mdtablefix 0.6.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
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

//! Unit tests for heading conversion.

use rstest::rstest;

use super::*;

#[rstest]
#[case(vec!["Heading".into(), "===".into()], vec!["# Heading".into()])]
#[case(vec!["Heading".into(), "----".into()], vec!["## Heading".into()])]
#[case(
    vec!["- item".into(), String::new(), "Heading".into(), "---".into()],
    vec!["- item".into(), String::new(), "## Heading".into()]
)]
#[case(vec!["  Heading".into(), " ---".into()], vec![" ## Heading".into()])]
#[case(vec![" Heading".into(), "  ---".into()], vec![" ## Heading".into()])]
#[case(vec!["Title   ".into(), "=====".into()], vec!["# Title".into()])]
#[case(vec!["   Heading".into(), "   ====".into()], vec!["   # Heading".into()])]
#[case(vec!["Heading".into(), "----   ".into()], vec!["## Heading".into()])]
#[case(
    vec!["> Quote".into(), "> ----".into()],
    vec!["> ## Quote".into()]
)]
#[case(
    vec![">> Title".into(), ">> ----".into()],
    vec![">> ## Title".into()]
)]
#[case(
    vec!["   > Title".into(), "   > -----".into()],
    vec!["   > ## Title".into()]
)]
fn converts_setext_headings(#[case] input: Vec<String>, #[case] expected: Vec<String>) {
    assert_eq!(convert_setext_headings(&input), expected);
}

#[rstest]
#[case(vec!["```".into(), "Heading".into(), "---".into(), "```".into()])]
#[case(vec!["Not a heading".into(), "--".into()])]
#[case(vec!["- Item".into(), "-----".into()])]
#[case(vec!["- Bar".into(), "  ---".into()])]
#[case(vec![String::new(), "---".into()])]
#[case(vec!["> Quote".into(), "-----".into()])]
#[case(vec!["- item".into(), "  continuation".into(), "---".into()])]
#[case(vec!["- item".into(), "lazy continuation".into(), "---".into()])]
#[case(vec!["  1. item".into(), "     wrapped".into(), "lazy continuation".into(), "-----".into()])]
#[case(vec!["- item".into(), String::new(), "  continuation".into(), "---".into()])]
#[case(vec!["Heading".into(), "-==".into()])]
fn leaves_non_headings_untouched(#[case] lines: Vec<String>) {
    assert_eq!(convert_setext_headings(&lines), lines);
}

/// Asserts a candidate that is itself a block start keeps its underline.
///
/// Every case is a line a Setext underline followed, which the conversion
/// must refuse so the second line survives as a block of its own. The
/// `## aa` case is the reported reproduction: it became `## ## aa`, and the
/// thematic break below it disappeared.
#[rstest]
// An ATX heading at every level, with and without closing hashes.
#[case(vec!["# aa".into(), "===".into()])]
#[case(vec!["## aa".into(), "---".into()])]
#[case(vec!["### aa".into(), "===".into()])]
#[case(vec!["#### aa".into(), "---".into()])]
#[case(vec!["##### aa".into(), "===".into()])]
#[case(vec!["###### aa".into(), "---".into()])]
#[case(vec!["# aa #".into(), "===".into()])]
#[case(vec!["## aa ##".into(), "---".into()])]
#[case(vec!["###### aa ######".into(), "---".into()])]
// The same shapes behind a blockquote prefix, which the predicate sees
// only after the shared prefix has been removed.
#[case(vec!["> ## aa".into(), "> ---".into()])]
#[case(vec![">> # aa".into(), ">> ===".into()])]
#[case(vec!["   ### aa".into(), "   ---".into()])]
// Thematic breaks are block starts, not paragraph text.
#[case(vec!["---".into(), "---".into()])]
#[case(vec!["***".into(), "---".into()])]
#[case(vec!["___".into(), "---".into()])]
#[case(vec!["- - -".into(), "---".into()])]
// Table delimiter rows are table syntax, not paragraph text, so the break
// below one is not its underline. The repaired delimiter row is what the
// table pass emits, and the quoted spelling reaches the predicate only after
// the shared prefix has been removed.
#[case(vec!["| --- | --- |".into(), "---".into()])]
#[case(vec!["|---|---|".into(), "---".into()])]
#[case(vec!["> | --- | --- |".into(), "> ---".into()])]
#[case(vec![">> |:--|--:|".into(), ">> ---".into()])]
#[case(vec!["   | --- | --- |".into(), "   ---".into()])]
// List items, including the indented forms whose prefix is shared.
#[case(vec!["* item".into(), "-----".into()])]
#[case(vec!["  - item".into(), "  ---".into()])]
#[case(vec!["1. item".into(), "---".into()])]
#[case(vec!["1) item".into(), "---".into()])]
#[case(vec!["- [x] task".into(), "---".into()])]
// Definitions and directives.
#[case(vec!["[^1]: note".into(), "---".into()])]
#[case(vec!["[label]: https://example.com".into(), "---".into()])]
#[case(vec!["<!-- markdownlint-disable MD013 -->".into(), "---".into()])]
// Four columns of indentation make both lines an indented code block.
#[case(vec!["    code".into(), "    ---".into()])]
#[case(vec!["    code".into(), "    ===".into()])]
#[case(vec!["\tcode".into(), "\t---".into()])]
#[case(vec![">     code".into(), ">     ---".into()])]
#[case(vec![">>     code".into(), ">>     ===".into()])]
// The same pairs behind one, two, and three spaces before the marker, which
// CommonMark still reads as a blockquote holding indented code.
#[case(vec![" >     code".into(), " >     ---".into()])]
#[case(vec!["  >     code".into(), "  >     ---".into()])]
#[case(vec!["   >     code".into(), "   >     ---".into()])]
fn refuses_underlines_below_a_block_start(#[case] lines: Vec<String>) {
    assert_eq!(convert_setext_headings(&lines), lines);
}

/// Asserts the indentation width is measured inside any blockquote markers.
///
/// Three columns or fewer stay paragraph text and still convert; four or
/// more are an indented code block. The single space after each `>` marker
/// belongs to the marker, not to the content.
#[rstest]
#[case("code", 0)]
#[case("   code", 3)]
#[case("    code", 4)]
#[case("\tcode", 4)]
#[case("> code", 0)]
#[case(">   code", 2)]
#[case(">     code", 4)]
#[case(" > code", 0)]
#[case(" >     code", 4)]
#[case("  >     code", 4)]
#[case("   >     code", 4)]
// Four leading spaces are indented code, so no marker is consumed.
#[case("    >     code", 4)]
#[case(">> # aa", 0)]
#[case(">>     code", 4)]
fn measures_content_indentation(#[case] line: &str, #[case] expected: usize) {
    assert_eq!(content_indent_width(line), expected);
}

/// Asserts the predicate rejects block starts and admits paragraph text.
///
/// The payload table covers classes the line-pair tests cannot reach: a
/// candidate whose payload keeps a blockquote marker is refused earlier, by
/// the prefix match, and a fence marker line is skipped by the fence
/// tracker before detection.
#[rstest]
#[case("## aa", false)]
#[case("# aa #", false)]
#[case("---", false)]
#[case("***", false)]
#[case("- item", false)]
#[case("1. item", false)]
#[case("> quote", false)]
#[case("[^1]: note", false)]
#[case("[label]: https://example.com", false)]
#[case("<!-- markdownlint-disable MD013 -->", false)]
#[case("```", false)]
#[case("~~~", false)]
// Table delimiter rows are table syntax, not paragraph text. Each one is a
// candidate the table pass has just repaired, and the line below it in the
// reported shape is a thematic break rather than an underline.
#[case("| --- | --- |", false)]
#[case("|---|---|", false)]
#[case("--- | ---", false)]
#[case("|:--|--:|", false)]
// A table row is structural table content, so it cannot be consumed as a
// Setext candidate either.
#[case("| a | b |", false)]
#[case("| a | b", false)]
#[case("|  |  |", false)]
#[case("plain paragraph", true)]
#[case("2024 revenue", true)]
#[case("Text with > inside", true)]
#[case("Text with > inside | here", true)]
fn classifies_setext_text(#[case] payload: &str, #[case] expected: bool) {
    let matcher = LinkReferenceMatcher::production();
    assert_eq!(
        is_setext_text(
            payload,
            is_setext_text_line(payload, &ClassifyCtx::default()),
            matcher,
        ),
        expected
    );
}

/// Asserts a digit-prefixed paragraph still converts, as before.
#[rstest]
#[case(vec!["2024 revenue".into(), "===".into()], vec!["# 2024 revenue".into()])]
fn converts_digit_prefixed_paragraphs(#[case] input: Vec<String>, #[case] expected: Vec<String>) {
    assert_eq!(convert_setext_headings(&input), expected);
}