Skip to content

Update dependency commander to v14#27

Closed
renovate[bot] wants to merge 12 commits intomainfrom
renovate/commander-14.x
Closed

Update dependency commander to v14#27
renovate[bot] wants to merge 12 commits intomainfrom
renovate/commander-14.x

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Jun 8, 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 11.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');

v12.1.0

Compare Source

Added
  • auto-detect special node flags node --eval and node --print when call .parse() with no arguments ([#​2164])
Changed
  • prefix require of Node.js core modules with node: ([#​2170])
  • format source files with Prettier ([#​2180])
  • switch from StandardJS to directly calling ESLint for linting ([#​2153])
  • extend security support for previous major version of Commander ([#​2150])
Removed
  • removed unimplemented Option.fullDescription from TypeScript definition ([#​2191])

v12.0.0

Compare Source

Added
  • .addHelpOption() as another way of configuring built-in help option ([#​2006])
  • .helpCommand() for configuring built-in help command ([#​2087])
Fixed
  • Breaking: use non-zero exit code when spawned executable subcommand terminates due to a signal ([#​2023])
  • Breaking: check passThroughOptions constraints when using .addCommand and throw if parent command does not have .enablePositionalOptions() enabled ([#​1937])
Changed
  • Breaking: Commander 12 requires Node.js v18 or higher ([#​2027])
  • Breaking: throw an error if add an option with a flag which is already in use ([#​2055])
  • Breaking: throw an error if add a command with name or alias which is already in use ([#​2059])
  • Breaking: throw error when calling .storeOptionsAsProperties() after setting an option value ([#​1928])
  • replace non-standard JSDoc of @api private with documented @private ([#​1949])
  • .addHelpCommand() now takes a Command (passing string or boolean still works as before but deprecated) ([#​2087])
  • refactor internal implementation of built-in help option ([#​2006])
  • refactor internal implementation of built-in help command ([#​2087])
Deprecated
  • .addHelpCommand() passing string or boolean (use .helpCommand() or pass a Command) ([#​2087])
Removed
  • Breaking: removed default export of a global Command instance from CommonJS (use the named program export instead) ([#​2017])
Migration Tips

global program

If you are using the deprecated default import of the global Command object, you need to switch to using a named import (or create a new Command).

// const program = require('commander');
const { program } = require('commander');

option and command clashes

A couple of configuration problems now throw an error, which will pick up issues in existing programs:

  • adding an option which uses the same flag as a previous option
  • adding a command which uses the same name or alias as a previous command

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.

rishibhargava and others added 12 commits December 2, 2022 20:59
CLI Authentication sample app
* Add renovate.json

* Update renovate.json

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Omer Cohen <omer@descope.com>
* fixes

* readme
* break into different command parameters

* set specific versions
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@renovate renovate bot added the renovate label Jun 8, 2025
@renovate
Copy link
Contributor Author

renovate bot commented Jun 8, 2025

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: package-lock.json
npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR! 
npm ERR! While resolving: cli-authentication@1.0.0
npm ERR! Found: eslint@8.51.0
npm ERR! node_modules/eslint
npm ERR!   dev eslint@"8.51.0" from the root project
npm ERR! 
npm ERR! Could not resolve dependency:
npm ERR! peer eslint@"^8.56.0" from @typescript-eslint/parser@7.0.1
npm ERR! node_modules/@typescript-eslint/parser
npm ERR!   dev @typescript-eslint/parser@"7.0.1" from the root project
npm ERR!   peer @typescript-eslint/parser@"^7.0.0" from @typescript-eslint/eslint-plugin@7.0.1
npm ERR!   node_modules/@typescript-eslint/eslint-plugin
npm ERR!     dev @typescript-eslint/eslint-plugin@"7.0.1" from the root project
npm ERR! 
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR! 
npm ERR! See /runner/cache/others/npm/eresolve-report.txt for a full report.

npm ERR! A complete log of this run can be found in:
npm ERR!     /runner/cache/others/npm/_logs/2025-09-01T14_54_31_816Z-debug-0.log

@stevenbarash stevenbarash force-pushed the renovate/commander-14.x branch from 9d04943 to b7597f1 Compare September 17, 2025 18:02
@renovate
Copy link
Contributor Author

renovate bot commented Sep 17, 2025

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

@stevenbarash stevenbarash deleted the renovate/commander-14.x branch September 17, 2025 18:03
@renovate
Copy link
Contributor Author

renovate bot commented Sep 17, 2025

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for any future 14.x releases. But if you manually upgrade to 14.x then Renovate will re-enable minor and patch updates automatically.

If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants