rsconstruct 0.9.124

Rust based fast build system
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245

//! luacheck's messages (each stage's `message_format`) and the `plain`
//! formatter with `--codes`: `file:line:column: (Wnnn) message`.

use super::check::Warning;
use super::value::number_to_string;

fn quoted(value: &[u8]) -> Vec<u8> {
    let mut out = vec![b'\''];
    out.extend_from_slice(value);
    out.push(b'\'');
    out
}

fn name(w: &Warning) -> Vec<u8> {
    quoted(w.name.as_deref().unwrap_or_default())
}

fn field(w: &Warning) -> Vec<u8> {
    quoted(w.field.as_deref().unwrap_or_default())
}

fn cat(parts: &[&[u8]]) -> Vec<u8> {
    parts.concat()
}

fn prefix_if_indirect(w: &Warning, message: Vec<u8>) -> Vec<u8> {
    if w.indirect {
        cat(&[b"indirectly ", &message])
    } else {
        message
    }
}

fn unused_or_overwritten(w: &Warning, subject: &[&[u8]]) -> Vec<u8> {
    let mut out = cat(subject);
    match w.overwritten_line {
        Some(line) => {
            out.extend_from_slice(b" is overwritten on line ");
            out.extend_from_slice(line.to_string().as_bytes());
            out.extend_from_slice(b" before use");
        }
        None => out.extend_from_slice(b" is unused"),
    }
    out
}

fn redefined(w: &Warning, before: &[u8], after: &[u8]) -> Vec<u8> {
    let prev_line = w.prev_line.unwrap_or(0).to_string();
    cat(&[before, &name(w), after, prev_line.as_bytes()])
}

/// The message for a warning, as luacheck formats it without color.
pub fn message(w: &Warning) -> Vec<u8> {
    match w.code.as_str() {
        "011" | "021" => w.msg.clone().unwrap_or_default(),
        "022" => b"unpaired push directive".to_vec(),
        "023" => b"unpaired pop directive".to_vec(),
        "033" => cat(&[
            b"assignment uses compound operator ",
            w.operator.as_deref().unwrap_or_default(),
        ]),
        "111" => {
            if w.module {
                cat(&[b"setting non-module global variable ", &name(w)])
            } else {
                cat(&[b"setting non-standard global variable ", &name(w)])
            }
        }
        "112" => cat(&[b"mutating non-standard global variable ", &name(w)]),
        "113" => cat(&[b"accessing undefined variable ", &name(w)]),
        "121" => cat(&[b"setting read-only global variable ", &name(w)]),
        "122" => prefix_if_indirect(
            w,
            cat(&[
                b"setting read-only field ",
                &field(w),
                b" of global ",
                &name(w),
            ]),
        ),
        "131" => cat(&[b"unused global variable ", &name(w)]),
        "142" => prefix_if_indirect(
            w,
            cat(&[
                b"setting undefined field ",
                &field(w),
                b" of global ",
                &name(w),
            ]),
        ),
        "143" => prefix_if_indirect(
            w,
            cat(&[
                b"accessing undefined field ",
                &field(w),
                b" of global ",
                &name(w),
            ]),
        ),
        "211" => {
            if w.func {
                if w.recursive {
                    cat(&[b"unused recursive function ", &name(w)])
                } else if w.mutually_recursive {
                    cat(&[b"unused mutually recursive function ", &name(w)])
                } else {
                    cat(&[b"unused function ", &name(w)])
                }
            } else {
                cat(&[b"unused variable ", &name(w)])
            }
        }
        "212" => {
            if w.name.as_deref() == Some(b"...") {
                b"unused variable length argument".to_vec()
            } else {
                cat(&[b"unused argument ", &name(w)])
            }
        }
        "213" => cat(&[b"unused loop variable ", &name(w)]),
        "214" => cat(&[b"used variable ", &name(w), b" with unused hint"]),
        "221" => cat(&[b"variable ", &name(w), b" is never set"]),
        "231" => cat(&[b"variable ", &name(w), b" is never accessed"]),
        "232" => cat(&[b"argument ", &name(w), b" is never accessed"]),
        "233" => cat(&[b"loop variable ", &name(w), b" is never accessed"]),
        "241" => cat(&[b"variable ", &name(w), b" is mutated but never accessed"]),
        "311" => unused_or_overwritten(w, &[b"value assigned to variable ", &name(w)]),
        "312" => unused_or_overwritten(w, &[b"value of argument ", &name(w)]),
        "313" => unused_or_overwritten(w, &[b"value of loop variable ", &name(w)]),
        "314" => {
            let target: &[u8] = if w.index { b"index" } else { b"field" };
            let line = w.overwritten_line.unwrap_or(0).to_string();
            cat(&[
                b"value assigned to ",
                target,
                b" ",
                &field(w),
                b" is overwritten on line ",
                line.as_bytes(),
                b" before use",
            ])
        }
        "321" => cat(&[b"accessing uninitialized variable ", &name(w)]),
        "331" => cat(&[
            b"value assigned to variable ",
            &name(w),
            b" is mutated but never accessed",
        ]),
        "341" => cat(&[b"mutating uninitialized variable ", &name(w)]),
        "411" => redefined(w, b"variable ", b" was previously defined on line "),
        "412" => redefined(
            w,
            b"variable ",
            b" was previously defined as an argument on line ",
        ),
        "413" => redefined(
            w,
            b"variable ",
            b" was previously defined as a loop variable on line ",
        ),
        "421" => redefined(w, b"shadowing definition of variable ", b" on line "),
        "422" => redefined(w, b"shadowing definition of argument ", b" on line "),
        "423" => redefined(w, b"shadowing definition of loop variable ", b" on line "),
        "431" => redefined(w, b"shadowing upvalue ", b" on line "),
        "432" => redefined(w, b"shadowing upvalue argument ", b" on line "),
        "433" => redefined(w, b"shadowing upvalue loop variable ", b" on line "),
        "511" => b"unreachable code".to_vec(),
        "512" => b"loop is executed at most once".to_vec(),
        "521" => cat(&[
            b"unused label ",
            &quoted(w.label.as_deref().unwrap_or_default()),
        ]),
        "531" => b"right side of assignment has more values than left side expects".to_vec(),
        "532" => b"right side of assignment has less values than left side expects".to_vec(),
        "541" => b"empty do..end block".to_vec(),
        "542" => b"empty if branch".to_vec(),
        "551" => b"empty statement".to_vec(),
        "561" => {
            let descr = if w.function_type == Some("main_chunk") {
                b"main chunk".to_vec()
            } else if let Some(function_name) = &w.function_name {
                cat(&[
                    w.function_type.unwrap_or("function").as_bytes(),
                    b" ",
                    &quoted(function_name),
                ])
            } else {
                b"function".to_vec()
            };
            let complexity = w.complexity.unwrap_or(0).to_string();
            let max = number_to_string(w.max_complexity.unwrap_or(0.0));
            cat(&[
                b"cyclomatic complexity of ",
                &descr,
                b" is too high (",
                complexity.as_bytes(),
                b" > ",
                max.as_bytes(),
                b")",
            ])
        }
        "571" => cat(&[
            b"numeric for loop goes from #(expr) down to ",
            w.limit.as_deref().unwrap_or_default(),
            b" but loop step is not negative",
        ]),
        "581" => cat(&[
            b"'not (x ",
            w.operator.as_deref().unwrap_or_default(),
            b" y)' can be replaced by 'x ",
            w.replacement_operator.as_deref().unwrap_or_default(),
            b" y' (if neither side is a table or NaN)",
        ]),
        "582" => b"Error prone negation: negation is executed before relational operator.".to_vec(),
        "611" => b"line contains only whitespace".to_vec(),
        "612" => b"line contains trailing whitespace".to_vec(),
        "613" => b"trailing whitespace in a string".to_vec(),
        "614" => b"trailing whitespace in a comment".to_vec(),
        "621" => b"inconsistent indentation (SPACE followed by TAB)".to_vec(),
        "631" => {
            let max = number_to_string(w.max_length.unwrap_or(0.0));
            cat(&[
                b"line is too long (",
                w.end_column.to_string().as_bytes(),
                b" > ",
                max.as_bytes(),
                b")",
            ])
        }
        other => format!("unknown warning code {other}").into_bytes(),
    }
}

/// `(Wnnn)` for a warning, `(Ennn)` for an error (codes starting with 0).
pub fn event_code(w: &Warning) -> String {
    let kind = if w.code.starts_with('0') { 'E' } else { 'W' };
    format!("{kind}{}", w.code)
}

/// A warning as `luacheck --formatter plain --codes` prints it.
pub fn plain_line(file_name: &str, w: &Warning) -> Vec<u8> {
    let mut out = format!("{file_name}:{}:{}: ({}) ", w.line, w.column, event_code(w)).into_bytes();
    out.extend(message(w));
    out
}