rumdl 0.1.70

A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)
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

use assert_cmd::cargo::cargo_bin_cmd;
use predicates::prelude::*;

#[test]
fn test_explain_command_with_valid_rule() {
    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.arg("explain").arg("MD045");

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("MD045 - Images should have alternate text"))
        .stdout(predicate::str::contains("What this rule does"))
        .stdout(predicate::str::contains("Examples"))
        .stdout(predicate::str::contains("Configuration"))
        .stdout(predicate::str::contains("Default Configuration:"));
}

#[test]
fn test_explain_command_with_lowercase_rule() {
    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.arg("explain").arg("md045");

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("MD045 - Images should have alternate text"));
}

#[test]
fn test_explain_command_without_md_prefix() {
    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.arg("explain").arg("045");

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("MD045 - Images should have alternate text"));
}

#[test]
fn test_explain_command_with_invalid_rule() {
    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.arg("explain").arg("MD999");

    cmd.assert()
        .failure()
        .stderr(predicate::str::contains("Error: Rule 'MD999' not found"))
        .stderr(predicate::str::contains("Use 'rumdl rule' to see all available rules"));
}

#[test]
fn test_explain_command_without_argument() {
    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.arg("explain");

    cmd.assert()
        .failure()
        .stderr(predicate::str::contains("required arguments were not provided"));
}

#[test]
fn test_explain_command_shows_configuration() {
    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.arg("explain").arg("MD013");

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("MD013 - Line length"))
        .stdout(predicate::str::contains("[MD013]"))
        .stdout(predicate::str::contains("line-length = "));
}

#[test]
fn test_explain_command_rule_with_no_config() {
    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.arg("explain").arg("MD001");

    cmd.assert().success().stdout(predicate::str::contains(
        "MD001 - Heading levels should only increment by one level at a time",
    ));
}

#[test]
fn test_explain_command_shows_examples() {
    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.arg("explain").arg("MD032");

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("✅ Correct"))
        .stdout(predicate::str::contains("❌ Incorrect"))
        .stdout(predicate::str::contains("🔧 Fixed"));
}

#[test]
fn test_explain_command_different_rules() {
    // Test a few different rules to ensure the command works for various rule types
    let rules = vec!["MD001", "MD013", "MD022", "MD045", "MD058"];

    for rule in rules {
        let mut cmd = cargo_bin_cmd!("rumdl");
        cmd.arg("explain").arg(rule);

        cmd.assert().success().stdout(predicate::str::contains(rule));
    }
}