hewdiff 0.4.0

High-performance review-first terminal diff viewer with PR-style comments
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

//! Lazy, per-line syntax highlighting via syntect (pure-Rust fancy-regex).
//!
//! Highlighting is intentionally line-isolated: each diff line is highlighted on
//! its own (no cross-line state), which keeps it cheap and trivially cacheable
//! for viewport-only rendering. Multi-line constructs (block comments, multiline
//! strings) won't carry state across hunk gaps — an accepted trade-off for a
//! diff viewer that never sees the whole file.

use ratatui::style::Color;
use syntect::easy::HighlightLines;
use syntect::highlighting::{Theme, ThemeSet};
use syntect::parsing::{SyntaxReference, SyntaxSet};

/// The vendored default theme, embedded directly in the binary. Unlike
/// `two_face::theme::extra()` (which bundles *all* of bat's themes as one
/// blob), this embeds only the single `.tmTheme` we ship, so we pay for exactly
/// the theme we use. Converted from GitHub's official "Dark High Contrast"
/// VSCode theme — a neutral, genuinely high-contrast palette that suits a
/// GitHub PR review tool.
const DEFAULT_THEME_TM: &str = include_str!("../../themes/github-dark-high-contrast.tmTheme");

/// The default syntax theme. This is the single source of truth for the whole
/// look: the chrome/background palette is *derived* from it (see
/// [`crate::ui::theme::Theme::from_syntect`]), so swapping the embedded
/// `.tmTheme` above rethemes the entire UI.
pub fn default_theme() -> Theme {
    ThemeSet::load_from_reader(&mut std::io::Cursor::new(DEFAULT_THEME_TM))
        .expect("vendored default tmTheme must parse")
}

pub struct Highlighter {
    ps: SyntaxSet,
    theme: Theme,
}

impl Highlighter {
    pub fn new() -> Self {
        // two-face ships bat's extended syntax set (TS/TSX, TOML, Dockerfile, …)
        // and themes; `_no_newlines` matches our line-by-line highlighting.
        let ps = two_face::syntax::extra_no_newlines();
        let theme = default_theme();
        Highlighter { ps, theme }
    }

    /// Resolve a syntax by file path (extension or filename), else plain text.
    pub fn syntax_for(&self, path: &str) -> &SyntaxReference {
        let p = std::path::Path::new(path);
        let ext = p.extension().and_then(|e| e.to_str()).unwrap_or("");
        self.ps
            .find_syntax_by_extension(ext)
            .or_else(|| {
                let name = p.file_name().and_then(|n| n.to_str()).unwrap_or("");
                self.ps.find_syntax_by_token(name)
            })
            .unwrap_or_else(|| self.ps.find_syntax_plain_text())
    }

    /// Highlight one line into `(fg color, text)` runs.
    pub fn line(&self, syntax: &SyntaxReference, text: &str) -> Vec<(Color, String)> {
        let mut h = HighlightLines::new(syntax, &self.theme);
        match h.highlight_line(text, &self.ps) {
            Ok(ranges) => ranges
                .into_iter()
                .map(|(st, s)| {
                    let c = st.foreground;
                    // Downsample to xterm-256 on non-truecolor terminals so the
                    // syntax palette degrades gracefully (see `theme`).
                    let fg = crate::ui::theme::adapt_color(Color::Rgb(c.r, c.g, c.b));
                    (fg, s.to_string())
                })
                .collect(),
            Err(_) => vec![(Color::Gray, text.to_string())],
        }
    }
}

impl Default for Highlighter {
    fn default() -> Self {
        Self::new()
    }
}

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

    #[test]
    fn default_theme_loads_and_highlights() {
        // Guards the vendored asset: a missing/corrupt tmTheme would panic in
        // `new()`, and a theme that yields no colors would defeat the point.
        let hl = Highlighter::new();
        let syntax = hl.syntax_for("main.rs");
        let runs = hl.line(syntax, "let x = 1;");
        assert!(!runs.is_empty(), "highlighting produced no runs");
        // GitHub Dark High Contrast is a truecolor theme; with truecolor active
        // (the test default) at least one run should carry a real RGB foreground.
        assert!(
            runs.iter().any(|(c, _)| matches!(c, Color::Rgb(..))),
            "expected an RGB foreground from the embedded theme"
        );
    }
}