rumdl 0.2.62

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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
//! Integration tests for NUL-framed multi-document stdin.

use std::fs;
use std::io::Write;
use std::path::Path;
use std::process::{Command, Output, Stdio};

fn run_batch(dir: &Path, input: &[u8], args: &[&str]) -> Output {
    let mut child = Command::new(env!("CARGO_BIN_EXE_rumdl"))
        .current_dir(dir)
        .args(args)
        .stdin(Stdio::piped())
        .stdout(Stdio::piped())
        .stderr(Stdio::piped())
        .spawn()
        .expect("failed to execute rumdl");

    child
        .stdin
        .as_mut()
        .expect("stdin must be piped")
        .write_all(input)
        .expect("failed to write batch stdin");

    child.wait_with_output().expect("failed to collect rumdl output")
}

#[test]
fn stdin_batch_lints_every_supplied_document() {
    let temp = tempfile::tempdir().unwrap();
    let input = b"docs/a.md\0# A\n\n### Skipped level\n\0docs/b.md\0# B\n\n### Skipped level\n\0";

    let output = run_batch(
        temp.path(),
        input,
        &["check", "--stdin-batch", "--no-cache", "--enable", "MD001", "--quiet"],
    );
    let stdout = String::from_utf8_lossy(&output.stdout).replace("\r\n", "\n");
    let stderr = String::from_utf8_lossy(&output.stderr).replace("\r\n", "\n");

    assert_eq!(output.status.code(), Some(1), "stdout:\n{stdout}\nstderr:\n{stderr}");
    assert!(
        stdout.contains("docs/a.md:3:1") && stdout.contains("docs/b.md:3:1"),
        "each supplied path must receive its own diagnostic.\nstdout:\n{stdout}\nstderr:\n{stderr}"
    );
    assert_eq!(
        stdout.matches("MD001").count(),
        2,
        "stdout:\n{stdout}\nstderr:\n{stderr}"
    );
    assert!(stderr.is_empty(), "unexpected stderr:\n{stderr}");
}

#[test]
fn stdin_batch_cross_file_checks_use_supplied_content() {
    let temp = tempfile::tempdir().unwrap();
    fs::create_dir(temp.path().join("docs")).unwrap();
    fs::write(temp.path().join("docs/b.md"), "# Disk version\n\n## Disk heading\n").unwrap();

    let input = b"docs/a.md\0# A\n\n[valid](b.md#batch-heading)\n\n[invalid](b.md#disk-heading)\n\0docs/b.md\0# Batch version\n\n## Batch heading\n\0";
    let output = run_batch(
        temp.path(),
        input,
        &["check", "--stdin-batch", "--no-cache", "--enable", "MD051", "--quiet"],
    );
    let stdout = String::from_utf8_lossy(&output.stdout).replace("\r\n", "\n");
    let stderr = String::from_utf8_lossy(&output.stderr).replace("\r\n", "\n");

    assert_eq!(output.status.code(), Some(1), "stdout:\n{stdout}\nstderr:\n{stderr}");
    assert!(
        stdout.contains("Link fragment 'disk-heading' not found in 'b.md'"),
        "the on-disk-only heading must be rejected.\nstdout:\n{stdout}\nstderr:\n{stderr}"
    );
    assert!(
        !stdout.contains("'batch-heading'"),
        "the supplied heading must resolve.\nstdout:\n{stdout}\nstderr:\n{stderr}"
    );
    assert!(stderr.is_empty(), "unexpected stderr:\n{stderr}");
}

#[test]
fn stdin_batch_falls_back_to_disk_for_unsupplied_documents() {
    let temp = tempfile::tempdir().unwrap();
    fs::create_dir(temp.path().join("docs")).unwrap();
    fs::write(temp.path().join("docs/b.md"), "# Disk target\n\n## Real heading\n").unwrap();

    let input = b"docs/a.md\0# A\n\n[valid](b.md#real-heading)\n\n[invalid](b.md#missing-heading)\n\0";
    let output = run_batch(
        temp.path(),
        input,
        &["check", "--stdin-batch", "--no-cache", "--enable", "MD051", "--quiet"],
    );
    let stdout = String::from_utf8_lossy(&output.stdout).replace("\r\n", "\n");
    let stderr = String::from_utf8_lossy(&output.stderr).replace("\r\n", "\n");

    assert_eq!(output.status.code(), Some(1), "stdout:\n{stdout}\nstderr:\n{stderr}");
    assert!(
        stdout.contains("Link fragment 'missing-heading' not found in 'b.md'"),
        "an unsupplied target must be indexed from disk.\nstdout:\n{stdout}\nstderr:\n{stderr}"
    );
    assert!(
        !stdout.contains("'real-heading'"),
        "the real on-disk heading must resolve.\nstdout:\n{stdout}\nstderr:\n{stderr}"
    );
    assert!(stderr.is_empty(), "unexpected stderr:\n{stderr}");
}

#[test]
fn stdin_batch_treats_supplied_documents_as_existing_link_targets() {
    let temp = tempfile::tempdir().unwrap();
    fs::create_dir(temp.path().join("docs")).unwrap();
    // An existing source canonicalizes to an absolute base path inside MD057;
    // the unsaved target still has to match its supplied relative identity.
    fs::write(temp.path().join("docs/a.md"), "# Saved A\n").unwrap();
    let input = b"docs/a.md\0# A\n\n[batch target](b.md)\n\0docs/b.md\0# B\n\0";

    let output = run_batch(
        temp.path(),
        input,
        &["check", "--stdin-batch", "--no-cache", "--enable", "MD057", "--quiet"],
    );
    let stdout = String::from_utf8_lossy(&output.stdout).replace("\r\n", "\n");
    let stderr = String::from_utf8_lossy(&output.stderr).replace("\r\n", "\n");

    assert_eq!(output.status.code(), Some(0), "stdout:\n{stdout}\nstderr:\n{stderr}");
    assert!(stdout.is_empty(), "unexpected stdout:\n{stdout}");
    assert!(stderr.is_empty(), "unexpected stderr:\n{stderr}");
}

#[test]
fn stdin_batch_closed_world_rejects_targets_outside_the_supplied_set() {
    let temp = tempfile::tempdir().unwrap();
    fs::create_dir(temp.path().join("docs")).unwrap();
    fs::write(temp.path().join("docs/b.md"), "# On disk\n").unwrap();
    let input = b"docs/a.md\0# A\n\n[disk target](b.md)\n\0";

    let output = run_batch(
        temp.path(),
        input,
        &[
            "check",
            "--stdin-batch",
            "--stdin-batch-closed-world",
            "--no-cache",
            "--enable",
            "MD057",
            "--quiet",
        ],
    );
    let stdout = String::from_utf8_lossy(&output.stdout).replace("\r\n", "\n");
    let stderr = String::from_utf8_lossy(&output.stderr).replace("\r\n", "\n");

    assert_eq!(output.status.code(), Some(1), "stdout:\n{stdout}\nstderr:\n{stderr}");
    assert!(
        stdout.contains("Relative link 'b.md' target not in the supplied document set"),
        "closed-world diagnostics must distinguish omitted targets from missing files.\nstdout:\n{stdout}\nstderr:\n{stderr}"
    );
    assert!(!stdout.contains("does not exist"), "stdout:\n{stdout}");
    assert!(stderr.is_empty(), "unexpected stderr:\n{stderr}");
}

#[test]
fn stdin_batch_closed_world_recognizes_virtual_self_references() {
    let temp = tempfile::tempdir().unwrap();
    fs::write(
        temp.path().join("rumdl.toml"),
        "[MD057]\nself-referential-links = true\n",
    )
    .unwrap();
    let input = b"docs/a.md\0# A\n\n## Section\n\n[self](a.md#section)\n\0";

    let output = run_batch(
        temp.path(),
        input,
        &[
            "check",
            "--stdin-batch",
            "--stdin-batch-closed-world",
            "--no-cache",
            "--enable",
            "MD057",
            "--quiet",
        ],
    );
    let stdout = String::from_utf8_lossy(&output.stdout).replace("\r\n", "\n");
    let stderr = String::from_utf8_lossy(&output.stderr).replace("\r\n", "\n");

    assert_eq!(output.status.code(), Some(1), "stdout:\n{stdout}\nstderr:\n{stderr}");
    assert!(
        stdout.contains("Relative link 'a.md#section' points to the file it is in and can be simplified to '#section'"),
        "stdout:\n{stdout}\nstderr:\n{stderr}"
    );
    assert!(!stdout.contains("target not in the supplied document set"));
    assert!(!stdout.contains("does not exist"));
    assert!(stderr.is_empty(), "unexpected stderr:\n{stderr}");
}

#[cfg(unix)]
#[test]
fn stdin_batch_closed_world_does_not_resolve_self_references_through_disk() {
    use std::os::unix::fs::symlink;

    let temp = tempfile::tempdir().unwrap();
    fs::create_dir_all(temp.path().join("docs")).unwrap();
    fs::create_dir_all(temp.path().join("other")).unwrap();
    fs::write(temp.path().join("docs/a.md"), "# Saved A\n").unwrap();
    symlink(temp.path().join("docs/a.md"), temp.path().join("other/a.md")).unwrap();
    fs::write(
        temp.path().join("rumdl.toml"),
        "[MD057]\nself-referential-links = true\n",
    )
    .unwrap();
    let input = b"docs/a.md\0# A\n\n[alias](../other/a.md)\n\0";

    let output = run_batch(
        temp.path(),
        input,
        &[
            "check",
            "--stdin-batch",
            "--stdin-batch-closed-world",
            "--no-cache",
            "--enable",
            "MD057",
            "--quiet",
        ],
    );
    let stdout = String::from_utf8_lossy(&output.stdout).replace("\r\n", "\n");
    let stderr = String::from_utf8_lossy(&output.stderr).replace("\r\n", "\n");

    assert_eq!(output.status.code(), Some(1), "stdout:\n{stdout}\nstderr:\n{stderr}");
    assert!(
        stdout.contains("Relative link '../other/a.md' target not in the supplied document set"),
        "stdout:\n{stdout}\nstderr:\n{stderr}"
    );
    assert!(!stdout.contains("points to the file it is in"));
    assert!(!stdout.contains("does not exist"));
    assert!(stderr.is_empty(), "unexpected stderr:\n{stderr}");
}

#[test]
fn stdin_batch_closed_world_compacts_paths_to_supplied_targets() {
    let temp = tempfile::tempdir().unwrap();
    fs::write(temp.path().join("rumdl.toml"), "[MD057]\ncompact-paths = true\n").unwrap();
    let input = b"docs/a.md\0# A\n\n[target](sub/../b.md)\n\0docs/b.md\0# B\n\0";

    let output = run_batch(
        temp.path(),
        input,
        &[
            "check",
            "--stdin-batch",
            "--stdin-batch-closed-world",
            "--no-cache",
            "--enable",
            "MD057",
            "--quiet",
        ],
    );
    let stdout = String::from_utf8_lossy(&output.stdout).replace("\r\n", "\n");
    let stderr = String::from_utf8_lossy(&output.stderr).replace("\r\n", "\n");

    assert_eq!(output.status.code(), Some(1), "stdout:\n{stdout}\nstderr:\n{stderr}");
    assert!(
        stdout.contains("Relative link 'sub/../b.md' can be simplified to 'b.md'"),
        "stdout:\n{stdout}\nstderr:\n{stderr}"
    );
    assert!(!stdout.contains("target not in the supplied document set"));
    assert!(!stdout.contains("does not exist"));
    assert!(stderr.is_empty(), "unexpected stderr:\n{stderr}");
}

#[test]
fn stdin_batch_reports_source_context_from_the_supplied_buffer() {
    let temp = tempfile::tempdir().unwrap();
    fs::create_dir(temp.path().join("docs")).unwrap();
    fs::write(temp.path().join("docs/a.md"), "# Disk\n\n### Disk text\n").unwrap();
    let input = b"docs/a.md\0# Supplied\n\n### Supplied text\n\0";

    let output = run_batch(
        temp.path(),
        input,
        &[
            "check",
            "--stdin-batch",
            "--no-cache",
            "--enable",
            "MD001",
            "--output-format",
            "full",
            "--quiet",
        ],
    );
    let stdout = String::from_utf8_lossy(&output.stdout).replace("\r\n", "\n");

    assert_eq!(output.status.code(), Some(1), "stdout:\n{stdout}");
    assert!(stdout.contains("### Supplied text"), "stdout:\n{stdout}");
    assert!(!stdout.contains("### Disk text"), "stdout:\n{stdout}");
}

#[test]
fn stdin_batch_rejects_malformed_framing() {
    let temp = tempfile::tempdir().unwrap();
    let output = run_batch(
        temp.path(),
        b"docs/a.md\0# Missing final delimiter\n",
        &["check", "--stdin-batch", "--quiet"],
    );
    let stderr = String::from_utf8_lossy(&output.stderr).replace("\r\n", "\n");

    assert_eq!(output.status.code(), Some(2), "stderr:\n{stderr}");
    assert!(
        stderr.contains("batch input must end with a NUL byte"),
        "stderr:\n{stderr}"
    );
}

#[test]
fn stdin_batch_does_not_modify_the_workspace_index_cache() {
    let temp = tempfile::tempdir().unwrap();
    let cache_dir = temp.path().join("cache");
    fs::create_dir(&cache_dir).unwrap();
    let workspace_cache = cache_dir.join("workspace_index.bin");
    let sentinel = b"existing workspace snapshot";
    fs::write(&workspace_cache, sentinel).unwrap();

    let output = run_batch(
        temp.path(),
        b"docs/a.md\0# A\n\0",
        &[
            "check",
            "--stdin-batch",
            "--cache-dir",
            cache_dir.to_str().unwrap(),
            "--quiet",
        ],
    );

    assert_eq!(
        output.status.code(),
        Some(0),
        "stdout:\n{}\nstderr:\n{}",
        String::from_utf8_lossy(&output.stdout),
        String::from_utf8_lossy(&output.stderr)
    );
    assert_eq!(fs::read(workspace_cache).unwrap(), sentinel);
}

#[test]
fn stdin_batch_rejects_file_arguments_and_single_stdin_metadata() {
    let temp = tempfile::tempdir().unwrap();
    for incompatible in [
        vec!["check", "--stdin-batch", "README.md"],
        vec!["check", "--stdin-batch", "--stdin-filename", "README.md"],
    ] {
        let output = run_batch(temp.path(), b"", &incompatible);
        let stderr = String::from_utf8_lossy(&output.stderr);
        assert_eq!(output.status.code(), Some(2), "stderr:\n{stderr}");
        assert!(stderr.contains("cannot be used with"), "stderr:\n{stderr}");
    }
}

#[test]
fn stdin_batch_rejects_paths_that_normalize_to_the_same_document() {
    let temp = tempfile::tempdir().unwrap();
    let output = run_batch(
        temp.path(),
        b"docs/a.md\0# A\n\0docs/./a.md\0# Duplicate\n\0",
        &["check", "--stdin-batch", "--quiet"],
    );
    let stderr = String::from_utf8_lossy(&output.stderr).replace("\r\n", "\n");

    assert_eq!(output.status.code(), Some(2), "stderr:\n{stderr}");
    assert!(stderr.contains("duplicate path 'docs/./a.md'"), "stderr:\n{stderr}");
}

#[test]
fn stdin_batch_honors_per_directory_configuration() {
    let temp = tempfile::tempdir().unwrap();
    fs::create_dir(temp.path().join("docs")).unwrap();
    fs::write(temp.path().join("docs/.rumdl.toml"), "enable = [\"MD001\"]\n").unwrap();
    let output = run_batch(
        temp.path(),
        b"docs/a.md\0# A\n\n### Skipped level\n\0",
        &["check", "--stdin-batch", "--no-cache", "--quiet"],
    );
    let stdout = String::from_utf8_lossy(&output.stdout).replace("\r\n", "\n");

    assert_eq!(output.status.code(), Some(1), "stdout:\n{stdout}");
    assert!(
        stdout.contains("docs/a.md:3:1") && stdout.contains("MD001"),
        "stdout:\n{stdout}"
    );
}

#[test]
fn stdin_batch_emits_one_valid_structured_report() {
    let temp = tempfile::tempdir().unwrap();
    let output = run_batch(
        temp.path(),
        b"a.md\0# A\n\n### Bad\n\0b.md\0# B\n\n### Bad\n\0",
        &[
            "check",
            "--stdin-batch",
            "--no-cache",
            "--enable",
            "MD001",
            "--output-format",
            "json",
        ],
    );
    let report: serde_json::Value = serde_json::from_slice(&output.stdout).unwrap_or_else(|error| {
        panic!(
            "invalid JSON ({error}):\n{}\nstderr:\n{}",
            String::from_utf8_lossy(&output.stdout),
            String::from_utf8_lossy(&output.stderr)
        )
    });
    let report = report.as_array().expect("JSON report must be an array");

    assert_eq!(output.status.code(), Some(1));
    assert_eq!(report.len(), 2, "report: {report:#?}");
    let serialized = serde_json::to_string(report).unwrap();
    assert!(serialized.contains("a.md") && serialized.contains("b.md"));
    assert!(output.stderr.is_empty());
}

#[test]
fn stdin_batch_propagates_inline_configuration_warnings() {
    let temp = tempfile::tempdir().unwrap();
    let output = run_batch(
        temp.path(),
        b"a.md\0<!-- rumdl-disable UNKNOWN -->\n# A\n\0",
        &[
            "check",
            "--stdin-batch",
            "--no-cache",
            "--deny-config-warnings",
            "--quiet",
        ],
    );
    let stderr = String::from_utf8_lossy(&output.stderr).replace("\r\n", "\n");

    assert_eq!(output.status.code(), Some(2), "stderr:\n{stderr}");
    assert!(
        stderr.contains("UNKNOWN") && stderr.contains("a.md"),
        "stderr:\n{stderr}"
    );
}