mdv 4.2.0

Terminal Markdown Viewer
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

use super::*;

#[test]
fn test_inline_table_link_style_inside_text_code_block_pretty() {
    let temp_file = NamedTempFile::new().unwrap();
    fs::write(
        &temp_file,
        "# Demo\n\n```text\nThis is a [link](https://example.com/example-path)\n```\n",
    )
    .unwrap();

    let mut cmd = mdv_cmd();
    cmd.arg("--code-block-style")
        .arg("pretty")
        .arg("-u")
        .arg("it")
        .arg("--link-truncation")
        .arg("none")
        .arg("--cols")
        .arg("80")
        .arg("--no-colors")
        .arg(temp_file.path());

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("╭─ Text"))
        .stdout(predicate::str::contains("│ This is a link[1]"))
        .stdout(predicate::str::contains(
            "[1] https://example.com/example-path",
        ))
        .stdout(predicate::str::contains("│ [1] https://example.com/example-path").not())
        .stdout(predicate::str::contains("[link](").not());
}

#[test]
fn test_inline_table_link_style_inside_text_code_block_simple() {
    let temp_file = NamedTempFile::new().unwrap();
    fs::write(
        &temp_file,
        "# Demo\n\n```text\nThis is a [link](https://example.com/example-path)\n```\n",
    )
    .unwrap();

    let mut cmd = mdv_cmd();
    cmd.arg("--code-block-style")
        .arg("simple")
        .arg("-u")
        .arg("it")
        .arg("--link-truncation")
        .arg("none")
        .arg("--cols")
        .arg("80")
        .arg("--no-colors")
        .arg(temp_file.path());

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("│ Text"))
        .stdout(predicate::str::contains("│ This is a link[1]"))
        .stdout(predicate::str::contains(
            "[1] https://example.com/example-path",
        ))
        .stdout(predicate::str::contains("│ [1] https://example.com/example-path").not())
        .stdout(predicate::str::contains("[link](").not());
}

#[test]
fn test_inline_table_table_reference_stays_inside_markdown_code_block() {
    let temp_file = NamedTempFile::new().unwrap();
    fs::write(
        &temp_file,
        "# Demo\n\n```markdown\n| Field | Value |\n| --- | --- |\n| docs | [guide](https://example.com/guide) |\n```\n",
    )
    .unwrap();

    let mut cmd = mdv_cmd();
    cmd.arg("--code-block-style")
        .arg("pretty")
        .arg("-u")
        .arg("it")
        .arg("--link-truncation")
        .arg("none")
        .arg("--cols")
        .arg("90")
        .arg("--no-colors")
        .arg(temp_file.path());

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("guide[1]"))
        .stdout(predicate::str::contains("│ [1] https://example.com/guide"))
        .stdout(predicate::str::contains("\n [1] https://example.com/guide").not());
}

#[test]
fn test_inline_table_mixed_references_split_between_code_body_and_nested_table() {
    let temp_file = NamedTempFile::new().unwrap();
    fs::write(
        &temp_file,
        "# Demo\n\n```markdown\n[text](https://example.com/block)\n| Field | Value |\n| --- | --- |\n| docs | [guide](https://example.com/table) |\n```\n",
    )
    .unwrap();

    let output = mdv_cmd()
        .arg("--code-block-style")
        .arg("pretty")
        .arg("-u")
        .arg("it")
        .arg("--link-truncation")
        .arg("none")
        .arg("--cols")
        .arg("90")
        .arg("--no-colors")
        .arg(temp_file.path())
        .output()
        .expect("run mdv for mixed code block references");

    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).expect("stdout utf8");
    let lines: Vec<&str> = stdout.lines().collect();

    assert!(
        stdout.contains("text[1]"),
        "expected block link marker, stdout:\n{}",
        stdout
    );
    assert!(
        stdout.contains("guide[1]"),
        "expected table link marker with table-local numbering, stdout:\n{}",
        stdout
    );

    let table_reference_idx = lines
        .iter()
        .position(|line| line.contains("│ [1] https://example.com/table"))
        .expect("table reference line inside code block");
    let block_reference_idx = lines
        .iter()
        .position(|line| {
            line.trim_start()
                .starts_with("[1] https://example.com/block")
        })
        .expect("block-level reference line outside code block");
    let code_block_bottom_idx = lines
        .iter()
        .rposition(|line| line.trim_start().starts_with('╰'))
        .expect("code block bottom border present");

    assert!(
        !lines
            .iter()
            .any(|line| line.contains("│ [1] https://example.com/block")),
        "block-level references must not stay inside code block, stdout:\n{}",
        stdout
    );
    assert!(
        table_reference_idx < code_block_bottom_idx,
        "table reference should stay inside code block, stdout:\n{}",
        stdout
    );
    assert!(
        block_reference_idx > code_block_bottom_idx,
        "block-level reference should render after code block, stdout:\n{}",
        stdout
    );
}