work in progress - help to full sentences.

heckj · heckj · commit 58fc542c5d73 · 2025-04-28T08:50:38.000-07:00
diff --git a/Sources/Commands/PackageCommands/APIDiff.swift b/Sources/Commands/PackageCommands/APIDiff.swift
@@ -59,7 +59,7 @@ struct APIDiff: AsyncSwiftCommand {
     """)
     var breakageAllowlistPath: AbsolutePath?
 
-    @Argument(help: "The baseline treeish to compare to (e.g. a commit hash, branch name, tag, etc.)")
+    @Argument(help: "The baseline treeish to compare to (for example, a commit hash, branch name, tag, and so on).")
     var treeish: String
 
     @Option(parsing: .upToNextOption,
diff --git a/Sources/Commands/PackageCommands/AddDependency.swift b/Sources/Commands/PackageCommands/AddDependency.swift
@@ -29,31 +29,31 @@ extension SwiftPackageCommand {
             abstract: "Add a package dependency to the manifest"
         )
 
-        @Argument(help: "The URL or directory of the package to add")
+        @Argument(help: "The URL or directory of the package to add.")
         var dependency: String
 
         @OptionGroup(visibility: .hidden)
         var globalOptions: GlobalOptions
 
-        @Option(help: "The exact package version to depend on")
+        @Option(help: "The exact package version to depend on.")
         var exact: Version?
 
-        @Option(help: "The specific package revision to depend on")
+        @Option(help: "The specific package revision to depend on.")
         var revision: String?
 
-        @Option(help: "The branch of the package to depend on")
+        @Option(help: "The branch of the package to depend on.")
         var branch: String?
 
-        @Option(help: "The package version to depend on (up to the next major version)")
+        @Option(help: "The package version to depend on (up to the next major version).")
         var from: Version?
 
-        @Option(help: "The package version to depend on (up to the next minor version)")
+        @Option(help: "The package version to depend on (up to the next minor version).")
         var upToNextMinorFrom: Version?
 
-        @Option(help: "Specify upper bound on the package version range (exclusive)")
+        @Option(help: "Specify upper bound on the package version range (exclusive).")
         var to: Version?
 
-        @Option(help: "Specify dependency type")
+        @Option(help: "Specify dependency type.")
         var type: DependencyType = .url
 
         enum DependencyType: String, Codable, CaseIterable, ExpressibleByArgument {
diff --git a/Sources/Commands/PackageCommands/AddProduct.swift b/Sources/Commands/PackageCommands/AddProduct.swift
@@ -41,15 +41,15 @@ extension SwiftPackageCommand {
         @OptionGroup(visibility: .hidden)
         var globalOptions: GlobalOptions
 
-        @Argument(help: "The name of the new product")
+        @Argument(help: "The name of the new product.")
         var name: String
 
-        @Option(help: "The type of target to add")
+        @Option(help: "The type of target to add.")
         var type: CommandProductType = .library
 
         @Option(
             parsing: .upToNextOption,
-            help: "A list of targets that are part of this product"
+            help: "A list of targets that are part of this product."
         )
         var targets: [String] = []
 
diff --git a/Sources/Commands/PackageCommands/AddSetting.swift b/Sources/Commands/PackageCommands/AddSetting.swift
@@ -33,19 +33,19 @@ extension SwiftPackageCommand {
         }
 
         package static let configuration = CommandConfiguration(
-            abstract: "Add a new setting to the manifest"
+            abstract: "Add a new setting to the manifest."
         )
 
         @OptionGroup(visibility: .hidden)
         var globalOptions: GlobalOptions
 
-        @Option(help: "The target to add the setting to")
+        @Option(help: "The target to add the setting to.")
         var target: String
 
         @Option(
             name: .customLong("swift"),
             parsing: .unconditionalSingleValue,
-            help: "The Swift language setting(s) to add. Supported settings: \(SwiftSetting.allCases.map(\.rawValue).joined(separator: ", "))"
+            help: "The Swift language setting(s) to add. Supported settings: \(SwiftSetting.allCases.map(\.rawValue).joined(separator: ", "))."
         )
         var _swiftSettings: [String]
 
diff --git a/Sources/Commands/PackageCommands/AddTarget.swift b/Sources/Commands/PackageCommands/AddTarget.swift
@@ -36,33 +36,33 @@ extension SwiftPackageCommand {
         }
 
         package static let configuration = CommandConfiguration(
-            abstract: "Add a new target to the manifest")
+            abstract: "Add a new target to the manifest.")
 
         @OptionGroup(visibility: .hidden)
         var globalOptions: GlobalOptions
 
-        @Argument(help: "The name of the new target")
+        @Argument(help: "The name of the new target.")
         var name: String
 
-        @Option(help: "The type of target to add")
+        @Option(help: "The type of target to add.")
         var type: TargetType = .library
 
         @Option(
             parsing: .upToNextOption,
-            help: "A list of target dependency names"
+            help: "A list of target dependency names."
         )
         var dependencies: [String] = []
 
-        @Option(help: "The URL for a remote binary target")
+        @Option(help: "The URL for a remote binary target.")
         var url: String?
 
-        @Option(help: "The path to a local binary target")
+        @Option(help: "The path to a local binary target.")
         var path: String?
 
-        @Option(help: "The checksum for a remote binary target")
+        @Option(help: "The checksum for a remote binary target.")
         var checksum: String?
 
-        @Option(help: "The testing library to use when generating test targets, which can be one of 'xctest', 'swift-testing', or 'none'")
+        @Option(help: "The testing library to use when generating test targets, which can be one of 'xctest', 'swift-testing', or 'none'.")
         var testingLibrary: PackageModelSyntax.AddTarget.TestHarness = .default
 
         func run(_ swiftCommandState: SwiftCommandState) throws {
diff --git a/Sources/Commands/PackageCommands/AddTargetDependency.swift b/Sources/Commands/PackageCommands/AddTargetDependency.swift
@@ -26,18 +26,18 @@ import Workspace
 extension SwiftPackageCommand {
     struct AddTargetDependency: SwiftCommand {
         package static let configuration = CommandConfiguration(
-            abstract: "Add a new target dependency to the manifest")
+            abstract: "Add a new target dependency to the manifest.")
 
         @OptionGroup(visibility: .hidden)
         var globalOptions: GlobalOptions
 
-        @Argument(help: "The name of the new dependency")
+        @Argument(help: "The name of the new dependency.")
         var dependencyName: String
 
-        @Argument(help: "The name of the target to update")
+        @Argument(help: "The name of the target to update.")
         var targetName: String
 
-        @Option(help: "The package in which the dependency resides")
+        @Option(help: "The package in which the dependency resides.")
         var package: String?
 
         func run(_ swiftCommandState: SwiftCommandState) throws {
diff --git a/Sources/Commands/PackageCommands/ArchiveSource.swift b/Sources/Commands/PackageCommands/ArchiveSource.swift
@@ -29,7 +29,7 @@ extension SwiftPackageCommand {
 
         @Option(
             name: [.short, .long],
-            help: "The absolute or relative path for the generated source archive"
+            help: "The absolute or relative path for the generated source archive."
         )
         var output: AbsolutePath?
 
diff --git a/Sources/Commands/PackageCommands/CompletionCommand.swift b/Sources/Commands/PackageCommands/CompletionCommand.swift
@@ -52,7 +52,7 @@ extension SwiftPackageCommand {
         @OptionGroup(visibility: .hidden)
         var globalOptions: GlobalOptions
 
-        @Argument(help: "Type of completions to list")
+        @Argument(help: "Type of completions to list.")
         var mode: Mode
 
         func run(_ swiftCommandState: SwiftCommandState) async throws {
diff --git a/Sources/Commands/PackageCommands/ComputeChecksum.swift b/Sources/Commands/PackageCommands/ComputeChecksum.swift
@@ -24,7 +24,7 @@ struct ComputeChecksum: SwiftCommand {
     @OptionGroup(visibility: .hidden)
     var globalOptions: GlobalOptions
 
-    @Argument(help: "The absolute or relative path to the binary artifact")
+    @Argument(help: "The absolute or relative path to the binary artifact.")
     var path: AbsolutePath
 
     func run(_ swiftCommandState: SwiftCommandState) throws {
diff --git a/Sources/Commands/SwiftBuildCommand.swift b/Sources/Commands/SwiftBuildCommand.swift
@@ -72,13 +72,13 @@ struct BuildCommandOptions: ParsableArguments {
     }
 
     /// If the test should be built.
-    @Flag(help: "Build both source and test targets")
+    @Flag(help: "Build both source and test targets.")
     var buildTests: Bool = false
 
     /// Whether to enable code coverage.
     @Flag(name: .customLong("code-coverage"),
           inversion: .prefixedEnableDisable,
-          help: "Enable code coverage")
+          help: "Enable code coverage.")
     var enableCodeCoverage: Bool = false
 
     /// If the binary output path should be printed.
@@ -87,20 +87,20 @@ struct BuildCommandOptions: ParsableArguments {
 
     /// Whether to output a graphviz file visualization of the combined job graph for all targets
     @Flag(name: .customLong("print-manifest-job-graph"),
-          help: "Write the command graph for the build manifest as a Graphviz file")
+          help: "Write the command graph for the build manifest as a Graphviz file.")
     var printManifestGraphviz: Bool = false
 
     /// Whether to output a graphviz file visualization of the PIF JSON sent to Swift Build.
     @Flag(name: .customLong("print-pif-manifest-graph"),
-          help: "Write the PIF JSON sent to Swift Build as a Graphviz file")
+          help: "Write the PIF JSON sent to Swift Build as a Graphviz file.")
     var printPIFManifestGraphviz: Bool = false
 
     /// Specific target to build.
-    @Option(help: "Build the specified target")
+    @Option(help: "Build the specified target.")
     var target: String?
 
     /// Specific product to build.
-    @Option(help: "Build the specified product")
+    @Option(help: "Build the specified product.")
     var product: String?
 
     /// Testing library options.
@@ -115,7 +115,7 @@ struct BuildCommandOptions: ParsableArguments {
     package var traits: TraitOptions
 
     /// If should link the Swift stdlib statically.
-    @Flag(name: .customLong("static-swift-stdlib"), inversion: .prefixedNo, help: "Link Swift stdlib statically")
+    @Flag(name: .customLong("static-swift-stdlib"), inversion: .prefixedNo, help: "Link Swift stdlib statically.")
     public var shouldLinkStaticSwiftStdlib: Bool = false
 }
 
diff --git a/Sources/Commands/SwiftRunCommand.swift b/Sources/Commands/SwiftRunCommand.swift
@@ -62,11 +62,11 @@ struct RunCommandOptions: ParsableArguments {
         static func help(for value: RunCommandOptions.RunMode) -> ArgumentHelp? {
             switch value {
             case .repl:
-                return "Launch Swift REPL for the package"
+                return "Launch Swift REPL for the package."
             case .debugger:
-                return "Launch the executable in a debugger session"
+                return "Launch the executable in a debugger session."
             case .run:
-                return "Launch the executable with the provided arguments"
+                return "Launch the executable with the provided arguments."
             }
         }
     }
@@ -75,17 +75,17 @@ struct RunCommandOptions: ParsableArguments {
     @Flag var mode: RunMode = .run
 
     /// If the executable product should be built before running.
-    @Flag(name: .customLong("skip-build"), help: "Skip building the executable product")
+    @Flag(name: .customLong("skip-build"), help: "Skip building the executable product.")
     var shouldSkipBuild: Bool = false
 
     var shouldBuild: Bool { !shouldSkipBuild }
 
     /// If the test should be built.
-    @Flag(name: .customLong("build-tests"), help: "Build both source and test targets")
+    @Flag(name: .customLong("build-tests"), help: "Build both source and test targets.")
     var shouldBuildTests: Bool = false
 
     /// The executable product to run.
-    @Argument(help: "The executable to run", completion: .shellCommand("swift package completion-tool list-executables"))
+    @Argument(help: "The executable to run.", completion: .shellCommand("swift package completion-tool list-executables"))
     var executable: String?
 
     /// Specifies the traits to build the product with.
@@ -94,7 +94,7 @@ struct RunCommandOptions: ParsableArguments {
 
     /// The arguments to pass to the executable.
     @Argument(parsing: .captureForPassthrough,
-              help: "The arguments to pass to the executable")
+              help: "The arguments to pass to the executable.")
     var arguments: [String] = []
 }
 
diff --git a/Sources/Commands/SwiftTestCommand.swift b/Sources/Commands/SwiftTestCommand.swift
@@ -81,7 +81,7 @@ extension TestError: CustomStringConvertible {
 
 struct SharedOptions: ParsableArguments {
     @Flag(name: .customLong("skip-build"),
-          help: "Skip building the test target")
+          help: "Skip building the test target.")
     var shouldSkipBuilding: Bool = false
 
     /// The test product to use. This is useful when there are multiple test products
@@ -160,12 +160,12 @@ struct TestCommandOptions: ParsableArguments {
 
     /// List the tests and exit.
     @Flag(name: [.customLong("list-tests"), .customShort("l")],
-          help: "Lists test methods in specifier format")
+          help: "Lists test methods in specifier format.")
     var _deprecated_shouldListTests: Bool = false
 
     /// If the path of the exported code coverage JSON should be printed.
     @Flag(name: [.customLong("show-codecov-path"), .customLong("show-code-coverage-path"), .customLong("show-coverage-path")],
-          help: "Print the path of the exported code coverage JSON file")
+          help: "Print the path of the exported code coverage JSON file.")
     var shouldPrintCodeCovPath: Bool = false
 
     var testCaseSpecifier: TestCaseSpecifier {
@@ -180,13 +180,13 @@ struct TestCommandOptions: ParsableArguments {
     var _testCaseSpecifier: String?
 
     @Option(help: """
-        Run test cases matching regular expression, Format: <test-target>.<test-case> \
-        or <test-target>.<test-case>/<test>
+        Run test cases that match a regular expression, Format: '<test-target>.<test-case>' \
+        or '<test-target>.<test-case>/<test>'.
         """)
     var filter: [String] = []
 
     @Option(name: .customLong("skip"),
-            help: "Skip test cases matching regular expression, Example: --skip PerformanceTests")
+            help: "Skip test cases that match regular expression, Example: '--skip PerformanceTests'.")
     var _testCaseSkip: [String] = []
 
     /// Path where the xUnit xml file should be generated.
@@ -210,7 +210,7 @@ struct TestCommandOptions: ParsableArguments {
     /// Whether to enable code coverage.
     @Flag(name: .customLong("code-coverage"),
           inversion: .prefixedEnableDisable,
-          help: "Enable code coverage")
+          help: "Enable code coverage.")
     var enableCodeCoverage: Bool = false
 
     /// Configure test output.

Original file line number	Diff line number	Diff line change
`@@ -33,19 +33,19 @@ extension SwiftPackageCommand {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`package static let configuration = CommandConfiguration(`
`36`		`- abstract: "Add a new setting to the manifest"`
	`36`	`+ abstract: "Add a new setting to the manifest."`
`37`	`37`	`)`
`38`	`38`
`39`	`39`	`@OptionGroup(visibility: .hidden)`
`40`	`40`	`var globalOptions: GlobalOptions`
`41`	`41`
`42`		`- @Option(help: "The target to add the setting to")`
	`42`	`+ @Option(help: "The target to add the setting to.")`
`43`	`43`	`var target: String`
`44`	`44`
`45`	`45`	`@Option(`
`46`	`46`	`name: .customLong("swift"),`
`47`	`47`	`parsing: .unconditionalSingleValue,`
`48`		`- help: "The Swift language setting(s) to add. Supported settings: \(SwiftSetting.allCases.map(\.rawValue).joined(separator: ", "))"`
	`48`	`+ help: "The Swift language setting(s) to add. Supported settings: \(SwiftSetting.allCases.map(\.rawValue).joined(separator: ", "))."`
`49`	`49`	`)`
`50`	`50`	`var _swiftSettings: [String]`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ extension SwiftPackageCommand {`
`29`	`29`
`30`	`30`	`@Option(`
`31`	`31`	`name: [.short, .long],`
`32`		`- help: "The absolute or relative path for the generated source archive"`
	`32`	`+ help: "The absolute or relative path for the generated source archive."`
`33`	`33`	`)`
`34`	`34`	`var output: AbsolutePath?`
`35`	`35`