Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: interpret demand() numbers as relative to executing command #582

Merged
merged 1 commit into from Aug 9, 2016

Conversation

nexdrew
Copy link
Member

@nexdrew nexdrew commented Aug 9, 2016

Fixes #451.

Previously, min and max values passed to .demand() were interpreted as the total number of non-option arguments, which included the arguments representing the command(s) itself.

With this PR, the min and max values are now interpreted as the additional number of non-option arguments, relative to the currently executing command.

Here's an example:

require('yargs')
  .command(
    'lint',
    'Lint a single file',
    (yargs) => yargs.demand(1, 1),
    (argv) => console.log('linting file:', argv._[1])
  )
  .argv

Before this PR, the command would not work as expected (i.e. would not accept any flagless args) because the lint command itself would satisfy the min and max on the command line.

$ program lint
linting file: undefined

$ program lint example.js
program lint

Too many non-option arguments: got 2, maximum of 1

$ program lint one.js two.js
program lint

Too many non-option arguments: got 3, maximum of 1

After this PR, the command works by requiring a single flagless arg on the command line besides the lint command itself.

$ program lint
program lint

Not enough non-option arguments: got 0, need at least 1

$ program lint example.js
linting file: example.js

$ program lint one.js two.js
program lint

Too many non-option arguments: got 2, maximum of 1

When .demand() is used outside of a command builder, the functionality remains the same.

Note that this is a BREAKING CHANGE since users relying on the previous (now deemed incorrect) functionality will need to change the values they pass to .demand() within command builders, decrementing them by the "nested/depth count" of the command.

Also note that this does not change the contents of argv._ within the command handler; argv._ still contains the command key(s) it took to execute the command(s). (Note the use of argv._[1] in the above example.)

We could possibly change this (which would be another breaking change), but I'd rather leave it this way to potentially support command handlers that are reusable across multiple commands (allowing the handler to slightly change its functionality based on the command keys present in argv._).

@nexdrew nexdrew added the 5.x label Aug 9, 2016
@maxrimue maxrimue mentioned this pull request Aug 9, 2016
10 tasks
@bcoe bcoe merged commit 927810c into master Aug 9, 2016
1 check passed
@bcoe bcoe deleted the contextual-demand branch August 9, 2016 23:58
This was referenced Aug 14, 2016
@mathieumg
Copy link
Contributor

Just got bit by this not being marked as a breaking change in the v5 changelog, must have slipped through the cracks! 😆

@nexdrew
Copy link
Member Author

nexdrew commented Oct 17, 2016

@mathieumg Whoops, you're right, looks like we forgot to use the BREAKING CHANGE marker in the merged commit, sorry about that!

@bcoe
Copy link
Member

bcoe commented Oct 17, 2016

@nexdrew @mathieumg mind updating the CHANGELOG for v5 post-hoc, save others :)

@mathieumg
Copy link
Contributor

@bcoe Done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants