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

mod compact;
mod pretty;

use std::fs;

pub use compact::format_compact;
use miette::Severity;
pub use pretty::{format_diff_context, format_pretty};
use serde::Serialize;

use crate::violation::{SourceFile, Violation};

/// Output format for linting results
#[derive(clap::ValueEnum, Clone, Copy, Default)]
pub enum Format {
    /// Human-readable text format with source snippets (default)
    #[default]
    Pretty,
    /// One-line-per-violation format (gcc/eslint style)
    Compact,
}

/// Format and output linting results
#[must_use]
pub fn format_output(violations: &[Violation], format: Format) -> String {
    match format {
        Format::Pretty => format_pretty(violations),
        Format::Compact => format_compact(violations),
    }
}

#[derive(Serialize)]
pub struct Summary {
    pub errors: usize,
    pub warnings: usize,
    pub hints: usize,
    pub files_checked: usize,
}

impl Summary {
    #[must_use]
    pub fn from_violations(violations: &[Violation]) -> Self {
        let (errors, warnings, hints) = violations.iter().fold(
            (0, 0, 0),
            |(errors, warnings, hints), violation| match violation.lint_level {
                Severity::Error => (errors + 1, warnings, hints),
                Severity::Warning => (errors, warnings + 1, hints),
                Severity::Advice => (errors, warnings, hints + 1),
            },
        );

        Self {
            errors,
            warnings,
            hints,
            files_checked: 1,
        }
    }

    #[must_use]
    pub fn format_compact(&self) -> String {
        let parts: Vec<String> = [
            (self.errors > 0).then(|| format!("{} error(s)", self.errors)),
            (self.warnings > 0).then(|| format!("{} warning(s)", self.warnings)),
            (self.hints > 0).then(|| format!("{} hint(s)", self.hints)),
        ]
        .into_iter()
        .flatten()
        .collect();

        if parts.is_empty() {
            String::from("0 violations")
        } else {
            parts.join(", ")
        }
    }
}

pub fn read_source_code(file: Option<&SourceFile>) -> String {
    file.and_then(|f| f.as_path())
        .and_then(|path| fs::read_to_string(path).ok())
        .unwrap_or_default()
}