Rename swift-parser-test to swift-parser-cli

swift-parser-test was easily confusable with the SwiftParserTest test target for newcomers.

Also, rename the `print-tree` subcommand to `tree` and `dump-diags` to `diags`. That’s a little shorter to type and you don’t need to remember which of the two commands was `dump` and which one was `print`.

Author: ahoppen

Package.swift

@@ -142,7 +142,7 @@ let package = Package(
       dependencies: ["SwiftSyntax", "SwiftSyntaxParser"]
     ),
     .executableTarget(
-      name: "swift-parser-test",
+      name: "swift-parser-cli",
       dependencies: ["SwiftDiagnostics", "SwiftSyntax", "SwiftParser",
                      "SwiftOperators",
                      .product(name: "ArgumentParser", package: "swift-argument-parser")]

Sources/SwiftParser/SwiftParser.docc/FilingBugReports.md

@@ -2,15 +2,15 @@
 
 Guide to provide steps for filing actionable bug reports for parser failures.
 
-Reducing a test case requires the `swift-parser-test` utility that you can build by checking out `swift-syntax` and running `swift build --product swift-parser-test` or building the `swift-parser-test` target in Xcode.
+Reducing a test case requires the `swift-parser-cli` utility that you can build by checking out `swift-syntax` and running `swift build --product swift-parser-cli` or building the `swift-parser-cli` target in Xcode.
 
 ## Round-Trip Failure or Parser Crash
 
 If you encounter a case where printing the parsed syntax tree does not reproduce the original source file, that’s a round-tripping failure and is considered a serious bug in SwiftSyntax – preserving the original source is a core principle of this library. To reproduce and reduce the failure, perform the following steps
 
 1. Reduce the failure by running 
     ```
-    swift-parser-test reduce /pth/to/file/that/does/not/roundtrip.swift
+    swift-parser-cli reduce /pth/to/file/that/does/not/roundtrip.swift
     ```
 2. File a bug report on <https://github.com/apple/swift-syntax/issues/new/choose> with the reduced source code or fix the issue yourself by following the steps in <doc:FixingBugs>. 
 
@@ -20,7 +20,7 @@ If you have source code that is parsed correctly by the current Swift compiler (
 
 1. Run the following command to see the diagnostics produced by the parser
     ```
-    swift-parser-test print-diags /path/to/file.swift
+    swift-parser-cli print-diags /path/to/file.swift
     ``` 
 2. Remove as much code as possible from your test file and check if it still produces the same diagnostic. 
 3. File a bug report on <https://github.com/apple/swift-syntax/issues/new/choose> with the reduced source code or fix the issue yourself by following the steps in <doc:FixingBugs>.
@@ -31,7 +31,7 @@ If you have valid source code that produced a syntax tree which doesn’t repres
 
 1. Run the following command to print the parsed syntax tree
     ```
-    swift-parser-test dump-tree /path/to/file.swift
+    swift-parser-cli print-tree /path/to/file.swift
     ``` 
 2. Remove as much code as possible from your test file and check if it still produces the same invalid tree
 3. File a bug report on <https://github.com/apple/swift-syntax/issues/new/choose> with the reduced source code or fix the issue yourself by following the steps in <doc:FixingBugs>.

Sources/SwiftParser/SwiftParser.docc/FixingBugs.md

@@ -44,7 +44,7 @@ Unhelpful diagnostics can result from two reasons:
 
 To distinguish these cases run the following command and look at the dumped syntax tree. Use your own judgment to decide whether this models the intended meaning of the source code reasonably well.
 ```
-swift-parser-test print-tree /path/to/file/with/unhelpful/diagnostic.swift
+swift-parser-cli print-tree /path/to/file/with/unhelpful/diagnostic.swift
 ``` 
 
 Fixing the first case where the parser does not recover according to the user’s intent is similar to [Parse of Valid Source Code Produced an Invalid Syntax Tree](#Parse-of-Valid-Source-Code-Produced-an-Invalid-Syntax-Tree). See <doc:SwiftParser/ParserRecovery> for documentation how parser recovery works and determine how to recover better from the invalid source code.

Sources/swift-parser-test/swift-parser-test.swift Sources/swift-parser-cli/swift-parser-cli.swift

@@ -1,4 +1,4 @@
-//===------------ main.swift - Entry point for swift-parser-test ----------===//
+//===--- swift-parser-cli.swift - Entry point for swift-parser-cli --------===//
 //
 // This source file is part of the Swift.org open source project
 //
@@ -28,7 +28,7 @@ func printerr(_ message: String, terminator: String = "\n") {
 
 private func withTemporaryFile<T>(contents: [UInt8], body: (URL) throws -> T) throws -> T {
   var tempFileURL = FileManager.default.temporaryDirectory
-  tempFileURL.appendPathComponent("swift-parser-test-\(UUID().uuidString).swift")
+  tempFileURL.appendPathComponent("swift-parser-cli-\(UUID().uuidString).swift")
   try Data(contents).write(to: tempFileURL)
   defer {
     try? FileManager.default.removeItem(at: tempFileURL)
@@ -47,16 +47,6 @@ private func getContentsOfSourceFile(at path: String?) throws -> [UInt8] {
   return [UInt8](source)
 }
 
-@main
-class SwiftParserTest: ParsableCommand {
-  required init() {}
-
-  static var configuration = CommandConfiguration(
-    abstract: "Utility to test SwiftSyntax syntax tree creation.",
-    subcommands: [VerifyRoundTrip.self, DumpTree.self, PrintDiags.self, Reduce.self]
-  )
-}
-
 /// Fold all of the sequences in the given source file.
 func foldAllSequences(_ tree: SourceFileSyntax) -> (Syntax, [Diagnostic]) {
   var diags: [Diagnostic] = []
@@ -70,9 +60,29 @@ func foldAllSequences(_ tree: SourceFileSyntax) -> (Syntax, [Diagnostic]) {
   return (resultTree, diags)
 }
 
+@main
+class SwiftParserCli: ParsableCommand {
+  required init() {}
+
+  static var configuration = CommandConfiguration(
+    abstract: "Utility to test SwiftSyntax syntax tree creation.",
+    subcommands: [
+      PrintDiags.self,
+      PrintTree.self,
+      Reduce.self,
+      VerifyRoundTrip.self,
+    ]
+  )
+}
+
 class VerifyRoundTrip: ParsableCommand {
   required init() {}
 
+  static var configuration = CommandConfiguration(
+    commandName: "verify-round-trip",
+    abstract: "Verify that printing the parsed syntax tree produces the original source"
+  )
+
   init(sourceFile: String?, swiftVersion: String?, enableBareSlashRegex: Bool?) {
     self.sourceFile = sourceFile
     self.swiftVersion = swiftVersion
@@ -139,6 +149,11 @@ class VerifyRoundTrip: ParsableCommand {
 }
 
 class PrintDiags: ParsableCommand {
+  static var configuration = CommandConfiguration(
+    commandName: "print-diags",
+    abstract: "Print the diagnostics produced by parsing a soruce file"
+  )
+
   required init() {}
 
   @Argument(help: "The source file that should be parsed; if omitted, use stdin")
@@ -178,7 +193,12 @@ class PrintDiags: ParsableCommand {
   }
 }
 
-class DumpTree: ParsableCommand {
+class PrintTree: ParsableCommand {
+  static var configuration = CommandConfiguration(
+    commandName: "print-tree",
+    abstract: "Print the syntax tree produced by parsing a source file"
+  )
+
   required init() {}
 
   @Argument(help: "The source file that should be parsed; if omitted, use stdin")
@@ -217,6 +237,11 @@ class DumpTree: ParsableCommand {
 }
 
 class Reduce: ParsableCommand {
+  static var configuration = CommandConfiguration(
+    commandName: "reduce",
+    abstract: "Reduce a test case that crashes the parser or fails to round-trip to a smaller test case that still reproduces the issue"
+  )
+
   required init() {}
 
   @Argument(help: "The test case that should be reduced; if omitted, use stdin")
@@ -257,7 +282,7 @@ class Reduce: ParsableCommand {
     case potentialCrash
   }
 
-  /// Invoke `swift-parser-test verify-round-trip` with the same arguments as this `reduce` subcommand.
+  /// Invoke `swift-parser-cli verify-round-trip` with the same arguments as this `reduce` subcommand.
   /// Returns the exit code of the invocation.
   private func runVerifyRoundTripInSeparateProcess(source: [UInt8]) throws -> ProcessExit {
     return try withTemporaryFile(contents: source) { tempFileURL in