nu-lint 1.3.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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

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

#[test]
fn detects_file_and_network_io() {
    init_test_log();
    let bad_code = r"
def main [] {}

def sync-data [] {
    http get https://api.example.com/data | save output.json
}
";
    RULE.assert_detects(bad_code);
}

#[test]
fn detects_file_and_print() {
    init_test_log();
    let bad_code = r#"
def main [] {}

def save-with-log [data] {
    print "Saving data..."
    $data | save output.json
}
"#;
    RULE.assert_detects(bad_code);
}

#[test]
fn detects_network_and_print() {
    init_test_log();
    let bad_code = r#"
def main [] {}

def fetch-with-log [] {
    print "Fetching..."
    http get https://api.example.com/data
}
"#;
    RULE.assert_detects(bad_code);
}

#[test]
fn detects_all_three_io_types() {
    init_test_log();
    let bad_code = r#"
def main [] {}

def process-all [] {
    print "Processing..."
    let data = (http get https://api.example.com/data)
    $data | save output.json
}
"#;
    RULE.assert_detects(bad_code);
}

#[test]
fn detects_file_operations_mixed() {
    init_test_log();
    let bad_code = r#"
def main [] {}

def backup-and-notify [] {
    mkdir /tmp/backup
    print "Backup created"
}
"#;
    RULE.assert_detects(bad_code);
}

#[test]
fn detects_nested_mixed_io() {
    init_test_log();
    let bad_code = r#"
def main [] {}

def complex-operation [] {
    if true {
        print "Starting..."
        http get https://api.example.com/data | save result.json
    }
}
"#;
    RULE.assert_detects(bad_code);
}

#[test]
fn detects_multiple_file_ops_with_network() {
    init_test_log();
    let bad_code = r"
def main [] {}

def download-and-archive [] {
    http get https://api.example.com/file | save /tmp/download.txt
}
";
    RULE.assert_detects(bad_code);
}

#[test]
fn detects_print_with_multiple_file_ops() {
    init_test_log();
    let bad_code = r#"
def main [] {}

def setup-directories [] {
    print "Creating directories..."
    mkdir /tmp/dir1
    mkdir /tmp/dir2
    touch /tmp/dir1/file.txt
}
"#;
    RULE.assert_detects(bad_code);
}

#[test]
fn detects_exported_functions_with_mixed_io() {
    init_test_log();
    let bad_code = r#"
def main [] {}

export def sync [] {
    print "Syncing..."
    http get https://api.example.com/data | save output.json
}
"#;
    RULE.assert_detects(bad_code);
}

#[test]
fn detects_function_without_main() {
    init_test_log();
    let bad_code = r#"
def helper [] {
    print "Helper"
    http get https://api.example.com/data | save output.json
}
"#;
    RULE.assert_detects(bad_code);
}

#[test]
fn detects_multiple_functions_without_main() {
    init_test_log();
    let bad_code = r#"
def fetch-data [] {
    print "Fetching..."
    http get https://api.example.com/data
}

def save-result [data] {
    print "Saving..."
    $data | save output.json
}
"#;
    RULE.assert_detects(bad_code);
}

#[test]
fn detects_library_function_mixing_io() {
    init_test_log();
    let bad_code = r#"
export def sync-data [] {
    print "Syncing data..."
    let data = (http get https://api.example.com/data)
    $data | save local-cache.json
    print "Done"
}
"#;
    RULE.assert_detects(bad_code);
}

#[test]
fn detects_top_level_script_mixing_io() {
    init_test_log();
    let bad_code = r#"
print "Fetching data..."
let data = (http get https://api.example.com/data)
$data | save output.json
print "Done"
"#;
    RULE.assert_detects(bad_code);
}

#[test]
fn detects_top_level_script_network_and_file() {
    init_test_log();
    let bad_code = r"
http get https://api.example.com/file | save download.txt
";
    RULE.assert_detects(bad_code);
}