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

use super::RULE;

#[test]
fn test_ignore_path_type_used() {
    let code = r"
def copy-file [source_path: path, dest_path: path] {
    cp $source_path $dest_path
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_string_without_path_name() {
    let code = r"
def greet [name: string, message: string] {
    print $'Hello ($name): ($message)'
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_no_type_annotation() {
    let code = r"
def process [input_data] {
    $input_data | to json
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_non_string_with_path_name() {
    let code = r"
def count-paths [path_count: int] {
    print $path_count
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_record_type_with_path() {
    let code = r"
def process-config [config: record] {
    let path = $config.file_path
    open $path
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_table_type() {
    let code = r"
def filter-paths [paths: table] {
    $paths | where type == 'file'
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_list_of_paths() {
    let code = r"
def backup-files [file_paths: list<path>] {
    for path in $file_paths {
        cp $path backup/
    }
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_closure_parameter() {
    let code = r"
def each-path [callback: closure] {
    ['a.txt', 'b.txt'] | each $callback
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_xpath_string() {
    let code = r"
def query-xml [xpath: string, xml_data: string] {
    # XPath is not a filesystem path
    $xml_data | query web $xpath
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_jsonpath_string() {
    let code = r"
def query-json [jsonpath: string, data: string] {
    # JSONPath is not a filesystem path
    $data | from json | query $jsonpath
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_classpath_string() {
    let code = r"
def run-java [class_path: string, main_class: string] {
    # Java classpath is not a filesystem path
    ^java -cp $class_path $main_class
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_external_command_without_path_name() {
    let code = r"
def compress [input: string, output: string] {
    tar czf $output $input
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_grep_with_pattern() {
    let code = r"
def search [pattern: string, text: string] {
    grep $pattern $text
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_sed_with_replacement() {
    let code = r"
def replace [pattern: string, replacement: string, input: string] {
    sed $pattern $replacement $input
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_docker_with_image_name() {
    let code = r"
def build [image: string, tag: string] {
    docker build -t $image:$tag .
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_git_with_branch() {
    let code = r"
def switch-branch [branch: string] {
    git checkout $branch
}
";
    RULE.assert_ignores(code);
}

#[test]
fn test_ignore_last_profile_false_positive() {
    let code = r#"
def handle_profile_change [last_profile: string] {
    sleep 500ms
    let profile = (get_current_profile)
    if $profile != $last_profile {
        print $"Profile changed from '($last_profile)' to '($profile)'"
        trigger_profile_service $profile
        $profile
    } else {
        $last_profile
    }
}
"#;
    RULE.assert_ignores(code);
}