rumdl 0.1.88

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
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

use assert_cmd::cargo::cargo_bin_cmd;
use predicates::prelude::*;
use std::fs;
use tempfile::tempdir;

#[test]
fn test_grouped_output_format() {
    let temp_dir = tempdir().unwrap();
    let test_file = temp_dir.path().join("test.md");

    let content = format!(
        r#"# Heading
Content with trailing space{}
*Emphasis without space*
"#,
        "   "
    ); // Add trailing spaces programmatically

    fs::write(&test_file, content).unwrap();

    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.arg("check")
        .arg("--output-format")
        .arg("grouped")
        .arg(test_file.to_str().unwrap());

    cmd.assert()
        .failure()
        .stdout(predicate::str::contains("test.md:"))
        .stdout(predicate::str::contains("MD022:")) // heading blank line
        .stdout(predicate::str::contains("MD009:")); // trailing space
}

#[test]
fn test_pylint_output_format() {
    let temp_dir = tempdir().unwrap();
    let test_file = temp_dir.path().join("test.md");

    let content = format!(
        r#"# Heading
Content with trailing space{}
"#,
        "   "
    ); // Add trailing spaces programmatically

    fs::write(&test_file, content).unwrap();

    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.arg("check")
        .arg("--output-format")
        .arg("pylint")
        .arg(test_file.to_str().unwrap());

    cmd.assert()
        .failure()
        .stdout(predicate::str::contains(":1:1: [CMD022]"))
        .stdout(predicate::str::contains(":2:28: [CMD009]"));
}

#[test]
fn test_azure_output_format() {
    let temp_dir = tempdir().unwrap();
    let test_file = temp_dir.path().join("test.md");

    let content = format!(
        r#"# Heading
Content with trailing space{}
"#,
        "   "
    ); // Add trailing spaces programmatically

    fs::write(&test_file, content).unwrap();

    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.arg("check")
        .arg("--output-format")
        .arg("azure")
        .arg(test_file.to_str().unwrap());

    cmd.assert()
        .failure()
        .stdout(predicate::str::contains("##vso[task.logissue type=warning;sourcepath="))
        .stdout(predicate::str::contains("code=MD009]"))
        .stdout(predicate::str::contains("code=MD022]"));
}

#[test]
fn test_rumdl_output_format_env_var() {
    let temp_dir = tempdir().unwrap();
    let test_file = temp_dir.path().join("test.md");

    let content = format!(
        r#"# Heading
Content with trailing space{}
"#,
        "   "
    );

    fs::write(&test_file, content).unwrap();

    // Test that RUMDL_OUTPUT_FORMAT env var is respected
    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.env("RUMDL_OUTPUT_FORMAT", "github")
        .arg("check")
        .arg(test_file.to_str().unwrap());

    // GitHub format uses ::warning:: annotations
    cmd.assert()
        .failure()
        .stdout(predicate::str::contains("::warning file="));
}

#[test]
fn test_rumdl_output_format_env_var_cli_override() {
    let temp_dir = tempdir().unwrap();
    let test_file = temp_dir.path().join("test.md");

    let content = format!(
        r#"# Heading
Content with trailing space{}
"#,
        "   "
    );

    fs::write(&test_file, content).unwrap();

    // CLI flag should override env var
    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.env("RUMDL_OUTPUT_FORMAT", "github")
        .arg("check")
        .arg("--output-format")
        .arg("azure")
        .arg(test_file.to_str().unwrap());

    // Should use azure format from CLI, not github from env var
    cmd.assert()
        .failure()
        .stdout(predicate::str::contains("##vso[task.logissue type=warning;"));
}

#[test]
fn test_rumdl_output_format_env_var_overrides_config() {
    let temp_dir = tempdir().unwrap();
    let test_file = temp_dir.path().join("test.md");
    let config_file = temp_dir.path().join(".rumdl.toml");

    let config_content = r#"[global]
output-format = "pylint"
"#;

    let md_content = format!(
        r#"# Heading
Content with trailing space{}
"#,
        "   "
    );

    fs::write(&test_file, md_content).unwrap();
    fs::write(&config_file, config_content).unwrap();

    // Env var should override config file
    let mut cmd = cargo_bin_cmd!("rumdl");
    cmd.current_dir(&temp_dir)
        .env("RUMDL_OUTPUT_FORMAT", "azure")
        .arg("check")
        .arg("test.md");

    // Should use azure format from env var, not pylint from config
    cmd.assert()
        .failure()
        .stdout(predicate::str::contains("##vso[task.logissue type=warning;"));
}