Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information.
Release Notes
apple/swift-argument-parser (ArgumentParser)
### [`v0.5.0`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#050---2021-09-02)
[Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.4.4...0.5.0)
##### Additions
- When a user doesn't provide a required argument, the error message now
includes that argument's help text. (\[[#324](https://togithub.com/apple/swift-argument-parser/issues/324)])
- Command-line tools built with `ArgumentParser` now include an experimental
flag to dump command/argument/help information as JSON:
`--experimental-dump-help`. (\[[#310](https://togithub.com/apple/swift-argument-parser/issues/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](https://togithub.com/apple/swift-argument-parser/issues/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](https://togithub.com/apple/swift-argument-parser/issues/333)])
- Completion scripts correctly use customized help flags. (\[[#308](https://togithub.com/apple/swift-argument-parser/issues/308)])
- Fixes errors with bash custom completion arguments and the executable path.
(\[[#320](https://togithub.com/apple/swift-argument-parser/issues/320)], \[[#323](https://togithub.com/apple/swift-argument-parser/issues/323)])
- Fixes the behavior when a user specifies both the `help` subcommand and a help
flag. (\[[#309](https://togithub.com/apple/swift-argument-parser/issues/309)])
- A variety of internal improvements. (\[[#315](https://togithub.com/apple/swift-argument-parser/issues/315)], \[[#316](https://togithub.com/apple/swift-argument-parser/issues/316)], \[[#321](https://togithub.com/apple/swift-argument-parser/issues/321)], \[[#341](https://togithub.com/apple/swift-argument-parser/issues/341)])
The 0.5.0 release includes contributions from \[atierian], \[compnerd],
\[dirtyhabits97], \[Frizlab], \[KS1019], \[natecook1000], and \[rauhul]. Thank you!
***
### [`v0.4.4`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#044---2021-07-30)
[Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.4.3...0.4.4)
##### Fixes
- Includes a workaround for a runtime crash with certain `OptionGroup`
configurations when a command is compiled in release mode.
### [`v0.4.3`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#043---2021-04-28)
[Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.4.2...0.4.3)
##### Additions
- Experimental API for hiding `@OptionGroup`-declared properties from
the help screen.
The 0.4.3 release includes a contribution from \[miggs597]. Thank you!
### [`v0.4.2`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#042---2021-04-21)
[Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.4.1...0.4.2)
##### 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](https://togithub.com/apple/swift-argument-parser/issues/290)])
- Help information from super-commands is no longer unnecessarily injected
into subcommand help screens.
The 0.4.2 release includes contributions from \[[`3405691`](https://togithub.com/apple/swift-argument-parser/commit/3405691582)], \[kylemacomber],
\[miggs597], \[natecook1000], and \[werm098]. Thank you!
### [`v0.4.1`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#041---2021-03-08)
[Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.4.0...0.4.1)
##### 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!
### [`v0.4.0`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#040---2021-03-04)
[Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.3.2...0.4.0)
##### 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](https://togithub.com/apple/swift-argument-parser/issues/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](https://togithub.com/apple/swift-argument-parser/issues/251)])
- The `errorCode` property is no longer used as a command's exit code when
`CustomNSError` types are thrown. (\[[#276](https://togithub.com/apple/swift-argument-parser/issues/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!
***
### [`v0.3.2`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#032---2021-01-15)
[Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.3.1...0.3.2)
##### 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](https://togithub.com/apple/swift-argument-parser/issues/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!
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
0.3.1->0.5.0⚠ Dependency Lookup Warnings ⚠
Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information.
Release Notes
apple/swift-argument-parser (ArgumentParser)
### [`v0.5.0`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#050---2021-09-02) [Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.4.4...0.5.0) ##### Additions - When a user doesn't provide a required argument, the error message now includes that argument's help text. (\[[#324](https://togithub.com/apple/swift-argument-parser/issues/324)]) - Command-line tools built with `ArgumentParser` now include an experimental flag to dump command/argument/help information as JSON: `--experimental-dump-help`. (\[[#310](https://togithub.com/apple/swift-argument-parser/issues/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](https://togithub.com/apple/swift-argument-parser/issues/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](https://togithub.com/apple/swift-argument-parser/issues/333)]) - Completion scripts correctly use customized help flags. (\[[#308](https://togithub.com/apple/swift-argument-parser/issues/308)]) - Fixes errors with bash custom completion arguments and the executable path. (\[[#320](https://togithub.com/apple/swift-argument-parser/issues/320)], \[[#323](https://togithub.com/apple/swift-argument-parser/issues/323)]) - Fixes the behavior when a user specifies both the `help` subcommand and a help flag. (\[[#309](https://togithub.com/apple/swift-argument-parser/issues/309)]) - A variety of internal improvements. (\[[#315](https://togithub.com/apple/swift-argument-parser/issues/315)], \[[#316](https://togithub.com/apple/swift-argument-parser/issues/316)], \[[#321](https://togithub.com/apple/swift-argument-parser/issues/321)], \[[#341](https://togithub.com/apple/swift-argument-parser/issues/341)]) The 0.5.0 release includes contributions from \[atierian], \[compnerd], \[dirtyhabits97], \[Frizlab], \[KS1019], \[natecook1000], and \[rauhul]. Thank you! *** ### [`v0.4.4`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#044---2021-07-30) [Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.4.3...0.4.4) ##### Fixes - Includes a workaround for a runtime crash with certain `OptionGroup` configurations when a command is compiled in release mode. ### [`v0.4.3`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#043---2021-04-28) [Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.4.2...0.4.3) ##### Additions - Experimental API for hiding `@OptionGroup`-declared properties from the help screen. The 0.4.3 release includes a contribution from \[miggs597]. Thank you! ### [`v0.4.2`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#042---2021-04-21) [Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.4.1...0.4.2) ##### 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](https://togithub.com/apple/swift-argument-parser/issues/290)]) - Help information from super-commands is no longer unnecessarily injected into subcommand help screens. The 0.4.2 release includes contributions from \[[`3405691`](https://togithub.com/apple/swift-argument-parser/commit/3405691582)], \[kylemacomber], \[miggs597], \[natecook1000], and \[werm098]. Thank you! ### [`v0.4.1`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#041---2021-03-08) [Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.4.0...0.4.1) ##### 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! ### [`v0.4.0`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#040---2021-03-04) [Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.3.2...0.4.0) ##### 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](https://togithub.com/apple/swift-argument-parser/issues/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](https://togithub.com/apple/swift-argument-parser/issues/251)]) - The `errorCode` property is no longer used as a command's exit code when `CustomNSError` types are thrown. (\[[#276](https://togithub.com/apple/swift-argument-parser/issues/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! *** ### [`v0.3.2`](https://togithub.com/apple/swift-argument-parser/blob/HEAD/CHANGELOG.md#032---2021-01-15) [Compare Source](https://togithub.com/apple/swift-argument-parser/compare/0.3.1...0.3.2) ##### 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](https://togithub.com/apple/swift-argument-parser/issues/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!Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.