Merge pull request #1399 from ahoppen/debug-subcommand

Move debug subcommands of sourcekit-lsp to a `debug` subcommand and unhide them

Author: ahoppen

Sources/Diagnose/CMakeLists.txt

@@ -1,6 +1,7 @@
 add_library(Diagnose STATIC
   CommandConfiguration+Sendable.swift
   CommandLineArgumentsReducer.swift
+  DebugCommand.swift
   DiagnoseCommand.swift
   IndexCommand.swift
   MergeSwiftFiles.swift

Sources/Diagnose/DebugCommand.swift

@@ -0,0 +1,28 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2024 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
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import ArgumentParser
+
+public struct DebugCommand: ParsableCommand {
+  public static let configuration = CommandConfiguration(
+    commandName: "debug",
+    abstract: "Commands to debug sourcekit-lsp. Intended for developers of sourcekit-lsp",
+    subcommands: [
+      IndexCommand.self,
+      ReduceCommand.self,
+      ReduceFrontendCommand.self,
+      RunSourceKitdRequestCommand.self,
+    ]
+  )
+
+  public init() {}
+}

Sources/Diagnose/IndexCommand.swift

@@ -55,8 +55,7 @@ private actor IndexLogMessageHandler: MessageHandler {
 public struct IndexCommand: AsyncParsableCommand {
   public static let configuration: CommandConfiguration = CommandConfiguration(
     commandName: "index",
-    abstract: "Index a project and print all the processes executed for it as well as their outputs",
-    shouldDisplay: false
+    abstract: "Index a project and print all the processes executed for it as well as their outputs"
   )
 
   @Option(

Sources/Diagnose/ReduceCommand.swift

@@ -22,8 +22,7 @@ import class TSCUtility.PercentProgressAnimation
 public struct ReduceCommand: AsyncParsableCommand {
   public static let configuration: CommandConfiguration = CommandConfiguration(
     commandName: "reduce",
-    abstract: "Reduce a single sourcekitd crash",
-    shouldDisplay: false
+    abstract: "Reduce a single sourcekitd crash"
   )
 
   @Option(name: .customLong("request-file"), help: "Path to a sourcekitd request to reduce.")

Sources/Diagnose/ReduceFrontendCommand.swift

@@ -22,8 +22,7 @@ import class TSCUtility.PercentProgressAnimation
 public struct ReduceFrontendCommand: AsyncParsableCommand {
   public static let configuration: CommandConfiguration = CommandConfiguration(
     commandName: "reduce-frontend",
-    abstract: "Reduce a single swift-frontend crash",
-    shouldDisplay: false
+    abstract: "Reduce a single swift-frontend crash"
   )
 
   #if canImport(Darwin)

Sources/Diagnose/RunSourcekitdRequestCommand.swift

@@ -21,8 +21,7 @@ import struct TSCBasic.AbsolutePath
 public struct RunSourceKitdRequestCommand: AsyncParsableCommand {
   public static let configuration = CommandConfiguration(
     commandName: "run-sourcekitd-request",
-    abstract: "Run a sourcekitd request and print its result",
-    shouldDisplay: false
+    abstract: "Run a sourcekitd request and print its result"
   )
 
   @Option(

Sources/Diagnose/SourceKitDRequestExecutor.swift

@@ -161,6 +161,7 @@ public class OutOfProcessSourceKitRequestExecutor: SourceKitRequestExecutor {
     let process = Process(
       arguments: [
         ProcessInfo.processInfo.arguments[0],
+        "debug",
         "run-sourcekitd-request",
         "--sourcekitd",
         sourcekitd.path,

Sources/sourcekit-lsp/SourceKitLSP.swift

@@ -105,10 +105,7 @@ struct SourceKitLSP: AsyncParsableCommand {
     abstract: "Language Server Protocol implementation for Swift and C-based languages",
     subcommands: [
       DiagnoseCommand.self,
-      IndexCommand.self,
-      ReduceCommand.self,
-      ReduceFrontendCommand.self,
-      RunSourceKitdRequestCommand.self,
+      DebugCommand.self,
     ]
   )