Remove configuration options from WorkspaceFolder

This extension was added for VS Code but never used. Let’s remove it in favor of workspace-specific configuration files.

Author: ahoppen

Documentation/LSP Extensions.md

@@ -73,80 +73,6 @@ Added case
 identifier = 'identifier'
 ```
 
-## `WorkspaceFolder`
-
-Added field:
-
-```ts
-/**
- * Build settings that should be used for this workspace.
- *
- * For arguments that have a single value (like the build configuration), this takes precedence over the global
- * options set when launching sourcekit-lsp. For all other options, the values specified in the workspace-specific
- * build setup are appended to the global options.
- */
-var buildSetup?: WorkspaceBuildSetup
-```
-
-with
-
-```ts
-/**
- * The configuration to build a workspace in.
- */
-export enum BuildConfiguration {
-  case debug = 'debug'
-  case release = 'release'
-}
-
-/**
- * The type of workspace; default workspace type selection logic can be overridden.
- */
-export enum WorkspaceType {
-  buildServer = 'buildServer'
-  compilationDatabase = 'compilationDatabase'
-  swiftPM = 'swiftPM'
-}
-
-/// Build settings that should be used for a workspace.
-interface WorkspaceBuildSetup {
-  /**
-   * The configuration that the workspace should be built in.
-   */
-  buildConfiguration?: BuildConfiguration
-
-  /**
-   * The default workspace type to use for this workspace.
-   */
-  defaultWorkspaceType?: WorkspaceType
-
-  /**
-   * The build directory for the workspace.
-   */
-  scratchPath?: DocumentURI
-
-  /**
-   * Arguments to be passed to any C compiler invocations.
-   */
-  cFlags?: string[]
-
-  /**
-   * Arguments to be passed to any C++ compiler invocations.
-   */
-  cxxFlags?: string[]
-
-  /**
-   * Arguments to be passed to any linker invocations.
-   */
-  linkerFlags?: string[]
-
-  /**
-   * Arguments to be passed to any Swift compiler invocations.
-   */
-  swiftFlags?: string[]
-}
-```
-
 ## `textDocument/completion`
 
 Added field:

Sources/LanguageServerProtocol/SupportTypes/WorkspaceFolder.swift

@@ -10,65 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-/// The configuration to build a workspace in.
-///
-/// **(LSP Extension)**
-public enum BuildConfiguration: Hashable, Codable, Sendable {
-  case debug
-  case release
-}
-
-/// The type of workspace; default workspace type selection logic can be overridden.
-///
-/// **(LSP Extension)**
-public enum WorkspaceType: Hashable, Codable, Sendable {
-  case buildServer, compilationDatabase, swiftPM
-}
-
-/// Build settings that should be used for a workspace.
-///
-/// **(LSP Extension)**
-public struct WorkspaceBuildSetup: Hashable, Codable, Sendable {
-  /// The configuration that the workspace should be built in.
-  public let buildConfiguration: BuildConfiguration?
-
-  /// The default workspace type to use for this workspace.
-  public let defaultWorkspaceType: WorkspaceType?
-
-  /// The build directory for the workspace.
-  public let scratchPath: DocumentURI?
-
-  /// Arguments to be passed to any C compiler invocations.
-  public let cFlags: [String]?
-
-  /// Arguments to be passed to any C++ compiler invocations.
-  public let cxxFlags: [String]?
-
-  /// Arguments to be passed to any linker invocations.
-  public let linkerFlags: [String]?
-
-  /// Arguments to be passed to any Swift compiler invocations.
-  public let swiftFlags: [String]?
-
-  public init(
-    buildConfiguration: BuildConfiguration? = nil,
-    defaultWorkspaceType: WorkspaceType? = nil,
-    scratchPath: DocumentURI? = nil,
-    cFlags: [String]? = nil,
-    cxxFlags: [String]? = nil,
-    linkerFlags: [String]? = nil,
-    swiftFlags: [String]? = nil
-  ) {
-    self.buildConfiguration = buildConfiguration
-    self.defaultWorkspaceType = defaultWorkspaceType
-    self.scratchPath = scratchPath
-    self.cFlags = cFlags
-    self.cxxFlags = cxxFlags
-    self.linkerFlags = linkerFlags
-    self.swiftFlags = swiftFlags
-  }
-}
-
 /// Unique identifier for a document.
 public struct WorkspaceFolder: ResponseType, Hashable, Codable, Sendable {
 
@@ -78,27 +19,13 @@ public struct WorkspaceFolder: ResponseType, Hashable, Codable, Sendable {
   /// The name of the workspace (default: basename of url).
   public var name: String
 
-  /// Build settings that should be used for this workspace.
-  ///
-  /// For arguments that have a single value (like the build configuration), this takes precedence over the global
-  /// options set when launching sourcekit-lsp. For all other options, the values specified in the workspace-specific
-  /// build setup are appended to the global options.
-  ///
-  /// **(LSP Extension)**
-  public var buildSetup: WorkspaceBuildSetup?
-
-  public init(
-    uri: DocumentURI,
-    name: String? = nil,
-    buildSetup: WorkspaceBuildSetup? = nil
-  ) {
+  public init(uri: DocumentURI, name: String? = nil) {
     self.uri = uri
 
     self.name = name ?? uri.fileURL?.lastPathComponent ?? "unknown_workspace"
 
     if self.name.isEmpty {
       self.name = "unknown_workspace"
     }
-    self.buildSetup = buildSetup
   }
 }

Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -838,27 +838,6 @@ extension SourceKitLSPServer: BuildSystemDelegate {
   }
 }
 
-extension LanguageServerProtocol.BuildConfiguration {
-  /// Convert `LanguageServerProtocol.BuildConfiguration` to `SKSupport.BuildConfiguration`.
-  var configuration: SKCore.BuildConfiguration {
-    switch self {
-    case .debug: return .debug
-    case .release: return .release
-    }
-  }
-}
-
-private extension LanguageServerProtocol.WorkspaceType {
-  /// Convert `LanguageServerProtocol.WorkspaceType` to `SkSupport.WorkspaceType`.
-  var workspaceType: SKCore.WorkspaceType {
-    switch self {
-    case .buildServer: return .buildServer
-    case .compilationDatabase: return .compilationDatabase
-    case .swiftPM: return .swiftPM
-    }
-  }
-}
-
 extension SourceKitLSPServer {
   nonisolated func logMessageToIndexLog(taskID: IndexTaskID, message: String) {
     var message: Substring = message[...]
@@ -884,29 +863,6 @@ extension SourceKitLSPServer {
 
   // MARK: - General
 
-  /// Returns the build setup for the parameters specified for the given `WorkspaceFolder`.
-  private func buildSetup(for workspaceFolder: WorkspaceFolder) -> BuildSetup {
-    let buildParams = workspaceFolder.buildSetup
-    let scratchPath: AbsolutePath?
-    if let scratchPathParam = buildParams?.scratchPath {
-      scratchPath = try? AbsolutePath(validating: scratchPathParam.pseudoPath)
-    } else {
-      scratchPath = nil
-    }
-    return SKCore.BuildSetup(
-      configuration: buildParams?.buildConfiguration?.configuration,
-      defaultWorkspaceType: buildParams?.defaultWorkspaceType?.workspaceType,
-      path: scratchPath,
-      flags: BuildFlags(
-        cCompilerFlags: buildParams?.cFlags ?? [],
-        cxxCompilerFlags: buildParams?.cxxFlags ?? [],
-        swiftCompilerFlags: buildParams?.swiftFlags ?? [],
-        linkerFlags: buildParams?.linkerFlags ?? [],
-        xcbuildFlags: []
-      )
-    )
-  }
-
   private func reloadPackageStatusCallback(_ status: ReloadPackageStatus) async {
     switch status {
     case .start:
@@ -927,8 +883,7 @@ extension SourceKitLSPServer {
       logger.log("Cannot open workspace before server is initialized")
       return nil
     }
-    var options = self.options
-    options.buildSetup = self.options.buildSetup.merging(buildSetup(for: workspaceFolder))
+    let options = self.options
     let buildSystem = await createBuildSystem(
       rootUri: workspaceFolder.uri,
       options: options,

Sources/SourceKitLSP/Workspace.swift

@@ -255,45 +255,3 @@ struct WeakWorkspace {
     self.value = value
   }
 }
-
-public struct IndexOptions: Sendable {
-
-  /// Override the index-store-path provided by the build system.
-  public var indexStorePath: AbsolutePath?
-
-  /// Override the index-database-path provided by the build system.
-  public var indexDatabasePath: AbsolutePath?
-
-  /// Override the index prefix mappings provided by the build system.
-  public var indexPrefixMappings: [PathPrefixMapping]?
-
-  /// *For Testing* Whether the index should listen to unit events, or wait for
-  /// explicit calls to pollForUnitChangesAndWait().
-  public var listenToUnitEvents: Bool
-
-  /// The percentage of the machine's cores that should at most be used for background indexing.
-  ///
-  /// Setting this to a value < 1 ensures that background indexing doesn't use all CPU resources.
-  public var maxCoresPercentageToUseForBackgroundIndexing: Double
-
-  /// How long to wait until we cancel an update indexstore task. This timeout should be long enough that all
-  /// `swift-frontend` tasks finish within it. It prevents us from blocking the index if the type checker gets stuck on
-  /// an expression for a long time.
-  public var updateIndexStoreTimeout: Duration
-
-  public init(
-    indexStorePath: AbsolutePath? = nil,
-    indexDatabasePath: AbsolutePath? = nil,
-    indexPrefixMappings: [PathPrefixMapping]? = nil,
-    listenToUnitEvents: Bool = true,
-    maxCoresPercentageToUseForBackgroundIndexing: Double = 1,
-    updateIndexStoreTimeout: Duration = .seconds(120)
-  ) {
-    self.indexStorePath = indexStorePath
-    self.indexDatabasePath = indexDatabasePath
-    self.indexPrefixMappings = indexPrefixMappings
-    self.listenToUnitEvents = listenToUnitEvents
-    self.maxCoresPercentageToUseForBackgroundIndexing = maxCoresPercentageToUseForBackgroundIndexing
-    self.updateIndexStoreTimeout = updateIndexStoreTimeout
-  }
-}

Tests/SourceKitLSPTests/WorkspaceTests.swift

@@ -723,46 +723,6 @@ final class WorkspaceTests: XCTestCase {
       ]
     )
   }
-
-  public func testWorkspaceSpecificBuildSettings() async throws {
-    let project = try await SwiftPMTestProject(
-      files: [
-        "test.swift": """
-        #if MY_FLAG
-        let a: Int = ""
-        #endif
-        """
-      ],
-      workspaces: {
-        [
-          WorkspaceFolder(
-            uri: DocumentURI($0),
-            buildSetup: WorkspaceBuildSetup(
-              buildConfiguration: nil,
-              scratchPath: nil,
-              cFlags: nil,
-              cxxFlags: nil,
-              linkerFlags: nil,
-              swiftFlags: ["-DMY_FLAG"]
-            )
-          )
-        ]
-      }
-    )
-
-    _ = try project.openDocument("test.swift")
-    let report = try await project.testClient.send(
-      DocumentDiagnosticsRequest(textDocument: TextDocumentIdentifier(project.uri(for: "test.swift")))
-    )
-    guard case .full(let fullReport) = report else {
-      XCTFail("Expected full diagnostics report")
-      return
-    }
-    XCTAssertEqual(fullReport.items.count, 1)
-    let diag = try XCTUnwrap(fullReport.items.first)
-    XCTAssertEqual(diag.message, "Cannot convert value of type 'String' to specified type 'Int'")
-  }
-
   func testIntegrationTest() async throws {
     // This test is doing the same as `test-sourcekit-lsp` in the `swift-integration-tests` repo.