nu-lint 1.3.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

use crate::{
    LintLevel,
    context::LintContext,
    rule::{DetectFix, Rule},
    violation::Detection,
};
const MAX_POSITIONAL: usize = 2;

struct MaxPositionalParams;

impl DetectFix for MaxPositionalParams {
    type FixInput<'a> = ();

    fn id(&self) -> &'static str {
        "max_positional_params"
    }

    fn short_description(&self) -> &'static str {
        "Custom commands should have ≤ 2 positional parameters"
    }

    fn level(&self) -> LintLevel {
        LintLevel::Warning
    }

    fn detect<'a>(&self, context: &'a LintContext) -> Vec<(Detection, Self::FixInput<'a>)> {
        let detections = context
            .custom_commands()
            .iter()
            .filter_map(|def| {
                let signature = &def.signature;
                log::trace!("Checking command '{}'", signature.name);
                // Count only positional parameters (not flags)
                let positional_count = signature.required_positional.len()
                    + signature.optional_positional.len()
                    + usize::from(signature.rest_positional.is_some());
                log::trace!(
                    "Command '{}' has {positional_count} positional parameters",
                    signature.name
                );
                // Only create violation if count exceeds threshold
                (positional_count > MAX_POSITIONAL).then(|| {
                    log::warn!(
                        "Command '{}' exceeds max positional parameters with {positional_count} \
                         parameters",
                        signature.name
                    );
                    Detection::from_file_span(
                        format!(
                            "Command has {positional_count} positional parameters, should have ≤ \
                             {MAX_POSITIONAL}"
                        ),
                        def.declaration_span(context),
                    )
                    .with_primary_label(format!("{positional_count} positional params"))
                })
            })
            .collect();
        Self::no_fix(detections)
    }
}

pub static RULE: &dyn Rule = &MaxPositionalParams;
#[cfg(test)]
mod detect_bad;
#[cfg(test)]
mod generated_fix;
#[cfg(test)]
mod ignore_good;