Skip to content

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented May 18, 2025

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.2

Compare Source

Changed
  • improve negative number auto-detection test ([#​2428])
  • update (dev) dependencies

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 - 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 becomes conflicted, 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 force-pushed the renovate/commander-14.x branch 2 times, most recently from 663255f to 74162c8 Compare May 23, 2025 08:52
@renovate renovate bot force-pushed the renovate/commander-14.x branch from 74162c8 to c50ca61 Compare June 22, 2025 12:38
@renovate renovate bot changed the title fix(deps): update dependency commander to v14 fix(deps): update dependency commander to v14 - autoclosed Jun 22, 2025
@renovate renovate bot closed this Jun 22, 2025
@renovate renovate bot deleted the renovate/commander-14.x branch June 22, 2025 12:43
@renovate renovate bot changed the title fix(deps): update dependency commander to v14 - autoclosed fix(deps): update dependency commander to v14 Jun 22, 2025
@renovate renovate bot reopened this Jun 22, 2025
@renovate renovate bot force-pushed the renovate/commander-14.x branch from c9017cc to c50ca61 Compare June 22, 2025 13:27
@renovate renovate bot changed the title fix(deps): update dependency commander to v14 Update dependency commander to v14 Jun 23, 2025
@renovate renovate bot changed the title Update dependency commander to v14 fix(deps): update dependency commander to v14 Jul 21, 2025
@renovate renovate bot force-pushed the renovate/commander-14.x branch from c50ca61 to 460cdfd Compare August 10, 2025 13:12
@renovate renovate bot force-pushed the renovate/commander-14.x branch 2 times, most recently from 4b43ed6 to 9c147b4 Compare August 21, 2025 15:58
@renovate renovate bot force-pushed the renovate/commander-14.x branch 2 times, most recently from 5f2614b to ca073e0 Compare August 31, 2025 10:09
@renovate renovate bot force-pushed the renovate/commander-14.x branch 3 times, most recently from 53f7a7e to 233ecd1 Compare September 16, 2025 06:36
@renovate renovate bot force-pushed the renovate/commander-14.x branch from 233ecd1 to ab656e6 Compare September 25, 2025 14:50
@renovate renovate bot force-pushed the renovate/commander-14.x branch from ab656e6 to 3dea7f8 Compare October 21, 2025 11:45
@renovate renovate bot force-pushed the renovate/commander-14.x branch from 3dea7f8 to 808281d Compare October 25, 2025 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant