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
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

//! Unit tests for pending-prefix continuation decisions.

use std::borrow::Cow;

use super::*;

fn pending_prefix(
    continuation_mode: ContinuationMode,
    rest: &str,
    rest_width: usize,
) -> PendingPrefix {
    PendingPrefix {
        prefix: "- ".to_string(),
        rest: rest.to_string(),
        original_lines: vec![format!("- {rest}")],
        synthetic_join_spaces: Vec::new(),
        rest_width,
        repeat_prefix: false,
        outer_prefix: None,
        hard_break: false,
        open_fence_len: Some(1),
        continuation_mode,
        used_prefix: false,
        tail_reflow: TailReflow::Allowed,
    }
}

fn state_with_pending(pending: PendingPrefix) -> ParagraphState {
    let mut state = ParagraphState::default();
    state.pending_prefix = Some(pending);
    state
}

#[test]
fn should_emit_verbatim_for_width_only_when_join_would_overflow() {
    let rest = "`EngineConnector::connect(socket: impl AsRef<str>)";
    let text = " -> Result<Docker, PodbotError>`";
    let overflowing = state_with_pending(pending_prefix(ContinuationMode::Normalize, rest, 40));
    let fitting = state_with_pending(pending_prefix(ContinuationMode::Normalize, rest, 120));

    assert!(should_emit_verbatim_for_width(text, &overflowing));
    assert!(!should_emit_verbatim_for_width(text, &fitting));
}

#[test]
fn apply_continuation_chunk_emits_overwidth_continuation_verbatim() {
    let mut out = Vec::new();
    let mut writer = ParagraphWriter::new(&mut out, 80);
    let rest = "`EngineConnector::connect(socket: impl AsRef<str>)";
    let mut state = state_with_pending(pending_prefix(ContinuationMode::Normalize, rest, 40));

    apply_continuation_chunk(
        " -> Result<Docker, PodbotError>`",
        "  -> Result<Docker, PodbotError>`",
        false,
        &mut writer,
        &mut state,
    );

    assert_eq!(
        out,
        vec![
            "- `EngineConnector::connect(socket: impl AsRef<str>)",
            "  -> Result<Docker, PodbotError>`",
        ]
    );
    assert!(state.pending_prefix.is_none());
}

#[test]
fn apply_continuation_chunk_preserves_original_lines_for_verbatim_flush() {
    let mut out = Vec::new();
    let mut writer = ParagraphWriter::new(&mut out, 80);
    let mut pending = pending_prefix(ContinuationMode::VerbatimFlush, "rewritten `a", 3);
    pending.original_lines = vec!["- original `a".to_string()];
    let mut state = state_with_pending(pending);

    apply_continuation_chunk("b`", "  b`", false, &mut writer, &mut state);

    assert_eq!(out, vec!["- original `a", "  b`"]);
    assert!(state.pending_prefix.is_none());
}

#[test]
fn handle_prefix_line_selects_tight_mode_for_opener_at_eol() {
    let mut out = Vec::new();
    let mut writer = ParagraphWriter::new(&mut out, 80);
    let mut state = ParagraphState::default();
    let line = PrefixLine {
        prefix: Cow::Borrowed("- "),
        rest: "run `",
        repeat_prefix: false,
        outer_prefix: None,
    };

    writer.handle_prefix_line(&mut state, &line);

    assert!(matches!(
        state
            .pending_prefix
            .map(|pending| pending.continuation_mode),
        Some(ContinuationMode::TightCodeSpan)
    ));
}

#[test]
fn handle_prefix_line_selects_normal_mode_for_nonempty_tail() {
    let mut out = Vec::new();
    let mut writer = ParagraphWriter::new(&mut out, 80);
    let mut state = ParagraphState::default();
    let line = PrefixLine {
        prefix: Cow::Borrowed("- "),
        rest: "run `code",
        repeat_prefix: false,
        outer_prefix: None,
    };

    writer.handle_prefix_line(&mut state, &line);

    assert!(matches!(
        state
            .pending_prefix
            .map(|pending| pending.continuation_mode),
        Some(ContinuationMode::Normalize)
    ));
}

#[test]
fn update_span_state_selects_verbatim_flush_for_word_tail_after_close() {
    let mut pending = pending_prefix(ContinuationMode::Normalize, "`foo", 80);

    let update = update_span_state("bar`baz", 0, &mut pending);

    assert!(matches!(update, SpanStateUpdate::Flush));
    assert!(matches!(
        pending.continuation_mode,
        ContinuationMode::VerbatimFlush
    ));
}

#[test]
fn scan_continuation_filter_distinguishes_closed_and_open_spans() {
    let closed = scan_continuation_span_state("no backticks here", 0);
    assert_eq!(closed, Some(0));
    assert_eq!(closed.filter(|len| *len > 0), None);

    let still_open = scan_continuation_span_state("text `more", 0);
    assert_eq!(still_open, Some(0));
    assert_eq!(still_open.filter(|len| *len > 0), None);
    assert_eq!(
        parse_open_code_span("text `more").map(|(len, _)| len),
        Some(1)
    );
}