Skip to content

Commit c9c7f2c

Browse files
heckjheckj
committed
final commands - help to full sentences, abstracts to full sentences.
1 parent 147c4e4 commit c9c7f2c

File tree

4 files changed

+35
-35
lines changed

4 files changed

+35
-35
lines changed

‎Sources/PackageCollectionsCommand/PackageCollectionsCommand.swift

+17-17
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public struct PackageCollectionsCommand: AsyncParsableCommand {
5858
public static var configuration = CommandConfiguration(
5959
commandName: "package-collection",
6060
_superCommandName: "swift",
61-
abstract: "Interact with package collections",
61+
abstract: "Interact with package collections.",
6262
discussion: "SEE ALSO: swift build, swift package, swift run, swift test",
6363
version: SwiftVersion.current.completeDisplayString,
6464
subcommands: [
@@ -77,7 +77,7 @@ public struct PackageCollectionsCommand: AsyncParsableCommand {
7777
// MARK: Collections
7878

7979
struct List: AsyncSwiftCommand {
80-
static let configuration = CommandConfiguration(abstract: "List configured collections")
80+
static let configuration = CommandConfiguration(abstract: "List configured collections.")
8181

8282
@OptionGroup
8383
var jsonOptions: JSONOptions
@@ -101,7 +101,7 @@ public struct PackageCollectionsCommand: AsyncParsableCommand {
101101
}
102102

103103
struct Refresh: AsyncSwiftCommand {
104-
static let configuration = CommandConfiguration(abstract: "Refresh configured collections")
104+
static let configuration = CommandConfiguration(abstract: "Refresh configured collections.")
105105

106106
@OptionGroup(visibility: .hidden)
107107
var globalOptions: GlobalOptions
@@ -115,18 +115,18 @@ public struct PackageCollectionsCommand: AsyncParsableCommand {
115115
}
116116

117117
struct Add: AsyncSwiftCommand {
118-
static let configuration = CommandConfiguration(abstract: "Add a new collection")
118+
static let configuration = CommandConfiguration(abstract: "Add a new collection.")
119119

120-
@Argument(help: "URL of the collection to add")
120+
@Argument(help: "URL of the collection to add.")
121121
var collectionURL: String
122122

123-
@Option(name: .long, help: "Sort order for the added collection")
123+
@Option(name: .long, help: "Sort order for the added collection.")
124124
var order: Int?
125125

126-
@Flag(name: .long, help: "Trust the collection even if it is unsigned")
126+
@Flag(name: .long, help: "Trust the collection even if it is unsigned.")
127127
var trustUnsigned: Bool = false
128128

129-
@Flag(name: .long, help: "Skip signature check if the collection is signed")
129+
@Flag(name: .long, help: "Skip signature check if the collection is signed.")
130130
var skipSignatureCheck: Bool = false
131131

132132
@OptionGroup(visibility: .hidden)
@@ -158,9 +158,9 @@ public struct PackageCollectionsCommand: AsyncParsableCommand {
158158
}
159159

160160
struct Remove: AsyncSwiftCommand {
161-
static let configuration = CommandConfiguration(abstract: "Remove a configured collection")
161+
static let configuration = CommandConfiguration(abstract: "Remove a configured collection.")
162162

163-
@Argument(help: "URL of the collection to remove")
163+
@Argument(help: "URL of the collection to remove.")
164164
var collectionURL: String
165165

166166
@OptionGroup(visibility: .hidden)
@@ -186,15 +186,15 @@ public struct PackageCollectionsCommand: AsyncParsableCommand {
186186
}
187187

188188
struct Search: AsyncSwiftCommand {
189-
static var configuration = CommandConfiguration(abstract: "Search for packages by keywords or module names")
189+
static var configuration = CommandConfiguration(abstract: "Search for packages by keywords or module names.")
190190

191191
@OptionGroup
192192
var jsonOptions: JSONOptions
193193

194-
@Flag(help: "Pick the method for searching")
194+
@Flag(help: "Pick the method for searching.")
195195
var searchMethod: SearchMethod
196196

197-
@Argument(help: "Search query")
197+
@Argument(help: "The search query.")
198198
var searchQuery: String
199199

200200
@OptionGroup(visibility: .hidden)
@@ -233,18 +233,18 @@ public struct PackageCollectionsCommand: AsyncParsableCommand {
233233
// MARK: Packages
234234

235235
struct Describe: AsyncSwiftCommand {
236-
static var configuration = CommandConfiguration(abstract: "Get metadata for a collection or a package included in an imported collection")
236+
static var configuration = CommandConfiguration(abstract: "Get metadata for a collection or a package included in an imported collection.")
237237

238238
@OptionGroup
239239
var jsonOptions: JSONOptions
240240

241-
@Argument(help: "URL of the package or collection to get information for")
241+
@Argument(help: "URL of the package or collection to get information for.")
242242
var packageURL: String
243243

244-
@Option(name: .long, help: "Version of the package to get information for")
244+
@Option(name: .long, help: "Version of the package to get information for.")
245245
var version: String?
246246

247-
@Flag(name: .long, help: "Skip signature check if the collection is signed")
247+
@Flag(name: .long, help: "Skip signature check if the collection is signed.")
248248
var skipSignatureCheck: Bool = false
249249

250250
@OptionGroup(visibility: .hidden)

‎Sources/PackageRegistryCommand/PackageRegistryCommand+Auth.swift

+7-7
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ extension PackageRegistryCommand {
113113
}
114114

115115
static let configuration = CommandConfiguration(
116-
abstract: "Log in to a registry"
116+
abstract: "Log in to a registry."
117117
)
118118

119119
static let maxPasswordLength = 512
@@ -125,29 +125,29 @@ extension PackageRegistryCommand {
125125
@OptionGroup(visibility: .hidden)
126126
var globalOptions: GlobalOptions
127127

128-
@Argument(help: "The registry URL")
128+
@Argument(help: "The registry URL.")
129129
var url: URL?
130130

131131
var registryURL: URL? {
132132
self.url
133133
}
134134

135-
@Option(help: "Username")
135+
@Option(help: "The username for the registry.")
136136
var username: String?
137137

138-
@Option(help: "Password")
138+
@Option(help: "The password for the registry.")
139139
var password: String?
140140

141-
@Option(help: "Access token")
141+
@Option(help: "The access token for the registry.")
142142
var token: String?
143143

144144
@Option(
145145
name: .customLong("token-file"),
146-
help: "Path to the file containing access token"
146+
help: "Path to the file containing access token."
147147
)
148148
var tokenFilePath: AbsolutePath?
149149

150-
@Flag(help: "Allow writing to netrc file without confirmation")
150+
@Flag(help: "Allow writing to netrc file without confirmation.")
151151
var noConfirm: Bool = false
152152

153153
private static let PLACEHOLDER_TOKEN_USER = "token"

‎Sources/PackageRegistryCommand/PackageRegistryCommand+Publish.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ extension PackageRegistryCommand {
3838
static let metadataFilename = "package-metadata.json"
3939

4040
static let configuration = CommandConfiguration(
41-
abstract: "Publish to a registry"
41+
abstract: "Publish to a registry."
4242
)
4343

4444
@OptionGroup(visibility: .hidden)
@@ -83,7 +83,7 @@ extension PackageRegistryCommand {
8383
)
8484
var certificateChainPaths: [AbsolutePath] = []
8585

86-
@Flag(name: .customLong("allow-insecure-http"), help: "Allow using a non-HTTPS registry URL")
86+
@Flag(name: .customLong("allow-insecure-http"), help: "Allow using a non-HTTPS registry URL.")
8787
var allowInsecureHTTP: Bool = false
8888

8989
@Flag(help: "Dry run only; prepare the archive and sign it but do not publish to the registry.")

‎Sources/PackageRegistryCommand/PackageRegistryCommand.swift

+9-9
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public struct PackageRegistryCommand: AsyncParsableCommand {
2323
public static var configuration = CommandConfiguration(
2424
commandName: "package-registry",
2525
_superCommandName: "swift",
26-
abstract: "Interact with package registry and manage related configuration",
26+
abstract: "Interact with package registry and manage related configuration.",
2727
discussion: "SEE ALSO: swift package",
2828
version: SwiftVersion.current.completeDisplayString,
2929
subcommands: [
@@ -43,22 +43,22 @@ public struct PackageRegistryCommand: AsyncParsableCommand {
4343

4444
struct Set: AsyncSwiftCommand {
4545
static let configuration = CommandConfiguration(
46-
abstract: "Set a custom registry"
46+
abstract: "Set a custom registry."
4747
)
4848

4949
@OptionGroup(visibility: .hidden)
5050
var globalOptions: GlobalOptions
5151

52-
@Flag(help: "Apply settings to all projects for this user")
52+
@Flag(help: "Apply settings to all projects for this user.")
5353
var global: Bool = false
5454

55-
@Option(help: "Associate the registry with a given scope")
55+
@Option(help: "Associate the registry with a given scope.")
5656
var scope: String?
5757

58-
@Flag(name: .customLong("allow-insecure-http"), help: "Allow using a non-HTTPS registry URL")
58+
@Flag(name: .customLong("allow-insecure-http"), help: "Allow using a non-HTTPS registry URL.")
5959
var allowInsecureHTTP: Bool = false
6060

61-
@Argument(help: "The registry URL")
61+
@Argument(help: "The registry URL.")
6262
var url: URL
6363

6464
var registryURL: URL {
@@ -90,16 +90,16 @@ public struct PackageRegistryCommand: AsyncParsableCommand {
9090

9191
struct Unset: AsyncSwiftCommand {
9292
static let configuration = CommandConfiguration(
93-
abstract: "Remove a configured registry"
93+
abstract: "Remove a configured registry."
9494
)
9595

9696
@OptionGroup(visibility: .hidden)
9797
var globalOptions: GlobalOptions
9898

99-
@Flag(help: "Apply settings to all projects for this user")
99+
@Flag(help: "Apply settings to all projects for this user.")
100100
var global: Bool = false
101101

102-
@Option(help: "Associate the registry with a given scope")
102+
@Option(help: "Associate the registry with a given scope.")
103103
var scope: String?
104104

105105
func run(_ swiftCommandState: SwiftCommandState) async throws {

0 commit comments

Comments
 (0)