mirror of
https://github.com/apple/swift-argument-parser.git
synced 2026-05-07 20:12:41 +00:00
Bassam (Sam) Khouri
a78d98b92d
In some use cases, there is a need to have an option argument behave
like a flag.
This change introduced 4 new intialiazers to `Option` that accept a
`defaultAsFlag` value.
With the following usage:
```swift
struct Example: ParsableCommand {
@Option(defaultAsFlag: "default", help: "Set output format.")
var format: String?
func run() {
print("Format: \(format ?? "none")")
}
}
```
The `defaultAsFlag` parameter creates a hybrid that supports both patterns:
- **Flag behavior**: `--format` (sets format to "default")
- **Option behavior**: `--format json` (sets format to "json")
- **No usage**: format remains `nil`
As a user of the command line tool, the `--help` output clearly distinguishes
between the the hybrid and regular usages.
```
OPTIONS:
--format [<format>] Set output format. (default as flag: default)
````
Note the `(default as flag: ...)` text instead of regular `(default: ...)`,
and the optional value syntax `[<value>]` instead of required `<value>`.
Fixes: #829
145 lines
4.3 KiB
Swift
145 lines
4.3 KiB
Swift
// swift-tools-version:6.0
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift Argument Parser open source project
|
|
//
|
|
// Copyright (c) 2020 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import PackageDescription
|
|
|
|
var package = Package(
|
|
name: "swift-argument-parser",
|
|
products: [
|
|
.library(
|
|
name: "ArgumentParser",
|
|
targets: ["ArgumentParser"]),
|
|
.plugin(
|
|
name: "GenerateDoccReference",
|
|
targets: ["GenerateDoccReference"]),
|
|
.plugin(
|
|
name: "GenerateManual",
|
|
targets: ["GenerateManual"]),
|
|
],
|
|
dependencies: [],
|
|
targets: [
|
|
// Core Library
|
|
.target(
|
|
name: "ArgumentParser",
|
|
dependencies: ["ArgumentParserToolInfo"],
|
|
exclude: ["CMakeLists.txt"]),
|
|
.target(
|
|
name: "ArgumentParserTestHelpers",
|
|
dependencies: ["ArgumentParser", "ArgumentParserToolInfo"],
|
|
exclude: ["CMakeLists.txt"]),
|
|
.target(
|
|
name: "ArgumentParserToolInfo",
|
|
exclude: ["CMakeLists.txt"]),
|
|
|
|
// Plugins
|
|
.plugin(
|
|
name: "GenerateDoccReference",
|
|
capability: .command(
|
|
intent: .custom(
|
|
verb: "generate-docc-reference",
|
|
description:
|
|
"Generate a documentation reference for a specified target."),
|
|
permissions: [
|
|
.writeToPackageDirectory(
|
|
reason: "This command generates documentation.")
|
|
]),
|
|
dependencies: ["generate-docc-reference"]),
|
|
.plugin(
|
|
name: "GenerateManual",
|
|
capability: .command(
|
|
intent: .custom(
|
|
verb: "generate-manual",
|
|
description: "Generate a manual entry for a specified target.")),
|
|
dependencies: ["generate-manual"]),
|
|
|
|
// Examples
|
|
.executableTarget(
|
|
name: "roll",
|
|
dependencies: ["ArgumentParser"],
|
|
path: "Examples/roll"),
|
|
.executableTarget(
|
|
name: "math",
|
|
dependencies: ["ArgumentParser"],
|
|
path: "Examples/math"),
|
|
.executableTarget(
|
|
name: "repeat",
|
|
dependencies: ["ArgumentParser"],
|
|
path: "Examples/repeat"),
|
|
.executableTarget(
|
|
name: "color",
|
|
dependencies: ["ArgumentParser"],
|
|
path: "Examples/color"),
|
|
.executableTarget(
|
|
name: "default-as-flag",
|
|
dependencies: ["ArgumentParser"],
|
|
path: "Examples/default-as-flag"
|
|
),
|
|
|
|
// Tools
|
|
.executableTarget(
|
|
name: "generate-docc-reference",
|
|
dependencies: ["ArgumentParser", "ArgumentParserToolInfo"],
|
|
path: "Tools/generate-docc-reference"),
|
|
.executableTarget(
|
|
name: "generate-manual",
|
|
dependencies: ["ArgumentParser", "ArgumentParserToolInfo"],
|
|
path: "Tools/generate-manual"),
|
|
|
|
// Tests
|
|
.testTarget(
|
|
name: "ArgumentParserEndToEndTests",
|
|
dependencies: ["ArgumentParser", "ArgumentParserTestHelpers"],
|
|
exclude: ["CMakeLists.txt"]),
|
|
.testTarget(
|
|
name: "ArgumentParserExampleTests",
|
|
dependencies: ["ArgumentParserTestHelpers"],
|
|
exclude: ["Snapshots"],
|
|
resources: [.copy("CountLinesTest.txt")]),
|
|
.testTarget(
|
|
name: "ArgumentParserGenerateDoccReferenceTests",
|
|
dependencies: ["ArgumentParserTestHelpers"],
|
|
exclude: ["Snapshots"]),
|
|
.testTarget(
|
|
name: "ArgumentParserGenerateManualTests",
|
|
dependencies: ["ArgumentParserTestHelpers"],
|
|
exclude: ["Snapshots"]),
|
|
.testTarget(
|
|
name: "ArgumentParserPackageManagerTests",
|
|
dependencies: ["ArgumentParser", "ArgumentParserTestHelpers"],
|
|
exclude: ["CMakeLists.txt"]),
|
|
.testTarget(
|
|
name: "ArgumentParserToolInfoTests",
|
|
dependencies: ["ArgumentParserToolInfo"],
|
|
exclude: ["Examples"]),
|
|
.testTarget(
|
|
name: "ArgumentParserUnitTests",
|
|
dependencies: ["ArgumentParser", "ArgumentParserTestHelpers"],
|
|
exclude: ["CMakeLists.txt", "Snapshots"]),
|
|
]
|
|
)
|
|
|
|
#if os(macOS)
|
|
package.targets.append(contentsOf: [
|
|
// Examples
|
|
.executableTarget(
|
|
name: "count-lines",
|
|
dependencies: ["ArgumentParser"],
|
|
path: "Examples/count-lines"),
|
|
|
|
// Tools
|
|
.executableTarget(
|
|
name: "changelog-authors",
|
|
dependencies: ["ArgumentParser"],
|
|
path: "Tools/changelog-authors"),
|
|
])
|
|
#endif
|