feat: requiresArg is now simply an alias for nargs(1) #1054
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
BREAKING CHANGE: requiresArg now has significantly different error output, matching nargs.
evocateur
reviewed
Jan 21, 2018
| @@ -204,7 +204,7 @@ function Yargs (processArgs, cwd, parentRequire) { | |||
|
|
|||
| self.requiresArg = function (keys) { | |||
| argsert('<array|string>', [keys], arguments.length) | |||
| populateParserHintArray('requiresArg', keys) | |||
| populateParserHintObject(self.nargs, false, 'narg', keys, 1) | |||
There was a problem hiding this comment.
Is calling self.nargs(keys, 1) too cute, here?
Both ways seem fine, the tradeoff being a duplicated call to populateParserHintObject vs a redundant argsert in the nested call...
There was a problem hiding this comment.
@evocateur it doesn't seem too cute; I like your idea of calling self.nargs.
There was a problem hiding this comment.
I was envisioning it being the entire contents of the method, not in addition to the duplicate argsert+populate call.
evocateur
approved these changes
Jan 21, 2018
bcoe
force-pushed
the
retire-require-args
branch
from
5a5bc65
to
585c89c
Compare
This was referenced Jan 22, 2020
This was referenced Nov 25, 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.
BREAKING CHANGE: requiresArg now has significantly different error output, matching nargs.
based on @evocateur's clever suggestion,
requiresArgis now just an alias fornargs(1); simplifying the implementation significantly and moving behavior closer to the parser.