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 12.1.0 to 13.0.0 #35796

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Dec 31, 2024

Bumps commander from 12.1.0 to 13.0.0.

Release notes

Sourced from commander's releases.

v13.0.0

Added

  • support multiple calls to .parse() with default settings (#2299)
  • add .saveStateBeforeParse() and .restoreStateBeforeParse() for use by subclasses (#2299)
  • style routines like styleTitle() to add color to help using .configureHelp() or Help subclass (#2251)
  • color related support in .configureOutput() for getOutHasColors(), getErrHasColors(), and stripColor() (#2251)
  • Help property for minWidthToWrap (#2251)
  • Help methods for displayWidth(), boxWrap(), preformatted() et al (#2251)

Changed

  • Breaking: excess command-arguments cause an error by default, see migration tips (#2223)
  • Breaking: throw during Option construction for unsupported option flags, like multiple characters after single - (#2270)
  • Breaking: throw on multiple calls to .parse() if storeOptionsAsProperties: true (#2299)
  • TypeScript: include implicit this in parameters for action handler callback (#2197)

Deleted

  • Breaking: Help.wrap() refactored into formatItem() and boxWrap() (#2251)

Migration Tips

Excess command-arguments

It is now an error for the user to specify more command-arguments than are expected. (allowExcessArguments is now false by default.)

Old code:

program.option('-p, --port <number>', 'port number');
program.action((options) => {
  console.log(program.args);
});

Now shows an error:

$ node example.js a b c
error: too many arguments. Expected 0 arguments but got 3.

You can declare the expected arguments. The help will then be more accurate too. Note that declaring new arguments will change what is passed to the action handler.

program.option('-p, --port <number>', 'port number');
program.argument('[args...]', 'remote command and arguments'); // expecting zero or more arguments
program.action((args, options) => {
</tr></table> 

... (truncated)

Changelog

Sourced from commander's changelog.

[13.0.0] (2024-12-30)

Added

  • support multiple calls to .parse() with default settings (#2299)
  • add .saveStateBeforeParse() and .restoreStateBeforeParse() for use by subclasses (#2299)
  • style routines like styleTitle() to add color to help using .configureHelp() or Help subclass (#2251)
  • color related support in .configureOutput() for getOutHasColors(), getErrHasColors(), and stripColor() (#2251)
  • Help property for minWidthToWrap (#2251)
  • Help methods for displayWidth(), boxWrap(), preformatted() et al (#2251)

Changed

  • Breaking: excess command-arguments cause an error by default, see migration tips (#2223)
  • Breaking: throw during Option construction for unsupported option flags, like multiple characters after single - (#2270)
  • Breaking: throw on multiple calls to .parse() if storeOptionsAsProperties: true (#2299)
  • TypeScript: include implicit this in parameters for action handler callback (#2197)

Deleted

  • Breaking: Help.wrap() refactored into formatItem() and boxWrap() (#2251)

Migration Tips

Excess command-arguments

It is now an error for the user to specify more command-arguments than are expected. (allowExcessArguments is now false by default.)

Old code:

program.option('-p, --port <number>', 'port number');
program.action((options) => {
  console.log(program.args);
});

Now shows an error:

$ node example.js a b c
error: too many arguments. Expected 0 arguments but got 3.

You can declare the expected arguments. The help will then be more accurate too. Note that declaring new arguments will change what is passed to the action handler.

program.option('-p, --port <number>', 'port number');
program.argument('[args...]', 'remote command and arguments'); // expecting zero or more arguments
</tr></table> 

... (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 show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @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)

Bumps [commander](https://github.com/tj/commander.js) from 12.1.0 to 13.0.0.
- [Release notes](https://github.com/tj/commander.js/releases)
- [Changelog](https://github.com/tj/commander.js/blob/master/CHANGELOG.md)
- [Commits](tj/commander.js@v12.1.0...v13.0.0)

---
updated-dependencies:
- dependency-name: commander
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update JavaScript code labels Dec 31, 2024
@github-actions github-actions bot closed this Dec 31, 2024
Copy link
Contributor

This dependency update will be handled internally by our engineering team.

Copy link
Contributor Author

dependabot bot commented on behalf of github Dec 31, 2024

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

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

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 31, 2024
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/commander-13.0.0 branch December 31, 2024 06:31
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dependencies Pull requests that update a dependency file javascript Pull requests that update JavaScript code triage Do not begin working on this issue until triaged by the team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants