-
Notifications
You must be signed in to change notification settings - Fork 59
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
Enhanced CLI Plugins #1064
Merged
Merged
Enhanced CLI Plugins #1064
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
attiasas
changed the title
Move logic from CLI
Enhanced Automatic Usage Generation for CLI Plugins Help
Dec 7, 2023
attiasas
changed the title
Enhanced Automatic Usage Generation for CLI Plugins Help
Enhanced Automatic Usage Help Generation for CLI Plugins
Dec 7, 2023
yahavi
requested changes
Dec 11, 2023
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.
Looks very good!
- Please consider my inline comments.
- Let's also talk about the design tomorrow
- I think it is important to document in this or future PR instructions in the
CONTRIBUTING.md
how to contribute a command.
4 tasks
sverdlov93
reviewed
Jan 3, 2024
attiasas
changed the title
Enhanced Automatic Usage Help Generation for CLI Plugins
Enhanced CLI Plugins
Jan 4, 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.
README.md
to help using and implementing plugins.Namespace
toApp
allowing to create sub commands at the plugin.PrintCommandHelp
method toContext
to allow for a dynamic way to print the command usage help for the plugins if an error occur while parsing the context for the command.Enhancements have been made in generating automatic usage for help regarding CLI Plugins to encompass broader scenarios:
download
).offlineupdate
).specFile
flag instead of arguments, such asscan
,download
,move
, etc.).audit-go
,xr scan
, etc.).UsageOptions
to manually add to or replace the generated usages (for help usage in commands such asocstartbuild
).Category
to commands.