lucid-lint 0.2.1

A cognitive accessibility linter for prose. Bilingual EN/FR. CI-native.
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

//! Output formatters for diagnostics.
//!
//! Formats supported in v0.2:
//!
//! - [`tty`]: human-readable, colorized when stdout is a tty
//! - [`json`]: stable JSON schema for CI and tooling integration
//! - [`sarif`]: SARIF v2.1.0 for GitHub Code Scanning and compatible consumers

use serde::{Deserialize, Serialize};

use crate::scoring::Scorecard;
use crate::types::Diagnostic;

pub mod json;
pub mod sarif;
pub mod tty;

/// Output format selector for the CLI and library.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Format {
    /// Human-readable terminal output (default).
    #[default]
    Tty,
    /// Structured JSON output.
    Json,
    /// SARIF v2.1.0 log for GitHub Code Scanning.
    Sarif,
}

impl Format {
    /// Render diagnostics + scorecard to a String using this format.
    #[must_use]
    pub fn render(self, diagnostics: &[Diagnostic], scorecard: &Scorecard) -> String {
        match self {
            Self::Tty => tty::render(
                diagnostics,
                scorecard,
                tty::TtyOptions::new(tty::ColorMode::Auto),
            ),
            Self::Json => json::render(diagnostics, scorecard),
            Self::Sarif => sarif::render(diagnostics, scorecard),
        }
    }
}