fix(deps): update dependency commander to v12

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
commander	^8.0.0 -> ^12.0.0

---

Release Notes

tj/commander.js (commander)

v12.1.0

Compare Source

Added

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

v11.1.0

Compare Source

Fixed

• TypeScript: update OptionValueSource to allow any string, to match supported use of custom sources ([#​1983])
• TypeScript: add that Command.version() can also be used as getter ([#​1982])
• TypeScript: add null return type to Commands.executableDir(), for when not configured ([#​1965])
• subcommands with an executable handler and only a short help flag are now handled correctly by the parent's help command ([#​1930])

Added

• registeredArguments property on Command with the array of defined Argument (like Command.options for Option) ([#​2010])
• TypeScript declarations for Option properties: envVar, presetArg ([#​2019])
• TypeScript declarations for Argument properties: argChoices, defaultValue, defaultValueDescription ([#​2019])
• example file which shows how to configure help to display any custom usage in the list of subcommands ([#​1896])

Changed

• (developer) refactor TypeScript configs for multiple use-cases, and enable checks in JavaScript files in supporting editors ([#​1969])

Deprecated

• Command._args was private anyway, but now available as registeredArguments ([#​2010])

v11.0.0

Compare Source

Fixed

• help command works when help option is disabled ([#​1864])

Changed

• leading and trailing spaces are now ignored by the .arguments() method ([#​1874])
• refine "types" exports for ESM to follow TypeScript guidelines ([#​1886])
• Breaking: Commander 11 requires Node.js v16 or higher

v10.0.1

Compare Source

Added

• improvements to documentation ([#​1858], [#​1859], [#​1860])

Fixed

• remove unused Option.optionFlags property from TypeScript definition ([#​1844])

Changed

• assume boolean option intended if caller passes string instead of hash to .implies() ([#​1854])

v10.0.0

Compare Source

Added

• wrap command description in help ([#​1804])

Changed

• Breaking: Commander 10 requires Node.js v14 or higher

v9.5.0

Compare Source

Added

• .getOptionValueSourceWithGlobals() ([#​1832])
• showGlobalOptions for .configureHelp{} and Help ([#​1828])

v9.4.1

Compare Source

Fixed

• .setOptionValue() now also clears option source ([#​1795])
• TypeScript: add implied to OptionValueSource for option values set by using .implies() ([#​1794])
• TypeScript : add undefined to return type of .getOptionValueSource() ([#​1794])

Changed

• additions to README

v9.4.0

Compare Source

Added

• preSubcommand hook called before direct subcommands ([#​1763])

Fixed

• export InvalidOptionArgumentError in esm ([#​1756])

Changed

• update dependencies ([#​1767])

v9.3.0

Compare Source

Added

• .summary() for a short summary to use instead of description when listing subcommands in help ([#​1726])
• Option.implies() to set other option values when the option is specified ([#​1724])
• updated Chinese README with 9.x changes ([#​1727])

Fixed

• TypeScript: add string[] to .options() default value parameter type for use with variadic options ([#​1721])

Deprecated

• multi-character short option flag (e.g. -ws) ([#​1718])

v9.2.0

Compare Source

Added

• conditional export of 'types' for upcoming TypeScript module resolution ([#​1703])
• example file showing two ways to add global options to subcommands ([#​1708])

Fixed

• detect option conflicts in parent commands of called subcommand ([#​1710])

Changed

• replace deprecated String.prototype.substr ([#​1706])

v9.1.0

Compare Source

Added

• Option .conflicts() to set conflicting options which can not be specified together ([#​1678])
• (developer) CodeQL configuration for GitHub Actions ([#​1698])

v9.0.0

Compare Source

Added

• simpler ECMAScript import ([#​1589])
• Option.preset() allows specifying value/arg for option when used without option-argument (especially optional, but also boolean option) ([#​1652])
• .executableDir() for custom search for subcommands ([#​1571])
• throw with helpful message if pass Option to .option() or .requiredOption() ([#​1655])
• .error() for generating errors from client code just like Commander generated errors, with support for .configureOutput(), .exitOverride(), and .showHelpAfterError() ([#​1675])
• .optsWithGlobals() to return merged local and global options ([#​1671])

Changed

• Breaking: Commander 9 requires Node.js v12.20.0 or higher
• update package-lock.json to lockfile@2 format ([#​1659])
• showSuggestionAfterError is now on by default ([#​1657])
• Breaking: default value specified for boolean option now always used as default value (see .preset() to match some previous behaviours) ([#​1652])
• default value for boolean option only shown in help if true/false ([#​1652])
• use command name as prefix for subcommand stand-alone executable name (with fallback to script name for backwards compatibility) ([#​1571])
• allow absolute path with executableFile ([#​1571])
• removed restriction that nested subcommands must specify executableFile ([#​1571])
• TypeScript: allow passing readonly string array to .choices() ([#​1667])
• TypeScript: allow passing readonly string array to .parse(), .parseAsync(), .aliases() ([#​1669])

Fixed

• option with optional argument not supplied on command line now works when option already has a value, whether from default value or from previous arguments ([#​1652])

Removed

• Breaking: removed internal fallback to require.main.filename when script not known from arguments passed to .parse() (can supply details using .name(), and .executableDir() or executableFile) ([#​1571])

v8.3.0

Compare Source

Added

• .getOptionValueSource() and .setOptionValueWithSource(), where expected values for source are one of 'default', 'env', 'config', 'cli' ([#​1613])

Deprecated

• .command('*'), use default command instead ([#​1612])
• on('command:*'), use .showSuggestionAfterError() instead ([#​1612])

v8.2.0

Compare Source

Added

• .showSuggestionAfterError() to show suggestions after unknown command or unknown option ([#​1590])
• add Option support for values from environment variables using .env() ([#​1587])

Changed

• show error for unknown global option before subcommand (rather than just help) ([#​1590])

Removed

• TypeScript declaration of unimplemented Option method argumentRejected

v8.1.0

Compare Source

Added

• .copyInheritedSettings() ([#​1557])
• update Chinese translations of documentation for Commander v8 ([#​1570])
• Argument methods for .argRequired() and .argOptional() ([#​1567])

---

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.