Split SourceKitLSPOptions out of SKCore

This only leaves build system functionality in SKCore, which allows us to rename SKCore.

Author: ahoppen

Documentation/Modules.md

@@ -71,6 +71,10 @@ This includes:
 
 Types that are API-compatible with OSLog to allow logging to OSLog when building for Darwin platforms and logging to stderr or files on non-Darwin platforms. This should not be dependent on any LSP specific types and be portable to other packages.
 
+### SKOptions
+
+Configuration options to change how SourceKit-LSP behaves, based on [Configuration files](Configuration%20File.md).
+
 ### SKSupport
 
 Contains SourceKit-LSP-specific helper functions. These fall into three different categories:

Package.swift

@@ -28,6 +28,7 @@ let package = Package(
         "LanguageServerProtocol",
         "LanguageServerProtocolJSONRPC",
         "SKCore",
+        "SKOptions",
         "SKSupport",
         "SourceKitLSP",
         "ToolchainRegistry",
@@ -78,6 +79,7 @@ let package = Package(
         "InProcessClient",
         "SKCore",
         "SKLogging",
+        "SKOptions",
         "SKSupport",
         "SourceKitD",
         "SourceKitLSP",
@@ -113,6 +115,7 @@ let package = Package(
         "LanguageServerProtocol",
         "SKCore",
         "SKLogging",
+        "SKOptions",
         "SourceKitLSP",
         "ToolchainRegistry",
       ],
@@ -187,6 +190,7 @@ let package = Package(
         "LanguageServerProtocol",
         "LanguageServerProtocolJSONRPC",
         "SKLogging",
+        "SKOptions",
         "SKSupport",
         "SourceKitD",
         "SwiftExtensions",
@@ -201,6 +205,7 @@ let package = Package(
       name: "SKCoreTests",
       dependencies: [
         "SKCore",
+        "SKOptions",
         "SKTestSupport",
         "ToolchainRegistry",
       ]
@@ -226,6 +231,19 @@ let package = Package(
       ]
     ),
 
+    // MARK: SKOptions
+
+    .target(
+      name: "SKOptions",
+      dependencies: [
+        "LanguageServerProtocol",
+        "SKLogging",
+        "SKSupport",
+        .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
+      ],
+      exclude: ["CMakeLists.txt"]
+    ),
+
     // MARK: SKSupport
 
     .target(
@@ -258,6 +276,7 @@ let package = Package(
         "LanguageServerProtocol",
         "SKCore",
         "SKLogging",
+        "SKOptions",
         "SwiftExtensions",
         "ToolchainRegistry",
         .product(name: "SwiftPM-auto", package: "swift-package-manager"),
@@ -271,6 +290,7 @@ let package = Package(
       dependencies: [
         "LanguageServerProtocol",
         "SKCore",
+        "SKOptions",
         "SKSwiftPMWorkspace",
         "SKTestSupport",
         "SourceKitLSP",
@@ -291,6 +311,7 @@ let package = Package(
         "LanguageServerProtocolJSONRPC",
         "SKCore",
         "SKLogging",
+        "SKOptions",
         "SKSupport",
         "SourceKitLSP",
         "SwiftExtensions",
@@ -336,6 +357,7 @@ let package = Package(
         "SemanticIndex",
         "SKCore",
         "SKLogging",
+        "SKOptions",
         "SKSupport",
         "SKSwiftPMWorkspace",
         "SourceKitD",
@@ -364,6 +386,7 @@ let package = Package(
         "SemanticIndex",
         "SKCore",
         "SKLogging",
+        "SKOptions",
         "SKSupport",
         "SKTestSupport",
         "SourceKitD",

Sources/CMakeLists.txt

@@ -9,6 +9,7 @@ add_subdirectory(LanguageServerProtocolJSONRPC)
 add_subdirectory(SemanticIndex)
 add_subdirectory(SKCore)
 add_subdirectory(SKLogging)
+add_subdirectory(SKOptions)
 add_subdirectory(SKSupport)
 add_subdirectory(SKSwiftPMWorkspace)
 add_subdirectory(SourceKitLSP)

Sources/Diagnose/CMakeLists.txt

@@ -28,6 +28,7 @@ target_link_libraries(Diagnose PUBLIC
   InProcessClient
   SKCore
   SKLogging
+  SKOptions
   SourceKitD
   SwiftExtensions
   ToolchainRegistry

Sources/Diagnose/IndexCommand.swift

@@ -14,7 +14,7 @@ import ArgumentParser
 import Foundation
 import InProcessClient
 import LanguageServerProtocol
-import SKCore
+import SKOptions
 import SKSupport
 import SourceKitLSP
 import SwiftExtensions

Sources/InProcessClient/CMakeLists.txt

@@ -9,6 +9,7 @@ target_link_libraries(InProcessClient PUBLIC
   LanguageServerProtocol
   SKCore
   SKLogging
+  SKOptions
   SourceKitLSP
   ToolchainRegistry
 )

Sources/InProcessClient/InProcessSourceKitLSPClient.swift

@@ -12,6 +12,7 @@
 
 import LanguageServerProtocol
 import SKCore
+import SKOptions
 import SKSupport
 import SourceKitLSP
 import ToolchainRegistry

Sources/SKCore/CMakeLists.txt

@@ -1,6 +1,5 @@
 
 add_library(SKCore STATIC
-  BuildConfiguration.swift
   BuildServerBuildSystem.swift
   BuildSystem.swift
   BuildSystemDelegate.swift
@@ -12,16 +11,15 @@ add_library(SKCore STATIC
   IndexTaskID.swift
   MainFilesProvider.swift
   PathPrefixMapping.swift
-  SourceKitLSPOptions.swift
-  SplitShellCommand.swift
-  WorkspaceType.swift)
+  SplitShellCommand.swift)
 set_target_properties(SKCore PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
 target_link_libraries(SKCore PUBLIC
   BuildServerProtocol
   LanguageServerProtocol
   LanguageServerProtocolJSONRPC
   SKLogging
+  SKOptions
   SKSupport
   SourceKitD
   SwiftExtensions

Sources/SKCore/FallbackBuildSystem.swift

@@ -14,6 +14,7 @@ import BuildServerProtocol
 import Dispatch
 import Foundation
 import LanguageServerProtocol
+import SKOptions
 import SKSupport
 
 import enum PackageLoading.Platform

Sources/SKCore/BuildConfiguration.swift renamed to Sources/SKOptions/BuildConfiguration.swift

@@ -0,0 +1,12 @@
+
+add_library(SKOptions STATIC
+  BuildConfiguration.swift
+  SourceKitLSPOptions.swift
+  WorkspaceType.swift)
+set_target_properties(SKOptions PROPERTIES
+  INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
+target_link_libraries(SKOptions PUBLIC
+  LanguageServerProtocol
+  SKLogging
+  SKSupport
+  TSCBasic)

Sources/SKOptions/CMakeLists.txt

@@ -309,7 +309,7 @@ public struct SourceKitLSPOptions: Sendable, Codable {
   }
 
   public init?(path: URL?) {
-    guard let path, let contents = try? String(contentsOf: path, encoding: .utf8) else {
+    guard let path, let contents = try? Data(contentsOf: path) else {
       return nil
     }
     guard

Sources/SKCore/SourceKitLSPOptions.swift renamed to Sources/SKOptions/SourceKitLSPOptions.swift

@@ -8,6 +8,7 @@ target_link_libraries(SKSwiftPMWorkspace PRIVATE
   LanguageServerProtocol
   SKCore
   SKLogging
+  SKOptions
   SwiftExtensions
   ToolchainRegistry
   TSCBasic)

Sources/SKCore/WorkspaceType.swift renamed to Sources/SKOptions/WorkspaceType.swift

@@ -21,6 +21,7 @@ import PackageLoading
 import PackageModel
 import SKCore
 import SKLogging
+import SKOptions
 import SKSupport
 import SourceControl
 import SourceKitLSPAPI

Sources/SKSwiftPMWorkspace/CMakeLists.txt

@@ -13,6 +13,7 @@
 import Foundation
 import LanguageServerProtocol
 @_spi(Testing) import SKCore
+import SKOptions
 import SourceKitLSP
 import TSCBasic
 import ToolchainRegistry

Sources/SKSwiftPMWorkspace/SwiftPMBuildSystem.swift

@@ -12,7 +12,7 @@
 
 import Foundation
 import LanguageServerProtocol
-import SKCore
+import SKOptions
 import SourceKitLSP
 
 /// The location of a test file within test workspace.

Sources/SKTestSupport/IndexedSingleSwiftFileTestProject.swift

@@ -13,9 +13,7 @@
 import Foundation
 import LanguageServerProtocol
 import RegexBuilder
-@_spi(Testing) import SKCore
 import SKLogging
-import SKTestSupport
 import SourceKitLSP
 import ToolchainRegistry
 import XCTest

Sources/SKTestSupport/MultiFileTestProject.swift

@@ -12,7 +12,7 @@
 
 import Foundation
 import LanguageServerProtocol
-@_spi(Testing) import SKCore
+import SKOptions
 import SourceKitLSP
 import TSCBasic
 import ToolchainRegistry

Sources/SKTestSupport/SkipUnless.swift

@@ -14,9 +14,8 @@ import Foundation
 import InProcessClient
 import LanguageServerProtocol
 import LanguageServerProtocolJSONRPC
-@_spi(Testing) import SKCore
+import SKOptions
 import SKSupport
-import SKTestSupport
 import SourceKitLSP
 import SwiftExtensions
 import SwiftSyntax

Sources/SKTestSupport/SwiftPMTestProject.swift

@@ -12,7 +12,6 @@
 
 import Foundation
 import LanguageServerProtocol
-import SKCore
 import TSCBasic
 
 extension Language {

Sources/SKTestSupport/TestSourceKitLSPClient.swift

@@ -10,8 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-import SKCore
-
 /// Protocol of tasks that are executed on the index task scheduler.
 ///
 /// It is assumed that `IndexTaskDescription` of different types are allowed to execute in parallel.

Sources/SKTestSupport/Utils.swift

@@ -80,6 +80,7 @@ target_link_libraries(SourceKitLSP PUBLIC
   SemanticIndex
   SKCore
   SKLogging
+  SKOptions
   SKSupport
   SKSwiftPMWorkspace
   SourceKitD

Sources/SemanticIndex/IndexTaskDescription.swift

@@ -14,6 +14,7 @@ import LanguageServerProtocol
 import LanguageServerProtocolJSONRPC
 import SKCore
 import SKLogging
+import SKOptions
 import SKSupport
 import SwiftExtensions
 import SwiftSyntax

Sources/SourceKitLSP/CMakeLists.txt

@@ -13,6 +13,7 @@
 import LanguageServerProtocol
 import SKCore
 import SKLogging
+import SKOptions
 import SKSwiftPMWorkspace
 import ToolchainRegistry
 

Sources/SourceKitLSP/Clang/ClangLanguageService.swift

@@ -11,7 +11,6 @@
 //===----------------------------------------------------------------------===//
 
 import LanguageServerProtocol
-import SKCore
 import SKLogging
 import SKSupport
 import SemanticIndex

Sources/SourceKitLSP/CreateBuildSystem.swift

@@ -13,6 +13,7 @@
 import Foundation
 import LanguageServerProtocol
 import SKCore
+import SKOptions
 import SwiftSyntax
 import ToolchainRegistry
 

Sources/SourceKitLSP/IndexProgressManager.swift

@@ -12,7 +12,6 @@
 
 import Dispatch
 import IndexStoreDB
-import SKCore
 import SKLogging
 import SKSupport
 import SwiftExtensions

Sources/SourceKitLSP/LanguageService.swift

@@ -18,6 +18,7 @@ import LanguageServerProtocol
 import PackageLoading
 import SKCore
 import SKLogging
+import SKOptions
 import SKSupport
 import SKSwiftPMWorkspace
 import SemanticIndex

Sources/SourceKitLSP/SourceKitIndexDelegate.swift

@@ -12,8 +12,8 @@
 
 import Dispatch
 import LanguageServerProtocol
-import SKCore
 import SKLogging
+import SKOptions
 import SKSupport
 import SourceKitD
 import SwiftExtensions

Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -11,8 +11,8 @@
 //===----------------------------------------------------------------------===//
 
 import LanguageServerProtocol
-import SKCore
 import SKLogging
+import SKOptions
 import SKSupport
 import SourceKitD
 import SwiftExtensions

Sources/SourceKitLSP/Swift/CodeCompletionSession.swift

@@ -16,6 +16,7 @@ import IndexStoreDB
 import LanguageServerProtocol
 import SKCore
 import SKLogging
+import SKOptions
 import SKSupport
 import SemanticIndex
 import SourceKitD

Sources/SourceKitLSP/Swift/DiagnosticReportManager.swift

@@ -12,7 +12,6 @@
 
 import Foundation
 import LanguageServerProtocol
-import SKCore
 import SKSupport
 import SKSwiftPMWorkspace
 import SemanticIndex

Sources/SourceKitLSP/Swift/SwiftLanguageService.swift

@@ -14,6 +14,7 @@ import IndexStoreDB
 import LanguageServerProtocol
 import SKCore
 import SKLogging
+import SKOptions
 import SKSupport
 import SemanticIndex
 import SwiftExtensions

Sources/SourceKitLSP/TestHooks.swift

@@ -7,6 +7,7 @@ target_link_libraries(sourcekit-lsp PRIVATE
   LanguageServerProtocolJSONRPC
   SemanticIndex
   SKCore
+  SKOptions
   SKSupport
   SourceKitLSP
   ToolchainRegistry