mirror of
https://github.com/apple/swift-argument-parser.git
synced 2026-05-07 20:12:41 +00:00
c0f9a5feee
* Allow normal Swift default property initialization syntax This change allows the normal `var foo = "blah"` default initialization syntax for `Option`s, as a parallel initialization method as using the `default` parameter. * Add simple tests for default property initialization * Centralize some constructor logic into a private `init` Preparing for another no-initial value `init` to be added and the existing one with a `default` parameter to be deprecated * Deprecate previous `Option.init` with `default` parameter It's replaced with an `init` containing no default value parameter, which will be used when the user does not provide any value. Also add a (most likely unnecessary) sanity test to make sure initializations without a default value still work. Also copy out documentation to allow clean removal of the older `init` when the time comes. * Document added test cases * Correct punctuation * Extend standard default initialization syntax to `Option`s with `transform` parameters * Actually replace previous `init` with private version This mirrors the non-transform variants, and should have been included in the previous commits * Clean up usage of default parameter values Private `init` doesn't need defaults, and the deprecated public ones shouldn't have it to avoid confusion with the new methods * Clean up documentation Treat new initializers as the originally intended way to allow for clean removal of the deprecated methods Also add some additional documentation to the deprecated methods to help point users in the right direction * Extend standard default initialization to `Argument`s * Extend standard default initialization to `Flag`s * Default flags with inversions to nil/required * Extend standard default initialization to no-inversion boolean `Flags` Prints a warning when that default value is `true` instead of `false`, as the flag value will be pinned regardless of user input * Eliminate deprecation spam from default value initialization All examples and unit tests have been transitioned to the new syntax, with the exception of `SourceCompatEndToEndTests`, which should not have the old style removed until it is no longer valid source. * Add source compatibility tests for new default syntax and associated changes * Update top-level documentation