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

use rumdl_lib::lint_context::LintContext;
use rumdl_lib::rule::Rule;
use rumdl_lib::rules::MD038NoSpaceInCode;

#[test]
fn test_valid_code_spans() {
    let rule = MD038NoSpaceInCode::new();
    let content = "`code` and `another code` here";
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);
    let result = rule.check(&ctx).unwrap();
    assert!(result.is_empty());
}

#[test]
fn test_spaces_both_ends() {
    // CommonMark: single space at start AND end is valid (spaces are stripped)
    // See https://spec.commonmark.org/0.31.2/#code-spans
    let rule = MD038NoSpaceInCode::new();
    let content = "` code ` and ` another code ` here";
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);
    let result = rule.check(&ctx).unwrap();
    assert!(result.is_empty(), "Single space at both ends is valid CommonMark");
}

#[test]
fn test_space_at_start() {
    let rule = MD038NoSpaceInCode::new();
    let content = "` code` and ` another code` here";
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);
    let result = rule.check(&ctx).unwrap();
    assert_eq!(result.len(), 2);
    let fixed = rule.fix(&ctx).unwrap();
    assert_eq!(fixed, "`code` and `another code` here");
}

#[test]
fn test_space_at_end() {
    let rule = MD038NoSpaceInCode::new();
    let content = "`code ` and `another code ` here";
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);
    let result = rule.check(&ctx).unwrap();
    assert_eq!(result.len(), 2);
    let fixed = rule.fix(&ctx).unwrap();
    assert_eq!(fixed, "`code` and `another code` here");
}

#[test]
fn test_code_in_code_block() {
    // CommonMark: single space at start AND end is valid (spaces are stripped)
    let rule = MD038NoSpaceInCode::new();
    let content = "```\n` code `\n```\n` code `";
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);
    let result = rule.check(&ctx).unwrap();
    // Both code spans have single space at both ends - valid CommonMark
    assert!(result.is_empty(), "Single space at both ends is valid CommonMark");
}

#[test]
fn test_multiple_code_spans() {
    // CommonMark: single space at start AND end is valid (spaces are stripped)
    let rule = MD038NoSpaceInCode::new();
    let content = "` code ` and ` another ` in one line";
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);
    let result = rule.check(&ctx).unwrap();
    assert!(result.is_empty(), "Single space at both ends is valid CommonMark");
}

#[test]
fn test_code_with_internal_spaces() {
    // CommonMark: single space at start AND end is valid (spaces are stripped)
    let rule = MD038NoSpaceInCode::new();
    let content = "`this is code` and ` this is also code `";
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);
    let result = rule.check(&ctx).unwrap();
    // Second code span has single space at both ends - valid CommonMark
    assert!(result.is_empty(), "Single space at both ends is valid CommonMark");
}

#[test]
fn test_code_with_punctuation() {
    // CommonMark: single space at start AND end is valid (spaces are stripped)
    let rule = MD038NoSpaceInCode::new();
    let content = "` code! ` and ` code? ` here";
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);
    let result = rule.check(&ctx).unwrap();
    assert!(result.is_empty(), "Single space at both ends is valid CommonMark");
}

#[test]
fn test_nested_backticks_do_not_lose_boundary_spaces() {
    let rule = MD038NoSpaceInCode::new();
    let content = "Schema example: `{ kind, mode, label (same enum as `Widget.mode` per MODEL-12) }`.";
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);

    let fixed = rule.fix(&ctx).unwrap();

    assert_eq!(
        fixed, content,
        "MD038 should not remove spaces around backticks that appear to be nested inside a larger code-like span"
    );
}