tj/commander.js
### [`v7.2.0`](https://togithub.com/tj/commander.js/blob/master/CHANGELOG.md#720-2021-03-26)
[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/master/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/master/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/master/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/master/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/master/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/master/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: 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 contains the following updates:
^5.1.0->^7.0.0Release Notes
tj/commander.js
### [`v7.2.0`](https://togithub.com/tj/commander.js/blob/master/CHANGELOG.md#720-2021-03-26) [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/master/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/master/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('compressConfiguration
📅 Schedule: 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 WhiteSource Renovate. View repository job log here.