fix: do not set boolean flags if not defined in argv
#119
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
pvdlg
force-pushed
the
default-boolean-undef
branch
from
f926841
to
4ecdb72
Compare
pvdlg
changed the title
undefined if not set in argvargv
pvdlg
force-pushed
the
default-boolean-undef
branch
from
4ecdb72
to
cf299cb
Compare
pvdlg
changed the title
argvargv
ljharb
suggested changes
Apr 1, 2018
index.js
Outdated
| @@ -105,8 +105,10 @@ function parse (args, opts) { | |||
| var argv = { _: [] } | |||
|
|
|||
| Object.keys(flags.bools).forEach(function (key) { | |||
| setArg(key, !(key in defaults) ? false : defaults[key]) | |||
| setDefaulted(key) | |||
| if (key in defaults) { | |||
There was a problem hiding this comment.
This should use Object.prototype.hasOwnProperty.call, in case the "key" is "toString" or "hasOwnProperty"
There was a problem hiding this comment.
I kept key in defaults because if was there before, but I agree we should use Object.prototype.hasOwnProperty.call. I made the change.
BREAKING CHANGE: `boolean` flags defined without a `default` value will now behave like other option type and won't be set in the parsed results when the user doesn't set the corresponding CLI arg.
Previous behavior:
```js
var parse = require('yargs-parser');
parse('--flag', {boolean: ['flag']});
// => { _: [], flag: true }
parse('--no-flag', {boolean: ['flag']});
// => { _: [], flag: false }
parse('', {boolean: ['flag']});
// => { _: [], flag: false }
```
New behavior:
```js
var parse = require('yargs-parser');
parse('--flag', {boolean: ['flag']});
// => { _: [], flag: true }
parse('--no-flag', {boolean: ['flag']});
// => { _: [], flag: false }
parse('', {boolean: ['flag']});
// => { _: [] } => flag not set similarly to other option type
```
pvdlg
force-pushed
the
default-boolean-undef
branch
from
cf299cb
to
9f185f2
Compare
bcoe
approved these changes
Apr 4, 2018
There was a problem hiding this comment.
@pvdlg thanks for digging into this; I'm currently triaging issues with @evocateur and we both agree that this is a good improvement to the API.
|
Awesome! Thanks! |
|
@bcoe could you by any chance also check out yargs/yargs#1071 which is related? Thanks! |
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.
Fix #116
booleanflags defined without adefaultvalue will now behave like other option type and won't be set in the parsed results when the user doesn't set the corresponding CLI arg.Previous behavior:
New behavior: