mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
a4ac6e0eda
The motivation for this is that I noticed that the `workspace/peekDocuments` request only allows the specification of a document to peek but not the location to peek within it. The fix is to change the `location` parameter from `DocumentUri` to `Location`, but this is a protocol-breaking change, so the client needs to communicate that it can support locations in the `workspace/peekDocuments` request.
The client currently communicates that it supports peeking documents by passing `workspace/peekDocuments: true` in the experimental client capabilities. We could just add another option to the experimental client capabilities like `workspace/peekDocuments.supportsLocations` but this seems a little hacky. Instead, what I propose is that we
1. Allow enabling experimental capabilities as `"<capability name>": { "supported": true }`
2. Switch the VS Code Swift extension to enable client capabilities using a dictionary if it discovers that it uses SourceKit-LSP ≥6.3 (older SourceKit-LSP don’t recogize a dictionary as enabling a capability)
3. Expanding the options to `"workspace/peekDocuments": { "supported" true, "supportsLocation": true }` to communicate that location-based peeking is supported
This pattern will also support experimental capability changes like this in the future.
Use cases that might lack because of this are:
1. Using an old Swift 6.3 toolchain that doesn’t support dictionary-based capabilities with the VS Code Swift extension. In that case macro expansion will work in the fallback mode that we have for other editors and active editor tracking (which cancels target preparation when a file is switched) is disabled. I think this is acceptable.
2. If there are other editors that support these experimental capabilities, they will continue to work just fine by passing the boolen value to enable the option. If they want to support one of the options (eg. location-based peeking), they will need to switch to dictinary-based enabling and thus check the SourceKit-LSP version prior to startup. This might be mildly annoying on their side but since the number of client that support these capabilities should be very small (I am not aware of any) and they need to explicitly opt-in to the new behavior, I think this is also acceptable.
54 lines
1.8 KiB
Swift
54 lines
1.8 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2022 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 Foundation
|
|
package import LanguageServerProtocol
|
|
import SKLogging
|
|
|
|
extension SwiftLanguageService {
|
|
package func openGeneratedInterface(
|
|
document: DocumentURI,
|
|
moduleName: String,
|
|
groupName: String?,
|
|
symbolUSR symbol: String?
|
|
) async throws -> GeneratedInterfaceDetails? {
|
|
let urlData = GeneratedInterfaceDocumentURLData(
|
|
moduleName: moduleName,
|
|
groupName: groupName,
|
|
sourcekitdDocumentName: "\(moduleName)-\(UUID())",
|
|
primaryFile: document
|
|
)
|
|
let position: Position? =
|
|
if let symbol {
|
|
await orLog("Getting position of USR") {
|
|
try await generatedInterfaceManager.position(ofUsr: symbol, in: urlData)
|
|
}
|
|
} else {
|
|
nil
|
|
}
|
|
|
|
if self.capabilityRegistry.clientHasExperimentalCapability(GetReferenceDocumentRequest.method) {
|
|
return GeneratedInterfaceDetails(uri: try urlData.uri, position: position)
|
|
}
|
|
let interfaceFilePath = self.generatedInterfacesPath.appendingPathComponent(urlData.displayName)
|
|
try await generatedInterfaceManager.snapshot(of: urlData).text.write(
|
|
to: interfaceFilePath,
|
|
atomically: true,
|
|
encoding: String.Encoding.utf8
|
|
)
|
|
return GeneratedInterfaceDetails(
|
|
uri: DocumentURI(interfaceFilePath),
|
|
position: position
|
|
)
|
|
}
|
|
}
|