nu-lint 1.2.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

use super::RULE;

#[test]
fn ignore_multiple_parameters_without_pipeline_usage() {
    let good_codes = vec![
        // Multiple parameters where none are used as pipeline input
        "def backup-file [source, destination] { cp $source $destination }",
        "def greet [name, greeting] { $\"($greeting), ($name)!\" }",
    ];

    for code in good_codes {
        RULE.assert_ignores(code);
    }
}

#[test]
fn ignore_no_parameters() {
    let good_codes = vec![
        "def get-current-time [] { date now }",
        "def list-files [] { ls }",
        "def show-help [] { help commands }",
    ];

    for code in good_codes {
        RULE.assert_ignores(code);
    }
}

#[test]
fn ignore_optional_parameters() {
    let good_codes = vec![
        // Optional parameter not used as pipeline input
        "def greet [name?] { $\"Hello, ($name | default 'World')!\" }",
    ];

    for code in good_codes {
        RULE.assert_ignores(code);
    }
}

#[test]
fn ignore_rest_parameters() {
    let good_codes = vec![
        "def multi-greet [...names] { $names | each { |name| $\"Hello, ($name)!\" } }",
        "def sum-all [...numbers] { $numbers | math sum }",
    ];

    for code in good_codes {
        RULE.assert_ignores(code);
    }
}

#[test]
fn ignore_generator_commands() {
    let good_codes = vec![
        "def generate-range [start, end] { $start..$end }",
        "def create-list [size] { 1..$size }",
        "def make-record [name] { { name: $name, created: (date now) } }",
        "def build-table [rows] { 1..$rows | each { |i| { id: $i, value: ($i * 2) } } }",
    ];

    for code in good_codes {
        RULE.assert_ignores(code);
    }
}

#[test]
fn ignore_configuration_parameters() {
    let good_codes = vec![
        "def configure-server [host, port] { $env.SERVER_HOST = $host; $env.SERVER_PORT = $port }",
        "def set-level [level] { $env.LOG_LEVEL = $level }",
        "def create-file [filename] { touch $filename }",
        "def delete-file [path] { rm $path }",
    ];

    for code in good_codes {
        RULE.assert_ignores(code);
    }
}

#[test]
fn ignore_non_pipeline_usage() {
    let good_codes = vec![
        "def get-info [name] { { name: $name, timestamp: (date now) } }",
        "def calculate [value] { $value * 2 + 1 }",
        "def make-greeting [name] { $\"Hello, ($name)!\" }",
        "def create-config [setting] { { config: $setting, created: true } }",
    ];

    for code in good_codes {
        RULE.assert_ignores(code);
    }
}

#[test]
fn ignore_path_and_filename_parameters() {
    let good_codes = vec![
        // Path/filename parameters not used as pipeline input
        "def read-config [path] { open $path | from toml }",
        "def process-file [filename] { open $filename | lines | length }",
    ];

    for code in good_codes {
        RULE.assert_ignores(code);
    }
}

#[test]
fn ignore_typed_non_data_parameters() {
    let good_codes = vec![
        "def repeat [count: int] { 1..$count | each { |i| $\"Item ($i)\" } }",
        "def create-url [host: string, port: int] { $\"http://($host):($port)\" }",
        "def set-flag [enabled: bool] { if $enabled { \"on\" } else { \"off\" } }",
    ];

    for code in good_codes {
        RULE.assert_ignores(code);
    }
}