Rename SKCore to BuildSystemIntegration

Author: ahoppen

Documentation/Modules.md

@@ -8,6 +8,10 @@ Swift types to represent the [Build Server Protocol (BSP) specification, version
 
 FIXME: Add link for BSP and version
 
+### BuildSystemIntegration
+
+Defines the queries SourceKit-LSP can ask of a a build system, like getting compiler arguments for a file. Finding a target’s dependencies or preparing a target.
+
 ### CAtomics
 
 Implementation of atomics for Swift using C. Once we can raise our deployment target to use the `Atomic` type from the Swift standard library, this module should be removed.
@@ -42,31 +46,6 @@ A connection to or from a SourceKit-LSP server. Since message parsing can fail,
 
 Contains the interface with which SourceKit-LSP queries the semantic index, adding up-to-date checks on top of the indexstore-db API. Also implements the types that manage background indexing.
 
-### SKCore
-
-FIXME: Currently serves two independent purposes and should be split up into two modules
-
-#### BuildSystem
-
-Defines the queries SourceKit-LSP can ask of a a build system, like getting compiler arguments for a file. Finding a target’s dependencies or preparing a target.
-
-This includes:
-- BuildConfiguration.swift
-- BuildServerBuildSystem.swift
-- BuildSetup.swift
-- BuildSystem.swift
-- BuildSystemDelegate.swift
-- BuildSystemManager.swift
-- CompilationDatabase.swift
-- CompilationDatabaseBuildSystem.swift
-- FallbackBuildSystem.swift
-- FileBuildSettings.swift
-- IndexTaskID.swift
-- MainFilesProvider.swift
-- PathPrefixMapping.swift
-- SplitShellCommand.swift
-- WorkspaceType.swift
-
 ### SKLogging
 
 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.
@@ -86,7 +65,7 @@ Contains SourceKit-LSP-specific helper functions. These fall into three differen
 
 Implements the `BuildSystem` protocol for Swift packages.
 
-FIXME: Merge this into the BuildSystem module once SKCore is split.
+FIXME: Merge this into the BuildSystem module once BuildSystemIntegration is split.
 
 ### SKTestSupport
 

Package.swift

@@ -24,10 +24,10 @@ let package = Package(
     .executableTarget(
       name: "sourcekit-lsp",
       dependencies: [
+        "BuildSystemIntegration",
         "Diagnose",
         "LanguageServerProtocol",
         "LanguageServerProtocolJSONRPC",
-        "SKCore",
         "SKOptions",
         "SKSupport",
         "SourceKitLSP",
@@ -49,6 +49,36 @@ let package = Package(
       exclude: ["CMakeLists.txt"]
     ),
 
+    // MARK: BuildSystemIntegration
+
+    .target(
+      name: "BuildSystemIntegration",
+      dependencies: [
+        "BuildServerProtocol",
+        "LanguageServerProtocol",
+        "LanguageServerProtocolJSONRPC",
+        "SKLogging",
+        "SKOptions",
+        "SKSupport",
+        "SourceKitD",
+        "SwiftExtensions",
+        "ToolchainRegistry",
+        .product(name: "SwiftPMDataModel-auto", package: "swift-package-manager"),
+        .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
+      ],
+      exclude: ["CMakeLists.txt"]
+    ),
+
+    .testTarget(
+      name: "BuildSystemIntegrationTests",
+      dependencies: [
+        "BuildSystemIntegration",
+        "SKOptions",
+        "SKTestSupport",
+        "ToolchainRegistry",
+      ]
+    ),
+
     // MARK: CAtomics
 
     .target(
@@ -76,8 +106,8 @@ let package = Package(
     .target(
       name: "Diagnose",
       dependencies: [
+        "BuildSystemIntegration",
         "InProcessClient",
-        "SKCore",
         "SKLogging",
         "SKOptions",
         "SKSupport",
@@ -97,8 +127,8 @@ let package = Package(
     .testTarget(
       name: "DiagnoseTests",
       dependencies: [
+        "BuildSystemIntegration",
         "Diagnose",
-        "SKCore",
         "SKLogging",
         "SKTestSupport",
         "SourceKitD",
@@ -112,8 +142,8 @@ let package = Package(
     .target(
       name: "InProcessClient",
       dependencies: [
+        "BuildSystemIntegration",
         "LanguageServerProtocol",
-        "SKCore",
         "SKLogging",
         "SKOptions",
         "SourceKitLSP",
@@ -162,8 +192,8 @@ let package = Package(
     .target(
       name: "SemanticIndex",
       dependencies: [
+        "BuildSystemIntegration",
         "LanguageServerProtocol",
-        "SKCore",
         "SKLogging",
         "SwiftExtensions",
         "ToolchainRegistry",
@@ -181,36 +211,6 @@ let package = Package(
       ]
     ),
 
-    // MARK: SKCore
-
-    .target(
-      name: "SKCore",
-      dependencies: [
-        "BuildServerProtocol",
-        "LanguageServerProtocol",
-        "LanguageServerProtocolJSONRPC",
-        "SKLogging",
-        "SKOptions",
-        "SKSupport",
-        "SourceKitD",
-        "SwiftExtensions",
-        "ToolchainRegistry",
-        .product(name: "SwiftPMDataModel-auto", package: "swift-package-manager"),
-        .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
-      ],
-      exclude: ["CMakeLists.txt"]
-    ),
-
-    .testTarget(
-      name: "SKCoreTests",
-      dependencies: [
-        "SKCore",
-        "SKOptions",
-        "SKTestSupport",
-        "ToolchainRegistry",
-      ]
-    ),
-
     // MARK: SKLogging
 
     .target(
@@ -273,8 +273,8 @@ let package = Package(
       name: "SKSwiftPMWorkspace",
       dependencies: [
         "BuildServerProtocol",
+        "BuildSystemIntegration",
         "LanguageServerProtocol",
-        "SKCore",
         "SKLogging",
         "SKOptions",
         "SwiftExtensions",
@@ -288,8 +288,8 @@ let package = Package(
     .testTarget(
       name: "SKSwiftPMWorkspaceTests",
       dependencies: [
+        "BuildSystemIntegration",
         "LanguageServerProtocol",
-        "SKCore",
         "SKOptions",
         "SKSwiftPMWorkspace",
         "SKTestSupport",
@@ -305,11 +305,11 @@ let package = Package(
     .target(
       name: "SKTestSupport",
       dependencies: [
+        "BuildSystemIntegration",
         "CSKTestSupport",
         "InProcessClient",
         "LanguageServerProtocol",
         "LanguageServerProtocolJSONRPC",
-        "SKCore",
         "SKLogging",
         "SKOptions",
         "SKSupport",
@@ -338,8 +338,8 @@ let package = Package(
     .testTarget(
       name: "SourceKitDTests",
       dependencies: [
+        "BuildSystemIntegration",
         "SourceKitD",
-        "SKCore",
         "SKTestSupport",
         "SwiftExtensions",
         "ToolchainRegistry",
@@ -352,10 +352,10 @@ let package = Package(
       name: "SourceKitLSP",
       dependencies: [
         "BuildServerProtocol",
+        "BuildSystemIntegration",
         "LanguageServerProtocol",
         "LanguageServerProtocolJSONRPC",
         "SemanticIndex",
-        "SKCore",
         "SKLogging",
         "SKOptions",
         "SKSupport",
@@ -382,9 +382,9 @@ let package = Package(
       name: "SourceKitLSPTests",
       dependencies: [
         "BuildServerProtocol",
+        "BuildSystemIntegration",
         "LanguageServerProtocol",
         "SemanticIndex",
-        "SKCore",
         "SKLogging",
         "SKOptions",
         "SKSupport",

Sources/SKCore/BuildServerBuildSystem.swift renamed to Sources/BuildSystemIntegration/BuildServerBuildSystem.swift

@@ -1,5 +1,5 @@
 
-add_library(SKCore STATIC
+add_library(BuildSystemIntegration STATIC
   BuildServerBuildSystem.swift
   BuildSystem.swift
   BuildSystemDelegate.swift
@@ -12,9 +12,9 @@ add_library(SKCore STATIC
   MainFilesProvider.swift
   PathPrefixMapping.swift
   SplitShellCommand.swift)
-set_target_properties(SKCore PROPERTIES
+set_target_properties(BuildSystemIntegration PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
-target_link_libraries(SKCore PUBLIC
+target_link_libraries(BuildSystemIntegration PUBLIC
   BuildServerProtocol
   LanguageServerProtocol
   LanguageServerProtocolJSONRPC

Sources/SKCore/BuildSystem.swift renamed to Sources/BuildSystemIntegration/BuildSystem.swift

@@ -1,13 +1,13 @@
 add_compile_options("$<$<COMPILE_LANGUAGE:Swift>:SHELL:-package-name SourceKitLSP>")
 add_subdirectory(BuildServerProtocol)
+add_subdirectory(BuildSystemIntegration)
 add_subdirectory(CAtomics)
 add_subdirectory(Csourcekitd)
 add_subdirectory(Diagnose)
 add_subdirectory(InProcessClient)
 add_subdirectory(LanguageServerProtocol)
 add_subdirectory(LanguageServerProtocolJSONRPC)
 add_subdirectory(SemanticIndex)
-add_subdirectory(SKCore)
 add_subdirectory(SKLogging)
 add_subdirectory(SKOptions)
 add_subdirectory(SKSupport)

Sources/SKCore/BuildSystemDelegate.swift renamed to Sources/BuildSystemIntegration/BuildSystemDelegate.swift

@@ -25,8 +25,8 @@ set_target_properties(Diagnose PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
 
 target_link_libraries(Diagnose PUBLIC
+  BuildSystemIntegration
   InProcessClient
-  SKCore
   SKLogging
   SKOptions
   SourceKitD

Sources/SKCore/BuildSystemManager.swift renamed to Sources/BuildSystemIntegration/BuildSystemManager.swift

@@ -10,8 +10,8 @@
 //
 //===----------------------------------------------------------------------===//
 
+import BuildSystemIntegration
 import Foundation
-import SKCore
 
 struct SwiftFrontendCrashScraper {
   /// Information we care about in a `.ips` crash report.

Sources/SKCore/CMakeLists.txt renamed to Sources/BuildSystemIntegration/CMakeLists.txt

@@ -6,8 +6,8 @@ set_target_properties(InProcessClient PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
 
 target_link_libraries(InProcessClient PUBLIC
+  BuildSystemIntegration
   LanguageServerProtocol
-  SKCore
   SKLogging
   SKOptions
   SourceKitLSP

Sources/SKCore/CompilationDatabase.swift renamed to Sources/BuildSystemIntegration/CompilationDatabase.swift

@@ -10,8 +10,8 @@
 //
 //===----------------------------------------------------------------------===//
 
+import BuildSystemIntegration
 import LanguageServerProtocol
-import SKCore
 import SKOptions
 import SKSupport
 import SourceKitLSP

Sources/SKCore/CompilationDatabaseBuildSystem.swift renamed to Sources/BuildSystemIntegration/CompilationDatabaseBuildSystem.swift

@@ -5,8 +5,8 @@ set_target_properties(SKSwiftPMWorkspace PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
 target_link_libraries(SKSwiftPMWorkspace PRIVATE
   BuildServerProtocol
+  BuildSystemIntegration
   LanguageServerProtocol
-  SKCore
   SKLogging
   SKOptions
   SwiftExtensions

Sources/SKCore/FallbackBuildSystem.swift renamed to Sources/BuildSystemIntegration/FallbackBuildSystem.swift

@@ -13,13 +13,13 @@
 import Basics
 import Build
 import BuildServerProtocol
+import BuildSystemIntegration
 import Dispatch
 import Foundation
 import LanguageServerProtocol
 import PackageGraph
 import PackageLoading
 import PackageModel
-import SKCore
 import SKLogging
 import SKOptions
 import SKSupport
@@ -122,9 +122,9 @@ package actor SwiftPMBuildSystem {
   }
 
   /// Delegate to handle any build system events.
-  package weak var delegate: SKCore.BuildSystemDelegate? = nil
+  package weak var delegate: BuildSystemIntegration.BuildSystemDelegate? = nil
 
-  package func setDelegate(_ delegate: SKCore.BuildSystemDelegate?) async {
+  package func setDelegate(_ delegate: BuildSystemIntegration.BuildSystemDelegate?) async {
     self.delegate = delegate
   }
 
@@ -440,7 +440,7 @@ fileprivate struct NonFileURIError: Error, CustomStringConvertible {
   }
 }
 
-extension SwiftPMBuildSystem: SKCore.BuildSystem {
+extension SwiftPMBuildSystem: BuildSystemIntegration.BuildSystem {
   package nonisolated var supportsPreparation: Bool { true }
 
   package var buildPath: TSCAbsolutePath {

Sources/SKCore/FileBuildSettings.swift renamed to Sources/BuildSystemIntegration/FileBuildSettings.swift

@@ -10,9 +10,9 @@
 //
 //===----------------------------------------------------------------------===//
 
+@_spi(Testing) import BuildSystemIntegration
 import Foundation
 import LanguageServerProtocol
-@_spi(Testing) import SKCore
 import SKOptions
 import SourceKitLSP
 import TSCBasic

Sources/SKCore/IndexTaskID.swift renamed to Sources/BuildSystemIntegration/IndexTaskID.swift

@@ -13,8 +13,8 @@ add_library(SemanticIndex STATIC
 set_target_properties(SemanticIndex PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
 target_link_libraries(SemanticIndex PRIVATE
+  BuildSystemIntegration
   LanguageServerProtocol
-  SKCore
   SKLogging
   SwiftExtensions
   ToolchainRegistry

Sources/SKCore/MainFilesProvider.swift renamed to Sources/BuildSystemIntegration/MainFilesProvider.swift

@@ -10,9 +10,9 @@
 //
 //===----------------------------------------------------------------------===//
 
+import BuildSystemIntegration
 import Foundation
 import LanguageServerProtocol
-import SKCore
 import SKLogging
 import SKSupport