rumdl 0.2.46

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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293

//! When more than one rumdl-native config file lives in the same directory, the
//! lower-precedence file is silently ignored. These tests pin the user-facing
//! warning that surfaces that collision, while resolution stays unchanged (the dot
//! file still wins, matching Ruff).

use std::fs;
use std::process::Command;
use tempfile::tempdir;

fn rumdl_bin() -> &'static str {
    env!("CARGO_BIN_EXE_rumdl")
}

/// `rumdl check` warns when both `.rumdl.toml` and `rumdl.toml` exist in the same
/// directory, naming the winner and the shadowed file.
#[test]
fn check_warns_when_dot_and_non_dot_config_coexist() {
    let dir = tempdir().unwrap();
    fs::write(dir.path().join(".rumdl.toml"), "line-length = 11\n").unwrap();
    fs::write(dir.path().join("rumdl.toml"), "line-length = 22\n").unwrap();
    fs::write(dir.path().join("test.md"), "# Title\n\nSome short body text here.\n").unwrap();

    let output = Command::new(rumdl_bin())
        .current_dir(dir.path())
        .args(["check", "--no-cache", "test.md"])
        .output()
        .unwrap();
    let stderr = String::from_utf8_lossy(&output.stderr);

    assert!(
        stderr.contains("multiple rumdl config files"),
        "expected a shadowed-config warning on stderr, got:\n{stderr}"
    );
    assert!(
        stderr.contains(".rumdl.toml") && stderr.contains("rumdl.toml"),
        "warning should name both the winner and the shadowed file, got:\n{stderr}"
    );
}

/// The dot file still wins: resolution is unchanged, only a warning is added.
#[test]
fn check_still_resolves_dot_config_as_winner() {
    let dir = tempdir().unwrap();
    // `.rumdl.toml` sets a tiny line length; `rumdl.toml` a large one. If the dot
    // file wins, the long line is flagged against length 11.
    fs::write(dir.path().join(".rumdl.toml"), "line-length = 11\n").unwrap();
    fs::write(dir.path().join("rumdl.toml"), "line-length = 200\n").unwrap();
    fs::write(
        dir.path().join("test.md"),
        "# Title\n\nThis line is definitely longer than eleven characters.\n",
    )
    .unwrap();

    let output = Command::new(rumdl_bin())
        .current_dir(dir.path())
        .args(["check", "--no-cache", "test.md"])
        .output()
        .unwrap();
    let stdout = String::from_utf8_lossy(&output.stdout);

    assert!(
        stdout.contains("MD013"),
        "the dot config (line-length = 11) must win, flagging MD013, got:\n{stdout}"
    );
}

/// A single config file must NOT trigger the shadow warning.
#[test]
fn check_does_not_warn_for_a_single_config() {
    let dir = tempdir().unwrap();
    fs::write(dir.path().join("rumdl.toml"), "line-length = 80\n").unwrap();
    fs::write(dir.path().join("test.md"), "# Title\n\nShort body.\n").unwrap();

    let output = Command::new(rumdl_bin())
        .current_dir(dir.path())
        .args(["check", "--no-cache", "test.md"])
        .output()
        .unwrap();
    let stderr = String::from_utf8_lossy(&output.stderr);

    assert!(
        !stderr.contains("multiple rumdl config files"),
        "a single config must not warn, got:\n{stderr}"
    );
}

/// `--silent` suppresses the shadow warning, like other config warnings.
#[test]
fn check_silent_suppresses_the_shadow_warning() {
    let dir = tempdir().unwrap();
    fs::write(dir.path().join(".rumdl.toml"), "line-length = 80\n").unwrap();
    fs::write(dir.path().join("rumdl.toml"), "line-length = 80\n").unwrap();
    fs::write(dir.path().join("test.md"), "# Title\n\nShort body.\n").unwrap();

    let output = Command::new(rumdl_bin())
        .current_dir(dir.path())
        .args(["check", "--no-cache", "--silent", "test.md"])
        .output()
        .unwrap();
    let stderr = String::from_utf8_lossy(&output.stderr);

    assert!(
        !stderr.contains("multiple rumdl config files"),
        "--silent must suppress the shadow warning, got:\n{stderr}"
    );
}

/// `rumdl config` also surfaces the shadow warning so `config file` / `config`
/// users see which file is winning.
#[test]
fn config_command_warns_when_configs_shadow() {
    let dir = tempdir().unwrap();
    fs::write(dir.path().join(".rumdl.toml"), "line-length = 11\n").unwrap();
    fs::write(dir.path().join("rumdl.toml"), "line-length = 22\n").unwrap();

    let output = Command::new(rumdl_bin())
        .current_dir(dir.path())
        .args(["config"])
        .output()
        .unwrap();
    let stderr = String::from_utf8_lossy(&output.stderr);

    assert!(
        stderr.contains("multiple rumdl config files"),
        "`rumdl config` should warn about shadowed configs on stderr, got:\n{stderr}"
    );
}

/// `rumdl config file` keeps stdout to the winning path (so it stays pipeable) and
/// emits the shadow warning on stderr.
#[test]
fn config_file_warns_on_stderr_keeping_stdout_clean() {
    let dir = tempdir().unwrap();
    fs::write(dir.path().join(".rumdl.toml"), "line-length = 11\n").unwrap();
    fs::write(dir.path().join("rumdl.toml"), "line-length = 22\n").unwrap();

    let output = Command::new(rumdl_bin())
        .current_dir(dir.path())
        .args(["config", "file"])
        .output()
        .unwrap();
    let stdout = String::from_utf8_lossy(&output.stdout);
    let stderr = String::from_utf8_lossy(&output.stderr);

    // stdout must be exactly the winning path (one line, no warning bleed) so it
    // stays pipeable.
    let stdout_lines: Vec<&str> = stdout.lines().collect();
    assert_eq!(
        stdout_lines.len(),
        1,
        "stdout should be a single path line, got:\n{stdout}"
    );
    assert!(
        stdout_lines[0].ends_with(".rumdl.toml"),
        "stdout should be the winning `.rumdl.toml` path, got:\n{stdout}"
    );
    assert!(
        stderr.contains("multiple rumdl config files"),
        "stderr should carry the shadow warning, got:\n{stderr}"
    );
}

/// A `pyproject.toml` with `[tool.rumdl]` alongside a `.rumdl.toml` is a real
/// collision: the dedicated file wins and pyproject is named as shadowed.
#[test]
fn check_warns_when_pyproject_shadows_dedicated_config() {
    let dir = tempdir().unwrap();
    fs::write(dir.path().join(".rumdl.toml"), "line-length = 11\n").unwrap();
    fs::write(dir.path().join("pyproject.toml"), "[tool.rumdl]\nline-length = 80\n").unwrap();
    fs::write(dir.path().join("test.md"), "# Title\n\nShort body.\n").unwrap();

    let output = Command::new(rumdl_bin())
        .current_dir(dir.path())
        .args(["check", "--no-cache", "test.md"])
        .output()
        .unwrap();
    let stderr = String::from_utf8_lossy(&output.stderr);

    assert!(
        stderr.contains("multiple rumdl config files"),
        "a [tool.rumdl] pyproject next to .rumdl.toml should warn, got:\n{stderr}"
    );
    assert!(
        stderr.contains("pyproject.toml"),
        "the warning should name the shadowed pyproject.toml, got:\n{stderr}"
    );
}

/// A `pyproject.toml` WITHOUT a `[tool.rumdl]` section is not a rumdl config source,
/// so it must NOT trigger a shadow warning next to a `.rumdl.toml`.
#[test]
fn check_does_not_warn_for_pyproject_without_tool_rumdl() {
    let dir = tempdir().unwrap();
    fs::write(dir.path().join(".rumdl.toml"), "line-length = 80\n").unwrap();
    fs::write(dir.path().join("pyproject.toml"), "[tool.black]\nline-length = 88\n").unwrap();
    fs::write(dir.path().join("test.md"), "# Title\n\nShort body.\n").unwrap();

    let output = Command::new(rumdl_bin())
        .current_dir(dir.path())
        .args(["check", "--no-cache", "test.md"])
        .output()
        .unwrap();
    let stderr = String::from_utf8_lossy(&output.stderr);

    assert!(
        !stderr.contains("multiple rumdl config files"),
        "a pyproject.toml without [tool.rumdl] must not count as a rumdl config, got:\n{stderr}"
    );
}

/// An explicit `--config <path>` is standalone: discovery is skipped, so no shadow
/// warning fires even when sibling configs exist on disk.
#[test]
fn explicit_config_does_not_trigger_shadow_warning() {
    let dir = tempdir().unwrap();
    fs::write(dir.path().join(".rumdl.toml"), "line-length = 11\n").unwrap();
    fs::write(dir.path().join("rumdl.toml"), "line-length = 22\n").unwrap();
    fs::write(dir.path().join("test.md"), "# Title\n\nShort body.\n").unwrap();

    let output = Command::new(rumdl_bin())
        .current_dir(dir.path())
        .args(["check", "--no-cache", "--config", "rumdl.toml", "test.md"])
        .output()
        .unwrap();
    let stderr = String::from_utf8_lossy(&output.stderr);

    assert!(
        !stderr.contains("multiple rumdl config files"),
        "explicit --config is standalone and must not warn about shadowing, got:\n{stderr}"
    );
}

/// The warning comes from config loading, which happens before the lint cache is
/// consulted, so it must still appear on a second run that hits a warm cache - not
/// only on the first cold run. Guards against the warning being hidden behind
/// cached lint results.
#[test]
fn check_warns_even_with_a_warm_cache() {
    let dir = tempdir().unwrap();
    fs::write(dir.path().join(".rumdl.toml"), "line-length = 80\n").unwrap();
    fs::write(dir.path().join("rumdl.toml"), "line-length = 80\n").unwrap();
    fs::write(dir.path().join("test.md"), "# Title\n\nShort body.\n").unwrap();

    // Caching is ON (no --no-cache); an isolated cache dir keeps the run hermetic.
    let cache_dir = dir.path().join("cache");
    let run = || {
        Command::new(rumdl_bin())
            .current_dir(dir.path())
            .env("RUMDL_CACHE_DIR", &cache_dir)
            .args(["check", "test.md"])
            .output()
            .unwrap()
    };

    let cold = run();
    let warm = run();
    let cold_err = String::from_utf8_lossy(&cold.stderr);
    let warm_err = String::from_utf8_lossy(&warm.stderr);

    assert!(
        cold_err.contains("multiple rumdl config files"),
        "cold run should warn, got:\n{cold_err}"
    );
    assert!(
        warm_err.contains("multiple rumdl config files"),
        "warm-cache run must still warn (warning precedes the cache lookup), got:\n{warm_err}"
    );
}

/// Discovery walks upward: a collision in a parent directory must warn when running
/// from a subdirectory that has no config of its own.
#[test]
fn check_warns_for_shadow_in_a_parent_directory() {
    let dir = tempdir().unwrap();
    fs::create_dir_all(dir.path().join(".git")).unwrap(); // project-root boundary
    fs::write(dir.path().join(".rumdl.toml"), "line-length = 80\n").unwrap();
    fs::write(dir.path().join("rumdl.toml"), "line-length = 80\n").unwrap();
    let sub = dir.path().join("sub");
    fs::create_dir_all(&sub).unwrap();
    fs::write(sub.join("test.md"), "# Title\n\nShort body.\n").unwrap();

    let output = Command::new(rumdl_bin())
        .current_dir(&sub)
        .args(["check", "--no-cache", "test.md"])
        .output()
        .unwrap();
    let stderr = String::from_utf8_lossy(&output.stderr);

    assert!(
        stderr.contains("multiple rumdl config files"),
        "a collision in the parent directory should warn from a subdir, got:\n{stderr}"
    );
}