Add support groups of options and commands in the help #2328
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.
Problem
People would like to be able to group options and commands in the help, and a number of other libraries have support for this.
Requests:
Other libraries:
helpGroup
: https://oclif.io/docs/flagslistGroup
: https://github.com/voxpelli/peowlyPrevious exploration by me: #1908 #1910 #2176 #2248
Solution
Add low-level
.helpGroup()
on Option and Command, and higher-level.optionsGroup()
and.commandsGroup()
which can be used in chaining way to specify group title for following options/commands.See the example file to see them in use.
ChangeLog