tj/commander.js
### [`v9.4.1`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#941-2022-09-30)
[Compare Source](https://togithub.com/tj/commander.js/compare/v9.4.0...v9.4.1)
##### Fixed
- `.setOptionValue()` now also clears option source (\[[#1795](https://togithub.com/tj/commander.js/issues/1795)])
- TypeScript: add `implied` to `OptionValueSource` for option values set by using `.implies()` (\[[#1794](https://togithub.com/tj/commander.js/issues/1794)])
- TypeScript : add `undefined` to return type of `.getOptionValueSource()` (\[[#1794](https://togithub.com/tj/commander.js/issues/1794)])
##### Changed
- additions to README
### [`v9.4.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#940-2022-07-15)
[Compare Source](https://togithub.com/tj/commander.js/compare/v9.3.0...v9.4.0)
##### Added
- `preSubcommand` hook called before direct subcommands (\[[#1763](https://togithub.com/tj/commander.js/issues/1763)])
##### Fixed
- export `InvalidOptionArgumentError` in esm (\[[#1756](https://togithub.com/tj/commander.js/issues/1756)])
##### Changed
- update dependencies (\[[#1767](https://togithub.com/tj/commander.js/issues/1767)])
### [`v9.3.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#930-2022-05-28)
[Compare Source](https://togithub.com/tj/commander.js/compare/v9.2.0...v9.3.0)
##### Added
- `.summary()` for a short summary to use instead of description when listing subcommands in help (\[[#1726](https://togithub.com/tj/commander.js/issues/1726)])
- `Option.implies()` to set other option values when the option is specified (\[[#1724](https://togithub.com/tj/commander.js/issues/1724)])
- updated Chinese README with 9.x changes (\[[#1727](https://togithub.com/tj/commander.js/issues/1727)])
##### Fixed
- TypeScript: add `string[]` to `.options()` default value parameter type for use with variadic options (\[[#1721](https://togithub.com/tj/commander.js/issues/1721)])
##### Deprecated
- multi-character short option flag (e.g. `-ws`) (\[[#1718](https://togithub.com/tj/commander.js/issues/1718)])
### [`v9.2.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#920-2022-04-15)
[Compare Source](https://togithub.com/tj/commander.js/compare/v9.1.0...v9.2.0)
##### Added
- conditional export of 'types' for upcoming TypeScript module resolution (\[[#1703](https://togithub.com/tj/commander.js/issues/1703)])
- example file showing two ways to add global options to subcommands (\[[#1708](https://togithub.com/tj/commander.js/issues/1708)])
##### Fixed
- detect option conflicts in parent commands of called subcommand (\[[#1710](https://togithub.com/tj/commander.js/issues/1710)])
##### Changed
- replace deprecated `String.prototype.substr` (\[[#1706](https://togithub.com/tj/commander.js/issues/1706)])
### [`v9.1.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#910-2022-03-19)
[Compare Source](https://togithub.com/tj/commander.js/compare/v9.0.0...v9.1.0)
##### Added
- Option `.conflicts()` to set conflicting options which can not be specified together (\[[#1678](https://togithub.com/tj/commander.js/issues/1678)])
- (developer) CodeQL configuration for GitHub Actions (\[[#1698](https://togithub.com/tj/commander.js/issues/1698)])
### [`v9.0.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#900-2022-01-28)
[Compare Source](https://togithub.com/tj/commander.js/compare/v8.3.0...v9.0.0)
##### Added
- simpler ECMAScript import (\[[#1589](https://togithub.com/tj/commander.js/issues/1589)])
- Option.preset() allows specifying value/arg for option when used without option-argument (especially optional, but also boolean option) (\[[#1652](https://togithub.com/tj/commander.js/issues/1652)])
- `.executableDir()` for custom search for subcommands (\[[#1571](https://togithub.com/tj/commander.js/issues/1571)])
- throw with helpful message if pass `Option` to `.option()` or `.requiredOption()` (\[[#1655](https://togithub.com/tj/commander.js/issues/1655)])
- .`error()` for generating errors from client code just like Commander generated errors, with support for `.configureOutput()`, `.exitOverride()`, and `.showHelpAfterError()` (\[[#1675](https://togithub.com/tj/commander.js/issues/1675)])
- `.optsWithGlobals()` to return merged local and global options (\[[#1671](https://togithub.com/tj/commander.js/issues/1671)])
##### Changed
- *Breaking:* Commander 9 requires Node.js v12.20.0 or higher
- update package-lock.json to lockfile@2 format (\[[#1659](https://togithub.com/tj/commander.js/issues/1659)])
- `showSuggestionAfterError` is now on by default (\[[#1657](https://togithub.com/tj/commander.js/issues/1657)])
- *Breaking:* default value specified for boolean option now always used as default value (see .preset() to match some previous behaviours) (\[[#1652](https://togithub.com/tj/commander.js/issues/1652)])
- default value for boolean option only shown in help if true/false (\[[#1652](https://togithub.com/tj/commander.js/issues/1652)])
- use command name as prefix for subcommand stand-alone executable name (with fallback to script name for backwards compatibility) (\[[#1571](https://togithub.com/tj/commander.js/issues/1571)])
- allow absolute path with `executableFile` (\[[#1571](https://togithub.com/tj/commander.js/issues/1571)])
- removed restriction that nested subcommands must specify `executableFile` (\[[#1571](https://togithub.com/tj/commander.js/issues/1571)])
- TypeScript: allow passing readonly string array to `.choices()` \[([#1667](https://togithub.com/tj/commander.js/issues/1667))]
- TypeScript: allow passing readonly string array to `.parse()`, `.parseAsync()`, `.aliases()` \[([#1669](https://togithub.com/tj/commander.js/issues/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](https://togithub.com/tj/commander.js/issues/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](https://togithub.com/tj/commander.js/issues/1571)])
### [`v8.3.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#830-2021-10-22)
[Compare Source](https://togithub.com/tj/commander.js/compare/v8.2.0...v8.3.0)
##### Added
- `.getOptionValueSource()` and `.setOptionValueWithSource()`, where expected values for source are one of 'default', 'env', 'config', 'cli' (\[[#1613](https://togithub.com/tj/commander.js/issues/1613)])
##### Deprecated
- `.command('*')`, use default command instead (\[[#1612](https://togithub.com/tj/commander.js/issues/1612)])
- `on('command:*')`, use `.showSuggestionAfterError()` instead (\[[#1612](https://togithub.com/tj/commander.js/issues/1612)])
### [`v8.2.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#820-2021-09-10)
[Compare Source](https://togithub.com/tj/commander.js/compare/v8.1.0...v8.2.0)
##### Added
- `.showSuggestionAfterError()` to show suggestions after unknown command or unknown option (\[[#1590](https://togithub.com/tj/commander.js/issues/1590)])
- add `Option` support for values from environment variables using `.env()` (\[[#1587](https://togithub.com/tj/commander.js/issues/1587)])
##### Changed
- show error for unknown global option before subcommand (rather than just help) (\[[#1590](https://togithub.com/tj/commander.js/issues/1590)])
##### Removed
- TypeScript declaration of unimplemented `Option` method `argumentRejected`
### [`v8.1.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#810-2021-07-27)
[Compare Source](https://togithub.com/tj/commander.js/compare/v8.0.0...v8.1.0)
##### Added
- `.copyInheritedSettings()` (\[[#1557](https://togithub.com/tj/commander.js/issues/1557)])
- update Chinese translations of documentation for Commander v8 (\[[#1570](https://togithub.com/tj/commander.js/issues/1570)])
- `Argument` methods for `.argRequired()` and `.argOptional()` (\[[#1567](https://togithub.com/tj/commander.js/issues/1567)])
### [`v8.0.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#800-2021-06-25)
[Compare Source](https://togithub.com/tj/commander.js/compare/v7.2.0...v8.0.0)
##### Added
- `.argument(name, description)` for adding command-arguments (\[[#1490](https://togithub.com/tj/commander.js/issues/1490)])
- supports default value for optional command-arguments (\[[#1508](https://togithub.com/tj/commander.js/issues/1508)])
- supports custom processing function (\[[#1508](https://togithub.com/tj/commander.js/issues/1508)])
- `.createArgument()` factory method (\[[#1497](https://togithub.com/tj/commander.js/issues/1497)])
- `.addArgument()` (\[[#1490](https://togithub.com/tj/commander.js/issues/1490)])
- `Argument` supports `.choices()` (\[[#1525](https://togithub.com/tj/commander.js/issues/1525)])
- `.showHelpAfterError()` to display full help or a custom message after an error (\[[#1534](https://togithub.com/tj/commander.js/issues/1534)])
- `.hook()` with support for `'preAction'` and `'postAction'` callbacks (\[[#1514](https://togithub.com/tj/commander.js/issues/1514)])
- client typing of `.opts()` return type using TypeScript generics (\[[#1539](https://togithub.com/tj/commander.js/issues/1539)])
- the number of command-arguments is checked for programs without an action handler (\[[#1502](https://togithub.com/tj/commander.js/issues/1502)])
- `.getOptionValue()` and `.setOptionValue()` (\[[#1521](https://togithub.com/tj/commander.js/issues/1521)])
##### Changed
- refactor and simplify TypeScript declarations (with no default export) (\[[#1520](https://togithub.com/tj/commander.js/issues/1520)])
- `.parseAsync()` is now declared as `async` (\[[#1513](https://togithub.com/tj/commander.js/issues/1513)])
- *Breaking:* `Help` method `.visibleArguments()` returns array of `Argument` (\[[#1490](https://togithub.com/tj/commander.js/issues/1490)])
- *Breaking:* Commander 8 requires Node.js 12 or higher (\[[#1500](https://togithub.com/tj/commander.js/issues/1500)])
- *Breaking:* `CommanderError` code `commander.invalidOptionArgument` renamed `commander.invalidArgument` (\[[#1508](https://togithub.com/tj/commander.js/issues/1508)])
- *Breaking:* TypeScript declaration for `.addTextHelp()` callback no longer allows result of `undefined`, now just `string` (\[[#1516](https://togithub.com/tj/commander.js/issues/1516)])
- refactor `index.tab` into a file per class (\[[#1522](https://togithub.com/tj/commander.js/issues/1522)])
- remove help suggestion from "unknown command" error message (see `.showHelpAfteError()`) (\[[#1534](https://togithub.com/tj/commander.js/issues/1534)])
- `Command` property `.arg` initialised to empty array (was previously undefined) (\[[#1529](https://togithub.com/tj/commander.js/issues/1529)])
- update dependencies
##### Deprecated
- second parameter of `cmd.description(desc, argDescriptions)` for adding argument descriptions (\[[#1490](https://togithub.com/tj/commander.js/issues/1490)])
- (use new `.argument(name, description)` instead)
- `InvalidOptionArgumentError` (replaced by `InvalidArgumentError`) (\[[#1508](https://togithub.com/tj/commander.js/issues/1508)])
##### Removed
- *Breaking:* TypeScript declaration for default export of global `Command` object (\[[#1520](https://togithub.com/tj/commander.js/issues/1520)])
- (still available as named `program` export)
##### Migration Tips
If you have a simple program without an action handler, you will now get an error if
there are missing command-arguments.
```js
program
.option('-d, --debug')
.arguments('');
program.parse();
```
```sh
$ node trivial.js
error: missing required argument 'file'
```
If you want to show the help in this situation, you could check the arguments before parsing:
```js
if (process.argv.length === 2)
program.help();
program.parse();
```
Or, you might choose to show the help after any user error:
```js
program.showHelpAfterError();
```
### [`v7.2.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#720-2021-03-22)
[Compare Source](https://togithub.com/tj/commander.js/compare/v7.1.0...v7.2.0)
##### Added
- TypeScript typing for `parent` property on `Command` (\[[#1475](https://togithub.com/tj/commander.js/issues/1475)])
- TypeScript typing for `.attributeName()` on `Option` (\[[#1483](https://togithub.com/tj/commander.js/issues/1483)])
- support information in package (\[[#1477](https://togithub.com/tj/commander.js/issues/1477)])
##### Changed
- improvements to error messages, README, and tests
- update dependencies
### [`v7.1.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#710-2021-02-15)
[Compare Source](https://togithub.com/tj/commander.js/compare/v7.0.0...v7.1.0)
##### Added
- support for named imports from ECMAScript modules (\[[#1440](https://togithub.com/tj/commander.js/issues/1440)])
- add `.cjs` to list of expected script file extensions (\[[#1449](https://togithub.com/tj/commander.js/issues/1449)])
- allow using option choices and variadic together (\[[#1454](https://togithub.com/tj/commander.js/issues/1454)])
##### Fixed
- replace use of deprecated `process.mainModule` (\[[#1448](https://togithub.com/tj/commander.js/issues/1448)])
- regression for legacy `command('*')` and call when command line includes options (\[[#1464](https://togithub.com/tj/commander.js/issues/1464)])
- regression for `on('command:*', ...)` and call when command line includes unknown options (\[[#1464](https://togithub.com/tj/commander.js/issues/1464)])
- display best error for combination of unknown command and unknown option (i.e. unknown command) (\[[#1464](https://togithub.com/tj/commander.js/issues/1464)])
##### Changed
- make TypeScript typings tests stricter (\[[#1453](https://togithub.com/tj/commander.js/issues/1453)])
- improvements to README and tests
### [`v7.0.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#700-2021-01-15)
[Compare Source](https://togithub.com/tj/commander.js/compare/v6.2.1...v7.0.0)
##### Added
- `.enablePositionalOptions()` to let program and subcommand reuse same option (\[[#1427](https://togithub.com/tj/commander.js/issues/1427)])
- `.passThroughOptions()` to pass options through to other programs without needing `--` (\[[#1427](https://togithub.com/tj/commander.js/issues/1427)])
- `.allowExcessArguments(false)` to show an error message if there are too many command-arguments on command line for the action handler (\[[#1409](https://togithub.com/tj/commander.js/issues/1409)])
- `.configureOutput()` to modify use of stdout and stderr or customise display of errors (\[[#1387](https://togithub.com/tj/commander.js/issues/1387)])
- use `.addHelpText()` to add text before or after the built-in help, for just current command or also for all subcommands (\[[#1296](https://togithub.com/tj/commander.js/issues/1296)])
- enhance Option class (\[[#1331](https://togithub.com/tj/commander.js/issues/1331)])
- allow hiding options from help
- allow restricting option arguments to a list of choices
- allow setting how default value is shown in help
- `.createOption()` to support subclassing of automatically created options (like `.createCommand()`) (\[[#1380](https://togithub.com/tj/commander.js/issues/1380)])
- refactor the code generating the help into a separate public Help class (\[[#1365](https://togithub.com/tj/commander.js/issues/1365)])
- support sorting subcommands and options in help
- support specifying wrap width (columns)
- allow subclassing Help class
- allow configuring Help class without subclassing
##### Changed
- *Breaking:* options are stored safely by default, not as properties on the command (\[[#1409](https://togithub.com/tj/commander.js/issues/1409)])
- this especially affects accessing options on program, use `program.opts()`
- revert behaviour with `.storeOptionsAsProperties()`
- *Breaking:* action handlers are passed options and command separately (\[[#1409](https://togithub.com/tj/commander.js/issues/1409)])
- deprecated callback parameter to `.help()` and `.outputHelp()` (removed from README) (\[[#1296](https://togithub.com/tj/commander.js/issues/1296)])
- *Breaking:* errors now displayed using `process.stderr.write()` instead of `console.error()`
- deprecate `.on('--help')` (removed from README) (\[[#1296](https://togithub.com/tj/commander.js/issues/1296)])
- initialise the command description to empty string (previously undefined) (\[[#1365](https://togithub.com/tj/commander.js/issues/1365)])
- document and annotate deprecated routines (\[[#1349](https://togithub.com/tj/commander.js/issues/1349)])
##### Fixed
- wrapping bugs in help (\[[#1365](https://togithub.com/tj/commander.js/issues/1365)])
- first line of command description was wrapping two characters early
- pad width calculation was not including help option and help command
- pad width calculation was including hidden options and commands
- improve backwards compatibility for custom command event listeners (\[[#1403](https://togithub.com/tj/commander.js/issues/1403)])
##### Deleted
- *Breaking:* `.passCommandToAction()` (\[[#1409](https://togithub.com/tj/commander.js/issues/1409)])
- no longer needed as action handler is passed options and command
- *Breaking:* "extra arguments" parameter to action handler (\[[#1409](https://togithub.com/tj/commander.js/issues/1409)])
- if being used to detect excess arguments, there is now an error available by setting `.allowExcessArguments(false)`
##### Migration Tips
The biggest change is the parsed option values. Previously the options were stored by default as properties on the command object, and now the options are stored separately.
If you wish to restore the old behaviour and get running quickly you can call `.storeOptionsAsProperties()`.
To allow you to move to the new code patterns incrementally, the action handler will be passed the command *twice*,
to match the new "options" and "command" parameters (see below).
**program options**
Use the `.opts()` method to access the options. This is available on any command but is used most with the program.
```js
program.option('-d, --debug');
program.parse();
// Old code before Commander 7
if (program.debug) console.log(`Program name is ${program.name()}`);
```
```js
// New code
const options = program.opts();
if (options.debug) console.log(`Program name is ${program.name()}`);
```
**action handler**
The action handler gets passed a parameter for each command-argument you declared. Previously by default the next parameter was the command object with the options as properties. Now the next two parameters are instead the options and the command. If you
only accessed the options there may be no code changes required.
```js
program
.command('compress ')
.option('-t, --trace')
// Old code before Commander 7
.action((filename, cmd) => {
if (cmd.trace) console.log(`Command name is ${cmd.name()}`);
});
```
```js
// New code
.action((filename, options, command) => {
if (options.trace) console.log(`Command name is ${command.name()}`);
});
```
If you already set `.storeOptionsAsProperties(false)` you may still need to adjust your code.
```js
program
.command('compress ')
.storeOptionsAsProperties(false)
.option('-t, --trace')
// Old code before Commander 7
.action((filename, command) => {
if (command.opts().trace) console.log(`Command name is ${command.name()}`);
});
```
```js
// New code
.action((filename, options, command) => {
if (command.opts().trace) console.log(`Command name is ${command.name()}`);
});
```
### [`v6.2.1`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#621-2020-12-13)
[Compare Source](https://togithub.com/tj/commander.js/compare/v6.2.0...v6.2.1)
##### Fixed
- some tests failed if directory path included a space (\[1390])
### [`v6.2.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#620-2020-10-25)
[Compare Source](https://togithub.com/tj/commander.js/compare/v6.1.0...v6.2.0)
##### Added
- added 'tsx' file extension for stand-alone executable subcommands (\[[#1368](https://togithub.com/tj/commander.js/issues/1368)])
- documented second parameter to `.description()` to describe command arguments (\[[#1353](https://togithub.com/tj/commander.js/issues/1353)])
- documentation of special cases with options taking varying numbers of option-arguments (\[[#1332](https://togithub.com/tj/commander.js/issues/1332)])
- documentation for terminology (\[[#1361](https://togithub.com/tj/commander.js/issues/1361)])
##### Fixed
- add missing TypeScript definition for \`.addHelpCommand()' (\[[#1375](https://togithub.com/tj/commander.js/issues/1375)])
- removed blank line after "Arguments:" in help, to match "Options:" and "Commands:" (\[[#1360](https://togithub.com/tj/commander.js/issues/1360)])
##### Changed
- update dependencies
### [`v6.1.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#610-2020-08-28)
[Compare Source](https://togithub.com/tj/commander.js/compare/v6.0.0...v6.1.0)
##### Added
- include URL to relevant section of README for error for potential conflict between Command properties and option values (\[[#1306](https://togithub.com/tj/commander.js/issues/1306)])
- `.combineFlagAndOptionalValue(false)` to ease upgrade path from older versions of Commander (\[[#1326](https://togithub.com/tj/commander.js/issues/1326)])
- allow disabling the built-in help option using `.helpOption(false)` (\[[#1325](https://togithub.com/tj/commander.js/issues/1325)])
- allow just some arguments in `argumentDescription` to `.description()` (\[[#1323](https://togithub.com/tj/commander.js/issues/1323)])
##### Changed
- tidy async test and remove lint override (\[[#1312](https://togithub.com/tj/commander.js/issues/1312)])
##### Fixed
- executable subcommand launching when script path not known (\[[#1322](https://togithub.com/tj/commander.js/issues/1322)])
### [`v6.0.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#600-2020-07-21)
[Compare Source](https://togithub.com/tj/commander.js/compare/v5.1.0...v6.0.0)
##### Added
- add support for variadic options (\[[#1250](https://togithub.com/tj/commander.js/issues/1250)])
- allow options to be added with just a short flag (\[[#1256](https://togithub.com/tj/commander.js/issues/1256)])
- *Breaking* the option property has same case as flag. e.g. flag `-n` accessed as `opts().n` (previously uppercase)
- *Breaking* throw an error if there might be a clash between option name and a Command property, with advice on how to resolve (\[[#1275](https://togithub.com/tj/commander.js/issues/1275)])
##### Fixed
- Options which contain -no- in the middle of the option flag should not be treated as negatable. (\[[#1301](https://togithub.com/tj/commander.js/issues/1301)])
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 has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
^5.1.0->^9.0.0Release Notes
tj/commander.js
### [`v9.4.1`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#941-2022-09-30) [Compare Source](https://togithub.com/tj/commander.js/compare/v9.4.0...v9.4.1) ##### Fixed - `.setOptionValue()` now also clears option source (\[[#1795](https://togithub.com/tj/commander.js/issues/1795)]) - TypeScript: add `implied` to `OptionValueSource` for option values set by using `.implies()` (\[[#1794](https://togithub.com/tj/commander.js/issues/1794)]) - TypeScript : add `undefined` to return type of `.getOptionValueSource()` (\[[#1794](https://togithub.com/tj/commander.js/issues/1794)]) ##### Changed - additions to README ### [`v9.4.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#940-2022-07-15) [Compare Source](https://togithub.com/tj/commander.js/compare/v9.3.0...v9.4.0) ##### Added - `preSubcommand` hook called before direct subcommands (\[[#1763](https://togithub.com/tj/commander.js/issues/1763)]) ##### Fixed - export `InvalidOptionArgumentError` in esm (\[[#1756](https://togithub.com/tj/commander.js/issues/1756)]) ##### Changed - update dependencies (\[[#1767](https://togithub.com/tj/commander.js/issues/1767)]) ### [`v9.3.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#930-2022-05-28) [Compare Source](https://togithub.com/tj/commander.js/compare/v9.2.0...v9.3.0) ##### Added - `.summary()` for a short summary to use instead of description when listing subcommands in help (\[[#1726](https://togithub.com/tj/commander.js/issues/1726)]) - `Option.implies()` to set other option values when the option is specified (\[[#1724](https://togithub.com/tj/commander.js/issues/1724)]) - updated Chinese README with 9.x changes (\[[#1727](https://togithub.com/tj/commander.js/issues/1727)]) ##### Fixed - TypeScript: add `string[]` to `.options()` default value parameter type for use with variadic options (\[[#1721](https://togithub.com/tj/commander.js/issues/1721)]) ##### Deprecated - multi-character short option flag (e.g. `-ws`) (\[[#1718](https://togithub.com/tj/commander.js/issues/1718)]) ### [`v9.2.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#920-2022-04-15) [Compare Source](https://togithub.com/tj/commander.js/compare/v9.1.0...v9.2.0) ##### Added - conditional export of 'types' for upcoming TypeScript module resolution (\[[#1703](https://togithub.com/tj/commander.js/issues/1703)]) - example file showing two ways to add global options to subcommands (\[[#1708](https://togithub.com/tj/commander.js/issues/1708)]) ##### Fixed - detect option conflicts in parent commands of called subcommand (\[[#1710](https://togithub.com/tj/commander.js/issues/1710)]) ##### Changed - replace deprecated `String.prototype.substr` (\[[#1706](https://togithub.com/tj/commander.js/issues/1706)]) ### [`v9.1.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#910-2022-03-19) [Compare Source](https://togithub.com/tj/commander.js/compare/v9.0.0...v9.1.0) ##### Added - Option `.conflicts()` to set conflicting options which can not be specified together (\[[#1678](https://togithub.com/tj/commander.js/issues/1678)]) - (developer) CodeQL configuration for GitHub Actions (\[[#1698](https://togithub.com/tj/commander.js/issues/1698)]) ### [`v9.0.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#900-2022-01-28) [Compare Source](https://togithub.com/tj/commander.js/compare/v8.3.0...v9.0.0) ##### Added - simpler ECMAScript import (\[[#1589](https://togithub.com/tj/commander.js/issues/1589)]) - Option.preset() allows specifying value/arg for option when used without option-argument (especially optional, but also boolean option) (\[[#1652](https://togithub.com/tj/commander.js/issues/1652)]) - `.executableDir()` for custom search for subcommands (\[[#1571](https://togithub.com/tj/commander.js/issues/1571)]) - throw with helpful message if pass `Option` to `.option()` or `.requiredOption()` (\[[#1655](https://togithub.com/tj/commander.js/issues/1655)]) - .`error()` for generating errors from client code just like Commander generated errors, with support for `.configureOutput()`, `.exitOverride()`, and `.showHelpAfterError()` (\[[#1675](https://togithub.com/tj/commander.js/issues/1675)]) - `.optsWithGlobals()` to return merged local and global options (\[[#1671](https://togithub.com/tj/commander.js/issues/1671)]) ##### Changed - *Breaking:* Commander 9 requires Node.js v12.20.0 or higher - update package-lock.json to lockfile@2 format (\[[#1659](https://togithub.com/tj/commander.js/issues/1659)]) - `showSuggestionAfterError` is now on by default (\[[#1657](https://togithub.com/tj/commander.js/issues/1657)]) - *Breaking:* default value specified for boolean option now always used as default value (see .preset() to match some previous behaviours) (\[[#1652](https://togithub.com/tj/commander.js/issues/1652)]) - default value for boolean option only shown in help if true/false (\[[#1652](https://togithub.com/tj/commander.js/issues/1652)]) - use command name as prefix for subcommand stand-alone executable name (with fallback to script name for backwards compatibility) (\[[#1571](https://togithub.com/tj/commander.js/issues/1571)]) - allow absolute path with `executableFile` (\[[#1571](https://togithub.com/tj/commander.js/issues/1571)]) - removed restriction that nested subcommands must specify `executableFile` (\[[#1571](https://togithub.com/tj/commander.js/issues/1571)]) - TypeScript: allow passing readonly string array to `.choices()` \[([#1667](https://togithub.com/tj/commander.js/issues/1667))] - TypeScript: allow passing readonly string array to `.parse()`, `.parseAsync()`, `.aliases()` \[([#1669](https://togithub.com/tj/commander.js/issues/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](https://togithub.com/tj/commander.js/issues/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](https://togithub.com/tj/commander.js/issues/1571)]) ### [`v8.3.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#830-2021-10-22) [Compare Source](https://togithub.com/tj/commander.js/compare/v8.2.0...v8.3.0) ##### Added - `.getOptionValueSource()` and `.setOptionValueWithSource()`, where expected values for source are one of 'default', 'env', 'config', 'cli' (\[[#1613](https://togithub.com/tj/commander.js/issues/1613)]) ##### Deprecated - `.command('*')`, use default command instead (\[[#1612](https://togithub.com/tj/commander.js/issues/1612)]) - `on('command:*')`, use `.showSuggestionAfterError()` instead (\[[#1612](https://togithub.com/tj/commander.js/issues/1612)]) ### [`v8.2.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#820-2021-09-10) [Compare Source](https://togithub.com/tj/commander.js/compare/v8.1.0...v8.2.0) ##### Added - `.showSuggestionAfterError()` to show suggestions after unknown command or unknown option (\[[#1590](https://togithub.com/tj/commander.js/issues/1590)]) - add `Option` support for values from environment variables using `.env()` (\[[#1587](https://togithub.com/tj/commander.js/issues/1587)]) ##### Changed - show error for unknown global option before subcommand (rather than just help) (\[[#1590](https://togithub.com/tj/commander.js/issues/1590)]) ##### Removed - TypeScript declaration of unimplemented `Option` method `argumentRejected` ### [`v8.1.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#810-2021-07-27) [Compare Source](https://togithub.com/tj/commander.js/compare/v8.0.0...v8.1.0) ##### Added - `.copyInheritedSettings()` (\[[#1557](https://togithub.com/tj/commander.js/issues/1557)]) - update Chinese translations of documentation for Commander v8 (\[[#1570](https://togithub.com/tj/commander.js/issues/1570)]) - `Argument` methods for `.argRequired()` and `.argOptional()` (\[[#1567](https://togithub.com/tj/commander.js/issues/1567)]) ### [`v8.0.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#800-2021-06-25) [Compare Source](https://togithub.com/tj/commander.js/compare/v7.2.0...v8.0.0) ##### Added - `.argument(name, description)` for adding command-arguments (\[[#1490](https://togithub.com/tj/commander.js/issues/1490)]) - supports default value for optional command-arguments (\[[#1508](https://togithub.com/tj/commander.js/issues/1508)]) - supports custom processing function (\[[#1508](https://togithub.com/tj/commander.js/issues/1508)]) - `.createArgument()` factory method (\[[#1497](https://togithub.com/tj/commander.js/issues/1497)]) - `.addArgument()` (\[[#1490](https://togithub.com/tj/commander.js/issues/1490)]) - `Argument` supports `.choices()` (\[[#1525](https://togithub.com/tj/commander.js/issues/1525)]) - `.showHelpAfterError()` to display full help or a custom message after an error (\[[#1534](https://togithub.com/tj/commander.js/issues/1534)]) - `.hook()` with support for `'preAction'` and `'postAction'` callbacks (\[[#1514](https://togithub.com/tj/commander.js/issues/1514)]) - client typing of `.opts()` return type using TypeScript generics (\[[#1539](https://togithub.com/tj/commander.js/issues/1539)]) - the number of command-arguments is checked for programs without an action handler (\[[#1502](https://togithub.com/tj/commander.js/issues/1502)]) - `.getOptionValue()` and `.setOptionValue()` (\[[#1521](https://togithub.com/tj/commander.js/issues/1521)]) ##### Changed - refactor and simplify TypeScript declarations (with no default export) (\[[#1520](https://togithub.com/tj/commander.js/issues/1520)]) - `.parseAsync()` is now declared as `async` (\[[#1513](https://togithub.com/tj/commander.js/issues/1513)]) - *Breaking:* `Help` method `.visibleArguments()` returns array of `Argument` (\[[#1490](https://togithub.com/tj/commander.js/issues/1490)]) - *Breaking:* Commander 8 requires Node.js 12 or higher (\[[#1500](https://togithub.com/tj/commander.js/issues/1500)]) - *Breaking:* `CommanderError` code `commander.invalidOptionArgument` renamed `commander.invalidArgument` (\[[#1508](https://togithub.com/tj/commander.js/issues/1508)]) - *Breaking:* TypeScript declaration for `.addTextHelp()` callback no longer allows result of `undefined`, now just `string` (\[[#1516](https://togithub.com/tj/commander.js/issues/1516)]) - refactor `index.tab` into a file per class (\[[#1522](https://togithub.com/tj/commander.js/issues/1522)]) - remove help suggestion from "unknown command" error message (see `.showHelpAfteError()`) (\[[#1534](https://togithub.com/tj/commander.js/issues/1534)]) - `Command` property `.arg` initialised to empty array (was previously undefined) (\[[#1529](https://togithub.com/tj/commander.js/issues/1529)]) - update dependencies ##### Deprecated - second parameter of `cmd.description(desc, argDescriptions)` for adding argument descriptions (\[[#1490](https://togithub.com/tj/commander.js/issues/1490)]) - (use new `.argument(name, description)` instead) - `InvalidOptionArgumentError` (replaced by `InvalidArgumentError`) (\[[#1508](https://togithub.com/tj/commander.js/issues/1508)]) ##### Removed - *Breaking:* TypeScript declaration for default export of global `Command` object (\[[#1520](https://togithub.com/tj/commander.js/issues/1520)]) - (still available as named `program` export) ##### Migration Tips If you have a simple program without an action handler, you will now get an error if there are missing command-arguments. ```js program .option('-d, --debug') .arguments('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.
This PR has been generated by Mend Renovate. View repository job log here.