mdtablefix 0.5.1

`mdtablefix` unb0rks and reflows Markdown tables so that each column has a uniform width. When the `--wrap` option is used, it also wraps paragraphs and list items to 80 columns.
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

//! Tests for markdownlint directive handling during wrapping.
//!
//! These tests ensure that comment directives such as
//! `<!-- markdownlint-disable-next-line -->` remain on their own line
//! after processing. Regular comments should still be wrapped normally.

#[macro_use]
#[path = "common/mod.rs"]
mod common;
use mdtablefix::process_stream;
use rstest::rstest;

/// The disable-next-line directive must remain intact after wrapping.
#[test]
fn test_markdownlint_disable_next_line_preserved() {
    let input = lines_vec![
        "[roadmap](./roadmap.md) and expands on the design ideas described in",
        "<!--  markdownlint-disable-next-line  MD013  -->",
    ];
    let output = process_stream(&input);
    assert_eq!(output, input);
}

/// The disable-next-line directive must remain intact when in the middle of the input.
#[test]
fn test_markdownlint_disable_next_line_preserved_middle() {
    let input = lines_vec![
        "This is the first line.",
        "<!--  markdownlint-disable-next-line  MD013  -->",
        "This is the third line.",
    ];
    let output = process_stream(&input);
    assert_eq!(output, input);
}

/// Regular comments should still wrap when necessary.
#[test]
fn test_regular_comment_wraps_normally() {
    let input = lines_vec![
        "Intro text that preludes a lengthy comment.",
        concat!(
            "<!-- This comment contains many words and should be wrapped across ",
            "multiple lines to ensure that regular comments are formatted ",
            "correctly. -->"
        ),
    ];
    let output = process_stream(&input);
    assert_eq!(
        output,
        lines_vec![
            "Intro text that preludes a lengthy comment. <!-- This comment contains many",
            "words and should be wrapped across multiple lines to ensure that regular",
            "comments are formatted correctly. -->",
        ]
    );
}

/// Other markdownlint directives should also remain on their own lines, even
/// when indented or combined with multiple rule names.
#[rstest]
#[case("<!-- markdownlint-disable-line MD001 MD005 -->")]
#[case("<!-- markdownlint-enable MD001 -->")]
#[case("    <!-- markdownlint-disable -->")]
#[case("<!--  markdownlint-disable   MD001   MD002  -->")]
#[case("<!-- MarkDownLint-disable-line MD003 -->")]
#[case("<!-- MARKDOWNLINT-disable-next-line MD004 MD005 -->")]
fn test_markdownlint_directive_variants_preserved(#[case] directive: &str) {
    let input = lines_vec!["A preceding line.", directive];
    let output = process_stream(&input);
    assert_eq!(output, input);
}

/// Comments that resemble directives but are invalid should wrap normally.
#[test]
fn test_non_directive_comment_wraps() {
    let input = lines_vec!["Intro line.", "<!-- markdowndisable -->"];
    let output = process_stream(&input);
    assert_eq!(output, lines_vec!["Intro line. <!-- markdowndisable -->"]);
}

/// Malformed or partially correct directive comments should wrap normally.
#[test]
fn test_malformed_directive_missing_closing() {
    let input = lines_vec!["Text before.", "<!-- markdownlint-disable"];
    let output = process_stream(&input);
    assert_eq!(output, lines_vec!["Text before. <!-- markdownlint-disable"]);
}

#[test]
fn test_malformed_directive_extra_text() {
    let input = lines_vec!["Text before.", "<!-- markdownlint-disable --> extra"];
    let output = process_stream(&input);
    assert_eq!(
        output,
        lines_vec!["Text before. <!-- markdownlint-disable --> extra"]
    );
}

#[test]
fn test_malformed_directive_typo() {
    let input = lines_vec!["Text before.", "<!-- markdownlnt-disable-line MD001 -->"];
    let output = process_stream(&input);
    assert_eq!(
        output,
        lines_vec!["Text before. <!-- markdownlnt-disable-line MD001 -->"]
    );
}

#[test]
fn test_malformed_directive_incomplete_tag() {
    let input = lines_vec!["Text before.", "<!-- markdownlint-disable-line MD001 "];
    let output = process_stream(&input);
    assert_eq!(
        output,
        lines_vec!["Text before. <!-- markdownlint-disable-line MD001"]
    );
}