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

use super::RULE;

#[test]
fn test_main_without_export_in_script_ignored() {
    let good_code = r"#!/usr/bin/env nu
def main [] {
    print 'Hello'
}
";
    RULE.assert_ignores(good_code);
}

#[test]
fn test_main_subcommand_without_export_in_script_ignored() {
    let good_code = r#"#!/usr/bin/env nu
def "main test" [] {
    print "Running tests"
}
"#;
    RULE.assert_ignores(good_code);
}

#[test]
fn test_export_non_main_function_in_script_ignored() {
    let good_code = r"#!/usr/bin/env nu
export def helper [] {
    print 'Helper function'
}
";
    RULE.assert_ignores(good_code);
}

#[test]
fn test_mixed_functions_in_script() {
    let good_code = r"#!/usr/bin/env nu
def main [] {
    print 'Main'
}

export def helper [] {
    print 'Helper'
}
";
    RULE.assert_ignores(good_code);
}

#[test]
fn test_function_with_main_in_name_ignored() {
    let good_code = r"#!/usr/bin/env nu
export def get-main-config [] {
    {key: 'value'}
}
";
    RULE.assert_ignores(good_code);
}

#[test]
fn test_export_main_in_module_ignored() {
    // Without shebang, this is treated as a module where export def main is valid
    let good_code = r"
export def main [] {
    print 'Hello'
}
";
    RULE.assert_ignores(good_code);
}

#[test]
fn test_export_main_subcommand_in_module_ignored() {
    // Without shebang, module subcommands with export are valid
    let good_code = r#"
export def "main test" [] {
    print "Running tests"
}
"#;
    RULE.assert_ignores(good_code);
}

#[test]
fn test_module_with_multiple_exports_ignored() {
    // This is a typical module pattern - should not trigger
    let good_code = r"
export def main []: int -> int {
    $in + 1
}

export def by [amount: int]: int -> int {
    $in + $amount
}
";
    RULE.assert_ignores(good_code);
}