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

use super::RULE;

#[test]
fn test_fix_basic_env_nu_shebang() {
    let source = r"#!/usr/bin/env nu

def main []: string -> string {
    $in | str upcase
}
";

    RULE.assert_fixed_contains(source, "--stdin");
    RULE.assert_fixed_contains(source, "#!/usr/bin/env -S nu --stdin");
}

#[test]
fn test_fix_env_with_s_flag() {
    let source = r"#!/usr/bin/env -S nu

def main [] {
    $in | str upcase
}
";

    RULE.assert_fixed_contains(source, "--stdin");
    RULE.assert_fixed_contains(source, "#!/usr/bin/env -S nu --stdin");
}

#[test]
fn test_fix_direct_nu_path() {
    let source = r"#!/usr/bin/nu

def main []: string -> string {
    $in | lines | length
}
";

    RULE.assert_fixed_contains(source, "#!/usr/bin/nu --stdin");
}

#[test]
fn test_fix_with_uses_in_variable() {
    let source = r"#!/usr/bin/env nu

def main [] {
    let input = $in
    print $input
}
";

    RULE.assert_fixed_contains(source, "#!/usr/bin/env -S nu --stdin");
}

#[test]
fn test_fix_with_pipeline_type_annotation() {
    let source = r"#!/usr/bin/env nu

def main []: list<string> -> string {
    lines | first
}
";

    RULE.assert_fixed_contains(source, "#!/usr/bin/env -S nu --stdin");
}

#[test]
fn test_no_fix_when_stdin_already_present() {
    let source = r"#!/usr/bin/env -S nu --stdin

def main []: string -> string {
    $in | str upcase
}
";

    RULE.assert_count(source, 0);
}

#[test]
fn test_fix_with_env_s_and_other_flags() {
    let source = r"#!/usr/bin/env -S nu --log-level debug

def main [] {
    $in | str trim
}
";

    RULE.assert_fixed_contains(source, "#!/usr/bin/env -S nu --stdin --log-level debug");
}

#[test]
fn test_fix_produces_valid_code() {
    // Test that the fix only replaces the shebang line, not the entire file
    let source = r"#!/usr/bin/env nu

def main [] {
    let input = $in
    print $input
}
";

    // Verify the fix contains the corrected shebang
    RULE.assert_fixed_contains(source, "#!/usr/bin/env -S nu --stdin");

    // Verify there's exactly one violation
    RULE.assert_count(source, 1);
}

#[test]
fn test_fix_preserves_rest_of_file() {
    // Ensure the fix doesn't mangle the code after the shebang
    let source = "#!/usr/bin/env nu
def helper [] { \"test\" }
def main [] { $in | str upcase }
";

    RULE.assert_fixed_contains(source, "#!/usr/bin/env -S nu --stdin");
    RULE.assert_count(source, 1);
}