girt-cli 0.2.4

Command-line tool for inspecting and benchmarking Git repositories with girt
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

//! One color policy for help, diagnostics and human command output.

use std::ffi::{OsStr, OsString};
use std::io::IsTerminal;

#[derive(Clone, Copy, Debug, Default, clap::ValueEnum)]
pub enum Color {
    #[default]
    Auto,
    Always,
    Never,
}

impl Color {
    /// Inspect global flags before clap can exit for help or a parse error.
    pub fn early(args: &[OsString]) -> Self {
        let mut color = Self::Auto;
        let mut git = false;
        let mut args = args.iter().skip(1);
        while let Some(arg) = args.next() {
            if arg == "--" {
                break;
            }
            if arg == "--git" {
                git = true;
            }
            let value = if arg == "--color" {
                args.next().and_then(|value| value.to_str())
            } else {
                arg.to_str().and_then(|arg| arg.strip_prefix("--color="))
            };
            if let Some(value) = value {
                color = match value {
                    "always" => Self::Always,
                    "never" => Self::Never,
                    _ => Self::Auto,
                };
            }
        }
        if git { Self::Never } else { color }
    }

    pub fn enabled(self, terminal: bool, env: impl Fn(&str) -> Option<OsString>) -> bool {
        match self {
            Self::Always => true,
            Self::Never => false,
            Self::Auto => {
                if env("NO_COLOR").is_some_and(|value| !value.is_empty()) {
                    false
                } else if env("CLICOLOR_FORCE")
                    .is_some_and(|value| !value.is_empty() && value != "0")
                {
                    true
                } else if env("CLICOLOR").as_deref() == Some(OsStr::new("0")) {
                    false
                } else {
                    terminal && env("TERM").as_deref() != Some(OsStr::new("dumb"))
                }
            }
        }
    }

    pub fn stdout(self) -> bool {
        self.enabled(std::io::stdout().is_terminal(), |name| {
            std::env::var_os(name)
        })
    }

    pub fn stderr(self) -> bool {
        self.enabled(std::io::stderr().is_terminal(), |name| {
            std::env::var_os(name)
        })
    }
}

/// Select style strings once for an output operation.
pub fn style(enabled: bool, ansi: &'static str) -> &'static str {
    if enabled { ansi } else { "" }
}

pub const RESET: &str = "\x1b[0m";
pub const RED: &str = "\x1b[31m";
pub const GREEN: &str = "\x1b[32m";
pub const YELLOW: &str = "\x1b[33m";

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

    #[test]
    fn precedence() {
        type Environment<'a> = &'a [(&'a str, &'a str)];
        let cases: &[(Environment<'_>, bool, bool)] = &[
            (&[], false, false),
            (&[], true, true),
            (&[("TERM", "dumb")], true, false),
            (&[("NO_COLOR", "1"), ("CLICOLOR_FORCE", "1")], true, false),
            (&[("NO_COLOR", "")], true, true),
            (
                &[("CLICOLOR_FORCE", "1"), ("CLICOLOR", "0"), ("TERM", "dumb")],
                false,
                true,
            ),
            (&[("CLICOLOR_FORCE", "0")], false, false),
            (&[("CLICOLOR_FORCE", "")], false, false),
            (&[("CLICOLOR", "0")], true, false),
            (&[("CLICOLOR", "1"), ("TERM", "dumb")], true, false),
        ];
        for &(values, terminal, expected) in cases {
            let env = |name: &str| {
                values
                    .iter()
                    .find(|(key, _)| *key == name)
                    .map(|(_, value)| OsString::from(value))
            };
            assert_eq!(Color::Auto.enabled(terminal, env), expected, "{values:?}");
            assert!(Color::Always.enabled(terminal, env));
            assert!(!Color::Never.enabled(terminal, env));
        }
    }
}