1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
//===----------------------------------------------------------*- 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
//
//===----------------------------------------------------------------------===//
/// An error type that is presented to the user as an error with parsing their
/// command-line input.
public struct ValidationError: Error, CustomStringConvertible {
/// The error message represented by this instance, this string is presented to
/// the user when a `ValidationError` is thrown from either; `run()`,
/// `validate()` or a transform closure.
public internal(set) var message: String
/// Creates a new validation error with the given message.
public init(_ message: String) {
self.message = message
}
public var description: String {
message
}
}
/// An error type that only includes an exit code.
///
/// If you're printing custom error messages yourself, you can throw this error
/// to specify the exit code without adding any additional output to standard
/// out or standard error.
public struct ExitCode: Error, RawRepresentable, Hashable {
/// The exit code represented by this instance.
public var rawValue: Int32
/// Creates a new `ExitCode` with the given code.
public init(_ code: Int32) {
self.rawValue = code
}
public init(rawValue: Int32) {
self.init(rawValue)
}
/// An exit code that indicates successful completion of a command.
public static let success = ExitCode(Platform.exitCodeSuccess)
/// An exit code that indicates that the command failed.
public static let failure = ExitCode(Platform.exitCodeFailure)
/// An exit code that indicates that the user provided invalid input.
public static let validationFailure = ExitCode(Platform.exitCodeValidationFailure)
/// A Boolean value indicating whether this exit code represents the
/// successful completion of a command.
public var isSuccess: Bool {
self == Self.success
}
}
/// An error type that represents a clean (i.e. non-error state) exit of the
/// utility.
///
/// Throwing a `CleanExit` instance from a `validate` or `run` method, or
/// passing it to `exit(with:)`, exits the program with exit code `0`.
public struct CleanExit: Error, CustomStringConvertible {
internal enum Representation {
case helpRequest(ParsableCommand.Type? = nil)
case message(String)
case dumpRequest(ParsableCommand.Type? = nil)
}
internal var base: Representation
/// Treat this error as a help request and display the full help message.
///
/// You can use this case to simulate the user specifying one of the help
/// flags or subcommands.
///
/// - Parameter command: The command type to offer help for, if different
/// from the root command.
public static func helpRequest(_ type: ParsableCommand.Type? = nil) -> CleanExit {
self.init(base: .helpRequest(type))
}
/// Treat this error as a clean exit with the given message.
public static func message(_ text: String) -> CleanExit {
self.init(base: .message(text))
}
/// Treat this error as a help request and display the full help message.
///
/// You can use this case to simulate the user specifying one of the help
/// flags or subcommands.
///
/// - Parameter command: A command to offer help for, if different from
/// the root command.
public static func helpRequest(_ command: ParsableCommand) -> CleanExit {
return .helpRequest(type(of: command))
}
public var description: String {
switch self.base {
case .helpRequest: return "--help"
case .message(let message): return message
case .dumpRequest: return "--experimental-dump-help"
}
}
}
|
