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

use super::RULE;
use crate::log::init_test_log;

#[test]
fn test_detects_unchecked_complete_result() {
    init_test_log();
    let bad_code = r"
let result = (^sed -i 's/foo/bar/g' file.txt | complete)
";

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detects_when_only_stderr_checked_not_exit_code() {
    init_test_log();
    let bad_code = r#"
let result = (^sed -i 's/old/new/g' config.txt | complete)
if ($result.stderr | is-empty) {
    print "ok"
}
"#;

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detects_stored_complete_result_never_accessed() {
    init_test_log();
    let bad_code = r#"
let result = (^rm -rf /tmp/build | complete)
print "Build finished"
"#;

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detects_mixed_complete_calls_with_unchecked_result() {
    init_test_log();
    let bad_code = r"
let success1 = (^sed -i '' file1.txt | complete | get exit_code) == 0
let result2 = (^sed -i '' file2.txt | complete)
if $success1 {
    print 'command1 succeeded'
}
";

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detects_outer_complete_when_inner_exit_code_checked() {
    init_test_log();
    let bad_code = r"
let inner = (^sed -i '' inner.txt | complete | get exit_code)
let outer = (^sed -i '' outer.txt | complete)
if $inner != 0 {
    print 'inner failed'
}
";

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detects_cat_command_without_exit_code_check() {
    init_test_log();
    let bad_code = r"
let result = (^cat file.txt | complete)
";

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detects_grep_command_without_exit_code_check() {
    init_test_log();
    let bad_code = r"
let result = (^grep pattern file.txt | complete)
";

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detects_find_command_without_exit_code_check() {
    init_test_log();
    let bad_code = r"
let result = (^find . -name '*.rs' | complete)
";

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detects_git_pull_without_exit_code_check() {
    init_test_log();
    let bad_code = r"
let result = (^git pull | complete)
";

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detects_curl_without_exit_code_check() {
    init_test_log();
    let bad_code = r"
let result = (^curl https://example.com | complete)
";

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detects_git_clone_without_exit_code_check() {
    init_test_log();
    let bad_code = r"
let result = (^git clone https://github.com/user/repo | complete)
";

    RULE.assert_detects(bad_code);
}

#[test]
fn test_suggestion_includes_actual_variable_name() {
    let bad_code = r"
let my_result = (^sed -i 's/foo/bar/g' file.txt | complete)
";

    RULE.assert_detects(bad_code);
}

#[test]
fn test_suggestion_includes_external_command_name() {
    let bad_code = r"
let result = (^rm -rf /tmp/build | complete)
";

    RULE.assert_detects(bad_code);
}

#[test]
fn test_suggestion_adapts_to_different_variable_names() {
    let bad_code = r"
mut fetch_output = (^sed -i '' config.txt | complete)
";

    RULE.assert_detects(bad_code);
}

#[test]
fn test_violation_message_mentions_specific_external_command() {
    let bad_code = r"
let status = (^sed -i 's/x/y/g' service.txt | complete)
";

    RULE.assert_detects(bad_code);
}