aether-tui 0.2.0

A lightweight terminal UI rendering library for building rich CLI applications
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
use tui::testing::{TestTerminal, render_lines};
use tui::{Line, MarkdownBlock, Theme, ViewContext, render_markdown_result};
use unicode_width::UnicodeWidthStr;

fn ctx() -> ViewContext {
    ViewContext::new((80, 24))
}

fn themed_ctx(theme: &Theme) -> ViewContext {
    ViewContext::new_with_theme((80, 24), theme.clone())
}

fn render(md: &str) -> TestTerminal {
    let ctx = ctx();
    render_lines(&render_markdown_result(md, &ctx).to_lines(), 80, 24)
}

fn render_themed(md: &str, theme: &Theme) -> TestTerminal {
    let ctx = themed_ctx(theme);
    render_lines(&render_markdown_result(md, &ctx).to_lines(), 80, 24)
}

fn render_tall(md: &str) -> TestTerminal {
    let ctx = ViewContext::new((80, 100));
    render_lines(&render_markdown_result(md, &ctx).to_lines(), 80, 100)
}

fn render_tall_themed(md: &str, theme: &Theme) -> TestTerminal {
    let ctx = ViewContext::new_with_theme((80, 100), theme.clone());
    render_lines(&render_markdown_result(md, &ctx).to_lines(), 80, 100)
}

fn find_row(term: &TestTerminal, text: &str) -> Option<usize> {
    term.get_lines().iter().position(|line| line.contains(text))
}

fn all_text(term: &TestTerminal) -> String {
    term.get_lines().join("\n")
}

/// Assert the joined terminal output contains every needle.
fn assert_contains_all(term: &TestTerminal, needles: &[&str]) {
    let text = all_text(term);
    for needle in needles {
        assert!(text.contains(needle), "Expected to find {needle:?} in:\n{text}");
    }
}

fn row_inner_display_widths(row: &str) -> Vec<usize> {
    let segments: Vec<&str> = row.split('').collect();
    if segments.len() < 3 {
        return Vec::new();
    }
    segments[1..segments.len() - 1].iter().map(|s| UnicodeWidthStr::width(*s)).collect()
}

#[test]
fn plain_text_passes_through() {
    assert_eq!(render("hello world").get_lines()[0], "hello world");
}

#[test]
fn heading_renders_with_prefix_and_style() {
    let term = render("# Title");
    let row = find_row(&term, "# Title").expect("heading row not found");
    assert!(term.get_lines()[row].contains("# Title"));
    assert!(term.style_of_text(row, "Title").unwrap().bold);
}

fn find_block(blocks: &[MarkdownBlock], anchor: usize) -> &MarkdownBlock {
    blocks
        .iter()
        .find(|block| block.anchor_line_no == anchor)
        .unwrap_or_else(|| panic!("no block anchored at source line {anchor}; blocks={blocks:?}"))
}

#[test]
fn block_metadata_anchors_heading_and_paragraph_lines() {
    let md = "# Title\n\nParagraph with **bold**\nsecond line";
    let result = render_markdown_result(md, &ctx());

    let anchors: Vec<_> = result.blocks.iter().map(|block| block.anchor_line_no).collect();
    assert_eq!(anchors, vec![1, 3]);
    let heading_text = &result.lines[find_block(&result.blocks, 1).rendered_line_range.clone()];
    assert_eq!(heading_text.len(), 1);
    assert!(heading_text[0].line.plain_text().contains("Title"));
}

#[test]
fn block_metadata_excludes_blank_separator_rows() {
    let md = "first\n\nsecond";
    let result = render_markdown_result(md, &ctx());

    let blocks: Vec<_> = result.blocks.iter().map(|block| block.anchor_line_no).collect();
    assert_eq!(blocks, vec![1, 3]);

    for block in &result.blocks {
        for line in &result.lines[block.rendered_line_range.clone()] {
            assert!(!line.line.plain_text().is_empty(), "block should not include blank separator rows");
        }
    }
}

#[test]
fn block_metadata_tracks_list_items_individually() {
    let md = "- alpha\n- beta\n- gamma";
    let result = render_markdown_result(md, &ctx());

    let anchors: Vec<_> = result.blocks.iter().map(|block| block.anchor_line_no).collect();
    assert_eq!(anchors, vec![1, 2, 3]);
}

#[test]
fn block_metadata_treats_fenced_code_block_as_single_block() {
    let md = "intro\n\n```rust\nlet x = 1;\nlet y = 2;\n```";
    let result = render_markdown_result(md, &ctx());

    let code_block = find_block(&result.blocks, 3);
    let rendered_code: Vec<_> =
        result.lines[code_block.rendered_line_range.clone()].iter().map(|line| line.line.plain_text()).collect();
    assert!(rendered_code.iter().any(|text| text.contains("let x = 1")));
    assert!(rendered_code.iter().any(|text| text.contains("let y = 2")));
}

#[test]
fn block_metadata_treats_table_as_single_block() {
    let md = "paragraph\n\n| A | B |\n|---|---|\n| 1 | 2 |";
    let result = render_markdown_result(md, &ctx());

    let table_block = find_block(&result.blocks, 3);
    let rendered_table: Vec<_> =
        result.lines[table_block.rendered_line_range.clone()].iter().map(|line| line.line.plain_text()).collect();
    assert!(rendered_table.iter().any(|text| text.contains('')));
}

#[test]
fn parse_only_heading_extraction_matches_renderer_headings() {
    let md = "# One\n\nbody\n\n## Two\nmore\n\n### Three";
    let rendered = render_markdown_result(md, &ctx());
    let extracted = tui::parse_markdown_headings(md);

    assert_eq!(extracted, rendered.headings);
    assert_eq!(extracted.len(), 3);
    assert_eq!(extracted[0].source_line_no, 1);
    assert_eq!(extracted[1].source_line_no, 5);
    assert_eq!(extracted[2].source_line_no, 8);
}

#[test]
fn display_render_wrapper_keeps_existing_output() {
    let md = "# Title\n\nfirst line\nsecond line\n\n- item";
    let rendered = render_markdown_result(md, &ctx()).to_lines();
    let text: Vec<_> = rendered.iter().map(Line::plain_text).collect();

    assert_eq!(
        text,
        vec![
            "# Title".to_string(),
            String::new(),
            "first line second line".to_string(),
            String::new(),
            "- item".to_string(),
        ]
    );
}

#[test]
fn inline_formatting_styles() {
    type StyleCase = (&'static str, &'static str, &'static str, fn(&tui::Style) -> bool);
    let cases: &[StyleCase] = &[
        ("some **bold** text", "some bold text", "bold", |s| s.bold),
        ("some *italic* text", "some italic text", "italic", |s| s.italic),
        ("some ~~struck~~ text", "some struck text", "struck", |s| s.strikethrough),
        ("***bold and italic***", "bold and italic", "bold and italic", |s| s.bold && s.italic),
    ];
    for (md, expected_text, styled_span, check) in cases {
        let term = render(md);
        assert_eq!(term.get_lines()[0].trim(), *expected_text, "md={md}");
        let style = term.style_of_text(0, styled_span).unwrap();
        assert!(check(&style), "style check failed for md={md}");
    }
}

#[test]
fn inline_code_has_code_style() {
    let theme = Theme::default();
    let term = render_themed("use `foo()` here", &theme);
    assert_eq!(term.get_lines()[0].trim(), "use foo() here");
    assert_eq!(term.style_of_text(0, "foo()").unwrap().fg, Some(theme.code_fg()));
}

#[test]
fn fenced_code_block_produces_lines() {
    assert!(all_text(&render("```rust\nfn main() {}\n```")).contains("fn main()"));
}

#[test]
fn list_items_render() {
    let cases: &[(&str, &[&str])] = &[
        ("- alpha\n- beta\n- gamma", &["- alpha", "- beta", "- gamma"]),
        ("1. first\n2. second\n3. third", &["1. first", "2. second", "3. third"]),
    ];
    for (md, expected) in cases {
        let term = render(md);
        let output = term.get_lines();
        for item in *expected {
            assert!(output.iter().any(|t| t.contains(item)), "Missing {item:?} in {md}");
        }
    }
}

#[test]
fn tight_list_items_are_not_double_spaced() {
    let term = render("1. first\n2. second\n3. third");

    let first_row = find_row(&term, "1. first").expect("first list item row not found");
    let second_row = find_row(&term, "2. second").expect("second list item row not found");
    let third_row = find_row(&term, "3. third").expect("third list item row not found");

    assert_eq!(second_row - first_row, 1);
    assert_eq!(third_row - second_row, 1);
}

#[test]
fn loose_list_item_with_nested_list_has_matching_spacing_before_next_sibling() {
    let term = render("1. first\n\n   - nested a\n   - nested b\n2. second");
    let output = term.get_lines();

    let first_row = find_row(&term, "1. first").expect("first list item row not found");
    let nested_first_item_row = find_row(&term, "nested a").expect("nested list item row not found");
    let nested_second_item_row = find_row(&term, "nested b").expect("nested list item row not found");
    let second_row = find_row(&term, "2. second").expect("second list item row not found");

    assert_eq!(nested_first_item_row - first_row, 2);
    assert!(output[first_row + 1].is_empty());
    assert_eq!(second_row - nested_second_item_row, 2);
    assert!(output[nested_second_item_row + 1].is_empty());
}

#[test]
fn tight_nested_list_keeps_next_sibling_compact() {
    let term = render("- outer\n  - inner\n- sibling");

    let inner_row = find_row(&term, "inner").expect("nested list item row not found");
    let sibling_row = find_row(&term, "sibling").expect("sibling list item row not found");

    assert_eq!(sibling_row - inner_row, 1);
}

#[test]
fn list_followed_by_paragraph_has_single_blank_row() {
    let term = render("- one\n- two\n\nafter");
    let output = term.get_lines();

    let one_row = find_row(&term, "- one").expect("first list item row not found");
    let two_row = find_row(&term, "- two").expect("second list item row not found");
    let after_row = find_row(&term, "after").expect("paragraph row not found");

    assert_eq!(two_row - one_row, 1);
    assert_eq!(after_row - two_row, 2);
    assert!(output[two_row + 1].is_empty());
}

#[test]
fn blockquote_is_indented() {
    let theme = Theme::default();
    let term = render_themed("> quoted text", &theme);
    let output = term.get_lines();
    let row = find_row(&term, "quoted text").expect("quoted text row not found");
    assert!(output[row].starts_with("  quoted text"));
    let style = term.style_of_text(row, "quoted text").unwrap();
    assert_eq!(style.fg, Some(theme.blockquote()));
    assert!(!style.dim);
}

#[test]
fn horizontal_rule() {
    assert!(all_text(&render("above\n\n---\n\nbelow")).contains("───"));
}

#[test]
fn link_is_underlined() {
    let theme = Theme::default();
    let term = render_themed("click [here](https://example.com)", &theme);
    let style = term.style_of_text(0, "here").unwrap();
    assert!(style.underline);
    assert_eq!(style.fg, Some(theme.link()));
}

#[test]
fn empty_input_returns_empty() {
    assert!(render_markdown_result("", &ctx()).to_lines().is_empty());
}

#[test]
fn multiple_paragraphs_have_single_blank_row() {
    let term = render("para one\n\npara two");
    let output = term.get_lines();

    let para_one_row = find_row(&term, "para one").expect("first paragraph row not found");
    let para_two_row = find_row(&term, "para two").expect("second paragraph row not found");

    assert_eq!(para_two_row - para_one_row, 2);
    assert!(output[para_one_row + 1].is_empty());
}

#[test]
fn unknown_language_falls_back_to_plain() {
    let theme = Theme::default();
    let term = render_themed("```nosuchlang\nsome code\n```", &theme);
    assert!(all_text(&term).contains("some code"));
    let row = find_row(&term, "some code").expect("code row not found");
    assert_eq!(term.style_of_text(row, "some code").unwrap().fg, Some(theme.code_fg()));
}

#[test]
fn nested_list_indents() {
    let output = render("- outer\n  - inner").get_lines();
    let inner = output.iter().find(|t| t.contains("inner")).unwrap();
    let outer = output.iter().find(|t| t.contains("outer")).unwrap();
    assert!(inner.len() - inner.trim_start().len() > outer.len() - outer.trim_start().len());
}

#[test]
fn highlight_cache_returns_consistent_results() {
    let ctx = ctx();
    let md = "```rust\nfn main() {}\n```";
    let first = render_markdown_result(md, &ctx).to_lines();
    let second = render_markdown_result(md, &ctx).to_lines();
    assert_eq!(first, second);

    let md2 = "```rust\nfn b() {}\n```";
    let lines2 = render_markdown_result(md2, &ctx).to_lines();
    assert_ne!(
        first.iter().map(Line::plain_text).collect::<String>(),
        lines2.iter().map(Line::plain_text).collect::<String>(),
    );
}

#[test]
fn simple_table_renders_correctly() {
    let md = "| Name | Age | City |\n|------|-----|------|\n| Alice | 30 | NYC |\n| Bob | 25 | LA |";
    let term = render_tall(md);
    let output = term.get_lines();
    let text = all_text(&term);
    let non_empty: Vec<&String> = output.iter().filter(|t| !t.is_empty()).collect();

    for ch in ['', '', '', '', '', '', '', '', '', ''] {
        assert!(text.contains(ch), "Missing table char {ch:?}");
    }
    assert_eq!(output.iter().filter(|t| t.contains('')).count(), 1);
    assert_eq!(non_empty.len(), 6);
    assert_contains_all(&term, &["Alice", "30", "NYC", "Bob", "25", "LA"]);
    assert!(!output.iter().any(|t| t.trim() == "Alice"), "Table content leaked to standalone line");
}

#[test]
fn table_with_alignment() {
    let md = "| Left | Center | Right |\n|:-----|:------:|------:|\n| L | C | R |";
    assert_contains_all(&render_tall(md), &["Left", "Center", "Right"]);
}

#[test]
fn table_with_empty_cells() {
    let term = render_tall("| A | B | C |\n|---|---|---|\n| 1 |   | 3 |");
    let text = all_text(&term);
    assert!(text.contains(''));
    assert!(text.contains('1'));
    assert!(text.contains('3'));
}

#[test]
fn table_cell_inline_code_does_not_leak_line() {
    let term = render_tall("| A | B |\n|---|---|\n| `x` and **y** | z |");
    let output = term.get_lines();
    let non_empty: Vec<&String> = output.iter().filter(|t| !t.is_empty()).collect();

    assert_eq!(non_empty.len(), 5);
    assert!(!output.iter().any(|t| t.trim() == "x"), "Inline code leaked outside table");
    let body_row =
        output.iter().find(|t| t.starts_with('') && t.contains("and y")).expect("Expected a rendered table body row");
    assert!(body_row.contains('x'));
}

#[test]
fn table_cell_preserves_inline_styles() {
    let theme = Theme::default();
    let md = "| A | B | C |\n|---|---|---|\n| **bold** | [link](https://example.com) | `code` |";
    let term = render_tall_themed(md, &theme);

    let bold_row = find_row(&term, "bold").expect("bold row not found");
    assert!(term.style_of_text(bold_row, "bold").unwrap().bold);

    let link_row = find_row(&term, "link").expect("link row not found");
    let link_style = term.style_of_text(link_row, "link").unwrap();
    assert!(link_style.underline);
    assert_eq!(link_style.fg, Some(theme.link()));

    let code_row = find_row(&term, "code").expect("code row not found");
    assert_eq!(term.style_of_text(code_row, "code").unwrap().fg, Some(theme.code_fg()));
}

#[test]
fn table_unicode_alignment_uses_display_width() {
    let md = "| Left | Right |\n|------|-------|\n| a | 你 |\n| bb | 😀 |";
    let output = render_tall(md).get_lines();
    let row_texts: Vec<&String> = output.iter().filter(|t| t.starts_with('')).collect();

    assert!(row_texts.len() >= 3);
    let expected = row_inner_display_widths(row_texts[0]);
    for row in row_texts.iter().skip(1) {
        assert_eq!(row_inner_display_widths(row), expected);
    }
}

#[test]
fn table_row_cell_count_normalization() {
    let md = "| A | B | C |\n|---|---|---|\n| 1 | 2 |\n| 3 | 4 | 5 | 6 |";
    let output = render_tall(md).get_lines();
    let row_texts: Vec<&String> = output.iter().filter(|t| t.starts_with('')).collect();

    assert_eq!(row_texts.len(), 3);
    for row in &row_texts {
        assert_eq!(row.matches('').count(), 4);
        assert_eq!(row_inner_display_widths(row).len(), 3);
    }
}

#[test]
fn table_in_paragraph_context() {
    let md = "Here is a table:\n\n| Item | Price |\n|------|-------|\n| Apple | $1.00 |\n| Orange | $1.50 |\n\nThat's the table.";
    assert_contains_all(&render_tall(md), &["Here is a table:", "That's the table.", "Apple", "$1.00"]);
}

#[test]
fn table_single_column() {
    let term = render_tall("| Value |\n|--------|\n| Hello |");
    let text = all_text(&term);
    assert!(text.contains(''));
    assert!(text.contains(''));
    assert!(text.contains("Hello"));
}