badness 0.12.0

A language server, formatter, and linter for LaTeX
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

//! Differential parse oracle — the **hard acceptance gate** (runs in `cargo test`).
//!
//! A one-way soundness check. For every
//! curated corpus file that *badness itself parses cleanly* (no syntax errors), the
//! external reference parser (texlab) must also parse it without an `ERROR` node. We
//! never compare tree shapes here — that is the soft `parse_compat.rs` gauge's job
//! (badness's generic CST and texlab's semantic CST are not meant to match).
//!
//! Scope is the *curated* `tests/corpus/*.tex` (inputs expected to be clean on both
//! parsers), so this stays a true green regression guard. A clean corpus file that
//! legitimately trips texlab should be recorded, not papered over by weakening the
//! gate.

#[path = "support/parse_skeleton.rs"]
mod parse_skeleton;

use std::fs;
use std::path::Path;

use badness::parser::parse;
use parse_skeleton::texlab_has_error;

/// Corpus files badness legitimately parses cleanly but texlab cannot, each with
/// the modeled feature texlab lacks. Recorded here per the module contract above
/// rather than weakening the gate.
const TEXLAB_KNOWN_DIVERGENT: &[&str] = &[
    // doc's `\MakeShortVerb{\|}` short verbs: `|}|` and `|\begin{document}|` are
    // opaque VERB spans for badness (issue #57), unmatched braces for texlab.
    "doc_shortverb.tex",
    // TeX char-constant backtick notation (issue #60): `` \char`$ ``/`` \char`} ``
    // are plain data for badness, an unclosed math opener and an unmatched brace
    // for texlab.
    "char_constant.tex",
];

#[test]
fn texlab_accepts_badness_clean_corpus() {
    let dir = Path::new(env!("CARGO_MANIFEST_DIR"))
        .join("tests")
        .join("corpus");

    let mut checked = 0usize;
    for entry in fs::read_dir(&dir).expect("read corpus dir") {
        let path = entry.expect("dir entry").path();
        if path.extension().and_then(|e| e.to_str()) != Some("tex") {
            continue;
        }
        let text = fs::read_to_string(&path).expect("read corpus file");

        // Only assert on inputs badness accepts cleanly (mirrors air_parser_harness).
        if !parse(&text).errors.is_empty() {
            continue;
        }

        let name = path.file_name().unwrap().to_string_lossy();
        if TEXLAB_KNOWN_DIVERGENT.contains(&name.as_ref()) {
            continue;
        }
        assert!(
            !texlab_has_error(&text),
            "texlab reported a parse error for badness-clean corpus file `{name}`"
        );
        checked += 1;
    }

    assert!(checked > 0, "no clean corpus files were checked");
}