v1.1.4

Compare Source

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!

v1.1.3

Compare Source

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!

v1.2.0

Compare Source

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 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 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!

.github/workflows/ci.yml

• actions/checkout v3
• actions/checkout v3
• actions/cache v3
• actions/upload-artifact v3
• actions/download-artifact v3
• kishikawakatsumi/xcresulttool v1

Package.swift

• apple/swift-argument-parser from: "1.1.4"