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

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

#[test]
fn test_detect_error_keyword_in_msg() {
    init_test_log();
    let bad_code = r#"
def process-file [file: string] {
    if not ($file | path exists) {
        error make { msg: "error" }
    }
}
"#;

    RULE.assert_detects(bad_code);
    RULE.assert_count(bad_code, 1);
}

#[test]
fn test_detect_failed_keyword_in_msg() {
    init_test_log();
    let bad_code = r#"
def convert-data [input] {
    if ($input | is-empty) {
        error make { msg: "failed" }
    }
}
"#;

    RULE.assert_detects(bad_code);
    RULE.assert_count(bad_code, 1);
}

#[test]
fn test_detect_vague_something_went_wrong_msg() {
    init_test_log();
    let bad_code = r#"
def validate [data] {
    error make { msg: "something went wrong" }
}
"#;

    RULE.assert_detects(bad_code);
    RULE.assert_count(bad_code, 1);
}

#[test]
fn test_detect_short_error_message() {
    init_test_log();
    let bad_code = r#"
def validate [data] {
    error make { msg: "bad input" }
}
"#;

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detect_error_prefix_pattern() {
    init_test_log();
    let bad_code = r#"
def validate [data] {
    error make { msg: "Error: x" }
}
"#;

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detect_print_stderr_vague() {
    init_test_log();
    let bad_code = r#"
def validate [data] {
    print -e "error"
}
"#;

    RULE.assert_detects(bad_code);
}

#[test]
fn test_detect_print_stderr_short() {
    init_test_log();
    let bad_code = r#"
def validate [data] {
    print -e "failed"
}
"#;

    RULE.assert_detects(bad_code);
}