alint_output/

style.rs

//! Styles, glyphs, and color-choice plumbing for the human
//! formatter.
//!
//! Two independent axes are handled here:
//!
//! 1. **ANSI color** — whether SGR escape sequences are emitted.
//!    Delegated to [`anstream`] and [`anstyle`]: the CLI wraps
//!    stdout in an `anstream::AutoStream`, which strips SGR codes
//!    on pipes, honors `NO_COLOR` / `CLICOLOR_FORCE`, and respects
//!    an explicit `--color` choice. Formatters just write
//!    `{STYLE}text{STYLE:#}` into the writer; the stream decides
//!    whether to keep the bytes.
//!
//! 2. **Glyph set** — Unicode vs. ASCII fallback for sigils,
//!    separators, and the like. Orthogonal to color: a no-color
//!    terminal can still render `✗`, and a color terminal with
//!    `--ascii` should still emit `x`. Controlled by [`GlyphSet`]
//!    with an auto-detect fallback for `TERM=dumb`.

use anstyle::{AnsiColor, Color, Style};

// ---------------------------------------------------------------
// Role-based style constants.
//
// Centralized so swapping palette is a one-file edit and every
// formatter call site reads as intent (`style::ERROR`) rather
// than a raw SGR code.
// ---------------------------------------------------------------

/// Errors — the thing the user most needs to notice.
pub const ERROR: Style = Style::new()
    .fg_color(Some(Color::Ansi(AnsiColor::Red)))
    .bold();

/// Warnings — actionable but not blocking.
pub const WARNING: Style = Style::new()
    .fg_color(Some(Color::Ansi(AnsiColor::Yellow)))
    .bold();

/// Info — purely advisory.
pub const INFO: Style = Style::new().fg_color(Some(Color::Ansi(AnsiColor::Cyan)));

/// Success / "passed" — all-clear banner.
pub const SUCCESS: Style = Style::new()
    .fg_color(Some(Color::Ansi(AnsiColor::Green)))
    .bold();

/// File path headers.
pub const PATH: Style = Style::new().bold();

/// Rule identifiers — dimmed so they're secondary to the
/// message.
pub const RULE_ID: Style = Style::new().dimmed();

/// Documentation / policy URLs — fallback styling for terminals
/// that do NOT support OSC 8 hyperlinks. Blue + underline reads
/// as the universal link convention.
pub const DOCS: Style = Style::new()
    .fg_color(Some(Color::Ansi(AnsiColor::Blue)))
    .underline();

/// Documentation / policy URLs — styling when the surrounding
/// emission wraps the URL in an OSC 8 hyperlink. The terminal
/// itself handles the link affordance (typically a hover-driven
/// underline + `pointer` cursor), so emitting our own `\e[4m`
/// on top causes some renderers (notably `asciinema-player`)
/// to extend the underline past the link text to the end of the
/// row. Drop the explicit underline; keep blue as the convention.
pub const DOCS_LINKED: Style = Style::new().fg_color(Some(Color::Ansi(AnsiColor::Blue)));

/// "fixable" tag — green to read as a positive affordance.
pub const FIXABLE: Style = Style::new().fg_color(Some(Color::Ansi(AnsiColor::Green)));

/// Dimmed ancillary text (counts, timings, footer notes).
pub const DIM: Style = Style::new().dimmed();

// ---------------------------------------------------------------
// Glyphs.
// ---------------------------------------------------------------

/// The set of single-character glyphs used in the human output.
///
/// Two variants are shipped: [`GlyphSet::UNICODE`] (default) for
/// modern terminals and [`GlyphSet::ASCII`] for `TERM=dumb` or
/// explicit `--ascii`. A future variant could add Nerd Font
/// glyphs on `COLORTERM=truecolor`, but isn't needed today.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct GlyphSet {
    pub error: &'static str,
    pub warning: &'static str,
    pub info: &'static str,
    pub success: &'static str,
    /// Horizontal-rule glyph used for section separators.
    pub rule: &'static str,
    /// Bullet for list items / summary lines.
    pub bullet: &'static str,
    /// Arrow for call-to-action lines (`→ run alint fix`).
    pub arrow: &'static str,
}

impl GlyphSet {
    pub const UNICODE: Self = Self {
        error: "✗",
        warning: "⚠",
        info: "ℹ",
        success: "✓",
        rule: "─",
        bullet: "·",
        arrow: "→",
    };
    pub const ASCII: Self = Self {
        error: "x",
        warning: "!",
        info: "i",
        success: "v",
        rule: "-",
        bullet: "*",
        arrow: "->",
    };

    /// Pick the Unicode set unless the caller forces ASCII or the
    /// environment signals a dumb terminal.
    ///
    /// Reads `$TERM` as the only signal. Thin wrapper around
    /// [`GlyphSet::decide`] — test that directly if you're
    /// exercising the decision logic.
    #[must_use]
    pub fn detect(force_ascii: bool) -> Self {
        Self::decide(force_ascii, std::env::var("TERM").ok().as_deref())
    }

    /// Pure version of [`GlyphSet::detect`] — takes `TERM` as an
    /// explicit argument so tests don't have to mutate process
    /// env (which is `unsafe` under edition 2024).
    #[must_use]
    pub fn decide(force_ascii: bool, term: Option<&str>) -> Self {
        if force_ascii || matches!(term, Some("dumb")) {
            Self::ASCII
        } else {
            Self::UNICODE
        }
    }
}

impl Default for GlyphSet {
    fn default() -> Self {
        Self::UNICODE
    }
}

// ---------------------------------------------------------------
// ColorChoice.
// ---------------------------------------------------------------

/// How to resolve whether to emit ANSI color codes. Parsed from
/// `--color=<auto|always|never>`.
///
/// On `Auto`, [`ColorChoice::resolve`] consults the
/// `CLICOLOR_FORCE` env var (which `anstream` does NOT check on
/// its own) and pre-resolves to `Always` when it's set to
/// anything other than `"0"`. The resulting choice is then
/// handed to `anstream::AutoStream`, which honors `NO_COLOR` and
/// the TTY check on the remaining `Auto` cases.
///
/// `Always` / `Never` are explicit user overrides and bypass the
/// env-var resolution entirely — useful when piping into a pager
/// that understands ANSI, or when capturing output for a
/// snapshot test.
///
/// Precedence summary:
///
/// | `--color` | env                                | result    |
/// |-----------|------------------------------------|-----------|
/// | `always`  | (any)                              | colors on |
/// | `never`   | (any)                              | colors off|
/// | `auto`    | `CLICOLOR_FORCE=1`                 | colors on |
/// | `auto`    | `NO_COLOR=…` (any value)           | colors off|
/// | `auto`    | TTY                                | colors on |
/// | `auto`    | non-TTY                            | colors off|
///
/// `CLICOLOR_FORCE=0` (or unset) is treated as "no force"; only
/// `1` (or any non-`"0"` value) forces colors on.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub enum ColorChoice {
    #[default]
    Auto,
    Always,
    Never,
}

impl ColorChoice {
    /// Pre-resolve `Auto` against the `CLICOLOR_FORCE` env var
    /// before handing off to `anstream`. `Auto + CLICOLOR_FORCE`
    /// → `Always`; everything else returns `self` unchanged.
    ///
    /// `anstream::ColorChoice::Auto` already honors `NO_COLOR`
    /// and the TTY check, so we don't intercept those — the
    /// only env-var contract `anstream` doesn't cover is
    /// `CLICOLOR_FORCE`, which this method adds.
    #[must_use]
    pub fn resolve(self) -> Self {
        if matches!(self, Self::Auto) && cliclor_force_is_set() {
            return Self::Always;
        }
        self
    }

    /// Map to `anstream`'s own enum so `AutoStream::new` accepts
    /// it directly. **Callers should normally call
    /// [`ColorChoice::resolve`] first** to pre-apply the
    /// `CLICOLOR_FORCE` precedence.
    #[must_use]
    pub fn to_anstream(self) -> anstream::ColorChoice {
        match self {
            Self::Auto => anstream::ColorChoice::Auto,
            Self::Always => anstream::ColorChoice::Always,
            Self::Never => anstream::ColorChoice::Never,
        }
    }
}

fn cliclor_force_is_set() -> bool {
    cliclor_force_is_set_in(std::env::var_os("CLICOLOR_FORCE").as_deref())
}

/// Pure decision function lifted out so unit tests can exercise
/// the parsing logic without mutating the process env (the
/// workspace forbids `unsafe` and `set_var` / `remove_var` are
/// `unsafe` in the 2024 edition).
fn cliclor_force_is_set_in(env_var: Option<&std::ffi::OsStr>) -> bool {
    // bixense convention: "1" (or any non-"0" value) forces
    // colors on; "0" or unset means no force.
    match env_var {
        Some(v) => v != "0",
        None => false,
    }
}

impl std::str::FromStr for ColorChoice {
    type Err = String;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_ascii_lowercase().as_str() {
            "auto" | "" => Ok(Self::Auto),
            "always" | "yes" | "true" | "on" => Ok(Self::Always),
            "never" | "no" | "false" | "off" => Ok(Self::Never),
            other => Err(format!(
                "invalid --color value {other:?}; expected auto|always|never"
            )),
        }
    }
}

// ---------------------------------------------------------------
// OSC 8 hyperlinks.
// ---------------------------------------------------------------

/// Write `text` as an OSC 8 hyperlink targeting `url` when
/// `enabled`, or as plain `text` otherwise.
///
/// The OSC 8 sequence (`ESC ] 8 ; ; URL ESC \ text ESC ] 8 ; ; ESC \`)
/// is understood by modern terminals (`iTerm2`, `Kitty`, `WezTerm`,
/// `Alacritty`, `VSCode`'s integrated terminal, Windows Terminal,
/// GNOME Terminal, …). Terminals that don't recognize it are
/// supposed to pass the payload through unchanged — in practice
/// most do, so we only emit the sequence when the CLI has
/// *positively* detected hyperlink support via the
/// `supports-hyperlinks` crate.
///
/// The surrounding SGR (underline + blue) is the caller's
/// responsibility — we keep concerns separate so the same helper
/// can render a cross-reference or a docs link with different
/// styling.
pub fn write_hyperlink(
    w: &mut dyn std::io::Write,
    url: &str,
    text: &str,
    enabled: bool,
) -> std::io::Result<()> {
    if enabled {
        // ST = ESC \ (C1 string terminator). BEL (\x07) works too
        // in most terminals but ESC \ is the standard spelling.
        write!(w, "\x1b]8;;{url}\x1b\\{text}\x1b]8;;\x1b\\")
    } else {
        write!(w, "{text}")
    }
}

// ---------------------------------------------------------------
// Per-render options.
// ---------------------------------------------------------------

/// Renderer options shared across the human formatter family.
/// Kept as a struct so new knobs (`--compact`, timing, etc.) can
/// be added without touching every call site.
///
/// The `Default` impl gives Unicode glyphs, no hyperlinks,
/// `None` for width (formatter falls back to
/// [`HumanOptions::DEFAULT_WIDTH`]), `compact = false`, and
/// `show_docs = true` — i.e. the same shape the CLI produces
/// when no flags are passed.
#[derive(Debug, Clone, Copy)]
pub struct HumanOptions {
    pub glyphs: GlyphSet,
    /// Whether the output sink supports OSC 8 hyperlinks. Detected
    /// by the CLI (via `supports-hyperlinks`) and threaded down
    /// here so formatters decide per-call whether to emit the
    /// OSC 8 sequence.
    pub hyperlinks: bool,
    /// Terminal width in columns, used for stretching section
    /// separators. `None` signals "no TTY / couldn't detect" and
    /// formatters fall back to [`HumanOptions::DEFAULT_WIDTH`].
    pub width: Option<usize>,
    /// Use the one-line-per-violation compact renderer instead of
    /// the grouped full layout. Designed for piping into editors /
    /// grep / `wc -l`. When this is `true`, the full-layout
    /// formatter delegates to the internal compact writer.
    pub compact: bool,
    /// Whether to print per-violation `docs:` URLs in the grouped
    /// full layout. Defaults to `true` (current behaviour). Set
    /// `false` for narrow terminals, screen recordings, or CI
    /// logs where long URLs disrupt visual alignment. Has no
    /// effect on JSON / SARIF / GitHub / markdown output (URLs
    /// always present in machine-readable formats).
    pub show_docs: bool,
}

impl Default for HumanOptions {
    fn default() -> Self {
        Self {
            glyphs: GlyphSet::default(),
            hyperlinks: false,
            width: None,
            compact: false,
            // Default `true` so library callers (and the no-flags
            // CLI invocation) get the same shape they got pre-v0.9.19.
            // The CLI's `--no-docs` flag flips this to `false`.
            show_docs: true,
        }
    }
}

impl HumanOptions {
    /// Width used when no terminal is attached (pipes, files,
    /// non-TTY log capture). Chosen to match POSIX `COLUMNS`
    /// default and what most CLI tools settle on.
    pub const DEFAULT_WIDTH: usize = 80;

    /// Effective render width — the detected terminal width or
    /// `DEFAULT_WIDTH` when detection failed. Capped at a sane
    /// max so a 1000-col terminal doesn't produce section headers
    /// longer than the reader can scan.
    #[must_use]
    pub fn effective_width(&self) -> usize {
        self.width.unwrap_or(Self::DEFAULT_WIDTH).clamp(40, 120)
    }
}

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

    #[test]
    fn color_choice_parses_common_forms() {
        assert_eq!("auto".parse::<ColorChoice>().unwrap(), ColorChoice::Auto);
        assert_eq!(
            "always".parse::<ColorChoice>().unwrap(),
            ColorChoice::Always
        );
        assert_eq!("never".parse::<ColorChoice>().unwrap(), ColorChoice::Never);
        assert_eq!("YES".parse::<ColorChoice>().unwrap(), ColorChoice::Always);
        assert_eq!("off".parse::<ColorChoice>().unwrap(), ColorChoice::Never);
        assert!("sparkles".parse::<ColorChoice>().is_err());
    }

    #[test]
    fn glyph_set_decide_respects_dumb_term() {
        assert_eq!(GlyphSet::decide(false, Some("dumb")), GlyphSet::ASCII);
        assert_eq!(
            GlyphSet::decide(false, Some("xterm-256color")),
            GlyphSet::UNICODE
        );
        assert_eq!(GlyphSet::decide(false, None), GlyphSet::UNICODE);
    }

    #[test]
    fn glyph_set_force_ascii_overrides_term() {
        assert_eq!(
            GlyphSet::decide(true, Some("xterm-256color")),
            GlyphSet::ASCII
        );
        assert_eq!(GlyphSet::decide(true, Some("dumb")), GlyphSet::ASCII);
        assert_eq!(GlyphSet::decide(true, None), GlyphSet::ASCII);
    }

    #[test]
    fn hyperlink_enabled_emits_osc8_sequence() {
        let mut out = Vec::new();
        write_hyperlink(&mut out, "https://example.com", "click", true).unwrap();
        let s = String::from_utf8(out).unwrap();
        // ESC ] 8 ; ; URL ESC \ TEXT ESC ] 8 ; ; ESC \
        assert_eq!(s, "\x1b]8;;https://example.com\x1b\\click\x1b]8;;\x1b\\");
    }

    #[test]
    fn hyperlink_disabled_emits_plain_text() {
        let mut out = Vec::new();
        write_hyperlink(&mut out, "https://example.com", "click", false).unwrap();
        assert_eq!(String::from_utf8(out).unwrap(), "click");
    }

    #[test]
    fn docs_style_carries_underline_and_blue() {
        // Non-OSC-8 fallback path: underline + blue keeps the
        // visual link convention for terminals that can't render
        // the OSC 8 hyperlink semantic themselves.
        let s = format!("{DOCS}link{DOCS:#}");
        assert!(s.contains("\x1b[4m"), "DOCS must carry underline: {s:?}");
        // 4-bit ANSI blue is `\e[34m`.
        assert!(s.contains("\x1b[34m"), "DOCS must carry blue: {s:?}");
    }

    #[test]
    fn docs_linked_drops_underline_keeps_blue() {
        // OSC-8 path: the terminal handles the link affordance
        // itself (hover-driven underline + pointer cursor).
        // Emitting our own `\e[4m` on top causes some renderers
        // — notably `asciinema-player` — to extend the underline
        // past the link text to the end of the row. The
        // DOCS_LINKED style drops the explicit underline; blue
        // stays as the universal "link" convention.
        let s = format!("{DOCS_LINKED}link{DOCS_LINKED:#}");
        assert!(
            !s.contains("\x1b[4m"),
            "DOCS_LINKED must NOT carry an explicit underline: {s:?}"
        );
        assert!(
            s.contains("\x1b[34m"),
            "DOCS_LINKED must keep blue as the link convention: {s:?}"
        );
    }

    // ColorChoice::resolve tests. The workspace forbids
    // `unsafe`, and `std::env::set_var` is `unsafe` in the 2024
    // edition. We therefore test the pure decision function
    // (`cliclor_force_is_set_in`) directly with hand-built
    // `OsStr` values; the `resolve()` end-to-end behaviour is
    // covered by the `cliclor-force-emits-on-non-tty.toml`
    // trycmd snapshot in `crates/alint/tests/cli/`, which sets
    // the env var via trycmd's per-case `env.*` field.

    use std::ffi::OsStr;

    #[test]
    fn cliclor_force_helper_treats_one_as_set() {
        assert!(cliclor_force_is_set_in(Some(OsStr::new("1"))));
    }

    #[test]
    fn cliclor_force_helper_treats_other_truthy_values_as_set() {
        // The bixense convention only specifies "1" → force, but
        // existing tools (Git, less) treat any non-"0" value as
        // "force on". We follow that convention.
        assert!(cliclor_force_is_set_in(Some(OsStr::new("yes"))));
        assert!(cliclor_force_is_set_in(Some(OsStr::new("true"))));
        assert!(cliclor_force_is_set_in(Some(OsStr::new(""))));
    }

    #[test]
    fn cliclor_force_helper_treats_zero_as_no_force() {
        assert!(!cliclor_force_is_set_in(Some(OsStr::new("0"))));
    }

    #[test]
    fn cliclor_force_helper_unset_returns_false() {
        assert!(!cliclor_force_is_set_in(None));
    }

    #[test]
    fn resolve_is_idempotent_for_explicit_choices() {
        // `Always` and `Never` are explicit user choices — they
        // pass through `resolve()` unchanged regardless of the
        // env. (We don't mutate the env here; the explicit
        // branches don't read it.)
        assert_eq!(ColorChoice::Always.resolve(), ColorChoice::Always);
        assert_eq!(ColorChoice::Never.resolve(), ColorChoice::Never);
    }
}