limner 0.3.0

A ratatui markdown renderer with image placeholders, code blocks, and styled headings
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

use ratatui::style::{Color, Style};
use ratatui::text::{Line, Span};
use unicode_width::UnicodeWidthStr;

/// Split a code block into pre-wrapped lines, each with a full-width
/// background span so the background colour fills the entire terminal
/// width (for the code-block look).
pub fn wrap_code_block(code: &str, width: usize, style: Style, bg: Color) -> Vec<Line<'static>> {
    let w = width.max(1);
    let mut out = Vec::new();

    for src_line in code.lines() {
        if src_line.is_empty() {
            // Preserve empty lines as blank code lines.
            out.push(make_code_line("", w, style, bg));
            continue;
        }

        let cols = UnicodeWidthStr::width(src_line);
        if cols <= w {
            out.push(make_code_line(src_line, w, style, bg));
        } else {
            // Hard-wrap long lines at width boundary.
            let mut remain = src_line;
            while !remain.is_empty() {
                let wrap_at = find_wrap_col(remain, w);
                let (part, rest) = remain.split_at(wrap_at);
                out.push(make_code_line(part, w, style, bg));
                remain = rest;
            }
        }
    }

    out
}

fn make_code_line(text: &str, width: usize, style: Style, bg: Color) -> Line<'static> {
    let padding = width.saturating_sub(UnicodeWidthStr::width(text));
    let mut s = text.to_string();
    if padding > 0 {
        s.push_str(&" ".repeat(padding));
    }
    Line::from(Span::styled(s, style.bg(bg)))
}

/// Find the byte index to break a line so that its displayed width ≤ `max_width`.
fn find_wrap_col(line: &str, max_width: usize) -> usize {
    let mut col = 0;
    for (i, c) in line.char_indices() {
        let cw = UnicodeWidthStr::width(c.to_string().as_str());
        if col + cw > max_width {
            return i;
        }
        col += cw;
    }
    line.len()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn short_line_padded() {
        let lines = wrap_code_block("hi", 10, Style::default(), Color::Black);
        assert_eq!(lines.len(), 1);
        // "hi" = 2 cols, padding = 8 spaces.
        let rendered = lines[0].to_string();
        assert_eq!(rendered.chars().count(), 10);
    }

    #[test]
    fn hard_wrap_long_line() {
        let lines = wrap_code_block("abcdefghij", 5, Style::default(), Color::Black);
        assert_eq!(lines.len(), 2);
    }

    #[test]
    fn empty_lines_preserved() {
        let lines = wrap_code_block("a\n\nb", 5, Style::default(), Color::Black);
        assert_eq!(lines.len(), 3);
    }
}