search

inpyjamas / ws-broadcast

A zero config websocket server as a CLI or as a module
MIT License
5 stars 0 forks source link

fix(deps): update dependency commander to v12 #83

Open renovate[bot] opened 7 months ago

renovate[bot] commented 7 months ago

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
commander ^2.19.0 -> ^12.0.0 age adoption passing confidence

Release Notes

tj/commander.js (commander) ### [`v12.1.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#1210-2024-05-18) [Compare Source](https://togithub.com/tj/commander.js/compare/v12.0.0...v12.1.0) ##### Added ### [`v12.0.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#1200-2024-02-03) [Compare Source](https://togithub.com/tj/commander.js/compare/v11.1.0...v12.0.0) ##### Added - `.addHelpOption()` as another way of configuring built-in help option (\[[#​2006](https://togithub.com/tj/commander.js/issues/2006)]) - `.helpCommand()` for configuring built-in help command (\[[#​2087](https://togithub.com/tj/commander.js/issues/2087)]) ##### Fixed - *Breaking:* use non-zero exit code when spawned executable subcommand terminates due to a signal (\[[#​2023](https://togithub.com/tj/commander.js/issues/2023)]) - *Breaking:* check `passThroughOptions` constraints when using `.addCommand` and throw if parent command does not have `.enablePositionalOptions()` enabled (\[[#​1937](https://togithub.com/tj/commander.js/issues/1937)]) ##### Changed - *Breaking:* Commander 12 requires Node.js v18 or higher (\[[#​2027](https://togithub.com/tj/commander.js/issues/2027)]) - *Breaking:* throw an error if add an option with a flag which is already in use (\[[#​2055](https://togithub.com/tj/commander.js/issues/2055)]) - *Breaking:* throw an error if add a command with name or alias which is already in use (\[[#​2059](https://togithub.com/tj/commander.js/issues/2059)]) - *Breaking:* throw error when calling `.storeOptionsAsProperties()` after setting an option value (\[[#​1928](https://togithub.com/tj/commander.js/issues/1928)]) - replace non-standard JSDoc of `@api private` with documented `@private` (\[[#​1949](https://togithub.com/tj/commander.js/issues/1949)]) - `.addHelpCommand()` now takes a Command (passing string or boolean still works as before but deprecated) (\[[#​2087](https://togithub.com/tj/commander.js/issues/2087)]) - refactor internal implementation of built-in help option (\[[#​2006](https://togithub.com/tj/commander.js/issues/2006)]) - refactor internal implementation of built-in help command (\[[#​2087](https://togithub.com/tj/commander.js/issues/2087)]) ##### Deprecated - `.addHelpCommand()` passing string or boolean (use `.helpCommand()` or pass a Command) (\[[#​2087](https://togithub.com/tj/commander.js/issues/2087)]) ##### Removed - *Breaking:* removed default export of a global Command instance from CommonJS (use the named `program` export instead) (\[[#​2017](https://togithub.com/tj/commander.js/issues/2017)]) ##### Migration Tips **global program** If you are using the [deprecated](./docs/deprecated.md#default-import-of-global-command-object) default import of the global Command object, you need to switch to using a named import (or create a new `Command`). ```js // 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`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#1110-2023-10-13) [Compare Source](https://togithub.com/tj/commander.js/compare/v11.0.0...v11.1.0) ##### Fixed - TypeScript: update `OptionValueSource` to allow any string, to match supported use of custom sources (\[[#​1983](https://togithub.com/tj/commander.js/issues/1983)]) - TypeScript: add that `Command.version()` can also be used as getter (\[[#​1982](https://togithub.com/tj/commander.js/issues/1982)]) - TypeScript: add null return type to `Commands.executableDir()`, for when not configured (\[[#​1965](https://togithub.com/tj/commander.js/issues/1965)]) - subcommands with an executable handler and only a short help flag are now handled correctly by the parent's help command (\[[#​1930](https://togithub.com/tj/commander.js/issues/1930)]) ##### Added - `registeredArguments` property on `Command` with the array of defined `Argument` (like `Command.options` for `Option`) (\[[#​2010](https://togithub.com/tj/commander.js/issues/2010)]) - TypeScript declarations for Option properties: `envVar`, `presetArg` (\[[#​2019](https://togithub.com/tj/commander.js/issues/2019)]) - TypeScript declarations for Argument properties: `argChoices`, `defaultValue`, `defaultValueDescription` (\[[#​2019](https://togithub.com/tj/commander.js/issues/2019)]) - example file which shows how to configure help to display any custom usage in the list of subcommands (\[[#​1896](https://togithub.com/tj/commander.js/issues/1896)]) ##### Changed - (developer) refactor TypeScript configs for multiple use-cases, and enable checks in JavaScript files in supporting editors (\[[#​1969](https://togithub.com/tj/commander.js/issues/1969)]) ##### Deprecated - `Command._args` was private anyway, but now available as `registeredArguments` (\[[#​2010](https://togithub.com/tj/commander.js/issues/2010)]) ### [`v11.0.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#1100-2023-06-16) [Compare Source](https://togithub.com/tj/commander.js/compare/v10.0.1...v11.0.0) ##### Fixed - help command works when help option is disabled (\[[#​1864](https://togithub.com/tj/commander.js/issues/1864)]) ##### Changed - leading and trailing spaces are now ignored by the .arguments() method (\[[#​1874](https://togithub.com/tj/commander.js/issues/1874)]) - refine "types" exports for ESM to follow TypeScript guidelines (\[[#​1886](https://togithub.com/tj/commander.js/issues/1886)]) - *Breaking:* Commander 11 requires Node.js v16 or higher ### [`v10.0.1`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#1001-2023-04-15) [Compare Source](https://togithub.com/tj/commander.js/compare/v10.0.0...v10.0.1) ##### Added - improvements to documentation (\[[#​1858](https://togithub.com/tj/commander.js/issues/1858)], \[[#​1859](https://togithub.com/tj/commander.js/issues/1859)], \[[#​1860](https://togithub.com/tj/commander.js/issues/1860)]) ##### Fixed - remove unused `Option.optionFlags` property from TypeScript definition (\[[#​1844](https://togithub.com/tj/commander.js/issues/1844)]) ##### Changed - assume boolean option intended if caller passes string instead of hash to `.implies()` (\[[#​1854](https://togithub.com/tj/commander.js/issues/1854)]) ### [`v10.0.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#1000-2023-01-13) [Compare Source](https://togithub.com/tj/commander.js/compare/v9.5.0...v10.0.0) ##### Added - wrap command description in help (\[[#​1804](https://togithub.com/tj/commander.js/issues/1804)]) ##### Changed - *Breaking:* Commander 10 requires Node.js v14 or higher ### [`v9.5.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#950-2023-01-07) [Compare Source](https://togithub.com/tj/commander.js/compare/v9.4.1...v9.5.0) ##### Added - `.getOptionValueSourceWithGlobals()` (\[[#​1832](https://togithub.com/tj/commander.js/issues/1832)]) - `showGlobalOptions` for `.configureHelp{}` and `Help` (\[[#​1828](https://togithub.com/tj/commander.js/issues/1828)]) ### [`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](https://togithub.com/tj/commander.js/issues/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)]) ### [`v5.1.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#510-2020-04-25) [Compare Source](https://togithub.com/tj/commander.js/compare/v5.0.0...v5.1.0) ##### Added - support for multiple command aliases, the first of which is shown in the auto-generated help (\[[#​531](https://togithub.com/tj/commander.js/issues/531)], \[[#​1236](https://togithub.com/tj/commander.js/issues/1236)]) - configuration support in `addCommand()` for `hidden` and `isDefault` (\[[#​1232](https://togithub.com/tj/commander.js/issues/1232)]) ##### Fixed - omit masked help flags from the displayed help (\[[#​645](https://togithub.com/tj/commander.js/issues/645)], \[[#​1247](https://togithub.com/tj/commander.js/issues/1247)]) - remove old short help flag when change help flags using `helpOption` (\[[#​1248](https://togithub.com/tj/commander.js/issues/1248)]) ##### Changed - remove use of `arguments` to improve auto-generated help in editors (\[[#​1235](https://togithub.com/tj/commander.js/issues/1235)]) - rename `.command()` configuration `noHelp` to `hidden` (but not remove old support) (\[[#​1232](https://togithub.com/tj/commander.js/issues/1232)]) - improvements to documentation - update dependencies - update tested versions of node - eliminate lint errors in TypeScript (\[[#​1208](https://togithub.com/tj/commander.js/issues/1208)]) ### [`v5.0.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#500-2020-03-14) [Compare Source](https://togithub.com/tj/commander.js/compare/v4.1.1...v5.0.0) ##### Added - support for nested commands with action-handlers (\[[#​1](https://togithub.com/tj/commander.js/issues/1)] \[[#​764](https://togithub.com/tj/commander.js/issues/764)] \[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) - `.addCommand()` for adding a separately configured command (\[[#​764](https://togithub.com/tj/commander.js/issues/764)] \[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) - allow a non-executable to be set as the default command (\[[#​742](https://togithub.com/tj/commander.js/issues/742)] \[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) - implicit help command when there are subcommands (previously only if executables) (\[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) - customise implicit help command with `.addHelpCommand()` (\[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) - display error message for unknown subcommand, by default (\[[#​432](https://togithub.com/tj/commander.js/issues/432)] \[[#​1088](https://togithub.com/tj/commander.js/issues/1088)] \[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) - display help for missing subcommand, by default (\[[#​1088](https://togithub.com/tj/commander.js/issues/1088)] \[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) - combined short options as single argument may include boolean flags and value flag and value (e.g. `-a -b -p 80` can be written as `-abp80`) (\[[#​1145](https://togithub.com/tj/commander.js/issues/1145)]) - `.parseOption()` includes short flag and long flag expansions (\[[#​1145](https://togithub.com/tj/commander.js/issues/1145)]) - `.helpInformation()` returns help text as a string, previously a private routine (\[[#​1169](https://togithub.com/tj/commander.js/issues/1169)]) - `.parse()` implicitly uses `process.argv` if arguments not specified (\[[#​1172](https://togithub.com/tj/commander.js/issues/1172)]) - optionally specify where `.parse()` arguments "from", if not following node conventions (\[[#​512](https://togithub.com/tj/commander.js/issues/512)] \[[#​1172](https://togithub.com/tj/commander.js/issues/1172)]) - suggest help option along with unknown command error (\[[#​1179](https://togithub.com/tj/commander.js/issues/1179)]) - TypeScript definition for `commands` property of `Command` (\[[#​1184](https://togithub.com/tj/commander.js/issues/1184)]) - export `program` property (\[[#​1195](https://togithub.com/tj/commander.js/issues/1195)]) - `createCommand` factory method to simplify subclassing (\[[#​1191](https://togithub.com/tj/commander.js/issues/1191)]) ##### Fixed - preserve argument order in subcommands (\[[#​508](https://togithub.com/tj/commander.js/issues/508)] \[[#​962](https://togithub.com/tj/commander.js/issues/962)] \[[#​1138](https://togithub.com/tj/commander.js/issues/1138)]) - do not emit `command:*` for executable subcommands (\[[#​809](https://togithub.com/tj/commander.js/issues/809)] \[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) - action handler called whether or not there are non-option arguments (\[[#​1062](https://togithub.com/tj/commander.js/issues/1062)] \[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) - combining option short flag and value in single argument now works for subcommands (\[[#​1145](https://togithub.com/tj/commander.js/issues/1145)]) - only add implicit help command when it will not conflict with other uses of argument (\[[#​1153](https://togithub.com/tj/commander.js/issues/1153)] \[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) - implicit help command works with command aliases (\[[#​948](https://togithub.com/tj/commander.js/issues/948)] \[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) - options are validated whether or not there is an action handler (\[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) ##### Changed - *Breaking* `.args` contains command arguments with just recognised options removed (\[[#​1032](https://togithub.com/tj/commander.js/issues/1032)] \[[#​1138](https://togithub.com/tj/commander.js/issues/1138)]) - *Breaking* display error if required argument for command is missing (\[[#​995](https://togithub.com/tj/commander.js/issues/995)] \[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) - tighten TypeScript definition of custom option processing function passed to `.option()` (\[[#​1119](https://togithub.com/tj/commander.js/issues/1119)]) - *Breaking* `.allowUnknownOption()` (\[[#​802](https://togithub.com/tj/commander.js/issues/802)] \[[#​1138](https://togithub.com/tj/commander.js/issues/1138)]) - unknown options included in arguments passed to command action handler - unknown options included in `.args` - only recognised option short flags and long flags are expanded (e.g. `-ab` or `--foo=bar`) (\[[#​1145](https://togithub.com/tj/commander.js/issues/1145)]) - *Breaking* `.parseOptions()` (\[[#​1138](https://togithub.com/tj/commander.js/issues/1138)]) - `args` in returned result renamed `operands` and does not include anything after first unknown option - `unknown` in returned result has arguments after first unknown option including operands, not just options and values - *Breaking* `.on('command:*', callback)` and other command events passed (changed) results from `.parseOptions`, i.e. operands and unknown (\[[#​1138](https://togithub.com/tj/commander.js/issues/1138)]) - refactor Option from prototype to class (\[[#​1133](https://togithub.com/tj/commander.js/issues/1133)]) - refactor Command from prototype to class (\[[#​1159](https://togithub.com/tj/commander.js/issues/1159)]) - changes to error handling (\[[#​1165](https://togithub.com/tj/commander.js/issues/1165)]) - throw for author error, not just display message - preflight for variadic error - add tips to missing subcommand executable - TypeScript fluent return types changed to be more subclass friendly, return `this` rather than `Command` (\[[#​1180](https://togithub.com/tj/commander.js/issues/1180)]) - `.parseAsync` returns `Promise` to be consistent with `.parse()` (\[[#​1180](https://togithub.com/tj/commander.js/issues/1180)]) - update dependencies ##### Removed - removed EventEmitter from TypeScript definition for Command, eliminating implicit peer dependency on `@types/node` (\[[#​1146](https://togithub.com/tj/commander.js/issues/1146)]) - removed private function `normalize` (the functionality has been integrated into `parseOptions`) (\[[#​1145](https://togithub.com/tj/commander.js/issues/1145)]) - `parseExpectedArgs` is now private (\[[#​1149](https://togithub.com/tj/commander.js/issues/1149)]) ##### Migration Tips If you use `.on('command:*')` or more complicated tests to detect an unrecognised subcommand, you may be able to delete the code and rely on the default behaviour. If you use `program.args` or more complicated tests to detect a missing subcommand, you may be able to delete the code and rely on the default behaviour. If you use `.command('*')` to add a default command, you may be be able to switch to `isDefault:true` with a named command. If you want to continue combining short options with optional values as though they were boolean flags, set `combineFlagAndOptionalValue(false)` to expand `-fb` to `-f -b` rather than `-f b`. ### [`v4.1.1`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#411-2020-02-02) [Compare Source](https://togithub.com/tj/commander.js/compare/v4.1.0...v4.1.1) ##### Fixed - TypeScript definition for `.action()` should include Promise for async (\[[#​1157](https://togithub.com/tj/commander.js/issues/1157)]) ### [`v4.1.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#410-2020-01-06) [Compare Source](https://togithub.com/tj/commander.js/compare/4.0.1...v4.1.0) ##### Added - two routines to change how option values are handled, and eliminate name clashes with command properties (\[[#​933](https://togithub.com/tj/commander.js/issues/933)] \[[#​1102](https://togithub.com/tj/commander.js/issues/1102)]) - see storeOptionsAsProperties and passCommandToAction in README - `.parseAsync` to use instead of `.parse` if supply async action handlers (\[[#​806](https://togithub.com/tj/commander.js/issues/806)] \[[#​1118](https://togithub.com/tj/commander.js/issues/1118)]) ##### Fixed - Remove trailing blanks from wrapped help text (\[[#​1096](https://togithub.com/tj/commander.js/issues/1096)]) ##### Changed - update dependencies - extend security coverage for Commander 2.x to 2020-02-03 - improvements to README - improvements to TypeScript definition documentation - move old versions out of main CHANGELOG - removed explicit use of `ts-node` in tests ### [`v4.0.1`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#401-2019-11-12) [Compare Source](https://togithub.com/tj/commander.js/compare/v4.0.0...4.0.1) ##### Fixed - display help when requested, even if there are missing required options (\[[#​1091](https://togithub.com/tj/commander.js/issues/1091)]) ### [`v4.0.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#400-2019-11-02) [Compare Source](https://togithub.com/tj/commander.js/compare/v3.0.2...v4.0.0) ##### Added - automatically wrap and indent help descriptions for options and commands (\[[#​1051](https://togithub.com/tj/commander.js/issues/1051)]) - `.exitOverride()` allows override of calls to `process.exit` for additional error handling and to keep program running (\[[#​1040](https://togithub.com/tj/commander.js/issues/1040)]) - support for declaring required options with `.requiredOptions()` (\[[#​1071](https://togithub.com/tj/commander.js/issues/1071)]) - GitHub Actions support (\[[#​1027](https://togithub.com/tj/commander.js/issues/1027)]) - translation links in README ##### Changed - dev: switch tests from Sinon+Should to Jest with major rewrite of tests (\[[#​1035](https://togithub.com/tj/commander.js/issues/1035)]) - call default subcommand even when there are unknown options (\[[#​1047](https://togithub.com/tj/commander.js/issues/1047)]) - *Breaking* Commander is only officially supported on Node 8 and above, and requires Node 6 (\[[#​1053](https://togithub.com/tj/commander.js/issues/1053)]) ##### Fixed - *Breaking* keep command object out of program.args when action handler called (\[[#​1048](https://togithub.com/tj/commander.js/issues/1048)]) - also, action handler now passed array of unknown arguments - complain about unknown options when program argument supplied and action handler (\[[#​1049](https://togithub.com/tj/commander.js/issues/1049)]) - this changes parameters to `command:*` event to include unknown arguments - removed deprecated `customFds` option from call to `child_process.spawn` (\[[#​1052](https://togithub.com/tj/commander.js/issues/1052)]) - rework TypeScript declarations to bring all types into imported namespace (\[[#​1081](https://togithub.com/tj/commander.js/issues/1081)]) ##### Migration Tips ##### Testing for no arguments If you were previously using code like: ```js if (!program.args.length) ... ``` a partial replacement is: ```js if (program.rawArgs.length < 3) ... ``` ### [`v3.0.2`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#302-2019-09-27) [Compare Source](https://togithub.com/tj/commander.js/compare/v3.0.1...v3.0.2) ##### Fixed - Improve tracking of executable subcommands. ##### Changed - update development dependencies ### [`v3.0.1`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#301-2019-08-30) [Compare Source](https://togithub.com/tj/commander.js/compare/v3.0.0...v3.0.1) ##### Added - .name and .usage to README (\[[#​1010](https://togithub.com/tj/commander.js/issues/1010)]) - Table of Contents to README (\[[#​1010](https://togithub.com/tj/commander.js/issues/1010)]) - TypeScript definition for `executableFile` in CommandOptions (\[[#​1028](https://togithub.com/tj/commander.js/issues/1028)]) ##### Changed - consistently use `const` rather than `var` in README (\[[#​1026](https://togithub.com/tj/commander.js/issues/1026)]) ##### Fixed - help for sub commands with custom executableFile (\[[#​1018](https://togithub.com/tj/commander.js/issues/1018)]) ### [`v3.0.0`](https://togithub.com/tj/commander.js/blob/HEAD/CHANGELOG.md#300--2019-08-08) [Compare Source](https://togithub.com/tj/commander.js/compare/v2.20.3...v3.0.0) - Add option to specify executable file name (\[[#​999](https://togithub.com/tj/commander.js/issues/999)]) - e.g. `.command('clone', 'clone description', { executableFile: 'myClone' })` - Change docs for `.command` to contrast action handler vs git-style executable. (\[[#​938](https://togithub.com/tj/commander.js/issues/938)] \[[#​990](https://togithub.com/tj/commander.js/issues/990)]) - **Breaking** Change TypeScript to use overloaded function for `.command`. (\[[#​938](https://togithub.com/tj/commander.js/issues/938)] \[[#​990](https://togithub.com/tj/commander.js/issues/990)]) - Change to use straight quotes around strings in error messages (like 'this' instead of \`this') (\[[#​915](https://togithub.com/tj/commander.js/issues/915)]) - Add TypeScript "reference types" for node (\[[#​974](https://togithub.com/tj/commander.js/issues/974)]) - Add support for hyphen as an option argument in subcommands (\[[#​697](https://togithub.com/tj/commander.js/issues/697)]) - Add support for a short option flag and its value to be concatenated for action handler subcommands (\[[#​599](https://togithub.com/tj/commander.js/issues/599)]) - e.g. `-p 80` can also be supplied as `-p80` - Add executable arguments to spawn in win32, for git-style executables (\[[#​611](https://togithub.com/tj/commander.js/issues/611)]) - e.g. `node --harmony myCommand.js clone` - Add parent command as prefix of subcommand in help (\[[#​980](https://togithub.com/tj/commander.js/issues/980)]) - Add optional custom description to `.version` (\[[#​963](https://togithub.com/tj/commander.js/issues/963)]) - e.g. `program.version('0.0.1', '-v, --vers', 'output the current version')` - Add `.helpOption(flags, description)` routine to customise help flags and description (\[[#​963](https://togithub.com/tj/commander.js/issues/963)]) - e.g. `.helpOption('-e, --HELP', 'read more information')` - Fix behavior of --no-\* options (\[[#​795](https://togithub.com/tj/commander.js/issues/795)]) - can now define both `--foo` and `--no-foo` - **Breaking** custom event listeners: `--no-foo` on cli now emits `option:no-foo` (previously `option:foo`) - **Breaking** default value: defining `--no-foo` after defining `--foo` leaves the default value unchanged (previously set it to false) - allow boolean default value, such as from environment (\[[#​987](https://togithub.com/tj/commander.js/issues/987)]) - Increment inspector port for spawned subcommands (\[[#​991](https://togithub.com/tj/commander.js/issues/991)]) - e.g. `node --inspect myCommand.js clone` ##### Migration Tips The custom event for a negated option like `--no-foo` is `option:no-foo` (previously `option:foo`). ```js program .option('--no-foo') .on('option:no-foo', () => { console.log('removing foo'); }); ``` When using TypeScript, adding a command does not allow an explicit `undefined` for an unwanted executable description (e.g for a command with an action handler). ```js program .command('action1', undefined, { noHelp: true }) // No longer valid .command('action2', { noHelp: true }) // Correct ```

Configuration

šŸ“… Schedule: Branch creation - "every 2 weeks on Monday before 7am" in timezone Europe/Berlin, 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.

This PR was generated by Mend Renovate. View the repository job log.