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

use nu_protocol::{
    Span,
    ast::{Comparison, Expr, Expression, Operator},
};

use crate::{
    LintLevel,
    ast::{block::BlockExt, expression::ExpressionExt},
    context::LintContext,
    rule::{DetectFix, Rule},
    violation::{Detection, Fix, Replacement},
};

#[cfg(test)]
mod detect_bad;
#[cfg(test)]
mod generated_fix;
#[cfg(test)]
mod ignore_good;

struct FixData {
    full_span: Span,
    record_key: Span,
    record: Span,
}

fn check_in_columns(expr: &Expression, ctx: &LintContext) -> Vec<(Detection, FixData)> {
    let Expr::BinaryOp(left, op, right) = &expr.expr else {
        return vec![];
    };

    let is_in_op = matches!(
        &op.expr,
        Expr::Operator(Operator::Comparison(Comparison::In))
    );

    if !is_in_op {
        return vec![];
    }

    let Some(block_id) = right.extract_block_id() else {
        return vec![];
    };

    let block = ctx.working_set.get_block(block_id);
    let Some(record) = block.find_columns_record_span(ctx) else {
        return vec![];
    };

    let detection = Detection::from_global_span(
        "Use 'has' operator instead of 'in ($record | columns)' for record key membership",
        expr.span,
    )
    .with_primary_label("non-idiomatic key check")
    .with_extra_label("key", left.span)
    .with_extra_label("columns call", right.span);

    vec![(
        detection,
        FixData {
            full_span: expr.span,
            record_key: left.span,
            record,
        },
    )]
}

struct ColumnsInToHas;

impl DetectFix for ColumnsInToHas {
    type FixInput<'a> = FixData;

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

    fn short_description(&self) -> &'static str {
        "Use 'has' operator instead of 'in ($record | columns)'"
    }

    fn long_description(&self) -> Option<&'static str> {
        Some(
            "The pattern `$key in ($record | columns)` can be written more idiomatically as \
             `$record has $key`. The 'has' operator directly checks if a key exists in a record.",
        )
    }

    fn source_link(&self) -> Option<&'static str> {
        Some("https://www.nushell.sh/book/operators.html")
    }

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

    fn detect<'a>(&self, context: &'a LintContext) -> Vec<(Detection, Self::FixInput<'a>)> {
        context.detect_with_fix_data(check_in_columns)
    }

    fn fix(&self, context: &LintContext, fix_data: &Self::FixInput<'_>) -> Option<Fix> {
        let key_text = context.span_text(fix_data.record_key).trim();
        let record_text = context.span_text(fix_data.record).trim();

        let replacement = format!("{record_text} has {key_text}");

        Some(Fix {
            explanation: "Replace with 'has' operator".into(),
            replacements: vec![Replacement::new(fix_data.full_span, replacement)],
        })
    }
}

pub static RULE: &dyn Rule = &ColumnsInToHas;