mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
d1cddb8c41
The idea here is to unify the different ways in which we can currently set options on SourceKit-LSP in a scalable way: Environment variables, command line arguments to `sourcekit-lsp` and initialization options. The idea is that a user can define a `~/.sourcekit-lsp/.sourcekit-lsp` file (we store logs in `~/.sourcekit-lsp/logs` on non-Darwin platforms), which will be used as the default configuration for all SourceKit-LSP instances. They can also place a `.sourcekit-lsp` file in the root of a workspace to configure SourceKit-LSP for that project specifically, eg. setting arguments that need to be passed to `swift build` for that project and which thus also need to be set on SourceKit-LSP. For compatibility reasons, I’m mapping the existing command line options into the new options structure for now. I hope to delete the command line arguments in the future and solely rely on `.sourcekit-lsp` configuration files. Environment variable will be migrated to `.sourcekit-lsp` in a follow-up commit.
83 lines
3.1 KiB
Swift
83 lines
3.1 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import LanguageServerProtocol
|
|
import SKCore
|
|
import SKSupport
|
|
import SourceKitLSP
|
|
|
|
/// Launches a `SourceKitLSPServer` in-process and allows sending messages to it.
|
|
public final class InProcessSourceKitLSPClient: Sendable {
|
|
private let server: SourceKitLSPServer
|
|
|
|
private let nextRequestID = AtomicUInt32(initialValue: 0)
|
|
|
|
/// Create a new `SourceKitLSPServer`. An `InitializeRequest` is automatically sent to the server.
|
|
///
|
|
/// `messageHandler` handles notifications and requests sent from the SourceKit-LSP server to the client.
|
|
public init(
|
|
toolchainRegistry: ToolchainRegistry,
|
|
options: SourceKitLSPOptions = SourceKitLSPOptions(),
|
|
testHooks: TestHooks = TestHooks(),
|
|
capabilities: ClientCapabilities = ClientCapabilities(),
|
|
workspaceFolders: [WorkspaceFolder],
|
|
messageHandler: any MessageHandler
|
|
) async throws {
|
|
let serverToClientConnection = LocalConnection(name: "client")
|
|
self.server = SourceKitLSPServer(
|
|
client: serverToClientConnection,
|
|
toolchainRegistry: toolchainRegistry,
|
|
options: options,
|
|
testHooks: testHooks,
|
|
onExit: {
|
|
serverToClientConnection.close()
|
|
}
|
|
)
|
|
serverToClientConnection.start(handler: messageHandler)
|
|
_ = try await self.send(
|
|
InitializeRequest(
|
|
processId: nil,
|
|
rootPath: nil,
|
|
rootURI: nil,
|
|
initializationOptions: nil,
|
|
capabilities: capabilities,
|
|
trace: .off,
|
|
workspaceFolders: workspaceFolders
|
|
)
|
|
)
|
|
}
|
|
|
|
/// Send the request to `server` and return the request result.
|
|
///
|
|
/// - Important: Because this is an async function, Swift concurrency makes no guarantees about the execution ordering
|
|
/// of this request with regard to other requests to the server. If execution of requests in a particular order is
|
|
/// necessary and the response of the request is not awaited, use the version of the function that takes a
|
|
/// completion handler
|
|
public func send<R: RequestType>(_ request: R) async throws -> R.Response {
|
|
return try await withCheckedThrowingContinuation { continuation in
|
|
self.send(request) {
|
|
continuation.resume(with: $0)
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Send the request to `server` and return the request result via a completion handler.
|
|
public func send<R: RequestType>(_ request: R, reply: @Sendable @escaping (LSPResult<R.Response>) -> Void) {
|
|
server.handle(request, id: .number(Int(nextRequestID.fetchAndIncrement())), reply: reply)
|
|
}
|
|
|
|
/// Send the notification to `server`.
|
|
public func send(_ notification: some NotificationType) {
|
|
server.handle(notification)
|
|
}
|
|
}
|