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
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
149
150

#[test]
fn ignores_properly_escaped_parentheses() {
    let rule = super::RULE;

    let code = r#"
def good_example [] {
    let path = "/some/path"
    print $"File ($path) \(not found\)"
}
"#;

    rule.assert_ignores(code);
}

#[test]
fn ignores_plain_strings_without_interpolation() {
    let rule = super::RULE;

    let code = r#"
def ok_example [] {
    print "(not a problem)"
}
"#;

    rule.assert_ignores(code);
}

#[test]
fn ignores_escaped_non_operator_text() {
    let rule = super::RULE;

    let code = r#"
def ok_example [] {
    let x = "value"
    print $"Result ($x) \(some text here\)"
}
"#;

    rule.assert_ignores(code);
}

#[test]
fn ignores_all_properly_escaped_operators() {
    let rule = super::RULE;

    let code = r#"
def good_operators [] {
    let var = "x"
    print $"($var) \(not x\)"
    print $"($var) \(and y\)"
    print $"($var) \(or z\)"
}
"#;

    rule.assert_ignores(code);
}

#[test]
fn ignores_simple_variable_interpolation() {
    let rule = super::RULE;

    let code = r#"
def test [] {
    let name = "Alice"
    print $"Hello ($name)"
}
"#;

    rule.assert_ignores(code);
}

#[test]
fn ignores_escaped_operators_in_error_messages() {
    let rule = super::RULE;

    let code = r#"
def good_error_msg [path: string] {
    error make {
        msg: $"File ($path) \(not found or not accessible\)"
    }
}
"#;

    rule.assert_ignores(code);
}

#[test]
fn ignores_valid_complex_boolean_expressions() {
    let rule = super::RULE;

    let code = r#"
def test_valid_complex [] {
    let x = 5
    let y = 10
    print $"Check: (($x + $y) * 2)"
    print $"Result: (($x > 0) and ($y < 20))"
}
"#;

    rule.assert_ignores(code);
}

#[test]
fn ignores_multiple_properly_escaped_patterns() {
    let rule = super::RULE;

    let code = r#"
def test_escaped [] {
    let file = "config.txt"
    print $"File ($file) \(not found\)"
    print $"Status ($file) \(access denied\)"
    print $"Service \(failed to connect\)"
    print $"Result ($file) \(and more\)"
}
"#;

    rule.assert_ignores(code);
}

#[test]
fn ignores_valid_arithmetic_subexpressions() {
    let rule = super::RULE;

    let code = r#"
def test_valid [] {
    let a = 1
    let b = 2
    print $"Sum: (($a + $b))"
    print $"Product: (($a * $b * 3))"
}
"#;

    rule.assert_ignores(code);
}

#[test]
fn ignores_non_operator_parenthetical_text() {
    let rule = super::RULE;

    let code = r#"
def test_safe [] {
    let item = "data"
    print $"Item ($item) (version 1.0)"
    print $"Status ($item) (processing complete)"
    print $"Result ($item) (success)"
}
"#;

    rule.assert_ignores(code);
}