Update commander 11.1.0 → 12.1.0 (major)

[depfu]

Here is everything you need to know about this upgrade. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ commander (11.1.0 → 12.1.0) · Repo · Changelog

Release Notes

12.1.0

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)

12.0.0

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

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by more commits than we can show here.

---

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands

@​depfu rebase

Rebases against your default branch and redoes this update

@​depfu recreate

Recreates this PR, overwriting any edits that you've made to it

@​depfu merge

Merges this PR once your tests are passing and conflicts are resolved

@​depfu cancel merge

Cancels automatic merging of this PR

@​depfu close

Closes this PR and deletes the branch

@​depfu reopen

Restores the branch and reopens this PR (if it's closed)

@​depfu pause

Ignores all future updates for this dependency and closes this PR

@​depfu pause [minor|major]

Ignores all future minor/major updates for this dependency and closes this PR

@​depfu resume

Future versions of this dependency will create PRs again (leaves this PR as is)