rumdl 0.1.86

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

use rumdl_lib::config::MarkdownFlavor;
use rumdl_lib::lint_context::LintContext;
use rumdl_lib::rule::Rule;
use rumdl_lib::rules::{MD024NoDuplicateHeading, MD052ReferenceLinkImages};

#[test]
fn test_mkdocs_snippets_md024_duplicate_headings() {
    // Test that MD024 doesn't flag duplicates within snippet sections
    let content = r#"# Document

## Installation

Some content here.

<!-- --8<-- [start:included-content] -->

## Installation

This is included content that might have duplicate headings.

<!-- --8<-- [end:included-content] -->

## Another Section
"#;

    let rule = MD024NoDuplicateHeading::default();

    // Test with standard flavor - should flag duplicate
    let ctx_standard = LintContext::new(content, MarkdownFlavor::Standard, None);
    let warnings_standard = rule.check(&ctx_standard).unwrap();
    assert_eq!(
        warnings_standard.len(),
        1,
        "Standard flavor should flag duplicate heading"
    );
    assert!(
        warnings_standard[0]
            .message
            .contains("Duplicate heading: 'Installation'")
    );

    // Test with MkDocs flavor - should NOT flag duplicate
    let ctx_mkdocs = LintContext::new(content, MarkdownFlavor::MkDocs, None);
    let warnings_mkdocs = rule.check(&ctx_mkdocs).unwrap();
    assert_eq!(
        warnings_mkdocs.len(),
        0,
        "MkDocs flavor should not flag duplicate heading in snippet section"
    );
}

#[test]
fn test_mkdocs_snippets_file_inclusion() {
    // Test that direct file inclusion syntax is handled correctly
    let content = r#"# Document

## Including Files

Here's how to include a file:

--8<-- "docs/installation.md"

More content here.
"#;

    let rule = MD052ReferenceLinkImages::default();

    // With MkDocs flavor, the snippet line should be ignored
    let ctx_mkdocs = LintContext::new(content, MarkdownFlavor::MkDocs, None);
    let warnings_mkdocs = rule.check(&ctx_mkdocs).unwrap();
    assert_eq!(
        warnings_mkdocs.len(),
        0,
        "MkDocs flavor should not flag snippet inclusion"
    );
}

#[test]
fn test_mkdocs_nested_snippets() {
    // Test nested snippet sections
    let content = r#"# Document

## Section 1

<!-- --8<-- [start:outer] -->

## Outer Section

<!-- --8<-- [start:inner] -->

## Inner Section

<!-- --8<-- [end:inner] -->

## Outer Section

<!-- --8<-- [end:outer] -->

## Section 2
"#;

    let rule = MD024NoDuplicateHeading::default();

    // With MkDocs flavor, duplicates within snippets should be ignored
    let ctx_mkdocs = LintContext::new(content, MarkdownFlavor::MkDocs, None);
    let warnings_mkdocs = rule.check(&ctx_mkdocs).unwrap();

    // Debug: Print warnings if any
    for warning in &warnings_mkdocs {
        eprintln!("Warning: {} at line {}", warning.message, warning.line);
    }

    assert_eq!(
        warnings_mkdocs.len(),
        0,
        "MkDocs flavor should handle nested snippets correctly"
    );
}

#[test]
fn test_mkdocs_snippet_variations() {
    // Test different snippet syntax variations
    let content = r#"# Document

--8<-- "file1.md"

--8<-- 'file2.md'

<!-- --8<-- "file3.md" -->

<!-- -8<- [start:section] -->

<!-- -8<- [end:section] -->
"#;

    let rule = MD052ReferenceLinkImages::default();

    // All variations should be recognized in MkDocs mode
    let ctx_mkdocs = LintContext::new(content, MarkdownFlavor::MkDocs, None);
    let warnings_mkdocs = rule.check(&ctx_mkdocs).unwrap();

    // Debug: Print warnings if any
    for warning in &warnings_mkdocs {
        eprintln!("Warning: {} at line {}", warning.message, warning.line);
    }

    assert_eq!(
        warnings_mkdocs.len(),
        0,
        "All snippet syntax variations should be recognized"
    );
}