mdqy 0.1.4

jq for markdown: query and transform Markdown with a hybrid selector and jq DSL
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

//! Black-box tests for the `mdqy` binary. Drives the CLI through
//! `assert_cmd` so scripts that depend on flag semantics get early
//! warning when behaviour drifts.

use assert_cmd::Command;
use predicates::prelude::*;
use std::fs;

const TINY: &str = "tests/fixtures/tiny.md";

fn mdqy() -> Command {
    Command::cargo_bin("mdqy").expect("binary built")
}

#[test]
fn output_json_contains_node_schema_keys() {
    mdqy()
        .args(["--output", "json", "headings | .text", TINY])
        .assert()
        .success()
        .stdout(predicate::str::contains("Tiny"))
        .stdout(predicate::str::contains("Second heading"));
}

#[test]
fn null_input_runs_without_a_file() {
    mdqy()
        .args(["-n", "1 + 2"])
        .assert()
        .success()
        .stdout(predicate::str::contains("3"));
}

#[test]
fn raw_input_binds_source_string() {
    mdqy()
        .args(["-R", "--stdin", "."])
        .write_stdin("hello\n")
        .assert()
        .success()
        .stdout(predicate::str::contains("hello"));
}

#[test]
fn slurp_binds_array_of_roots() {
    mdqy()
        .args(["--slurp", "length", TINY])
        .assert()
        .success()
        .stdout(predicate::str::contains("1"));
}

/// Without `-U` or `--dry-run`, mutation expressions don't modify
/// the input file. The CLI runs eval (not `transform_bytes`), so
/// disk state is untouched even when the expression contains `|=`,
/// `del`, or `walk`.
#[test]
fn no_in_place_flag_leaves_file_untouched() {
    let tmp = tempfile::NamedTempFile::new().unwrap();
    fs::write(tmp.path(), b"# Hi\n").unwrap();
    let before = fs::read(tmp.path()).unwrap();
    let _ = mdqy()
        .args([".level |= 99", tmp.path().to_str().unwrap()])
        .assert();
    assert_eq!(fs::read(tmp.path()).unwrap(), before);
}

#[test]
fn dry_run_prints_diff_does_not_write() {
    let tmp = tempfile::NamedTempFile::new().unwrap();
    fs::write(tmp.path(), b"See [x](http://e.com).\n").unwrap();
    let before = fs::read(tmp.path()).unwrap();
    mdqy()
        .args([
            "--dry-run",
            r#"(.. | select(type == "link")).href |= sub("http:"; "https:")"#,
            tmp.path().to_str().unwrap(),
        ])
        .assert()
        .success()
        .stdout(predicate::str::contains("-See"))
        .stdout(predicate::str::contains("+See"));
    assert_eq!(fs::read(tmp.path()).unwrap(), before);
}

#[test]
fn in_place_rewrites_file() {
    let tmp = tempfile::NamedTempFile::new().unwrap();
    fs::write(tmp.path(), b"[x](http://e.com)\n").unwrap();
    mdqy()
        .args([
            "-U",
            r#"(.. | select(type == "link")).href |= sub("http:"; "https:")"#,
            tmp.path().to_str().unwrap(),
        ])
        .assert()
        .success();
    let after = fs::read_to_string(tmp.path()).unwrap();
    assert!(after.contains("https://e.com"), "got: {after}");
    assert!(!after.contains("http://e.com"), "got: {after}");
}

#[test]
fn with_path_tags_json_output() {
    mdqy()
        .args(["--output", "json", "--with-path", "headings | .text", TINY])
        .assert()
        .success()
        .stdout(predicate::str::contains("\"path\""))
        .stdout(predicate::str::contains(TINY));
}

#[test]
fn compile_error_exits_with_caret() {
    mdqy()
        .args([". ~ garbage", TINY])
        .assert()
        .failure()
        .stderr(predicate::str::contains("^"));
}

#[test]
fn workers_preserves_sequential_output() {
    let dir = tempfile::tempdir().unwrap();
    for (name, body) in [
        ("a.md", "# A\n## A-sub\n"),
        ("b.md", "# B\n## B-sub\n"),
        ("c.md", "# C\n## C-sub\n"),
        ("d.md", "# D\n## D-sub\n"),
    ] {
        fs::write(dir.path().join(name), body).unwrap();
    }
    let serial = mdqy()
        .args(["headings | .text", dir.path().to_str().unwrap()])
        .assert()
        .success()
        .get_output()
        .stdout
        .clone();
    let parallel = mdqy()
        .args([
            "--workers",
            "4",
            "headings | .text",
            dir.path().to_str().unwrap(),
        ])
        .assert()
        .success()
        .get_output()
        .stdout
        .clone();
    assert_eq!(serial, parallel);
}

#[test]
fn arg_and_argjson_bind_variables() {
    mdqy()
        .args(["--arg", "name", "World", "-n", r#""hi " + $name"#])
        .assert()
        .success()
        .stdout(predicate::str::contains("hi World"));

    mdqy()
        .args(["--argjson", "n", "41", "-n", "$n + 1"])
        .assert()
        .success()
        .stdout(predicate::str::contains("42"));
}