-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Support showing global options in help #1828
Merged
shadowspawn
merged 6 commits into
tj:develop
from
shadowspawn:feature/global-options-in-help
Dec 7, 2022
Merged
Support showing global options in help #1828
shadowspawn
merged 6 commits into
tj:develop
from
shadowspawn:feature/global-options-in-help
Dec 7, 2022
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
abetomo
approved these changes
Dec 7, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Released with Commander v9.5.0 |
This was referenced May 26, 2024
This was referenced Jun 6, 2024
This was referenced Jun 19, 2024
This was referenced Jul 16, 2024
This was referenced Aug 16, 2024
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.
Pull Request
Commander has long supported options at both the program level and in subcommands, but using both at once was a little subtle for both the author and the end-user.
Problem
In the Help you can't see all the options at once for a subcommand when the program has global options.
See: #1078 #1689
The global options poll has continued accumulating votes for displaying global options after the poll was closed. #1551 (comment)
Solution
Add help configuration to show the global options. This is off by default so can go in a feature version without changing behaviour of executing programs.
The global options are included in the padding calculations and are optional sorted.
The global options are shown in a separate section. This is the layout that was shown in #1551 (comment)).
Using the updated example file:
ChangeLog
showGlobalOptions
to.configureHelp{}