nu-lint 1.1.0

Linter for Nu shell scripts that helpfully suggests improvements
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

#[test]
fn detects_not_operator_without_escaping() {
    let rule = super::RULE;

    let code = r#"
def bad_example [] {
    let path = "/some/path"
    print $"File ($path) (not x)"
}
"#;

    rule.assert_detects(code);
}

#[test]
fn detects_or_operator_in_conditional_branch() {
    let rule = super::RULE;

    let code = r#"
def write_sysfs [path: string, value: string] {
    if ($path | path exists) {
        do -i { $value | save -f $path }
        print -e $"<7>Set ($path) = ($value)"
    } else {
        print -e $"<7>Skipped ($path) (or)"
    }
}
"#;

    rule.assert_count(code, 1);
}

#[test]
fn detects_and_or_operators_without_escaping() {
    let rule = super::RULE;

    for (keyword, var_val) in [("and", "y"), ("or", "z")] {
        let code = format!(
            r#"
def test [] {{
    let var = "x"
    print $"($var) ({keyword} {var_val})"
}}
"#
        );
        rule.assert_detects(&code);
    }
}

#[test]
fn detects_multiple_unescaped_operators_in_single_string() {
    let rule = super::RULE;

    let code = r#"
def test [] {
    let name = "test"
    print $"Item ($name) (or maybe not) (and another)"
}
"#;

    rule.assert_detects(code);
    rule.assert_count(code, 1); // One string with multiple violations is still one violation
}

#[test]
fn detects_unescaped_operators_in_error_messages() {
    let rule = super::RULE;

    let code = r#"
def bad_error_msg [path: string] {
    error make {
        msg: $"File ($path) (not found or not accessible)"
    }
}
"#;

    rule.assert_detects(code);
}

#[test]
fn detects_and_operator_after_interpolated_values() {
    let rule = super::RULE;

    let code = r#"
def bad_nested [] {
    let a = "x"
    let b = "y"
    print $"Values ($a) and ($b) (and)"
}
"#;

    rule.assert_detects(code);
}

#[test]
fn detects_multiple_unescaped_operators_across_strings() {
    let rule = super::RULE;

    let code = r#"
def test_errors [] {
    let file = "config.txt"
    print $"File ($file) (not x)"
    print $"Access ($file) (and y)"
    print $"Service ($file) (or z)"
}
"#;

    rule.assert_detects(code);
    rule.assert_count(code, 3);
}

#[test]
fn detects_incomplete_comparison_and_arithmetic_operators() {
    let rule = super::RULE;

    let code = r#"
def test_incomplete [] {
    let x = "value"
    print $"Result ($x) (==)"
    print $"Status ($x) (+)"
    print $"Check ($x) (if condition)"
}
"#;

    rule.assert_detects(code);
}

#[test]
fn detects_unescaped_boolean_expressions() {
    let rule = super::RULE;

    let code = r#"
def test_complex [] {
    let x = "test"
    print $"Check ($x) (x > 0 and y < 10)"
    print $"Validate ($x) (not empty and not null)"
}
"#;

    rule.assert_detects(code);
}

#[test]
fn detects_common_unescaped_operator_patterns() {
    let rule = super::RULE;

    let code = r#"
def test_common [] {
    let item = "data"
    print $"Item ($item) (not available)"
    print $"Status ($item) (and more)"
    print $"Result ($item) (or else)"
    print $"Service ($item) (unable to process)"
}
"#;

    rule.assert_detects(code);
}

#[test]
fn detects_unescaped_or_operator_in_ansi_string() {
    let rule = super::RULE;

    let code = r#"
def fix_file [file: string] {
    if $has_errors {
        print $"(ansi yellow)⚠️  Could not apply some fixes to ($file) (or)(ansi reset)"
    } else {
        print $"(ansi green)✅ No issues in ($file)(ansi reset)"
    }
}
"#;

    rule.assert_detects(code);
    rule.assert_count(code, 1);
}