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
|
//===----------------------------------------------------------*- 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
//
//===----------------------------------------------------------------------===//
/// Help information for a command-line argument.
public struct ArgumentHelp {
/// A short description of the argument.
public var abstract: String = ""
/// An expanded description of the argument, in plain text form.
public var discussion: String = ""
/// An alternative name to use for the argument's value when showing usage
/// information.
///
/// - Note: This property is ignored when generating help for flags, since
/// flags don't include a value.
public var valueName: String?
/// A visibility level indicating whether this argument should be shown in
/// the extended help display.
public var visibility: ArgumentVisibility = .default
/// A Boolean value indicating whether this argument should be shown in
/// the extended help display.
@available(*, deprecated, message: "Use visibility level instead.")
public var shouldDisplay: Bool {
get {
return visibility.base == .default
}
set {
visibility = newValue ? .default : .hidden
}
}
/// Creates a new help instance.
@available(*, deprecated, message: "Use init(_:discussion:valueName:visibility:) instead.")
public init(
_ abstract: String = "",
discussion: String = "",
valueName: String? = nil,
shouldDisplay: Bool)
{
self.abstract = abstract
self.discussion = discussion
self.valueName = valueName
self.shouldDisplay = shouldDisplay
}
/// Creates a new help instance.
public init(
_ abstract: String = "",
discussion: String = "",
valueName: String? = nil,
visibility: ArgumentVisibility = .default)
{
self.abstract = abstract
self.discussion = discussion
self.valueName = valueName
self.visibility = visibility
}
/// A `Help` instance that shows an argument only in the extended help display.
public static var hidden: ArgumentHelp {
ArgumentHelp(visibility: .hidden)
}
/// A `Help` instance that hides an argument from the extended help display.
public static var `private`: ArgumentHelp {
ArgumentHelp(visibility: .private)
}
}
extension ArgumentHelp: ExpressibleByStringInterpolation {
public init(stringLiteral value: String) {
self.abstract = value
}
}
|
