Move DocumentationLanguageService to a separate module

Author: ahoppen

Package.swift

@@ -237,7 +237,21 @@ var targets: [Target] = [
     swiftSettings: globalSwiftSettings
   ),
 
-  // MARK: DocCDocumentation
+  // MARK: DocumentationLanguageService
+
+  .target(
+    name: "DocumentationLanguageService",
+    dependencies: [
+      "BuildServerIntegration",
+      "DocCDocumentation",
+      "LanguageServerProtocol",
+      "SKUtilities",
+      "SemanticIndex",
+      .product(name: "Markdown", package: "swift-markdown"),
+    ],
+    exclude: [],
+    swiftSettings: globalSwiftSettings
+  ),
 
   .target(
     name: "DocCDocumentation",
@@ -263,6 +277,7 @@ var targets: [Target] = [
     dependencies: [
       "BuildServerIntegration",
       "ClangLanguageService",
+      "DocumentationLanguageService",
       "LanguageServerProtocol",
       "SKLogging",
       "SKOptions",

Sources/SourceKitLSP/Documentation/DoccDocumentationHandler.swift renamed to Sources/DocumentationLanguageService/DoccDocumentationHandler.swift

@@ -18,6 +18,7 @@ import Foundation
 package import LanguageServerProtocol
 import Markdown
 import SKUtilities
+import SourceKitLSP
 import SemanticIndex
 
 extension DocumentationLanguageService {
@@ -63,9 +64,13 @@ extension DocumentationLanguageService {
             ofDocCSymbolLink: symbolLink,
             fetchSymbolGraph: { location in
               guard let symbolWorkspace = try await workspaceForDocument(uri: location.documentUri),
-                let languageService = try await languageService(for: location.documentUri, .swift, in: symbolWorkspace)
+                let languageService = await sourceKitLSPServer.languageService(
+                  for: location.documentUri,
+                  .swift,
+                  in: symbolWorkspace
+                )
               else {
-                throw ResponseError.internalError("Unable to find Swift language service for \(location.documentUri)")
+                throw ResponseError.internalError("Unable to find language service for \(location.documentUri)")
               }
               return try await languageService.symbolGraph(forOnDiskContentsOf: location.documentUri, at: location)
             }
@@ -76,9 +81,13 @@ extension DocumentationLanguageService {
         let symbolDocumentUri = symbolOccurrence.location.documentUri
         guard
           let symbolWorkspace = try await workspaceForDocument(uri: symbolDocumentUri),
-          let languageService = try await languageService(for: symbolDocumentUri, .swift, in: symbolWorkspace)
+          let languageService = await sourceKitLSPServer.languageService(
+            for: symbolDocumentUri,
+            .swift,
+            in: symbolWorkspace
+          )
         else {
-          throw ResponseError.internalError("Unable to find Swift language service for \(symbolDocumentUri)")
+          throw ResponseError.internalError("Unable to find language service for \(symbolDocumentUri)")
         }
         let symbolGraph = try await languageService.symbolGraph(
           forOnDiskContentsOf: symbolDocumentUri,

Sources/SourceKitLSP/Documentation/DocumentationLanguageService.swift renamed to Sources/DocumentationLanguageService/DocumentationLanguageService.swift

@@ -14,6 +14,7 @@ import Foundation
 package import IndexStoreDB
 package import LanguageServerProtocol
 package import SKOptions
+package import SourceKitLSP
 import SwiftExtensions
 package import SwiftSyntax
 package import ToolchainRegistry
@@ -52,7 +53,7 @@ package actor DocumentationLanguageService: LanguageService, Sendable {
 
   func languageService(
     for uri: DocumentURI,
-    _ language: Language,
+    _ language: LanguageServerProtocol.Language,
     in workspace: Workspace
   ) async throws -> LanguageService? {
     guard let sourceKitLSPServer else {

Sources/InProcessClient/LanguageServiceRegistry+staticallyKnownServices.swift

@@ -15,13 +15,19 @@ import LanguageServerProtocol
 package import SourceKitLSP
 import SwiftLanguageService
 
+#if canImport(DocumentationLanguageService)
+import DocumentationLanguageService
+#endif
+
 extension LanguageServiceRegistry {
   /// All types conforming to `LanguageService` that are known at compile time.
   package static let staticallyKnownServices = {
     var registry = LanguageServiceRegistry()
     registry.register(ClangLanguageService.self, for: [.c, .cpp, .objective_c, .objective_cpp])
     registry.register(SwiftLanguageService.self, for: [.swift])
+    #if canImport(DocumentationLanguageService)
     registry.register(DocumentationLanguageService.self, for: [.markdown, .tutorial])
+    #endif
     return registry
   }()
 }

Sources/SourceKitLSP/CMakeLists.txt

@@ -26,10 +26,6 @@ add_library(SourceKitLSP STATIC
   TextEdit+IsNoop.swift
   Workspace.swift
 )
-target_sources(SourceKitLSP PRIVATE
-  Documentation/DocCDocumentationHandler.swift
-  Documentation/DocumentationLanguageService.swift
-)
 set_target_properties(SourceKitLSP PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY}
 )