mdwright-lint 0.1.1

Lint diagnostics, rule execution, suppressions, and standard rules for mdwright
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

//! `math/unbalanced-delim` — TeX-style math opener with no matching
//! close.
//!
//! Mdwright recognises `\[ … \]`, `\( … \)`, `$$ … $$`, and `$ … $`.
//! An open delimiter with no matching close is almost always a typo
//! or a copy-paste accident: the rest of the document collapses into
//! "math content" in the author's mental model, but pulldown-cmark
//! parses it as prose and the document renders badly.
//!
//! Companion rule [`super::math_unbalanced_env::MathUnbalancedEnv`]
//! covers `\begin{env}` / `\end{env}` imbalance.

use crate::diagnostic::Diagnostic;
use crate::rule::LintRule;
use mdwright_document::Document;
use mdwright_document::MathError;

pub struct MathUnbalancedDelim;

impl LintRule for MathUnbalancedDelim {
    fn name(&self) -> &str {
        "math/unbalanced-delim"
    }

    fn description(&self) -> &str {
        "TeX-style math open delimiter (`\\[`, `\\(`, `$$`, `$`) with no matching close."
    }

    fn explain(&self) -> &str {
        include_str!("explain/math__unbalanced_delim.md")
    }

    fn check(&self, doc: &Document, out: &mut Vec<Diagnostic>) {
        for err in doc.math_errors() {
            let MathError::UnbalancedDelim { delim, range } = err else {
                continue;
            };
            let open_lit = delim.open();
            let close_lit = delim.close();
            let flavour = if delim.is_display() {
                "display-math"
            } else {
                "inline-math"
            };
            let message = format!(
                "unbalanced {flavour} `{open_lit}` — no matching `{close_lit}` before end of document or next code/HTML block"
            );
            if let Some(d) = Diagnostic::at(doc, 0, range.clone(), message, None) {
                out.push(d);
            }
        }
    }
}