-
-
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
Add showHelpAfterError #1534
Merged
shadowspawn
merged 12 commits into
tj:release/8.x
from
shadowspawn:feature/displayHelpWithError
Jun 1, 2021
Merged
Add showHelpAfterError #1534
shadowspawn
merged 12 commits into
tj:release/8.x
from
shadowspawn:feature/displayHelpWithError
Jun 1, 2021
+180
−25
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
This was referenced May 29, 2021
abetomo
approved these changes
Jun 1, 2021
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
Thanks @abetomo |
This was referenced Jun 6, 2021
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
Problem
Some users would like the help displayed along with the error, or a tip that the help is available.
Related: #7 (comment) #482 #766 #919 #1423
Solution
Add
.showHelpAfterError()
to turn on displaying the help, and can optionally take a string to display (rather than the full help).The form of the solution inspired in part by Yargs showHelpOnFail.
Example uses:
ChangeLog
.showHelpAfterError()
to display full help or a custom message after an error.showHelpAfteError()
)