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

use nu_protocol::{
    BlockId, Flag, PositionalArg, Span, SyntaxShape, Type,
    ast::{Block, Call},
};

use crate::{ast::call::CallExt, context::LintContext};

pub mod add_type_hints_arguments;
pub mod missing_in_type;
pub mod missing_output_type;

pub fn find_return_span(block: &Block) -> Option<Span> {
    block
        .pipelines
        .last()
        .and_then(|p| p.elements.last())
        .map(|e| e.expr.span)
}

pub fn get_input_type(signature: &nu_protocol::Signature) -> Option<Type> {
    signature
        .input_output_types
        .first()
        .map(|(input, _)| input.clone())
}

pub fn get_output_type(signature: &nu_protocol::Signature) -> Option<Type> {
    signature
        .input_output_types
        .first()
        .map(|(_, output)| output.clone())
}

pub fn find_signature_span(call: &Call, _ctx: &LintContext) -> Option<Span> {
    let sig_arg = call.get_positional_arg(1)?;
    Some(sig_arg.span)
}

fn format_shape(name: &str, shape: &SyntaxShape) -> String {
    match shape {
        SyntaxShape::Any => name.to_string(),
        s => format!("{name}: {s}"),
    }
}

/// Format a required positional parameter: `name: type`
pub fn format_required(p: &PositionalArg) -> String {
    format_shape(&p.name, &p.shape)
}

/// Format an optional positional parameter: `name?: type`
pub fn format_optional(p: &PositionalArg) -> String {
    if matches!(p.shape, SyntaxShape::Any) {
        format!("{}?", p.name)
    } else {
        format!("{}?: {}", p.name, p.shape)
    }
}

/// Format a rest/variadic parameter: `...name: type`
pub fn format_rest(p: &PositionalArg) -> String {
    match &p.shape {
        SyntaxShape::Any => format!("...{}", p.name),
        s => format!("...{}: {s}", p.name),
    }
}

/// Format a rest/variadic parameter with a custom shape (for list<T> -> T
/// conversion)
pub fn format_rest_with_shape(name: &str, shape: &SyntaxShape) -> String {
    match shape {
        SyntaxShape::Any => format!("...{name}"),
        s => format!("...{name}: {s}"),
    }
}

/// Format a flag/named parameter.
pub fn format_flag(f: &Flag) -> String {
    let short = f.short.map(|s| format!(" (-{s})")).unwrap_or_default();
    let arg_type = f.arg.as_ref().map(|s| format!(": {s}")).unwrap_or_default();
    format!("--{}{short}{arg_type}", f.long)
}

/// Extract parameters from a signature as Nu source text.
pub fn extract_parameters_text(signature: &nu_protocol::Signature) -> String {
    signature
        .required_positional
        .iter()
        .map(format_required)
        .chain(signature.optional_positional.iter().map(format_optional))
        .chain(signature.rest_positional.iter().map(format_rest))
        .chain(
            signature
                .named
                .iter()
                .filter(|f| f.long != "help")
                .map(format_flag),
        )
        .collect::<Vec<_>>()
        .join(", ")
}

pub struct FixData {
    pub sig_span: Span,
    pub body_block_id: BlockId,
}