You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+57-11Lines changed: 57 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -6,17 +6,47 @@ Add new items at the end of the relevant section under **Unreleased**.
6
6
7
7
## [Unreleased]
8
8
9
+
*No changes yet.*
10
+
11
+
---
12
+
13
+
## [1.1.0] - 2022-03-14
14
+
9
15
### Additions
10
16
11
-
- Adds new API for distinguishing between public, hidden, and private arguments and option groups. This will allow the addition of addition help flags to show extended or group-specific help screens. ([#390])
17
+
- A command's `run()` method now supports `async`/`await` when the command
18
+
conforms to `AsyncParsableCommand`. ([#404])
19
+
- New API for distinguishing between public, hidden, and private arguments
20
+
and option groups, and a new extended help screen accessible via
21
+
`--help-hidden`. ([#366], [#390], and [#405 through #413][1.1.0])
22
+
- You can now override the autogenerated usage string when configuring a
23
+
command. ([#400])
24
+
25
+
### Changes
26
+
27
+
-`ArgumentParser` now requires Swift 5.5.
28
+
29
+
### Fixes
30
+
31
+
- The auto-generated usage string now correctly hides all optional parameters
32
+
when over the length limit. ([#416])
33
+
- One `@Option` initializer now has its parameters in the correct order; the
34
+
incorrect initializer is deprecated. ([#391])
35
+
- Help flags are now correctly captured in `.unconditionalRemaining` argument
36
+
arrays.
37
+
- Documentation fixes and improvements.
38
+
39
+
The 1.1.0 release includes contributions from [keith], [MartinP7r], [McNight],
40
+
[natecook1000], [rauhul], and [zkiraly]. Thank you!
12
41
13
42
---
14
43
15
44
## [1.0.3] - 2022-01-31
16
45
17
46
### Changes
18
47
19
-
- When a user provides an incorrect value for an option, an `ArgumentParser`-based program now includes the valid values when possible.
48
+
- When a user provides an incorrect value for an option, an
49
+
`ArgumentParser`-based program now includes the valid values when possible.
20
50
21
51
```
22
52
$ example --format png
@@ -26,29 +56,37 @@ Add new items at the end of the relevant section under **Unreleased**.
26
56
27
57
### Fixes
28
58
29
-
- Resolves an issue with `zsh` custom completions for command names that include a dash.
59
+
- Resolves an issue with `zsh` custom completions for command names that include
60
+
a dash.
30
61
- Improves the generated completions scripts for `fish`.
31
-
- Resolves issues that prevented building `ArgumentParser` for WebAssembly using SwiftWasm toolchains.
62
+
- Resolves issues that prevented building `ArgumentParser` for WebAssembly using
63
+
SwiftWasm toolchains.
32
64
- Improved window size handling on Windows.
33
-
- Fixed a crash when using `--experimental-dump-help` with commands that provide non-parsed values.
34
-
- Fixes an issue where subcommands that declare array arguments with the `.unconditionalRemaining` parsing strategy unexpectedly miss arguments, extending the change in [#333] to subcommands. ([#397])
35
-
- Corrects the order of an `@Option` initializer's parameters, deprecating the old version. ([#391])
65
+
- Fixed a crash when using `--experimental-dump-help` with commands that provide
66
+
non-parsed values.
67
+
- Fixes an issue where subcommands that declare array arguments with the
68
+
`.unconditionalRemaining` parsing strategy unexpectedly miss arguments,
69
+
extending the change in [#333] to subcommands. ([#397])
70
+
- Corrects the order of an `@Option` initializer's parameters, deprecating the
71
+
old version. ([#391])
36
72
- Expanded and corrected documentation.
37
73
38
-
The 1.0.3 release includes contributions from [atierian], [CraigSiemens], [dduan], [floam], [KS1019], [McNight], [mdznr], [natecook1000], [rauhul], and [yonihemi]. Thank you!
74
+
The 1.0.3 release includes contributions from [atierian], [CraigSiemens],
75
+
[dduan], [floam], [KS1019], [McNight], [mdznr], [natecook1000], [rauhul], and
76
+
[yonihemi]. Thank you!
39
77
40
78
41
79
## [1.0.2] - 2021-11-09
42
80
43
-
## Fixes
81
+
### Fixes
44
82
45
83
- Addresses an issue when building tests under Mac Catalyst.
46
84
47
85
The 1.0.2 release includes a contribution from [jakepetroules]. Thank you!
48
86
49
87
## [1.0.1] - 2021-09-14
50
88
51
-
## Fixes
89
+
### Fixes
52
90
53
91
- Addresses an issue when compiling under Mac Catalyst.
54
92
@@ -571,7 +609,8 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
0 commit comments