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

build(deps): bump commander from 6.2.1 to 7.0.0 #337

Closed
wants to merge 2 commits into from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jan 18, 2021

Bumps commander from 6.2.1 to 7.0.0.

Release notes

Sourced from commander's releases.

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)

Fixed

  • wrapping bugs in help (#1365)
    • first line of command description was wrapping two characters early
    • pad width calculation was not including help option and help command
    • pad width calculation was including hidden options and commands
  • improve backwards compatibility for custom command event listeners (#1403)

Deleted

  • Breaking: .passCommandToAction() (#1409)
    • no longer needed as action handler is passed options and command
  • Breaking: "extra arguments" parameter to action handler (#1409)
    • if being used to detect excess arguments, there is now an error available by setting .allowExcessArguments(false)

Migration Tips

The biggest change is the parsed option values. Previously the options were stored by default as properties on the command object, and now the options are stored separately.

... (truncated)

Changelog

Sourced from commander's changelog.

[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)
  • document and annotate deprecated routines (#1349)

Fixed

  • wrapping bugs in help (#1365)
    • first line of command description was wrapping two characters early
    • pad width calculation was not including help option and help command
    • pad width calculation was including hidden options and commands
  • improve backwards compatibility for custom command event listeners (#1403)

Deleted

  • Breaking: .passCommandToAction() (#1409)
    • no longer needed as action handler is passed options and command
  • Breaking: "extra arguments" parameter to action handler (#1409)
    • if being used to detect excess arguments, there is now an error displayed by default

Migration Tips

The biggest change is the parsed option values. Previously the options were stored by default as properties on the command object, and now the options are stored separately.

... (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 Jan 18, 2021
@shaftoe
Copy link
Contributor

shaftoe commented Jan 18, 2021

Probably breaking because of this:

https://github.com/tj/commander.js/releases/tag/v7.0.0

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()

GitHub
Added

.enablePositionalOptions() to let program and subcommand reuse same option (#1427)
.passThroughOptions() to pass options through to other programs without needing -- (#1427)
.allowExcessArgu...

@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Jan 19, 2021

OK, I won't notify you again about this release, but will get in touch when a new version is available.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

@dependabot dependabot bot deleted the dependabot/npm_and_yarn/commander-7.0.0 branch January 19, 2021 21:41
@github-actions
Copy link

🎉 This issue has been resolved in version 4.5.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

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 released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant