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

mod archives;
mod build_tools;
mod containers;
mod filesystem;
mod git;
mod network;
mod package_managers;
mod predicates;
mod shells;
mod system;
mod text_processing;

use nu_protocol::ast::ExternalArgument;
pub use predicates::extract_external_arg_text;

use super::CommonEffect;
use crate::context::LintContext;

/// Things that may happen at runtime for external commands.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ExternEffect {
    /// Effect that is common between built-in and external commands.
    CommonEffect(CommonEffect),
    /// Silent, does not produce useful output
    NoDataInStdout,
    /// This command modifies the file system
    ModifiesFileSystem,
    /// Produces useful output on `StdErr` (maybe in addition to `StdOut`)
    WritesDataToStdErr,
    /// This command performs network I/O operations
    ModifiesNetworkState,
    /// Output is useful to see in real-time (progress bars, build output, etc.)
    SlowStreamingOutput,
}

pub type CommandEffects = (
    &'static str,
    &'static [(ExternEffect, predicates::Predicate)],
);

/// All external command side effects, merged from domain-specific modules.
const ALL_COMMANDS: &[&[CommandEffects]] = &[
    filesystem::COMMANDS,
    archives::COMMANDS,
    text_processing::COMMANDS,
    network::COMMANDS,
    git::COMMANDS,
    build_tools::COMMANDS,
    containers::COMMANDS,
    package_managers::COMMANDS,
    system::COMMANDS,
    shells::COMMANDS,
];

pub fn has_external_side_effect(
    command_name: &str,
    side_effect: ExternEffect,
    context: &LintContext,
    args: &[ExternalArgument],
) -> bool {
    log::trace!("Checking external side effect '{side_effect:?}' for command '{command_name}'");

    for commands in ALL_COMMANDS {
        if let Some((_, effects)) = commands.iter().find(|(name, _)| *name == command_name)
            && let Some((_, predicate)) = effects.iter().find(|(effect, _)| *effect == side_effect)
        {
            log::trace!("Checking external predicate for side effect '{side_effect:?}'");
            let result = predicate(context, args);
            if result {
                log::trace!("External predicate matched for side effect '{side_effect:?}'");
            }
            return result;
        }
    }

    log::trace!(
        "No matching external side effect '{side_effect:?}' found for command '{command_name}'"
    );
    false
}

pub fn has_external_recursive_flag(args: &[ExternalArgument], context: &LintContext) -> bool {
    args.iter().any(|arg| {
        let arg_text = extract_external_arg_text(arg, context);
        matches!(
            arg_text,
            text if text.contains("-r")
                || text.contains("--recursive")
                || text.contains("-rf")
                || text.contains("-fr")
                || text.contains("--force")
        )
    })
}