Skip to content

Commit 69ddee8

Browse files
authored
Update changelog for 0.4.0 release (#281)
1 parent b1380e7 commit 69ddee8

File tree

3 files changed

+73
-10
lines changed

3 files changed

+73
-10
lines changed

CHANGELOG.md

Lines changed: 69 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,68 @@ This project follows semantic versioning. While still in major version `0`,
88
source-stability is only guaranteed within minor versions (e.g. between
99
`0.0.3` and `0.0.4`). If you want to guard against potentially source-breaking
1010
package updates, you can specify your package dependency using
11-
`.upToNextMinor(from: "0.3.0")` as the requirement.
11+
`.upToNextMinor(from: "0.4.0")` as the requirement.
1212

1313
## [Unreleased]
1414

1515
*No changes yet.*
1616

1717
---
1818

19+
## [0.4.0] - 2021-03-04
20+
21+
### Additions
22+
23+
- Short options can now support "joined option" syntax, which lets users specify
24+
a value appended immediately after the option's short name. For example, in
25+
addition to calling this `example` command with `-D debug` and `-D=debug`,
26+
users can now write `-Ddebug` for the same parsed value. ([#240])
27+
28+
```swift
29+
@main
30+
struct Example: ParsableCommand {
31+
@Option(name: .customShort("D", allowingJoined: true))
32+
var debugValue: String
33+
34+
func run() {
35+
print(debugValue)
36+
}
37+
}
38+
```
39+
40+
### Changes
41+
42+
- The `CommandConfiguration.helpNames` property is now optional, to allow the
43+
overridden help flags of parent commands to flow down to their children. Most
44+
existing code should not be affected, but if you've customized a command's
45+
help flags you may see different behavior. ([#251])
46+
- The `errorCode` property is no longer used as a command's exit code when
47+
`CustomNSError` types are thrown. ([#276])
48+
49+
*Migration:* Instead of throwing a `CustomNSError` type, print your error
50+
manually and throw an `ExitCode` error to customize your command's exit code.
51+
52+
### Removals
53+
54+
- Old, deprecated property wrapper initializers have been removed.
55+
56+
### Fixes
57+
58+
- Validation errors now show the correct help flags when help flags have been
59+
customized.
60+
- Options, flags, and arguments that are marked as hidden from the help screen
61+
are also suppressed from completion scripts.
62+
- Non-parsed variable properties are now allowed in parsable types.
63+
- Error messages produced when `NSError` types are thrown have been improved.
64+
- The usage line for commands with a large number of options includes more
65+
detail about required flags and positional arguments.
66+
- Support for CMake builds on Apple Silicon is improved.
67+
68+
The 0.4.0 release includes contributions from [CodaFi], [lorentey],
69+
[natecook1000], [schlagelk], and [Zoha131]. Thank you!
70+
71+
---
72+
1973
## [0.3.2] - 2021-01-15
2074

2175
### Fixes
@@ -34,8 +88,6 @@ The 0.3.2 release includes contributions from [compnerd], [CypherPoet],
3488
[damuellen], [drewmccormack], [elliottwilliams], [gmittert], [MaxDesiatov],
3589
[natecook1000], [pegasuze], and [SergeyPetrachkov]. Thank you!
3690

37-
---
38-
3991
## [0.3.1] - 2020-09-02
4092

4193
### Fixes
@@ -51,8 +103,6 @@ The 0.3.2 release includes contributions from [compnerd], [CypherPoet],
51103

52104
- Parsing performance improvements.
53105

54-
---
55-
56106
## [0.3.0] - 2020-08-15
57107

58108
### Additions
@@ -79,6 +129,8 @@ The 0.3.2 release includes contributions from [compnerd], [CypherPoet],
79129
The 0.3.0 release includes contributions from [dduan], [MPLew-is],
80130
[natecook1000], and [thomasvl]. Thank you!
81131

132+
---
133+
82134
## [0.2.2] - 2020-08-05
83135

84136
### Fixes
@@ -160,6 +212,8 @@ The 0.2.0 release includes contributions from [artemnovichkov], [compnerd],
160212
[ibrahimoktay], [john-mueller], [MPLew-is], [natecook1000], and [owenv].
161213
Thank you!
162214

215+
---
216+
163217
## [0.1.0] - 2020-06-03
164218

165219
### Additions
@@ -217,6 +271,8 @@ Thank you!
217271
The 0.1.0 release includes contributions from [aleksey-mashanov], [BradLarson],
218272
[compnerd], [erica], [ibrahimoktay], and [natecook1000]. Thank you!
219273

274+
---
275+
220276
## [0.0.6] - 2020-05-14
221277

222278
### Additions
@@ -366,7 +422,8 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
366422

367423
<!-- Link references for releases -->
368424

369-
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/0.3.2...HEAD
425+
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/0.4.0...HEAD
426+
[0.4.0]: https://github.com/apple/swift-argument-parser/compare/0.3.2...0.4.0
370427
[0.3.2]: https://github.com/apple/swift-argument-parser/compare/0.3.1...0.3.2
371428
[0.3.1]: https://github.com/apple/swift-argument-parser/compare/0.3.0...0.3.1
372429
[0.3.0]: https://github.com/apple/swift-argument-parser/compare/0.2.2...0.3.0
@@ -384,7 +441,10 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
384441
<!-- Link references for pull requests -->
385442

386443
[#65]: https://github.com/apple/swift-argument-parser/pull/65
444+
[#240]: https://github.com/apple/swift-argument-parser/pull/240
445+
[#251]: https://github.com/apple/swift-argument-parser/pull/251
387446
[#256]: https://github.com/apple/swift-argument-parser/pull/256
447+
[#276]: https://github.com/apple/swift-argument-parser/pull/276
388448

389449
<!-- Link references for contributors -->
390450

@@ -393,6 +453,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
393453
[artemnovichkov]: https://github.com/apple/swift-argument-parser/commits?author=artemnovichkov
394454
[BradLarson]: https://github.com/apple/swift-argument-parser/commits?author=BradLarson
395455
[buttaface]: https://github.com/apple/swift-argument-parser/commits?author=buttaface
456+
[CodaFi]: https://github.com/apple/swift-argument-parser/commits?author=CodaFi
396457
[compnerd]: https://github.com/apple/swift-argument-parser/commits?author=compnerd
397458
[CypherPoet]: https://github.com/apple/swift-argument-parser/commits?author=CypherPoet
398459
[damuellen]: https://github.com/apple/swift-argument-parser/commits?author=damuellen
@@ -412,6 +473,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
412473
[kennyyork]: https://github.com/apple/swift-argument-parser/commits?author=kennyyork
413474
[klaaspieter]: https://github.com/apple/swift-argument-parser/commits?author=klaaspieter
414475
[Lantua]: https://github.com/apple/swift-argument-parser/commits?author=Lantua
476+
[lorentey]: https://github.com/apple/swift-argument-parser/commits?author=lorentey
415477
[MaxDesiatov]: https://github.com/apple/swift-argument-parser/commits?author=MaxDesiatov
416478
[miguelangel-dev]: https://github.com/apple/swift-argument-parser/commits?author=miguelangel-dev
417479
[MPLew-is]: https://github.com/apple/swift-argument-parser/commits?author=MPLew-is
@@ -433,3 +495,4 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
433495
[Wildchild9]: https://github.com/apple/swift-argument-parser/commits?author=Wildchild9
434496
[YuAo]: https://github.com/apple/swift-argument-parser/commits?author=YuAo
435497
[zntfdr]: https://github.com/apple/swift-argument-parser/commits?author=zntfdr
498+
[Zoha131]: https://github.com/apple/swift-argument-parser/commits?author=Zoha131

Documentation/01 Getting Started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import PackageDescription
1919
let package = Package(
2020
name: "random",
2121
dependencies: [
22-
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "0.3.0"),
22+
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "0.4.0"),
2323
],
2424
targets: [
2525
.target(

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ To use the `ArgumentParser` library in a SwiftPM project,
8888
add the following line to the dependencies in your `Package.swift` file:
8989

9090
```swift
91-
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.3.0"),
91+
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.4.0"),
9292
```
9393

9494
Because `ArgumentParser` is under active development,
@@ -97,7 +97,7 @@ If you don't want potentially source-breaking package updates,
9797
use this dependency specification instead:
9898

9999
```swift
100-
.package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "0.3.0")),
100+
.package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "0.4.0")),
101101
```
102102

103103
Finally, include `"ArgumentParser"` as a dependency for your executable target:
@@ -106,7 +106,7 @@ Finally, include `"ArgumentParser"` as a dependency for your executable target:
106106
let package = Package(
107107
// name, platforms, products, etc.
108108
dependencies: [
109-
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.3.0"),
109+
.package(url: "https://github.com/apple/swift-argument-parser", from: "0.4.0"),
110110
// other dependencies
111111
],
112112
targets: [

0 commit comments

Comments
 (0)