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

use super::RULE;

#[test]
fn ignore_with_complete() {
    RULE.assert_ignores("^git clone https://example.com/repo | complete");
}

#[test]
fn ignore_curl_with_complete() {
    RULE.assert_ignores("^curl https://example.com | complete");
}

#[test]
fn ignore_complete_with_exit_check() {
    RULE.assert_ignores(
        r#"
        let result = ^git push origin main | complete
        if $result.exit_code != 0 {
            error make { msg: "git failed" }
        }
    "#,
    );
}

#[test]
fn ignore_git_status() {
    // git status is not in the LikelyErrors list - it's a read-only query
    RULE.assert_ignores("^git status");
}

#[test]
fn ignore_git_log() {
    // git log is also read-only
    RULE.assert_ignores("^git log --oneline");
}

#[test]
fn ignore_echo() {
    // echo doesn't have LikelyErrors effect
    RULE.assert_ignores("^echo hello");
}

#[test]
fn ignore_complete_in_function() {
    RULE.assert_ignores(
        r#"
        def safe-fetch [] {
            ^curl https://api.example.com | complete
        }
    "#,
    );
}

// Streaming output commands - users want to see live progress
#[test]
fn ignore_git_clone_streaming() {
    // git clone shows progress, buffering defeats the purpose
    RULE.assert_ignores("^git clone https://github.com/example/repo");
}

#[test]
fn ignore_git_push_streaming() {
    RULE.assert_ignores("^git push origin main");
}

#[test]
fn ignore_git_pull_streaming() {
    RULE.assert_ignores("^git pull");
}

#[test]
fn ignore_cargo_build_streaming() {
    // Build output should stream for progress visibility
    RULE.assert_ignores("^cargo build");
}

#[test]
fn ignore_cargo_test_streaming() {
    RULE.assert_ignores("^cargo test");
}

#[test]
fn ignore_npm_install_streaming() {
    RULE.assert_ignores("^npm install");
}

#[test]
fn ignore_make_streaming() {
    RULE.assert_ignores("^make");
}

#[test]
fn ignore_docker_build_streaming() {
    RULE.assert_ignores("^docker build .");
}

#[test]
fn ignore_wget_streaming() {
    // wget shows download progress by default
    RULE.assert_ignores("^wget https://example.com/file.tar.gz");
}

// try blocks catch external command failures since nushell 0.98.0
#[test]
fn ignore_try_wrapped_curl() {
    RULE.assert_ignores("try { ^curl https://example.com }");
}

#[test]
fn ignore_try_catch_git_commit() {
    RULE.assert_ignores(r#"try { ^git commit -m 'test' } catch { print "failed" }"#);
}

#[test]
fn ignore_try_in_function() {
    RULE.assert_ignores(
        r#"
        def safe-op [] {
            try { ^curl https://api.example.com }
        }
    "#,
    );
}