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
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

use std::fs;

use super::RULE;
use crate::{Config, engine::LintEngine, log::init_test_log};

#[test]
fn test_config_nu() {
    init_test_log();
    let code = "config nu --doc | nu-highlight | to html --html-color";
    RULE.assert_ignores(code);
}

#[test]
fn ignore_valid_let_statement() {
    let code = "let x = 5";
    RULE.assert_ignores(code);
}

#[test]
fn ignore_valid_function_definition() {
    let code = r#"
def greet [name: string] {
    print $"Hello, ($name)!"
}
"#;
    RULE.assert_ignores(code);
}

#[test]
fn ignore_valid_pipeline() {
    let code = "ls | where size > 100 | sort-by name";
    RULE.assert_ignores(code);
}

#[test]
fn ignore_valid_list() {
    let code = "let items = [1, 2, 3, 4, 5]";
    RULE.assert_ignores(code);
}

#[test]
fn ignore_valid_record() {
    let code = "let person = {name: 'John', age: 30}";
    RULE.assert_ignores(code);
}

#[test]
fn ignore_valid_string() {
    let code = r#"let greeting = "Hello, world!""#;
    RULE.assert_ignores(code);
}

#[test]
fn ignore_valid_closure() {
    let code = "let adder = {|x, y| $x + $y}";
    RULE.assert_ignores(code);
}

#[test]
fn ignore_valid_path_self() {
    let code = "const SELF = path self .";
    RULE.assert_ignores(code);
}

#[test]
fn ignore_valid_if_expression() {
    let code = r#"
let x = 10
if $x > 5 {
    print "greater"
} else {
    print "lesser"
}
"#;
    RULE.assert_ignores(code);
}

#[test]
fn ignore_complex_valid_use_statements() {
    let code = r#"
use std/config light-theme
use std/config dark-theme

export def refresh-theme [] {
    let current_theme = "dark"
    match $current_theme {
        "dark" => {
            $env.config = ($env.config | merge {color_config: (dark-theme)})
        }
        "light" => {
            $env.config = ($env.config | merge {color_config: (light-theme)})
        }
        _ => {
            $env.config = ($env.config | merge {color_config: (dark-theme)})
        }
    }
}
"#;
    RULE.assert_ignores(code);
}

#[test]
fn ignore_relative_parent_import_on_disk() {
    let dir = tempfile::tempdir().unwrap();

    let lib_dir = dir.path().join("library");
    fs::create_dir_all(&lib_dir).unwrap();
    fs::write(lib_dir.join("mod.nu"), "export def hello [] { \"hi\" }").unwrap();

    let bin_dir = dir.path().join("bin");
    fs::create_dir_all(&bin_dir).unwrap();
    let script = bin_dir.join("script.nu");
    fs::write(&script, "use ../library/mod.nu *").unwrap();

    let engine = LintEngine::new(Config::default());
    let violations = engine.lint_file(&script).unwrap();
    assert!(
        violations
            .iter()
            .all(|v| v.rule_id.as_deref() != Some("nu_parse_error")),
        "Expected no nu_parse_error for a valid relative import, but got: {violations:?}"
    );
}

#[test]
fn ignore_relative_dot_import_on_disk() {
    let dir = tempfile::tempdir().unwrap();

    let sibling_dir = dir.path().join("sibling");
    fs::create_dir_all(&sibling_dir).unwrap();
    fs::write(
        sibling_dir.join("mod.nu"),
        "export def greet [] { \"hey\" }",
    )
    .unwrap();

    let script = dir.path().join("main.nu");
    fs::write(&script, "use ./sibling/mod.nu *").unwrap();

    let engine = LintEngine::new(Config::default());
    let violations = engine.lint_file(&script).unwrap();
    assert!(
        violations
            .iter()
            .all(|v| v.rule_id.as_deref() != Some("nu_parse_error")),
        "Expected no nu_parse_error for a valid ./sibling import, but got: {violations:?}"
    );
}