Add --workspace-type flag

Author: z2oh

Sources/SourceKitLSP/SourceKitServer+Options.swift

@@ -30,6 +30,9 @@ extension SourceKitServer {
     /// Additional arguments to pass to `clangd` on the command-line.
     public var clangdOptions: [String]
 
+    /// Overrides default workspace type selection.
+    public var workspaceType: WorkspaceType?
+
     /// Additional paths to search for a compilation database, relative to a workspace root.
     public var compilationDatabaseSearchPaths: [RelativePath]
 
@@ -52,6 +55,7 @@ extension SourceKitServer {
     public init(
       buildSetup: BuildSetup = .default,
       clangdOptions: [String] = [],
+      workspaceType: WorkspaceType? = nil,
       compilationDatabaseSearchPaths: [RelativePath] = [],
       indexOptions: IndexOptions = .init(),
       completionOptions: SKCompletionOptions = .init(),
@@ -60,6 +64,7 @@ extension SourceKitServer {
     ) {
       self.buildSetup = buildSetup
       self.clangdOptions = clangdOptions
+      self.workspaceType = workspaceType
       self.compilationDatabaseSearchPaths = compilationDatabaseSearchPaths
       self.indexOptions = indexOptions
       self.completionOptions = completionOptions

Sources/SourceKitLSP/SourceKitServer.swift

@@ -1015,6 +1015,7 @@ extension SourceKitServer {
       capabilityRegistry: capabilityRegistry,
       toolchainRegistry: self.toolchainRegistry,
       buildSetup: self.options.buildSetup.merging(workspaceBuildSetup),
+      workspaceType: self.options.workspaceType,
       compilationDatabaseSearchPaths: self.options.compilationDatabaseSearchPaths,
       indexOptions: self.options.indexOptions,
       reloadPackageStatusCallback: { status in

Sources/SourceKitLSP/Workspace.swift

@@ -38,6 +38,10 @@ fileprivate func firstNonNil<T>(
   return try await defaultValue()
 }
 
+public enum WorkspaceType: String {
+  case buildserver, compdb, swiftpm
+}
+
 /// Represents the configuration and state of a project or combination of projects being worked on
 /// together.
 ///
@@ -103,14 +107,53 @@ public final class Workspace {
     capabilityRegistry: CapabilityRegistry,
     toolchainRegistry: ToolchainRegistry,
     buildSetup: BuildSetup,
+    workspaceType: WorkspaceType?,
     compilationDatabaseSearchPaths: [RelativePath],
     indexOptions: IndexOptions = IndexOptions(),
     reloadPackageStatusCallback: @escaping (ReloadPackageStatus) async -> Void
   ) async throws {
     var buildSystem: BuildSystem? = nil
     if let rootUrl = rootUri.fileURL, let rootPath = try? AbsolutePath(validating: rootUrl.path) {
-      if let buildServer = await BuildServerBuildSystem(projectRoot: rootPath, buildSetup: buildSetup) {
-        buildSystem = buildServer
+      if let workspaceType = workspaceType {
+        switch workspaceType {
+          case WorkspaceType.swiftpm:
+            if let swiftpm = await SwiftPMWorkspace(
+              url: rootUrl,
+              toolchainRegistry: toolchainRegistry,
+              buildSetup: buildSetup,
+              reloadPackageStatusCallback: reloadPackageStatusCallback
+            ) {
+              buildSystem = swiftpm
+            } else {
+              logger.error(
+                "Could not set up a swiftpm build system for workspace at '\(rootUri.forLogging)'"
+              )
+              buildSystem = nil
+            }
+          case WorkspaceType.buildserver:
+            if let buildServer = await BuildServerBuildSystem(projectRoot: rootPath, buildSetup: buildSetup) {
+              buildSystem = buildServer
+            } else {
+              logger.error(
+                "Could not set up a build server build system for workspace at '\(rootUri.forLogging)'"
+              )
+              buildSystem = nil
+            }
+          case WorkspaceType.compdb:
+            if let compdb = CompilationDatabaseBuildSystem(
+              projectRoot: rootPath,
+              searchPaths: compilationDatabaseSearchPaths
+            ) {
+              buildSystem = compdb
+            } else {
+              logger.error(
+                "Could not set up a compilation database build system for workspace at '\(rootUri.forLogging)'"
+              )
+              buildSystem = nil
+            }
+        }
+      } else if let buildServer = await BuildServerBuildSystem(projectRoot: rootPath, buildSetup: buildSetup) {
+          buildSystem = buildServer
       } else if let swiftpm = await SwiftPMWorkspace(
         url: rootUrl,
         toolchainRegistry: toolchainRegistry,

Sources/sourcekit-lsp/SourceKitLSP.swift

@@ -92,6 +92,12 @@ extension SKSupport.BuildConfiguration: ExpressibleByArgument {}
 extension SKSupport.BuildConfiguration: @retroactive ExpressibleByArgument {}
 #endif
 
+#if swift(<5.10)
+extension WorkspaceType: ExpressibleByArgument {}
+#else
+extension WorkspaceType: @retroactive ExpressibleByArgument {}
+#endif
+
 @main
 struct SourceKitLSP: ParsableCommand {
   static let configuration = CommandConfiguration(
@@ -169,6 +175,12 @@ struct SourceKitLSP: ParsableCommand {
   )
   var indexPrefixMappings = [PathPrefixMapping]()
 
+  @Option(
+    name: .customLong("workspace-type"),
+    help: "Override default workspace type selection"
+  )
+  var workspaceType: WorkspaceType?
+
   @Option(
     name: .customLong("compilation-db-search-path"),
     parsing: .singleValue,
@@ -197,6 +209,7 @@ struct SourceKitLSP: ParsableCommand {
     serverOptions.buildSetup.flags.linkerFlags = buildFlagsLinker
     serverOptions.buildSetup.flags.swiftCompilerFlags = buildFlagsSwift
     serverOptions.clangdOptions = clangdOptions
+    serverOptions.workspaceType = workspaceType
     serverOptions.compilationDatabaseSearchPaths = compilationDatabaseSearchPaths
     serverOptions.indexOptions.indexStorePath = indexStorePath
     serverOptions.indexOptions.indexDatabasePath = indexDatabasePath