mdstream 0.2.0

Streaming-first Markdown middleware for LLM output (committed + pending blocks, render-agnostic).
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

mod support;

use mdstream::{BlockKind, Options};

#[test]
fn list_allows_blank_line_between_items_chunking_invariance() {
    let markdown = "- item 1\n\n- item 2\n\nAfter\n";

    let opts = Options::default();
    let blocks_whole = support::collect_final_blocks(support::chunk_whole(markdown), opts.clone());
    let blocks_lines = support::collect_final_blocks(support::chunk_lines(markdown), opts.clone());
    let blocks_rand = support::collect_final_blocks(
        support::chunk_pseudo_random(markdown, "list_blank_line_between_items", 0, 40),
        opts.clone(),
    );

    assert_eq!(blocks_lines, blocks_whole);
    assert_eq!(blocks_rand, blocks_whole);

    assert_eq!(blocks_whole.len(), 2);
    assert_eq!(blocks_whole[0].0, BlockKind::List);
    assert!(blocks_whole[0].1.contains("- item 1\n\n- item 2\n\n"));
    assert_eq!(blocks_whole[1].0, BlockKind::Paragraph);
    assert_eq!(blocks_whole[1].1, "After\n");
}

#[test]
fn list_allows_multiline_item_then_next_item_chunking_invariance() {
    let markdown = "- item 1\n  continued line\n- item 2\n\nAfter\n";

    let opts = Options::default();
    let blocks_whole = support::collect_final_blocks(support::chunk_whole(markdown), opts.clone());
    let blocks_lines = support::collect_final_blocks(support::chunk_lines(markdown), opts.clone());
    let blocks_rand = support::collect_final_blocks(
        support::chunk_pseudo_random(markdown, "list_multiline_item_then_next_item", 0, 40),
        opts.clone(),
    );

    assert_eq!(blocks_lines, blocks_whole);
    assert_eq!(blocks_rand, blocks_whole);

    assert_eq!(blocks_whole.len(), 2);
    assert_eq!(blocks_whole[0].0, BlockKind::List);
    assert!(
        blocks_whole[0]
            .1
            .contains("- item 1\n  continued line\n- item 2\n\n")
    );
    assert_eq!(blocks_whole[1].1, "After\n");
}

#[test]
fn list_allows_blank_line_then_indented_continuation_chunking_invariance() {
    let markdown = "- item 1\n\n  continuation after blank\n- item 2\n\nAfter\n";

    let opts = Options::default();
    let blocks_whole = support::collect_final_blocks(support::chunk_whole(markdown), opts.clone());
    let blocks_lines = support::collect_final_blocks(support::chunk_lines(markdown), opts.clone());
    let blocks_rand = support::collect_final_blocks(
        support::chunk_pseudo_random(
            markdown,
            "list_blank_line_then_indented_continuation",
            0,
            40,
        ),
        opts.clone(),
    );

    assert_eq!(blocks_lines, blocks_whole);
    assert_eq!(blocks_rand, blocks_whole);

    assert_eq!(blocks_whole.len(), 2);
    assert_eq!(blocks_whole[0].0, BlockKind::List);
    assert!(
        blocks_whole[0]
            .1
            .contains("- item 1\n\n  continuation after blank\n- item 2\n\n")
    );
    assert_eq!(blocks_whole[1].1, "After\n");
}

#[test]
fn task_list_items_are_stable_chunking_invariance() {
    let markdown = "- [x] done\n  more\n- [ ] todo\n\nAfter\n";

    let opts = Options::default();
    let blocks_whole = support::collect_final_blocks(support::chunk_whole(markdown), opts.clone());
    let blocks_lines = support::collect_final_blocks(support::chunk_lines(markdown), opts.clone());
    let blocks_rand = support::collect_final_blocks(
        support::chunk_pseudo_random(markdown, "task_list_items_are_stable", 0, 40),
        opts.clone(),
    );

    assert_eq!(blocks_lines, blocks_whole);
    assert_eq!(blocks_rand, blocks_whole);

    assert_eq!(blocks_whole.len(), 2);
    assert_eq!(blocks_whole[0].0, BlockKind::List);
    assert!(
        blocks_whole[0]
            .1
            .contains("- [x] done\n  more\n- [ ] todo\n\n")
    );
    assert_eq!(blocks_whole[1].1, "After\n");
}

#[test]
fn blockquote_lazy_continuation_is_stable_chunking_invariance() {
    let markdown = "> quote line 1\nlazy continuation\n> quote line 2\n\nAfter\n";

    let opts = Options::default();
    let blocks_whole = support::collect_final_blocks(support::chunk_whole(markdown), opts.clone());
    let blocks_lines = support::collect_final_blocks(support::chunk_lines(markdown), opts.clone());
    let blocks_rand = support::collect_final_blocks(
        support::chunk_pseudo_random(markdown, "blockquote_lazy_continuation_is_stable", 0, 40),
        opts.clone(),
    );

    assert_eq!(blocks_lines, blocks_whole);
    assert_eq!(blocks_rand, blocks_whole);

    assert_eq!(blocks_whole.len(), 2);
    assert_eq!(blocks_whole[0].0, BlockKind::BlockQuote);
    assert!(
        blocks_whole[0]
            .1
            .contains("> quote line 1\nlazy continuation\n> quote line 2\n\n")
    );
    assert_eq!(blocks_whole[1].1, "After\n");
}