From 19c8041a3992e6c6a1f6c8fc546766056baac5a2 Mon Sep 17 00:00:00 2001 From: John Gee Date: Tue, 21 Dec 2021 20:44:03 +1300 Subject: [PATCH] Combine back into single CHANGELOG to simplify searches (#1656) --- CHANGELOG.md | 676 +++++++++++++++++++++++++++++++++++++- changelogs/CHANGELOG-0.md | 88 ----- changelogs/CHANGELOG-1.md | 56 ---- changelogs/CHANGELOG-2.md | 219 ------------ changelogs/CHANGELOG-3.md | 103 ------ changelogs/CHANGELOG-4.md | 108 ------ changelogs/CHANGELOG-5.md | 158 --------- 7 files changed, 667 insertions(+), 741 deletions(-) delete mode 100644 changelogs/CHANGELOG-0.md delete mode 100644 changelogs/CHANGELOG-1.md delete mode 100644 changelogs/CHANGELOG-2.md delete mode 100644 changelogs/CHANGELOG-3.md delete mode 100644 changelogs/CHANGELOG-4.md delete mode 100644 changelogs/CHANGELOG-5.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 4bf34a986..cc1940284 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,7 +19,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - `.command('*')`, use default command instead ([#1612]) - `on('command:*')`, use `.showSuggestionAfterError()` instead ([#1612]) - ## [8.2.0] (2021-09-10) ### Added @@ -210,7 +209,7 @@ program.showHelpAfterError(); 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()`. +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). @@ -343,15 +342,581 @@ program (Released in 6.0.0) +## [5.1.0] (2020-04-25) + +### Added + +- support for multiple command aliases, the first of which is shown in the auto-generated help ([#531], [#1236]) +- configuration support in `addCommand()` for `hidden` and `isDefault` ([#1232]) + +### Fixed + +- omit masked help flags from the displayed help ([#645], [#1247]) +- remove old short help flag when change help flags using `helpOption` ([#1248]) + +### Changed + +- remove use of `arguments` to improve auto-generated help in editors ([#1235]) +- rename `.command()` configuration `noHelp` to `hidden` (but not remove old support) ([#1232]) +- improvements to documentation +- update dependencies +- update tested versions of node +- eliminate lint errors in TypeScript ([#1208]) + +## [5.0.0] (2020-03-14) + +### Added + +* support for nested commands with action-handlers ([#1] [#764] [#1149]) +* `.addCommand()` for adding a separately configured command ([#764] [#1149]) +* allow a non-executable to be set as the default command ([#742] [#1149]) +* implicit help command when there are subcommands (previously only if executables) ([#1149]) +* customise implicit help command with `.addHelpCommand()` ([#1149]) +* display error message for unknown subcommand, by default ([#432] [#1088] [#1149]) +* display help for missing subcommand, by default ([#1088] [#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]) +* `.parseOption()` includes short flag and long flag expansions ([#1145]) +* `.helpInformation()` returns help text as a string, previously a private routine ([#1169]) +* `.parse()` implicitly uses `process.argv` if arguments not specified ([#1172]) +* optionally specify where `.parse()` arguments "from", if not following node conventions ([#512] [#1172]) +* suggest help option along with unknown command error ([#1179]) +* TypeScript definition for `commands` property of `Command` ([#1184]) +* export `program` property ([#1195]) +* `createCommand` factory method to simplify subclassing ([#1191]) + +### Fixed + +* preserve argument order in subcommands ([#508] [#962] [#1138]) +* do not emit `command:*` for executable subcommands ([#809] [#1149]) +* action handler called whether or not there are non-option arguments ([#1062] [#1149]) +* combining option short flag and value in single argument now works for subcommands ([#1145]) +* only add implicit help command when it will not conflict with other uses of argument ([#1153] [#1149]) +* implicit help command works with command aliases ([#948] [#1149]) +* options are validated whether or not there is an action handler ([#1149]) + +### Changed + +* *Breaking* `.args` contains command arguments with just recognised options removed ([#1032] [#1138]) +* *Breaking* display error if required argument for command is missing ([#995] [#1149]) +* tighten TypeScript definition of custom option processing function passed to `.option()` ([#1119]) +* *Breaking* `.allowUnknownOption()` ([#802] [#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]) +* *Breaking* `.parseOptions()` ([#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]) +* refactor Option from prototype to class ([#1133]) +* refactor Command from prototype to class ([#1159]) +* changes to error handling ([#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]) +* `.parseAsync` returns `Promise` to be consistent with `.parse()` ([#1180]) +* update dependencies + +### Removed + +* removed EventEmitter from TypeScript definition for Command, eliminating implicit peer dependency on `@types/node` ([#1146]) +* removed private function `normalize` (the functionality has been integrated into `parseOptions`) ([#1145]) +* `parseExpectedArgs` is now private ([#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`. + +## [5.0.0-4] (2020-03-03) + +(Released in 5.0.0) + +## [5.0.0-3] (2020-02-20) + +(Released in 5.0.0) + +## [5.0.0-2] (2020-02-10) + +(Released in 5.0.0) + +## [5.0.0-1] (2020-02-08) + +(Released in 5.0.0) + +## [5.0.0-0] (2020-02-02) + +(Released in 5.0.0) + +## [4.1.1] (2020-02-02) + +### Fixed + +* TypeScript definition for `.action()` should include Promise for async ([#1157]) + +## [4.1.0] (2020-01-06) + +### Added + +* two routines to change how option values are handled, and eliminate name clashes with command properties ([#933] [#1102]) + * see storeOptionsAsProperties and passCommandToAction in README +* `.parseAsync` to use instead of `.parse` if supply async action handlers ([#806] [#1118]) + +### Fixed + +* Remove trailing blanks from wrapped help text ([#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 + +## [4.0.1] (2019-11-12) + +### Fixed + +* display help when requested, even if there are missing required options ([#1091]) + +## [4.0.0] (2019-11-02) + +### Added + +* automatically wrap and indent help descriptions for options and commands ([#1051]) +* `.exitOverride()` allows override of calls to `process.exit` for additional error handling and to keep program running ([#1040]) +* support for declaring required options with `.requiredOptions()` ([#1071]) +* GitHub Actions support ([#1027]) +* translation links in README + +### Changed + +* dev: switch tests from Sinon+Should to Jest with major rewrite of tests ([#1035]) +* call default subcommand even when there are unknown options ([#1047]) +* *Breaking* Commander is only officially supported on Node 8 and above, and requires Node 6 ([#1053]) + +### Fixed + +* *Breaking* keep command object out of program.args when action handler called ([#1048]) + * also, action handler now passed array of unknown arguments +* complain about unknown options when program argument supplied and action handler ([#1049]) + * this changes parameters to `command:*` event to include unknown arguments +* removed deprecated `customFds` option from call to `child_process.spawn` ([#1052]) +* rework TypeScript declarations to bring all types into imported namespace ([#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) ... +``` + +## [4.0.0-1] Prerelease (2019-10-08) + +(Released in 4.0.0) + +## [4.0.0-0] Prerelease (2019-10-01) + +(Released in 4.0.0) + +## [3.0.2] (2019-09-27) + + + +### Fixed + +* Improve tracking of executable subcommands. + +### Changed + +* update development dependencies + +## [3.0.1] (2019-08-30) + +### Added + +* .name and .usage to README ([#1010]) +* Table of Contents to README ([#1010]) +* TypeScript definition for `executableFile` in CommandOptions ([#1028]) + +### Changed + +* consistently use `const` rather than `var` in README ([#1026]) + +### Fixed + +* help for sub commands with custom executableFile ([#1018]) + +## [3.0.0] / 2019-08-08 + +* Add option to specify executable file name ([#999]) + * e.g. `.command('clone', 'clone description', { executableFile: 'myClone' })` +* Change docs for `.command` to contrast action handler vs git-style executable. ([#938] [#990]) +* **Breaking** Change TypeScript to use overloaded function for `.command`. ([#938] [#990]) +* Change to use straight quotes around strings in error messages (like 'this' instead of `this') ([#915]) +* Add TypeScript "reference types" for node ([#974]) +* Add support for hyphen as an option argument in subcommands ([#697]) +* Add support for a short option flag and its value to be concatenated for action handler subcommands ([#599]) + * e.g. `-p 80` can also be supplied as `-p80` +* Add executable arguments to spawn in win32, for git-style executables ([#611]) + * e.g. `node --harmony myCommand.js clone` +* Add parent command as prefix of subcommand in help ([#980]) +* Add optional custom description to `.version` ([#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]) + * e.g. `.helpOption('-e, --HELP', 'read more information')` +* Fix behavior of --no-* options ([#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]) +* Increment inspector port for spawned subcommands ([#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 +``` + +## 3.0.0-0 Prerelease / 2019-07-28 + +(Released as 3.0.0) + +## [2.20.1] (2019-09-29) + +### Fixed + +* Improve tracking of executable subcommands. + +### Changed + +* update development dependencies + +## 2.20.0 / 2019-04-02 + +* fix: resolve symbolic links completely when hunting for subcommands (#935) +* Update index.d.ts (#930) +* Update Readme.md (#924) +* Remove --save option as it isn't required anymore (#918) +* Add link to the license file (#900) +* Added example of receiving args from options (#858) +* Added missing semicolon (#882) +* Add extension to .eslintrc (#876) + +## 2.19.0 / 2018-10-02 + +* Removed newline after Options and Commands headers (#864) +* Bugfix - Error output (#862) +* Fix to change default value to string (#856) + +## 2.18.0 / 2018-09-07 + +* Standardize help output (#853) +* chmod 644 travis.yml (#851) +* add support for execute typescript subcommand via ts-node (#849) + +## 2.17.1 / 2018-08-07 + +* Fix bug in command emit (#844) + +## 2.17.0 / 2018-08-03 + +* fixed newline output after help information (#833) +* Fix to emit the action even without command (#778) +* npm update (#823) + +## 2.16.0 / 2018-06-29 + +* Remove Makefile and `test/run` (#821) +* Make 'npm test' run on Windows (#820) +* Add badge to display install size (#807) +* chore: cache node_modules (#814) +* chore: remove Node.js 4 (EOL), add Node.js 10 (#813) +* fixed typo in readme (#812) +* Fix types (#804) +* Update eslint to resolve vulnerabilities in lodash (#799) +* updated readme with custom event listeners. (#791) +* fix tests (#794) + +## 2.15.0 / 2018-03-07 + +* Update downloads badge to point to graph of downloads over time instead of duplicating link to npm +* Arguments description + +## 2.14.1 / 2018-02-07 + +* Fix typing of help function + +## 2.14.0 / 2018-02-05 + +* only register the option:version event once +* Fixes issue #727: Passing empty string for option on command is set to undefined +* enable eqeqeq rule +* resolves #754 add linter configuration to project +* resolves #560 respect custom name for version option +* document how to override the version flag +* document using options per command + +## 2.13.0 / 2018-01-09 + +* Do not print default for --no- +* remove trailing spaces in command help +* Update CI's Node.js to LTS and latest version +* typedefs: Command and Option types added to commander namespace + +## 2.12.2 / 2017-11-28 + +* fix: typings are not shipped + +## 2.12.1 / 2017-11-23 + +* Move @types/node to dev dependency + +## 2.12.0 / 2017-11-22 + +* add attributeName() method to Option objects +* Documentation updated for options with --no prefix +* typings: `outputHelp` takes a string as the first parameter +* typings: use overloads +* feat(typings): update to match js api +* Print default value in option help +* Fix translation error +* Fail when using same command and alias (#491) +* feat(typings): add help callback +* fix bug when description is add after command with options (#662) +* Format js code +* Rename History.md to CHANGELOG.md (#668) +* feat(typings): add typings to support TypeScript (#646) +* use current node + +## 2.11.0 / 2017-07-03 + +* Fix help section order and padding (#652) +* feature: support for signals to subcommands (#632) +* Fixed #37, --help should not display first (#447) +* Fix translation errors. (#570) +* Add package-lock.json +* Remove engines +* Upgrade package version +* Prefix events to prevent conflicts between commands and options (#494) +* Removing dependency on graceful-readlink +* Support setting name in #name function and make it chainable +* Add .vscode directory to .gitignore (Visual Studio Code metadata) +* Updated link to ruby commander in readme files + +## 2.10.0 / 2017-06-19 + +* Update .travis.yml. drop support for older node.js versions. +* Fix require arguments in README.md +* On SemVer you do not start from 0.0.1 +* Add missing semi colon in readme +* Add save param to npm install +* node v6 travis test +* Update Readme_zh-CN.md +* Allow literal '--' to be passed-through as an argument +* Test subcommand alias help +* link build badge to master branch +* Support the alias of Git style sub-command +* added keyword commander for better search result on npm +* Fix Sub-Subcommands +* test node.js stable +* Fixes TypeError when a command has an option called `--description` +* Update README.md to make it beginner friendly and elaborate on the difference between angled and square brackets. +* Add chinese Readme file + +## 2.9.0 / 2015-10-13 + +* Add option `isDefault` to set default subcommand #415 @Qix- +* Add callback to allow filtering or post-processing of help text #434 @djulien +* Fix `undefined` text in help information close #414 #416 @zhiyelee + +## 2.8.1 / 2015-04-22 + +* Back out `support multiline description` Close #396 #397 + +## 2.8.0 / 2015-04-07 + +* Add `process.execArg` support, execution args like `--harmony` will be passed to sub-commands #387 @DigitalIO @zhiyelee +* Fix bug in Git-style sub-commands #372 @zhiyelee +* Allow commands to be hidden from help #383 @tonylukasavage +* When git-style sub-commands are in use, yet none are called, display help #382 @claylo +* Add ability to specify arguments syntax for top-level command #258 @rrthomas +* Support multiline descriptions #208 @zxqfox + +## 2.7.1 / 2015-03-11 + +* Revert #347 (fix collisions when option and first arg have same name) which causes a bug in #367. + +## 2.7.0 / 2015-03-09 + +* Fix git-style bug when installed globally. Close #335 #349 @zhiyelee +* Fix collisions when option and first arg have same name. Close #346 #347 @tonylukasavage +* Add support for camelCase on `opts()`. Close #353 @nkzawa +* Add node.js 0.12 and io.js to travis.yml +* Allow RegEx options. #337 @palanik +* Fixes exit code when sub-command failing. Close #260 #332 @pirelenito +* git-style `bin` files in $PATH make sense. Close #196 #327 @zhiyelee + +## 2.6.0 / 2014-12-30 + +* added `Command#allowUnknownOption` method. Close #138 #318 @doozr @zhiyelee +* Add application description to the help msg. Close #112 @dalssoft -## Older versions +## 2.5.1 / 2014-12-15 -* [5.x](./changelogs/CHANGELOG-5.md) -* [4.x](./changelogs/CHANGELOG-4.md) -* [3.x](./changelogs/CHANGELOG-3.md) -* [2.x](./changelogs/CHANGELOG-2.md) -* [1.x](./changelogs/CHANGELOG-1.md) -* [0.x](./changelogs/CHANGELOG-0.md) +* fixed two bugs incurred by variadic arguments. Close #291 @Quentin01 #302 @zhiyelee + +## 2.5.0 / 2014-10-24 + +* add support for variadic arguments. Closes #277 @whitlockjc + +## 2.4.0 / 2014-10-17 + +* fixed a bug on executing the coercion function of subcommands option. Closes #270 +* added `Command.prototype.name` to retrieve command name. Closes #264 #266 @tonylukasavage +* added `Command.prototype.opts` to retrieve all the options as a simple object of key-value pairs. Closes #262 @tonylukasavage +* fixed a bug on subcommand name. Closes #248 @jonathandelgado +* fixed function normalize doesn’t honor option terminator. Closes #216 @abbr + +## 2.3.0 / 2014-07-16 + +* add command alias'. Closes PR #210 +* fix: Typos. Closes #99 +* fix: Unused fs module. Closes #217 + +## 2.2.0 / 2014-03-29 + +* add passing of previous option value +* fix: support subcommands on windows. Closes #142 +* Now the defaultValue passed as the second argument of the coercion function. + +## 2.1.0 / 2013-11-21 + +* add: allow cflag style option params, unit test, fixes #174 + +## 2.0.0 / 2013-07-18 + +* remove input methods (.prompt, .confirm, etc) + +## 0.6.1 / 2012-06-01 + +* Added: append (yes or no) on confirmation +* Added: allow node.js v0.7.x + +## 0.6.0 / 2012-04-10 + +* Added `.prompt(obj, callback)` support. Closes #49 +* Added default support to .choose(). Closes #41 +* Fixed the choice example + +## 0.5.1 / 2011-12-20 + +* Fixed `password()` for recent nodes. Closes #36 + +## 0.5.0 / 2011-12-04 + +* Added sub-command option support [itay] + +## 0.4.3 / 2011-12-04 + +* Fixed custom help ordering. Closes #32 + +## 0.4.2 / 2011-11-24 + +* Added travis support +* Fixed: line-buffered input automatically trimmed. Closes #31 + +## 0.4.1 / 2011-11-18 + +* Removed listening for "close" on --help + +## 0.4.0 / 2011-11-15 + +* Added support for `--`. Closes #24 + +## 0.3.3 / 2011-11-14 + +* Fixed: wait for close event when writing help info [Jerry Hamlet] + +## 0.3.2 / 2011-11-01 + +* Fixed long flag definitions with values [felixge] + +## 0.3.1 / 2011-10-31 + +* Changed `--version` short flag to `-V` from `-v` +* Changed `.version()` so it's configurable [felixge] + +## 0.3.0 / 2011-10-31 + +* Added support for long flags only. Closes #18 + +## 0.2.1 / 2011-10-24 + +* "node": ">= 0.4.x < 0.7.0". Closes #20 + +## 0.2.0 / 2011-09-26 + +* Allow for defaults that are not just boolean. Default peassignment only occurs for --no-*, optional, and required arguments. [Jim Isaacs] + +## 0.1.0 / 2011-08-24 + +* Added support for custom `--help` output + +## 0.0.5 / 2011-08-18 + +* Changed: when the user enters nothing prompt for password again +* Fixed issue with passwords beginning with numbers [NuckChorris] + +## 0.0.4 / 2011-08-15 + +* Fixed `Commander#args` + +## 0.0.3 / 2011-08-15 + +* Added default option value support + +## 0.0.2 / 2011-08-15 + +* Added mask support to `Command#password(str[, mask], fn)` +* Added `Command#password(str, fn)` + +## 0.0.1 / 2010-01-03 + +* Initial release [#948]: https://github.com/tj/commander.js/issues/948 [#1032]: https://github.com/tj/commander.js/issues/1032 @@ -412,6 +977,82 @@ program [#1612]: https://github.com/tj/commander.js/pull/1612 [#1613]: https://github.com/tj/commander.js/pull/1613 + +[#1]: https://github.com/tj/commander.js/issues/1 +[#432]: https://github.com/tj/commander.js/issues/432 +[#508]: https://github.com/tj/commander.js/issues/508 +[#512]: https://github.com/tj/commander.js/issues/512 +[#531]: https://github.com/tj/commander.js/issues/531 +[#645]: https://github.com/tj/commander.js/issues/645 +[#742]: https://github.com/tj/commander.js/issues/742 +[#764]: https://github.com/tj/commander.js/issues/764 +[#802]: https://github.com/tj/commander.js/issues/802 +[#809]: https://github.com/tj/commander.js/issues/809 +[#962]: https://github.com/tj/commander.js/issues/962 +[#995]: https://github.com/tj/commander.js/issues/995 +[#1062]: https://github.com/tj/commander.js/pull/1062 +[#1088]: https://github.com/tj/commander.js/issues/1088 +[#1119]: https://github.com/tj/commander.js/pull/1119 +[#1133]: https://github.com/tj/commander.js/pull/1133 +[#1138]: https://github.com/tj/commander.js/pull/1138 +[#1145]: https://github.com/tj/commander.js/pull/1145 +[#1146]: https://github.com/tj/commander.js/pull/1146 +[#1149]: https://github.com/tj/commander.js/pull/1149 +[#1153]: https://github.com/tj/commander.js/issues/1153 +[#1159]: https://github.com/tj/commander.js/pull/1159 +[#1165]: https://github.com/tj/commander.js/pull/1165 +[#1169]: https://github.com/tj/commander.js/pull/1169 +[#1172]: https://github.com/tj/commander.js/pull/1172 +[#1179]: https://github.com/tj/commander.js/pull/1179 +[#1180]: https://github.com/tj/commander.js/pull/1180 +[#1184]: https://github.com/tj/commander.js/pull/1184 +[#1191]: https://github.com/tj/commander.js/pull/1191 +[#1195]: https://github.com/tj/commander.js/pull/1195 +[#1208]: https://github.com/tj/commander.js/pull/1208 +[#1232]: https://github.com/tj/commander.js/pull/1232 +[#1235]: https://github.com/tj/commander.js/pull/1235 +[#1236]: https://github.com/tj/commander.js/pull/1236 +[#1247]: https://github.com/tj/commander.js/pull/1247 +[#1248]: https://github.com/tj/commander.js/pull/1248 + + +[#1027]: https://github.com/tj/commander.js/pull/1027 +[#1035]: https://github.com/tj/commander.js/pull/1035 +[#1040]: https://github.com/tj/commander.js/pull/1040 +[#1047]: https://github.com/tj/commander.js/pull/1047 +[#1048]: https://github.com/tj/commander.js/pull/1048 +[#1049]: https://github.com/tj/commander.js/pull/1049 +[#1051]: https://github.com/tj/commander.js/pull/1051 +[#1052]: https://github.com/tj/commander.js/pull/1052 +[#1053]: https://github.com/tj/commander.js/pull/1053 +[#1071]: https://github.com/tj/commander.js/pull/1071 +[#1081]: https://github.com/tj/commander.js/pull/1081 +[#1091]: https://github.com/tj/commander.js/pull/1091 +[#1096]: https://github.com/tj/commander.js/pull/1096 +[#1102]: https://github.com/tj/commander.js/pull/1102 +[#1118]: https://github.com/tj/commander.js/pull/1118 +[#1157]: https://github.com/tj/commander.js/pull/1157 +[#806]: https://github.com/tj/commander.js/issues/806 + + +[#599]: https://github.com/tj/commander.js/issues/599 +[#611]: https://github.com/tj/commander.js/issues/611 +[#697]: https://github.com/tj/commander.js/issues/697 +[#795]: https://github.com/tj/commander.js/issues/795 +[#915]: https://github.com/tj/commander.js/issues/915 +[#938]: https://github.com/tj/commander.js/issues/938 +[#963]: https://github.com/tj/commander.js/issues/963 +[#974]: https://github.com/tj/commander.js/issues/974 +[#980]: https://github.com/tj/commander.js/issues/980 +[#987]: https://github.com/tj/commander.js/issues/987 +[#990]: https://github.com/tj/commander.js/issues/990 +[#991]: https://github.com/tj/commander.js/issues/991 +[#999]: https://github.com/tj/commander.js/issues/999 +[#1010]: https://github.com/tj/commander.js/pull/1010 +[#1018]: https://github.com/tj/commander.js/pull/1018 +[#1026]: https://github.com/tj/commander.js/pull/1026 +[#1028]: https://github.com/tj/commander.js/pull/1028 + [Unreleased]: https://github.com/tj/commander.js/compare/master...develop [8.3.0]: https://github.com/tj/commander.js/compare/v8.2.0...v8.3.0 [8.2.0]: https://github.com/tj/commander.js/compare/v8.1.0...v8.2.0 @@ -431,3 +1072,20 @@ program [6.1.0]: https://github.com/tj/commander.js/compare/v6.0.0..v6.1.0 [6.0.0]: https://github.com/tj/commander.js/compare/v5.1.0..v6.0.0 [6.0.0-0]: https://github.com/tj/commander.js/compare/v5.1.0..v6.0.0-0 +[5.1.0]: https://github.com/tj/commander.js/compare/v5.0.0..v5.1.0 +[5.0.0]: https://github.com/tj/commander.js/compare/v4.1.1..v5.0.0 +[5.0.0-4]: https://github.com/tj/commander.js/compare/v5.0.0-3..v5.0.0-4 +[5.0.0-3]: https://github.com/tj/commander.js/compare/v5.0.0-2..v5.0.0-3 +[5.0.0-2]: https://github.com/tj/commander.js/compare/v5.0.0-1..v5.0.0-2 +[5.0.0-1]: https://github.com/tj/commander.js/compare/v5.0.0-0..v5.0.0-1 +[5.0.0-0]: https://github.com/tj/commander.js/compare/v4.1.1..v5.0.0-0 +[4.1.1]: https://github.com/tj/commander.js/compare/v4.1.0..v4.1.1 +[4.1.0]: https://github.com/tj/commander.js/compare/v4.0.1..v4.1.0 +[4.0.1]: https://github.com/tj/commander.js/compare/v4.0.0..v4.0.1 +[4.0.0]: https://github.com/tj/commander.js/compare/v3.0.2..v4.0.0 +[4.0.0-1]: https://github.com/tj/commander.js/compare/v4.0.0-0..v4.0.0-1 +[4.0.0-0]: https://github.com/tj/commander.js/compare/v3.0.2...v4.0.0-0 +[3.0.2]: https://github.com/tj/commander.js/compare/v3.0.1...v3.0.2 +[3.0.1]: https://github.com/tj/commander.js/compare/v3.0.0...v3.0.1 +[3.0.0]: https://github.com/tj/commander.js/compare/v2.20.1...v3.0.0 +[2.20.1]: https://github.com/tj/commander.js/compare/v2.20.0...v2.20.1 diff --git a/changelogs/CHANGELOG-0.md b/changelogs/CHANGELOG-0.md deleted file mode 100644 index 07defca8d..000000000 --- a/changelogs/CHANGELOG-0.md +++ /dev/null @@ -1,88 +0,0 @@ -# Changelog for 0.x - -## 0.6.1 / 2012-06-01 - -* Added: append (yes or no) on confirmation -* Added: allow node.js v0.7.x - -## 0.6.0 / 2012-04-10 - -* Added `.prompt(obj, callback)` support. Closes #49 -* Added default support to .choose(). Closes #41 -* Fixed the choice example - -## 0.5.1 / 2011-12-20 - -* Fixed `password()` for recent nodes. Closes #36 - -## 0.5.0 / 2011-12-04 - -* Added sub-command option support [itay] - -## 0.4.3 / 2011-12-04 - -* Fixed custom help ordering. Closes #32 - -## 0.4.2 / 2011-11-24 - -* Added travis support -* Fixed: line-buffered input automatically trimmed. Closes #31 - -## 0.4.1 / 2011-11-18 - -* Removed listening for "close" on --help - -## 0.4.0 / 2011-11-15 - -* Added support for `--`. Closes #24 - -## 0.3.3 / 2011-11-14 - -* Fixed: wait for close event when writing help info [Jerry Hamlet] - -## 0.3.2 / 2011-11-01 - -* Fixed long flag definitions with values [felixge] - -## 0.3.1 / 2011-10-31 - -* Changed `--version` short flag to `-V` from `-v` -* Changed `.version()` so it's configurable [felixge] - -## 0.3.0 / 2011-10-31 - -* Added support for long flags only. Closes #18 - -## 0.2.1 / 2011-10-24 - -* "node": ">= 0.4.x < 0.7.0". Closes #20 - -## 0.2.0 / 2011-09-26 - -* Allow for defaults that are not just boolean. Default peassignment only occurs for --no-*, optional, and required arguments. [Jim Isaacs] - -## 0.1.0 / 2011-08-24 - -* Added support for custom `--help` output - -## 0.0.5 / 2011-08-18 - -* Changed: when the user enters nothing prompt for password again -* Fixed issue with passwords beginning with numbers [NuckChorris] - -## 0.0.4 / 2011-08-15 - -* Fixed `Commander#args` - -## 0.0.3 / 2011-08-15 - -* Added default option value support - -## 0.0.2 / 2011-08-15 - -* Added mask support to `Command#password(str[, mask], fn)` -* Added `Command#password(str, fn)` - -## 0.0.1 / 2010-01-03 - -* Initial release diff --git a/changelogs/CHANGELOG-1.md b/changelogs/CHANGELOG-1.md deleted file mode 100644 index 1eb7ac32e..000000000 --- a/changelogs/CHANGELOG-1.md +++ /dev/null @@ -1,56 +0,0 @@ -# Changelog for 1.x - -## 1.3.2 / 2013-07-18 - -* add support for sub-commands to co-exist with the original command - -## 1.3.1 / 2013-07-18 - -* add quick .runningCommand hack so you can opt-out of other logic when running a sub command - -## 1.3.0 / 2013-07-09 - -* add EACCES error handling -* fix sub-command --help - -## 1.2.0 / 2013-06-13 - -* allow "-" hyphen as an option argument -* support for RegExp coercion - -## 1.1.1 / 2012-11-20 - -* add more sub-command padding -* fix .usage() when args are present. Closes #106 - -## 1.1.0 / 2012-11-16 - -* add git-style executable subcommand support. Closes #94 - -## 1.0.5 / 2012-10-09 - -* fix `--name` clobbering. Closes #92 -* fix examples/help. Closes #89 - -## 1.0.4 / 2012-09-03 - -* add `outputHelp()` method. - -## 1.0.3 / 2012-08-30 - -* remove invalid .version() defaulting - -## 1.0.2 / 2012-08-24 - -* add `--foo=bar` support [arv] -* fix password on node 0.8.8. Make backward compatible with 0.6 [focusaurus] - -## 1.0.1 / 2012-08-03 - -* fix issue #56 -* fix tty.setRawMode(mode) was moved to tty.ReadStream#setRawMode() (i.e. process.stdin.setRawMode()) - -## 1.0.0 / 2012-07-05 - -* add support for optional option descriptions -* add defaulting of `.version()` to package.json's version diff --git a/changelogs/CHANGELOG-2.md b/changelogs/CHANGELOG-2.md deleted file mode 100644 index cb9ae2ca5..000000000 --- a/changelogs/CHANGELOG-2.md +++ /dev/null @@ -1,219 +0,0 @@ -# Changelog for 2.x - -## [2.20.1] (2019-09-29) - -### Fixed - -* Improve tracking of executable subcommands. - -### Changed - -* update development dependencies - -## 2.20.0 / 2019-04-02 - -* fix: resolve symbolic links completely when hunting for subcommands (#935) -* Update index.d.ts (#930) -* Update Readme.md (#924) -* Remove --save option as it isn't required anymore (#918) -* Add link to the license file (#900) -* Added example of receiving args from options (#858) -* Added missing semicolon (#882) -* Add extension to .eslintrc (#876) - -## 2.19.0 / 2018-10-02 - -* Removed newline after Options and Commands headers (#864) -* Bugfix - Error output (#862) -* Fix to change default value to string (#856) - -## 2.18.0 / 2018-09-07 - -* Standardize help output (#853) -* chmod 644 travis.yml (#851) -* add support for execute typescript subcommand via ts-node (#849) - -## 2.17.1 / 2018-08-07 - -* Fix bug in command emit (#844) - -## 2.17.0 / 2018-08-03 - -* fixed newline output after help information (#833) -* Fix to emit the action even without command (#778) -* npm update (#823) - -## 2.16.0 / 2018-06-29 - -* Remove Makefile and `test/run` (#821) -* Make 'npm test' run on Windows (#820) -* Add badge to display install size (#807) -* chore: cache node_modules (#814) -* chore: remove Node.js 4 (EOL), add Node.js 10 (#813) -* fixed typo in readme (#812) -* Fix types (#804) -* Update eslint to resolve vulnerabilities in lodash (#799) -* updated readme with custom event listeners. (#791) -* fix tests (#794) - -## 2.15.0 / 2018-03-07 - -* Update downloads badge to point to graph of downloads over time instead of duplicating link to npm -* Arguments description - -## 2.14.1 / 2018-02-07 - -* Fix typing of help function - -## 2.14.0 / 2018-02-05 - -* only register the option:version event once -* Fixes issue #727: Passing empty string for option on command is set to undefined -* enable eqeqeq rule -* resolves #754 add linter configuration to project -* resolves #560 respect custom name for version option -* document how to override the version flag -* document using options per command - -## 2.13.0 / 2018-01-09 - -* Do not print default for --no- -* remove trailing spaces in command help -* Update CI's Node.js to LTS and latest version -* typedefs: Command and Option types added to commander namespace - -## 2.12.2 / 2017-11-28 - -* fix: typings are not shipped - -## 2.12.1 / 2017-11-23 - -* Move @types/node to dev dependency - -## 2.12.0 / 2017-11-22 - -* add attributeName() method to Option objects -* Documentation updated for options with --no prefix -* typings: `outputHelp` takes a string as the first parameter -* typings: use overloads -* feat(typings): update to match js api -* Print default value in option help -* Fix translation error -* Fail when using same command and alias (#491) -* feat(typings): add help callback -* fix bug when description is add after command with options (#662) -* Format js code -* Rename History.md to CHANGELOG.md (#668) -* feat(typings): add typings to support TypeScript (#646) -* use current node - -## 2.11.0 / 2017-07-03 - -* Fix help section order and padding (#652) -* feature: support for signals to subcommands (#632) -* Fixed #37, --help should not display first (#447) -* Fix translation errors. (#570) -* Add package-lock.json -* Remove engines -* Upgrade package version -* Prefix events to prevent conflicts between commands and options (#494) -* Removing dependency on graceful-readlink -* Support setting name in #name function and make it chainable -* Add .vscode directory to .gitignore (Visual Studio Code metadata) -* Updated link to ruby commander in readme files - -## 2.10.0 / 2017-06-19 - -* Update .travis.yml. drop support for older node.js versions. -* Fix require arguments in README.md -* On SemVer you do not start from 0.0.1 -* Add missing semi colon in readme -* Add save param to npm install -* node v6 travis test -* Update Readme_zh-CN.md -* Allow literal '--' to be passed-through as an argument -* Test subcommand alias help -* link build badge to master branch -* Support the alias of Git style sub-command -* added keyword commander for better search result on npm -* Fix Sub-Subcommands -* test node.js stable -* Fixes TypeError when a command has an option called `--description` -* Update README.md to make it beginner friendly and elaborate on the difference between angled and square brackets. -* Add chinese Readme file - -## 2.9.0 / 2015-10-13 - -* Add option `isDefault` to set default subcommand #415 @Qix- -* Add callback to allow filtering or post-processing of help text #434 @djulien -* Fix `undefined` text in help information close #414 #416 @zhiyelee - -## 2.8.1 / 2015-04-22 - -* Back out `support multiline description` Close #396 #397 - -## 2.8.0 / 2015-04-07 - -* Add `process.execArg` support, execution args like `--harmony` will be passed to sub-commands #387 @DigitalIO @zhiyelee -* Fix bug in Git-style sub-commands #372 @zhiyelee -* Allow commands to be hidden from help #383 @tonylukasavage -* When git-style sub-commands are in use, yet none are called, display help #382 @claylo -* Add ability to specify arguments syntax for top-level command #258 @rrthomas -* Support multiline descriptions #208 @zxqfox - -## 2.7.1 / 2015-03-11 - -* Revert #347 (fix collisions when option and first arg have same name) which causes a bug in #367. - -## 2.7.0 / 2015-03-09 - -* Fix git-style bug when installed globally. Close #335 #349 @zhiyelee -* Fix collisions when option and first arg have same name. Close #346 #347 @tonylukasavage -* Add support for camelCase on `opts()`. Close #353 @nkzawa -* Add node.js 0.12 and io.js to travis.yml -* Allow RegEx options. #337 @palanik -* Fixes exit code when sub-command failing. Close #260 #332 @pirelenito -* git-style `bin` files in $PATH make sense. Close #196 #327 @zhiyelee - -## 2.6.0 / 2014-12-30 - -* added `Command#allowUnknownOption` method. Close #138 #318 @doozr @zhiyelee -* Add application description to the help msg. Close #112 @dalssoft - -## 2.5.1 / 2014-12-15 - -* fixed two bugs incurred by variadic arguments. Close #291 @Quentin01 #302 @zhiyelee - -## 2.5.0 / 2014-10-24 - -* add support for variadic arguments. Closes #277 @whitlockjc - -## 2.4.0 / 2014-10-17 - -* fixed a bug on executing the coercion function of subcommands option. Closes #270 -* added `Command.prototype.name` to retrieve command name. Closes #264 #266 @tonylukasavage -* added `Command.prototype.opts` to retrieve all the options as a simple object of key-value pairs. Closes #262 @tonylukasavage -* fixed a bug on subcommand name. Closes #248 @jonathandelgado -* fixed function normalize doesn’t honor option terminator. Closes #216 @abbr - -## 2.3.0 / 2014-07-16 - -* add command alias'. Closes PR #210 -* fix: Typos. Closes #99 -* fix: Unused fs module. Closes #217 - -## 2.2.0 / 2014-03-29 - -* add passing of previous option value -* fix: support subcommands on windows. Closes #142 -* Now the defaultValue passed as the second argument of the coercion function. - -## 2.1.0 / 2013-11-21 - -* add: allow cflag style option params, unit test, fixes #174 - -## 2.0.0 / 2013-07-18 - -* remove input methods (.prompt, .confirm, etc) - -[2.20.1]: https://github.com/tj/commander.js/compare/v2.20.0...v2.20.1 diff --git a/changelogs/CHANGELOG-3.md b/changelogs/CHANGELOG-3.md deleted file mode 100644 index 40ec19e08..000000000 --- a/changelogs/CHANGELOG-3.md +++ /dev/null @@ -1,103 +0,0 @@ - -# Changelog for 3.x - -## [3.0.2] (2019-09-27) - - - -### Fixed - -* Improve tracking of executable subcommands. - -### Changed - -* update development dependencies - -## [3.0.1] (2019-08-30) - -### Added - -* .name and .usage to README ([#1010]) -* Table of Contents to README ([#1010]) -* TypeScript definition for `executableFile` in CommandOptions ([#1028]) - -### Changed - -* consistently use `const` rather than `var` in README ([#1026]) - -### Fixed - -* help for sub commands with custom executableFile ([#1018]) - -## [3.0.0] / 2019-08-08 - -* Add option to specify executable file name ([#999]) - * e.g. `.command('clone', 'clone description', { executableFile: 'myClone' })` -* Change docs for `.command` to contrast action handler vs git-style executable. ([#938] [#990]) -* **Breaking** Change TypeScript to use overloaded function for `.command`. ([#938] [#990]) -* Change to use straight quotes around strings in error messages (like 'this' instead of `this') ([#915]) -* Add TypeScript "reference types" for node ([#974]) -* Add support for hyphen as an option argument in subcommands ([#697]) -* Add support for a short option flag and its value to be concatenated for action handler subcommands ([#599]) - * e.g. `-p 80` can also be supplied as `-p80` -* Add executable arguments to spawn in win32, for git-style executables ([#611]) - * e.g. `node --harmony myCommand.js clone` -* Add parent command as prefix of subcommand in help ([#980]) -* Add optional custom description to `.version` ([#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]) - * e.g. `.helpOption('-e, --HELP', 'read more information')` -* Fix behavior of --no-* options ([#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]) -* Increment inspector port for spawned subcommands ([#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 -``` - -## 3.0.0-0 Prerelease / 2019-07-28 - -(Released as 3.0.0) - -[#599]: https://github.com/tj/commander.js/issues/599 -[#611]: https://github.com/tj/commander.js/issues/611 -[#697]: https://github.com/tj/commander.js/issues/697 -[#795]: https://github.com/tj/commander.js/issues/795 -[#915]: https://github.com/tj/commander.js/issues/915 -[#938]: https://github.com/tj/commander.js/issues/938 -[#963]: https://github.com/tj/commander.js/issues/963 -[#974]: https://github.com/tj/commander.js/issues/974 -[#980]: https://github.com/tj/commander.js/issues/980 -[#987]: https://github.com/tj/commander.js/issues/987 -[#990]: https://github.com/tj/commander.js/issues/990 -[#991]: https://github.com/tj/commander.js/issues/991 -[#999]: https://github.com/tj/commander.js/issues/999 -[#1010]: https://github.com/tj/commander.js/pull/1010 -[#1018]: https://github.com/tj/commander.js/pull/1018 -[#1026]: https://github.com/tj/commander.js/pull/1026 -[#1028]: https://github.com/tj/commander.js/pull/1028 - -[3.0.2]: https://github.com/tj/commander.js/compare/v3.0.1...v3.0.2 -[3.0.1]: https://github.com/tj/commander.js/compare/v3.0.0...v3.0.1 -[3.0.0]: https://github.com/tj/commander.js/compare/v2.20.1...v3.0.0 diff --git a/changelogs/CHANGELOG-4.md b/changelogs/CHANGELOG-4.md deleted file mode 100644 index 6396313a3..000000000 --- a/changelogs/CHANGELOG-4.md +++ /dev/null @@ -1,108 +0,0 @@ -# Changelog for 4.x - -## [4.1.1] (2020-02-02) - -### Fixed - -* TypeScript definition for `.action()` should include Promise for async ([#1157]) - -## [4.1.0] (2020-01-06) - -### Added - -* two routines to change how option values are handled, and eliminate name clashes with command properties ([#933] [#1102]) - * see storeOptionsAsProperties and passCommandToAction in README -* `.parseAsync` to use instead of `.parse` if supply async action handlers ([#806] [#1118]) - -### Fixed - -* Remove trailing blanks from wrapped help text ([#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 - -## [4.0.1] (2019-11-12) - -### Fixed - -* display help when requested, even if there are missing required options ([#1091]) - -## [4.0.0] (2019-11-02) - -### Added - -* automatically wrap and indent help descriptions for options and commands ([#1051]) -* `.exitOverride()` allows override of calls to `process.exit` for additional error handling and to keep program running ([#1040]) -* support for declaring required options with `.requiredOptions()` ([#1071]) -* GitHub Actions support ([#1027]) -* translation links in README - -### Changed - -* dev: switch tests from Sinon+Should to Jest with major rewrite of tests ([#1035]) -* call default subcommand even when there are unknown options ([#1047]) -* *Breaking* Commander is only officially supported on Node 8 and above, and requires Node 6 ([#1053]) - -### Fixed - -* *Breaking* keep command object out of program.args when action handler called ([#1048]) - * also, action handler now passed array of unknown arguments -* complain about unknown options when program argument supplied and action handler ([#1049]) - * this changes parameters to `command:*` event to include unknown arguments -* removed deprecated `customFds` option from call to `child_process.spawn` ([#1052]) -* rework TypeScript declarations to bring all types into imported namespace ([#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) ... -``` - -## [4.0.0-1] Prerelease (2019-10-08) - -(Released in 4.0.0) - -## [4.0.0-0] Prerelease (2019-10-01) - -(Released in 4.0.0) - -[#1027]: https://github.com/tj/commander.js/pull/1027 -[#1035]: https://github.com/tj/commander.js/pull/1035 -[#1040]: https://github.com/tj/commander.js/pull/1040 -[#1047]: https://github.com/tj/commander.js/pull/1047 -[#1048]: https://github.com/tj/commander.js/pull/1048 -[#1049]: https://github.com/tj/commander.js/pull/1049 -[#1051]: https://github.com/tj/commander.js/pull/1051 -[#1052]: https://github.com/tj/commander.js/pull/1052 -[#1053]: https://github.com/tj/commander.js/pull/1053 -[#1071]: https://github.com/tj/commander.js/pull/1071 -[#1081]: https://github.com/tj/commander.js/pull/1081 -[#1091]: https://github.com/tj/commander.js/pull/1091 -[#1096]: https://github.com/tj/commander.js/pull/1096 -[#1102]: https://github.com/tj/commander.js/pull/1102 -[#1118]: https://github.com/tj/commander.js/pull/1118 -[#1157]: https://github.com/tj/commander.js/pull/1157 -[#806]: https://github.com/tj/commander.js/issues/806 - -[4.1.1]: https://github.com/tj/commander.js/compare/v4.1.0..v4.1.1 -[4.1.0]: https://github.com/tj/commander.js/compare/v4.0.1..v4.1.0 -[4.0.1]: https://github.com/tj/commander.js/compare/v4.0.0..v4.0.1 -[4.0.0]: https://github.com/tj/commander.js/compare/v3.0.2..v4.0.0 -[4.0.0-1]: https://github.com/tj/commander.js/compare/v4.0.0-0..v4.0.0-1 -[4.0.0-0]: https://github.com/tj/commander.js/compare/v3.0.2...v4.0.0-0 diff --git a/changelogs/CHANGELOG-5.md b/changelogs/CHANGELOG-5.md deleted file mode 100644 index 4cf0b7b1d..000000000 --- a/changelogs/CHANGELOG-5.md +++ /dev/null @@ -1,158 +0,0 @@ -# Changelog for 5.x - -## [5.1.0] (2020-04-25) - -### Added - -- support for multiple command aliases, the first of which is shown in the auto-generated help ([#531], [#1236]) -- configuration support in `addCommand()` for `hidden` and `isDefault` ([#1232]) - -### Fixed - -- omit masked help flags from the displayed help ([#645], [#1247]) -- remove old short help flag when change help flags using `helpOption` ([#1248]) - -### Changed - -- remove use of `arguments` to improve auto-generated help in editors ([#1235]) -- rename `.command()` configuration `noHelp` to `hidden` (but not remove old support) ([#1232]) -- improvements to documentation -- update dependencies -- update tested versions of node -- eliminate lint errors in TypeScript ([#1208]) - -## [5.0.0] (2020-03-14) - -### Added - -* support for nested commands with action-handlers ([#1] [#764] [#1149]) -* `.addCommand()` for adding a separately configured command ([#764] [#1149]) -* allow a non-executable to be set as the default command ([#742] [#1149]) -* implicit help command when there are subcommands (previously only if executables) ([#1149]) -* customise implicit help command with `.addHelpCommand()` ([#1149]) -* display error message for unknown subcommand, by default ([#432] [#1088] [#1149]) -* display help for missing subcommand, by default ([#1088] [#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]) -* `.parseOption()` includes short flag and long flag expansions ([#1145]) -* `.helpInformation()` returns help text as a string, previously a private routine ([#1169]) -* `.parse()` implicitly uses `process.argv` if arguments not specified ([#1172]) -* optionally specify where `.parse()` arguments "from", if not following node conventions ([#512] [#1172]) -* suggest help option along with unknown command error ([#1179]) -* TypeScript definition for `commands` property of `Command` ([#1184]) -* export `program` property ([#1195]) -* `createCommand` factory method to simplify subclassing ([#1191]) - -### Fixed - -* preserve argument order in subcommands ([#508] [#962] [#1138]) -* do not emit `command:*` for executable subcommands ([#809] [#1149]) -* action handler called whether or not there are non-option arguments ([#1062] [#1149]) -* combining option short flag and value in single argument now works for subcommands ([#1145]) -* only add implicit help command when it will not conflict with other uses of argument ([#1153] [#1149]) -* implicit help command works with command aliases ([#948] [#1149]) -* options are validated whether or not there is an action handler ([#1149]) - -### Changed - -* *Breaking* `.args` contains command arguments with just recognised options removed ([#1032] [#1138]) -* *Breaking* display error if required argument for command is missing ([#995] [#1149]) -* tighten TypeScript definition of custom option processing function passed to `.option()` ([#1119]) -* *Breaking* `.allowUnknownOption()` ([#802] [#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]) -* *Breaking* `.parseOptions()` ([#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]) -* refactor Option from prototype to class ([#1133]) -* refactor Command from prototype to class ([#1159]) -* changes to error handling ([#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]) -* `.parseAsync` returns `Promise` to be consistent with `.parse()` ([#1180]) -* update dependencies - -### Removed - -* removed EventEmitter from TypeScript definition for Command, eliminating implicit peer dependency on `@types/node` ([#1146]) -* removed private function `normalize` (the functionality has been integrated into `parseOptions`) ([#1145]) -* `parseExpectedArgs` is now private ([#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`. - -## [5.0.0-4] (2020-03-03) - -(Released in 5.0.0) - -## [5.0.0-3] (2020-02-20) - -(Released in 5.0.0) - -## [5.0.0-2] (2020-02-10) - -(Released in 5.0.0) - -## [5.0.0-1] (2020-02-08) - -(Released in 5.0.0) - -## [5.0.0-0] (2020-02-02) - -(Released in 5.0.0) - -[#1]: https://github.com/tj/commander.js/issues/1 -[#432]: https://github.com/tj/commander.js/issues/432 -[#508]: https://github.com/tj/commander.js/issues/508 -[#512]: https://github.com/tj/commander.js/issues/512 -[#531]: https://github.com/tj/commander.js/issues/531 -[#645]: https://github.com/tj/commander.js/issues/645 -[#742]: https://github.com/tj/commander.js/issues/742 -[#764]: https://github.com/tj/commander.js/issues/764 -[#802]: https://github.com/tj/commander.js/issues/802 -[#809]: https://github.com/tj/commander.js/issues/809 -[#962]: https://github.com/tj/commander.js/issues/962 -[#995]: https://github.com/tj/commander.js/issues/995 -[#1062]: https://github.com/tj/commander.js/pull/1062 -[#1088]: https://github.com/tj/commander.js/issues/1088 -[#1119]: https://github.com/tj/commander.js/pull/1119 -[#1133]: https://github.com/tj/commander.js/pull/1133 -[#1138]: https://github.com/tj/commander.js/pull/1138 -[#1145]: https://github.com/tj/commander.js/pull/1145 -[#1146]: https://github.com/tj/commander.js/pull/1146 -[#1149]: https://github.com/tj/commander.js/pull/1149 -[#1153]: https://github.com/tj/commander.js/issues/1153 -[#1159]: https://github.com/tj/commander.js/pull/1159 -[#1165]: https://github.com/tj/commander.js/pull/1165 -[#1169]: https://github.com/tj/commander.js/pull/1169 -[#1172]: https://github.com/tj/commander.js/pull/1172 -[#1179]: https://github.com/tj/commander.js/pull/1179 -[#1180]: https://github.com/tj/commander.js/pull/1180 -[#1184]: https://github.com/tj/commander.js/pull/1184 -[#1191]: https://github.com/tj/commander.js/pull/1191 -[#1195]: https://github.com/tj/commander.js/pull/1195 -[#1208]: https://github.com/tj/commander.js/pull/1208 -[#1232]: https://github.com/tj/commander.js/pull/1232 -[#1235]: https://github.com/tj/commander.js/pull/1235 -[#1236]: https://github.com/tj/commander.js/pull/1236 -[#1247]: https://github.com/tj/commander.js/pull/1247 -[#1248]: https://github.com/tj/commander.js/pull/1248 - -[5.1.0]: https://github.com/tj/commander.js/compare/v5.0.0..v5.1.0 -[5.0.0]: https://github.com/tj/commander.js/compare/v4.1.1..v5.0.0 -[5.0.0-4]: https://github.com/tj/commander.js/compare/v5.0.0-3..v5.0.0-4 -[5.0.0-3]: https://github.com/tj/commander.js/compare/v5.0.0-2..v5.0.0-3 -[5.0.0-2]: https://github.com/tj/commander.js/compare/v5.0.0-1..v5.0.0-2 -[5.0.0-1]: https://github.com/tj/commander.js/compare/v5.0.0-0..v5.0.0-1 -[5.0.0-0]: https://github.com/tj/commander.js/compare/v4.1.1..v5.0.0-0