rig-tui 0.45.0

A rig-harness plugin: the terminal view, with panels and tool renderers other plugins add to.
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

use ratatui::style::Modifier;
use unicode_width::UnicodeWidthStr;

use crate::Theme;
use crate::markdown::render;

fn text(markdown: &str, width: usize) -> Vec<String> {
    let lines = render(markdown, &Theme::default(), Some(width));
    lines
        .iter()
        .map(|line| line.to_string().trim_end().to_owned())
        .collect()
}

const WIDE: &str = "\
| Tool | What it did |
| --- | --- |
| read | Read the first five lines of the workspace manifest, which name the package and its edition |
| shell | Ran ls on a path that does not exist and failed with exit code 2 |
";

#[test]
fn a_table_that_fits_is_drawn_at_its_widest_cells_with_a_bold_header() {
    let markdown = "| a | bb |\n| - | - |\n| ccc | d |\n";
    assert_eq!(text(markdown, 80), ["a     bb", "ccc   d"]);
    let lines = render(markdown, &Theme::default(), Some(80));
    let header = lines
        .first()
        .and_then(|line| line.spans.iter().find(|span| span.content == "a"));
    let bold = Modifier::BOLD | Modifier::UNDERLINED;
    assert!(header.is_some_and(|span| span.style.add_modifier.contains(bold)));
}

#[test]
fn a_wide_table_wraps_its_cells_in_columns_that_fit() {
    let lines = text(WIDE, 50);
    assert!(lines.iter().all(|line| line.width() <= 50), "{lines:#?}");
    let words = |text: &str| {
        text.split_whitespace()
            .map(str::to_owned)
            .collect::<Vec<_>>()
    };
    let drawn: Vec<String> = lines.iter().flat_map(|line| words(line)).collect();
    assert!(
        words(WIDE)
            .iter()
            .filter(|word| word.chars().all(char::is_alphanumeric))
            .all(|word| drawn.contains(word)),
        "{lines:#?}"
    );
    // Each row's first line starts with its tool, the second column beside it.
    assert!(
        lines
            .iter()
            .any(|line| line.starts_with("read") && line.contains("Read the")),
        "{lines:#?}"
    );
    // Rows that wrapped are apart.
    assert!(lines.iter().any(String::is_empty), "{lines:#?}");
}

#[test]
fn a_table_too_narrow_for_its_columns_is_drawn_as_records() {
    let lines = text(WIDE, 16);
    assert!(lines.iter().all(|line| line.width() <= 16), "{lines:#?}");
    assert_eq!(
        lines.first().map(String::as_str),
        Some("Tool"),
        "{lines:#?}"
    );
    assert_eq!(
        lines.get(1).map(String::as_str),
        Some("  read"),
        "{lines:#?}"
    );
    assert!(lines.iter().any(|line| line == "What it did"), "{lines:#?}");
}

#[test]
fn a_br_breaks_a_cell_and_a_line() {
    let lines = text("| a | b |\n| - | - |\n| one<br>two | x |\n", 80);
    assert_eq!(lines, ["a     b", "one   x", "two"]);
    assert_eq!(text("first<br/>second", 80), ["first", "second"]);
}