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
|
from typing import (
Optional,
Any,
Tuple,
Union,
)
from collections.abc import Sequence, Container
from debputy.linting.lint_util import LintState, DebputyMetadata
from debputy.lsp.lsp_features import (
lint_diagnostics,
lsp_standard_handler,
lsp_hover,
lsp_completer,
SecondaryLanguage,
LanguageDispatchRule,
)
from debputy.lsp.lsp_generic_yaml import (
yaml_key_range,
generic_yaml_hover,
LSPYAMLHelper,
generic_yaml_lint,
generic_yaml_completer,
_is_empty_range,
)
from debputy.lsprotocol.types import (
TEXT_DOCUMENT_WILL_SAVE_WAIT_UNTIL,
HoverParams,
Hover,
TEXT_DOCUMENT_CODE_ACTION,
CompletionParams,
CompletionList,
CompletionItem,
)
from debputy.plugin.api.impl_types import (
PluginProvidedParser,
)
from debputy.plugin.api.parser_tables import OPARSER_MANIFEST_ROOT
from debputy.plugin.api.spec import DebputyIntegrationMode
from debputy.plugins.debputy.private_api import Capability, load_libcap
try:
from pygls.server import LanguageServer
from debputy.lsp.debputy_ls import DebputyLanguageServer
except ImportError:
pass
_DISPATCH_RULE = LanguageDispatchRule.new_rule(
"debian/debputy.manifest",
"debputy.manifest",
"debian/debputy.manifest",
[
SecondaryLanguage("debputy.manifest"),
# LSP's official language ID for YAML files
SecondaryLanguage("yaml", secondary_lookup="path-name"),
],
)
lsp_standard_handler(_DISPATCH_RULE, TEXT_DOCUMENT_CODE_ACTION)
lsp_standard_handler(_DISPATCH_RULE, TEXT_DOCUMENT_WILL_SAVE_WAIT_UNTIL)
class DebputyManifestLSPYAMLHelper(LSPYAMLHelper[DebputyMetadata]):
def _validate_subparser_is_valid_here(
self,
subparser: PluginProvidedParser,
orig_key: str,
line: int,
col: int,
) -> None:
_integration_mode_allows_key(
self.lint_state,
self.custom_data.debputy_integration_mode,
subparser.parser.expected_debputy_integration_mode,
orig_key,
line,
col,
)
def _type_based_value_check(
self,
target_attr_type: type,
value: Any,
value_pos: tuple[int, int],
*,
key: str | int | None = None,
) -> bool:
if issubclass(target_attr_type, Capability):
has_libcap, _, is_valid_cap = load_libcap()
if has_libcap and not is_valid_cap(value):
line_no, cursor_pos = value_pos
cap_range = self._remaining_line(line_no, cursor_pos)
if _is_empty_range(cap_range):
# FIXME: We cannot report an empty range, but there is still a problem here.
return True
self.lint_state.emit_diagnostic(
cap_range,
"The value could not be parsed as a capability via cap_from_text on this system",
"warning",
"debputy",
)
return True
return super()._type_based_value_check(
target_attr_type,
value,
value_pos,
key=key,
)
def _initialize_yaml_helper(lint_state: LintState) -> DebputyManifestLSPYAMLHelper:
return DebputyManifestLSPYAMLHelper(
lint_state,
lint_state.plugin_feature_set.manifest_parser_generator,
lint_state.debputy_metadata,
)
@lint_diagnostics(_DISPATCH_RULE)
async def _lint_debian_debputy_manifest(lint_state: LintState) -> None:
pg = lint_state.plugin_feature_set.manifest_parser_generator
root_parser = pg.dispatchable_object_parsers[OPARSER_MANIFEST_ROOT]
await generic_yaml_lint(
lint_state,
root_parser,
_initialize_yaml_helper,
)
def _integration_mode_allows_key(
lint_state: LintState,
debputy_integration_mode: DebputyIntegrationMode | None,
expected_debputy_integration_modes: Container[DebputyIntegrationMode] | None,
key: str,
line: int,
col: int,
) -> None:
if debputy_integration_mode is None or expected_debputy_integration_modes is None:
return
if debputy_integration_mode in expected_debputy_integration_modes:
return
key_range = yaml_key_range(key, line, col)
lint_state.emit_diagnostic(
key_range,
f'Feature "{key}" not supported in integration mode {debputy_integration_mode}',
"error",
"debputy",
)
@lsp_completer(_DISPATCH_RULE)
def debputy_manifest_completer(
ls: "DebputyLanguageServer",
params: CompletionParams,
) -> CompletionList | Sequence[CompletionItem] | None:
pg = ls.plugin_feature_set.manifest_parser_generator
root_parser = pg.dispatchable_object_parsers[OPARSER_MANIFEST_ROOT]
return generic_yaml_completer(
ls,
params,
root_parser,
)
@lsp_hover(_DISPATCH_RULE)
def debputy_manifest_hover(
ls: "DebputyLanguageServer",
params: HoverParams,
) -> Hover | None:
return generic_yaml_hover(
ls,
params,
lambda pg: pg.dispatchable_object_parsers[OPARSER_MANIFEST_ROOT],
show_integration_mode=True,
)
|