commander 3.0.2 → 4.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +370 -347
- package/Readme.md +50 -3
- package/index.js +294 -77
- package/package.json +12 -8
- package/typings/index.d.ts +38 -36
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,73 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
|
6
6
|
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). (Format adopted after v3.0.0.)
|
|
7
7
|
|
|
8
|
+
<!-- markdownlint-disable MD024 -->
|
|
9
|
+
|
|
10
|
+
## [4.0.1] (2019-11-12)
|
|
11
|
+
|
|
12
|
+
### Fixed
|
|
13
|
+
|
|
14
|
+
* display help when requested, even if there are missing required options [(#1091)]
|
|
15
|
+
|
|
16
|
+
## [4.0.0] (2019-11-02)
|
|
17
|
+
|
|
18
|
+
### Added
|
|
19
|
+
|
|
20
|
+
* automatically wrap and indent help descriptions for options and commands ([#1051])
|
|
21
|
+
* `.exitOverride()` allows override of calls to `process.exit` for additional error handling and to keep program running ([#1040])
|
|
22
|
+
* support for declaring required options with `.requiredOptions()` ([#1071])
|
|
23
|
+
* GitHub Actions support ([#1027])
|
|
24
|
+
* translation links in README
|
|
25
|
+
|
|
26
|
+
### Changed
|
|
27
|
+
|
|
28
|
+
* dev: switch tests from Sinon+Should to Jest with major rewrite of tests ([#1035])
|
|
29
|
+
* call default subcommand even when there are unknown options ([#1047])
|
|
30
|
+
* *Breaking* Commander is only officially supported on Node 8 and above, and requires Node 6 ([#1053])
|
|
31
|
+
|
|
32
|
+
### Fixed
|
|
33
|
+
|
|
34
|
+
* *Breaking* keep command object out of program.args when action handler called ([#1048])
|
|
35
|
+
* also, action handler now passed array of unknown arguments
|
|
36
|
+
* complain about unknown options when program argument supplied and action handler ([#1049])
|
|
37
|
+
* this changes parameters to `command:*` event to include unknown arguments
|
|
38
|
+
* removed deprecated `customFds` option from call to `child_process.spawn` ([#1052])
|
|
39
|
+
* rework TypeScript declarations to bring all types into imported namespace ([#1081])
|
|
40
|
+
|
|
41
|
+
### Migration Tips
|
|
42
|
+
|
|
43
|
+
#### Testing for no arguments
|
|
44
|
+
|
|
45
|
+
If you were previously using code like:
|
|
46
|
+
|
|
47
|
+
```js
|
|
48
|
+
if (!program.args.length) ...
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
a partial replacement is:
|
|
52
|
+
|
|
53
|
+
```js
|
|
54
|
+
if (program.rawArgs.length < 3) ...
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## [4.0.0-1] Prerelease (2019-10-08)
|
|
58
|
+
|
|
59
|
+
(Released in 4.0.0)
|
|
60
|
+
|
|
61
|
+
## [4.0.0-0] Prerelease (2019-10-01)
|
|
62
|
+
|
|
63
|
+
(Released in 4.0.0)
|
|
64
|
+
|
|
65
|
+
## [2.20.1] (2019-09-29)
|
|
66
|
+
|
|
67
|
+
### Fixed
|
|
68
|
+
|
|
69
|
+
* Improve tracking of executable subcommands.
|
|
70
|
+
|
|
71
|
+
### Changed
|
|
72
|
+
|
|
73
|
+
* update development dependencies
|
|
74
|
+
|
|
8
75
|
## [3.0.2] (2019-09-27)
|
|
9
76
|
|
|
10
77
|
### Fixed
|
|
@@ -31,35 +98,33 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
|
|
|
31
98
|
|
|
32
99
|
* help for sub commands with custom executableFile ([#1018])
|
|
33
100
|
|
|
34
|
-
3.0.0 / 2019-08-08
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
*
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
*
|
|
45
|
-
|
|
46
|
-
*
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
*
|
|
50
|
-
|
|
51
|
-
*
|
|
52
|
-
|
|
53
|
-
*
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
*
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
Example Breaking Changes
|
|
62
|
-
------------------------
|
|
101
|
+
## [3.0.0] / 2019-08-08
|
|
102
|
+
|
|
103
|
+
* Add option to specify executable file name ([#999])
|
|
104
|
+
* e.g. `.command('clone', 'clone description', { executableFile: 'myClone' })`
|
|
105
|
+
* Change docs for `.command` to contrast action handler vs git-style executable. ([#938] [#990])
|
|
106
|
+
* **Breaking** Change TypeScript to use overloaded function for `.command`. ([#938] [#990])
|
|
107
|
+
* Change to use straight quotes around strings in error messages (like 'this' instead of `this') ([#915])
|
|
108
|
+
* Add TypeScript "reference types" for node ([#974])
|
|
109
|
+
* Add support for hyphen as an option argument in subcommands ([#697])
|
|
110
|
+
* Add support for a short option flag and its value to be concatenated for action handler subcommands ([#599])
|
|
111
|
+
* e.g. `-p 80` can also be supplied as `-p80`
|
|
112
|
+
* Add executable arguments to spawn in win32, for git-style executables ([#611])
|
|
113
|
+
* e.g. `node --harmony myCommand.js clone`
|
|
114
|
+
* Add parent command as prefix of subcommand in help ([#980])
|
|
115
|
+
* Add optional custom description to `.version` ([#963])
|
|
116
|
+
* e.g. `program.version('0.0.1', '-v, --vers', 'output the current version')`
|
|
117
|
+
* Add `.helpOption(flags, description)` routine to customise help flags and description ([#963])
|
|
118
|
+
* e.g. `.helpOption('-e, --HELP', 'read more information')`
|
|
119
|
+
* Fix behavior of --no-* options ([#795])
|
|
120
|
+
* can now define both `--foo` and `--no-foo`
|
|
121
|
+
* **Breaking** custom event listeners: `--no-foo` on cli now emits `option:no-foo` (previously `option:foo`)
|
|
122
|
+
* **Breaking** default value: defining `--no-foo` after defining `--foo` leaves the default value unchanged (previously set it to false)
|
|
123
|
+
* allow boolean default value, such as from environment ([#987])
|
|
124
|
+
* Increment inspector port for spawned subcommands ([#991])
|
|
125
|
+
* e.g. `node --inspect myCommand.js clone`
|
|
126
|
+
|
|
127
|
+
### Migration Tips
|
|
63
128
|
|
|
64
129
|
The custom event for a negated option like `--no-foo` is `option:no-foo` (previously `option:foo`).
|
|
65
130
|
|
|
@@ -80,418 +145,357 @@ program
|
|
|
80
145
|
.command('action2', { noHelp: true }) // Correct
|
|
81
146
|
```
|
|
82
147
|
|
|
83
|
-
3.0.0-0 Prerelease / 2019-07-28
|
|
84
|
-
==============================
|
|
148
|
+
## 3.0.0-0 Prerelease / 2019-07-28
|
|
85
149
|
|
|
86
150
|
(Released as 3.0.0)
|
|
87
151
|
|
|
88
|
-
2.20.0 / 2019-04-02
|
|
89
|
-
|
|
152
|
+
## 2.20.0 / 2019-04-02
|
|
153
|
+
|
|
154
|
+
* fix: resolve symbolic links completely when hunting for subcommands (#935)
|
|
155
|
+
* Update index.d.ts (#930)
|
|
156
|
+
* Update Readme.md (#924)
|
|
157
|
+
* Remove --save option as it isn't required anymore (#918)
|
|
158
|
+
* Add link to the license file (#900)
|
|
159
|
+
* Added example of receiving args from options (#858)
|
|
160
|
+
* Added missing semicolon (#882)
|
|
161
|
+
* Add extension to .eslintrc (#876)
|
|
162
|
+
|
|
163
|
+
## 2.19.0 / 2018-10-02
|
|
164
|
+
|
|
165
|
+
* Removed newline after Options and Commands headers (#864)
|
|
166
|
+
* Bugfix - Error output (#862)
|
|
167
|
+
* Fix to change default value to string (#856)
|
|
168
|
+
|
|
169
|
+
## 2.18.0 / 2018-09-07
|
|
170
|
+
|
|
171
|
+
* Standardize help output (#853)
|
|
172
|
+
* chmod 644 travis.yml (#851)
|
|
173
|
+
* add support for execute typescript subcommand via ts-node (#849)
|
|
174
|
+
|
|
175
|
+
## 2.17.1 / 2018-08-07
|
|
176
|
+
|
|
177
|
+
* Fix bug in command emit (#844)
|
|
178
|
+
|
|
179
|
+
## 2.17.0 / 2018-08-03
|
|
180
|
+
|
|
181
|
+
* fixed newline output after help information (#833)
|
|
182
|
+
* Fix to emit the action even without command (#778)
|
|
183
|
+
* npm update (#823)
|
|
184
|
+
|
|
185
|
+
## 2.16.0 / 2018-06-29
|
|
186
|
+
|
|
187
|
+
* Remove Makefile and `test/run` (#821)
|
|
188
|
+
* Make 'npm test' run on Windows (#820)
|
|
189
|
+
* Add badge to display install size (#807)
|
|
190
|
+
* chore: cache node_modules (#814)
|
|
191
|
+
* chore: remove Node.js 4 (EOL), add Node.js 10 (#813)
|
|
192
|
+
* fixed typo in readme (#812)
|
|
193
|
+
* Fix types (#804)
|
|
194
|
+
* Update eslint to resolve vulnerabilities in lodash (#799)
|
|
195
|
+
* updated readme with custom event listeners. (#791)
|
|
196
|
+
* fix tests (#794)
|
|
197
|
+
|
|
198
|
+
## 2.15.0 / 2018-03-07
|
|
199
|
+
|
|
200
|
+
* Update downloads badge to point to graph of downloads over time instead of duplicating link to npm
|
|
201
|
+
* Arguments description
|
|
202
|
+
|
|
203
|
+
## 2.14.1 / 2018-02-07
|
|
204
|
+
|
|
205
|
+
* Fix typing of help function
|
|
206
|
+
|
|
207
|
+
## 2.14.0 / 2018-02-05
|
|
208
|
+
|
|
209
|
+
* only register the option:version event once
|
|
210
|
+
* Fixes issue #727: Passing empty string for option on command is set to undefined
|
|
211
|
+
* enable eqeqeq rule
|
|
212
|
+
* resolves #754 add linter configuration to project
|
|
213
|
+
* resolves #560 respect custom name for version option
|
|
214
|
+
* document how to override the version flag
|
|
215
|
+
* document using options per command
|
|
216
|
+
|
|
217
|
+
## 2.13.0 / 2018-01-09
|
|
218
|
+
|
|
219
|
+
* Do not print default for --no-
|
|
220
|
+
* remove trailing spaces in command help
|
|
221
|
+
* Update CI's Node.js to LTS and latest version
|
|
222
|
+
* typedefs: Command and Option types added to commander namespace
|
|
223
|
+
|
|
224
|
+
## 2.12.2 / 2017-11-28
|
|
225
|
+
|
|
226
|
+
* fix: typings are not shipped
|
|
227
|
+
|
|
228
|
+
## 2.12.1 / 2017-11-23
|
|
229
|
+
|
|
230
|
+
* Move @types/node to dev dependency
|
|
231
|
+
|
|
232
|
+
## 2.12.0 / 2017-11-22
|
|
233
|
+
|
|
234
|
+
* add attributeName() method to Option objects
|
|
235
|
+
* Documentation updated for options with --no prefix
|
|
236
|
+
* typings: `outputHelp` takes a string as the first parameter
|
|
237
|
+
* typings: use overloads
|
|
238
|
+
* feat(typings): update to match js api
|
|
239
|
+
* Print default value in option help
|
|
240
|
+
* Fix translation error
|
|
241
|
+
* Fail when using same command and alias (#491)
|
|
242
|
+
* feat(typings): add help callback
|
|
243
|
+
* fix bug when description is add after command with options (#662)
|
|
244
|
+
* Format js code
|
|
245
|
+
* Rename History.md to CHANGELOG.md (#668)
|
|
246
|
+
* feat(typings): add typings to support TypeScript (#646)
|
|
247
|
+
* use current node
|
|
248
|
+
|
|
249
|
+
## 2.11.0 / 2017-07-03
|
|
250
|
+
|
|
251
|
+
* Fix help section order and padding (#652)
|
|
252
|
+
* feature: support for signals to subcommands (#632)
|
|
253
|
+
* Fixed #37, --help should not display first (#447)
|
|
254
|
+
* Fix translation errors. (#570)
|
|
255
|
+
* Add package-lock.json
|
|
256
|
+
* Remove engines
|
|
257
|
+
* Upgrade package version
|
|
258
|
+
* Prefix events to prevent conflicts between commands and options (#494)
|
|
259
|
+
* Removing dependency on graceful-readlink
|
|
260
|
+
* Support setting name in #name function and make it chainable
|
|
261
|
+
* Add .vscode directory to .gitignore (Visual Studio Code metadata)
|
|
262
|
+
* Updated link to ruby commander in readme files
|
|
263
|
+
|
|
264
|
+
## 2.10.0 / 2017-06-19
|
|
90
265
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
==================
|
|
109
|
-
|
|
110
|
-
* Standardize help output (#853)
|
|
111
|
-
* chmod 644 travis.yml (#851)
|
|
112
|
-
* add support for execute typescript subcommand via ts-node (#849)
|
|
113
|
-
|
|
114
|
-
2.17.1 / 2018-08-07
|
|
115
|
-
==================
|
|
116
|
-
|
|
117
|
-
* Fix bug in command emit (#844)
|
|
118
|
-
|
|
119
|
-
2.17.0 / 2018-08-03
|
|
120
|
-
==================
|
|
121
|
-
|
|
122
|
-
* fixed newline output after help information (#833)
|
|
123
|
-
* Fix to emit the action even without command (#778)
|
|
124
|
-
* npm update (#823)
|
|
125
|
-
|
|
126
|
-
2.16.0 / 2018-06-29
|
|
127
|
-
==================
|
|
128
|
-
|
|
129
|
-
* Remove Makefile and `test/run` (#821)
|
|
130
|
-
* Make 'npm test' run on Windows (#820)
|
|
131
|
-
* Add badge to display install size (#807)
|
|
132
|
-
* chore: cache node_modules (#814)
|
|
133
|
-
* chore: remove Node.js 4 (EOL), add Node.js 10 (#813)
|
|
134
|
-
* fixed typo in readme (#812)
|
|
135
|
-
* Fix types (#804)
|
|
136
|
-
* Update eslint to resolve vulnerabilities in lodash (#799)
|
|
137
|
-
* updated readme with custom event listeners. (#791)
|
|
138
|
-
* fix tests (#794)
|
|
139
|
-
|
|
140
|
-
2.15.0 / 2018-03-07
|
|
141
|
-
==================
|
|
142
|
-
|
|
143
|
-
* Update downloads badge to point to graph of downloads over time instead of duplicating link to npm
|
|
144
|
-
* Arguments description
|
|
145
|
-
|
|
146
|
-
2.14.1 / 2018-02-07
|
|
147
|
-
==================
|
|
148
|
-
|
|
149
|
-
* Fix typing of help function
|
|
150
|
-
|
|
151
|
-
2.14.0 / 2018-02-05
|
|
152
|
-
==================
|
|
153
|
-
|
|
154
|
-
* only register the option:version event once
|
|
155
|
-
* Fixes issue #727: Passing empty string for option on command is set to undefined
|
|
156
|
-
* enable eqeqeq rule
|
|
157
|
-
* resolves #754 add linter configuration to project
|
|
158
|
-
* resolves #560 respect custom name for version option
|
|
159
|
-
* document how to override the version flag
|
|
160
|
-
* document using options per command
|
|
161
|
-
|
|
162
|
-
2.13.0 / 2018-01-09
|
|
163
|
-
==================
|
|
164
|
-
|
|
165
|
-
* Do not print default for --no-
|
|
166
|
-
* remove trailing spaces in command help
|
|
167
|
-
* Update CI's Node.js to LTS and latest version
|
|
168
|
-
* typedefs: Command and Option types added to commander namespace
|
|
169
|
-
|
|
170
|
-
2.12.2 / 2017-11-28
|
|
171
|
-
==================
|
|
172
|
-
|
|
173
|
-
* fix: typings are not shipped
|
|
174
|
-
|
|
175
|
-
2.12.1 / 2017-11-23
|
|
176
|
-
==================
|
|
177
|
-
|
|
178
|
-
* Move @types/node to dev dependency
|
|
179
|
-
|
|
180
|
-
2.12.0 / 2017-11-22
|
|
181
|
-
==================
|
|
182
|
-
|
|
183
|
-
* add attributeName() method to Option objects
|
|
184
|
-
* Documentation updated for options with --no prefix
|
|
185
|
-
* typings: `outputHelp` takes a string as the first parameter
|
|
186
|
-
* typings: use overloads
|
|
187
|
-
* feat(typings): update to match js api
|
|
188
|
-
* Print default value in option help
|
|
189
|
-
* Fix translation error
|
|
190
|
-
* Fail when using same command and alias (#491)
|
|
191
|
-
* feat(typings): add help callback
|
|
192
|
-
* fix bug when description is add after command with options (#662)
|
|
193
|
-
* Format js code
|
|
194
|
-
* Rename History.md to CHANGELOG.md (#668)
|
|
195
|
-
* feat(typings): add typings to support TypeScript (#646)
|
|
196
|
-
* use current node
|
|
197
|
-
|
|
198
|
-
2.11.0 / 2017-07-03
|
|
199
|
-
==================
|
|
200
|
-
|
|
201
|
-
* Fix help section order and padding (#652)
|
|
202
|
-
* feature: support for signals to subcommands (#632)
|
|
203
|
-
* Fixed #37, --help should not display first (#447)
|
|
204
|
-
* Fix translation errors. (#570)
|
|
205
|
-
* Add package-lock.json
|
|
206
|
-
* Remove engines
|
|
207
|
-
* Upgrade package version
|
|
208
|
-
* Prefix events to prevent conflicts between commands and options (#494)
|
|
209
|
-
* Removing dependency on graceful-readlink
|
|
210
|
-
* Support setting name in #name function and make it chainable
|
|
211
|
-
* Add .vscode directory to .gitignore (Visual Studio Code metadata)
|
|
212
|
-
* Updated link to ruby commander in readme files
|
|
213
|
-
|
|
214
|
-
2.10.0 / 2017-06-19
|
|
215
|
-
==================
|
|
216
|
-
|
|
217
|
-
* Update .travis.yml. drop support for older node.js versions.
|
|
218
|
-
* Fix require arguments in README.md
|
|
219
|
-
* On SemVer you do not start from 0.0.1
|
|
220
|
-
* Add missing semi colon in readme
|
|
221
|
-
* Add save param to npm install
|
|
222
|
-
* node v6 travis test
|
|
223
|
-
* Update Readme_zh-CN.md
|
|
224
|
-
* Allow literal '--' to be passed-through as an argument
|
|
225
|
-
* Test subcommand alias help
|
|
226
|
-
* link build badge to master branch
|
|
227
|
-
* Support the alias of Git style sub-command
|
|
228
|
-
* added keyword commander for better search result on npm
|
|
229
|
-
* Fix Sub-Subcommands
|
|
230
|
-
* test node.js stable
|
|
231
|
-
* Fixes TypeError when a command has an option called `--description`
|
|
232
|
-
* Update README.md to make it beginner friendly and elaborate on the difference between angled and square brackets.
|
|
233
|
-
* Add chinese Readme file
|
|
266
|
+
* Update .travis.yml. drop support for older node.js versions.
|
|
267
|
+
* Fix require arguments in README.md
|
|
268
|
+
* On SemVer you do not start from 0.0.1
|
|
269
|
+
* Add missing semi colon in readme
|
|
270
|
+
* Add save param to npm install
|
|
271
|
+
* node v6 travis test
|
|
272
|
+
* Update Readme_zh-CN.md
|
|
273
|
+
* Allow literal '--' to be passed-through as an argument
|
|
274
|
+
* Test subcommand alias help
|
|
275
|
+
* link build badge to master branch
|
|
276
|
+
* Support the alias of Git style sub-command
|
|
277
|
+
* added keyword commander for better search result on npm
|
|
278
|
+
* Fix Sub-Subcommands
|
|
279
|
+
* test node.js stable
|
|
280
|
+
* Fixes TypeError when a command has an option called `--description`
|
|
281
|
+
* Update README.md to make it beginner friendly and elaborate on the difference between angled and square brackets.
|
|
282
|
+
* Add chinese Readme file
|
|
234
283
|
|
|
235
|
-
2.9.0 / 2015-10-13
|
|
236
|
-
==================
|
|
284
|
+
## 2.9.0 / 2015-10-13
|
|
237
285
|
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
286
|
+
* Add option `isDefault` to set default subcommand #415 @Qix-
|
|
287
|
+
* Add callback to allow filtering or post-processing of help text #434 @djulien
|
|
288
|
+
* Fix `undefined` text in help information close #414 #416 @zhiyelee
|
|
241
289
|
|
|
242
|
-
2.8.1 / 2015-04-22
|
|
243
|
-
==================
|
|
290
|
+
## 2.8.1 / 2015-04-22
|
|
244
291
|
|
|
245
|
-
|
|
292
|
+
* Back out `support multiline description` Close #396 #397
|
|
246
293
|
|
|
247
|
-
2.8.0 / 2015-04-07
|
|
248
|
-
==================
|
|
294
|
+
## 2.8.0 / 2015-04-07
|
|
249
295
|
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
296
|
+
* Add `process.execArg` support, execution args like `--harmony` will be passed to sub-commands #387 @DigitalIO @zhiyelee
|
|
297
|
+
* Fix bug in Git-style sub-commands #372 @zhiyelee
|
|
298
|
+
* Allow commands to be hidden from help #383 @tonylukasavage
|
|
299
|
+
* When git-style sub-commands are in use, yet none are called, display help #382 @claylo
|
|
300
|
+
* Add ability to specify arguments syntax for top-level command #258 @rrthomas
|
|
301
|
+
* Support multiline descriptions #208 @zxqfox
|
|
256
302
|
|
|
257
|
-
2.7.1 / 2015-03-11
|
|
258
|
-
==================
|
|
303
|
+
## 2.7.1 / 2015-03-11
|
|
259
304
|
|
|
260
|
-
|
|
305
|
+
* Revert #347 (fix collisions when option and first arg have same name) which causes a bug in #367.
|
|
261
306
|
|
|
262
|
-
2.7.0 / 2015-03-09
|
|
263
|
-
==================
|
|
307
|
+
## 2.7.0 / 2015-03-09
|
|
264
308
|
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
309
|
+
* Fix git-style bug when installed globally. Close #335 #349 @zhiyelee
|
|
310
|
+
* Fix collisions when option and first arg have same name. Close #346 #347 @tonylukasavage
|
|
311
|
+
* Add support for camelCase on `opts()`. Close #353 @nkzawa
|
|
312
|
+
* Add node.js 0.12 and io.js to travis.yml
|
|
313
|
+
* Allow RegEx options. #337 @palanik
|
|
314
|
+
* Fixes exit code when sub-command failing. Close #260 #332 @pirelenito
|
|
315
|
+
* git-style `bin` files in $PATH make sense. Close #196 #327 @zhiyelee
|
|
272
316
|
|
|
273
|
-
2.6.0 / 2014-12-30
|
|
274
|
-
==================
|
|
317
|
+
## 2.6.0 / 2014-12-30
|
|
275
318
|
|
|
276
|
-
|
|
277
|
-
|
|
319
|
+
* added `Command#allowUnknownOption` method. Close #138 #318 @doozr @zhiyelee
|
|
320
|
+
* Add application description to the help msg. Close #112 @dalssoft
|
|
278
321
|
|
|
279
|
-
2.5.1 / 2014-12-15
|
|
280
|
-
==================
|
|
322
|
+
## 2.5.1 / 2014-12-15
|
|
281
323
|
|
|
282
|
-
|
|
324
|
+
* fixed two bugs incurred by variadic arguments. Close #291 @Quentin01 #302 @zhiyelee
|
|
283
325
|
|
|
284
|
-
2.5.0 / 2014-10-24
|
|
285
|
-
==================
|
|
326
|
+
## 2.5.0 / 2014-10-24
|
|
286
327
|
|
|
287
|
-
|
|
328
|
+
* add support for variadic arguments. Closes #277 @whitlockjc
|
|
288
329
|
|
|
289
|
-
2.4.0 / 2014-10-17
|
|
290
|
-
==================
|
|
330
|
+
## 2.4.0 / 2014-10-17
|
|
291
331
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
332
|
+
* fixed a bug on executing the coercion function of subcommands option. Closes #270
|
|
333
|
+
* added `Command.prototype.name` to retrieve command name. Closes #264 #266 @tonylukasavage
|
|
334
|
+
* added `Command.prototype.opts` to retrieve all the options as a simple object of key-value pairs. Closes #262 @tonylukasavage
|
|
335
|
+
* fixed a bug on subcommand name. Closes #248 @jonathandelgado
|
|
336
|
+
* fixed function normalize doesn’t honor option terminator. Closes #216 @abbr
|
|
297
337
|
|
|
298
|
-
2.3.0 / 2014-07-16
|
|
299
|
-
==================
|
|
338
|
+
## 2.3.0 / 2014-07-16
|
|
300
339
|
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
340
|
+
* add command alias'. Closes PR #210
|
|
341
|
+
* fix: Typos. Closes #99
|
|
342
|
+
* fix: Unused fs module. Closes #217
|
|
304
343
|
|
|
305
|
-
2.2.0 / 2014-03-29
|
|
306
|
-
==================
|
|
344
|
+
## 2.2.0 / 2014-03-29
|
|
307
345
|
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
346
|
+
* add passing of previous option value
|
|
347
|
+
* fix: support subcommands on windows. Closes #142
|
|
348
|
+
* Now the defaultValue passed as the second argument of the coercion function.
|
|
311
349
|
|
|
312
|
-
2.1.0 / 2013-11-21
|
|
313
|
-
==================
|
|
350
|
+
## 2.1.0 / 2013-11-21
|
|
314
351
|
|
|
315
|
-
|
|
352
|
+
* add: allow cflag style option params, unit test, fixes #174
|
|
316
353
|
|
|
317
|
-
2.0.0 / 2013-07-18
|
|
318
|
-
==================
|
|
354
|
+
## 2.0.0 / 2013-07-18
|
|
319
355
|
|
|
320
|
-
|
|
356
|
+
* remove input methods (.prompt, .confirm, etc)
|
|
321
357
|
|
|
322
|
-
1.3.2 / 2013-07-18
|
|
323
|
-
==================
|
|
358
|
+
## 1.3.2 / 2013-07-18
|
|
324
359
|
|
|
325
|
-
|
|
360
|
+
* add support for sub-commands to co-exist with the original command
|
|
326
361
|
|
|
327
|
-
1.3.1 / 2013-07-18
|
|
328
|
-
==================
|
|
362
|
+
## 1.3.1 / 2013-07-18
|
|
329
363
|
|
|
330
|
-
|
|
364
|
+
* add quick .runningCommand hack so you can opt-out of other logic when running a sub command
|
|
331
365
|
|
|
332
|
-
1.3.0 / 2013-07-09
|
|
333
|
-
==================
|
|
366
|
+
## 1.3.0 / 2013-07-09
|
|
334
367
|
|
|
335
|
-
|
|
336
|
-
|
|
368
|
+
* add EACCES error handling
|
|
369
|
+
* fix sub-command --help
|
|
337
370
|
|
|
338
|
-
1.2.0 / 2013-06-13
|
|
339
|
-
==================
|
|
371
|
+
## 1.2.0 / 2013-06-13
|
|
340
372
|
|
|
341
|
-
|
|
342
|
-
|
|
373
|
+
* allow "-" hyphen as an option argument
|
|
374
|
+
* support for RegExp coercion
|
|
343
375
|
|
|
344
|
-
1.1.1 / 2012-11-20
|
|
345
|
-
==================
|
|
376
|
+
## 1.1.1 / 2012-11-20
|
|
346
377
|
|
|
347
|
-
|
|
348
|
-
|
|
378
|
+
* add more sub-command padding
|
|
379
|
+
* fix .usage() when args are present. Closes #106
|
|
349
380
|
|
|
350
|
-
1.1.0 / 2012-11-16
|
|
351
|
-
==================
|
|
381
|
+
## 1.1.0 / 2012-11-16
|
|
352
382
|
|
|
353
|
-
|
|
383
|
+
* add git-style executable subcommand support. Closes #94
|
|
354
384
|
|
|
355
|
-
1.0.5 / 2012-10-09
|
|
356
|
-
==================
|
|
385
|
+
## 1.0.5 / 2012-10-09
|
|
357
386
|
|
|
358
|
-
|
|
359
|
-
|
|
387
|
+
* fix `--name` clobbering. Closes #92
|
|
388
|
+
* fix examples/help. Closes #89
|
|
360
389
|
|
|
361
|
-
1.0.4 / 2012-09-03
|
|
362
|
-
==================
|
|
390
|
+
## 1.0.4 / 2012-09-03
|
|
363
391
|
|
|
364
|
-
|
|
392
|
+
* add `outputHelp()` method.
|
|
365
393
|
|
|
366
|
-
1.0.3 / 2012-08-30
|
|
367
|
-
==================
|
|
394
|
+
## 1.0.3 / 2012-08-30
|
|
368
395
|
|
|
369
|
-
|
|
396
|
+
* remove invalid .version() defaulting
|
|
370
397
|
|
|
371
|
-
1.0.2 / 2012-08-24
|
|
372
|
-
==================
|
|
398
|
+
## 1.0.2 / 2012-08-24
|
|
373
399
|
|
|
374
|
-
|
|
375
|
-
|
|
400
|
+
* add `--foo=bar` support [arv]
|
|
401
|
+
* fix password on node 0.8.8. Make backward compatible with 0.6 [focusaurus]
|
|
376
402
|
|
|
377
|
-
1.0.1 / 2012-08-03
|
|
378
|
-
==================
|
|
403
|
+
## 1.0.1 / 2012-08-03
|
|
379
404
|
|
|
380
|
-
|
|
381
|
-
|
|
405
|
+
* fix issue #56
|
|
406
|
+
* fix tty.setRawMode(mode) was moved to tty.ReadStream#setRawMode() (i.e. process.stdin.setRawMode())
|
|
382
407
|
|
|
383
|
-
1.0.0 / 2012-07-05
|
|
384
|
-
==================
|
|
408
|
+
## 1.0.0 / 2012-07-05
|
|
385
409
|
|
|
386
|
-
|
|
387
|
-
|
|
410
|
+
* add support for optional option descriptions
|
|
411
|
+
* add defaulting of `.version()` to package.json's version
|
|
388
412
|
|
|
389
|
-
0.6.1 / 2012-06-01
|
|
390
|
-
==================
|
|
413
|
+
## 0.6.1 / 2012-06-01
|
|
391
414
|
|
|
392
|
-
|
|
393
|
-
|
|
415
|
+
* Added: append (yes or no) on confirmation
|
|
416
|
+
* Added: allow node.js v0.7.x
|
|
394
417
|
|
|
395
|
-
0.6.0 / 2012-04-10
|
|
396
|
-
==================
|
|
418
|
+
## 0.6.0 / 2012-04-10
|
|
397
419
|
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
420
|
+
* Added `.prompt(obj, callback)` support. Closes #49
|
|
421
|
+
* Added default support to .choose(). Closes #41
|
|
422
|
+
* Fixed the choice example
|
|
401
423
|
|
|
402
|
-
0.5.1 / 2011-12-20
|
|
403
|
-
==================
|
|
424
|
+
## 0.5.1 / 2011-12-20
|
|
404
425
|
|
|
405
|
-
|
|
426
|
+
* Fixed `password()` for recent nodes. Closes #36
|
|
406
427
|
|
|
407
|
-
0.5.0 / 2011-12-04
|
|
408
|
-
==================
|
|
428
|
+
## 0.5.0 / 2011-12-04
|
|
409
429
|
|
|
410
|
-
|
|
430
|
+
* Added sub-command option support [itay]
|
|
411
431
|
|
|
412
|
-
0.4.3 / 2011-12-04
|
|
413
|
-
==================
|
|
432
|
+
## 0.4.3 / 2011-12-04
|
|
414
433
|
|
|
415
|
-
|
|
434
|
+
* Fixed custom help ordering. Closes #32
|
|
416
435
|
|
|
417
|
-
0.4.2 / 2011-11-24
|
|
418
|
-
==================
|
|
436
|
+
## 0.4.2 / 2011-11-24
|
|
419
437
|
|
|
420
|
-
|
|
421
|
-
|
|
438
|
+
* Added travis support
|
|
439
|
+
* Fixed: line-buffered input automatically trimmed. Closes #31
|
|
422
440
|
|
|
423
|
-
0.4.1 / 2011-11-18
|
|
424
|
-
==================
|
|
441
|
+
## 0.4.1 / 2011-11-18
|
|
425
442
|
|
|
426
|
-
|
|
443
|
+
* Removed listening for "close" on --help
|
|
427
444
|
|
|
428
|
-
0.4.0 / 2011-11-15
|
|
429
|
-
==================
|
|
445
|
+
## 0.4.0 / 2011-11-15
|
|
430
446
|
|
|
431
|
-
|
|
447
|
+
* Added support for `--`. Closes #24
|
|
432
448
|
|
|
433
|
-
0.3.3 / 2011-11-14
|
|
434
|
-
==================
|
|
449
|
+
## 0.3.3 / 2011-11-14
|
|
435
450
|
|
|
436
|
-
|
|
451
|
+
* Fixed: wait for close event when writing help info [Jerry Hamlet]
|
|
437
452
|
|
|
438
|
-
0.3.2 / 2011-11-01
|
|
439
|
-
==================
|
|
453
|
+
## 0.3.2 / 2011-11-01
|
|
440
454
|
|
|
441
|
-
|
|
455
|
+
* Fixed long flag definitions with values [felixge]
|
|
442
456
|
|
|
443
|
-
0.3.1 / 2011-10-31
|
|
444
|
-
==================
|
|
457
|
+
## 0.3.1 / 2011-10-31
|
|
445
458
|
|
|
446
|
-
|
|
447
|
-
|
|
459
|
+
* Changed `--version` short flag to `-V` from `-v`
|
|
460
|
+
* Changed `.version()` so it's configurable [felixge]
|
|
448
461
|
|
|
449
|
-
0.3.0 / 2011-10-31
|
|
450
|
-
==================
|
|
462
|
+
## 0.3.0 / 2011-10-31
|
|
451
463
|
|
|
452
|
-
|
|
464
|
+
* Added support for long flags only. Closes #18
|
|
453
465
|
|
|
454
|
-
0.2.1 / 2011-10-24
|
|
455
|
-
==================
|
|
466
|
+
## 0.2.1 / 2011-10-24
|
|
456
467
|
|
|
457
|
-
|
|
468
|
+
* "node": ">= 0.4.x < 0.7.0". Closes #20
|
|
458
469
|
|
|
459
|
-
0.2.0 / 2011-09-26
|
|
460
|
-
==================
|
|
470
|
+
## 0.2.0 / 2011-09-26
|
|
461
471
|
|
|
462
|
-
|
|
472
|
+
* Allow for defaults that are not just boolean. Default peassignment only occurs for --no-*, optional, and required arguments. [Jim Isaacs]
|
|
463
473
|
|
|
464
|
-
0.1.0 / 2011-08-24
|
|
465
|
-
==================
|
|
474
|
+
## 0.1.0 / 2011-08-24
|
|
466
475
|
|
|
467
|
-
|
|
476
|
+
* Added support for custom `--help` output
|
|
468
477
|
|
|
469
|
-
0.0.5 / 2011-08-18
|
|
470
|
-
==================
|
|
478
|
+
## 0.0.5 / 2011-08-18
|
|
471
479
|
|
|
472
|
-
|
|
473
|
-
|
|
480
|
+
* Changed: when the user enters nothing prompt for password again
|
|
481
|
+
* Fixed issue with passwords beginning with numbers [NuckChorris]
|
|
474
482
|
|
|
475
|
-
0.0.4 / 2011-08-15
|
|
476
|
-
==================
|
|
483
|
+
## 0.0.4 / 2011-08-15
|
|
477
484
|
|
|
478
|
-
|
|
485
|
+
* Fixed `Commander#args`
|
|
479
486
|
|
|
480
|
-
0.0.3 / 2011-08-15
|
|
481
|
-
==================
|
|
487
|
+
## 0.0.3 / 2011-08-15
|
|
482
488
|
|
|
483
|
-
|
|
489
|
+
* Added default option value support
|
|
484
490
|
|
|
485
|
-
0.0.2 / 2011-08-15
|
|
486
|
-
==================
|
|
491
|
+
## 0.0.2 / 2011-08-15
|
|
487
492
|
|
|
488
|
-
|
|
489
|
-
|
|
493
|
+
* Added mask support to `Command#password(str[, mask], fn)`
|
|
494
|
+
* Added `Command#password(str, fn)`
|
|
490
495
|
|
|
491
|
-
0.0.1 / 2010-01-03
|
|
492
|
-
==================
|
|
496
|
+
## 0.0.1 / 2010-01-03
|
|
493
497
|
|
|
494
|
-
|
|
498
|
+
* Initial release
|
|
495
499
|
|
|
496
500
|
[#599]: https://github.com/tj/commander.js/issues/599
|
|
497
501
|
[#611]: https://github.com/tj/commander.js/issues/611
|
|
@@ -509,7 +513,26 @@ program
|
|
|
509
513
|
[#1010]: https://github.com/tj/commander.js/pull/1010
|
|
510
514
|
[#1018]: https://github.com/tj/commander.js/pull/1018
|
|
511
515
|
[#1026]: https://github.com/tj/commander.js/pull/1026
|
|
516
|
+
[#1027]: https://github.com/tj/commander.js/pull/1027
|
|
512
517
|
[#1028]: https://github.com/tj/commander.js/pull/1028
|
|
518
|
+
[#1035]: https://github.com/tj/commander.js/pull/1035
|
|
519
|
+
[#1040]: https://github.com/tj/commander.js/pull/1040
|
|
520
|
+
[#1047]: https://github.com/tj/commander.js/pull/1047
|
|
521
|
+
[#1048]: https://github.com/tj/commander.js/pull/1048
|
|
522
|
+
[#1049]: https://github.com/tj/commander.js/pull/1049
|
|
523
|
+
[#1051]: https://github.com/tj/commander.js/pull/1051
|
|
524
|
+
[#1052]: https://github.com/tj/commander.js/pull/1052
|
|
525
|
+
[#1053]: https://github.com/tj/commander.js/pull/1053
|
|
526
|
+
[#1071]: https://github.com/tj/commander.js/pull/1071
|
|
527
|
+
[#1081]: https://github.com/tj/commander.js/pull/1081
|
|
528
|
+
[#1091]: https://github.com/tj/commander.js/pull/1091
|
|
513
529
|
|
|
514
530
|
[Unreleased]: https://github.com/tj/commander.js/compare/master...develop
|
|
531
|
+
[4.0.1]: https://github.com/tj/commander.js/compare/v4.0.0..v4.0.1
|
|
532
|
+
[4.0.0]: https://github.com/tj/commander.js/compare/v3.0.2..v4.0.0
|
|
533
|
+
[4.0.0-1]: https://github.com/tj/commander.js/compare/v4.0.0-0..v4.0.0-1
|
|
534
|
+
[4.0.0-0]: https://github.com/tj/commander.js/compare/v3.0.2...v4.0.0-0
|
|
535
|
+
[3.0.2]: https://github.com/tj/commander.js/compare/v3.0.1...v3.0.2
|
|
515
536
|
[3.0.1]: https://github.com/tj/commander.js/compare/v3.0.0...v3.0.1
|
|
537
|
+
[3.0.0]: https://github.com/tj/commander.js/compare/v2.20.1...v3.0.0
|
|
538
|
+
[2.20.1]: https://github.com/tj/commander.js/compare/v2.20.0...v2.20.1
|