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

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

#[test]
fn test_already_using_complete() {
    init_test_log();
    let good_code = r"let result = (^curl https://api.example.com | complete)
if $result.exit_code != 0 { error make { msg: 'Failed' } }
$result.stdout | from json";
    RULE.assert_ignores(good_code);
}

#[test]
fn safe_git() {
    init_test_log();
    let good_code = r#"git config get remote.origin.url
    | str replace "git@ssh.gitgud.io:" "https://gitgud.io/"
"#;

    RULE.assert_ignores(good_code);
}

#[test]
fn test_single_external_command() {
    let good_code = r"^git status";
    RULE.assert_ignores(good_code);
}

#[test]
fn test_safe_command() {
    let good_code = r"^echo 'test' | from json";
    RULE.assert_ignores(good_code);
}

#[test]
fn test_bare_external_command_no_pipeline() {
    // Bare external commands without pipelines are not detected by this rule
    let good_code = r"^curl https://example.com";
    RULE.assert_ignores(good_code);
}

#[test]
fn test_complete_in_subexpression() {
    let good_code =
        r"let data = (^curl https://api.example.com | complete | get stdout | from json)";
    RULE.assert_ignores(good_code);
}

#[test]
fn complete_stor() {
    init_test_log();
    RULE.assert_ignores("stor open | query db 'select'");
}

#[test]
fn test_external_with_ignore() {
    init_test_log();
    // Using `ignore` explicitly signals intentional discard of output and exit code
    let good_code = r"^curl https://api.example.com | ignore";
    RULE.assert_ignores(good_code);
}

#[test]
fn test_external_with_ignore_in_pipeline() {
    init_test_log();
    // External piped to ignore should not trigger warning
    let good_code = r"^git fetch origin | ignore";
    RULE.assert_ignores(good_code);
}