rumdl 0.0.12

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

use rumdl::rules::MD030ListMarkerSpace;
use rumdl::rule::Rule;

#[test]
fn test_valid_single_line_lists() {
    let rule = MD030ListMarkerSpace::default();
    let content = "* Item\n- Another item\n+ Third item\n1. Ordered item";
    let result = rule.check(content).unwrap();
    assert!(result.is_empty());
}

#[test]
fn test_valid_multi_line_lists() {
    let rule = MD030ListMarkerSpace::default();
    let content = "* First line\n  continued\n- Second item\n  also continued";
    let result = rule.check(content).unwrap();
    assert!(result.is_empty());
}

#[test]
fn test_invalid_spaces_unordered() {
    let rule = MD030ListMarkerSpace::default();
    let content = "*  Too many spaces\n-   Three spaces";
    let result = rule.check(content).unwrap();
    assert_eq!(result.len(), 2);
}

#[test]
fn test_invalid_spaces_ordered() {
    let rule = MD030ListMarkerSpace::default();
    let content = "1.  Too many spaces\n2.   Three spaces";
    let result = rule.check(content).unwrap();
    assert_eq!(result.len(), 2);
}

#[test]
fn test_fix_unordered_list() {
    let rule = MD030ListMarkerSpace::default();
    let content = "*  Item\n-   Another\n+    Third";
    let fixed = rule.fix(content).unwrap();
    assert_eq!(fixed, "* Item\n- Another\n+ Third");
}

#[test]
fn test_fix_ordered_list() {
    let rule = MD030ListMarkerSpace::default();
    let content = "1.  First\n2.   Second\n3.    Third";
    let fixed = rule.fix(content).unwrap();
    assert_eq!(fixed, "1. First\n2. Second\n3. Third");
}

#[test]
fn test_custom_spacing() {
    let rule = MD030ListMarkerSpace::new(2, 3, 2, 3);
    let content = "* One space\n- One space\n1. One space";
    let result = rule.check(content).unwrap();
    assert_eq!(result.len(), 3);
    let fixed = rule.fix(content).unwrap();
    assert_eq!(fixed, "*  One space\n-  One space\n1.  One space");
}

#[test]
fn test_mixed_list_types() {
    let rule = MD030ListMarkerSpace::default();
    let content = "*  Unordered\n1.  Ordered\n-   Mixed\n2.   Types";
    let result = rule.check(content).unwrap();
    assert_eq!(result.len(), 4);
    let fixed = rule.fix(content).unwrap();
    assert_eq!(fixed, "* Unordered\n1. Ordered\n- Mixed\n2. Types");
}

#[test]
fn test_nested_lists() {
    let rule = MD030ListMarkerSpace::default();
    let content = "* First\n  *  Nested\n    *   More nested";
    let result = rule.check(content).unwrap();
    assert_eq!(result.len(), 2);
    let fixed = rule.fix(content).unwrap();
    assert_eq!(fixed, "* First\n  * Nested\n    * More nested");
}

#[test]
fn test_ignore_code_blocks() {
    let rule = MD030ListMarkerSpace::default();
    let content = "* Normal item\n```\n*  Not a list\n1.  Not a list\n```\n- Back to list";
    let result = rule.check(content).unwrap();
    assert!(result.is_empty());
}

#[test]
fn test_multi_line_items() {
    let rule = MD030ListMarkerSpace::new(1, 2, 1, 2);
    let content = "* Single line\n* Multi line\n  continued here\n* Another single";
    let result = rule.check(content).unwrap();
    assert_eq!(result.len(), 1); // Only the multi-line item should be flagged
    let fixed = rule.fix(content).unwrap();
    assert_eq!(fixed, "* Single line\n*  Multi line\n  continued here\n* Another single");
}

#[test]
fn test_preserve_indentation() {
    let rule = MD030ListMarkerSpace::default();
    let content = "  *  Item\n    -   Another\n      +    Third";
    let fixed = rule.fix(content).unwrap();
    assert_eq!(fixed, "  * Item\n    - Another\n      + Third");
}