command-stream 1.2.0

Modern shell command execution library with streaming, async iteration, and event support
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

use super::*;

/// Tokens rendered like Bun's lexer debug output (`$.lex` in tests).
fn toks(src: &str) -> Vec<String> {
    let res = lex(src, &[], 0).unwrap();
    assert!(res.errors.is_empty(), "{:?}", res.errors);
    res.tokens
        .iter()
        .map(|t| match t.range() {
            Some((s, e)) => format!("{}:{}", t.tag().name(), &res.strpool[s..e]),
            None => match t {
                Token::Redirect(f) => format!("Redirect:{}", f.bits()),
                Token::VarArgv(n) => format!("VarArgv:{n}"),
                _ => t.tag().name().to_string(),
            },
        })
        .collect()
}

fn errors(src: &str) -> Vec<String> {
    lex(src, &[], 0).unwrap().errors
}

#[test]
fn words_and_operators() {
    assert_eq!(
        toks("echo hi && ls | wc; x"),
        [
            "Text:echo",
            "Delimit",
            "Text:hi",
            "Delimit",
            "DoubleAmpersand",
            "Text:ls",
            "Delimit",
            "Pipe",
            "Text:wc",
            "Delimit",
            "Semicolon",
            "Text:x",
            "Delimit",
            "Eof"
        ]
    );
}

#[test]
fn quotes_and_vars() {
    assert_eq!(
        toks("echo \"a $FOO\"'b'$1"),
        [
            "Text:echo",
            "Delimit",
            "DoubleQuotedText:a ",
            "Var:FOO",
            "SingleQuotedText:b",
            "VarArgv:1",
            "Eof"
        ]
    );
    assert_eq!(toks("\"\""), ["DoubleQuotedText:", "Eof"]);
    assert_eq!(
        toks("echo \\$x"),
        ["Text:echo", "Delimit", "Text:$x", "Delimit", "Eof"]
    );
}

#[test]
fn redirects() {
    assert_eq!(
        toks("a 2>&1 >> f"),
        [
            "Text:a",
            "Delimit",
            "Redirect:18",
            "Redirect:10",
            "Text:f",
            "Delimit",
            "Eof"
        ]
    );
    assert_eq!(toks("a &> f")[2], "Redirect:6");
    assert_eq!(toks("a &>> f")[2], "Redirect:14");
}

#[test]
fn substitutions() {
    assert_eq!(
        toks("echo $(ls)`pwd`"),
        [
            "Text:echo",
            "Delimit",
            "CmdSubstBegin",
            "Text:ls",
            "Delimit",
            "CmdSubstEnd",
            "CmdSubstBegin",
            "Text:pwd",
            "Delimit",
            "CmdSubstEnd",
            "Eof"
        ]
    );
}

#[test]
fn lexer_errors() {
    assert_eq!(errors("echo $(ls"), ["Unclosed command substitution"]);
    assert_eq!(errors("(ls"), ["Unclosed subshell"]);
    assert_eq!(errors("ls )"), ["Unexpected ')'"]);
    assert_eq!(errors("ls |"), ["Unexpected EOF"]);
    assert_eq!(
        errors("ls |& cat"),
        ["Piping stdout and stderr (`|&`) is not supported yet. Please file an issue on GitHub."]
    );
    assert_eq!(
        errors("echo \x08__bunstr_0\x08"),
        ["Invalid JS string ref (out of bounds"]
    );
    assert!(lex(&"(".repeat(129), &[], 0).is_err());
}

#[test]
fn js_refs() {
    let refs = vec!["a b".to_string()];
    let res = lex("echo \x08__bunstr_0\x08 \x08__bun_0\x08", &refs, 1).unwrap();
    assert!(res.errors.is_empty());
    assert_eq!(res.js_string_ranges, [(4, 7)]);
    assert_eq!(res.tokens[4], Token::JsObjRef(0));
    let res = lex("\"\x08__bun_0\x08\"", &[], 1).unwrap();
    assert_eq!(
        res.errors,
        ["JS object reference not allowed in double quotes"]
    );
}