Skip to content

Commit 223d62a

Browse files
authored
Update changelog for release 0.0.6 (#145)
1 parent 44fb59e commit 223d62a

File tree

1 file changed

+52
-1
lines changed

1 file changed

+52
-1
lines changed

CHANGELOG.md

+52-1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,45 @@ package updates, you can specify your package dependency using
1414

1515
*No changes yet.*
1616

17+
## [0.0.6] - 2020-05-14
18+
19+
### Additions
20+
21+
- Command definition validation now checks for name collisions between options
22+
and flags.
23+
- `ValidationError.message` is now publicly accessible.
24+
- Added an `EnumerableFlag` protocol for `CaseIterable` types that are used to
25+
provide the names for flags. When declaring conformance to `EnumerableFlag`,
26+
you can override the name specification and help text for individual flags.
27+
See [#65] for more detail.
28+
- When a command that requires arguments is called with no arguments at all,
29+
the error message includes the full help text instead of the short usage
30+
string. This is intended to provide a better experience for first-time users.
31+
- Added a `helpMessage()` method for generating the help text for a command
32+
or subcommand.
33+
34+
### Deprecations
35+
36+
- `@Flag` properties that use `CaseIterable`/`String` types as their values
37+
are deprecated, and the related `@Flag` initializers will be removed
38+
in a future version.
39+
40+
*Migration:* Add `EnumerableFlag` conformance to the type of these kinds of
41+
`@Flag` properties.
42+
43+
### Fixes
44+
45+
- Errors thrown while parsing in a `transform` closure are printed correclty
46+
instead of a general `Invalid state` error.
47+
- Improvements to the guides and in the error message when attempting to access
48+
a value from an argument/option/flag definition.
49+
- Fixed issues in the CMake and Windows build configurations.
50+
- You can now use an `=` to join a value with an option's short name when calling
51+
a command. This previously only worked for long names.
52+
53+
The 0.0.6 release includes contributions from [compnerd], [john-mueller],
54+
[natecook1000], [owenv], [rjstelling], and [toddthomas]. Thank you!
55+
1756
## [0.0.5] - 2020-04-15
1857

1958
### Additions
@@ -118,16 +157,24 @@ The 0.0.2 release includes contributions from [AliSoftware], [buttaface],
118157

119158
- `ArgumentParser` initial release.
120159

160+
---
161+
162+
This changelog's format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
121163

122164
<!-- Link references for releases -->
123165

124-
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/0.0.5...HEAD
166+
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/0.0.6...HEAD
167+
[0.0.6]: https://github.com/apple/swift-argument-parser/compare/0.0.5...0.0.6
125168
[0.0.5]: https://github.com/apple/swift-argument-parser/compare/0.0.4...0.0.5
126169
[0.0.4]: https://github.com/apple/swift-argument-parser/compare/0.0.3...0.0.4
127170
[0.0.3]: https://github.com/apple/swift-argument-parser/compare/0.0.2...0.0.3
128171
[0.0.2]: https://github.com/apple/swift-argument-parser/compare/0.0.1...0.0.2
129172
[0.0.1]: https://github.com/apple/swift-argument-parser/releases/tag/0.0.1
130173

174+
<!-- Link references for pull requests -->
175+
176+
[#65]: https://github.com/apple/swift-argument-parser/pull/65
177+
131178
<!-- Link references for contributors -->
132179

133180
[AliSoftware]: https://github.com/apple/swift-argument-parser/commits?author=AliSoftware
@@ -139,15 +186,19 @@ The 0.0.2 release includes contributions from [AliSoftware], [buttaface],
139186
[griffin-stewie]: https://github.com/apple/swift-argument-parser/commits?author=griffin-stewie
140187
[iainsmith]: https://github.com/apple/swift-argument-parser/commits?author=iainsmith
141188
[IngmarStein]: https://github.com/apple/swift-argument-parser/commits?author=IngmarStein
189+
[john-mueller]: https://github.com/apple/swift-argument-parser/commits?author=john-mueller
142190
[jonathanpenn]: https://github.com/apple/swift-argument-parser/commits?author=jonathanpenn
143191
[kennyyork]: https://github.com/apple/swift-argument-parser/commits?author=kennyyork
144192
[klaaspieter]: https://github.com/apple/swift-argument-parser/commits?author=klaaspieter
145193
[Lantua]: https://github.com/apple/swift-argument-parser/commits?author=Lantua
146194
[miguelangel-dev]: https://github.com/apple/swift-argument-parser/commits?author=miguelangel-dev
147195
[natecook1000]: https://github.com/apple/swift-argument-parser/commits?author=natecook1000
196+
[owenv]: https://github.com/apple/swift-argument-parser/commits?author=owenv
197+
[rjstelling]: https://github.com/apple/swift-argument-parser/commits?author=rjstelling
148198
[Sajjon]: https://github.com/apple/swift-argument-parser/commits?author=Sajjon
149199
[sgl0v]: https://github.com/apple/swift-argument-parser/commits?author=sgl0v
150200
[sjavora]: https://github.com/apple/swift-argument-parser/commits?author=sjavora
201+
[toddthomas]: https://github.com/apple/swift-argument-parser/commits?author=toddthomas
151202
[Wildchild9]: https://github.com/apple/swift-argument-parser/commits?author=Wildchild9
152203
[YuAo]: https://github.com/apple/swift-argument-parser/commits?author=YuAo
153204
[zntfdr]: https://github.com/apple/swift-argument-parser/commits?author=zntfdr

0 commit comments

Comments
 (0)