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

use super::RULE;

#[test]
fn main_named_flag_with_documentation() {
    let source = r#"
def main [
    --verbose # Enable verbose output
] {
    if $verbose { print "Verbose mode" }
}
"#;
    RULE.assert_count(source, 0);
}

#[test]
fn main_short_named_flag_with_documentation() {
    let source = r#"
def main [
    --verbose (-v) # Enable verbose output
] {
    if $verbose { print "Verbose mode" }
}
"#;
    RULE.assert_count(source, 0);
}

#[test]
fn main_multiple_named_flags_with_documentation() {
    let source = r#"
def main [
    --verbose # Enable verbose output
    --debug # Enable debug mode
    --output: string # Output file path
] {
    if $verbose { print "Verbose" }
    if $debug { print "Debug" }
    print $output
}
"#;
    RULE.assert_count(source, 0);
}

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

#[test]
fn non_main_function_ignores_documentation_requirement() {
    let source = r#"
def helper [--verbose] {
    if $verbose { print "Verbose" }
}
"#;
    RULE.assert_count(source, 0);
}

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

#[test]
fn main_mixed_parameters_all_documented_passes() {
    let source = r#"
def main [
    input # Input file
    --verbose # Enable verbose output
] {
    if $verbose { print "Processing" $input }
}
"#;
    RULE.assert_count(source, 0);
}