fix help text not displaying #446
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
echo-bravo-yahoo
commented
Dec 2, 2024
Comment on lines
-37
to
-52
| // this case only occurs when an error is thrown and not caught | ||
| if (!argv) { | ||
| // we give yargs _just_ enough information that we can use it to parse | ||
| // out the verbosity flags needed by the logger | ||
| argv = yargs(hideBin(process.argv)) | ||
| .options({ | ||
| verboseComponent: { | ||
| type: "array", | ||
| default: [], | ||
| }, | ||
| verbosity: { | ||
| type: "number", | ||
| default: 0, | ||
| }, | ||
| }) | ||
| .version(false).argv; |
There was a problem hiding this comment.
the config parser runs well before the rest of yargs. as far as i can tell, it looks something like:
- start parsing argv
- run config parser
- check if it's a --help command
- run before validation middleware
- run validation
- run after validation middleware
- finished parsing argv
- run command handler
anyway, this block was previously only hit on errors, and exists to pull the populate verbosity so we can decide if we should log the full error stack. now, though, log is called by config parser - which also happens before argv are available. for whatever reason, calling yargs...argv is sticky and clobbers the help it would otherwise generate.
so, in the error case, we can instead read the argv out of the parsed yargs object, and do nothing in the config parser case.
echo-bravo-yahoo
force-pushed
the
fix-help-text
branch
from
24b6b43 to
4b2d960
Compare
ptpaterson
approved these changes
Dec 2, 2024
ecooper
approved these changes
Dec 2, 2024
cleve-fauna
approved these changes
Dec 2, 2024
Closed
Closed
Merged
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.
No description provided.