git-stk 0.7.5

Git-native stacked branch workflow helper
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

//! Semantic terminal styles. Styled lines must be printed through
//! `anstream::println!`/`eprintln!`, which strip color for pipes, NO_COLOR,
//! and consoles that cannot render it.

use anstyle::{AnsiColor, Style};

use crate::providers::ReviewState;

/// Branch names.
pub const BRANCH: Style = AnsiColor::Cyan.on_default();
/// The branch you are standing on.
pub const CURRENT: Style = AnsiColor::Green.on_default().bold();
/// Secondary detail: URLs, the trunk tag, counts.
pub const DIM: Style = Style::new().dimmed();
/// The `hint:` prefix.
pub const HINT: Style = AnsiColor::Cyan.on_default();
/// The `warning:` prefix.
pub const WARN: Style = AnsiColor::Yellow.on_default();

/// Review states, matching the ledger emoji: green open, purple merged,
/// red closed.
pub const OPEN: Style = AnsiColor::Green.on_default();
pub const MERGED: Style = AnsiColor::Magenta.on_default();
pub const CLOSED: Style = AnsiColor::Red.on_default();

pub fn paint(style: Style, text: &str) -> String {
    format!("{style}{text}{style:#}")
}

/// A branch name in the branch color.
pub fn branch(name: &str) -> String {
    paint(BRANCH, name)
}

/// Secondary detail: ids, urls, skip lines, previews.
pub fn dim(text: &str) -> String {
    paint(DIM, text)
}

/// Completion lines ("... complete", "merged ...").
pub fn success(text: &str) -> String {
    paint(OPEN, text)
}

/// Notable-but-not-fatal lines.
pub fn warn(text: &str) -> String {
    paint(WARN, text)
}

/// The shared `hint:` prefix.
pub fn hint_prefix() -> String {
    paint(HINT, "hint:")
}

/// A review state in its color.
pub fn state(state: &ReviewState) -> String {
    let style = match state {
        ReviewState::Open => OPEN,
        ReviewState::Merged => MERGED,
        ReviewState::Closed => CLOSED,
        ReviewState::Unknown(_) => DIM,
    };
    paint(style, &state.to_string())
}

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

    #[test]
    fn paint_wraps_text_in_escape_codes() {
        let painted = paint(BRANCH, "feature/a");
        assert!(painted.contains("feature/a"));
        assert!(painted.starts_with('\u{1b}'));
        assert!(painted.ends_with('m'));
    }

    #[test]
    fn state_uses_the_ledger_palette() {
        assert!(state(&ReviewState::Open).contains("open"));
        assert!(state(&ReviewState::Merged).contains("merged"));
        assert!(state(&ReviewState::Closed).contains("closed"));
        assert_ne!(
            state(&ReviewState::Open),
            state(&ReviewState::Merged),
            "states should not share a style"
        );
    }
}