Rename LSPLogging to SKLogging

Author: ahoppen

Documentation/Modules.md

@@ -36,13 +36,7 @@ Swift types to represent the [Language Server Protocol (LSP) specification, vers
 
 ### 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 LSPLogging, which hardcodes `org.swift.sourcekit-lsp` as the default logging subsystem and thus makes the module unsuitable for generic clients.
-
-### LSPLogging
-
-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.
-
-FIXME: Rename the module to SKLogging
+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.
 
 ### LSPTestSupport
 
@@ -85,12 +79,15 @@ Discovers Swift toolchains on the system.
 - ToolchainRegistry.swift
 - XCToolchainPlist.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.
 
 ### SKSupport
 
 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 `LSPLogging` + `LanguageServerProtocol`
+- 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`.
 
 ### SKSwiftPMWorkspace

Package.swift

@@ -38,7 +38,6 @@ let package = Package(
     ),
 
     // MARK: BuildServerProtocol
-    // Connection between build server and language server to provide build and index info
 
     .target(
       name: "BuildServerProtocol",
@@ -49,19 +48,21 @@ let package = Package(
     ),
 
     // MARK: CAtomics
+
     .target(
       name: "CAtomics",
       dependencies: []
     ),
 
     // MARK: CSKTestSupport
+
     .target(
       name: "CSKTestSupport",
       dependencies: []
     ),
 
     // MARK: Csourcekitd
-    // C modules wrapper for sourcekitd.
+
     .target(
       name: "Csourcekitd",
       dependencies: [],
@@ -74,8 +75,8 @@ let package = Package(
       name: "Diagnose",
       dependencies: [
         "InProcessClient",
-        "LSPLogging",
         "SKCore",
+        "SKLogging",
         "SKSupport",
         "SourceKitD",
         "SourceKitLSP",
@@ -93,11 +94,11 @@ let package = Package(
       name: "DiagnoseTests",
       dependencies: [
         "Diagnose",
-        "LSPLogging",
         "LSPTestSupport",
-        "SourceKitD",
         "SKCore",
+        "SKLogging",
         "SKTestSupport",
+        "SourceKitD",
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ]
     ),
@@ -108,15 +109,15 @@ let package = Package(
       name: "InProcessClient",
       dependencies: [
         "LanguageServerProtocol",
-        "LSPLogging",
         "SKCore",
+        "SKLogging",
         "SourceKitLSP",
       ],
       exclude: ["CMakeLists.txt"]
     ),
 
     // MARK: LanguageServerProtocol
-    // The core LSP types, suitable for any LSP implementation.
+
     .target(
       name: "LanguageServerProtocol",
       dependencies: [],
@@ -132,13 +133,12 @@ let package = Package(
     ),
 
     // MARK: LanguageServerProtocolJSONRPC
-    // LSP connection using jsonrpc over pipes.
 
     .target(
       name: "LanguageServerProtocolJSONRPC",
       dependencies: [
         "LanguageServerProtocol",
-        "LSPLogging",
+        "SKLogging",
       ],
       exclude: ["CMakeLists.txt"]
     ),
@@ -151,27 +151,6 @@ let package = Package(
       ]
     ),
 
-    // MARK: LSPLogging
-    // Logging support used in LSP modules.
-
-    .target(
-      name: "LSPLogging",
-      dependencies: [
-        "SwiftExtensions",
-        .product(name: "Crypto", package: "swift-crypto"),
-      ],
-      exclude: ["CMakeLists.txt"],
-      swiftSettings: lspLoggingSwiftSettings
-    ),
-
-    .testTarget(
-      name: "LSPLoggingTests",
-      dependencies: [
-        "LSPLogging",
-        "SKTestSupport",
-      ]
-    ),
-
     // MARK: LSPTestSupport
 
     .target(
@@ -191,8 +170,8 @@ let package = Package(
       name: "SemanticIndex",
       dependencies: [
         "LanguageServerProtocol",
-        "LSPLogging",
         "SKCore",
+        "SKLogging",
         "SwiftExtensions",
         .product(name: "IndexStoreDB", package: "indexstore-db"),
       ],
@@ -202,23 +181,21 @@ let package = Package(
     .testTarget(
       name: "SemanticIndexTests",
       dependencies: [
-        "LSPLogging",
         "SemanticIndex",
+        "SKLogging",
         "SKTestSupport",
       ]
     ),
 
     // MARK: SKCore
-    // Data structures and algorithms useful across the project, but not necessarily
-    // suitable for use in other packages.
 
     .target(
       name: "SKCore",
       dependencies: [
         "BuildServerProtocol",
         "LanguageServerProtocol",
         "LanguageServerProtocolJSONRPC",
-        "LSPLogging",
+        "SKLogging",
         "SKSupport",
         "SourceKitD",
         "SwiftExtensions",
@@ -236,16 +213,34 @@ let package = Package(
       ]
     ),
 
+    // MARK: SKLogging
+
+    .target(
+      name: "SKLogging",
+      dependencies: [
+        "SwiftExtensions",
+        .product(name: "Crypto", package: "swift-crypto"),
+      ],
+      exclude: ["CMakeLists.txt"],
+      swiftSettings: lspLoggingSwiftSettings
+    ),
+
+    .testTarget(
+      name: "SKLoggingTests",
+      dependencies: [
+        "SKLogging",
+        "SKTestSupport",
+      ]
+    ),
+
     // MARK: SKSupport
-    // Data structures, algorithms and platform-abstraction code that might be generally useful to any Swift package.
-    // Similar in spirit to SwiftPM's Basic module.
 
     .target(
       name: "SKSupport",
       dependencies: [
         "CAtomics",
         "LanguageServerProtocol",
-        "LSPLogging",
+        "SKLogging",
         "SwiftExtensions",
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ],
@@ -269,8 +264,8 @@ let package = Package(
       dependencies: [
         "BuildServerProtocol",
         "LanguageServerProtocol",
-        "LSPLogging",
         "SKCore",
+        "SKLogging",
         "SwiftExtensions",
         .product(name: "SwiftPM-auto", package: "swift-package-manager"),
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
@@ -301,8 +296,8 @@ let package = Package(
         "InProcessClient",
         "LanguageServerProtocol",
         "LSPTestSupport",
-        "LSPLogging",
         "SKCore",
+        "SKLogging",
         "SourceKitLSP",
         "SwiftExtensions",
         .product(name: "ISDBTestSupport", package: "indexstore-db"),
@@ -312,13 +307,12 @@ let package = Package(
     ),
 
     // MARK: SourceKitD
-    // Swift bindings for sourcekitd.
 
     .target(
       name: "SourceKitD",
       dependencies: [
         "Csourcekitd",
-        "LSPLogging",
+        "SKLogging",
         "SwiftExtensions",
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ],
@@ -343,9 +337,9 @@ let package = Package(
         "BuildServerProtocol",
         "LanguageServerProtocol",
         "LanguageServerProtocolJSONRPC",
-        "LSPLogging",
         "SemanticIndex",
         "SKCore",
+        "SKLogging",
         "SKSupport",
         "SKSwiftPMWorkspace",
         "SourceKitD",
@@ -369,11 +363,11 @@ let package = Package(
       name: "SourceKitLSPTests",
       dependencies: [
         "BuildServerProtocol",
-        "LSPLogging",
-        "LSPTestSupport",
         "LanguageServerProtocol",
+        "LSPTestSupport",
         "SemanticIndex",
         "SKCore",
+        "SKLogging",
         "SKSupport",
         "SKTestSupport",
         "SourceKitD",

Sources/CMakeLists.txt

@@ -6,9 +6,9 @@ add_subdirectory(Diagnose)
 add_subdirectory(InProcessClient)
 add_subdirectory(LanguageServerProtocol)
 add_subdirectory(LanguageServerProtocolJSONRPC)
-add_subdirectory(LSPLogging)
 add_subdirectory(SemanticIndex)
 add_subdirectory(SKCore)
+add_subdirectory(SKLogging)
 add_subdirectory(SKSupport)
 add_subdirectory(SKSwiftPMWorkspace)
 add_subdirectory(SourceKitLSP)

Sources/Diagnose/CMakeLists.txt

@@ -26,8 +26,8 @@ set_target_properties(Diagnose PROPERTIES
 
 target_link_libraries(Diagnose PUBLIC
   InProcessClient
-  LSPLogging
   SKCore
+  SKLogging
   SourceKitD
   SwiftExtensions
   ArgumentParser

Sources/Diagnose/CommandLineArgumentsReducer.swift

@@ -11,7 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-import LSPLogging
+import SKLogging
 
 // MARK: - Entry point
 

Sources/Diagnose/MergeSwiftFiles.swift

@@ -11,7 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-import LSPLogging
+import SKLogging
 
 extension RequestInfo {
   /// Check if the issue reproduces when merging all `.swift` input files into a single file.

Sources/Diagnose/SourceReducer.swift

@@ -11,7 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-import LSPLogging
+import SKLogging
 import SourceKitD
 @_spi(FixItApplier) import SwiftIDEUtils
 import SwiftParser

Sources/InProcessClient/CMakeLists.txt

@@ -7,7 +7,7 @@ set_target_properties(InProcessClient PROPERTIES
 
 target_link_libraries(InProcessClient PUBLIC
   LanguageServerProtocol
-  LSPLogging
   SKCore
+  SKLogging
   SourceKitLSP
 )

Sources/InProcessClient/LocalConnection.swift

@@ -11,8 +11,8 @@
 //===----------------------------------------------------------------------===//
 
 import Dispatch
-import LSPLogging
 import LanguageServerProtocol
+import SKLogging
 
 /// A connection between two message handlers in the same process.
 ///

Sources/LanguageServerProtocolJSONRPC/CMakeLists.txt

@@ -8,7 +8,7 @@ set_target_properties(LanguageServerProtocolJSONRPC PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
 target_link_libraries(LanguageServerProtocolJSONRPC PRIVATE
   LanguageServerProtocol
-  LSPLogging)
+  SKLogging)
 target_link_libraries(LanguageServerProtocolJSONRPC PRIVATE
   $<$<NOT:$<PLATFORM_ID:Darwin>>:swiftDispatch>
   $<$<NOT:$<PLATFORM_ID:Darwin>>:Foundation>)