doc: switch legacy .argv to .parse() #2346
Merged
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.
This PR is acting on notes in #2045 (comment)
The magic
yargs.argv
mystified me, until I found it is a getter. I have switched the user facing uses of.argv
in documentation and examples to.parse()
.Supporting links for making the change:
The requested module 'yargs/helpers' does not provide an export named 'hideBin'
#2068 (comment)yargs/lib/yargs-factory.ts
Line 72 in e517318
I have not updated all the tests, as it was going to trigger big code reformats. On that note, this PR may clash miserably with #2172 and might need to redo one or the other! But should be easy to redo the formatting steps rather than do a cold merge.