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

use super::RULE;

#[test]
fn test_ignore_native_subcommands() {
    let good = r#"
def main [] {
    print "Use --help to see subcommands"
}

def "main info" [] {
    print "Info subcommand"
}

def "main adjust" [] {
    print "Adjust subcommand"
}
"#;

    RULE.assert_ignores(good);
}

#[test]
fn test_ignore_main_without_match() {
    let good = r#"
def main [
    file: path
] {
    open $file | process
}
"#;

    RULE.assert_ignores(good);
}

#[test]
fn test_ignore_match_on_non_command_variable() {
    let good = r#"
def main [
    level?: int
] {
    match $level {
        1 => { "low" }
        2 => { "medium" }
        3 => { "high" }
        _ => { "unknown" }
    }
}
"#;

    RULE.assert_ignores(good);
}

#[test]
fn test_ignore_match_with_only_wildcard() {
    let good = r#"
def main [
    mode?: string
] {
    match $mode {
        _ => { run-normal }
    }
}
"#;

    RULE.assert_ignores(good);
}

#[test]
fn test_ignore_non_main_function_with_dispatch() {
    let good = r#"
def process-command [
    command?: string
] {
    match $command {
        "a" => { 1 }
        "b" => { 2 }
        "c" => { 3 }
        _ => { 0 }
    }
}

def main [] {
    process-command "a"
}
"#;

    RULE.assert_ignores(good);
}

#[test]
fn test_ignore_main_with_match_on_different_variable() {
    let good = r#"
def main [
    command?: string
    mode?: string
] {
    let status = "ready"
    match $status {
        "ready" => { do-ready }
        "pending" => { do-pending }
        "done" => { do-done }
        _ => { do-unknown }
    }
}
"#;

    RULE.assert_ignores(good);
}

#[test]
fn test_ignore_exported_main_with_subcommands() {
    let good = r#"
export def main [] {
    print "Module with subcommands"
}

export def "main sub1" [] {
    print "sub1"
}

export def "main sub2" [] {
    print "sub2"
}
"#;

    RULE.assert_ignores(good);
}

#[test]
fn test_ignore_main_using_if_chain() {
    let good = r#"
def main [
    command?: string
] {
    if $command == "info" {
        print "info"
    } else if $command == "debug" {
        print "debug"
    } else {
        print "usage"
    }
}
"#;

    RULE.assert_ignores(good);
}

#[test]
fn test_ignore_required_string_param_not_dispatched() {
    let good = r#"
def main [
    message: string
] {
    print $message
}
"#;

    RULE.assert_ignores(good);
}