rumdl 0.2.21

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

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

#[test]
fn test_kramdown_block_attributes_auto_detected() {
    // Kramdown attributes should be auto-detected without configuration
    let rule = MD031BlanksAroundFences::default();
    let content = r#"# Title

```bash
echo hello
```
{:.wrap}

Some text"#;
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);
    let result = rule.check(&ctx).unwrap();
    assert!(result.is_empty(), "Should auto-detect Kramdown block attributes");
}

#[test]
fn test_non_kramdown_braces_still_flagged() {
    // Lines with braces that don't match Kramdown IAL syntax should still be flagged
    let rule = MD031BlanksAroundFences::default();
    let content = r#"# Title

```bash
echo hello
```
{not kramdown}

Some text"#;
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);
    let result = rule.check(&ctx).unwrap();
    assert_eq!(result.len(), 1, "Should flag non-Kramdown brace lines");
    assert!(result[0].message.contains("No blank line after"));
}

#[test]
fn test_kramdown_css_class_variants() {
    // Test various Kramdown attribute syntax variations
    let rule = MD031BlanksAroundFences::default();

    // Class attribute
    let content1 = r#"```bash
echo hello
```
{:.wrap}"#;
    let ctx = LintContext::new(content1, rumdl_lib::config::MarkdownFlavor::Standard, None);
    assert!(rule.check(&ctx).unwrap().is_empty());

    // ID attribute
    let content2 = r#"```bash
echo hello
```
{:#my-code}"#;
    let ctx = LintContext::new(content2, rumdl_lib::config::MarkdownFlavor::Standard, None);
    assert!(rule.check(&ctx).unwrap().is_empty());

    // Multiple attributes
    let content3 = r#"```bash
echo hello
```
{:.wrap #my-code .highlight}"#;
    let ctx = LintContext::new(content3, rumdl_lib::config::MarkdownFlavor::Standard, None);
    assert!(rule.check(&ctx).unwrap().is_empty());
}

#[test]
fn test_kramdown_no_blank_after_attribute() {
    // Kramdown attributes don't need blank lines after them
    let rule = MD031BlanksAroundFences::default();
    let content = r#"```bash
echo hello
```
{:.wrap}
Some text immediately after"#;
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);
    let result = rule.check(&ctx).unwrap();
    // This should not flag since the Kramdown attribute is auto-detected
    assert!(result.is_empty(), "Should auto-detect Kramdown attributes");
}

#[test]
fn test_normal_code_blocks_still_checked() {
    // Normal code blocks without attributes should still be checked
    let rule = MD031BlanksAroundFences::default();
    let content = r#"# Title

```bash
echo hello
```
Some text immediately after"#;
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);
    let result = rule.check(&ctx).unwrap();
    assert_eq!(
        result.len(),
        1,
        "Should still flag missing blank line for normal code blocks"
    );
}

#[test]
fn test_fix_preserves_kramdown_attributes() {
    let rule = MD031BlanksAroundFences::default();
    let content = r#"Text before
```bash
echo hello
```
{:.wrap}
Text after"#;
    let ctx = LintContext::new(content, rumdl_lib::config::MarkdownFlavor::Standard, None);
    let fixed = rule.fix(&ctx).unwrap();

    // Should add blank line before the code block but not after (due to attribute)
    let expected = r#"Text before

```bash
echo hello
```
{:.wrap}
Text after"#;
    assert_eq!(fixed, expected);
}