penknife 0.2.1

Git-style remotes for your documents: sync a folder of markdown to GitHub Gists, track drift per file, and copy anything as rich text to paste elsewhere
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

use std::sync::OnceLock;

/// Glyphs used throughout the UI. Three profiles:
///
/// - slim (default): single-column unicode symbols. Predictable widths, so
///   tree rows and the status bar stay aligned in every terminal/font combo.
/// - emoji: the original wide glyphs, opt-in via `PENKNIFE_EMOJI=1` for terminals
///   that render them well.
/// - ASCII: pure 7-bit fallback, via `PENKNIFE_NO_EMOJI` or a dumb `TERM`.
pub struct Glyphs {
    pub status_synced: &'static str,
    pub status_local_newer: &'static str,
    pub status_remote_newer: &'static str,
    pub status_conflict: &'static str,
    pub status_not_gisted: &'static str,
    pub dir: &'static str,
    pub file_pane: &'static str,
    pub help: &'static str,
    pub search: &'static str,
    pub warn: &'static str,
    pub info: &'static str,
    pub root: &'static str,
    pub welcome: &'static str,
    pub question: &'static str,
    pub git_staged: &'static str,
    pub git_modified: &'static str,
    pub git_untracked: &'static str,
    pub git_clean: &'static str,
}

const SLIM: Glyphs = Glyphs {
    status_synced: "✓",
    status_local_newer: "↑",
    status_remote_newer: "↓",
    status_conflict: "!",
    status_not_gisted: "·",
    dir: "▸",
    file_pane: "≡",
    help: "?",
    search: "/",
    warn: "!",
    info: "i",
    root: "⌂",
    welcome: "»",
    question: "?",
    git_staged: "✦",
    git_modified: "✱",
    git_untracked: "?",
    git_clean: " ",
};

const EMOJI: Glyphs = Glyphs {
    status_synced: "✅",
    status_local_newer: "⬆️",
    status_remote_newer: "⬇️",
    status_conflict: "❗",
    status_not_gisted: "⚪",
    dir: "📁",
    file_pane: "📄",
    help: "❓",
    search: "🔍",
    warn: "⚠️",
    info: "💬",
    root: "📂",
    welcome: "👋",
    question: "❓",
    git_staged: "✦",
    git_modified: "✱",
    git_untracked: "?",
    git_clean: " ",
};

const ASCII: Glyphs = Glyphs {
    status_synced: "[=]",
    status_local_newer: "[^]",
    status_remote_newer: "[v]",
    status_conflict: "[!]",
    status_not_gisted: "[ ]",
    dir: "[d]",
    file_pane: "[f]",
    help: "[?]",
    search: "[/]",
    warn: "[!]",
    info: "[i]",
    root: "[r]",
    welcome: "[*]",
    question: "[?]",
    git_staged: "+",
    git_modified: "*",
    git_untracked: "?",
    git_clean: " ",
};

static GLYPHS: OnceLock<&'static Glyphs> = OnceLock::new();

/// Get the active glyph set (initialized lazily on first call).
pub fn glyphs() -> &'static Glyphs {
    GLYPHS.get_or_init(pick_profile)
}

fn pick_profile() -> &'static Glyphs {
    if use_ascii() {
        &ASCII
    } else if env_flag("EMOJI") {
        &EMOJI
    } else {
        &SLIM
    }
}

/// A boolean opt-in flag, read from `PENKNIFE_<name>`.
pub(crate) fn env_flag(name: &str) -> bool {
    std::env::var_os(format!("PENKNIFE_{name}")).is_some()
}

fn use_ascii() -> bool {
    if env_flag("NO_EMOJI") {
        return true;
    }
    matches!(
        std::env::var("TERM").as_deref(),
        Ok("dumb" | "linux" | "vt100" | "vt220")
    )
}

#[cfg(test)]
mod tests {
    use super::SLIM;
    use unicode_width::UnicodeWidthStr;

    /// The whole point of the slim profile is layout stability: every glyph
    /// must occupy exactly one terminal column.
    #[test]
    fn slim_glyphs_are_single_width() {
        for (name, s) in [
            ("status_synced", SLIM.status_synced),
            ("status_local_newer", SLIM.status_local_newer),
            ("status_remote_newer", SLIM.status_remote_newer),
            ("status_conflict", SLIM.status_conflict),
            ("status_not_gisted", SLIM.status_not_gisted),
            ("dir", SLIM.dir),
            ("file_pane", SLIM.file_pane),
            ("help", SLIM.help),
            ("search", SLIM.search),
            ("warn", SLIM.warn),
            ("info", SLIM.info),
            ("root", SLIM.root),
            ("welcome", SLIM.welcome),
            ("question", SLIM.question),
            ("git_staged", SLIM.git_staged),
            ("git_modified", SLIM.git_modified),
            ("git_untracked", SLIM.git_untracked),
            ("git_clean", SLIM.git_clean),
        ] {
            assert_eq!(s.width(), 1, "glyph `{name}` ({s:?}) is not 1 column wide");
        }
    }
}