@@ -8,7 +8,45 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
8
8
<!-- markdownlint-disable MD024 -->
9
9
<!-- markdownlint-disable MD004 -->
10
10
11
- ## [ Unreleased] (date goes here)
11
+ ## [ 8.0.0] (2021-06-25)
12
+
13
+ ### Added
14
+
15
+ - ` .argument(name, description) ` for adding command-arguments ([ #1490 ] )
16
+ - supports default value for optional command-arguments ([ #1508 ] )
17
+ - supports custom processing function ([ #1508 ] )
18
+ - ` .createArgument() ` factory method ([ #1497 ] )
19
+ - ` .addArgument() ` ([ #1490 ] )
20
+ - ` Argument ` supports ` .choices() ` ([ #1525 ] )
21
+ - ` .showHelpAfterError() ` to display full help or a custom message after an error ([ #1534 ] )
22
+ - ` .hook() ` with support for ` 'preAction' ` and ` 'postAction' ` callbacks ([ #1514 ] )
23
+ - client typing of ` .opts() ` return type using TypeScript generics ([ #1539 ] )
24
+ - the number of command-arguments is checked for programs without an action handler ([ #1502 ] )
25
+ - ` .getOptionValue() ` and ` .setOptionValue() ` ([ #1521 ] )
26
+
27
+ ### Changed
28
+
29
+ - refactor and simplify TypeScript declarations (with no default export) ([ #1520 ] )
30
+ - ` .parseAsync() ` is now declared as ` async ` ([ #1513 ] )
31
+ - * Breaking:* ` Help ` method ` .visibleArguments() ` returns array of ` Argument ` ([ #1490 ] )
32
+ - * Breaking:* Commander 8 requires Node.js 12 or higher ([ #1500 ] )
33
+ - * Breaking:* ` CommanderError ` code ` commander.invalidOptionArgument ` renamed ` commander.invalidArgument ` ([ #1508 ] )
34
+ - * Breaking:* TypeScript declaration for ` .addTextHelp() ` callback no longer allows result of ` undefined ` , now just ` string ` ([ #1516 ] )
35
+ - refactor ` index.tab ` into a file per class ([ #1522 ] )
36
+ - remove help suggestion from "unknown command" error message (see ` .showHelpAfteError() ` ) ([ #1534 ] )
37
+ - ` Command ` property ` .arg ` initialised to empty array (was previously undefined) ([ #1529 ] )
38
+ - update dependencies
39
+
40
+ ### Deprecated
41
+
42
+ - second parameter of ` cmd.description(desc, argDescriptions) ` for adding argument descriptions ([ #1490 ] )
43
+ - (use new ` .argument(name, description) ` instead)
44
+ - ` InvalidOptionArgumentError ` (replaced by ` InvalidArgumentError ` ) ([ #1508 ] )
45
+
46
+ ### Removed
47
+
48
+ - * Breaking:* TypeScript declaration for default export of global ` Command ` object ([ #1520 ] )
49
+ - (still available as named ` program ` export)
12
50
13
51
### Migration Tips
14
52
@@ -43,60 +81,15 @@ program.showHelpAfterError();
43
81
44
82
## [ 8.0.0-2] (2021-06-06)
45
83
46
- ### Added
47
-
48
- - ` .showHelpAfterError() ` to display full help or a custom message after an error ([ #1534 ] )
49
- - custom argument processing function also called without action handler (only with action handler in v8.0.0-0) ([ #1529 ] )
50
-
51
- ### Changed
52
-
53
- - remove help suggestion from "unknown command" error message (see ` .showHelpAfteError() ` ) ([ #1534 ] )
54
- - ` Command ` property ` .arg ` initialised to empty array (was previously undefined) ([ #1529 ] )
84
+ (Released in 8.0.0)
55
85
56
86
## [ 8.0.0-1] (2021-05-30)
57
87
58
- ### Added
59
-
60
- - ` .addArgument() ` ([ #1490 ] )
61
- - ` Argument ` supports ` .choices() ` ([ #1525 ] )
62
- - client typing of ` .opts() ` return type using TypeScript generics ([ #1539 ] )
63
-
64
- ### Changed
65
-
66
- - refactor ` index.tab ` into a file per class ([ #1522 ] )
67
- - update dependencies
88
+ (Released in 8.0.0)
68
89
69
90
## [ 8.0.0-0] (2021-05-23)
70
91
71
- ### Added
72
-
73
- - ` .getOptionValue() ` and ` .setOptionValue() ` ([ #1521 ] )
74
- - ` .hook() ` with support for ` 'preAction' ` and ` 'postAction' ` callbacks ([ #1514 ] )
75
- - ` .argument(name, description) ` for adding command-arguments ([ #1490 ] )
76
- - supports default value for optional command-arguments ([ #1508 ] )
77
- - supports custom processing function ([ #1508 ] )
78
- - ` .createArgument() ` factory method ([ #1497 ] )
79
- - the number of command-arguments is checked for programs without an action handler ([ #1502 ] )
80
-
81
- ### Changed
82
-
83
- - refactor and simplify TypeScript declarations (with no default export) ([ #1520 ] )
84
- - ` .parseAsync() ` is now declared as ` async ` ([ #1513 ] )
85
- - * Breaking:* ` Help ` method ` .visibleArguments() ` returns array of ` Argument ` ([ #1490 ] )
86
- - * Breaking:* Commander 8 requires Node.js 12 or higher ([ #1500 ] )
87
- - * Breaking:* ` CommanderError ` code ` commander.invalidOptionArgument ` renamed ` commander.invalidArgument ` ([ #1508 ] )
88
- - * Breaking:* TypeScript declaration for ` .addTextHelp() ` callback no longer allows result of ` undefined ` , now just ` string ` ([ #1516 ] )
89
-
90
- ### Deprecated
91
-
92
- - second parameter of ` cmd.description(desc, argDescriptions) ` for adding argument descriptions ([ #1490 ] )
93
- - (use new ` .argument(name, description) ` instead)
94
- - ` InvalidOptionArgumentError ` (replaced by ` InvalidArgumentError ` ) ([ #1508 ] )
95
-
96
- ### Removed
97
-
98
- - * Breaking:* TypeScript declaration for default export of global ` Command ` object ([ #1520 ] )
99
- - (still available as named ` program ` export)
92
+ (Released in 8.0.0)
100
93
101
94
## [ 7.2.0] (2021-03-22)
102
95
@@ -378,6 +371,7 @@ program
378
371
[ #1539 ] : https://github.com/tj/commander.js/pull/1539
379
372
380
373
[ Unreleased ] : https://github.com/tj/commander.js/compare/master...develop
374
+ [ 8.0.0 ] : https://github.com/tj/commander.js/compare/v7.2.0...v8.0.0
381
375
[ 8.0.0-2 ] : https://github.com/tj/commander.js/compare/v8.0.0-1...v8.0.0-2
382
376
[ 8.0.0-1 ] : https://github.com/tj/commander.js/compare/v8.0.0-0...v8.0.0-1
383
377
[ 8.0.0-0 ] : https://github.com/tj/commander.js/compare/v7.2.0...v8.0.0-0
0 commit comments