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

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

#[test]
fn test_detect_main_with_match_dispatch_three_branches() {
    init_test_log();
    let bad_code = r#"
def main [
    command?: string
] {
    match $command {
        "info" => { print "info" }
        "adjust" => { print "adjust" }
        "test" => { print "test" }
        _ => { print "Usage: ..." }
    }
}
"#;

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detect_main_with_match_dispatch_four_branches() {
    init_test_log();
    let bad_code = r#"
def main [
    cmd?: string
] {
    match $cmd {
        "start" => { run-start }
        "stop" => { run-stop }
        "restart" => { run-restart }
        "status" => { run-status }
        _ => { print "Unknown command" }
    }
}
"#;

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detect_main_with_default_string_param() {
    init_test_log();
    let bad_code = r#"
def main [
    action: string = "help"
] {
    match $action {
        "build" => { do-build }
        "test" => { do-test }
        "deploy" => { do-deploy }
        _ => { show-help }
    }
}
"#;

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detect_main_with_flags_and_dispatch() {
    init_test_log();
    let bad_code = r#"
def main [
    command?: string
    --verbose (-v)
] {
    match $command {
        "info" => { show-info $verbose }
        "debug" => { show-debug $verbose }
        "trace" => { show-trace $verbose }
        _ => { print "Usage" }
    }
}
"#;

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detect_only_one_violation_for_main() {
    init_test_log();
    let bad_code = r#"
def main [
    command?: string
] {
    match $command {
        "a" => { 1 }
        "b" => { 2 }
        "c" => { 3 }
        _ => { 0 }
    }
}
"#;

    RULE.assert_count(bad_code, 1);
}