markdownlint-rs 0.3.15

A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files
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

use mdlint::config::Config;
use mdlint::fix::Fixer;
use mdlint::formatter;
use mdlint::lint::LintEngine;
use std::fs;

// ── Helpers ──────────────────────────────────────────────────────────────────

fn fixture(path: &str) -> String {
    let full = format!("tests/fixtures/{path}");
    fs::read_to_string(&full).unwrap_or_else(|e| panic!("cannot read fixture {full}: {e}"))
}

fn all_rules_engine() -> LintEngine {
    LintEngine::new(Config {
        default_enabled: true,
        ..Config::default()
    })
}

// ── Format workflow tests ─────────────────────────────────────────────────────

#[test]
fn format_produces_expected_output() {
    let input = fixture("format/input.md");
    let expected = fixture("format/expected.md");
    let got = formatter::format(&input);
    assert_eq!(got, expected, "formatter output did not match golden file");
}

#[test]
fn format_is_idempotent_on_expected() {
    let expected = fixture("format/expected.md");
    let twice = formatter::format(&expected);
    assert_eq!(
        expected, twice,
        "formatting the already-formatted file produced different output"
    );
}

#[test]
fn format_empty_string_is_empty() {
    assert_eq!(formatter::format(""), "");
}

#[test]
fn format_whitespace_only_is_empty() {
    assert_eq!(formatter::format("   \n\n  \t\n"), "");
}

// ── Check workflow tests ──────────────────────────────────────────────────────

#[test]
fn check_detects_heading_level_skip() {
    let content = fixture("check/violations.md");
    let engine = all_rules_engine();
    let violations = engine.lint_content(&content).unwrap();
    assert!(
        violations.iter().any(|v| v.rule == "MD001"),
        "MD001 (heading level skip) should fire; got: {violations:?}"
    );
}

#[test]
fn check_detects_trailing_spaces() {
    // Use inline content so trailing spaces aren't stripped by the editor
    let content = "# Heading\n\nSome text   \nMore text\n";
    let engine = all_rules_engine();
    let violations = engine.lint_content(content).unwrap();
    assert!(
        violations.iter().any(|v| v.rule == "MD009"),
        "MD009 (trailing spaces) should fire; got: {violations:?}"
    );
}

#[test]
fn check_fix_removes_trailing_spaces() {
    let content = "# Heading\n\nSome text   \nMore text\n";
    let engine = all_rules_engine();
    let violations = engine.lint_content(content).unwrap();
    let fixes: Vec<_> = violations.iter().filter_map(|v| v.fix.clone()).collect();
    assert!(!fixes.is_empty(), "MD009 should produce an inline fix");
    let fixed = Fixer::new()
        .apply_fixes_to_content(content, &fixes)
        .unwrap();
    assert_eq!(fixed, "# Heading\n\nSome text\nMore text\n");
}

#[test]
fn check_detects_hard_tabs() {
    let content = fixture("check/violations.md");
    let engine = all_rules_engine();
    let violations = engine.lint_content(&content).unwrap();
    assert!(
        violations.iter().any(|v| v.rule == "MD010"),
        "MD010 (hard tabs) should fire; got: {violations:?}"
    );
}

#[test]
fn check_fix_replaces_hard_tabs() {
    let content = "# Heading\n\n\tTabbed line\n";
    let engine = all_rules_engine();
    let violations = engine.lint_content(content).unwrap();
    let fixes: Vec<_> = violations.iter().filter_map(|v| v.fix.clone()).collect();
    assert!(!fixes.is_empty(), "MD010 should produce an inline fix");
    let fixed = Fixer::new()
        .apply_fixes_to_content(content, &fixes)
        .unwrap();
    assert!(!fixed.contains('\t'), "tabs should be replaced after fix");
}

#[test]
fn check_clean_file_has_no_violations() {
    let content = fixture("format/expected.md");
    let engine = LintEngine::new(Config {
        default_enabled: true,
        rules: {
            // MD041 requires a top-level heading — our fixture has one, but MD013
            // line length and other cosmetic rules might fire; only disable none.
            std::collections::HashMap::new()
        },
        ..Config::default()
    });
    let violations = engine.lint_content(&content).unwrap();
    // Only allow violations that are expected (none for a well-formed file)
    // Filter out MD041 if the expected.md doesn't start with a top-level heading
    let non_trivial: Vec<_> = violations
        .iter()
        .filter(|v| !matches!(v.rule.as_str(), "MD013" | "MD043"))
        .collect();
    assert!(
        non_trivial.is_empty(),
        "formatted file should have no violations (except MD013/MD043): {non_trivial:?}"
    );
}