mdwright-lint 0.1.2

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
54
55
56
57
58
59
60
61

//! Mixed `-` / `*` / `+` markers within one bullet list.
//!
//! Pick one and stick to it. Mixed markers look like a stale merge
//! and confuse renderers that re-emit the list with a normalised
//! marker. Ordered lists are not flagged — their markers are digits
//! and have semantic meaning.

use crate::diagnostic::{Diagnostic, Fix};
use crate::rule::LintRule;
use mdwright_document::Document;

pub struct InconsistentListMarker;

impl LintRule for InconsistentListMarker {
    fn name(&self) -> &str {
        "inconsistent-list-marker"
    }

    fn description(&self) -> &str {
        "Mixed `-` / `*` / `+` markers in one bullet list."
    }

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

    fn produces_fix(&self) -> bool {
        true
    }

    fn check(&self, doc: &Document, out: &mut Vec<Diagnostic>) {
        for group in doc.list_groups() {
            if group.ordered || group.items.is_empty() {
                continue;
            }
            let Some(first) = group.items.first() else {
                continue;
            };
            let expected = first.marker_byte;
            for item in group.items.iter().skip(1) {
                if item.marker_byte != expected {
                    let actual = item.marker_byte as char;
                    let expected_c = expected as char;
                    let message = format!(
                        "list marker `{actual}` does not match first item's `{expected_c}` \
                         — keep one marker per list"
                    );
                    let start = item.raw_range.start;
                    let local = 0..1;
                    let fix = Some(Fix {
                        replacement: expected_c.to_string(),
                        safe: true,
                    });
                    if let Some(d) = Diagnostic::at(doc, start, local, message, fix) {
                        out.push(d);
                    }
                }
            }
        }
    }
}