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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
use crate::{
query::{lookup_keys, Query},
world::World,
};
use itertools::Itertools;
use lsp_async_stub::{
rpc::Error,
util::{LspExt, Position},
Context, Params,
};
use lsp_types::{Hover, HoverContents, HoverParams, MarkupContent, MarkupKind};
use serde_json::Value;
use taplo::{
dom::{KeyOrIndex, Keys},
syntax::SyntaxKind::{
self, BOOL, DATE, DATE_TIME_LOCAL, DATE_TIME_OFFSET, IDENT, INTEGER, INTEGER_BIN,
INTEGER_HEX, INTEGER_OCT, MULTI_LINE_STRING, MULTI_LINE_STRING_LITERAL, STRING,
STRING_LITERAL, TIME,
},
};
use taplo_common::{environment::Environment, schema::ext::schema_ext_of};
#[tracing::instrument(skip_all)]
pub(crate) async fn hover<E: Environment>(
context: Context<World<E>>,
params: Params<HoverParams>,
) -> Result<Option<Hover>, Error> {
let p = params.required()?;
let document_uri = p.text_document_position_params.text_document.uri;
let workspaces = context.workspaces.read().await;
let ws = workspaces.by_document(&document_uri);
let doc = match ws.document(&document_uri) {
Ok(d) => d,
Err(error) => {
tracing::debug!(%error, "failed to get document from workspace");
return Ok(None);
}
};
let position = p.text_document_position_params.position;
let offset = match doc.mapper.offset(Position::from_lsp(position)) {
Some(ofs) => ofs,
None => {
tracing::error!(?position, "document position not found");
return Ok(None);
}
};
let query = Query::at(&doc.dom, offset);
let position_info = match query.before.clone().and_then(|p| {
if p.syntax.kind() == IDENT || is_primitive(p.syntax.kind()) {
Some(p)
} else {
None
}
}) {
Some(before) => before,
None => match query.after.clone().and_then(|p| {
if p.syntax.kind() == IDENT || is_primitive(p.syntax.kind()) {
Some(p)
} else {
None
}
}) {
Some(after) => after,
None => return Ok(None),
},
};
if let Some(schema_association) = ws.schemas.associations().association_for(&document_uri) {
tracing::debug!(
schema.url = %schema_association.url,
schema.name = schema_association.meta["name"].as_str().unwrap_or(""),
schema.source = schema_association.meta["source"].as_str().unwrap_or(""),
"using schema"
);
let value = match serde_json::to_value(&doc.dom) {
Ok(v) => v,
Err(error) => {
tracing::warn!(%error, "cannot turn DOM into JSON");
return Ok(None);
}
};
let (keys, _) = match &position_info.dom_node {
Some(n) => n,
None => return Ok(None),
};
let links_in_hover = !ws.config.schema.links;
let mut keys = keys.clone();
if let Some(header_key) = query.header_key() {
let key_idx = header_key
.descendants_with_tokens()
.filter(|t| t.kind() == SyntaxKind::IDENT)
.position(|t| t.as_token().unwrap() == &position_info.syntax)
.unwrap();
keys = lookup_keys(
doc.dom.clone(),
&Keys::new(keys.into_iter().take(key_idx + 1)),
);
}
let node = match doc.dom.path(&keys) {
Some(n) => n,
None => return Ok(None),
};
if position_info.syntax.kind() == SyntaxKind::IDENT {
keys = lookup_keys(doc.dom.clone(), &keys);
if let Some(KeyOrIndex::Index(_)) = keys.iter().last() {
keys = keys.skip_right(1);
}
let schemas = match ws
.schemas
.schemas_at_path(&schema_association.url, &value, &keys)
.await
{
Ok(s) => s,
Err(error) => {
tracing::error!(?error, "schema resolution failed");
return Ok(None);
}
};
let content = schemas
.iter()
.map(|(_, schema)| {
let ext = schema_ext_of(schema).unwrap_or_default();
let ext_docs = ext.docs.unwrap_or_default();
let ext_links = ext.links.unwrap_or_default();
let mut s = String::new();
if let Some(docs) = ext_docs.main {
s += &docs;
} else if let Some(desc) = schema["description"].as_str() {
s += desc;
}
let link_title = if let Some(s) = schema["title"].as_str() {
s
} else {
"..."
};
if links_in_hover {
if let Some(link) = &ext_links.key {
s = format!("[{link_title}]({link})\n\n{s}");
}
}
s
})
.join("\n\n");
if content.is_empty() {
return Ok(None);
}
return Ok(Some(Hover {
contents: HoverContents::Markup(MarkupContent {
kind: MarkupKind::Markdown,
value: content,
}),
range: Some(
doc.mapper
.range(position_info.syntax.text_range())
.unwrap()
.into_lsp(),
),
}));
} else if is_primitive(position_info.syntax.kind()) {
let schemas = match ws
.schemas
.schemas_at_path(&schema_association.url, &value, &keys)
.await
{
Ok(s) => s,
Err(error) => {
tracing::error!(?error, "schema resolution failed");
return Ok(None);
}
};
let value = match serde_json::to_value(node) {
Ok(v) => v,
Err(error) => {
tracing::warn!(%error, "failed to turn DOM into JSON");
Value::Null
}
};
let content = schemas
.iter()
.map(|(_, schema)| {
let ext = schema_ext_of(schema).unwrap_or_default();
let ext_docs = ext.docs.unwrap_or_default();
let enum_docs = ext_docs.enum_values.unwrap_or_default();
let ext_links = ext.links.unwrap_or_default();
let enum_links = ext_links.enum_values.unwrap_or_default();
if !enum_docs.is_empty() {
if let Some(enum_values) = schema["enum"].as_array() {
for (idx, val) in enum_values.iter().enumerate() {
if val == &value {
if let Some(enum_docs) = enum_docs.get(idx).cloned().flatten() {
if links_in_hover {
let link_title =
if let Some(s) = schema["title"].as_str() {
s
} else {
"..."
};
if let Some(enum_link) =
enum_links.get(idx).and_then(Option::as_ref)
{
return format!(
"[{link_title}]({enum_link})\n\n{enum_docs}"
);
}
}
return enum_docs;
}
}
}
}
}
if let (Some(docs), Some(default_value)) =
(ext_docs.default_value, schema.get("default"))
{
if &value == default_value {
return docs;
}
}
if let (Some(docs), Some(const_value)) =
(ext_docs.const_value, schema.get("const"))
{
if &value == const_value {
return docs;
}
}
if let Some(docs) = ext_docs.main {
docs
} else if let Some(desc) = schema["description"].as_str() {
desc.to_string()
} else {
"".to_string()
}
})
.join("\n");
if content.is_empty() {
return Ok(None);
}
return Ok(Some(Hover {
contents: HoverContents::Markup(MarkupContent {
kind: MarkupKind::Markdown,
value: content,
}),
range: Some(
doc.mapper
.range(position_info.syntax.text_range())
.unwrap()
.into_lsp(),
),
}));
}
}
Ok(None)
}
fn is_primitive(kind: SyntaxKind) -> bool {
matches!(
kind,
BOOL | DATE
| DATE_TIME_LOCAL
| DATE_TIME_OFFSET
| TIME
| STRING
| MULTI_LINE_STRING
| STRING_LITERAL
| MULTI_LINE_STRING_LITERAL
| INTEGER
| INTEGER_HEX
| INTEGER_OCT
| INTEGER_BIN
)
}