1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
|
# CHANGELOG
<!--
Add new items at the end of the relevant section under **Unreleased**.
-->
## [Unreleased]
*No changes yet.*
---
## [1.2.3] - 2023-08-15
### Additions
- You can now use ArgumentParser with Musl libc. ([#574])
### Fixes
- Fixes a bug where single-page manuals did not include command abstracts for
subcommands. ([#552])
- Fixes a bug where non-optional properties in ParsableCommands could cause
ArgumentParser to crash. You can now include properties like dictionaries in
ParsableCommands without issue. ([#554])
- Fixes a configuration issue which would cause `ArgumentParserTestHelpers` to
fail to link when building for Windows. ([#579])
The 1.2.3 release includes contributions from [compnerd], [gwynne],
[MaxDesiatov], [natecook1000], and [rauhul]. Thank you!
## [1.2.2] - 2023-02-09
### Fixes
- Arguments with the `.allUnrecognized` parsing strategy no longer consume
built-in flags like `--help` and `--version`. ([#550])
- Fixes an issue introduced in version 1.2.0 where properties with underscored
names couldn't be parsed. ([#548])
- Improves the error message for cases where platform availability causes the
synchronous `ParsableCommand.main()` static method to be run on an
`AsyncParsableCommand` type. ([#547])
## [1.2.1] - 2023-01-12
### Changes
- Documentation is now primarily hosted at the
[Swift Package Index](https://swiftpackageindex.com/apple/swift-argument-parser).
### Fixes
- `exit(_:)` no longer causes infinite recursion on the WASI platform. ([#520])
- Completion scripts for `fish` now provide completions after a
non-hyphen-prefixed argument has been provided. ([#535])
- Overload selection for custom `ExpressibleByArgument` types has been improved.
([#522])
- The usage string for `.postTerminator` arguments now includes the required
terminator (`--`). ([#542])
- Documentation and testing fixes and improvements.
The 1.2.1 release includes contributions from [Chamepp], [kkk669], [mtj0928],
[natecook1000], [rauhul], [rickrizzo], [TiagoMaiaL], and [yim-lee]. Thank you!
## [1.2.0] - 2022-11-08
### Additions
- You can now provide a title in an `@OptionGroup` declaration. Titled option
groups are listed separately in the help screen under that title as a
heading. ([#492])
- Two new parsing strategies have been added for `@Argument` array properties:
- `.allUnrecognized` captures all unrecognized inputs after parsing known
flags, options, and arguments.
- `.postTerminator` collects any inputs that follow the `--` terminator.
See the [`ArgumentArrayParsingStrategy` documentation][arrayparse-docs] for
more. ([#496])
- Default values are now supported for `@Argument` or `@Option` properties with
optional type, allowing you to initialize those properties with `nil`.
Providing a non-`nil` default value results in a warning, since optional
properties with non-`nil` defaults don't need to be declared as optionals.
([#477], [#480])
### Changes
- The `.unconditionalRemaining` array parsing strategy has been deprecated and
renamed to `.captureForPassthrough`, to better fit its semantic behavior and
intended usage. See the [`ArgumentArrayParsingStrategy`
documentation][arrayparse-docs] for more. ([#496])
### Fixes
- Invalid `init(from:)` decoding initializers are now correctly diagnosed by
ArgumentParser's validators. ([#487])
- Default values are now correctly displayed as flags for `@Flag` properties
with inversions or `EnumerableFlag` types. ([#486])
- The help display for non-string-backed raw representable types has been
corrected to not show raw Swift values. Instead, the help display uses the
type's customized `defaultValueDescription` and `allValues` implementations.
([#494])
- Properties at different levels of a command hierarchy with the same Swift name
but different argument names no longer collide. ([#495])
- The `generate-manual` plugin name is improved when used from within Xcode.
([#505])
- Documentation fixes and improvements.
The 1.2.0 release includes contributions from [allevato], [clayellis],
[compnerd], [d-ronnqvist], [natecook1000], [randomeizer], and [rauhul].
Thank you!
[arrayparse-docs]: https://swiftpackageindex.com/apple/swift-argument-parser/documentation/argumentparser/argumentarrayparsingstrategy
---
## [1.1.4] - 2022-08-26
### Changes
- The generate-manual plugin now defaults to creating single page manuals. The
`--single-page` flag has been replaced with `--multi-page` to restore the
previous default functionality. ([#472])
*Migration:* Update scripts that invoked generate-manual without
`--single-page` to include `--multi-page` and update scripts that invoked
generate-manual with `--single-page` to omit the flag.
- The "experimental" prefix from the generate-manual plugin has been removed.
([#475])
*Migration:* Update scripts to invoke the generate manual plugin via
`swift package generate-manual` instead of
`swift package plugin experimental-generate-manual`.
### Fixes
- The generate-manual plugin is correctly declared as a product, making the
plugin visible to clients. ([#456])
- The generate-manual plugin's `--authors` arguments are now correctly passed to
the underlying generation tool. ([#471])
- Manuals generated by the generate-manual plugin now include the option's value
names and do not include value names for flags. ([#473])
- Built-in flags such as `--help` and `--version` are now correctly marked as
optional fixing some generated content which indicated the flags are always
required. ([#474])
- Value descriptions are now correctly derived for types which are
`ExpressibleByArgument` and `RawRepresentable` by `String`. Help menus will
now display valid default values for such types. ([#476])
The 1.1.4 release includes contributions from [ian-twilightcoder],
[MarcoEidinger], and [rauhul]. Thank you!
## [1.1.3] - 2022-06-23
### Additions
- `ArgumentParser` now includes a SwiftPM plugin for generating `man` pages.
Explore the functionality and configuration by running
`swift package plugin experimental-generate-manual --help` from your package
root. ([#332])
### Fixes
- Hidden subcommands are now excluded from completion scripts. ([#443])
- When an invalid value is provided for a `CaseIterable` type, the error message
now includes a list of valid inputs. ([#445])
- There's now a diagnostic when an `AsyncParsableCommand` is incorrectly placed
under a non-`async` root command. ([#436])
The 1.1.3 release includes contributions from [keith], [KeithBird],
[konomae], [LucianoPAlmeida], and [rauhul]. Thank you!
## [1.1.2] - 2022-04-11
### Changes
- CMake builds now always statically links `ArgumentParserToolInfo`.
([#424])
### Fixes
- When a user provides an array-based option's key (e.g. `--key`)
without any values, the error message now correctly describes the
problem. ([#435])
The 1.1.2 release includes contributions from [compnerd] and [KeithBird].
Thank you!
## [1.1.1] - 2022-03-16
### Fixes
- Moves the platform requirement from the package level down to the new
types and protocols with `async` members. This was a source-breaking
change in 1.1.0. ([#427])
- Fixed issues in the CMake build configuration.
## [1.1.0] - 2022-03-14
### Additions
- 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!
---
## [1.0.3] - 2022-01-31
### Changes
- When a user provides an incorrect value for an option, an
`ArgumentParser`-based program now includes the valid values when possible.
```
$ example --format png
Error: The value 'png' is invalid for '--format <format>'.
Please provide one of 'text', 'json' or 'csv'.
```
### Fixes
- 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.
- 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])
- 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!
## [1.0.2] - 2021-11-09
### Fixes
- Addresses an issue when building tests under Mac Catalyst.
The 1.0.2 release includes a contribution from [jakepetroules]. Thank you!
## [1.0.1] - 2021-09-14
### Fixes
- Addresses an issue when compiling under Mac Catalyst.
The 1.0.1 release includes a contribution from [imxieyi]. Thank you!
## [1.0.0] - 2021-09-10
The 1.0 release marks an important milestone —
`ArgumentParser` is now source stable!
### Changes
- `ArgumentParser` now provides a DocC documentation catalog, so you
can view rendered articles and symbol documentation directly within
Xcode.
### Fixes
- Parsing works as expected for options with single-dash names that
are declared using the `.upToNextOption` parsing strategy.
---
## [0.5.0] - 2021-09-02
### Additions
- When a user doesn't provide a required argument, the error message now
includes that argument's help text. ([#324])
- Command-line tools built with `ArgumentParser` now include an experimental
flag to dump command/argument/help information as JSON:
`--experimental-dump-help`. ([#310])
### Changes
- All public enumerations are now structs with static properties, to make
compatibility with future additions simpler.
### Fixes
- Array properties defined as `@Option` with the `.upToNextOption` parsing
strategy now include all provided values. ([#304]) In the example below, all
four values are now included in the resulting array, where only the last two
were included in previous releases:
```swift
struct Example: ParsableCommand {
@Option(parsing: .upToNextOption)
var option: [String]
}
```
```
$ example --option one two --option three four
```
- When a command defines an array property as an `@Argument` with the
`.unconditionalRemaining` parsing strategy, option and flag parsing now stops
at the first positional argument or unrecognized flag. ([#333])
- Completion scripts correctly use customized help flags. ([#308])
- Fixes errors with bash custom completion arguments and the executable path.
([#320], [#323])
- Fixes the behavior when a user specifies both the `help` subcommand and a help
flag. ([#309])
- A variety of internal improvements. ([#315], [#316], [#321], [#341])
The 0.5.0 release includes contributions from [atierian], [compnerd],
[dirtyhabits97], [Frizlab], [KS1019], [natecook1000], and [rauhul]. Thank you!
---
## [0.4.4] - 2021-07-30
### Fixes
- Includes a workaround for a runtime crash with certain `OptionGroup`
configurations when a command is compiled in release mode.
## [0.4.3] - 2021-04-28
### Additions
- Experimental API for hiding `@OptionGroup`-declared properties from
the help screen.
The 0.4.3 release includes a contribution from [miggs597]. Thank you!
## [0.4.2] - 2021-04-21
### Fixes
- Both parts of a flag with an inversion are now hidden when specified.
- Better support for building on OpenBSD.
- Optional unparsed values are now always properly decoded. ([#290])
- Help information from super-commands is no longer unnecessarily injected
into subcommand help screens.
The 0.4.2 release includes contributions from [3405691582], [kylemacomber],
[miggs597], [natecook1000], and [werm098]. Thank you!
## [0.4.1] - 2021-03-08
### Additions
- When a user provides an invalid value as an argument or option, the error
message now includes the help text for that argument.
### Fixes
- Zsh completion scripts for commands that include a hyphen no longer cause
errors.
- Optional unparsed values are now decoded correctly in `ParsableArguments`
types.
The 0.4.1 release includes contributions from [adellibovi] and [natecook1000].
Thank you!
## [0.4.0] - 2021-03-04
### Additions
- Short options can now support "joined option" syntax, which lets users specify
a value appended immediately after the option's short name. For example, in
addition to calling this `example` command with `-D debug` and `-D=debug`,
users can now write `-Ddebug` for the same parsed value. ([#240])
```swift
@main
struct Example: ParsableCommand {
@Option(name: .customShort("D", allowingJoined: true))
var debugValue: String
func run() {
print(debugValue)
}
}
```
### Changes
- The `CommandConfiguration.helpNames` property is now optional, to allow the
overridden help flags of parent commands to flow down to their children. Most
existing code should not be affected, but if you've customized a command's
help flags you may see different behavior. ([#251])
- The `errorCode` property is no longer used as a command's exit code when
`CustomNSError` types are thrown. ([#276])
*Migration:* Instead of throwing a `CustomNSError` type, print your error
manually and throw an `ExitCode` error to customize your command's exit code.
### Removals
- Old, deprecated property wrapper initializers have been removed.
### Fixes
- Validation errors now show the correct help flags when help flags have been
customized.
- Options, flags, and arguments that are marked as hidden from the help screen
are also suppressed from completion scripts.
- Non-parsed variable properties are now allowed in parsable types.
- Error messages produced when `NSError` types are thrown have been improved.
- The usage line for commands with a large number of options includes more
detail about required flags and positional arguments.
- Support for CMake builds on Apple Silicon is improved.
The 0.4.0 release includes contributions from [CodaFi], [lorentey],
[natecook1000], [schlagelk], and [Zoha131]. Thank you!
---
## [0.3.2] - 2021-01-15
### Fixes
- Changes made to a command's properties in its `validate` method are now
persisted.
- The exit code defined by error types that conform to `CustomNSError` are now
honored.
- Improved error message when declaring a command type with an unadorned
mutable property. (See [#256] for more.)
- Migrated from `CRT` to `MSVCRT` for Windows platforms.
- Fixes and improvements for building with CMake for Windows and Apple Silicon.
- Documentation improvements.
The 0.3.2 release includes contributions from [compnerd], [CypherPoet],
[damuellen], [drewmccormack], [elliottwilliams], [gmittert], [MaxDesiatov],
[natecook1000], [pegasuze], and [SergeyPetrachkov]. Thank you!
## [0.3.1] - 2020-09-02
### Fixes
- An option or flag can now declare a name with both single- and double-
dash prefixes, such as `-my-flag` and `--my-flag`. Specify both names in the
`name` parameter when declaring your property:
```swift
@Flag(name: [.long, .customLong("my-flag", withSingleDash: true)])
var myFlag = false
```
- Parsing performance improvements.
## [0.3.0] - 2020-08-15
### Additions
- Shell completions scripts are now available for Fish.
### Changes
- Array properties without a default value are now treated as required for the
user of a command-line tool. In previous versions of the library, these
properties defaulted to an empty array; a deprecation was introduced for this
behavior in version 0.2.0.
*Migration:* Specify an empty array as the default value for properties that
should not require user input:
```swift
// old
@Option var names: [String]
// new
@Option var names: [String] = []
```
The 0.3.0 release includes contributions from [dduan], [MPLew-is],
[natecook1000], and [thomasvl]. Thank you!
---
## [0.2.2] - 2020-08-05
### Fixes
- Zsh completion scripts have improved documentation and better support
multi-word completion strings, escaped characters, non-standard executable
locations, and empty help strings.
The 0.2.2 release includes contributions from [interstateone],
[miguelangel-dev], [natecook1000], [stuartcarnie], and [Wevah]. Thank you!
## [0.2.1] - 2020-07-30
### Additions
- You can now generate Bash and Zsh shell completion scripts for commands,
either by using the `--generate-completion-script` flag when running a
command, or by calling the static `completionScript(for:)` method on a root
`ParsableCommand` type. See the [guide to completion scripts][comp-guide] for
information on customizing and installing the completion script for your
command.
### Fixes
- Property wrappers without parameters can now be written without parentheses
— e.g. `@Flag var verbose = false`.
- When displaying default values for array properties, the help screen now
correctly uses the element type's `ExpressibleByArgument` conformance to
generate the description.
- Running a project that defines a command as its own subcommand now fails with
a useful error message.
The 0.2.1 release includes contributions from [natecook1000], [NicFontana],
[schlagelk], [sharplet], and [Wevah]. Thank you!
[comp-guide]: https://github.com/apple/swift-argument-parser/blob/main/Documentation/07%20Completion%20Scripts.md
## [0.2.0] - 2020-06-23
### Additions
- You can now specify default values for array properties of parsable types.
The default values are overridden if the user provides at least one value
as part of the command-line arguments.
### Changes
- This release of `swift-argument-parser` requires Swift 5.2.
- Default values for all properties are now written using default initialization
syntax, including some values that were previously implicit, such as empty
arrays and `false` for Boolean flags.
*Migration:* Specify default values using typical Swift default value syntax
to remove the deprecation warnings:
```swift
// old
@Flag var verbose: Bool
// new
@Flag var verbose = false
```
**_Important:_** There is a semantic change for flags with inversions that do
not have a default value. In previous releases, these flags had a default
value of `false`; starting in 0.2.0, these flags will have no default, and
will therefore be required by the user. Specify a default value of `false` to
retain the old behavior.
### Fixes
- Options with multiple names now consistently show the first-declared name
in usage and help screens.
- Default subcommands are indicated in the help screen.
- User errors with options are now shown before positional argument errors,
eliminating some false negative reports.
- CMake compatibility fixes.
The 0.2.0 release includes contributions from [artemnovichkov], [compnerd],
[ibrahimoktay], [john-mueller], [MPLew-is], [natecook1000], and [owenv].
Thank you!
---
## [0.1.0] - 2020-06-03
### Additions
- Error messages and help screens now include information about how to request
more help.
- CMake builds now support installation.
### Changes
- The `static func main()` method on `ParsableCommand` no longer returns
`Never`. This allows `ParsableCommand` types to be designated as the entry
point for a Swift executable by using the `@main` attribute.
*Migration:* For most uses, this change is source compatible. If you have
used `main()` where a `() -> Never` function is explicitly required, you'll
need to change your usage or capture the method in another function.
- `Optional` no longer conforms to `ExpressibleByArgument`, to avoid some
property declarations that don't make sense.
*Migration:* This is source-compatible for all property declarations, with
deprecations for optional properties that define an explicit default. If
you're using optional values where an `ExpressibleByArgument` type is
expected, such as a generic function, you will need to change your usage
or provide an explicit override.
- `ParsableCommand`'s `run()` method requirement is now a `mutating` method,
allowing mutations to a command's properties, such as sorting an array of
arguments, without additional copying.
*Migration:* No changes are required for commands that are executed through
the `main()` method. If you manually parse a command and then call its
`run()` method, you may need to change the command from a constant to a
variable.
### Removals
- The `@Flag` initializers that were deprecated in version 0.0.6 are now
marked as unavailable.
### Fixes
- `@Option` properties of an optional type that use a `transform` closure now
correctly indicate their optionality in the usage string.
- Correct wrapping and indentation are maintained for abstracts and discussions
with short lines.
- Empty abstracts no longer add extra blank lines to the help screen.
- Help requests are still honored even when a parsed command fails validation.
- The `--` terminator isn't consumed when parsing a command, so that it can be
parsed as a value when a subcommand includes an `.unconditionalRemaining`
argument array.
- CMake builds work correctly again.
The 0.1.0 release includes contributions from [aleksey-mashanov], [BradLarson],
[compnerd], [erica], [ibrahimoktay], and [natecook1000]. Thank you!
---
## [0.0.6] - 2020-05-14
### Additions
- Command definition validation now checks for name collisions between options
and flags.
- `ValidationError.message` is now publicly accessible.
- Added an `EnumerableFlag` protocol for `CaseIterable` types that are used to
provide the names for flags. When declaring conformance to `EnumerableFlag`,
you can override the name specification and help text for individual flags.
See [#65] for more detail.
- When a command that requires arguments is called with no arguments at all,
the error message includes the full help text instead of the short usage
string. This is intended to provide a better experience for first-time users.
- Added a `helpMessage()` method for generating the help text for a command
or subcommand.
### Deprecations
- `@Flag` properties that use `CaseIterable`/`String` types as their values
are deprecated, and the related `@Flag` initializers will be removed
in a future version.
*Migration:* Add `EnumerableFlag` conformance to the type of these kinds of
`@Flag` properties.
### Fixes
- Errors thrown while parsing in a `transform` closure are printed correclty
instead of a general `Invalid state` error.
- Improvements to the guides and in the error message when attempting to access
a value from an argument/option/flag definition.
- Fixed issues in the CMake and Windows build configurations.
- You can now use an `=` to join a value with an option's short name when calling
a command. This previously only worked for long names.
The 0.0.6 release includes contributions from [compnerd], [john-mueller],
[natecook1000], [owenv], [rjstelling], and [toddthomas]. Thank you!
## [0.0.5] - 2020-04-15
### Additions
- You can now specify a version string in a `ParsableCommand`'s configuration.
The generated tool will then automatically respond to a `--version` flag.
- Command definitions are now validated at runtime in debug mode, to check
issues that can't be detected during compilation.
### Fixes
- Deprecation warnings during compilation on Linux have been removed.
- The `validate()` method is now called on each command in the matched command
stack, instead of only the last command in the stack.
The 0.0.5 release includes contributions from [kennyyork], [natecook1000],
[sgl0v], and [YuAo]. Thank you!
## [0.0.4] - 2020-03-23
### Fixes
- Removed usage of 5.2-only syntax.
## [0.0.3] - 2020-03-22
### Additions
- You can specify the `.unconditionalRemaining` parsing strategy for arrays of
positional arguments to accept dash-prefixed input, like
`example --one two -three`.
- You can now provide a default value for a positional argument.
- You can now customize the display of default values in the extended help for
an `ExpressibleByArgument` type.
- You can call the static `exitCode(for:)` method on any command to retrieve the
exit code for a given error.
### Fixes
- Supporting targets are now prefixed to prevent conflicts with other libraries.
- The extension providing `init?(argument:)` to `RawRepresentable` types is now
properly constrained.
- The parser no longer treats passing the same exclusive flag more than once as
an error.
- `ParsableArguments` types that are declared as `@OptionGroup` properties on
commands can now also be declared on subcommands. Previosuly, the parent
command's declaration would prevent subcommands from seeing the user-supplied
arguments.
- Default values are rendered correctly for properties with `Optional` types.
- The output of help requests is now printed during the "exit" phase of execution,
instead of during the "run" phase.
- Usage strings now correctly show that optional positional arguments aren't
required.
- Extended help now omits extra line breaks when displaying arguments or commands
with long names that don't provide help text.
The 0.0.3 release includes contributions from [compnerd], [elliottwilliams],
[glessard], [griffin-stewie], [iainsmith], [Lantua], [miguelangel-dev],
[natecook1000], [sjavora], and [YuAo]. Thank you!
## [0.0.2] - 2020-03-06
### Additions
- The `EX_USAGE` exit code is now used for validation errors.
- The parser provides near-miss suggestions when a user provides an unknown
option.
- `ArgumentParser` now builds on Windows.
- You can throw an `ExitCode` error to exit without printing any output.
- You can now create optional Boolean flags with inversions that default to
`nil`:
```swift
@Flag(inversion: .prefixedNo) var takeMyShot: Bool?
```
- You can now specify exclusivity for case-iterable flags and for Boolean flags
with inversions.
### Fixes
- Cleaned up a wide variety of documentation typos and shortcomings.
- Improved different kinds of error messages:
- Duplicate exclusive flags now show the duplicated arguments.
- Subcommand validation errors print the correct usage string.
- In the help screen:
- Removed the extra space before the default value for arguments without
descriptions.
- Removed the default value note when the default value is an empty string.
- Default values are now shown for Boolean options.
- Case-iterable flags are now grouped correctly.
- Case-iterable flags with default values now show the default value.
- Arguments from parent commands that are included via `@OptionGroup` in
subcommands are no longer duplicated.
- Case-iterable flags created with the `.chooseFirst` exclusivity parameter now
correctly ignore additional flags.
The 0.0.2 release includes contributions from [AliSoftware], [buttaface],
[compnerd], [dduan], [glessard], [griffin-stewie], [IngmarStein],
[jonathanpenn], [klaaspieter], [natecook1000], [Sajjon], [sjavora],
[Wildchild9], and [zntfdr]. Thank you!
## [0.0.1] - 2020-02-27
- `ArgumentParser` initial release.
---
This changelog's format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
<!-- Link references for releases -->
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.2.3...HEAD
[1.2.3]: https://github.com/apple/swift-argument-parser/compare/1.2.2...1.2.3
[1.2.2]: https://github.com/apple/swift-argument-parser/compare/1.2.1...1.2.2
[1.2.1]: https://github.com/apple/swift-argument-parser/compare/1.2.0...1.2.1
[1.2.0]: https://github.com/apple/swift-argument-parser/compare/1.1.4...1.2.0
[1.1.4]: https://github.com/apple/swift-argument-parser/compare/1.1.3...1.1.4
[1.1.3]: https://github.com/apple/swift-argument-parser/compare/1.1.2...1.1.3
[1.1.2]: https://github.com/apple/swift-argument-parser/compare/1.1.1...1.1.2
[1.1.1]: https://github.com/apple/swift-argument-parser/compare/1.1.0...1.1.1
[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
[1.0.0]: https://github.com/apple/swift-argument-parser/compare/0.5.0...1.0.0
[0.5.0]: https://github.com/apple/swift-argument-parser/compare/0.4.4...0.5.0
[0.4.4]: https://github.com/apple/swift-argument-parser/compare/0.4.3...0.4.4
[0.4.3]: https://github.com/apple/swift-argument-parser/compare/0.4.2...0.4.3
[0.4.2]: https://github.com/apple/swift-argument-parser/compare/0.4.1...0.4.2
[0.4.1]: https://github.com/apple/swift-argument-parser/compare/0.4.0...0.4.1
[0.4.0]: https://github.com/apple/swift-argument-parser/compare/0.3.2...0.4.0
[0.3.2]: https://github.com/apple/swift-argument-parser/compare/0.3.1...0.3.2
[0.3.1]: https://github.com/apple/swift-argument-parser/compare/0.3.0...0.3.1
[0.3.0]: https://github.com/apple/swift-argument-parser/compare/0.2.2...0.3.0
[0.2.2]: https://github.com/apple/swift-argument-parser/compare/0.2.1...0.2.2
[0.2.1]: https://github.com/apple/swift-argument-parser/compare/0.2.0...0.2.1
[0.2.0]: https://github.com/apple/swift-argument-parser/compare/0.1.0...0.2.0
[0.1.0]: https://github.com/apple/swift-argument-parser/compare/0.0.6...0.1.0
[0.0.6]: https://github.com/apple/swift-argument-parser/compare/0.0.5...0.0.6
[0.0.5]: https://github.com/apple/swift-argument-parser/compare/0.0.4...0.0.5
[0.0.4]: https://github.com/apple/swift-argument-parser/compare/0.0.3...0.0.4
[0.0.3]: https://github.com/apple/swift-argument-parser/compare/0.0.2...0.0.3
[0.0.2]: https://github.com/apple/swift-argument-parser/compare/0.0.1...0.0.2
[0.0.1]: https://github.com/apple/swift-argument-parser/releases/tag/0.0.1
<!-- Link references for pull requests -->
[#65]: https://github.com/apple/swift-argument-parser/pull/65
[#240]: https://github.com/apple/swift-argument-parser/pull/240
[#251]: https://github.com/apple/swift-argument-parser/pull/251
[#256]: https://github.com/apple/swift-argument-parser/pull/256
[#276]: https://github.com/apple/swift-argument-parser/pull/276
[#290]: https://github.com/apple/swift-argument-parser/pull/290
[#299]: https://github.com/apple/swift-argument-parser/pull/299
[#304]: https://github.com/apple/swift-argument-parser/pull/304
[#308]: https://github.com/apple/swift-argument-parser/pull/308
[#309]: https://github.com/apple/swift-argument-parser/pull/309
[#310]: https://github.com/apple/swift-argument-parser/pull/310
[#315]: https://github.com/apple/swift-argument-parser/pull/315
[#316]: https://github.com/apple/swift-argument-parser/pull/316
[#320]: https://github.com/apple/swift-argument-parser/pull/320
[#321]: https://github.com/apple/swift-argument-parser/pull/321
[#323]: https://github.com/apple/swift-argument-parser/pull/323
[#324]: https://github.com/apple/swift-argument-parser/pull/324
[#332]: https://github.com/apple/swift-argument-parser/pull/332
[#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
[#424]: https://github.com/apple/swift-argument-parser/pull/424
[#427]: https://github.com/apple/swift-argument-parser/pull/427
[#435]: https://github.com/apple/swift-argument-parser/pull/435
[#436]: https://github.com/apple/swift-argument-parser/pull/436
[#443]: https://github.com/apple/swift-argument-parser/pull/443
[#445]: https://github.com/apple/swift-argument-parser/pull/445
[#456]: https://github.com/apple/swift-argument-parser/pull/456
[#471]: https://github.com/apple/swift-argument-parser/pull/471
[#472]: https://github.com/apple/swift-argument-parser/pull/472
[#473]: https://github.com/apple/swift-argument-parser/pull/473
[#474]: https://github.com/apple/swift-argument-parser/pull/474
[#475]: https://github.com/apple/swift-argument-parser/pull/475
[#476]: https://github.com/apple/swift-argument-parser/pull/476
[#477]: https://github.com/apple/swift-argument-parser/pull/477
[#480]: https://github.com/apple/swift-argument-parser/pull/480
[#486]: https://github.com/apple/swift-argument-parser/pull/486
[#487]: https://github.com/apple/swift-argument-parser/pull/487
[#492]: https://github.com/apple/swift-argument-parser/pull/492
[#494]: https://github.com/apple/swift-argument-parser/pull/494
[#495]: https://github.com/apple/swift-argument-parser/pull/495
[#496]: https://github.com/apple/swift-argument-parser/pull/496
[#505]: https://github.com/apple/swift-argument-parser/pull/505
[#520]: https://github.com/apple/swift-argument-parser/pull/520
[#522]: https://github.com/apple/swift-argument-parser/pull/522
[#535]: https://github.com/apple/swift-argument-parser/pull/535
[#542]: https://github.com/apple/swift-argument-parser/pull/542
[#547]: https://github.com/apple/swift-argument-parser/pull/547
[#548]: https://github.com/apple/swift-argument-parser/pull/548
[#550]: https://github.com/apple/swift-argument-parser/pull/550
[#552]: https://github.com/apple/swift-argument-parser/pull/552
[#554]: https://github.com/apple/swift-argument-parser/pull/554
[#574]: https://github.com/apple/swift-argument-parser/pull/574
[#579]: https://github.com/apple/swift-argument-parser/pull/579
<!-- Link references for contributors -->
[3405691582]: https://github.com/apple/swift-argument-parser/commits?author=3405691582
[adellibovi]: https://github.com/apple/swift-argument-parser/commits?author=adellibovi
[aleksey-mashanov]: https://github.com/apple/swift-argument-parser/commits?author=aleksey-mashanov
[AliSoftware]: https://github.com/apple/swift-argument-parser/commits?author=AliSoftware
[allevato]: https://github.com/apple/swift-argument-parser/commits?author=allevato
[artemnovichkov]: https://github.com/apple/swift-argument-parser/commits?author=artemnovichkov
[atierian]: https://github.com/apple/swift-argument-parser/commits?author=atierian
[BradLarson]: https://github.com/apple/swift-argument-parser/commits?author=BradLarson
[buttaface]: https://github.com/apple/swift-argument-parser/commits?author=buttaface
[Chamepp]: https://github.com/apple/swift-argument-parser/commits?author=Chamepp
[clayellis]: https://github.com/apple/swift-argument-parser/commits?author=clayellis
[CodaFi]: https://github.com/apple/swift-argument-parser/commits?author=CodaFi
[compnerd]: https://github.com/apple/swift-argument-parser/commits?author=compnerd
[CraigSiemens]: https://github.com/apple/swift-argument-parser/commits?author=CraigSiemens
[CypherPoet]: https://github.com/apple/swift-argument-parser/commits?author=CypherPoet
[d-ronnqvist]: https://github.com/apple/swift-argument-parser/commits?author=d-ronnqvist
[damuellen]: https://github.com/apple/swift-argument-parser/commits?author=damuellen
[dduan]: https://github.com/apple/swift-argument-parser/commits?author=dduan
[dirtyhabits97]: https://github.com/apple/swift-argument-parser/commits?author=dirtyhabits97
[drewmccormack]: https://github.com/apple/swift-argument-parser/commits?author=drewmccormack
[elliottwilliams]: https://github.com/apple/swift-argument-parser/commits?author=elliottwilliams
[erica]: https://github.com/apple/swift-argument-parser/commits?author=erica
[floam]: https://github.com/apple/swift-argument-parser/commits?author=floam
[Frizlab]: https://github.com/apple/swift-argument-parser/commits?author=Frizlab
[glessard]: https://github.com/apple/swift-argument-parser/commits?author=glessard
[gmittert]: https://github.com/apple/swift-argument-parser/commits?author=gmittert
[griffin-stewie]: https://github.com/apple/swift-argument-parser/commits?author=griffin-stewie
[gwynne]: https://github.com/apple/swift-argument-parser/commits?author=gwynne
[iainsmith]: https://github.com/apple/swift-argument-parser/commits?author=iainsmith
[ian-twilightcoder]: https://github.com/apple/swift-argument-parser/commits?author=ian-twilightcoder
[ibrahimoktay]: https://github.com/apple/swift-argument-parser/commits?author=ibrahimoktay
[imxieyi]: https://github.com/apple/swift-argument-parser/commits?author=imxieyi
[IngmarStein]: https://github.com/apple/swift-argument-parser/commits?author=IngmarStein
[interstateone]: https://github.com/apple/swift-argument-parser/commits?author=interstateone
[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
[KeithBird]: https://github.com/apple/swift-argument-parser/commits?author=KeithBird
[kennyyork]: https://github.com/apple/swift-argument-parser/commits?author=kennyyork
[kkk669]: https://github.com/apple/swift-argument-parser/commits?author=kkk669
[klaaspieter]: https://github.com/apple/swift-argument-parser/commits?author=klaaspieter
[konomae]: https://github.com/apple/swift-argument-parser/commits?author=konomae
[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
[LucianoPAlmeida]: https://github.com/apple/swift-argument-parser/commits?author=LucianoPAlmeida
[MarcoEidinger]: https://github.com/apple/swift-argument-parser/commits?author=MarcoEidinger
[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
[miggs597]: https://github.com/apple/swift-argument-parser/commits?author=miggs597
[miguelangel-dev]: https://github.com/apple/swift-argument-parser/commits?author=miguelangel-dev
[MPLew-is]: https://github.com/apple/swift-argument-parser/commits?author=MPLew-is
[mtj0928]: https://github.com/apple/swift-argument-parser/commits?author=mtj0928
[natecook1000]: https://github.com/apple/swift-argument-parser/commits?author=natecook1000
[NicFontana]: https://github.com/apple/swift-argument-parser/commits?author=NicFontana
[owenv]: https://github.com/apple/swift-argument-parser/commits?author=owenv
[pegasuze]: https://github.com/apple/swift-argument-parser/commits?author=pegasuze
[randomeizer]: https://github.com/apple/swift-argument-parser/commits?author=randomeizer
[rauhul]: https://github.com/apple/swift-argument-parser/commits?author=rauhul
[rickrizzo]: https://github.com/apple/swift-argument-parser/commits?author=rickrizzo
[rjstelling]: https://github.com/apple/swift-argument-parser/commits?author=rjstelling
[Sajjon]: https://github.com/apple/swift-argument-parser/commits?author=Sajjon
[schlagelk]: https://github.com/apple/swift-argument-parser/commits?author=schlagelk
[SergeyPetrachkov]: https://github.com/apple/swift-argument-parser/commits?author=SergeyPetrachkov
[sgl0v]: https://github.com/apple/swift-argument-parser/commits?author=sgl0v
[sharplet]: https://github.com/apple/swift-argument-parser/commits?author=sharplet
[sjavora]: https://github.com/apple/swift-argument-parser/commits?author=sjavora
[stuartcarnie]: https://github.com/apple/swift-argument-parser/commits?author=stuartcarnie
[thomasvl]: https://github.com/apple/swift-argument-parser/commits?author=thomasvl
[TiagoMaiaL]: https://github.com/apple/swift-argument-parser/commits?author=TiagoMaiaL
[toddthomas]: https://github.com/apple/swift-argument-parser/commits?author=toddthomas
[werm098]: https://github.com/apple/swift-argument-parser/commits?author=werm098
[Wevah]: https://github.com/apple/swift-argument-parser/commits?author=Wevah
[Wildchild9]: https://github.com/apple/swift-argument-parser/commits?author=Wildchild9
[yim-lee]: https://github.com/apple/swift-argument-parser/commits?author=yim-lee
[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
|