feat: add help class to display additional cmd help #52
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
@W-9791511@ add custom help class
peternhale
commented
Sep 9, 2021
| @@ -29,6 +29,7 @@ | |||
| "state": "beta", | |||
| "topicSeparator": " ", | |||
| "commands": "./dist/commands", | |||
| "helpClass": "./dist/help/sfHelp.js", | |||
There was a problem hiding this comment.
name the help class for oclif
| import { SfCommandInterface } from '@salesforce/command'; | ||
| type SectionType = { header: string; generate: HelpSectionRenderer }; | ||
|
|
||
| export class SfCommandHelp extends CommandHelp { |
There was a problem hiding this comment.
This class is responsible for collecting the help sections to display
| super(command, config, opts); | ||
| } | ||
|
|
||
| protected sections(): SectionType[] { |
There was a problem hiding this comment.
Override base class sections
|
|
||
| protected sections(): SectionType[] { | ||
| const sections = super.sections(); | ||
| const additionaSfSections: SectionType[] = [ |
There was a problem hiding this comment.
sf additional sections
| import { CommandHelp, Help } from '@oclif/core'; | ||
| import { SfCommandHelp } from './sfCommandHelp'; | ||
|
|
||
| export default class SfHelp extends Help { |
There was a problem hiding this comment.
Needed to specify SfCommandHelp as the class to call
mdonnalley
previously approved these changes
Sep 9, 2021
RodEsp
previously approved these changes
Sep 9, 2021
mdonnalley
approved these changes
Sep 10, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@W-9791511@ add custom help class