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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
from typing import (
Literal,
TypedDict,
Callable,
Iterable,
Union,
TypeVar,
Mapping,
Dict,
Optional,
List,
cast,
)
from lsprotocol.types import (
CodeAction,
Command,
CodeActionParams,
Diagnostic,
TextEdit,
WorkspaceEdit,
TextDocumentEdit,
OptionalVersionedTextDocumentIdentifier,
Range,
Position,
CodeActionKind,
)
from debputy.lsp.diagnostics import DiagnosticData
from debputy.util import _warn
try:
from debputy.lsp.vendoring._deb822_repro.locatable import (
Position as TEPosition,
Range as TERange,
)
from pygls.server import LanguageServer
from pygls.workspace import TextDocument
except ImportError:
pass
CodeActionName = Literal[
"correct-text",
"remove-line",
"insert-text-on-line-after-diagnostic",
]
class CorrectTextCodeAction(TypedDict):
code_action: Literal["correct-text"]
correct_value: str
class InsertTextOnLineAfterDiagnosticCodeAction(TypedDict):
code_action: Literal["insert-text-on-line-after-diagnostic"]
text_to_insert: str
class RemoveLineCodeAction(TypedDict):
code_action: Literal["remove-line"]
def propose_correct_text_quick_fix(correct_value: str) -> CorrectTextCodeAction:
return {
"code_action": "correct-text",
"correct_value": correct_value,
}
def propose_insert_text_on_line_after_diagnostic_quick_fix(
text_to_insert: str,
) -> InsertTextOnLineAfterDiagnosticCodeAction:
return {
"code_action": "insert-text-on-line-after-diagnostic",
"text_to_insert": text_to_insert,
}
def propose_remove_line_quick_fix() -> RemoveLineCodeAction:
return {
"code_action": "remove-line",
}
CODE_ACTION_HANDLERS: Dict[
CodeActionName,
Callable[
[Mapping[str, str], CodeActionParams, Diagnostic],
Iterable[Union[CodeAction, Command]],
],
] = {}
M = TypeVar("M", bound=Mapping[str, str])
Handler = Callable[
[M, CodeActionParams, Diagnostic],
Iterable[Union[CodeAction, Command]],
]
def _code_handler_for(action_name: CodeActionName) -> Callable[[Handler], Handler]:
def _wrapper(func: Handler) -> Handler:
assert action_name not in CODE_ACTION_HANDLERS
CODE_ACTION_HANDLERS[action_name] = func
return func
return _wrapper
@_code_handler_for("correct-text")
def _correct_value_code_action(
code_action_data: CorrectTextCodeAction,
code_action_params: CodeActionParams,
diagnostic: Diagnostic,
) -> Iterable[Union[CodeAction, Command]]:
corrected_value = code_action_data["correct_value"]
edit = TextEdit(
diagnostic.range,
corrected_value,
)
yield CodeAction(
title=f'Replace with "{corrected_value}"',
kind=CodeActionKind.QuickFix,
diagnostics=[diagnostic],
edit=WorkspaceEdit(
changes={code_action_params.text_document.uri: [edit]},
document_changes=[
TextDocumentEdit(
text_document=OptionalVersionedTextDocumentIdentifier(
uri=code_action_params.text_document.uri,
),
edits=[edit],
)
],
),
)
@_code_handler_for("insert-text-on-line-after-diagnostic")
def _correct_value_code_action(
code_action_data: InsertTextOnLineAfterDiagnosticCodeAction,
code_action_params: CodeActionParams,
diagnostic: Diagnostic,
) -> Iterable[Union[CodeAction, Command]]:
corrected_value = code_action_data["text_to_insert"]
line_no = diagnostic.range.end.line
if diagnostic.range.end.character > 0:
line_no += 1
insert_range = Range(
Position(
line_no,
0,
),
Position(
line_no,
0,
),
)
edit = TextEdit(
insert_range,
corrected_value,
)
yield CodeAction(
title=f'Insert "{corrected_value}"',
kind=CodeActionKind.QuickFix,
diagnostics=[diagnostic],
edit=WorkspaceEdit(
changes={code_action_params.text_document.uri: [edit]},
document_changes=[
TextDocumentEdit(
text_document=OptionalVersionedTextDocumentIdentifier(
uri=code_action_params.text_document.uri,
),
edits=[edit],
)
],
),
)
def range_compatible_with_remove_line_fix(range_: Range) -> bool:
start = range_.start
end = range_.end
if start.line != end.line and (start.line + 1 != end.line or end.character > 0):
return False
return True
@_code_handler_for("remove-line")
def _remove_line_code_action(
_code_action_data: RemoveLineCodeAction,
code_action_params: CodeActionParams,
diagnostic: Diagnostic,
) -> Iterable[Union[CodeAction, Command]]:
start = code_action_params.range.start
if range_compatible_with_remove_line_fix(code_action_params.range):
_warn(
"Bug: the quick was used for a diagnostic that spanned multiple lines and would corrupt the file."
)
return
edit = TextEdit(
Range(
start=Position(
line=start.line,
character=0,
),
end=Position(
line=start.line + 1,
character=0,
),
),
"",
)
yield CodeAction(
title="Remove the line",
kind=CodeActionKind.QuickFix,
diagnostics=[diagnostic],
edit=WorkspaceEdit(
changes={code_action_params.text_document.uri: [edit]},
document_changes=[
TextDocumentEdit(
text_document=OptionalVersionedTextDocumentIdentifier(
uri=code_action_params.text_document.uri,
),
edits=[edit],
)
],
),
)
def provide_standard_quickfixes_from_diagnostics(
code_action_params: CodeActionParams,
) -> Optional[List[Union[Command, CodeAction]]]:
actions: List[Union[Command, CodeAction]] = []
for diagnostic in code_action_params.context.diagnostics:
if not isinstance(diagnostic.data, dict):
continue
data: DiagnosticData = cast("DiagnosticData", diagnostic.data)
quickfixes = data.get("quickfixes")
if quickfixes is None:
continue
for action_suggestion in quickfixes:
if (
action_suggestion
and isinstance(action_suggestion, Mapping)
and "code_action" in action_suggestion
):
action_name: CodeActionName = action_suggestion["code_action"]
handler = CODE_ACTION_HANDLERS.get(action_name)
if handler is not None:
actions.extend(
handler(
cast("Mapping[str, str]", action_suggestion),
code_action_params,
diagnostic,
)
)
else:
_warn(f"No codeAction handler for {action_name} !?")
if not actions:
return None
return actions
|
