@@ -8,20 +8,44 @@ 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
- ## [ 7.0.0-2] (2020-12-14)
11
+ ## [ 7.0.0] (date goes here)
12
+
13
+ ### Added
14
+
15
+ - * Breaking:* error message if there are too many command-arguments on command line for the action handler ([ #1409 ] )
16
+ - if should be allowed then declare extra arguments, or use ` .allowExcessArguments() `
17
+ - ` .configureOutput() ` to modify use of stdout and stderr or customise display of errors ([ #1387 ] )
18
+ - use ` .addHelpText() ` to add text before or after the built-in help, for just current command or also for all subcommands ([ #1296 ] )
19
+ - enhance Option class ([ #1331 ] )
20
+ - allow hiding options from help
21
+ - allow restricting option arguments to a list of choices
22
+ - allow setting how default value is shown in help
23
+ - ` .createOption() ` to support subclassing of automatically created options (like ` .createCommand() ` ) ([ #1380 ] )
24
+ - refactor the code generating the help into a separate public Help class ([ #1365 ] )
25
+ - support sorting subcommands and options in help
26
+ - support specifying wrap width (columns)
27
+ - allow subclassing Help class
28
+ - allow configuring Help class without subclassing
12
29
13
30
### Changed
14
31
15
32
- * Breaking:* options are stored safely by default, not as properties on the command ([ #1409 ] )
16
33
- this especially affects accessing options on program, use ` program.opts() `
17
34
- revert behaviour with ` .storeOptionsAsProperties() `
18
35
- * Breaking:* action handlers are passed options and command separately ([ #1409 ] )
36
+ - deprecated callback parameter to ` .help() ` and ` .outputHelp() ` (removed from README) ([ #1296 ] )
37
+ - * Breaking:* errors now displayed using ` process.stderr.write() ` instead of ` console.error() `
38
+ - deprecate ` .on('--help') ` (removed from README) ([ #1296 ] )
39
+ - initialise the command description to empty string (previously undefined) ([ #1365 ] )
40
+ - document and annotate deprecated routines ([ #1349 ] )
19
41
20
- ### Added
21
-
22
- - * Breaking:* error message if there are too many command-arguments on command line for the action handler ([ #1409 ] )
23
- - if should be allowed then declare extra arguments, or use ` .allowExcessArguments() `
42
+ ### Fixed
24
43
44
+ - wrapping bugs in help ([ #1365 ] )
45
+ - first line of command description was wrapping two characters early
46
+ - pad width calculation was not including help option and help command
47
+ - pad width calculation was including hidden options and commands
48
+
25
49
### Deleted
26
50
27
51
- * Breaking:* ` .passCommandToAction() ` ([ #1409 ] )
@@ -122,49 +146,18 @@ program
122
146
.action (() => {});
123
147
```
124
148
125
- ## [ 7.0.0-1] (2020-11-21)
126
-
127
- ### Added
149
+ ## [ 7.0.0-2] (2020-12-14)
128
150
129
- - ` .createOption() ` to support subclassing of automatically created options (like ` .createCommand() ` ) ([ #1380 ] )
130
- - ` .configureOutput() ` to modify use of stdout and stderr or customise display of errors ([ #1387 ] )
151
+ (Released in 7.0.0)
131
152
132
- ### Breaking changes relative to 7.0.0-0
153
+ ## [ 7.0.0-1 ] (2020-11-21)
133
154
134
- - rework new ` Help.wrap() ` for simpler usage pattern (#1395 )
135
- - rename new "columns" properties (#1396 )
136
- - ` Help.columns ` -> ` helpWidth `
137
- - ` getOutColumns() ` -> ` getOutHelpWidth() `
138
- - ` getErrColumns() ` -> ` getErrHelpWidth() `
155
+ (Released in 7.0.0)
139
156
140
157
## [ 7.0.0-0] (2020-10-25)
141
158
142
- ### Added
159
+ (Released in 7.0.0)
143
160
144
- - use ` .addHelpText() ` to add text before or after the built-in help, for just current command or also for all subcommands ([ #1296 ] )
145
- - enhance Option class ([ #1331 ] )
146
- - allow hiding options from help
147
- - allow restricting option arguments to a list of choices
148
- - allow setting how default value is shown in help
149
- - refactor the code generating the help into a separate public Help class ([ #1365 ] )
150
- - support sorting subcommands and options in help
151
- - support specifying wrap width (columns)
152
- - allow subclassing Help class
153
- - allow configuring Help class without subclassing
154
-
155
- ### Fixed
156
-
157
- - wrapping bugs in help ([ #1365 ] )
158
- - first line of command description was wrapping two characters early
159
- - pad width calculation was not including help option and help command
160
- - pad width calculation was including hidden options and commands
161
-
162
- ### Changed
163
-
164
- - document and annotate deprecated routines ([ #1349 ] )
165
- - deprecated callback parameter to ` .help() ` and ` .outputHelp() ` (removed from README) ([ #1296 ] )
166
- - deprecate ` .on('--help') ` (removed from README) ([ #1296 ] )
167
- - initialise the command description to empty string (previously undefined) ([ #1365 ] )
168
161
## [ 6.2.1] (2020-12-13)
169
162
170
163
### Fixed
0 commit comments