glslint 0.5.0

A luma.gl/deck.gl-aware GLSL checker and language server
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

//! The single diagnostic type every stage produces, plus terminal rendering.

use std::io::IsTerminal;
use std::path::PathBuf;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Severity {
    Error,
    Warning,
    /// Informational — never a failure. Currently the "embedded shader has a
    /// `${…}` interpolation, validated with lints only" note. Doesn't count toward
    /// the CLI's exit status; maps to LSP `INFORMATION`.
    Note,
}

impl Severity {
    fn label(self) -> &'static str {
        match self {
            Severity::Error => "error",
            Severity::Warning => "warning",
            Severity::Note => "note",
        }
    }
    /// ANSI color for the severity label (red / yellow / cyan).
    fn color(self) -> &'static str {
        match self {
            Severity::Error => "\x1b[31m",
            Severity::Warning => "\x1b[33m",
            Severity::Note => "\x1b[36m",
        }
    }
}

/// A diagnostic resolved back to its *original* source file and 1-based
/// line/column — never to the assembled translation unit.
#[derive(Debug, Clone)]
pub struct Diag {
    /// File the diagnostic belongs to (the edited shader, or an injected
    /// module/prelude file when the error originates there).
    pub path: PathBuf,
    /// 1-based line within `path`.
    pub line: u32,
    /// 1-based column.
    pub col: u32,
    /// Length of the highlighted span, in chars (clamped to >= 1).
    pub len: u32,
    pub severity: Severity,
    pub message: String,
    /// Which stage emitted it: "glslang" | "lint" | "glslint" (the last for
    /// tool-level failures, e.g. a missing validator).
    pub source: &'static str,
}

/// Print one diagnostic in `path:line:col: severity: message [source]` form,
/// with color unless `NO_COLOR` is set or output isn't a tty-ish stream.
pub fn print_diag(d: &Diag) {
    let color = std::env::var_os("NO_COLOR").is_none() && std::io::stdout().is_terminal();
    let (c0, c1, dim, dim0) = if color {
        (d.severity.color(), "\x1b[0m", "\x1b[2m", "\x1b[0m")
    } else {
        ("", "", "", "")
    };
    println!(
        "{}:{}:{}: {c0}{}{c1}: {} {dim}[glslint/{}]{dim0}",
        d.path.display(),
        d.line,
        d.col,
        d.severity.label(),
        d.message,
        d.source,
    );
}