feat: .help() API can now enable implicit help command#574
Merged
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
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.
In addition to a flagged option (e.g.
--help),.help()now also supports an implicit command (e.g.help), which is enabled by default.This means any yargs CLI can now enjoy commands such as:
No flag needed. 😎
I opted to build the implicit command into the existing
.help()API (instead of creating a new method) in order to:.help()It can be explicitly disabled by passing
falseas one of the 3 arguments.Note that any help option aliases will also be used as an alias for the command, as long as:
This should be considered a 5.x breaking change in case existing CLIs use their own
helpcommand.