diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e0a8eba3..78a58bc57 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,9 +6,38 @@ Add new items at the end of the relevant section under **Unreleased**. ## [Unreleased] +*No changes yet.* + +--- + +## [1.1.0] - 2022-03-14 + ### Additions -- 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]) +- A command's `run()` method now supports `async`/`await` when the command + conforms to `AsyncParsableCommand`. ([#404]) +- New API for distinguishing between public, hidden, and private arguments + and option groups, and a new extended help screen accessible via + `--help-hidden`. ([#366], [#390], and [#405 through #413][1.1.0]) +- You can now override the autogenerated usage string when configuring a + command. ([#400]) + +### Changes + +- `ArgumentParser` now requires Swift 5.5. + +### Fixes + +- The auto-generated usage string now correctly hides all optional parameters + when over the length limit. ([#416]) +- One `@Option` initializer now has its parameters in the correct order; the + incorrect initializer is deprecated. ([#391]) +- Help flags are now correctly captured in `.unconditionalRemaining` argument + arrays. +- Documentation fixes and improvements. + +The 1.1.0 release includes contributions from [keith], [MartinP7r], [McNight], +[natecook1000], [rauhul], and [zkiraly]. Thank you! --- @@ -16,7 +45,8 @@ Add new items at the end of the relevant section under **Unreleased**. ### Changes -- When a user provides an incorrect value for an option, an `ArgumentParser`-based program now includes the valid values when possible. +- When a user provides an incorrect value for an option, an + `ArgumentParser`-based program now includes the valid values when possible. ``` $ example --format png @@ -26,21 +56,29 @@ Add new items at the end of the relevant section under **Unreleased**. ### Fixes -- Resolves an issue with `zsh` custom completions for command names that include a dash. +- Resolves an issue with `zsh` custom completions for command names that include + a dash. - Improves the generated completions scripts for `fish`. -- Resolves issues that prevented building `ArgumentParser` for WebAssembly using SwiftWasm toolchains. +- Resolves issues that prevented building `ArgumentParser` for WebAssembly using + SwiftWasm toolchains. - Improved window size handling on Windows. -- Fixed a crash when using `--experimental-dump-help` with commands that provide non-parsed values. -- 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]) -- Corrects the order of an `@Option` initializer's parameters, deprecating the old version. ([#391]) +- Fixed a crash when using `--experimental-dump-help` with commands that provide + non-parsed values. +- 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]) +- Corrects the order of an `@Option` initializer's parameters, deprecating the + old version. ([#391]) - Expanded and corrected documentation. -The 1.0.3 release includes contributions from [atierian], [CraigSiemens], [dduan], [floam], [KS1019], [McNight], [mdznr], [natecook1000], [rauhul], and [yonihemi]. Thank you! +The 1.0.3 release includes contributions from [atierian], [CraigSiemens], +[dduan], [floam], [KS1019], [McNight], [mdznr], [natecook1000], [rauhul], and +[yonihemi]. Thank you! ## [1.0.2] - 2021-11-09 -## Fixes +### Fixes - Addresses an issue when building tests under Mac Catalyst. @@ -48,7 +86,7 @@ The 1.0.2 release includes a contribution from [jakepetroules]. Thank you! ## [1.0.1] - 2021-09-14 -## Fixes +### Fixes - Addresses an issue when compiling under Mac Catalyst. @@ -571,7 +609,8 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co -[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.0.3...HEAD +[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.1.0...HEAD +[1.1.0]: https://github.com/apple/swift-argument-parser/compare/1.0.3...1.1.0 [1.0.3]: https://github.com/apple/swift-argument-parser/compare/1.0.2...1.0.3 [1.0.2]: https://github.com/apple/swift-argument-parser/compare/1.0.1...1.0.2 [1.0.1]: https://github.com/apple/swift-argument-parser/compare/1.0.0...1.0.1 @@ -617,9 +656,13 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co [#324]: https://github.com/apple/swift-argument-parser/pull/324 [#333]: https://github.com/apple/swift-argument-parser/pull/333 [#341]: https://github.com/apple/swift-argument-parser/pull/341 +[#366]: https://github.com/apple/swift-argument-parser/pull/366 [#390]: https://github.com/apple/swift-argument-parser/pull/390 [#391]: https://github.com/apple/swift-argument-parser/pull/391 [#397]: https://github.com/apple/swift-argument-parser/pull/397 +[#400]: https://github.com/apple/swift-argument-parser/pull/400 +[#404]: https://github.com/apple/swift-argument-parser/pull/404 +[#416]: https://github.com/apple/swift-argument-parser/pull/416 @@ -654,12 +697,14 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co [jakepetroules]: https://github.com/apple/swift-argument-parser/commits?author=jakepetroules [john-mueller]: https://github.com/apple/swift-argument-parser/commits?author=john-mueller [jonathanpenn]: https://github.com/apple/swift-argument-parser/commits?author=jonathanpenn +[keith]: https://github.com/apple/swift-argument-parser/commits?author=keith [kennyyork]: https://github.com/apple/swift-argument-parser/commits?author=kennyyork [klaaspieter]: https://github.com/apple/swift-argument-parser/commits?author=klaaspieter [KS1019]: https://github.com/apple/swift-argument-parser/commits?author=KS1019 [kylemacomber]: https://github.com/apple/swift-argument-parser/commits?author=kylemacomber [Lantua]: https://github.com/apple/swift-argument-parser/commits?author=Lantua [lorentey]: https://github.com/apple/swift-argument-parser/commits?author=lorentey +[MartinP7r]: https://github.com/apple/swift-argument-parser/commits?author=MartinP7r [MaxDesiatov]: https://github.com/apple/swift-argument-parser/commits?author=MaxDesiatov [McNight]: https://github.com/apple/swift-argument-parser/commits?author=McNight [mdznr]: https://github.com/apple/swift-argument-parser/commits?author=mdznr @@ -686,5 +731,6 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co [Wildchild9]: https://github.com/apple/swift-argument-parser/commits?author=Wildchild9 [yonihemi]: https://github.com/apple/swift-argument-parser/commits?author=yonihemi [YuAo]: https://github.com/apple/swift-argument-parser/commits?author=YuAo +[zkiraly]: https://github.com/apple/swift-argument-parser/commits?author=zkiraly [zntfdr]: https://github.com/apple/swift-argument-parser/commits?author=zntfdr [Zoha131]: https://github.com/apple/swift-argument-parser/commits?author=Zoha131