Skip to content

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented May 19, 2025

Coming soon: The Renovate bot (GitHub App) will be renamed to Mend. PRs from Renovate will soon appear from 'Mend'. Learn more here.

This PR contains the following updates:

Package Change Age Confidence
commander ^12.1.0 -> ^14.0.0 age confidence

Release Notes

tj/commander.js (commander)

v14.0.1

Compare Source

Fixed
  • broken markdown link in README ([#​2369])
Changed
  • improve code readability by using optional chaining ([#​2394])
  • use more idiomatic code with object spread instead of Object.assign() ([#​2395])
  • improve code readability using string.endsWith() instead of string.slice() ([#​2396])
  • refactor .parseOptions() to process args array in-place ([#​2409])
  • change private variadic support routines from ._concatValue() to ._collectValue() (change code from array.concat() to array.push()) ([#​2410])
  • update (dev) dependencies

v14.0.0

Compare Source

Added
  • support for groups of options and commands in the help using low-level .helpGroup() on Option and Command, and higher-level .optionsGroup() and .commandsGroup() which can be used in chaining way to specify group title for following options/commands ([#​2328])
  • support for unescaped negative numbers as option-arguments and command-arguments ([#​2339])
  • TypeScript: add parseArg property to Argument class ([#​2359])
Fixed
  • remove bogus leading space in help when option has default value but not a description ([#​2348])
  • .configureOutput() now makes copy of settings instead of modifying in-place, fixing side-effects ([#​2350])
Changed
  • Breaking: Commander 14 requires Node.js v20 or higher
  • internal refactor of Help class adding .formatItemList() and .groupItems() methods ([#​2328])

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])
    • note: support for dual long option flags added in Commander 13.1
  • 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);
});

Stricter option flag parsing

Commander now throws an error for option flag combinations that are not supported.
In particular, a short flag with multiple characters is now an error.

program.option('-ws, --workspace'); // throws error

A short option has a single character:

program.option('-w, --workspace');

Or from Commander 13.1 you can have an extra long flag instead of a short flag to allow a more memorable shortcut for the full name:

program.option('--ws, --workspace');

Configuration

📅 Schedule: Branch creation - "before 4am,after 11pm" in timezone America/New_York, 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 Pull requests that update a dependency file label May 19, 2025
@renovate renovate bot force-pushed the renovate_commander-14.x branch 6 times, most recently from a2c9d29 to cd46531 Compare May 25, 2025 06:07
@renovate renovate bot force-pushed the renovate_commander-14.x branch 9 times, most recently from ff8afad to 8abaf31 Compare June 2, 2025 08:53
@renovate renovate bot force-pushed the renovate_commander-14.x branch 5 times, most recently from 6282db0 to 1b4d9ef Compare June 10, 2025 13:59
@renovate renovate bot force-pushed the renovate_commander-14.x branch 5 times, most recently from d7df720 to 6e205c0 Compare June 17, 2025 14:10
@renovate renovate bot force-pushed the renovate_commander-14.x branch 3 times, most recently from 022e752 to f437926 Compare June 22, 2025 08:54
@renovate renovate bot force-pushed the renovate_commander-14.x branch from f437926 to ecab175 Compare June 27, 2025 09:59
@renovate renovate bot force-pushed the renovate_commander-14.x branch 2 times, most recently from c9ad03d to ca7dadf Compare August 6, 2025 12:45
@renovate renovate bot force-pushed the renovate_commander-14.x branch 6 times, most recently from 660631d to d163cb5 Compare August 27, 2025 23:24
@renovate renovate bot force-pushed the renovate_commander-14.x branch 5 times, most recently from 9f06f04 to 98f894b Compare September 10, 2025 05:55
@renovate renovate bot force-pushed the renovate_commander-14.x branch 9 times, most recently from 48be999 to eacb1ea Compare September 18, 2025 10:05
@renovate renovate bot force-pushed the renovate_commander-14.x branch 6 times, most recently from f78fad7 to 03352eb Compare September 24, 2025 08:34
@renovate renovate bot force-pushed the renovate_commander-14.x branch from 03352eb to 9a5d41d Compare September 25, 2025 14:39
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.

0 participants