Merge pull request #1132 from ahoppen/ahoppen/renames

A couple of renames for clarity

Author: ahoppen

Sources/SKSwiftPMWorkspace/CMakeLists.txt

@@ -1,6 +1,6 @@
 
 add_library(SKSwiftPMWorkspace STATIC
-  SwiftPMWorkspace.swift)
+  SwiftPMBuildSystem.swift)
 set_target_properties(SKSwiftPMWorkspace PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
 target_link_libraries(SKSwiftPMWorkspace PRIVATE

Sources/SKSwiftPMWorkspace/SwiftPMWorkspace.swift renamed to Sources/SKSwiftPMWorkspace/SwiftPMBuildSystem.swift

@@ -63,7 +63,7 @@ private func getDefaultToolchain(_ toolchainRegistry: ToolchainRegistry) async -
 /// This class implements the `BuildSystem` interface to provide the build settings for a Swift
 /// Package Manager (SwiftPM) package. The settings are determined by loading the Package.swift
 /// manifest using `libSwiftPM` and constructing a build plan using the default (debug) parameters.
-public actor SwiftPMWorkspace {
+public actor SwiftPMBuildSystem {
 
   public enum Error: Swift.Error {
 
@@ -197,7 +197,7 @@ public actor SwiftPMWorkspace {
   }
 }
 
-extension SwiftPMWorkspace {
+extension SwiftPMBuildSystem {
 
   /// (Re-)load the package settings by parsing the manifest and resolving all the targets and
   /// dependencies.
@@ -270,7 +270,7 @@ extension SwiftPMWorkspace {
   }
 }
 
-extension SwiftPMWorkspace: SKCore.BuildSystem {
+extension SwiftPMBuildSystem: SKCore.BuildSystem {
 
   public var buildPath: TSCAbsolutePath {
     return TSCAbsolutePath(buildParameters.buildPath)
@@ -382,7 +382,7 @@ extension SwiftPMWorkspace: SKCore.BuildSystem {
   }
 }
 
-extension SwiftPMWorkspace {
+extension SwiftPMBuildSystem {
 
   // MARK: Implementation details
 

Sources/SKTestSupport/IndexedSingleSwiftFileWorkspace.swift renamed to Sources/SKTestSupport/IndexedSingleSwiftFileTestProject.swift

@@ -17,7 +17,7 @@ import LanguageServerProtocol
 import SourceKitLSP
 import TSCBasic
 
-public struct IndexedSingleSwiftFileWorkspace {
+public struct IndexedSingleSwiftFileTestProject {
   enum Error: Swift.Error {
     case swiftcNotFound
   }
@@ -95,7 +95,7 @@ public struct IndexedSingleSwiftFileWorkspace {
     }
 
     // Create the test client
-    var options = SourceKitServer.Options.testDefault
+    var options = SourceKitLSPServer.Options.testDefault
     options.indexOptions = IndexOptions(
       indexStorePath: try AbsolutePath(validating: indexURL.path),
       indexDatabasePath: try AbsolutePath(validating: indexDBURL.path)

Sources/SKTestSupport/MultiFileTestWorkspace.swift renamed to Sources/SKTestSupport/MultiFileTestProject.swift

@@ -33,11 +33,11 @@ public struct RelativeFileLocation: Hashable, ExpressibleByStringLiteral {
   }
 }
 
-/// A workspace that writes multiple files to disk and opens a `TestSourceKitLSPClient` client with a workspace pointing
-/// to a temporary directory containing those files.
+/// A test project that writes multiple files to disk and opens a `TestSourceKitLSPClient` client with a workspace
+/// pointing to a temporary directory containing those files.
 ///
 /// The temporary files will be deleted when the `TestSourceKitLSPClient` is destructed.
-public class MultiFileTestWorkspace {
+public class MultiFileTestProject {
   /// Information necessary to open a file in the LSP server by its filename.
   private struct FileData {
     /// The URI at which the file is stored on disk.
@@ -53,7 +53,7 @@ public class MultiFileTestWorkspace {
   private let fileData: [String: FileData]
 
   enum Error: Swift.Error {
-    /// No file with the given filename is known to the `SwiftPMTestWorkspace`.
+    /// No file with the given filename is known to the `MultiFileTestProject`.
     case fileNotFound
   }
 

Sources/SKTestSupport/SkipUnless.swift

@@ -180,7 +180,7 @@ public enum SkipUnless {
     line: UInt = #line
   ) async throws {
     try await skipUnlessSupportedByToolchain(swiftVersion: SwiftVersion(5, 11), file: file, line: line) {
-      let workspace = try await SwiftPMTestWorkspace(
+      let workspace = try await SwiftPMTestProject(
         files: ["test.swift": ""],
         build: true
       )

Sources/SKTestSupport/SwiftPMTestWorkspace.swift renamed to Sources/SKTestSupport/SwiftPMTestProject.swift

@@ -15,7 +15,7 @@ import LanguageServerProtocol
 @_spi(Testing) import SKCore
 import TSCBasic
 
-public class SwiftPMTestWorkspace: MultiFileTestWorkspace {
+public class SwiftPMTestProject: MultiFileTestProject {
   enum Error: Swift.Error {
     /// The `swift` executable could not be found.
     case swiftNotFound
@@ -37,7 +37,7 @@ public class SwiftPMTestWorkspace: MultiFileTestWorkspace {
   /// If `index` is `true`, then the package will be built, indexing all modules within the package.
   public init(
     files: [RelativeFileLocation: String],
-    manifest: String = SwiftPMTestWorkspace.defaultPackageManifest,
+    manifest: String = SwiftPMTestProject.defaultPackageManifest,
     workspaces: (URL) -> [WorkspaceFolder] = { [WorkspaceFolder(uri: DocumentURI($0))] },
     build: Bool = false,
     usePullDiagnostics: Bool = true,

Sources/SKTestSupport/TestSourceKitLSPClient.swift

@@ -20,8 +20,8 @@ import SourceKitLSP
 import SwiftSyntax
 import XCTest
 
-extension SourceKitServer.Options {
-  /// The default SourceKitServer options for testing.
+extension SourceKitLSPServer.Options {
+  /// The default SourceKitLSPServer options for testing.
   public static var testDefault = Self(swiftPublishDiagnosticsDebounceDuration: 0)
 }
 
@@ -44,7 +44,7 @@ public final class TestSourceKitLSPClient: MessageHandler {
   private let moduleCache: URL?
 
   /// The server that handles the requests.
-  public let server: SourceKitServer
+  public let server: SourceKitLSPServer
 
   /// Whether pull or push-model diagnostics should be used.
   ///
@@ -70,7 +70,7 @@ public final class TestSourceKitLSPClient: MessageHandler {
 
   /// A closure that is called when the `TestSourceKitLSPClient` is destructed.
   ///
-  /// This allows e.g. a `IndexedSingleSwiftFileWorkspace` to delete its temporary files when they are no longer needed.
+  /// This allows e.g. a `IndexedSingleSwiftFileTestProject` to delete its temporary files when they are no longer needed.
   private let cleanUp: () -> Void
 
   /// - Parameters:
@@ -84,10 +84,10 @@ public final class TestSourceKitLSPClient: MessageHandler {
   ///   - usePullDiagnostics: Whether to use push diagnostics or use push-based diagnostics
   ///   - workspaceFolders: Workspace folders to open.
   ///   - cleanUp: A closure that is called when the `TestSourceKitLSPClient` is destructed.
-  ///     This allows e.g. a `IndexedSingleSwiftFileWorkspace` to delete its temporary files when they are no longer
+  ///     This allows e.g. a `IndexedSingleSwiftFileTestProject` to delete its temporary files when they are no longer
   ///     needed.
   public init(
-    serverOptions: SourceKitServer.Options = .testDefault,
+    serverOptions: SourceKitLSPServer.Options = .testDefault,
     useGlobalModuleCache: Bool = true,
     initialize: Bool = true,
     initializationOptions: LSPAny? = nil,
@@ -114,7 +114,7 @@ public final class TestSourceKitLSPClient: MessageHandler {
 
     let serverToClientConnection = LocalConnection()
     self.serverToClientConnection = serverToClientConnection
-    server = SourceKitServer(
+    server = SourceKitLSPServer(
       client: serverToClientConnection,
       toolchainRegistry: ToolchainRegistry.forTesting,
       options: serverOptions,
@@ -262,26 +262,25 @@ public final class TestSourceKitLSPClient: MessageHandler {
 
   /// Handle the next request that is sent to the client with the given handler.
   ///
-  /// By default, `TestSourceKitServer` emits an `XCTFail` if a request is sent
+  /// By default, `TestSourceKitLSPClient` emits an `XCTFail` if a request is sent
   /// to the client, since it doesn't know how to handle it. This allows the
   /// simulation of a single request's handling on the client.
   ///
   /// If the next request that is sent to the client is of a different kind than
-  /// the given handler, `TestSourceKitServer` will emit an `XCTFail`.
+  /// the given handler, `TestSourceKitLSPClient` will emit an `XCTFail`.
   public func handleNextRequest<R: RequestType>(_ requestHandler: @escaping RequestHandler<R>) {
     requestHandlers.append(requestHandler)
   }
 
   // MARK: - Conformance to MessageHandler
 
-  /// - Important: Implementation detail of `TestSourceKitServer`. Do not call
+  /// - Important: Implementation detail of `TestSourceKitLSPServer`. Do not call
   ///   from tests.
   public func handle(_ params: some NotificationType) {
     notificationYielder.yield(params)
   }
 
-  /// - Important: Implementation detail of `TestSourceKitServer`. Do not call
-  ///   from tests.
+  /// - Important: Implementation detail of `TestSourceKitLSPClient`. Do not call from tests.
   public func handle<Request: RequestType>(
     _ params: Request,
     id: LanguageServerProtocol.RequestID,
@@ -393,8 +392,8 @@ public struct DocumentPositions {
 
 /// Wrapper around a weak `MessageHandler`.
 ///
-/// This allows us to set the ``TestSourceKitServer`` as the message handler of
-/// `SourceKitServer` without retaining it.
+/// This allows us to set the ``TestSourceKitLSPClient`` as the message handler of
+/// `SourceKitLSPServer` without retaining it.
 private class WeakMessageHandler: MessageHandler {
   private weak var handler: (any MessageHandler)?
 

Sources/SourceKitLSP/CMakeLists.txt

@@ -3,20 +3,20 @@ add_library(SourceKitLSP STATIC
   CapabilityRegistry.swift
   DocumentManager.swift
   IndexStoreDB+MainFilesProvider.swift
-  ResponseError+Init.swift
+  LanguageService.swift
   Rename.swift
+  ResponseError+Init.swift
   Sequence+AsyncMap.swift
   SourceKitIndexDelegate.swift
   SourceKitLSPCommandMetadata.swift
-  SourceKitServer.swift
-  SourceKitServer+Options.swift
+  SourceKitLSPServer.swift
+  SourceKitLSPServer+Options.swift
   TestDiscovery.swift
-  ToolchainLanguageServer.swift
   WorkDoneProgressManager.swift
   Workspace.swift
 )
 target_sources(SourceKitLSP PRIVATE
-  Clang/ClangLanguageServer.swift)
+  Clang/ClangLanguageService.swift)
 target_sources(SourceKitLSP PRIVATE
   Swift/AdjustPositionToStartOfIdentifier.swift
   Swift/CodeCompletion.swift
@@ -36,7 +36,7 @@ target_sources(SourceKitLSP PRIVATE
   Swift/SemanticTokens.swift
   Swift/SourceKitD+ResponseError.swift
   Swift/SwiftCommand.swift
-  Swift/SwiftLanguageServer.swift
+  Swift/SwiftLanguageService.swift
   Swift/SymbolInfo.swift
   Swift/SyntaxHighlightingToken.swift
   Swift/SyntaxHighlightingTokenParser.swift

Sources/SourceKitLSP/CapabilityRegistry.swift

@@ -135,7 +135,7 @@ public final actor CapabilityRegistry {
     options: Options,
     forMethod method: String,
     languages: [Language],
-    in server: SourceKitServer,
+    in server: SourceKitLSPServer,
     registrationDict: [CapabilityRegistration: Options],
     setRegistrationDict: (CapabilityRegistration, Options?) -> Void
   ) async {
@@ -176,7 +176,7 @@ public final actor CapabilityRegistry {
   public func registerCompletionIfNeeded(
     options: CompletionOptions,
     for languages: [Language],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) async {
     guard clientHasDynamicCompletionRegistration else { return }
 
@@ -195,7 +195,7 @@ public final actor CapabilityRegistry {
 
   public func registerDidChangeWatchedFiles(
     watchers: [FileSystemWatcher],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) async {
     guard clientHasDynamicDidChangeWatchedFilesRegistration else { return }
     if let registration = didChangeWatchedFiles {
@@ -230,7 +230,7 @@ public final actor CapabilityRegistry {
   public func registerFoldingRangeIfNeeded(
     options: FoldingRangeOptions,
     for languages: [Language],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) async {
     guard clientHasDynamicFoldingRangeRegistration else { return }
 
@@ -253,7 +253,7 @@ public final actor CapabilityRegistry {
   public func registerSemanticTokensIfNeeded(
     options: SemanticTokensOptions,
     for languages: [Language],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) async {
     guard clientHasDynamicSemanticTokensRegistration else { return }
 
@@ -276,7 +276,7 @@ public final actor CapabilityRegistry {
   public func registerInlayHintIfNeeded(
     options: InlayHintOptions,
     for languages: [Language],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) async {
     guard clientHasDynamicInlayHintRegistration else { return }
     await registerLanguageSpecificCapability(
@@ -297,7 +297,7 @@ public final actor CapabilityRegistry {
   public func registerDiagnosticIfNeeded(
     options: DiagnosticOptions,
     for languages: [Language],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) async {
     guard clientHasDynamicDocumentDiagnosticsRegistration else { return }
 
@@ -318,7 +318,7 @@ public final actor CapabilityRegistry {
   /// it and we haven't yet registered the given command IDs yet.
   public func registerExecuteCommandIfNeeded(
     commands: [String],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) {
     guard clientHasDynamicExecuteCommandRegistration else { return }