1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2019 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 CodeActionProvider = @Sendable (CodeActionRequest) async throws -> [CodeAction]
/// 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 = CodeActionRequestResponse?
/// The document in which the command was invoked.
public var textDocument: TextDocumentIdentifier
/// The range for which the command was invoked.
@CustomCodable<PositionRange>
public var range: Range<Position>
/// Context carrying additional information.
public var context: CodeActionContext
public init(range: Range<Position>, context: CodeActionContext, textDocument: TextDocumentIdentifier) {
self._range = CustomCodable<PositionRange>(wrappedValue: range)
self.context = context
self.textDocument = textDocument
}
}
/// Wrapper type for the response of a CodeAction request.
/// If the client supports CodeAction literals, the encoded type will be the CodeAction array itself.
/// Otherwise, the encoded value will be an array of CodeActions' inner Command structs.
public enum CodeActionRequestResponse: ResponseType, Codable, Equatable {
case codeActions([CodeAction])
case commands([Command])
public init(codeActions: [CodeAction], clientCapabilities: TextDocumentClientCapabilities.CodeAction?) {
if clientCapabilities?.codeActionLiteralSupport != nil {
// The client guarantees that unsupported kinds will be handled, and in
// practice some clients use `"codeActionKind":{"valueSet":[]}`, since
// they support all kinds anyway.
self = .codeActions(codeActions)
} else {
self = .commands(codeActions.compactMap { $0.command })
}
}
public init(from decoder: Decoder) throws {
let container = try decoder.singleValueContainer()
if let codeActions = try? container.decode([CodeAction].self) {
self = .codeActions(codeActions)
} else if let commands = try? container.decode([Command].self) {
self = .commands(commands)
} else {
let error = "CodeActionRequestResponse has neither a CodeAction or a Command."
throw DecodingError.dataCorruptedError(in: container, debugDescription: error)
}
}
public func encode(to encoder: Encoder) throws {
var container = encoder.singleValueContainer()
switch self {
case .codeActions(let codeActions):
try container.encode(codeActions)
case .commands(let commands):
try container.encode(commands)
}
}
}
/// The reason why code actions were requested.
public struct CodeActionTriggerKind: RawRepresentable, Codable, Hashable, Sendable {
public var rawValue: Int
public init(rawValue: Int) {
self.rawValue = rawValue
}
/// Code actions were explicitly requested by the user or by an extension.
public static let invoked = CodeActionTriggerKind(rawValue: 1)
/// Code actions were requested automatically.
///
/// This typically happens when current selection in a file changes, but can
/// also be triggered when file content changes.
public static let automatic = CodeActionTriggerKind(rawValue: 2)
}
public struct CodeActionContext: Codable, Hashable, Sendable {
/// 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]?
/// The reason why code actions were requested.
public var triggerKind: CodeActionTriggerKind?
public init(
diagnostics: [Diagnostic] = [],
only: [CodeActionKind]? = nil,
triggerKind: CodeActionTriggerKind? = nil
) {
self.diagnostics = diagnostics
self.only = only
self.triggerKind = triggerKind
}
}
public struct CodeAction: ResponseType, Hashable {
/// 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]?
/// The workspace edit this code action performs.
public var edit: WorkspaceEdit?
/// 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,
edit: WorkspaceEdit? = nil,
command: Command? = nil
) {
self.title = title
self.kind = kind
self.diagnostics = diagnostics
self.edit = edit
self.command = command
}
}
|
