Skip to content

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented May 25, 2025

This PR contains the following updates:

Package Change Age Confidence
commander 12.1.0 -> 14.0.1 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 - 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.

Copy link
Contributor

github-actions bot commented May 25, 2025

Test Results

  1 files  ±0   48 suites  ±0   2s ⏱️ ±0s
332 tests ±0  331 ✅  - 1  0 💤 ±0  1 ❌ +1 
333 runs  ±0  332 ✅  - 1  0 💤 ±0  1 ❌ +1 

For more details on these failures, see this check.

Results for commit 916e59d. ± Comparison against base commit 0d4438d.

♻️ This comment has been updated with latest results.

@renovate renovate bot force-pushed the renovate/dependency-update-commander-14.x branch 13 times, most recently from b63145e to 008a08c Compare May 29, 2025 05:10
@renovate renovate bot force-pushed the renovate/dependency-update-commander-14.x branch 9 times, most recently from 6be54a6 to 2f26c70 Compare June 14, 2025 18:26
@renovate renovate bot force-pushed the renovate/dependency-update-commander-14.x branch 6 times, most recently from 9fd3547 to d710383 Compare June 20, 2025 21:49
@renovate renovate bot force-pushed the renovate/dependency-update-commander-14.x branch 7 times, most recently from 15a9aa2 to 74c1206 Compare August 12, 2025 00:32
@renovate renovate bot force-pushed the renovate/dependency-update-commander-14.x branch 6 times, most recently from 2fb15c8 to d925364 Compare August 21, 2025 23:54
@renovate renovate bot force-pushed the renovate/dependency-update-commander-14.x branch 5 times, most recently from 5b85803 to bbd854c Compare August 28, 2025 06:09
@renovate renovate bot force-pushed the renovate/dependency-update-commander-14.x branch 7 times, most recently from 7ea30d8 to 7edb502 Compare September 6, 2025 02:54
@renovate renovate bot force-pushed the renovate/dependency-update-commander-14.x branch from 7edb502 to e4637e9 Compare September 8, 2025 18:06
@renovate renovate bot force-pushed the renovate/dependency-update-commander-14.x branch from e4637e9 to 3b548aa Compare September 19, 2025 09:28
@renovate renovate bot force-pushed the renovate/dependency-update-commander-14.x branch from 3b548aa to 9170d7f Compare October 21, 2025 10:37
@renovate renovate bot force-pushed the renovate/dependency-update-commander-14.x branch from 9170d7f to 916e59d Compare October 21, 2025 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants