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
107
108
109
110
111
112

use std::{collections::HashMap, iter::once};

use miette::Severity;

use super::read_source_code;
use crate::violation::Violation;

/// Format violations in compact one-line-per-violation style (gcc/eslint).
///
/// Output format: `file:line:col: severity(rule_id): message`
#[must_use]
pub fn format_compact(violations: &[Violation]) -> String {
    if violations.is_empty() {
        return String::from("No violations found!");
    }

    let sources = build_source_cache(violations);

    violations
        .iter()
        .map(|v| {
            let file_name = v.file.as_ref().map_or("<stdin>", |f| f.as_str());
            let source = sources.get(file_name).map_or("", String::as_str);
            let span = v.file_span();
            let (line, col) = byte_offset_to_line_col(source, span.start);
            let severity = severity_label(v.lint_level);
            let rule_id = v.rule_id.as_deref().unwrap_or("unknown");
            format!(
                "{file_name}:{line}:{col}: {severity}({rule_id}): {}",
                v.message
            )
        })
        .collect::<Vec<_>>()
        .join("\n")
}

fn build_source_cache(violations: &[Violation]) -> HashMap<&str, String> {
    violations.iter().fold(HashMap::new(), |mut cache, v| {
        let file_name = v.file.as_ref().map_or("<stdin>", |f| f.as_str());
        cache.entry(file_name).or_insert_with(|| {
            v.source
                .as_ref()
                .map_or_else(|| read_source_code(v.file.as_ref()), ToString::to_string)
        });
        cache
    })
}

/// Convert a byte offset in `source` to a 1-based `(line, col)` pair.
fn byte_offset_to_line_col(source: &str, offset: usize) -> (usize, usize) {
    let offset = offset.min(source.len());

    let line_starts: Vec<usize> = once(0)
        .chain(
            source
                .bytes()
                .enumerate()
                .filter_map(|(i, b)| (b == b'\n').then_some(i + 1)),
        )
        .collect();

    let line_index = line_starts
        .partition_point(|&start| start <= offset)
        .saturating_sub(1);
    let col = offset - line_starts[line_index];

    (line_index + 1, col + 1)
}

const fn severity_label(severity: Severity) -> &'static str {
    match severity {
        Severity::Error => "error",
        Severity::Warning => "warning",
        Severity::Advice => "hint",
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn byte_offset_at_start() {
        assert_eq!(byte_offset_to_line_col("hello\nworld", 0), (1, 1));
    }

    #[test]
    fn byte_offset_mid_first_line() {
        assert_eq!(byte_offset_to_line_col("hello\nworld", 3), (1, 4));
    }

    #[test]
    fn byte_offset_at_newline() {
        // offset 5 is the '\n' character itself — still on line 1
        assert_eq!(byte_offset_to_line_col("hello\nworld", 5), (1, 6));
    }

    #[test]
    fn byte_offset_start_of_second_line() {
        assert_eq!(byte_offset_to_line_col("hello\nworld", 6), (2, 1));
    }

    #[test]
    fn byte_offset_past_end_clamped() {
        assert_eq!(byte_offset_to_line_col("hello", 999), (1, 6));
    }

    #[test]
    fn byte_offset_empty_source() {
        assert_eq!(byte_offset_to_line_col("", 0), (1, 1));
    }
}