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

use super::RULE;

#[test]
fn main_positional_with_documentation() {
    let source = r"
def main [
    input # The input file path
] {
    echo $input
}
";
    RULE.assert_count(source, 0);
}

#[test]
fn main_multiple_positional_with_documentation() {
    let source = r"
def main [
    input # Input file
    output # Output file
] {
    echo $input | save $output
}
";
    RULE.assert_count(source, 0);
}

#[test]
fn main_typed_positional_with_documentation() {
    let source = r"
def main [
    count: int # Number of iterations
] {
    1..$count
}
";
    RULE.assert_count(source, 0);
}

#[test]
fn main_rest_positional_with_documentation() {
    let source = r"
def main [
    ...files # Files to process
] {
    $files | each { |f| open $f }
}
";
    RULE.assert_count(source, 0);
}

#[test]
fn non_main_function_ignores_documentation_requirement() {
    let source = r"
def helper [input] {
    echo $input
}
";
    RULE.assert_count(source, 0);
}

#[test]
fn main_without_parameters_passes() {
    let source = r#"
def main [] {
    echo "Hello"
}
"#;
    RULE.assert_count(source, 0);
}