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

chore(deps): update dependency commander to v13 #341

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 30, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
commander ^12.0.0 -> ^13.0.0 age adoption passing confidence

Release Notes

tj/commander.js (commander)

v13.0.0

Compare Source

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) => {
  console.log(args);
});

Or you could suppress the error, useful for minimising changes in legacy code.

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

v12.1.0

Compare Source

Added

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added the 🤖 dependencies Dependency upgrade label Dec 30, 2024
@renovate renovate bot force-pushed the renovate/commander-13.x branch 6 times, most recently from 0ff5c1b to 0e304b6 Compare January 4, 2025 23:33
@renovate renovate bot force-pushed the renovate/commander-13.x branch 9 times, most recently from 46a6002 to e65abb2 Compare January 14, 2025 02:28
@renovate renovate bot force-pushed the renovate/commander-13.x branch 2 times, most recently from 97bec04 to 80d741e Compare January 17, 2025 15:01
@renovate renovate bot force-pushed the renovate/commander-13.x branch 7 times, most recently from b941ad8 to fdc99e2 Compare January 28, 2025 16:13
@luke-hill
Copy link
Contributor

ping @davidjgoss this looks like it busts a lot of stuff in later JS versions

@renovate renovate bot force-pushed the renovate/commander-13.x branch from fdc99e2 to a6b4e57 Compare January 29, 2025 17:39
@renovate renovate bot force-pushed the renovate/commander-13.x branch from a6b4e57 to 654850b Compare January 30, 2025 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 dependencies Dependency upgrade
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant