Merge pull request #1818 from ahoppen/split-sksupport

Split `SKSupport` into multiple modules

Author: ahoppen

Contributor Documentation/Modules.md

@@ -37,6 +37,10 @@ This should be the dedicated entry point for clients that want to run SourceKit-
 
 Swift types to represent the [Language Server Protocol (LSP) specification, version 3.17](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/). These types should also be usable when implementing an LSP client and thus this module should not have any dependencies.
 
+### LanguageServerProtocolExtensions
+
+Extensions on top of `LanguageServerProtocol` and `LanguageServerProtocolJSONRPC` that might require other modules defined in sourcekit-lsp.
+
 ### LanguageServerProtocolJSONRPC
 
 A connection to or from a SourceKit-LSP server. Since message parsing can fail, it needs to handle errors in some way and the design decision here is to use SKLogging, which hardcodes `org.swift.sourcekit-lsp` as the default logging subsystem and thus makes the module unsuitable for generic clients.
@@ -49,16 +53,13 @@ Contains the interface with which SourceKit-LSP queries the semantic index, addi
 
 Types that are API-compatible with OSLog that allow logging to OSLog when building for Apple platforms and logging to stderr or files on non-Apple platforms. This should not be dependent on any LSP specific types and be portable to other packages.
 
-### SKOptions
+### SKUtilities
 
-Configuration options to change how SourceKit-LSP behaves, based on [Configuration files](../Documentation/Configuration%20File.md).
+Types that should be sharable by the different modules that implement SourceKit-LSP but that are not generic enough to fit into `SwiftExtensions` or that need to depend on `SKLogging` and thus can’t live in `SwiftExtensions`.
 
-### SKSupport
+### SKOptions
 
-Contains SourceKit-LSP-specific helper functions. These fall into three different categories:
--  Extensions on top of `swift-tools-support-core`
-- Functionality that can only be implemented by combining two lower-level modules that don't have a shared dependency, like `SKLogging` + `LanguageServerProtocol`
-- Types that should be sharable by the different modules that implement SourceKit-LSP but that are not generic enough to fit into `SwiftExtensions`, like `ExperimentalFeatures`.
+Configuration options to change how SourceKit-LSP behaves, based on [Configuration files](../Documentation/Configuration%20File.md).
 
 ### SKTestSupport
 
@@ -83,3 +84,7 @@ Extensions to the Swift standard library and Foundation. Should not have any oth
 #### ToolchainRegistry
 
 Discovers Swift toolchains on the system.
+
+### TSCExtensions
+
+Extensions on top of `swift-tools-support-core` that might integrate with modules from sourcekit-lsp.

Package.swift

@@ -30,9 +30,9 @@ var targets: [Target] = [
       "BuildSystemIntegration",
       "Diagnose",
       "LanguageServerProtocol",
+      "LanguageServerProtocolExtensions",
       "LanguageServerProtocolJSONRPC",
       "SKOptions",
-      "SKSupport",
       "SourceKitLSP",
       "ToolchainRegistry",
       .product(name: "ArgumentParser", package: "swift-argument-parser"),
@@ -71,13 +71,15 @@ var targets: [Target] = [
     dependencies: [
       "BuildServerProtocol",
       "LanguageServerProtocol",
+      "LanguageServerProtocolExtensions",
       "LanguageServerProtocolJSONRPC",
       "SKLogging",
       "SKOptions",
-      "SKSupport",
+      "SKUtilities",
       "SourceKitD",
       "SwiftExtensions",
       "ToolchainRegistry",
+      "TSCExtensions",
       .product(name: "SwiftPM-auto", package: "swift-package-manager"),
       .product(name: "SwiftPMDataModel-auto", package: "swift-package-manager"),
       .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
@@ -128,13 +130,15 @@ var targets: [Target] = [
     dependencies: [
       "BuildSystemIntegration",
       "InProcessClient",
+      "LanguageServerProtocolExtensions",
       "SKLogging",
       "SKOptions",
-      "SKSupport",
+      "SKUtilities",
       "SourceKitD",
       "SourceKitLSP",
       "SwiftExtensions",
       "ToolchainRegistry",
+      "TSCExtensions",
       .product(name: "ArgumentParser", package: "swift-argument-parser"),
       .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
     ] + swiftSyntaxDependencies(["SwiftIDEUtils", "SwiftSyntax", "SwiftParser"]),
@@ -167,6 +171,7 @@ var targets: [Target] = [
       "SKOptions",
       "SourceKitLSP",
       "ToolchainRegistry",
+      "TSCExtensions",
     ],
     exclude: ["CMakeLists.txt"],
     swiftSettings: globalSwiftSettings
@@ -190,6 +195,22 @@ var targets: [Target] = [
     swiftSettings: globalSwiftSettings
   ),
 
+  // MARK: LanguageServerProtocolExtensions
+
+  .target(
+    name: "LanguageServerProtocolExtensions",
+    dependencies: [
+      "LanguageServerProtocol",
+      "LanguageServerProtocolJSONRPC",
+      "SKLogging",
+      "SourceKitD",
+      "SwiftExtensions",
+      .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
+    ],
+    exclude: ["CMakeLists.txt"],
+    swiftSettings: globalSwiftSettings
+  ),
+
   // MARK: LanguageServerProtocolJSONRPC
 
   .target(
@@ -222,6 +243,7 @@ var targets: [Target] = [
       "SKLogging",
       "SwiftExtensions",
       "ToolchainRegistry",
+      "TSCExtensions",
       .product(name: "IndexStoreDB", package: "indexstore-db"),
     ],
     exclude: ["CMakeLists.txt"],
@@ -265,37 +287,31 @@ var targets: [Target] = [
     name: "SKOptions",
     dependencies: [
       "LanguageServerProtocol",
+      "LanguageServerProtocolExtensions",
       "SKLogging",
-      "SKSupport",
       .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
     ],
     exclude: ["CMakeLists.txt"],
     swiftSettings: globalSwiftSettings
   ),
 
-  // MARK: SKSupport
+  // MARK: SKUtilities
 
   .target(
-    name: "SKSupport",
+    name: "SKUtilities",
     dependencies: [
-      "LanguageServerProtocol",
-      "LanguageServerProtocolJSONRPC",
       "SKLogging",
-      "SourceKitD",
       "SwiftExtensions",
-      .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
     ],
     exclude: ["CMakeLists.txt"],
     swiftSettings: globalSwiftSettings
   ),
 
   .testTarget(
-    name: "SKSupportTests",
+    name: "SKUtilitiesTests",
     dependencies: [
-      "SKLogging",
-      "SKSupport",
+      "SKUtilities",
       "SKTestSupport",
-      "SwiftExtensions",
     ],
     swiftSettings: globalSwiftSettings
   ),
@@ -309,13 +325,15 @@ var targets: [Target] = [
       "CSKTestSupport",
       "InProcessClient",
       "LanguageServerProtocol",
+      "LanguageServerProtocolExtensions",
       "LanguageServerProtocolJSONRPC",
       "SKLogging",
       "SKOptions",
-      "SKSupport",
+      "SKUtilities",
       "SourceKitLSP",
       "SwiftExtensions",
       "ToolchainRegistry",
+      "TSCExtensions",
       .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
     ],
     resources: [.copy("INPUTS")],
@@ -356,14 +374,16 @@ var targets: [Target] = [
       "BuildServerProtocol",
       "BuildSystemIntegration",
       "LanguageServerProtocol",
+      "LanguageServerProtocolExtensions",
       "LanguageServerProtocolJSONRPC",
       "SemanticIndex",
       "SKLogging",
       "SKOptions",
-      "SKSupport",
+      "SKUtilities",
       "SourceKitD",
       "SwiftExtensions",
       "ToolchainRegistry",
+      "TSCExtensions",
       .product(name: "IndexStoreDB", package: "indexstore-db"),
       .product(name: "Crypto", package: "swift-crypto"),
       .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
@@ -383,11 +403,12 @@ var targets: [Target] = [
       "BuildServerProtocol",
       "BuildSystemIntegration",
       "LanguageServerProtocol",
+      "LanguageServerProtocolExtensions",
       "SemanticIndex",
       "SKLogging",
       "SKOptions",
-      "SKSupport",
       "SKTestSupport",
+      "SKUtilities",
       "SourceKitD",
       "SourceKitLSP",
       "ToolchainRegistry",
@@ -408,14 +429,26 @@ var targets: [Target] = [
     swiftSettings: globalSwiftSettings
   ),
 
+  .testTarget(
+    name: "SwiftExtensionsTests",
+    dependencies: [
+      "SKLogging",
+      "SKTestSupport",
+      "SwiftExtensions",
+    ],
+    swiftSettings: globalSwiftSettings
+  ),
+
   // MARK: ToolchainRegistry
 
   .target(
     name: "ToolchainRegistry",
     dependencies: [
+      "LanguageServerProtocolExtensions",
       "SKLogging",
-      "SKSupport",
+      "SKUtilities",
       "SwiftExtensions",
+      "TSCExtensions",
       .product(name: "SwiftPMDataModel-auto", package: "swift-package-manager"),
       .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
     ],
@@ -433,6 +466,30 @@ var targets: [Target] = [
     ],
     swiftSettings: globalSwiftSettings
   ),
+
+  // MARK: TSCExtensions
+
+  .target(
+    name: "TSCExtensions",
+    dependencies: [
+      "SKLogging",
+      "SwiftExtensions",
+      .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
+    ],
+    exclude: ["CMakeLists.txt"],
+    swiftSettings: globalSwiftSettings
+  ),
+
+  .testTarget(
+    name: "TSCExtensionsTests",
+    dependencies: [
+      "SKTestSupport",
+      "SwiftExtensions",
+      "TSCExtensions",
+    ],
+    exclude: ["CMakeLists.txt"],
+    swiftSettings: globalSwiftSettings
+  ),
 ]
 
 if buildOnlyTests {

Sources/BuildSystemIntegration/BuildSystemManager.swift

@@ -15,11 +15,13 @@ package import BuildServerProtocol
 import Dispatch
 import Foundation
 package import LanguageServerProtocol
+package import LanguageServerProtocolExtensions
 import SKLogging
 package import SKOptions
-package import SKSupport
+import SKUtilities
 package import SwiftExtensions
 package import ToolchainRegistry
+import TSCExtensions
 
 package import struct TSCBasic.AbsolutePath
 package import struct TSCBasic.RelativePath
@@ -28,11 +30,13 @@ import BuildServerProtocol
 import Dispatch
 import Foundation
 import LanguageServerProtocol
+import LanguageServerProtocolExtensions
 import SKLogging
 import SKOptions
-import SKSupport
+import SKUtilities
 import SwiftExtensions
 import ToolchainRegistry
+import TSCExtensions
 
 import struct TSCBasic.AbsolutePath
 import struct TSCBasic.RelativePath

Sources/BuildSystemIntegration/BuildSystemMessageDependencyTracker.swift

@@ -13,14 +13,14 @@
 #if compiler(>=6)
 import BuildServerProtocol
 package import LanguageServerProtocol
+import LanguageServerProtocolExtensions
 import SKLogging
-import SKSupport
 import SwiftExtensions
 #else
 import BuildServerProtocol
 import LanguageServerProtocol
+import LanguageServerProtocolExtensions
 import SKLogging
-import SKSupport
 import SwiftExtensions
 #endif
 

Sources/BuildSystemIntegration/BuiltInBuildSystemAdapter.swift

@@ -13,9 +13,9 @@
 import BuildServerProtocol
 import Foundation
 import LanguageServerProtocol
+import LanguageServerProtocolExtensions
 import SKLogging
 import SKOptions
-import SKSupport
 import SwiftExtensions
 import ToolchainRegistry
 

Sources/BuildSystemIntegration/CMakeLists.txt

@@ -29,11 +29,15 @@ target_link_libraries(BuildSystemIntegration PUBLIC
   LanguageServerProtocolJSONRPC
   SKLogging
   SKOptions
-  SKSupport
+  LanguageServerProtocolExtensions
   SourceKitD
   SwiftExtensions
   ToolchainRegistry
   PackageModel
   TSCBasic
   Build
   SourceKitLSPAPI)
+
+target_link_libraries(BuildSystemIntegration PRIVATE
+  SKUtilities
+  TSCExtensions)

Sources/BuildSystemIntegration/CompilationDatabase.swift

@@ -14,9 +14,10 @@
 package import BuildServerProtocol
 import Foundation
 package import LanguageServerProtocol
+import LanguageServerProtocolExtensions
 import SKLogging
-import SKSupport
 import SwiftExtensions
+import TSCExtensions
 
 package import struct TSCBasic.AbsolutePath
 package import protocol TSCBasic.FileSystem
@@ -26,9 +27,10 @@ package import var TSCBasic.localFileSystem
 import BuildServerProtocol
 import Foundation
 import LanguageServerProtocol
+import LanguageServerProtocolExtensions
 import SKLogging
-import SKSupport
 import SwiftExtensions
+import TSCExtensions
 
 import struct TSCBasic.AbsolutePath
 import protocol TSCBasic.FileSystem

Sources/BuildSystemIntegration/CompilationDatabaseBuildSystem.swift

@@ -14,10 +14,11 @@
 package import BuildServerProtocol
 import Dispatch
 package import LanguageServerProtocol
+import LanguageServerProtocolExtensions
 import SKLogging
 package import SKOptions
-import SKSupport
 import ToolchainRegistry
+import TSCExtensions
 
 import struct Foundation.URL
 package import struct TSCBasic.AbsolutePath
@@ -28,10 +29,11 @@ package import var TSCBasic.localFileSystem
 import BuildServerProtocol
 import Dispatch
 import LanguageServerProtocol
+import LanguageServerProtocolExtensions
 import SKLogging
 import SKOptions
-import SKSupport
 import ToolchainRegistry
+import TSCExtensions
 
 import struct Foundation.URL
 import struct TSCBasic.AbsolutePath