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

use nu_protocol::{Span, ast::Pipeline};

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

pub struct FixData {
    full_span: Span,
    format: String,
    filename: String,
}

fn check_pipeline(pipeline: &Pipeline, context: &LintContext) -> Vec<(Detection, FixData)> {
    find_open_from_patterns(pipeline, context)
        .into_iter()
        .filter(|pattern| !pattern.has_raw_flag)
        .map(|pattern| {
            let full_span = open_from_span(&pattern);
            let format = &pattern.format;
            let filename = &pattern.filename;

            let detected = Detection::from_global_span(
                format!(
                    "'from {format}' expects text input but 'open {filename}' returns structured \
                     data"
                ),
                pattern.from_expr.span,
            )
            .with_primary_label("'from' expects text, not structured data")
            .with_extra_label(
                "Nu recognizes this format and parses it automatically",
                pattern.open_expr.span,
            );

            let fix_data = FixData {
                full_span,
                format: format.clone(),
                filename: filename.clone(),
            };

            (detected, fix_data)
        })
        .collect()
}

/// Detects `open FILE.json | from json` which is an error because `open`
/// already recognizes the file format and parses it into structured data. The
/// `from` command expects text input, not structured data.
struct FromAfterParsedOpen;

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

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

    fn short_description(&self) -> &'static str {
        "`open` already parses known formats into structured data"
    }

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

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

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

    fn fix(&self, _context: &LintContext, fix_data: &Self::FixInput<'_>) -> Option<Fix> {
        Some(Fix {
            explanation: format!(
                "Remove '| from {}' - open already parses this file format",
                fix_data.format
            )
            .into(),
            replacements: vec![Replacement::new(
                fix_data.full_span,
                format!("open {}", fix_data.filename),
            )],
        })
    }
}

pub static RULE: &dyn Rule = &FromAfterParsedOpen;

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