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

use super::RULE;
use crate::log::init_test_log;

#[test]
fn test_detect_various_path_parameter_names() {
    init_test_log();

    let test_cases = [
        ("source_path", "cp $source_path $dest"),
        ("config_path", "open $config_path | from toml"),
        ("filepath", "open $filepath"),
        ("input_file", "open $input_file"),
        ("target_dir", "ls $target_dir"),
        ("source_directory", "ls $source_directory"),
        ("target_location", "save $target_location"),
    ];

    for (param_name, body) in test_cases {
        let code = format!(r"def test-fn [{param_name}: string] {{ {body} }}");
        RULE.assert_detects(&code);
    }
}

#[test]
fn test_detect_path_parameters_without_type_annotation() {
    init_test_log();

    for param_name in [
        "file_path",
        "config_path",
        "target_directory",
        "backup_location",
    ] {
        let code = format!(r"def test-fn [{param_name}] {{ open ${param_name} }}");
        RULE.assert_detects(&code);
    }
}

#[test]
fn test_detect_multiple_path_parameters() {
    init_test_log();
    let code = r"
def sync-files [source_path: string, target_path: string, backup_path: string] {
    cp $source_path $target_path
    cp $target_path $backup_path
}
";
    RULE.assert_count(code, 3);
}

#[test]
fn test_detect_optional_path_parameter() {
    init_test_log();
    let code = r"
def read-file [file_path?: string] {
    if ($file_path != null) {
        open $file_path
    }
}
";
    RULE.assert_detects(code);
}

#[test]
fn test_detect_exported_function() {
    init_test_log();
    let code = r"
export def save-data [output_path: string, data] {
    $data | save $output_path
}
";
    RULE.assert_detects(code);
}

#[test]
fn test_detect_different_case_variations() {
    init_test_log();
    for (param, body) in [
        ("filePath", "open $filePath"),
        ("SOURCE_PATH", "cp $SOURCE_PATH dest"),
    ] {
        let code = format!(r"def test-fn [{param}: string] {{ {body} }}");
        RULE.assert_detects(&code);
    }
}