Skip to content

chore(deps): update dependency commander to v14 #2025

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

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

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jun 9, 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.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 - "on Monday every 9 weeks of the year starting on the 6th week" (UTC), 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.

@coveralls
Copy link

coveralls commented Jul 9, 2025

Coverage Status

coverage: 95.523%. remained the same
when pulling 66a0769 on renovate/commander-14.x
into 597e978 on main.

@renovate renovate bot force-pushed the renovate/commander-14.x branch from 9fd1ed1 to 6402a9b Compare July 10, 2025 12:16
@renovate renovate bot force-pushed the renovate/commander-14.x branch from 6402a9b to e6dde5a Compare July 10, 2025 21:41
@renovate renovate bot force-pushed the renovate/commander-14.x branch from e6dde5a to 3922fcd Compare July 15, 2025 20:32
@renovate renovate bot force-pushed the renovate/commander-14.x branch from 3922fcd to 0eed679 Compare July 16, 2025 17:14
@renovate renovate bot force-pushed the renovate/commander-14.x branch from 0eed679 to 2d7269e Compare July 18, 2025 15:03
@renovate renovate bot force-pushed the renovate/commander-14.x branch from 2d7269e to 4fec5f2 Compare July 25, 2025 13:43
@renovate renovate bot force-pushed the renovate/commander-14.x branch from 4fec5f2 to 146170e Compare July 25, 2025 14:05
@renovate renovate bot force-pushed the renovate/commander-14.x branch from 146170e to f614721 Compare July 31, 2025 20:48
@renovate renovate bot force-pushed the renovate/commander-14.x branch from f614721 to 8f9092a Compare August 1, 2025 21:32
@renovate renovate bot force-pushed the renovate/commander-14.x branch from 8f9092a to e9aee49 Compare August 6, 2025 17:32
@renovate renovate bot force-pushed the renovate/commander-14.x branch from e9aee49 to 23e3799 Compare August 7, 2025 15:28
@renovate renovate bot force-pushed the renovate/commander-14.x branch from 23e3799 to 55b59df Compare August 7, 2025 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

1 participant