mirror of
https://github.com/apple/swift-argument-parser.git
synced 2026-05-07 20:12:41 +00:00
Nate Cook
1141ed1e1b
Adds a new `AsyncParsableCommand` protocol, which provides a
`static func main() async` entry point and can call through to the root
command's or a subcommand's asynchronous `run()` method. For this
asynchronous execution, the root command must conform to `AsyncParsableCommand`,
but its subcommands can be a mix of asynchronous and synchronous commands.
Due to an issue in Swift 5.5, you can only use `@main` on an
`AsyncParsableCommand` root command starting in Swift 5.6.
This change also includes a workaround for clients that are using Swift 5.5.
Declare a separate type that conforms to `AsyncMainProtocol` and add the `@main`
attribute to that type.
```
@main enum Main: AsyncMain {
typealias Command = <#command#>
}
```
59 lines
2.1 KiB
Swift
59 lines
2.1 KiB
Swift
//===----------------------------------------------------------*- swift -*-===//
|
|
//
|
|
// 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 XCTest
|
|
import ArgumentParserTestHelpers
|
|
|
|
final class RollDiceExampleTests: XCTestCase {
|
|
func testRollDice() throws {
|
|
try AssertExecuteCommand(command: "roll --times 6")
|
|
}
|
|
|
|
func testRollDice_Help() throws {
|
|
let helpText = """
|
|
USAGE: roll [--times <n>] [--sides <m>] [--seed <seed>] [--verbose]
|
|
|
|
OPTIONS:
|
|
--times <n> Rolls the dice <n> times. (default: 1)
|
|
--sides <m> Rolls an <m>-sided dice. (default: 6)
|
|
Use this option to override the default value of a six-sided die.
|
|
--seed <seed> A seed to use for repeatable random generation.
|
|
-v, --verbose Show all roll results.
|
|
-h, --help Show help information.
|
|
"""
|
|
|
|
try AssertExecuteCommand(command: "roll -h", expected: helpText)
|
|
try AssertExecuteCommand(command: "roll --help", expected: helpText)
|
|
}
|
|
|
|
func testRollDice_Fail() throws {
|
|
try AssertExecuteCommand(
|
|
command: "roll --times",
|
|
expected: """
|
|
Error: Missing value for '--times <n>'
|
|
Help: --times <n> Rolls the dice <n> times.
|
|
Usage: roll [--times <n>] [--sides <m>] [--seed <seed>] [--verbose]
|
|
See 'roll --help' for more information.
|
|
""",
|
|
exitCode: .validationFailure)
|
|
|
|
try AssertExecuteCommand(
|
|
command: "roll --times ZZZ",
|
|
expected: """
|
|
Error: The value 'ZZZ' is invalid for '--times <n>'
|
|
Help: --times <n> Rolls the dice <n> times.
|
|
Usage: roll [--times <n>] [--sides <m>] [--seed <seed>] [--verbose]
|
|
See 'roll --help' for more information.
|
|
""",
|
|
exitCode: .validationFailure)
|
|
}
|
|
}
|