nu-lint 1.2.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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

use crate::{
    LintLevel,
    context::{ExternalCmdFixData, LintContext},
    rule::{DetectFix, Rule},
    violation::{Detection, Fix, Replacement},
};

const NOTE: &str = "Use 'sys host' to get system information. Nu's sys host returns structured \
                    data with fields like name, os_version, kernel_version, hostname, and uptime.";

#[derive(Default)]
struct UnameOptions {
    all: bool,
    kernel_name: bool,
    kernel_release: bool,
    kernel_version: bool,
    machine: bool,
    os_name: bool,
}

impl UnameOptions {
    fn parse<'a>(args: impl IntoIterator<Item = &'a str>) -> Self {
        let mut opts = Self::default();

        for text in args {
            Self::parse_arg(&mut opts, text);
        }

        opts
    }

    fn parse_arg(opts: &mut Self, text: &str) {
        match text {
            "-a" | "--all" => opts.all = true,
            "-s" | "--kernel-name" => opts.kernel_name = true,
            "-r" | "--kernel-release" => opts.kernel_release = true,
            "-v" | "--kernel-version" => opts.kernel_version = true,
            "-m" | "--machine" => opts.machine = true,
            "-o" | "--operating-system" => opts.os_name = true,
            _ => {}
        }
    }

    fn to_nushell(&self) -> (String, String) {
        let (replacement, description) = if self.all {
            (
                "sys host".to_string(),
                "Use 'sys host' to get all system information as a structured record. Fields \
                 include name, kernel_version, os_version, hostname, and more."
                    .to_string(),
            )
        } else if self.kernel_release || self.kernel_version {
            (
                "sys host | get kernel_version".to_string(),
                "Use 'sys host | get kernel_version' to get the kernel version.".to_string(),
            )
        } else if self.kernel_name || self.os_name {
            (
                "sys host | get name".to_string(),
                "Use 'sys host | get name' to get the operating system name.".to_string(),
            )
        } else if self.machine {
            (
                "sys host | get name".to_string(),
                "Use 'sys host | get name' for system information. For architecture, use \
                 $nu.os-info.arch."
                    .to_string(),
            )
        } else {
            (
                "sys host | get name".to_string(),
                "Use 'sys host | get name' to get the operating system name. For more details, \
                 use 'sys host' to get all system information."
                    .to_string(),
            )
        };

        (replacement, description)
    }
}

struct UseSysHostInsteadOfUname;

impl DetectFix for UseSysHostInsteadOfUname {
    type FixInput<'a> = ExternalCmdFixData<'a>;

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

    fn short_description(&self) -> &'static str {
        "`uname` replaceable with `sys host`"
    }

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

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

    fn detect<'a>(&self, context: &'a LintContext) -> Vec<(Detection, Self::FixInput<'a>)> {
        context.detect_external_with_validation("uname", |_, _, _| Some(NOTE))
    }

    fn fix(&self, context: &LintContext, fix_data: &Self::FixInput<'_>) -> Option<Fix> {
        let opts = UnameOptions::parse(fix_data.arg_texts(context));
        let (replacement, description) = opts.to_nushell();

        Some(Fix {
            explanation: description.into(),
            replacements: vec![Replacement {
                span: fix_data.expr_span.into(),
                replacement_text: replacement.into(),
            }],
        })
    }
}

pub static RULE: &dyn Rule = &UseSysHostInsteadOfUname;

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