mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
89 lines
3.2 KiB
Swift
89 lines
3.2 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2018 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
public typealias CodeActionProviderCompletion = (([CodeAction]) -> Void)
|
|
public typealias CodeActionProvider = ((CodeActionRequest, CodeActionProviderCompletion) -> Void)
|
|
|
|
/// Request for returning all possible code actions for a given text document and range.
|
|
///
|
|
/// The code action request is sent from the client to the server to compute commands for a given text
|
|
/// document and range. These commands are typically code fixes to either fix problems or to beautify/
|
|
/// refactor code.
|
|
///
|
|
/// Servers that provide code actions should set the `codeActions` server capability.
|
|
///
|
|
/// - Parameters:
|
|
/// - textDocument: The document in which the command was invoked.
|
|
/// - range: The specific range inside the document to search for code actions.
|
|
/// - context: The context of the request.
|
|
///
|
|
/// - Returns: A list of code actions for the given range and context.
|
|
public struct CodeActionRequest: TextDocumentRequest, Hashable {
|
|
public static let method: String = "textDocument/codeAction"
|
|
public typealias Response = [CodeAction]?
|
|
|
|
/// The range for which the command was invoked.
|
|
public var range: PositionRange
|
|
|
|
/// Context carrying additional information.
|
|
public var context: CodeActionContext
|
|
|
|
/// The document in which the command was invoked.
|
|
public var textDocument: TextDocumentIdentifier
|
|
|
|
public init(range: Range<Position>, context: CodeActionContext, textDocument: TextDocumentIdentifier) {
|
|
self.range = PositionRange(range)
|
|
self.context = context
|
|
self.textDocument = textDocument
|
|
}
|
|
}
|
|
|
|
public struct CodeActionContext: Codable, Hashable {
|
|
|
|
/// An array of diagnostics.
|
|
public var diagnostics: [Diagnostic]
|
|
|
|
/// Requested kind of actions to return.
|
|
/// If provided, actions of these kinds are filtered out by the client before being shown,
|
|
/// so servers can omit computing them.
|
|
public var only: [CodeActionKind]?
|
|
|
|
public init(diagnostics: [Diagnostic] = [], only: [CodeActionKind]?) {
|
|
self.diagnostics = diagnostics
|
|
self.only = only
|
|
}
|
|
}
|
|
|
|
public struct CodeAction: Codable, ResponseType {
|
|
|
|
/// A short, human-readable, title for this code action.
|
|
public var title: String
|
|
|
|
/// The kind of the code action.
|
|
public var kind: CodeActionKind?
|
|
|
|
/// The diagnostics that this code action resolves, if applicable.
|
|
public var diagnostics: [Diagnostic]?
|
|
|
|
/// A command this code action executes.
|
|
/// If a code action provides an edit and a command,
|
|
/// first the edit is executed and then the command.
|
|
public var command: Command?
|
|
|
|
public init(title: String, kind: CodeActionKind? = nil, diagnostics: [Diagnostic]? = nil, command: Command? = nil) {
|
|
self.title = title
|
|
self.kind = kind
|
|
self.diagnostics = diagnostics
|
|
self.command = command
|
|
}
|
|
}
|