Split SKUtilities from SKSupport

Author: ahoppen

Contributor Documentation/Modules.md

@@ -49,6 +49,10 @@ 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.
 
+### SKUtilities
+
+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`.
+
 ### SKOptions
 
 Configuration options to change how SourceKit-LSP behaves, based on [Configuration files](../Documentation/Configuration%20File.md).
@@ -57,7 +61,6 @@ Configuration options to change how SourceKit-LSP behaves, based on [Configurati
 
 Contains SourceKit-LSP-specific helper functions. These fall into two different categories:
 - 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`.
 
 ### SKTestSupport
 

Package.swift

@@ -75,6 +75,7 @@ var targets: [Target] = [
       "SKLogging",
       "SKOptions",
       "SKSupport",
+      "SKUtilities",
       "SourceKitD",
       "SwiftExtensions",
       "ToolchainRegistry",
@@ -132,6 +133,7 @@ var targets: [Target] = [
       "SKLogging",
       "SKOptions",
       "SKSupport",
+      "SKUtilities",
       "SourceKitD",
       "SourceKitLSP",
       "SwiftExtensions",
@@ -277,30 +279,43 @@ var targets: [Target] = [
     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",
+      // "SKLogging",
+      // "SKSupport",
       "SKTestSupport",
+      // "SwiftExtensions",
+    ],
+    swiftSettings: globalSwiftSettings
+  ),
+
+  // MARK: SKSupport
+
+  .target(
+    name: "SKSupport",
+    dependencies: [
+      "LanguageServerProtocol",
+      "LanguageServerProtocolJSONRPC",
+      "SKLogging",
+      "SourceKitD",
       "SwiftExtensions",
+      .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
     ],
+    exclude: ["CMakeLists.txt"],
     swiftSettings: globalSwiftSettings
   ),
 
@@ -317,6 +332,7 @@ var targets: [Target] = [
       "SKLogging",
       "SKOptions",
       "SKSupport",
+      "SKUtilities",
       "SourceKitLSP",
       "SwiftExtensions",
       "ToolchainRegistry",
@@ -366,6 +382,7 @@ var targets: [Target] = [
       "SKLogging",
       "SKOptions",
       "SKSupport",
+      "SKUtilities",
       "SourceKitD",
       "SwiftExtensions",
       "ToolchainRegistry",
@@ -394,6 +411,7 @@ var targets: [Target] = [
       "SKOptions",
       "SKSupport",
       "SKTestSupport",
+      "SKUtilities",
       "SourceKitD",
       "SourceKitLSP",
       "ToolchainRegistry",
@@ -414,13 +432,24 @@ var targets: [Target] = [
     swiftSettings: globalSwiftSettings
   ),
 
+  .testTarget(
+    name: "SwiftExtensionsTests",
+    dependencies: [
+      "SKLogging",
+      "SKTestSupport",
+      "SwiftExtensions",
+    ],
+    swiftSettings: globalSwiftSettings
+  ),
+
   // MARK: ToolchainRegistry
 
   .target(
     name: "ToolchainRegistry",
     dependencies: [
       "SKLogging",
       "SKSupport",
+      "SKUtilities",
       "SwiftExtensions",
       "TSCExtensions",
       .product(name: "SwiftPMDataModel-auto", package: "swift-package-manager"),

Sources/BuildSystemIntegration/BuildSystemManager.swift

@@ -18,6 +18,7 @@ package import LanguageServerProtocol
 import SKLogging
 package import SKOptions
 package import SKSupport
+import SKUtilities
 package import SwiftExtensions
 package import ToolchainRegistry
 import TSCExtensions
@@ -32,6 +33,7 @@ import LanguageServerProtocol
 import SKLogging
 import SKOptions
 import SKSupport
+import SKUtilities
 import SwiftExtensions
 import ToolchainRegistry
 import TSCExtensions

Sources/BuildSystemIntegration/CMakeLists.txt

@@ -38,5 +38,6 @@ target_link_libraries(BuildSystemIntegration PUBLIC
   Build
   SourceKitLSPAPI)
 
-target_link_libraries(BuildSystemIntegration PUBLIC
+target_link_libraries(BuildSystemIntegration PRIVATE
+  SKUtilities
   TSCExtensions)

Sources/Diagnose/CMakeLists.txt

@@ -40,5 +40,6 @@ target_link_libraries(Diagnose PUBLIC
 )
 
 target_link_libraries(Diagnose PRIVATE
+  SKUtilities
   TSCExtensions
 )

Sources/Diagnose/RunSourcekitdRequestCommand.swift

@@ -14,7 +14,7 @@
 package import ArgumentParser
 import Csourcekitd
 import Foundation
-import SKSupport
+import SKUtilities
 import SourceKitD
 import ToolchainRegistry
 
@@ -23,7 +23,7 @@ import struct TSCBasic.AbsolutePath
 import ArgumentParser
 import Csourcekitd
 import Foundation
-import SKSupport
+import SKUtilities
 import SourceKitD
 import ToolchainRegistry
 

Sources/SKOptions/SourceKitLSPOptions.swift

@@ -448,7 +448,8 @@ public struct SourceKitLSPOptions: Sendable, Codable, Equatable {
     if let generatedFilesPath {
       return URL(fileURLWithPath: generatedFilesPath)
     }
-    return defaultDirectoryForGeneratedFiles
+
+    return URL(fileURLWithPath: NSTemporaryDirectory()).appendingPathComponent("sourcekit-lsp")
   }
 
   public func hasExperimentalFeature(_ feature: ExperimentalFeature) -> Bool {

Sources/SKSupport/FileSystem.swift

@@ -17,6 +17,7 @@ package import LanguageServerProtocol
 import LanguageServerProtocolJSONRPC
 package import SKOptions
 import SKSupport
+import SKUtilities
 package import SourceKitLSP
 import SwiftExtensions
 import SwiftSyntax
@@ -29,6 +30,7 @@ import LanguageServerProtocol
 import LanguageServerProtocolJSONRPC
 import SKOptions
 import SKSupport
+import SKUtilities
 import SourceKitLSP
 import SwiftExtensions
 import SwiftSyntax

Sources/SKTestSupport/TestSourceKitLSPClient.swift

@@ -0,0 +1,14 @@
+
+add_library(SKUtilities STATIC
+  Debouncer.swift
+  Dictionary+InitWithElementsKeyedBy.swift
+  FileSystem.swift
+  LineTable.swift
+)
+set_target_properties(SKUtilities PROPERTIES
+  INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
+target_link_libraries(SKSupport PRIVATE
+  SKLogging
+  SwiftExtensions
+  TSCBasic
+  $<$<NOT:$<PLATFORM_ID:Darwin>>:Foundation>)