Merge pull request #2249 from ahoppen/merge-docc

Merge `DocumentationLanguageService` and `DocCDocumentation` modules

Author: ahoppen

Package.swift

@@ -133,7 +133,6 @@ var targets: [Target] = [
     name: "ClangLanguageService",
     dependencies: [
       "BuildServerIntegration",
-      "DocCDocumentation",
       "LanguageServerProtocol",
       "LanguageServerProtocolExtensions",
       "LanguageServerProtocolJSONRPC",
@@ -243,27 +242,17 @@ var targets: [Target] = [
     name: "DocumentationLanguageService",
     dependencies: [
       "BuildServerIntegration",
-      "DocCDocumentation",
-      "LanguageServerProtocol",
-      "SKUtilities",
-      "SourceKitLSP",
-      "SemanticIndex",
-      .product(name: "Markdown", package: "swift-markdown"),
-    ],
-    exclude: [],
-    swiftSettings: globalSwiftSettings
-  ),
-
-  .target(
-    name: "DocCDocumentation",
-    dependencies: [
       "BuildServerProtocol",
-      "BuildServerIntegration",
       "LanguageServerProtocol",
+
+      "SemanticIndex",
       "SemanticIndex",
       "SKLogging",
+      "SKUtilities",
+      "SourceKitLSP",
       "SwiftExtensions",
       .product(name: "IndexStoreDB", package: "indexstore-db"),
+      .product(name: "Markdown", package: "swift-markdown"),
       .product(name: "SwiftDocC", package: "swift-docc"),
       .product(name: "SymbolKit", package: "swift-docc-symbolkit"),
     ],
@@ -538,7 +527,6 @@ var targets: [Target] = [
     dependencies: [
       "BuildServerProtocol",
       "BuildServerIntegration",
-      "DocCDocumentation",
       "LanguageServerProtocol",
       "LanguageServerProtocolExtensions",
       "LanguageServerProtocolJSONRPC",
@@ -614,7 +602,6 @@ var targets: [Target] = [
       "BuildServerProtocol",
       "BuildServerIntegration",
       "Csourcekitd",
-      "DocCDocumentation",
       "LanguageServerProtocol",
       "LanguageServerProtocolExtensions",
       "LanguageServerProtocolJSONRPC",

Sources/DocCDocumentation/BuildSystemIntegrationExtensions.swift renamed to Sources/DocumentationLanguageService/BuildSystemIntegrationExtensions.swift

@@ -10,13 +10,13 @@
 //
 //===----------------------------------------------------------------------===//
 
-package import BuildServerIntegration
-package import BuildServerProtocol
-package import Foundation
+import BuildServerIntegration
+import BuildServerProtocol
+import Foundation
 import LanguageServerProtocol
 import SKLogging
 
-package extension BuildServerManager {
+extension BuildServerManager {
   /// Retrieves the name of the Swift module for a given target.
   ///
   /// **Note:** prefer using ``module(for:in:)`` over ths function. This function

Sources/DocCDocumentation/DocCCatalogIndexManager.swift renamed to Sources/DocumentationLanguageService/DocCCatalogIndexManager.swift

@@ -10,7 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-package import Foundation
+import Foundation
 import SKLogging
 import SKUtilities
 @_spi(LinkCompletion) @preconcurrency import SwiftDocC
@@ -71,12 +71,12 @@ final actor DocCCatalogIndexManager {
 }
 
 /// Represents a potential error that the ``DocCCatalogIndexManager`` could encounter while indexing
-package enum DocCIndexError: LocalizedError {
+enum DocCIndexError: LocalizedError {
   case internalError(any Error)
   case unexpectedlyNilRenderReferenceStore
   case cancelled
 
-  package var errorDescription: String? {
+  var errorDescription: String? {
     switch self {
     case .internalError(let internalError):
       return "An internal error occurred: \(internalError.localizedDescription)"
@@ -88,7 +88,7 @@ package enum DocCIndexError: LocalizedError {
   }
 }
 
-package struct DocCCatalogIndex: Sendable {
+struct DocCCatalogIndex: Sendable {
   /// A map from an asset name to its DataAsset contents.
   let assets: [String: DataAsset]
 
@@ -107,7 +107,7 @@ package struct DocCCatalogIndex: Sendable {
   /// Retrieves the documentation extension URL for the given symbol if one exists.
   ///
   /// - Parameter symbolInformation: The `DocCSymbolInformation` representing the symbol to search for.
-  package func documentationExtension(for symbolInformation: DocCSymbolInformation) -> URL? {
+  func documentationExtension(for symbolInformation: DocCSymbolInformation) -> URL? {
     documentationExtensions.filter { symbolInformation.matches($0.link) }.first?.documentURL
   }
 

Sources/DocCDocumentation/DocCDocumentationManager.swift renamed to Sources/DocumentationLanguageService/DocCDocumentationManager.swift

@@ -10,21 +10,21 @@
 //
 //===----------------------------------------------------------------------===//
 
-package import BuildServerIntegration
+import BuildServerIntegration
 import BuildServerProtocol
-package import Foundation
-package import LanguageServerProtocol
+import Foundation
+import LanguageServerProtocol
 import SKLogging
 import SwiftDocC
 
-package struct DocCDocumentationManager: Sendable {
+struct DocCDocumentationManager: Sendable {
   private let doccServer: DocCServer
   private let referenceResolutionService: DocCReferenceResolutionService
   private let catalogIndexManager: DocCCatalogIndexManager
 
   private let buildServerManager: BuildServerManager
 
-  package init(buildServerManager: BuildServerManager) {
+  init(buildServerManager: BuildServerManager) {
     let symbolResolutionServer = DocumentationServer(qualityOfService: .unspecified)
     doccServer = DocCServer(
       peer: symbolResolutionServer,
@@ -36,7 +36,7 @@ package struct DocCDocumentationManager: Sendable {
     self.buildServerManager = buildServerManager
   }
 
-  package func filesDidChange(_ events: [FileEvent]) async {
+  func filesDidChange(_ events: [FileEvent]) async {
     for event in events {
       for target in await buildServerManager.targets(for: event.uri) {
         guard let catalogURL = await buildServerManager.doccCatalog(for: target) else {
@@ -47,7 +47,7 @@ package struct DocCDocumentationManager: Sendable {
     }
   }
 
-  package func catalogIndex(for catalogURL: URL) async throws(DocCIndexError) -> DocCCatalogIndex {
+  func catalogIndex(for catalogURL: URL) async throws(DocCIndexError) -> DocCCatalogIndex {
     try await catalogIndexManager.index(for: catalogURL)
   }
 
@@ -63,7 +63,7 @@ package struct DocCDocumentationManager: Sendable {
   ///   - catalogURL: The URL pointing to the docc catalog that this symbol, tutorial, or markdown file is a part of
   /// - Throws: A ResponseError if something went wrong
   /// - Returns: The DoccDocumentationResponse containing the RenderNode if successful
-  package func renderDocCDocumentation(
+  func renderDocCDocumentation(
     symbolUSR: String? = nil,
     symbolGraph: String? = nil,
     overrideDocComments: [String]? = nil,

Sources/DocCDocumentation/DocCReferenceResolutionService.swift renamed to Sources/DocumentationLanguageService/DocCReferenceResolutionService.swift

@@ -13,7 +13,7 @@
 import Foundation
 @preconcurrency import SwiftDocC
 
-package struct DocCServer {
+struct DocCServer {
   private let server: DocumentationServer
 
   init(peer peerServer: DocumentationServer? = nil, qualityOfService: DispatchQoS) {

Sources/DocCDocumentation/DocCServer.swift renamed to Sources/DocumentationLanguageService/DocCServer.swift

@@ -15,7 +15,7 @@ import Foundation
 import SwiftExtensions
 import SymbolKit
 
-package struct DocCSymbolInformation {
+struct DocCSymbolInformation {
   struct Component {
     let name: String
     let information: LinkCompletionTools.SymbolInformation
@@ -37,7 +37,7 @@ package struct DocCSymbolInformation {
     self.components = components
   }
 
-  package func matches(_ link: DocCSymbolLink) -> Bool {
+  func matches(_ link: DocCSymbolLink) -> Bool {
     guard link.components.count == components.count else {
       return false
     }

Sources/DocCDocumentation/DocCSymbolInformation.swift renamed to Sources/DocumentationLanguageService/DocCSymbolInformation.swift

@@ -16,15 +16,15 @@ import SemanticIndex
 @_spi(LinkCompletion) @preconcurrency import SwiftDocC
 import SymbolKit
 
-package struct DocCSymbolLink: Sendable {
+struct DocCSymbolLink: Sendable {
   let linkString: String
   let components: [(name: String, disambiguation: LinkCompletionTools.ParsedDisambiguation)]
 
   var symbolName: String {
     components.last!.name
   }
 
-  package init?(linkString: String) {
+  init?(linkString: String) {
     let components = LinkCompletionTools.parse(linkString: linkString)
     guard !components.isEmpty else {
       return nil

Sources/DocCDocumentation/DocCSymbolLink.swift renamed to Sources/DocumentationLanguageService/DocCSymbolLink.swift

@@ -11,20 +11,17 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-package import LanguageServerProtocol
+import LanguageServerProtocol
 
-package enum DocCDocumentationError: LocalizedError {
+enum DocCDocumentationError: LocalizedError {
   case unsupportedLanguage(Language)
-  case noDocumentableSymbols
   case indexNotAvailable
   case symbolNotFound(String)
 
   var errorDescription: String? {
     switch self {
     case .unsupportedLanguage(let language):
       return "Documentation preview is not available for \(language.description) files"
-    case .noDocumentableSymbols:
-      return "No documentable symbols were found in this Swift file"
     case .indexNotAvailable:
       return "The index is not availble to complete the request"
     case .symbolNotFound(let symbolName):
@@ -33,7 +30,7 @@ package enum DocCDocumentationError: LocalizedError {
   }
 }
 
-package extension ResponseError {
+extension ResponseError {
   static func requestFailed(doccDocumentationError: DocCDocumentationError) -> ResponseError {
     return ResponseError.requestFailed(doccDocumentationError.localizedDescription)
   }

Sources/DocCDocumentation/DoccDocumentationError.swift renamed to Sources/DocumentationLanguageService/DoccDocumentationError.swift

@@ -10,17 +10,15 @@
 //
 //===----------------------------------------------------------------------===//
 
-#if canImport(DocCDocumentation)
 import BuildServerIntegration
-import DocCDocumentation
 import Foundation
 @preconcurrency import IndexStoreDB
 package import LanguageServerProtocol
 import Markdown
+import SKLogging
 import SKUtilities
-import SourceKitLSP
 import SemanticIndex
-import SKLogging
+import SourceKitLSP
 
 extension DocumentationLanguageService {
   package func doccDocumentation(_ req: DoccDocumentationRequest) async throws -> DoccDocumentationResponse {
@@ -76,7 +74,7 @@ extension DocumentationLanguageService {
     moduleName: String?,
     catalogURL: URL?
   ) async throws -> DoccDocumentationResponse {
-    return try await workspace.doccDocumentationManager.renderDocCDocumentation(
+    return try await documentationManager.renderDocCDocumentation(
       tutorialFile: snapshot.text,
       moduleName: moduleName,
       catalogURL: catalogURL
@@ -92,7 +90,7 @@ extension DocumentationLanguageService {
     guard let sourceKitLSPServer else {
       throw ResponseError.internalError("SourceKit-LSP is shutting down")
     }
-    let documentationManager = workspace.doccDocumentationManager
+    let documentationManager = documentationManager
     guard case .symbol(let symbolName) = MarkdownTitleFinder.find(parsing: snapshot.text) else {
       // This is an article that can be rendered on its own
       return try await documentationManager.renderDocCDocumentation(
@@ -171,7 +169,6 @@ extension DocumentationLanguageService {
     guard let sourceKitLSPServer else {
       throw ResponseError.internalError("SourceKit-LSP is shutting down")
     }
-    let documentationManager = workspace.doccDocumentationManager
     let (symbolGraph, symbolUSR, overrideDocComments) = try await sourceKitLSPServer.primaryLanguageService(
       for: snapshot.uri,
       snapshot.language,
@@ -275,4 +272,3 @@ struct MarkdownTitleFinder: MarkupVisitor {
     return .plainText(heading.plainText)
   }
 }
-#endif