rumdl 0.2.63

A fast Markdown linter and formatter written in Rust
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

//! End-to-end contract tests for the machine-readable output formats documented
//! in `docs/output-formats.md` and committed as stable surfaces in
//! `docs/stability.md`. These assert the documented field structure on real CLI
//! output so a field rename, a missing field, or a structural change fails CI.
//!
//! SARIF is checked for structural conformance (the required fields rumdl
//! publishes and the severity -> level mapping) rather than full SARIF 2.1.0
//! JSON-schema validation: the SARIF schema marks nearly every field optional,
//! so schema validation passes trivially, whereas asserting the published
//! contract actually catches regressions.

use assert_cmd::cargo::cargo_bin_cmd;
use serde_json::Value;
use std::fs;
use std::path::Path;

/// Deterministic, fixable violations:
/// - closed-ATX heading -> MD003 (fixable)
/// - trailing whitespace -> MD009 (fixable)
/// - bare URL -> MD034 (fixable)
const FIXTURE: &str = "# Title\n\n## Closed Heading ##\n\ntrailing spaces here   \n\nSee http://example.com now.\n";

fn write_fixture() -> (tempfile::TempDir, std::path::PathBuf) {
    let dir = tempfile::tempdir().unwrap();
    let path = dir.path().join("doc.md");
    fs::write(&path, FIXTURE).unwrap();
    (dir, path)
}

fn run_format(path: &Path, format: &str) -> String {
    let output = cargo_bin_cmd!("rumdl")
        .args(["check", path.to_str().unwrap(), "--output-format", format, "--no-cache"])
        .output()
        .unwrap();
    String::from_utf8(output.stdout).expect("output is valid UTF-8")
}

fn published_json_schema() -> Value {
    let schema_path = Path::new(env!("CARGO_MANIFEST_DIR")).join("docs/schemas/rumdl-output.schema.json");
    let schema_text = fs::read_to_string(&schema_path)
        .unwrap_or_else(|error| panic!("published schema {} must exist: {error}", schema_path.display()));
    serde_json::from_str(&schema_text).expect("published schema is valid JSON")
}

#[test]
fn json_contract() {
    let (_dir, path) = write_fixture();
    let parsed: Value = serde_json::from_str(&run_format(&path, "json")).expect("valid JSON");

    let warnings = parsed.as_array().expect("json output is a flat array");
    assert!(!warnings.is_empty(), "fixture should produce violations");

    let mut saw_fix = false;
    for w in warnings {
        assert!(w["file"].is_string(), "file: {w}");
        assert!(w["line"].is_u64(), "line: {w}");
        assert!(w["column"].is_u64(), "column: {w}");
        assert!(w["rule"].is_string(), "rule: {w}");
        assert!(w["message"].is_string(), "message: {w}");
        assert!(
            matches!(w["severity"].as_str(), Some("error" | "warning" | "info")),
            "severity: {w}"
        );
        let fixable = w["fixable"].as_bool().expect("fixable is a boolean");

        let fix = w.get("fix").filter(|f| !f.is_null());
        if fixable {
            let fix = fix.expect("a fixable violation must carry a fix object");
            assert!(fix["range"]["start"].is_u64(), "fix.range.start: {w}");
            assert!(fix["range"]["end"].is_u64(), "fix.range.end: {w}");
            assert!(fix["replacement"].is_string(), "fix.replacement: {w}");
            saw_fix = true;
        }
    }
    assert!(
        saw_fix,
        "fixture should include at least one fixable violation with a fix"
    );
}

#[test]
fn json_output_matches_the_published_schema() {
    let (_dir, path) = write_fixture();
    let output: Value = serde_json::from_str(&run_format(&path, "json")).expect("valid JSON");
    let schema = published_json_schema();
    let validator = jsonschema::validator_for(&schema).expect("published schema compiles");

    if let Err(error) = validator.validate(&output) {
        panic!("JSON output must match the published schema: {error}\n{output}");
    }
}

#[test]
fn json_fix_ranges_address_the_original_crlf_input() {
    let dir = tempfile::tempdir().unwrap();
    let path = dir.path().join("crlf.md");
    let input = b"# Title\r\n\r\nTrailing spaces   \r\n";
    fs::write(&path, input).unwrap();

    let parsed: Value = serde_json::from_str(&run_format(&path, "json")).expect("valid JSON");
    let warning = parsed
        .as_array()
        .unwrap()
        .iter()
        .find(|warning| warning["rule"] == "MD009")
        .expect("fixture should produce MD009");
    let start = warning["fix"]["range"]["start"].as_u64().unwrap() as usize;
    let end = warning["fix"]["range"]["end"].as_u64().unwrap() as usize;

    assert_eq!(
        &input[start..end],
        b"   ",
        "JSON fix ranges must address the original bytes read from disk"
    );
}

#[test]
fn json_omits_fix_for_unfixable_violations() {
    let dir = tempfile::tempdir().unwrap();
    let path = dir.path().join("unfixable.md");
    fs::write(&path, "# Title\n\n![](missing.png)\n").unwrap();

    let parsed: Value = serde_json::from_str(&run_format(&path, "json")).expect("valid JSON");
    let warning = parsed
        .as_array()
        .unwrap()
        .iter()
        .find(|warning| warning["rule"] == "MD045")
        .expect("fixture should produce unfixable MD045");

    assert_eq!(warning["fixable"], false);
    assert!(
        warning.get("fix").is_none(),
        "unfixable violations omit the optional fix field"
    );
}

#[test]
fn json_lines_contract_omits_fix() {
    let (_dir, path) = write_fixture();
    let stdout = run_format(&path, "json-lines");
    let published = published_json_schema();
    let record_schema = serde_json::json!({
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "$ref": "#/$defs/jsonLineWarning",
        "$defs": published["$defs"].clone()
    });
    let validator = jsonschema::validator_for(&record_schema).expect("JSON Lines record schema compiles");

    let mut count = 0;
    for line in stdout.lines().filter(|l| !l.trim().is_empty()) {
        let w: Value = serde_json::from_str(line).expect("each line is a valid JSON object");
        if let Err(error) = validator.validate(&w) {
            panic!("JSON Lines record must match the published schema: {error}\n{w}");
        }
        for field in ["file", "line", "column", "rule", "message", "severity", "fixable"] {
            assert!(w.get(field).is_some(), "json-lines missing {field:?}: {line}");
        }
        // json-lines intentionally omits the fix object (use json for fix detail).
        assert!(w.get("fix").is_none(), "json-lines must omit the fix object: {line}");
        count += 1;
    }
    assert!(count >= 1, "expected at least one json-lines record");
}

#[test]
fn sarif_contract() {
    let (_dir, path) = write_fixture();
    let v: Value = serde_json::from_str(&run_format(&path, "sarif")).expect("valid SARIF JSON");

    assert_eq!(v["version"], "2.1.0", "SARIF version");
    assert_eq!(
        v["$schema"], "https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/schemas/sarif-schema-2.1.0.json",
        "SARIF references the immutable official schema"
    );

    let runs = v["runs"].as_array().expect("runs array");
    assert_eq!(runs.len(), 1, "single run");

    let driver = &runs[0]["tool"]["driver"];
    assert_eq!(driver["name"], "rumdl", "driver name");
    assert!(driver["rules"].is_array(), "driver.rules array");

    let results = runs[0]["results"].as_array().expect("results array");
    assert!(!results.is_empty(), "fixture should produce results");
    for r in results {
        assert!(r["ruleId"].is_string(), "ruleId: {r}");
        assert!(
            matches!(r["level"].as_str(), Some("error" | "warning" | "note")),
            "level (severity mapped): {r}"
        );
        assert!(r["message"]["text"].is_string(), "message.text: {r}");
        let loc = &r["locations"][0]["physicalLocation"];
        assert!(loc["artifactLocation"]["uri"].is_string(), "artifactLocation.uri: {r}");
        assert!(loc["region"]["startLine"].is_u64(), "region.startLine: {r}");
        assert!(loc["region"]["startColumn"].is_u64(), "region.startColumn: {r}");
    }
}

#[test]
fn sarif_artifact_locations_are_valid_uri_references() {
    let dir = tempfile::tempdir().unwrap();
    let nested = dir.path().join("docs with spaces");
    fs::create_dir(&nested).unwrap();
    let path = nested.join("guide#one.md");
    fs::write(&path, "#Title\n").unwrap();

    let parsed: Value = serde_json::from_str(&run_format(&path, "sarif")).expect("valid SARIF JSON");
    let uri = parsed["runs"][0]["results"][0]["locations"][0]["physicalLocation"]["artifactLocation"]["uri"]
        .as_str()
        .expect("artifact URI");

    assert!(!uri.contains(' '), "spaces must be percent-encoded: {uri}");
    assert!(uri.contains("%20"), "encoded path preserves spaces: {uri}");
    assert!(uri.contains("%23"), "encoded path preserves literal #: {uri}");
    let parsed_uri = url::Url::parse(uri).unwrap_or_else(|error| panic!("valid absolute artifact URI: {error}: {uri}"));
    assert_eq!(parsed_uri.scheme(), "file");
}

#[test]
fn junit_contract() {
    let (_dir, path) = write_fixture();
    let stdout = run_format(&path, "junit");

    assert!(stdout.starts_with("<?xml"), "XML declaration");
    assert!(stdout.contains("<testsuites name=\"rumdl\""), "testsuites element");
    assert!(stdout.contains("<testsuite name="), "testsuite element");
    assert!(stdout.contains("classname=\"rumdl\""), "testcase classname");

    let failures = stdout.matches("<failure type=\"MD").count();
    assert!(failures >= 1, "expected one <failure> per violation, got {failures}");
    assert!(stdout.contains(" at line "), "failure body includes line/column");
}

#[test]
fn junit_is_well_formed_for_diagnostic_text_with_control_characters() {
    let dir = tempfile::tempdir().unwrap();
    let path = dir.path().join("control.md");
    fs::write(&path, "# Title\n\n[link](bad\u{1}path)\n").unwrap();
    let stdout = run_format(&path, "junit");

    assert!(
        !stdout.contains('\u{1}'),
        "XML-forbidden control characters must not reach the report"
    );
    assert!(
        stdout.contains("bad\u{fffd}path"),
        "invalid source characters are replaced rather than silently deleted"
    );

    let mut reader = quick_xml::Reader::from_str(&stdout);
    loop {
        match reader.read_event() {
            Ok(quick_xml::events::Event::Eof) => break,
            Ok(_) => {}
            Err(error) => panic!("JUnit output must be well-formed XML: {error}\n{stdout}"),
        }
    }
}