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

//! Enhancers for deprecated nushell features.
//!
//! Each enhancer matches specific deprecation patterns and provides fixes
//! and/or additional context.

use nu_protocol::{ParseWarning, Span};

use crate::{
    context::LintContext,
    violation::{Fix, Replacement},
};

/// Enhancement that can be applied to an upstream detection.
#[derive(Default)]
pub struct Enhancement {
    /// Additional notes to append to the message
    pub notes: Vec<String>,
    /// Extra labeled spans to add
    pub extra_labels: Vec<(Span, String)>,
    /// Optional auto-fix
    pub fix: Option<Fix>,
}

/// Try to enhance a deprecation warning with fixes and notes.
pub fn enhance(warning: &ParseWarning, context: &LintContext) -> Option<Enhancement> {
    let ParseWarning::Deprecated { label, span, .. } = warning;

    // get --ignore-errors / -i deprecation (renamed to --optional / -o in 0.106.0)
    if label.contains("get --ignore-errors") {
        let source = context.span_text(*span);
        let replacement = source
            .replace("--ignore-errors", "--optional")
            .replace("-i", "-o");

        return Some(Enhancement {
            notes: vec!["The --optional (-o) flag requires nushell >= 0.106.0".into()],
            extra_labels: vec![],
            fix: Some(Fix {
                explanation: "Replace with --optional (-o)".into(),
                replacements: vec![Replacement::new(*span, replacement)],
            }),
        });
    }

    None
}