badness 0.7.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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

//! End-to-end test that the CLI formatter pulls a local package's signatures into
//! scope: a package-defined environment's arity changes how its `\begin` arguments
//! are laid out. Exercises `format_file_with_packages` → `DiskPackageSource` →
//! `collect_package_signatures` → the formatter's environment-arity lowering.

use std::fs;

use badness::formatter::{FormatStyle, format_file_with_packages, format_with_style_flavored};
use badness::parser::LatexFlavor;

const DOC: &str = "\\usepackage{mypkg}\n\\begin{myenv}\n{x}\nbody text here\n\\end{myenv}\n";

#[test]
fn local_package_environment_arity_glues_begin_argument() {
    let dir = tempfile::tempdir().unwrap();
    // A package defining a one-argument environment, alongside the document.
    fs::write(
        dir.path().join("mypkg.sty"),
        "\\newenvironment{myenv}[1]{start #1}{end}\n",
    )
    .unwrap();
    let main = dir.path().join("main.tex");

    let with_pkg =
        format_file_with_packages(DOC, &main, FormatStyle::default(), LatexFlavor::Document)
            .expect("formats cleanly");

    // Knowing `myenv` takes one argument, the formatter glues `{x}` onto the
    // `\begin{myenv}` line (the header break is dropped).
    assert!(
        with_pkg.contains("\\begin{myenv}{x}"),
        "expected the package arity to glue the argument, got:\n{with_pkg}"
    );

    // Without the package on disk, `myenv` is unknown (arity 0), so the argument is
    // not glued — the two outputs differ, proving the package drove the change.
    let without_pkg =
        format_with_style_flavored(DOC, FormatStyle::default(), LatexFlavor::Document)
            .expect("formats cleanly");
    assert!(!without_pkg.contains("\\begin{myenv}{x}"));
    assert_ne!(with_pkg, without_pkg);
}

#[test]
fn format_never_reads_the_aux_file() {
    // Hermeticism guard (the `.aux` analog of the TEXMF guard in
    // `semantic::load`): the compile's `.aux` feeds LSP label hover and document
    // symbols only. `badness format` output must be byte-identical whether or not
    // a sibling `.aux` exists — otherwise formatting would depend on whether the
    // user last compiled, breaking the deterministic-formatting tenet.
    let dir = tempfile::tempdir().unwrap();
    let main = dir.path().join("main.tex");
    let doc = "\\section{Intro}\n\\label{sec:a}\nSee \\ref{sec:a}.\n";

    let without_aux =
        format_file_with_packages(doc, &main, FormatStyle::default(), LatexFlavor::Document)
            .expect("formats cleanly");
    fs::write(
        dir.path().join("main.aux"),
        "\\newlabel{sec:a}{{1}{1}{Intro}{section.1}{}}\n",
    )
    .unwrap();
    let with_aux =
        format_file_with_packages(doc, &main, FormatStyle::default(), LatexFlavor::Document)
            .expect("formats cleanly");
    assert_eq!(
        without_aux, with_aux,
        "the formatter must not read the .aux file"
    );
}

#[test]
fn formatting_is_idempotent_with_packages() {
    let dir = tempfile::tempdir().unwrap();
    fs::write(
        dir.path().join("mypkg.sty"),
        "\\newenvironment{myenv}[1]{start #1}{end}\n",
    )
    .unwrap();
    let main = dir.path().join("main.tex");

    let once = format_file_with_packages(DOC, &main, FormatStyle::default(), LatexFlavor::Document)
        .expect("formats cleanly");
    let twice =
        format_file_with_packages(&once, &main, FormatStyle::default(), LatexFlavor::Document)
            .expect("formats cleanly");
    assert_eq!(once, twice, "format must be idempotent");
}