tailspin 7.0.0

A log file highlighter
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

use crate::theme::Theme;
use serde::Serialize;
use std::fmt::Write;
use tailspin::config::*;
use tailspin::style::Style;

/// The default theme as a `theme.toml` the user can copy and edit. Every table
/// and style is rendered from the same `Default` impls the highlighter uses,
/// so the output cannot drift from the code.
///
/// The exhaustive destructure below fails to compile when `Theme` gains a
/// field, and a field that is never emitted is an unused-variable warning
/// (an error under CI's `-D warnings`).
pub fn default_theme_toml() -> String {
    let Theme {
        keywords: _,
        regexes: _,
        numbers,
        uuids,
        quotes,
        ipv4,
        ipv6,
        dates,
        durations,
        paths,
        urls,
        emails,
        pointers,
        processes,
        key_value_pairs,
        json,
        jvm_stack_traces,
    } = Theme::default();

    let mut out = String::from(
        "\
# Generated by `tspin --generate-default-theme` — DO NOT EDIT.
#
# Every value below is a default: copying this file to
# ~/.config/tailspin/theme.toml and leaving it unchanged does nothing.
# Edit the styles you want to override and delete the rest.
#
# Keyword ([[keywords]]) and regex ([[regexes]]) highlights are additive
# lists and default to empty; the built-in keywords are compiled into tspin.
# See the README for their syntax.
",
    );

    push_config(&mut out, "numbers", &numbers);
    push_config(&mut out, "uuids", &uuids);
    push_quotes(&mut out, quotes);
    push_config(&mut out, "ipv4", &ipv4);
    push_config(&mut out, "ipv6", &ipv6);
    push_config(&mut out, "dates", &dates);
    push_config(&mut out, "durations", &durations);
    push_config(&mut out, "paths", &paths);
    push_config(&mut out, "urls", &urls);
    push_config(&mut out, "emails", &emails);
    push_config(&mut out, "pointers", &pointers);
    push_config(&mut out, "processes", &processes);
    push_config(&mut out, "key_value_pairs", &key_value_pairs);
    push_config(&mut out, "json", &json);
    push_config(&mut out, "jvm_stack_traces", &jvm_stack_traces);

    out
}

/// Writes a config struct as a `[name]` table, one `field = { ... }` per style.
fn push_config<T: Serialize>(out: &mut String, name: &str, config: &T) {
    let table = toml::Value::try_from(config).expect("config structs serialize to tables");
    let table = table.as_table().expect("config structs serialize to tables");

    let styles: Vec<(&str, Style)> = table
        .iter()
        .map(|(field, style)| {
            let style = style.clone().try_into().expect("config fields are styles");
            (field.as_str(), style)
        })
        .collect();

    push_table(out, name, &styles);
}

fn push_table(out: &mut String, name: &str, styles: &[(&str, Style)]) {
    writeln!(out, "\n[{name}]").unwrap();
    for (field, style) in styles {
        writeln!(out, "{field} = {}", inline_style(*style)).unwrap();
    }
}

/// `[quotes]` is the one table with a non-style field.
fn push_quotes(out: &mut String, config: QuoteConfig) {
    writeln!(out, "\n[quotes]\nquote_token = '{}'", config.quote_token as char).unwrap();
    writeln!(out, "style = {}", inline_style(config.style)).unwrap();
}

/// A style as a TOML inline table, e.g. `{ fg = "magenta", italic = true }`.
fn inline_style(style: Style) -> String {
    let table = toml::Value::try_from(style).expect("styles serialize to tables");
    let table = table.as_table().expect("styles serialize to tables");

    let fields: Vec<String> = table.iter().map(|(key, value)| format!("{key} = {value}")).collect();

    format!("{{ {} }}", fields.join(", "))
}

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

    #[test]
    fn generated_theme_parses_and_resolves_to_the_defaults() {
        let generated = default_theme_toml();
        let theme: Theme = toml::from_str(&generated).expect("generated theme must parse cleanly");

        assert_eq!(theme.uuids.letter, UuidConfig::default().letter);
        assert_eq!(theme.durations.unit, DurationConfig::default().unit);
        assert_eq!(theme.numbers.style, NumberConfig::default().style);
        assert_eq!(theme.quotes.quote_token, b'"');
        assert_eq!(theme.ipv4.separator, IpV4Config::default().separator);
        assert_eq!(theme.ipv6.letter, IpV6Config::default().letter);
    }
}