This repository has been archived by the owner on Mar 3, 2023. It is now read-only.
Fix usage message (closes #25441) #25442
Merged
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
… parsed yargs depends on an intact console.log to display help and usage messages, so just delay the override by a few statements.
The second call to yargs should be responsible for printing the main usage message. This also fixes the `--help` description w/i the usage message, which was only using the yargs default description.
claytonrcarter
force-pushed
the
fix-usage-message
branch
from
6ff0674
to
19b28ed
Compare
|
Hi @claytonrcarter, I appreciate this fix and wanted to add it to the community fork. Did you want to re-submit this PR there, or can I submit it on your behalf? (I'd point people to this as the original PR and use the same commits in the new PR.) (A note just to be clear to anyone reading this: the community fork has no official relationship with official Atom, and I am not related to or involved in the official Atom team. I am just an independent community contributor to Atom like anyone else who posts PRs here.) |
|
I don't see myself having time to do so soon, so if you're set up to submit it for me, please feel free to do so. Good luck on the community fork! |
|
Thanks for the contribution 🙇🏾 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Identify the Bug
This fixes #25441.
Description of the Change
The commit should be self explanatory, but the summary is:
atom -hproduces actual outputatom --helpproduces correct outputatom -handatom --helpboth produce the same output-h/--helpis corrected-v/--versionare correctly included in the usage messageAlternate Designs
I did not consider alternate designs b/c these fixes were pretty straightforward.
Possible Drawbacks
None that I can think of. This only corrects defects.
Verification Process
I have built and tested this locally, by hand.
Release Notes
When launched from the CLI, the
-hand--helpflags will now display the correct usage message.