karet-treesitter 0.7.1

Shared tree-sitter parse host (incremental parsing, tree cache, query running) for karet.
Documentation
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
use super::*;

#[test]
fn language_ids_compare() {
    assert_eq!(LanguageId(1), LanguageId(1));
    assert_ne!(LanguageId(1), LanguageId(2));
}

#[test]
fn error_displays() {
    assert_eq!(TsError::UnknownLanguage.to_string(), "unknown language");
}

#[test]
fn unknown_language_has_no_highlights() {
    assert!(highlights_query(LanguageId(60000)).is_none());
    assert!(injections_query(LanguageId(60000)).is_none());
    assert!(semantic_query(LanguageId(60000)).is_none());
    assert!(outline_query(LanguageId(60000)).is_none());
}

#[test]
fn every_registered_highlight_query_compiles() -> Result<(), TsError> {
    for grammar in registry::all() {
        Query::compile(grammar.id, grammar.highlights)?;
    }
    Ok(())
}

#[test]
fn every_registered_semantic_query_compiles() -> Result<(), TsError> {
    for grammar in registry::all() {
        let Some(source) = semantic_query(grammar.id) else {
            continue;
        };
        let query = Query::compile(grammar.id, source)?;
        assert!(
            query
                .capture_names()
                .iter()
                .any(|name| name.starts_with("semantic.")),
            "{} semantic query has no semantic captures",
            grammar.name
        );
    }
    Ok(())
}

#[test]
fn every_registered_outline_query_compiles() -> Result<(), TsError> {
    for grammar in registry::all() {
        let Some(source) = outline_query(grammar.id) else {
            continue;
        };
        let query = Query::compile(grammar.id, &source)?;
        assert!(
            query
                .capture_names()
                .iter()
                .any(|capture| capture.starts_with("definition.")),
            "{} outline query has no definition captures",
            grammar.name
        );
        assert!(query.capture_names().contains(&"name"));
    }
    Ok(())
}

#[cfg(feature = "lang-rust")]
#[test]
fn injections_query_compiles_for_grammars_that_ship_one() -> Result<(), TsError> {
    let lang = language_id_from_injection_name("rust").ok_or(TsError::UnknownLanguage)?;
    let src = injections_query(lang).ok_or(TsError::UnknownLanguage)?;
    let query = Query::compile(lang, &src)?;
    assert!(query.capture_names().contains(&"injection.content"));
    Ok(())
}

#[cfg(feature = "lang-python")]
#[test]
fn grammar_without_injections_reports_none() -> Result<(), TsError> {
    // Python's grammar ships no injections query; that is not an error.
    let lang = language_id_from_injection_name("python").ok_or(TsError::UnknownLanguage)?;
    assert!(highlights_query(lang).is_some());
    assert!(injections_query(lang).is_none());
    Ok(())
}

#[cfg(feature = "lang-rust")]
#[test]
fn clean_trees_report_no_error_lines() -> Result<(), TsError> {
    let lang = language_id_from_injection_name("rust").ok_or(TsError::UnknownLanguage)?;
    let mut pool = ParserPool::new();
    let tree = SyntaxTree::parse(&mut pool, lang, "fn main() { let x = 1; }\n")?;
    assert!(tree.error_lines().is_empty());
    Ok(())
}

#[cfg(feature = "lang-rust")]
#[test]
fn error_lines_cover_the_broken_lines_only() -> Result<(), TsError> {
    let lang = language_id_from_injection_name("rust").ok_or(TsError::UnknownLanguage)?;
    let mut pool = ParserPool::new();
    // Line 2 (0-based) is broken inside its block; the neighbours are fine.
    let src = "fn ok() {}\n\nfn broken() { let x = ; }\n\nfn also_ok() {}\n";
    let tree = SyntaxTree::parse(&mut pool, lang, src)?;
    let errors = tree.error_lines();
    assert!(
        !errors.is_empty(),
        "the malformed source must report errors"
    );
    assert!(
        errors.iter().any(|&(s, e)| s <= 2 && 2 <= e),
        "line 2 is broken: {errors:?}"
    );
    assert!(
        errors.iter().all(|&(s, _)| s != 0),
        "line 0 parsed cleanly: {errors:?}"
    );
    Ok(())
}

#[cfg(feature = "lang-rust")]
#[test]
fn missing_nodes_count_as_errors() -> Result<(), TsError> {
    let lang = language_id_from_injection_name("rust").ok_or(TsError::UnknownLanguage)?;
    let mut pool = ParserPool::new();
    // An unclosed brace makes the parser insert a zero-width missing "}".
    let tree = SyntaxTree::parse(&mut pool, lang, "fn f() {\n    let x = 1;\n")?;
    assert!(
        !tree.error_lines().is_empty(),
        "a missing closing brace is an outright error"
    );
    Ok(())
}

#[cfg(feature = "lang-rust")]
#[test]
fn layered_error_lines_union_the_layers() -> Result<(), TsError> {
    let lang = language_id_from_injection_name("rust").ok_or(TsError::UnknownLanguage)?;
    let mut parser = LayeredParser::new();
    let clean = parser.parse(lang, "fn main() {}\n")?;
    assert!(clean.error_lines().is_empty());
    let broken = parser.parse(lang, "fn broken( {{{\n")?;
    assert!(!broken.error_lines().is_empty());
    Ok(())
}

#[cfg(feature = "lang-rust")]
#[test]
fn parses_rust_and_runs_highlights() -> Result<(), TsError> {
    let lang =
        language_id_from_path(std::path::Path::new("main.rs")).ok_or(TsError::UnknownLanguage)?;
    let src = "fn main() { let x = 1; }";
    let mut pool = ParserPool::new();
    let tree = SyntaxTree::parse(&mut pool, lang, src)?;
    let query_src = highlights_query(lang).ok_or(TsError::UnknownLanguage)?;
    let query = Query::compile(lang, query_src)?;
    let caps = tree.captures(&query, src);
    assert!(!caps.is_empty(), "rust highlights should match something");
    assert!(query.capture_names().contains(&"keyword"));
    // Every capture index is within range.
    assert!(
        caps.iter()
            .all(|c| (c.capture as usize) < query.capture_names().len())
    );
    Ok(())
}

#[cfg(feature = "lang-rust")]
#[test]
fn incremental_reparse_matches_full() -> Result<(), TsError> {
    // Insert "let z=1;" before the closing brace and reparse incrementally;
    // the captures must be identical to a fresh full parse of the new text.
    let Some(lang) = language_id_from_path(std::path::Path::new("x.rs")) else {
        return Ok(());
    };
    let old = "fn main() {}";
    let new = "fn main() {let z=1;}";
    let mut pool = ParserPool::new();
    let mut tree = SyntaxTree::parse(&mut pool, lang, old)?;
    // The insertion happens at byte 11 (before '}'), 8 bytes long, same line.
    tree.edit(&Edit {
        start_byte: 11,
        old_end_byte: 11,
        new_end_byte: 19,
        start_point: karet_core::BytePoint::new(0, 11),
        old_end_point: karet_core::BytePoint::new(0, 11),
        new_end_point: karet_core::BytePoint::new(0, 19),
        replaced: String::new(),
    });
    tree.reparse_with(&mut pool, |byte| new.as_bytes().get(byte..).unwrap_or(&[]))?;

    let full = SyntaxTree::parse(&mut pool, lang, new)?;
    let query_src = highlights_query(lang).ok_or(TsError::UnknownLanguage)?;
    let query = Query::compile(lang, query_src)?;
    assert_eq!(
        tree.captures(&query, new),
        full.captures(&query, new),
        "incremental reparse must match a full parse"
    );
    Ok(())
}

#[cfg(feature = "lang-markdown")]
#[test]
fn parses_markdown_and_compiles_block_query() -> Result<(), TsError> {
    let lang =
        language_id_from_path(std::path::Path::new("README.md")).ok_or(TsError::UnknownLanguage)?;
    let src = "# Title\n\nSome `code` and a [link](http://x).\n";
    let mut pool = ParserPool::new();
    let tree = SyntaxTree::parse(&mut pool, lang, src)?;
    let query_src = highlights_query(lang).ok_or(TsError::UnknownLanguage)?;
    let query = Query::compile(lang, query_src)?;
    // The block grammar should at least capture the heading text.
    let caps = tree.captures(&query, src);
    assert!(query.capture_names().contains(&"text.title"));
    assert!(
        caps.iter()
            .all(|c| (c.capture as usize) < query.capture_names().len())
    );
    Ok(())
}

/// The `(row, byte-column)` of `byte` in `text` — for building test edits.
#[cfg(feature = "lang-markdown")]
fn point_of(text: &str, byte: usize) -> karet_core::BytePoint {
    let before = text.get(..byte).unwrap_or("");
    let row = before.matches('\n').count();
    let col = before.rfind('\n').map_or(byte, |i| byte - i - 1);
    karet_core::BytePoint::new(row, col)
}

#[cfg(feature = "lang-markdown")]
fn layer_langs(tree: &LayeredTree) -> Vec<LanguageId> {
    tree.children().iter().map(SyntaxTree::language).collect()
}

#[cfg(all(feature = "lang-markdown", feature = "lang-rust"))]
#[test]
fn markdown_injects_fenced_code_into_its_language() -> Result<(), TsError> {
    let md = language_id_from_injection_name("markdown").ok_or(TsError::UnknownLanguage)?;
    let rust = language_id_from_injection_name("rust").ok_or(TsError::UnknownLanguage)?;
    let src = "# Title\n\n```rust\nfn main() {}\n```\n";

    let mut parser = LayeredParser::new();
    let tree = parser.parse(md, src)?;

    assert_eq!(tree.root().language(), md);
    // The fence's info string names rust, so its content becomes a rust layer.
    assert!(
        layer_langs(&tree).contains(&rust),
        "expected an embedded rust layer, got {:?}",
        layer_langs(&tree)
    );
    // Root is always the first layer.
    assert_eq!(tree.layers().count(), tree.children().len() + 1);
    Ok(())
}

#[cfg(feature = "lang-markdown")]
#[test]
fn markdown_injects_its_own_inline_grammar() -> Result<(), TsError> {
    let md = language_id_from_injection_name("markdown").ok_or(TsError::UnknownLanguage)?;
    let inline =
        language_id_from_injection_name("markdown_inline").ok_or(TsError::UnknownLanguage)?;
    let mut parser = LayeredParser::new();
    let tree = parser.parse(md, "Some *emphasis* and a [link](http://x).\n")?;
    assert!(layer_langs(&tree).contains(&inline));
    Ok(())
}

#[cfg(feature = "lang-markdown")]
#[test]
fn unknown_fence_language_injects_nothing() -> Result<(), TsError> {
    let md = language_id_from_injection_name("markdown").ok_or(TsError::UnknownLanguage)?;
    let mut parser = LayeredParser::new();
    // No grammar for `brainfuck`; the fence stays plain text rather than erroring.
    let tree = parser.parse(md, "```brainfuck\n+++.\n```\n")?;
    assert!(
        tree.children().is_empty(),
        "an unresolvable fence language must yield no layer"
    );
    // A resolvable fence over the same shape does produce one.
    let rust = parser.parse(md, "```rust\nfn f() {}\n```\n")?;
    assert!(!rust.children().is_empty());
    Ok(())
}

#[cfg(all(
    feature = "lang-html",
    feature = "lang-javascript",
    feature = "lang-css"
))]
#[test]
fn html_injects_script_and_style() -> Result<(), TsError> {
    let html = language_id_from_injection_name("html").ok_or(TsError::UnknownLanguage)?;
    let js = language_id_from_injection_name("javascript").ok_or(TsError::UnknownLanguage)?;
    let css = language_id_from_injection_name("css").ok_or(TsError::UnknownLanguage)?;

    let mut parser = LayeredParser::new();
    let tree = parser.parse(
        html,
        "<script>let x = 1;</script><style>a { color: red }</style>",
    )?;
    let langs: Vec<_> = tree.children().iter().map(SyntaxTree::language).collect();
    assert!(
        langs.contains(&js),
        "expected a javascript layer: {langs:?}"
    );
    assert!(langs.contains(&css), "expected a css layer: {langs:?}");
    Ok(())
}

#[cfg(all(feature = "lang-markdown", feature = "lang-rust"))]
#[test]
fn reparse_discovers_a_newly_typed_code_fence() -> Result<(), TsError> {
    let md = language_id_from_injection_name("markdown").ok_or(TsError::UnknownLanguage)?;
    let rust = language_id_from_injection_name("rust").ok_or(TsError::UnknownLanguage)?;

    let old = "text\n";
    let new = "text\n\n```rust\nfn f() {}\n```\n";
    let mut parser = LayeredParser::new();
    let mut tree = parser.parse(md, old)?;
    assert!(!layer_langs(&tree).contains(&rust), "no fence yet");

    // Append the fence — the edit turns a paragraph into an injected rust region.
    let edit = Edit {
        start_byte: old.len(),
        old_end_byte: old.len(),
        new_end_byte: new.len(),
        start_point: point_of(old, old.len()),
        old_end_point: point_of(old, old.len()),
        new_end_point: point_of(new, new.len()),
        replaced: String::new(),
    };
    parser.reparse(&mut tree, &[edit], new)?;

    assert!(
        layer_langs(&tree).contains(&rust),
        "reparse must discover the new fence, got {:?}",
        layer_langs(&tree)
    );
    // And it agrees with a cold parse of the same text.
    let fresh = parser.parse(md, new)?;
    let (mut a, mut b) = (layer_langs(&tree), layer_langs(&fresh));
    a.sort_unstable_by_key(|l| l.0);
    b.sort_unstable_by_key(|l| l.0);
    assert_eq!(a, b, "incremental layers must match a full layered parse");
    Ok(())
}

#[cfg(all(feature = "lang-markdown", feature = "lang-rust"))]
#[test]
fn deleting_a_fence_drops_its_layer() -> Result<(), TsError> {
    let md = language_id_from_injection_name("markdown").ok_or(TsError::UnknownLanguage)?;
    let rust = language_id_from_injection_name("rust").ok_or(TsError::UnknownLanguage)?;
    let old = "```rust\nfn f() {}\n```\n";
    let new = "";

    let mut parser = LayeredParser::new();
    let mut tree = parser.parse(md, old)?;
    assert!(layer_langs(&tree).contains(&rust));

    parser.reparse(
        &mut tree,
        &[Edit {
            start_byte: 0,
            old_end_byte: old.len(),
            new_end_byte: 0,
            start_point: karet_core::BytePoint::new(0, 0),
            old_end_point: point_of(old, old.len()),
            new_end_point: karet_core::BytePoint::new(0, 0),
            replaced: String::new(),
        }],
        new,
    )?;
    assert!(
        !layer_langs(&tree).contains(&rust),
        "the rust layer must vanish with its fence"
    );
    Ok(())
}

#[cfg(all(feature = "lang-rust", feature = "lang-markdown"))]
#[test]
fn rust_doc_comment_is_markdown() -> Result<(), TsError> {
    let rust = language_id_from_injection_name("rust").ok_or(TsError::UnknownLanguage)?;
    let md = language_id_from_injection_name("markdown").ok_or(TsError::UnknownLanguage)?;
    let mut parser = LayeredParser::new();
    let tree = parser.parse(rust, "/// Adds *one*.\npub fn f() {}\n")?;
    let langs: Vec<_> = tree.children().iter().map(SyntaxTree::language).collect();
    assert!(
        langs.contains(&md),
        "doc comment must inject markdown: {langs:?}"
    );
    // A plain `//` comment is not markdown.
    let plain = parser.parse(rust, "// not *markdown*\npub fn f() {}\n")?;
    assert!(!plain.children().iter().any(|c| c.language() == md));
    Ok(())
}

#[cfg(all(feature = "lang-rust", feature = "lang-markdown"))]
#[test]
fn rust_doctest_fence_in_a_doc_comment_is_rust() -> Result<(), TsError> {
    // The headline case: a doctest fence spans several `///` lines, each its own
    // `line_comment` node. Only a *combined* markdown injection can see the fence,
    // and markdown must then recursively inject rust back into it.
    let rust = language_id_from_injection_name("rust").ok_or(TsError::UnknownLanguage)?;
    let md = language_id_from_injection_name("markdown").ok_or(TsError::UnknownLanguage)?;
    let src = "\
/// Adds one.
///
/// ```rust
/// let y = 1 + 1;
/// assert_eq!(y, 2);
/// ```
pub fn add_one() {}
";
    let mut parser = LayeredParser::new();
    let tree = parser.parse(rust, src)?;
    let langs: Vec<_> = tree.children().iter().map(SyntaxTree::language).collect();
    assert!(langs.contains(&md), "expected a markdown layer: {langs:?}");

    // The doctest body must come back as a *nested* rust layer covering the fence
    // body — not merely some rust layer (a macro injection would also be rust).
    let fence_body = src.find("let y").ok_or(TsError::ParseFailed)?;
    let doctest = tree
        .children()
        .iter()
        .find(|c| c.language() == rust && c.span().start.0 >= fence_body);
    let doctest = doctest.ok_or(TsError::ParseFailed)?;
    assert!(
        doctest.span().end.0 <= src.find("pub fn").unwrap_or(src.len()),
        "the doctest layer must stay inside the doc comment"
    );
    Ok(())
}

#[cfg(all(feature = "lang-rust", feature = "lang-markdown"))]
#[test]
fn layers_are_ordered_shallowest_first() -> Result<(), TsError> {
    // rust (root) → markdown (doc comment, depth 1) → rust (doctest fence, depth 2).
    // The nested rust layer must come *after* the markdown layer that produced it,
    // so a capture merge can let the deeper layer win an exact-range tie.
    let rust = language_id_from_injection_name("rust").ok_or(TsError::UnknownLanguage)?;
    let md = language_id_from_injection_name("markdown").ok_or(TsError::UnknownLanguage)?;
    let src = "/// ```rust\n/// let y = 1;\n/// ```\npub fn f() {}\n";

    let mut parser = LayeredParser::new();
    let tree = parser.parse(rust, src)?;
    let langs: Vec<_> = tree.children().iter().map(SyntaxTree::language).collect();
    let md_at = langs.iter().position(|l| *l == md);
    let nested_rust_at = tree
        .children()
        .iter()
        .position(|c| c.language() == rust && c.span().start.0 < src.len());
    let (Some(md_at), Some(rust_at)) = (md_at, nested_rust_at) else {
        return Err(TsError::ParseFailed);
    };
    assert!(
        md_at < rust_at,
        "markdown (depth 1) must precede the doctest rust layer (depth 2): {langs:?}"
    );
    Ok(())
}

#[cfg(feature = "lang-rust")]
#[test]
fn self_injecting_grammar_terminates() -> Result<(), TsError> {
    // Rust's own injections query re-parses macro token trees as rust. Without the
    // depth cap and identity guard this descends forever.
    let rust = language_id_from_injection_name("rust").ok_or(TsError::UnknownLanguage)?;
    let mut parser = LayeredParser::new();
    let tree = parser.parse(rust, "macro_rules! m { () => { m!(); } }\nfn f() { m!(); }")?;
    assert!(tree.children().len() < MAX_INJECTION_LAYERS);
    Ok(())
}

#[test]
fn parse_ranges_rejects_an_empty_range_list() {
    let mut pool = ParserPool::new();
    let err = SyntaxTree::parse_ranges(&mut pool, LanguageId(60000), "x", &[]);
    assert!(matches!(err, Err(TsError::ParseFailed)));
}

#[test]
fn point_at_resolves_rows_and_columns() {
    let text = "ab\ncd\n";
    let starts = karet_core::LineIndex::new(text);
    assert_eq!(starts.line_count(), 3);
    assert_eq!(
        point_at(&starts, 0),
        tree_sitter::Point { row: 0, column: 0 }
    );
    assert_eq!(
        point_at(&starts, 4),
        tree_sitter::Point { row: 1, column: 1 }
    );
    // End of buffer sits at the start of the (empty) trailing line.
    assert_eq!(
        point_at(&starts, 6),
        tree_sitter::Point { row: 2, column: 0 }
    );
}

#[test]
fn named_ancestors_are_neutral_and_innermost_first() -> Result<(), TsError> {
    let lang = language_id_from_injection_name("rust").ok_or(TsError::UnknownLanguage)?;
    let source = "fn main() { let value = 1; }";
    let mut pool = ParserPool::new();
    let tree = SyntaxTree::parse(&mut pool, lang, source)?;
    let byte = source.find("value").ok_or(TsError::ParseFailed)?;
    let nodes = tree.named_ancestors_at(BytePos(byte));

    assert_eq!(
        nodes.first().map(|node| node.kind.as_str()),
        Some("identifier")
    );
    assert!(nodes.iter().any(|node| node.kind == "block"));
    assert_eq!(
        nodes.last().map(|node| node.kind.as_str()),
        Some("source_file")
    );
    assert!(nodes.windows(2).all(|pair| {
        pair[1].span.start.0 <= pair[0].span.start.0 && pair[0].span.end.0 <= pair[1].span.end.0
    }));
    assert_eq!(
        tree.named_ancestors_at(BytePos(source.len()))
            .last()
            .map(|node| node.kind.as_str()),
        Some("source_file")
    );
    Ok(())
}

#[cfg(feature = "lang-rust")]
#[test]
fn detects_rust_by_extension_and_name() {
    let p = std::path::Path::new("src/lib.rs");
    assert!(language_id_from_path(p).is_some());
    assert_eq!(language_name_from_path(p), Some("Rust"));
}

#[cfg(all(
    feature = "lang-scss",
    feature = "lang-sass",
    feature = "lang-less",
    feature = "lang-erb",
    feature = "lang-mdx",
    feature = "lang-html"
))]
#[test]
fn detects_web_and_template_grammars_by_shared_filetype_identity() {
    for (path, expected_grammar) in [
        ("style.scss", "scss"),
        ("style.sass", "sass"),
        ("style.less", "less"),
        ("view.erb", "erb"),
        ("guide.mdx", "mdx"),
        ("page.xhtml", "html"),
    ] {
        let path = std::path::Path::new(path);
        assert_eq!(
            language_id_from_path(path),
            language_id_from_injection_name(expected_grammar),
            "{path:?}"
        );
    }
}

#[cfg(all(
    feature = "lang-json5",
    feature = "lang-ini",
    feature = "lang-properties",
    feature = "lang-edn",
    feature = "lang-cbor",
    feature = "lang-xml",
    feature = "lang-json",
    feature = "lang-yaml",
    feature = "lang-toml",
    feature = "lang-lockfile"
))]
#[test]
fn detects_structured_formats_and_ecosystem_lockfiles() {
    for (path, expected_grammar) in [
        ("data.json5", "json5"),
        ("settings.ini", "ini"),
        ("messages.properties", "properties"),
        ("data.edn", "edn"),
        ("data.cbor", "cbor"),
        ("catalog.xml", "xml"),
        ("icon.svg", "xml"),
        (".editorconfig", "ini"),
        (".env", "properties"),
        (".gitmodules", "ini"),
        ("Cargo.lock", "toml"),
        ("package-lock.json", "json"),
        ("pnpm-lock.yaml", "yaml"),
        ("yarn.lock", "lockfile"),
    ] {
        let path = std::path::Path::new(path);
        assert_eq!(
            language_id_from_path(path),
            language_id_from_injection_name(expected_grammar),
            "{path:?}"
        );
    }
}

#[cfg(all(feature = "lang-typescript", feature = "lang-graphql"))]
fn graphql_regions(host: &str, src: &str) -> Result<Vec<InjectionRegion>, TsError> {
    let host = language_id_from_injection_name(host).ok_or(TsError::UnknownLanguage)?;
    let graphql = language_id_from_injection_name("graphql").ok_or(TsError::UnknownLanguage)?;
    let mut pool = ParserPool::new();
    let tree = SyntaxTree::parse(&mut pool, host, src)?;
    let query_src = injections_query(host).ok_or(TsError::UnknownLanguage)?;
    let query = Query::compile(host, &query_src)?;
    Ok(tree
        .injections(&query, src)
        .into_iter()
        .filter(|region| region.lang == graphql)
        .collect())
}

#[cfg(all(feature = "lang-typescript", feature = "lang-graphql"))]
#[test]
fn typescript_gql_tagged_templates_inject_graphql() -> Result<(), TsError> {
    let src = "const q = gql`query { hero { name } }`;\n";
    let regions = graphql_regions("typescript", src)?;
    assert_eq!(regions.len(), 1, "{regions:?}");
    let span = regions[0]
        .ranges
        .first()
        .copied()
        .ok_or(TsError::ParseFailed)?;
    assert_eq!(&src[span.start.0..span.end.0], "query { hero { name } }");
    Ok(())
}

#[cfg(all(feature = "lang-typescript", feature = "lang-graphql"))]
#[test]
fn tsx_member_tagged_templates_inject_graphql() -> Result<(), TsError> {
    let src = "const q = graphql.experimental`query { hero }`;\n";
    assert_eq!(
        graphql_regions("tsx", src)?.len(),
        0,
        "unknown tag stays plain"
    );
    let src = "const q = api.gql`query { hero }`;\n";
    assert_eq!(graphql_regions("tsx", src)?.len(), 1);
    Ok(())
}

#[cfg(all(feature = "lang-typescript", feature = "lang-graphql"))]
#[test]
fn typescript_graphql_comment_marker_injects() -> Result<(), TsError> {
    let src = "const q = /* GraphQL */ `query { x }`;\n";
    assert_eq!(graphql_regions("typescript", src)?.len(), 1);
    let src = "const q = /* just a note */ `query { x }`;\n";
    assert_eq!(graphql_regions("typescript", src)?.len(), 0);
    Ok(())
}

#[cfg(all(feature = "lang-typescript", feature = "lang-graphql"))]
#[test]
fn typescript_hash_graphql_leader_injects() -> Result<(), TsError> {
    let src = "const q = `\n  #graphql\n  query { x }\n`;\n";
    assert_eq!(graphql_regions("typescript", src)?.len(), 1);
    let src = "const q = `plain text`;\n";
    assert_eq!(graphql_regions("typescript", src)?.len(), 0);
    Ok(())
}

#[cfg(all(
    feature = "lang-javascript",
    feature = "lang-typescript",
    feature = "lang-graphql"
))]
#[test]
fn javascript_graphql_markers_inject() -> Result<(), TsError> {
    let src = "const q = /* GraphQL */ `query { x }`;\n";
    assert_eq!(graphql_regions("javascript", src)?.len(), 1);
    let src = "const q = `#graphql\nquery { x }`;\n";
    assert_eq!(graphql_regions("javascript", src)?.len(), 1);
    Ok(())
}