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

Bump commander from 6.2.1 to 7.1.0 #289

Merged
merged 3 commits into from
Mar 5, 2021

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Feb 15, 2021

Bumps commander from 6.2.1 to 7.1.0.

Release notes

Sourced from commander's releases.

v7.1.0

Added

  • support for named imports from ECMAScript modules (#1440)
  • add .cjs to list of expected script file extensions (#1449)
  • allow using option choices and variadic together (#1454)

Fixed

  • replace use of deprecated process.mainModule (#1448)
  • regression for legacy command('*') and call when command line includes options (#1464)
  • regression for on('command:*', ...) and call when command line includes unknown options (#1464)
  • display best error for combination of unknown command and unknown option (i.e. unknown command) (#1464)

Changed

  • make TypeScript typings tests stricter (#1453)
  • improvements to README and tests

v7.0.0

Added

  • .enablePositionalOptions() to let program and subcommand reuse same option (#1427)
  • .passThroughOptions() to pass options through to other programs without needing -- (#1427)
  • .allowExcessArguments(false) to show an error message if there are too many command-arguments on command line for the action handler (#1409)
  • .configureOutput() to modify use of stdout and stderr or customise display of errors (#1387)
  • use .addHelpText() to add text before or after the built-in help, for just current command or also for all subcommands (#1296)
  • enhance Option class (#1331)
    • allow hiding options from help
    • allow restricting option arguments to a list of choices
    • allow setting how default value is shown in help
  • .createOption() to support subclassing of automatically created options (like .createCommand()) (#1380)
  • refactor the code generating the help into a separate public Help class (#1365)
    • support sorting subcommands and options in help
    • support specifying wrap width (columns)
    • allow subclassing Help class
    • allow configuring Help class without subclassing

Changed

  • Breaking: options are stored safely by default, not as properties on the command (#1409)
    • this especially affects accessing options on program, use program.opts()
    • revert behaviour with .storeOptionsAsProperties()
  • Breaking: action handlers are passed options and command separately (#1409)
  • deprecated callback parameter to .help() and .outputHelp() (removed from README) (#1296)
  • Breaking: errors now displayed using process.stderr.write() instead of console.error()
  • deprecate .on('--help') (removed from README) (#1296)
  • initialise the command description to empty string (previously undefined) (#1365)
  • document and annotate deprecated routines (#1349)

... (truncated)

Changelog

Sourced from commander's changelog.

[7.1.0] (2021-02-15)

Added

  • support for named imports from ECMAScript modules (#1440)
  • add .cjs to list of expected script file extensions (#1449)
  • allow using option choices and variadic together (#1454)

Fixed

  • replace use of deprecated process.mainModule (#1448)
  • regression for legacy command('*') and call when command line includes options (#1464)
  • regression for on('command:*', ...) and call when command line includes unknown options (#1464)
  • display best error for combination of unknown command and unknown option (i.e. unknown command) (#1464)

Changed

  • make TypeScript typings tests stricter (#1453)
  • improvements to README and tests

[7.0.0] (2021-01-15)

Added

  • .enablePositionalOptions() to let program and subcommand reuse same option (#1427)
  • .passThroughOptions() to pass options through to other programs without needing -- (#1427)
  • .allowExcessArguments(false) to show an error message if there are too many command-arguments on command line for the action handler (#1409)
  • .configureOutput() to modify use of stdout and stderr or customise display of errors (#1387)
  • use .addHelpText() to add text before or after the built-in help, for just current command or also for all subcommands (#1296)
  • enhance Option class (#1331)
    • allow hiding options from help
    • allow restricting option arguments to a list of choices
    • allow setting how default value is shown in help
  • .createOption() to support subclassing of automatically created options (like .createCommand()) (#1380)
  • refactor the code generating the help into a separate public Help class (#1365)
    • support sorting subcommands and options in help
    • support specifying wrap width (columns)
    • allow subclassing Help class
    • allow configuring Help class without subclassing

Changed

  • Breaking: options are stored safely by default, not as properties on the command (#1409)
    • this especially affects accessing options on program, use program.opts()
    • revert behaviour with .storeOptionsAsProperties()
  • Breaking: action handlers are passed options and command separately (#1409)
  • deprecated callback parameter to .help() and .outputHelp() (removed from README) (#1296)
  • Breaking: errors now displayed using process.stderr.write() instead of console.error()
  • deprecate .on('--help') (removed from README) (#1296)
  • initialise the command description to empty string (previously undefined) (#1365)

... (truncated)

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Feb 15, 2021
@minrk minrk force-pushed the dependabot/npm_and_yarn/commander-7.1.0 branch from 144be10 to a398329 Compare March 5, 2021 10:43
Copy link
Member

@consideRatio consideRatio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remember reading through commander changelog when 7.0.0 was out and didn't notice anything breaking for 7.0.0. But, the test had failures.

With 7.1.0 having fixed regressions and the tests succeeding, I'm +1 for merge!

@minrk minrk merged commit 15ac3af into master Mar 5, 2021
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/commander-7.1.0 branch March 5, 2021 12:32
@minrk
Copy link
Member

minrk commented Mar 5, 2021

Yup, the only relevant change was moving the parsed options off of the cli object to an explicit getOpts() method. A small change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants