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
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 super::RULE;

#[test]
fn function_at_line_limit() {
    let rule = RULE;
    let function = format!(
        r"def acceptable_function [] {{
{}
}}",
        (0..38)
            .map(|i| format!("    let x{i} = {i}"))
            .collect::<Vec<_>>()
            .join("\n")
    );
    rule.assert_ignores(&function);
}

#[test]
fn short_function() {
    let rule = RULE;
    rule.assert_ignores(r"def short_function [] { print 'hello' }");
}

#[test]
fn function_with_few_lines() {
    let rule = RULE;
    rule.assert_ignores(
        r"def simple_function [x y] {
    let sum = $x + $y
    let product = $x * $y
    {sum: $sum, product: $product}
}",
    );
}

#[test]
fn empty_function() {
    let rule = RULE;
    rule.assert_ignores(r"def empty_function [] {}");
}

#[test]
fn function_with_comments() {
    let rule = RULE;
    let function = format!(
        r"def documented_function [] {{
    # This function does something
{}
    # End of function
}}",
        (0..20)
            .map(|i| format!("    let x{i} = {i}"))
            .collect::<Vec<_>>()
            .join("\n")
    );
    rule.assert_ignores(&function);
}

#[test]
fn function_with_moderate_complexity() {
    let rule = RULE;
    rule.assert_ignores(
        r"def process_items [items] {
    let filtered = $items | where value > 10
    let transformed = $filtered | each { |x| $x * 2 }
    let grouped = $transformed | group-by type
    $grouped
}",
    );
}

#[test]
fn main_function_within_limit() {
    let rule = RULE;
    let function = format!(
        r"def main [] {{
{}
}}",
        (0..30)
            .map(|i| format!("    print {i}"))
            .collect::<Vec<_>>()
            .join("\n")
    );
    rule.assert_ignores(&function);
}

#[test]
fn exported_function_within_limit() {
    let rule = RULE;
    let function = format!(
        r"export def helper_function [] {{
{}
}}",
        (0..30)
            .map(|i| format!("    let x{i} = {i}"))
            .collect::<Vec<_>>()
            .join("\n")
    );
    rule.assert_ignores(&function);
}

#[test]
fn multiple_short_functions() {
    let rule = RULE;
    rule.assert_ignores(
        r"def func1 [] { print 'one' }
def func2 [] { print 'two' }
def func3 [] { print 'three' }",
    );
}

#[test]
fn function_with_nested_blocks() {
    let rule = RULE;
    rule.assert_ignores(
        r"def process_data [data] {
    if ($data | is-empty) {
        return null
    } else {
        $data
        | where active == true
        | each { |item|
            if $item.value > 100 {
                $item | update value { |x| $x.value / 2 }
            } else {
                $item
            }
        }
        | sort-by value
    }
}",
    );
}

#[test]
fn closure_definitions() {
    let rule = RULE;
    rule.assert_ignores(
        r"def create_processor [] {
    let processor = { |x|
        $x
        | where valid == true
        | each { |item| $item * 2 }
    }
    $processor
}",
    );
}