lang-check 0.4.4

Multilingual prose linter with tree-sitter extraction and pluggable checking engines
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
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
use tree_sitter::Node;

use super::{ProseRange, shared};

/// Built-in environment types that tree-sitter-latex recognises as dedicated
/// node kinds (not `generic_environment`). Skip these entirely.
const SKIP_ENV_KINDS: &[&str] = &[
    "verbatim_environment",
    "minted_environment",
    "listing_environment",
    "comment_environment",
    "math_environment",
    "asy_environment",
    "luacode_environment",
    "pycode_environment",
    "sageblock_environment",
    "sagesilent_environment",
];

/// Generic environment names (the `{name}` in `\begin{name}`) that should be
/// skipped. These are environments tree-sitter-latex parses as
/// `generic_environment` rather than a dedicated node kind.
const SKIP_GENERIC_ENVS: &[&str] = &[
    "algorithm",
    "algorithmic",
    "lstlisting",
    "equation",
    "equation*",
    "align",
    "align*",
    "gather",
    "gather*",
    "multline",
    "multline*",
    "flalign",
    "flalign*",
    "split",
    "mathpar",
    "mathpar*",
    "IEEEeqnarray",
    "IEEEeqnarray*",
    "tikzpicture",
    "pgfpicture",
    "forest",
    "tabular",
    "tabular*",
    "array",
    "matrix",
    "bmatrix",
    "pmatrix",
    "vmatrix",
    "Bmatrix",
    "Vmatrix",
    "cases",
    "bnf",
];

/// Node types that represent math and should be skipped.
const SKIP_NODES: &[&str] = &["inline_formula", "displayed_equation"];

/// Node types that are always structural (never contain prose `word` nodes).
const STRUCTURAL_NODES: &[&str] = &[
    "command_name",
    "graphics_include",
    "label_definition",
    "label_reference",
    "citation",
    "package_include",
    "bibstyle_include",
];

/// Generic command names (the `\name` in `\name{...}`) whose arguments are
/// non-prose and should be skipped entirely. When `collect_words` encounters
/// a `generic_command` whose command name matches, the entire subtree is
/// dropped.
const SKIP_GENERIC_COMMANDS: &[&str] = &[
    "thispagestyle",
    "pagestyle",
    "bibliographystyle",
    "bibliography",
    "setcounter",
    "addtocounter",
    "setlength",
    "addtolength",
    "newcommand",
    "renewcommand",
    "newenvironment",
    "renewenvironment",
    "DeclareMathOperator",
    "definecolor",
    "hypersetup",
    "geometry",
    "input",
    "include",
    "hfill",
    "vfill",
    "hspace",
    "vspace",
    "smallskip",
    "medskip",
    "bigskip",
    "hrule",
    "vrule",
    "newpage",
    "clearpage",
    "maketitle",
    "tableofcontents",
    "listoffigures",
    "listoftables",
    "texttt",
    "verb",
    "lstinline",
    "mintinline",
    "url",
    "href",
    "path",
];

/// User-configurable extras for LaTeX prose extraction.
#[derive(Default)]
pub struct LatexExtras<'a> {
    pub skip_envs: &'a [String],
    pub skip_commands: &'a [String],
}

/// Extract prose ranges from a LaTeX AST.
///
/// Walks the tree collecting `word` leaf nodes, skipping preamble, math,
/// verbatim, and other non-prose environments. Adjacent words are merged
/// into sentence-level prose chunks.
pub(crate) fn extract(text: &str, root: Node, extras: &LatexExtras) -> Vec<ProseRange> {
    let doc_start = find_document_body_start(root, text);

    let mut word_ranges: Vec<(usize, usize)> = Vec::new();
    collect_words(root, text, doc_start, false, extras, &mut word_ranges);

    shared::merge_ranges(
        &word_ranges,
        text,
        strip_latex_noise,
        collect_gap_exclusions,
    )
}

/// Check whether a node kind represents a structural (non-prose) container.
///
/// Includes all `brack_group*` variants, specialised `curly_group_*` variants
/// (but NOT plain `curly_group` which holds prose), and explicitly listed
/// structural node types.
fn is_structural_node(kind: &str) -> bool {
    if kind.starts_with("brack_group") {
        return true;
    }
    if kind.starts_with("curly_group_") {
        return true;
    }
    STRUCTURAL_NODES.contains(&kind)
}

/// Find the byte offset where `\begin{document}` body starts.
/// Returns 0 if no document environment is found (single-file snippets).
fn find_document_body_start(root: Node, text: &str) -> usize {
    let mut cursor = root.walk();
    for child in root.children(&mut cursor) {
        if child.kind() == "generic_environment"
            && let Some(begin_node) = child.child_by_field_name("begin")
        {
            let begin_text = &text[begin_node.start_byte()..begin_node.end_byte()];
            if begin_text.contains("document") {
                return begin_node.end_byte();
            }
        }
    }
    0
}

/// Recursively collect prose leaf nodes (`word`), skipping excluded subtrees.
///
/// The `in_structural` flag propagates through the tree so that `word` nodes
/// nested inside structural parents (at any depth) are skipped.
fn collect_words(
    node: Node,
    text: &str,
    doc_start: usize,
    in_structural: bool,
    extras: &LatexExtras,
    out: &mut Vec<(usize, usize)>,
) {
    if node.end_byte() <= doc_start {
        return;
    }

    let kind = node.kind();

    if SKIP_ENV_KINDS.contains(&kind) || SKIP_NODES.contains(&kind) {
        return;
    }

    if kind == "generic_environment" && should_skip_generic_env(node, text, extras.skip_envs) {
        return;
    }

    if kind == "generic_command" && should_skip_generic_command(node, text, extras.skip_commands) {
        return;
    }

    let structural = in_structural || is_structural_node(kind);

    if kind == "word" {
        if !structural {
            let start = node.start_byte();
            let end = node.end_byte();
            if start >= doc_start && start < end {
                out.push((start, end));
            }
        }
        return;
    }

    let mut cursor = node.walk();
    for child in node.children(&mut cursor) {
        collect_words(child, text, doc_start, structural, extras, out);
    }
}

/// Check if a `generic_environment` node should be skipped based on its name.
fn should_skip_generic_env(node: Node, text: &str, extra_skip_envs: &[String]) -> bool {
    let mut cursor = node.walk();
    for child in node.children(&mut cursor) {
        if child.kind() != "begin" {
            continue;
        }
        let mut inner = child.walk();
        for bc in child.children(&mut inner) {
            if bc.kind() != "curly_group_text" {
                continue;
            }
            let mut name_cursor = bc.walk();
            for name_child in bc.children(&mut name_cursor) {
                if name_child.kind() != "text" {
                    continue;
                }
                let env_name = &text[name_child.start_byte()..name_child.end_byte()];
                let env_name = env_name.trim();
                if SKIP_GENERIC_ENVS.contains(&env_name) {
                    return true;
                }
                return extra_skip_envs.iter().any(|e| e == env_name);
            }
        }
        break;
    }
    false
}

/// Check if a `generic_command` node should be skipped based on its command name.
fn should_skip_generic_command(node: Node, text: &str, extra_skip_commands: &[String]) -> bool {
    let mut cursor = node.walk();
    for child in node.children(&mut cursor) {
        if child.kind() == "command_name" {
            // command_name text is e.g. `\thispagestyle` — strip leading `\`
            let raw = &text[child.start_byte()..child.end_byte()];
            let name = raw.strip_prefix('\\').unwrap_or(raw);
            if SKIP_GENERIC_COMMANDS.contains(&name) {
                return true;
            }
            return extra_skip_commands.iter().any(|c| c == name);
        }
    }
    false
}

// ---------------------------------------------------------------------------
// Word-range merging with LaTeX-aware gap analysis
// ---------------------------------------------------------------------------

/// Walk a gap string and record every LaTeX noise region as an exclusion
/// (document-level byte offsets).  This mirrors the logic in
/// `strip_latex_noise` so that everything the gap-stripper removes is also
/// blanked with spaces in the text the checker receives.
///
/// Covered: inline math (`$...$`), display math (`\[...\]`), inline math
/// (`\(...\)`), command names with their arguments (`\textsc{...}`), and
/// escape sequences (`\\`, `\,`, etc.).  Display math exclusions are
/// extended to cover surrounding whitespace so that the grammar checker
/// doesn't see false paragraph breaks.
/// Skip inline math `$...$` starting at position `i` (on the `$`).
/// Returns the new scan position (just past the closing `$`).
fn skip_inline_math_exclusion(
    bytes: &[u8],
    i: usize,
    gap_offset: usize,
    out: &mut Vec<(usize, usize)>,
) -> usize {
    let mut j = i + 1;
    while j < bytes.len() && bytes[j] != b'$' {
        j += 1;
    }
    if j < bytes.len() {
        j += 1; // closing $
    }
    out.push((gap_offset + i, gap_offset + j));
    j
}

/// Skip display math `\[...\]` starting at position `i` (on the `\`).
/// Absorbs surrounding whitespace into the exclusion so the checker doesn't
/// see false paragraph breaks.
fn skip_display_math_exclusion(
    bytes: &[u8],
    i: usize,
    gap_offset: usize,
    out: &mut Vec<(usize, usize)>,
) -> usize {
    let len = bytes.len();
    let mut exc_start = i;
    while exc_start > 0 && bytes[exc_start - 1].is_ascii_whitespace() {
        exc_start -= 1;
    }
    let mut j = i + 2;
    while j + 1 < len && !(bytes[j] == b'\\' && bytes[j + 1] == b']') {
        j += 1;
    }
    if j + 1 < len {
        j += 2;
    }
    let mut exc_end = j;
    while exc_end < len && bytes[exc_end].is_ascii_whitespace() {
        exc_end += 1;
    }
    out.push((gap_offset + exc_start, gap_offset + exc_end));
    exc_end
}

/// Skip inline paren math `\(...\)` starting at position `i` (on the `\`).
fn skip_inline_paren_math_exclusion(
    bytes: &[u8],
    i: usize,
    gap_offset: usize,
    out: &mut Vec<(usize, usize)>,
) -> usize {
    let mut j = i + 2;
    let len = bytes.len();
    while j + 1 < len && !(bytes[j] == b'\\' && bytes[j + 1] == b')') {
        j += 1;
    }
    if j + 1 < len {
        j += 2;
    }
    out.push((gap_offset + i, gap_offset + j));
    j
}

fn collect_gap_exclusions(gap: &str, gap_offset: usize, out: &mut Vec<(usize, usize)>) {
    let bytes = gap.as_bytes();
    let len = bytes.len();
    let mut i = 0;

    while i < len {
        if bytes[i] == b'$' {
            i = skip_inline_math_exclusion(bytes, i, gap_offset, out);
        } else if i + 1 < len && bytes[i] == b'\\' && bytes[i + 1] == b'[' {
            i = skip_display_math_exclusion(bytes, i, gap_offset, out);
        } else if i + 1 < len && bytes[i] == b'\\' && bytes[i + 1] == b'(' {
            i = skip_inline_paren_math_exclusion(bytes, i, gap_offset, out);
        } else if i + 1 < len && bytes[i] == b'\\' && bytes[i + 1].is_ascii_alphabetic() {
            // command: \name[...]{...}
            let start = i;
            i += 1;
            while i < len && bytes[i].is_ascii_alphabetic() {
                i += 1;
            }
            if i < len && bytes[i] == b'*' {
                i += 1;
            }
            i = shared::skip_command_args_bytes(bytes, i, &[(b'{', b'}'), (b'[', b']')]);
            out.push((gap_offset + start, gap_offset + i));
        } else if i + 1 < len && bytes[i] == b'\\' {
            // escape sequence: \\ , \, , \; , etc.
            out.push((gap_offset + i, gap_offset + i + 2));
            i += 2;
        } else if bytes[i] == b'{' || bytes[i] == b'}' {
            // bare braces
            out.push((gap_offset + i, gap_offset + i + 1));
            i += 1;
        } else {
            i += 1;
        }
    }
}

/// Strip LaTeX noise from a gap string: math (`$...$`, `\(...\)`, `\[...\]`)
/// and command names (`\textbf`, `\ref`, etc.). Display math content is
/// excluded from the prose text via `ProseRange.exclusions`, so stripping
/// it here is safe. Leaves braces, whitespace, and punctuation intact for
/// subsequent validation.
fn strip_latex_noise(gap: &str) -> String {
    let mut result = String::new();
    let chars: Vec<char> = gap.chars().collect();
    let mut i = 0;
    while i < chars.len() {
        if chars[i] == '$' {
            i += 1;
            while i < chars.len() && chars[i] != '$' {
                i += 1;
            }
            i += 1;
            result.push(' ');
        } else if chars[i] == '\\'
            && i + 1 < chars.len()
            && (chars[i + 1] == '[' || chars[i + 1] == '(')
        {
            // Replace math with a space to avoid creating false paragraph
            // breaks (display math between newlines: \n\[...\]\n → \n \n).
            // Display math content is excluded via ProseRange.exclusions.
            let close = if chars[i + 1] == '[' { ']' } else { ')' };
            i += 2;
            while i + 1 < chars.len() && !(chars[i] == '\\' && chars[i + 1] == close) {
                i += 1;
            }
            if i + 1 < chars.len() {
                i += 2;
            }
            result.push(' ');
        } else if chars[i] == '\\' && i + 1 < chars.len() && chars[i + 1].is_ascii_alphabetic() {
            let cmd_start = i + 1;
            let mut j = cmd_start;
            while j < chars.len() && chars[j].is_ascii_alphabetic() {
                j += 1;
            }
            let cmd: String = chars[cmd_start..j].iter().collect();

            // Block/layout commands should NOT be bridged — leave them to
            // fail validation so adjacent ranges stay separate.
            if matches!(
                cmd.as_str(),
                "begin"
                    | "end"
                    | "item"
                    | "par"
                    | "section"
                    | "subsection"
                    | "subsubsection"
                    | "paragraph"
                    | "chapter"
                    | "part"
                    | "hfill"
                    | "vfill"
                    | "newline"
                    | "linebreak"
                    | "noindent"
            ) {
                result.push(chars[i]);
                i += 1;
                continue;
            }

            i = j;
            if i < chars.len() && chars[i] == '*' {
                i += 1;
            }
            i = shared::skip_command_args_chars(&chars, i, &[('{', '}'), ('[', ']')]);
        } else if chars[i] == '\\' {
            i += 1;
            if i < chars.len() {
                i += 1;
            }
        } else {
            result.push(chars[i]);
            i += 1;
        }
    }
    result
}

#[cfg(test)]
mod tests {
    use super::LatexExtras;
    use crate::prose::ProseExtractor;
    use anyhow::Result;

    #[test]
    fn test_latex_basic_extraction() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\usepackage{amsmath}

\begin{document}

\section{Introduction}

This is a simple paragraph with some text.

\textbf{Bold text} and \textit{italic text} here.

\begin{verbatim}
This should be ignored completely.
\end{verbatim}

Another paragraph after verbatim.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();

        assert!(
            extracted.iter().any(|t| t.contains("simple paragraph")),
            "Should extract prose text, got: {extracted:?}"
        );
        assert!(
            extracted.iter().any(|t| t.contains("Bold text")),
            "Should extract text inside \\textbf, got: {extracted:?}"
        );
        assert!(
            !extracted.iter().any(|t| t.contains("ignored completely")),
            "Should NOT extract verbatim content, got: {extracted:?}"
        );
        assert!(
            !extracted.iter().any(|t| t.contains("\\textbf")),
            "Should NOT contain latex commands, got: {extracted:?}"
        );
        assert!(
            !extracted.iter().any(|t| t.contains("\\documentclass")),
            "Should NOT contain preamble, got: {extracted:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_math_excluded() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

Some text before math.

$x^2 + y^2 = z^2$

Text after inline math.

\[
  \int_0^1 f(x) \, dx
\]

Text after display math.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();

        assert!(
            extracted.iter().any(|t| t.contains("before math")),
            "Should extract text before math, got: {extracted:?}"
        );
        assert!(
            extracted.iter().any(|t| t.contains("after inline math")),
            "Should extract text after math, got: {extracted:?}"
        );
        assert!(
            !extracted.iter().any(|t| t.contains("x^2")),
            "Should NOT extract inline math, got: {extracted:?}"
        );
        assert!(
            !extracted.iter().any(|t| t.contains("\\int")),
            "Should NOT extract display math, got: {extracted:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_preamble_excluded() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\usepackage{amsmath}
\title{My Document}
\author{John Doe}

\begin{document}

Hello world.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();

        assert!(
            extracted.iter().any(|t| t.contains("Hello world")),
            "Should extract body text, got: {extracted:?}"
        );
        assert!(
            !extracted.iter().any(|t| t.contains("My Document")),
            "Should NOT extract title from preamble, got: {extracted:?}"
        );
        assert!(
            !extracted.iter().any(|t| t.contains("John Doe")),
            "Should NOT extract author from preamble, got: {extracted:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_no_document_env() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\section{Test}
Some text here.
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();

        assert!(
            extracted.iter().any(|t| t.contains("text here")),
            "Should extract text from snippet without document env, got: {extracted:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_real_content() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass[10pt]{article}
\usepackage{styles/pagestyle}
\usepackage{styles/codestyle}

\begin{document}

{\scshape Notes } \hfill {\scshape \large } \hfill {\scshape \today}

\smallskip
\hrule
\bigskip

\section{Insertion sort}

There are two popular variants of insertsion sort you typically see

\begin{algorithm}[H]
  \caption{InsertionSort A}
  \begin{algorithmic}[1]
    \State $i \gets 1$
    \While{$i < \text{length}(A)$}
    \State $j \gets i$
    \EndWhile
  \end{algorithmic}
\end{algorithm}

\subsection{InsertionSort A}
The invariants for this version are relatively straightforward. The first invariant we specify is that the outer loop variable $i$ is always between $1$ and the length of the array (inclusive). So
\[
  1 \leq i \leq \text{length}(A) \tag{Index Constraint}
\]
Secondly, for the outer loop, we weaken the postcondition with the index variable $i$ to get the invariant that the subarray $A[0..i)$ is sorted.

\begin{grayblock}
  One sidenote we can actually weaken the `elements greater than key' invariant as follows
  \[
    \forall k.\ j < k \leq i \to A[k] \geq \text{key}
  \]
\end{grayblock}

\begin{minted}{dafny}
method InsertionSortA(a : array<int>)
  modifies a
  requires a.Length >= 1
\end{minted}

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();

        assert!(
            extracted.iter().any(|t| t.contains("popular variants")),
            "Should extract prose about variants, got: {extracted:?}"
        );
        assert!(
            extracted.iter().any(|t| t.contains("Insertion sort")),
            "Should extract section heading, got: {extracted:?}"
        );
        assert!(
            !extracted.iter().any(|t| t.contains("\\section")),
            "Should NOT contain \\section command, got: {extracted:?}"
        );
        assert!(
            !extracted.iter().any(|t| t.contains("pagestyle")),
            "Should NOT contain preamble, got: {extracted:?}"
        );
        assert!(
            !extracted.iter().any(|t| t.contains("InsertionSortA")),
            "Should NOT contain minted code, got: {extracted:?}"
        );
        assert!(
            !extracted.iter().any(|t| t.contains("\\caption")),
            "Should NOT contain algorithm content, got: {extracted:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_algorithm_env() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

Text before algorithm.

\begin{algorithm}[H]
  \caption{InsertionSort}
  \begin{algorithmic}[1]
    \State $i \gets 1$
  \end{algorithmic}
\end{algorithm}

Text after algorithm.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();

        assert!(
            extracted.iter().any(|t| t.contains("before algorithm")),
            "Should extract text before algorithm, got: {extracted:?}"
        );
        assert!(
            extracted.iter().any(|t| t.contains("after algorithm")),
            "Should extract text after algorithm, got: {extracted:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_inline_math_bridges() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

The variable $i$ is always between $1$ and the length of the array.

Some text, with a comma and more text after it.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();

        assert!(
            extracted.iter().any(|t| t.contains("variable")
                && t.contains("always between")
                && t.contains("length")),
            "Sentence with inline math should be a single chunk bridging across $i$ and $1$, got: {extracted:?}"
        );
        assert!(
            extracted
                .iter()
                .any(|t| t.contains("text,") || (t.contains("text") && t.contains("comma"))),
            "Sentence with comma should stay together, got: {extracted:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_includegraphics_not_extracted() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

Some text before.

\includegraphics[width=0.5\textwidth]{array.pdf}

Some text after.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();

        assert!(
            !extracted.iter().any(|t| *t == "width" || *t == "0.5"),
            "Should NOT extract includegraphics optional args, got: {extracted:?}"
        );
        assert!(
            extracted.iter().any(|t| t.contains("text before")),
            "Should extract prose before includegraphics, got: {extracted:?}"
        );
        assert!(
            extracted.iter().any(|t| t.contains("text after")),
            "Should extract prose after includegraphics, got: {extracted:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_display_math_excluded_from_text() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

We know that
\[
  x^2 + y^2 = z^2
\]
which proves our claim.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;

        // The sentence should bridge across the display math
        let bridged = ranges.iter().any(|r| {
            let raw = &text[r.start_byte..r.end_byte];
            raw.contains("know that") && raw.contains("proves our claim")
        });
        assert!(
            bridged,
            "Sentence should bridge across display math, got: {:?}",
            ranges
                .iter()
                .map(|r| &text[r.start_byte..r.end_byte])
                .collect::<Vec<_>>()
        );

        // But extract_text should replace the math with spaces
        let bridged_range = ranges
            .iter()
            .find(|r| {
                let raw = &text[r.start_byte..r.end_byte];
                raw.contains("know that") && raw.contains("proves our claim")
            })
            .expect("Should have a bridged range");

        assert!(
            !bridged_range.exclusions.is_empty(),
            "Should have exclusions for display math"
        );

        let clean_text = bridged_range.extract_text(text);
        assert!(
            !clean_text.contains("x^2"),
            "extract_text should not contain math content, got: {:?}",
            clean_text
        );
        assert!(
            clean_text.contains("know that"),
            "extract_text should still contain prose, got: {:?}",
            clean_text
        );
        // Newlines around display math should also be blanked so that
        // "which" after \] doesn't look like a new sentence start
        assert!(
            !clean_text.contains('\n'),
            "extract_text should blank newlines around display math, got: {:?}",
            clean_text
        );

        Ok(())
    }

    #[test]
    fn test_latex_display_math_no_false_capitalization() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        // Reproduces the user's exact pattern: display math followed by
        // lowercase continuation that should NOT be flagged for capitalization.
        let text = r"\documentclass{article}
\begin{document}

Thus, our invariant for the inner loop is:
\[
  \forall p, q.\ 0 \leq p < q
\]
the intuition here being that all elements are in sorted order.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;

        // Should bridge across \[...\] into one chunk
        let bridged = ranges.iter().find(|r| {
            let raw = &text[r.start_byte..r.end_byte];
            raw.contains("invariant") && raw.contains("intuition")
        });
        assert!(
            bridged.is_some(),
            "Should bridge across display math, got: {:?}",
            ranges
                .iter()
                .map(|r| &text[r.start_byte..r.end_byte])
                .collect::<Vec<_>>()
        );

        let range = bridged.unwrap();
        let clean = range.extract_text(text);

        // The clean text should flow as "is:  the intuition" (with spaces
        // replacing the math), not "is:\n...\nthe" which would trigger
        // capitalization warnings.
        assert!(
            clean.contains("is:") && clean.contains("the intuition"),
            "Prose should flow continuously, got: {:?}",
            clean
        );
        assert!(
            !clean.contains("\\forall"),
            "Math commands should be blanked, got: {:?}",
            clean
        );

        Ok(())
    }

    #[test]
    fn test_latex_mathpar_skipped() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

We define the rules as follows
\begin{mathpar}
    \inferrule
    { }
    {\Gamma \vdash n : \text{num}} \quad \text{T-Num}

    \inferrule
    {\Gamma (x) = \tau}
    {\Gamma \vdash x : \tau} \quad \text{T-Var}
\end{mathpar}

The proof is complete.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();

        assert!(
            extracted.iter().any(|t| t.contains("define the rules")),
            "Should extract prose before mathpar, got: {extracted:?}"
        );
        assert!(
            extracted.iter().any(|t| t.contains("proof is complete")),
            "Should extract prose after mathpar, got: {extracted:?}"
        );
        assert!(
            !extracted.iter().any(|t| t.contains("T-Num")),
            "Should NOT extract inference rule labels, got: {extracted:?}"
        );
        assert!(
            !extracted.iter().any(|t| t.contains("T-Var")),
            "Should NOT extract inference rule labels, got: {extracted:?}"
        );
        // Single-letter fragments from \text{} inside math should not appear
        assert!(
            !extracted.iter().any(|t| *t == "x" || *t == "n"),
            "Should NOT extract single variable names from mathpar, got: {extracted:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_thispagestyle_skipped() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}
\thispagestyle{empty}

Hello world.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();

        assert!(
            !extracted.iter().any(|t| t.contains("empty")),
            "Should NOT extract thispagestyle argument, got: {extracted:?}"
        );
        assert!(
            extracted.iter().any(|t| t.contains("Hello world")),
            "Should extract body prose, got: {extracted:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_hfill_breaks_ranges() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

{\scshape LV } \hfill {\scshape \large Assignment 1} \hfill {\scshape \today}

Some real prose here.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();

        // \hfill should break merging — LV and Assignment 1 should not be in the same range
        assert!(
            !extracted
                .iter()
                .any(|t| t.contains("LV") && t.contains("Assignment")),
            "\\hfill should break ranges, got: {extracted:?}"
        );
        assert!(
            extracted.iter().any(|t| t.contains("real prose")),
            "Should extract body prose, got: {extracted:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_bnf_env_skipped() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

The syntax is defined as follows.
\begin{bnf}(
        prod-delim={--},
        comment={//},
      )[
        colspec = {llcll},
      ]
      e // Expr ::=
      | n // number
    \end{bnf}

That concludes the grammar.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();

        assert!(
            extracted.iter().any(|t| t.contains("syntax is defined")),
            "Should extract prose before bnf, got: {extracted:?}"
        );
        assert!(
            extracted
                .iter()
                .any(|t| t.contains("concludes the grammar")),
            "Should extract prose after bnf, got: {extracted:?}"
        );
        assert!(
            !extracted
                .iter()
                .any(|t| t.contains("prod-delim") || t.contains("colspec")),
            "Should NOT extract bnf parameters, got: {extracted:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_inline_math_excluded_from_text() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

The value $x + 1$ is positive and $y - 2$ is negative.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;

        let range = ranges
            .iter()
            .find(|r| {
                let raw = &text[r.start_byte..r.end_byte];
                raw.contains("value") && raw.contains("positive")
            })
            .expect("Should have a range containing the sentence");

        let clean = range.extract_text(text);
        assert!(
            !clean.contains("x + 1"),
            "extract_text should not contain inline math, got: {clean:?}"
        );
        assert!(
            !clean.contains("y - 2"),
            "extract_text should not contain second inline math, got: {clean:?}"
        );
        assert!(
            clean.contains("value"),
            "extract_text should preserve prose, got: {clean:?}"
        );
        assert!(
            clean.contains("positive"),
            "extract_text should preserve prose after math, got: {clean:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_paren_math_excluded_from_text() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

We define \(f(x) = x^2\) for all reals.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;

        let range = ranges
            .iter()
            .find(|r| {
                let raw = &text[r.start_byte..r.end_byte];
                raw.contains("define") && raw.contains("reals")
            })
            .expect("Should have a range containing the sentence");

        let clean = range.extract_text(text);
        assert!(
            !clean.contains("f(x)"),
            "extract_text should not contain \\(...\\) math, got: {clean:?}"
        );
        assert!(
            clean.contains("define"),
            "extract_text should preserve prose, got: {clean:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_command_excluded_from_text() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

The \textsc{Foo} method solves \textbf{bar} problems.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;

        let range = ranges
            .iter()
            .find(|r| {
                let raw = &text[r.start_byte..r.end_byte];
                raw.contains("method") && raw.contains("solves")
            })
            .expect("Should have a range containing the sentence");

        let clean = range.extract_text(text);
        assert!(
            !clean.contains("\\textsc"),
            "extract_text should not contain \\textsc command, got: {clean:?}"
        );
        assert!(
            !clean.contains("\\textbf"),
            "extract_text should not contain \\textbf command, got: {clean:?}"
        );
        // The word content inside the braces is also excluded (command + args),
        // so Foo and bar should be blanked too
        assert!(
            clean.contains("method"),
            "extract_text should preserve surrounding prose, got: {clean:?}"
        );
        assert!(
            clean.contains("solves"),
            "extract_text should preserve surrounding prose, got: {clean:?}"
        );

        Ok(())
    }

    #[test]
    fn test_latex_custom_skip_env() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

Text before custom env.

\begin{prooftree}
  Some proof tree content here.
\end{prooftree}

Text after custom env.

\end{document}
";
        // Without extra skip envs, prooftree content is extracted
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();
        assert!(
            extracted.iter().any(|t| t.contains("proof tree content")),
            "Without config, prooftree content should be extracted, got: {extracted:?}"
        );

        // With extra skip envs, prooftree content is skipped
        let extra = vec!["prooftree".to_string()];
        let extras = LatexExtras {
            skip_envs: &extra,
            ..LatexExtras::default()
        };
        let ranges = extractor.extract(text, "latex", &extras)?;
        let extracted: Vec<&str> = ranges
            .iter()
            .map(|r| &text[r.start_byte..r.end_byte])
            .collect();
        assert!(
            !extracted.iter().any(|t| t.contains("proof tree content")),
            "With config, prooftree content should be skipped, got: {extracted:?}"
        );
        assert!(
            extracted.iter().any(|t| t.contains("Text before")),
            "Prose before should still be extracted, got: {extracted:?}"
        );
        assert!(
            extracted.iter().any(|t| t.contains("Text after")),
            "Prose after should still be extracted, got: {extracted:?}"
        );

        Ok(())
    }

    #[test]
    fn test_texttt_content_not_extracted() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

Use the \texttt{myvar} variable in your code.

\end{document}
";
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;

        // The raw range bridges across \texttt{myvar}, but extract_text
        // should strip the command and its argument via gap exclusions.
        let range = ranges
            .iter()
            .find(|r| {
                let raw = &text[r.start_byte..r.end_byte];
                raw.contains("variable")
            })
            .expect("Should have a range containing surrounding prose");

        let clean = range.extract_text(text);
        assert!(
            !clean.contains("myvar"),
            "extract_text should not contain \\texttt argument, got: {clean:?}"
        );
        assert!(
            clean.contains("variable"),
            "extract_text should preserve surrounding prose, got: {clean:?}"
        );

        Ok(())
    }

    #[test]
    fn test_custom_skip_command() -> Result<()> {
        let language: tree_sitter::Language = codebook_tree_sitter_latex::LANGUAGE.into();
        let mut extractor = ProseExtractor::new(language)?;

        let text = r"\documentclass{article}
\begin{document}

The \codefont{badspeling} function works.

\end{document}
";
        // Without skip_commands, codefont content IS extracted as prose words
        let ranges = extractor.extract(text, "latex", &LatexExtras::default())?;
        let clean_texts: Vec<_> = ranges.iter().map(|r| r.extract_text(text)).collect();
        assert!(
            clean_texts.iter().any(|t| t.contains("badspeling")),
            "Without config, codefont content should appear in prose, got: {clean_texts:?}"
        );

        // With skip_commands, the word node inside \codefont is not collected,
        // and extract_text strips the gap command — so "badspeling" disappears.
        let skip_cmds = vec!["codefont".to_string()];
        let extras = LatexExtras {
            skip_commands: &skip_cmds,
            ..LatexExtras::default()
        };
        let ranges = extractor.extract(text, "latex", &extras)?;
        let range = ranges
            .iter()
            .find(|r| {
                let raw = &text[r.start_byte..r.end_byte];
                raw.contains("function works")
            })
            .expect("Should have a range with surrounding prose");

        let clean = range.extract_text(text);
        assert!(
            !clean.contains("badspeling"),
            "With config, codefont argument should not appear in extract_text, got: {clean:?}"
        );
        assert!(
            clean.contains("function works"),
            "Surrounding prose should be preserved, got: {clean:?}"
        );

        Ok(())
    }
}