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

use nu_protocol::ast::{Expr, Expression, RecordItem};

use crate::{
    ast::{expression::ExpressionExt, string::StringFormat},
    context::LintContext,
};

pub mod add_help_to_error;
pub mod add_label_to_error;
pub mod add_span_to_label;
pub mod add_url_to_error;
pub mod error_make_for_non_fatal;

pub fn extract_field_name(key: &Expression, context: &LintContext) -> String {
    StringFormat::from_expression(key, context).map_or_else(
        || key.span_text(context).to_string(),
        |format| format.content().to_string(),
    )
}

pub fn has_field(record: &[RecordItem], field_name: &str, context: &LintContext) -> bool {
    record.iter().any(|item| {
        matches!(item, RecordItem::Pair(key, _) if extract_field_name(key, context) == field_name)
    })
}

pub fn extract_record_from_expr(expr: &Expression) -> Option<&Vec<RecordItem>> {
    match &expr.expr {
        Expr::Record(record) => Some(record),
        Expr::FullCellPath(cell_path) => match &cell_path.head.expr {
            Expr::Record(record) => Some(record),
            _ => None,
        },
        _ => None,
    }
}

pub fn get_labels_value<'a>(
    record: &'a [RecordItem],
    context: &LintContext,
) -> Option<&'a Expression> {
    record.iter().find_map(|item| match item {
        RecordItem::Pair(key, value) => {
            let name = extract_field_name(key, context);
            (name == "labels" || name == "label").then_some(value)
        }
        RecordItem::Spread(..) => None,
    })
}