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

use std::collections::BTreeSet;

use nu_protocol::Span;

use crate::{
    ast::{block::BlockExt, declaration::CustomCommandDef},
    context::LintContext,
};

pub trait SpanExt {
    #[must_use]
    /// Finds function containing this span. Example: statement span inside `def
    /// process [] { ... }`
    fn find_containing_function<'a>(
        &self,
        functions: &'a BTreeSet<CustomCommandDef>,
        context: &LintContext,
    ) -> Option<&'a CustomCommandDef>;
    #[must_use]
    /// Finds the span of a substring within this span. Example: finding
    /// parameter name within signature span
    fn find_substring_span(&self, substring: &str, context: &LintContext) -> Span;
    #[must_use]
    /// Check if there's a documentation comment on the same line as this span
    /// This is used for inline parameter documentation: `param # Description`
    fn has_inline_doc_comment(&self, context: &LintContext) -> bool;
    #[must_use]
    /// Check if this span is contained within any of the provided container
    /// spans
    fn is_inside_any(&self, container_spans: &[Span]) -> bool;
}

impl SpanExt for Span {
    fn find_containing_function<'a>(
        &self,
        functions: &'a BTreeSet<CustomCommandDef>,
        context: &LintContext,
    ) -> Option<&'a CustomCommandDef> {
        functions
            .iter()
            .filter(|def| context.working_set.get_block(def.body).contains_span(*self))
            .min_by_key(|def| {
                let block = context.working_set.get_block(def.body);
                block.span.map_or(usize::MAX, |s| s.end - s.start)
            })
    }

    fn find_substring_span(&self, substring: &str, context: &LintContext) -> Span {
        context
            .span_text(*self)
            .as_bytes()
            .windows(substring.len())
            .position(|window| window == substring.as_bytes())
            .map_or(*self, |offset| {
                Self::new(self.start + offset, self.start + offset + substring.len())
            })
    }

    fn has_inline_doc_comment(&self, context: &LintContext) -> bool {
        // Get the source text after this span
        let after_text = context.source_after_span(*self);

        // Find the end of the line (either newline or end of file)
        let line_end = after_text.find('\n').unwrap_or(after_text.len());

        let rest_of_line = &after_text[..line_end];

        // Check if the rest of the line contains a documentation comment
        // For typed parameters like "count: int # Description", the span only covers
        // "count" so we need to check if " # " appears anywhere on the rest of
        // the line
        rest_of_line.contains(" # ")
    }

    fn is_inside_any(&self, container_spans: &[Span]) -> bool {
        container_spans
            .iter()
            .any(|s| s.start <= self.start && s.end >= self.end)
    }
}