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

Update dependency commander to v13 (master) #11616

Merged
merged 2 commits into from
Feb 19, 2025

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jan 1, 2025

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
commander 12.1.0 -> 13.1.0 age adoption passing confidence

Release Notes

tj/commander.js (commander)

v13.1.0

Compare Source

Added
  • support a pair of long option flags to allow a memorable shortened flag, like .option('--ws, --workspace') ([#​2312])

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);
});

Configuration

📅 Schedule: Branch creation - "after 5pm on the first day of the month" in timezone Europe/Zurich, Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

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 Update the dependencies label Jan 1, 2025
@renovate renovate bot enabled auto-merge (squash) January 1, 2025 16:48
@renovate renovate bot force-pushed the renovate/master-commander-13.x branch 7 times, most recently from bc9244e to 1463c01 Compare January 10, 2025 17:49
@renovate renovate bot force-pushed the renovate/master-commander-13.x branch 4 times, most recently from e520eba to 8240743 Compare January 16, 2025 09:25
@renovate renovate bot force-pushed the renovate/master-commander-13.x branch 3 times, most recently from 74dfb36 to a726792 Compare January 27, 2025 20:40
@renovate renovate bot force-pushed the renovate/master-commander-13.x branch 13 times, most recently from 3e9c35f to 93298e4 Compare February 4, 2025 15:47
@renovate renovate bot force-pushed the renovate/master-commander-13.x branch 9 times, most recently from 6dc7b3d to dfc98c7 Compare February 7, 2025 09:44
@renovate renovate bot force-pushed the renovate/master-commander-13.x branch 5 times, most recently from c57f28a to 9a106f9 Compare February 17, 2025 17:04
@renovate renovate bot force-pushed the renovate/master-commander-13.x branch from 9a106f9 to 144a41e Compare February 19, 2025 17:31
From the artifact of the previous workflow run
@renovate renovate bot merged commit e0facbc into master Feb 19, 2025
18 checks passed
@renovate renovate bot deleted the renovate/master-commander-13.x branch February 19, 2025 18:38
sbrunner added a commit that referenced this pull request Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Update the dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants