Skip to content

Commit 0fbc884

Browse files
authored
Update CHANGELOG for release 1.4.0 (#640)
1 parent 29b3d39 commit 0fbc884

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

CHANGELOG.md

+35-2
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,37 @@ Add new items at the end of the relevant section under **Unreleased**.
1010

1111
---
1212

13+
## [1.4.0] - 2024-05-21
14+
15+
### Additions
16+
17+
- Adds support for subcommand aliases via a new `CommandConfiguration.aliases`
18+
parameter. Aliases are shown in help text and used during command parsing. For
19+
example, a subcommand like "average" from the example "math" tool can be
20+
defined with the aliases `["avg"]`. The resulting subcommand can now be
21+
invoked with either of `math stats average` and ``math stats avg`. See the
22+
updated documentation and example for additional details. ([#627])
23+
- Adds a new API `usageString` to `ParsableArguments` and `ParsableCommand` for
24+
retrieving their usage text, allowing for more flexible construction of error
25+
screens. ([#634])
26+
- Adds support for passing custom arguments to `AsyncParsableCommand.main()`
27+
with a new `static func main(_ arguments: [String]?) async` method. ([#568])
28+
29+
### Fixes
30+
31+
- Removes default parameter values from deprecated CommandConfiguration
32+
initializers to prevent them from being selected as overloads. Some niche
33+
invalid deprecation warnings should no longer occur. ([#636])
34+
35+
The 1.4.0 release includes contributions from [Austinpayne], [dcantah],
36+
[KS1019], [natecook1000], [rauhul], and [revolter]. Thank you!
37+
1338
## [1.3.1] - 2024-03-16
1439

1540
### Changes
1641

1742
- The `CommandConfiguration` type is now designated as `Sendable`. ([#615])
18-
- The library uses `internal` imports instead of ``@_implementationOnly` annotations
43+
- The library uses `internal` imports instead of `@_implementationOnly` annotations
1944
in Swift versions where permitted. ([#616])
2045

2146
### Fixes
@@ -867,7 +892,8 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
867892

868893
<!-- Link references for releases -->
869894

870-
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.3.1...HEAD
895+
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.4.0...HEAD
896+
[1.4.0]: https://github.com/apple/swift-argument-parser/compare/1.3.1...1.4.0
871897
[1.3.1]: https://github.com/apple/swift-argument-parser/compare/1.3.0...1.3.1
872898
[1.3.0]: https://github.com/apple/swift-argument-parser/compare/1.2.3...1.3.0
873899
[1.2.3]: https://github.com/apple/swift-argument-parser/compare/1.2.2...1.2.3
@@ -964,6 +990,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
964990
[#552]: https://github.com/apple/swift-argument-parser/pull/552
965991
[#554]: https://github.com/apple/swift-argument-parser/pull/554
966992
[#565]: https://github.com/apple/swift-argument-parser/pull/565
993+
[#568]: https://github.com/apple/swift-argument-parser/pull/568
967994
[#572]: https://github.com/apple/swift-argument-parser/pull/572
968995
[#573]: https://github.com/apple/swift-argument-parser/pull/573
969996
[#574]: https://github.com/apple/swift-argument-parser/pull/574
@@ -986,6 +1013,9 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
9861013
[#617]: https://github.com/apple/swift-argument-parser/pull/617
9871014
[#619]: https://github.com/apple/swift-argument-parser/pull/619
9881015
[#621]: https://github.com/apple/swift-argument-parser/pull/621
1016+
[#627]: https://github.com/apple/swift-argument-parser/pull/627
1017+
[#634]: https://github.com/apple/swift-argument-parser/pull/634
1018+
[#636]: https://github.com/apple/swift-argument-parser/pull/636
9891019

9901020
<!-- Link references for contributors -->
9911021

@@ -997,6 +1027,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
9971027
[allevato]: https://github.com/apple/swift-argument-parser/commits?author=allevato
9981028
[artemnovichkov]: https://github.com/apple/swift-argument-parser/commits?author=artemnovichkov
9991029
[atierian]: https://github.com/apple/swift-argument-parser/commits?author=atierian
1030+
[Austinpayne]: https://github.com/apple/swift-argument-parser/commits?author=Austinpayne
10001031
[BradLarson]: https://github.com/apple/swift-argument-parser/commits?author=BradLarson
10011032
[buttaface]: https://github.com/apple/swift-argument-parser/commits?author=buttaface
10021033
[Chamepp]: https://github.com/apple/swift-argument-parser/commits?author=Chamepp
@@ -1008,6 +1039,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
10081039
[CypherPoet]: https://github.com/apple/swift-argument-parser/commits?author=CypherPoet
10091040
[d-ronnqvist]: https://github.com/apple/swift-argument-parser/commits?author=d-ronnqvist
10101041
[damuellen]: https://github.com/apple/swift-argument-parser/commits?author=damuellen
1042+
[dcantah]: https://github.com/apple/swift-argument-parser/commits?author=dcantah
10111043
[dduan]: https://github.com/apple/swift-argument-parser/commits?author=dduan
10121044
[dirtyhabits97]: https://github.com/apple/swift-argument-parser/commits?author=dirtyhabits97
10131045
[drewmccormack]: https://github.com/apple/swift-argument-parser/commits?author=drewmccormack
@@ -1055,6 +1087,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
10551087
[pegasuze]: https://github.com/apple/swift-argument-parser/commits?author=pegasuze
10561088
[randomeizer]: https://github.com/apple/swift-argument-parser/commits?author=randomeizer
10571089
[rauhul]: https://github.com/apple/swift-argument-parser/commits?author=rauhul
1090+
[revolter]: https://github.com/apple/swift-argument-parser/commits?author=revolter
10581091
[rickrizzo]: https://github.com/apple/swift-argument-parser/commits?author=rickrizzo
10591092
[rjstelling]: https://github.com/apple/swift-argument-parser/commits?author=rjstelling
10601093
[robertmryan]: https://github.com/apple/swift-argument-parser/commits?author=robertmryan

0 commit comments

Comments
 (0)