-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Add support for groups of options and commands in the help #2328
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
shadowspawn
wants to merge
11
commits into
tj:develop
Choose a base branch
from
shadowspawn:feature/help-group-4
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or 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
abetomo
reviewed
Feb 27, 2025
If we decide to land this, might wait for the major version when we drop Node.js 18. |
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.
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