ui.rs 19.9%

34 of 171 lines run, 6 of 37 functions · run #2 on main · run missed

#![allow(dead_code)] // Shared with oxy: not every helper is used yet.
//! Terminal presentation: colour, emphasis, and a live spinner while a
//! command works. Everything degrades to plain text when stdout is not a
//! terminal, when `NO_COLOR` is set, or with `--plain`.

use console::{style, StyledObject, Term};
use indicatif::{ProgressBar, ProgressStyle};
use std::sync::atomic::{AtomicBool, Ordering};
use std::time::Duration;

static PLAIN: AtomicBool = AtomicBool::new(false);
static UNICODE: AtomicBool = AtomicBool::new(false);
static INIT: std::sync::Once = std::sync::Once::new();

/// Decide once whether to use colour, glyphs, and animation.
pub fn init(plain_flag: bool) {
    INIT.call_once(|| {
        let no_color = std::env::var_os("NO_COLOR").is_some();
        let tty = Term::stdout().features().is_attended();
        let plain = plain_flag || no_color || !tty;
        PLAIN.store(plain, Ordering::Relaxed);
        console::set_colors_enabled(!plain);
        let utf8 = ["LC_ALL", "LC_CTYPE", "LANG"]
            .iter()
            .filter_map(|k| std::env::var(k).ok())
            .find(|v| !v.is_empty())
            .map(|v| v.to_ascii_uppercase().contains("UTF-8") || v.to_ascii_uppercase().contains("UTF8"))
            .unwrap_or(false);
        UNICODE.store(!plain && utf8, Ordering::Relaxed);
    });
}

pub fn plain() -> bool {
    PLAIN.load(Ordering::Relaxed)
}

/// Whether the terminal takes Unicode glyphs (a UTF-8 locale, not `--plain`).
pub fn unicode() -> bool {
    UNICODE.load(Ordering::Relaxed)
}

/// A glyph with an ASCII fallback for plain output and non-UTF-8 locales.
pub fn glyph<'a>(fancy: &'a str, ascii: &'a str) -> &'a str {
    if unicode() {
        fancy
    } else {
        ascii
    }
}

/// A finished action: a tick and the verb in green.
pub fn done<T: std::fmt::Display>(v: T) -> String {
    format!("{} {}", ok(glyph("✔", "*")), ok(v))
}

/// A warning line prefix.
pub fn caution() -> String {
    warn(glyph("⚠", "!"))
}

/// An informational note prefix.
pub fn note() -> String {
    dim(glyph("›", ">"))
}

/// A section title.
pub fn section<T: std::fmt::Display>(v: T) -> String {
    format!("{} {}", s(glyph("▍", "#")).cyan(), s(v).bold())
}

/// `  key   value`, with the key dimmed and padded.
pub fn kv<T: std::fmt::Display>(key: &str, value: T) -> String {
    format!("  {} {value}", dim(format!("{key:<8}")))
}

/// An author name.
pub fn author<T: std::fmt::Display>(v: T) -> String {
    s(v).magenta().to_string()
}

/// A bookmark or reference name.
pub fn bookmark<T: std::fmt::Display>(v: T) -> String {
    s(v).green().bold().to_string()
}

/// The subject line of a message.
pub fn subject<T: std::fmt::Display>(v: T) -> String {
    s(v).bold().to_string()
}

/// A dimmed separator between the parts of a metadata line.
pub fn sep() -> String {
    dim(format!(" {} ", glyph("·", "-")))
}

/// Milliseconds since the epoch as a relative time ("3 minutes ago"), or the
/// date when older than a month.
pub fn ago(ms: u64) -> String {
    let now = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).map(|d| d.as_millis() as u64).unwrap_or(0);
    let secs = now.saturating_sub(ms) / 1000;
    let unit = |n: u64, w: &str| format!("{n} {w}{} ago", if n == 1 { "" } else { "s" });
    match secs {
        0..=44 => "just now".into(),
        45..=89 => "a minute ago".into(),
        90..=2_699 => unit(secs.div_ceil(60), "minute"),
        2_700..=5_399 => "an hour ago".into(),
        5_400..=79_199 => unit(secs.div_ceil(3_600), "hour"),
        79_200..=129_599 => "yesterday".into(),
        129_600..=2_591_999 => unit(secs.div_ceil(86_400), "day"),
        _ => super::format::when(ms).split(' ').next().unwrap_or("").to_string(),
    }
}

/// The bullet for a log entry: the working copy, a head, or an ordinary change.
pub fn log_bullet(working_copy: bool, head: bool, conflicted: bool) -> String {
    if working_copy {
        s(glyph("◉", "@")).cyan().bold().to_string()
    } else if conflicted {
        err(glyph("✱", "!"))
    } else if head {
        ok(glyph("●", "*"))
    } else {
        dim(glyph("○", "o"))
    }
}

/// A status glyph and word for a working-copy change.
pub fn status_mark(tag: &str) -> String {
    let (g, a, word) = match tag {
        "A" => ("✚", "+", "added"),
        "M" => ("✎", "~", "modified"),
        "D" => ("✖", "-", "removed"),
        "X" => ("⚙", "x", "mode"),
        "C!" => ("‼", "!", "markers"),
        "R" => ("➜", ">", "renamed"),
        "V" => ("✔", "r", "resolved"),
        _ => ("?", "?", "unknown"),
    };
    let text = format!("{} {word:<9}", glyph(g, a));
    self::tag_style(tag, &text)
}

fn tag_style(t: &str, text: &str) -> String {
    match t {
        "A" | "V" => s(text).green().to_string(),
        "R" => s(text).cyan().to_string(),
        "M" | "X" => s(text).yellow().to_string(),
        "D" | "C!" => s(text).red().to_string(),
        _ => text.to_string(),
    }
}

fn s<T: std::fmt::Display>(v: T) -> StyledObject<T> {
    style(v)
}

/// A ChangeId prefix.
pub fn id<T: std::fmt::Display>(v: T) -> String {
    s(v).cyan().bold().to_string()
}
/// A hash prefix.
pub fn hash<T: std::fmt::Display>(v: T) -> String {
    s(v).dim().to_string()
}
pub fn path<T: std::fmt::Display>(v: T) -> String {
    s(v).bold().to_string()
}
pub fn ok<T: std::fmt::Display>(v: T) -> String {
    s(v).green().to_string()
}
pub fn warn<T: std::fmt::Display>(v: T) -> String {
    s(v).yellow().to_string()
}
pub fn err<T: std::fmt::Display>(v: T) -> String {
    s(v).red().bold().to_string()
}
pub fn dim<T: std::fmt::Display>(v: T) -> String {
    s(v).dim().to_string()
}
pub fn heading<T: std::fmt::Display>(v: T) -> String {
    s(v).bold().underlined().to_string()
}
/// A live spinner with a message, shown only on a terminal. Drop or call
/// `done` to clear it; `done` prints the final line in its place.
pub struct Spinner {
    bar: Option<ProgressBar>,
}

pub fn spinner(msg: &str) -> Spinner {
    if plain() {
        return Spinner { bar: None };
    }
    let bar = ProgressBar::new_spinner();
    bar.set_style(
        ProgressStyle::with_template("{spinner:.cyan} {msg}")
            .unwrap()
            .tick_strings(&["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏", " "]),
    );
    bar.set_message(msg.to_string());
    bar.enable_steady_tick(Duration::from_millis(80));
    Spinner { bar: Some(bar) }
}

impl Spinner {
    /// Replace the spinner with a final line (or print it plainly). The
    /// line is printed as given: callers start it with their own mark.
    pub fn done(self, msg: &str) {
        if let Some(b) = &self.bar {
            b.finish_and_clear();
        }
        println!("{msg}");
    }
    /// Say what is happening now: the spinner's message, or, with no
    /// terminal, a line on stderr, so a long command is never silent.
    pub fn set(&self, msg: &str) {
        match &self.bar {
            Some(b) => b.set_message(msg.to_string()),
            None => eprintln!("{} {msg}", dim(glyph("›", ">"))),
        }
    }
    /// Clear the spinner without printing.
    pub fn clear(self) {
        if let Some(b) = &self.bar {
            b.finish_and_clear();
        }
    }
}

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

    #[test]
    fn relative_times() {
        let now = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap().as_millis() as u64;
        assert_eq!(ago(now), "just now");
        assert_eq!(ago(now - 60_000), "a minute ago");
        assert_eq!(ago(now - 5 * 60_000), "5 minutes ago");
        assert_eq!(ago(now - 3 * 3_600_000), "3 hours ago");
        assert_eq!(ago(now - 25 * 3_600_000), "yesterday");
        assert_eq!(ago(now - 4 * 86_400_000), "4 days ago");
        assert_eq!(ago(0), "1970-01-01");
        assert_eq!(glyph("✔", "*"), if unicode() { "✔" } else { "*" });
    }
}

`/`	Search
`g` `c`	Code
`g` `h`	History
`g` `b`	Bookmarks
`g` `t`	Trust
`y`	Permalink to this state (files and trees)
`?`	This sheet

1		#![allow(dead_code)] // Shared with oxy: not every helper is used yet.
2		//! Terminal presentation: colour, emphasis, and a live spinner while a
3		//! command works. Everything degrades to plain text when stdout is not a
4		//! terminal, when `NO_COLOR` is set, or with `--plain`.
5
6		use console::{style, StyledObject, Term};
7		use indicatif::{ProgressBar, ProgressStyle};
8		use std::sync::atomic::{AtomicBool, Ordering};
9		use std::time::Duration;
10
11		static PLAIN: AtomicBool = AtomicBool::new(false);
12		static UNICODE: AtomicBool = AtomicBool::new(false);
13		static INIT: std::sync::Once = std::sync::Once::new();
14
15		/// Decide once whether to use colour, glyphs, and animation.
16	0×	pub fn init(plain_flag: bool) {
17	0×	INIT.call_once(\|\| {
18	0×	let no_color = std::env::var_os("NO_COLOR").is_some();
19	0×	let tty = Term::stdout().features().is_attended();
20	0×	let plain = plain_flag \|\| no_color \|\| !tty;
21	0×	PLAIN.store(plain, Ordering::Relaxed);
22	0×	console::set_colors_enabled(!plain);
23	0×	let utf8 = ["LC_ALL", "LC_CTYPE", "LANG"]
24	0×	.iter()
25	0×	.filter_map(\|k\| std::env::var(k).ok())
26	0×	.find(\|v\| !v.is_empty())
27	0×	.map(\|v\| v.to_ascii_uppercase().contains("UTF-8") \|\| v.to_ascii_uppercase().contains("UTF8"))
28	0×	.unwrap_or(false);
29	0×	UNICODE.store(!plain && utf8, Ordering::Relaxed);
30	0×	});
31	0×	}
32
33	0×	pub fn plain() -> bool {
34	0×	PLAIN.load(Ordering::Relaxed)
35	0×	}
36
37		/// Whether the terminal takes Unicode glyphs (a UTF-8 locale, not `--plain`).
38	2×	pub fn unicode() -> bool {
39	2×	UNICODE.load(Ordering::Relaxed)
40	2×	}
41
42		/// A glyph with an ASCII fallback for plain output and non-UTF-8 locales.
43	1×	pub fn glyph<'a>(fancy: &'a str, ascii: &'a str) -> &'a str {
44	1×	if unicode() {
45	0×	fancy
46		} else {
47	1×	ascii
48		}
49	1×	}
50
51		/// A finished action: a tick and the verb in green.
52	0×	pub fn done<T: std::fmt::Display>(v: T) -> String {
53	0×	format!("{} {}", ok(glyph("✔", "*")), ok(v))
54	0×	}
55
56		/// A warning line prefix.
57	0×	pub fn caution() -> String {
58	0×	warn(glyph("⚠", "!"))
59	0×	}
60
61		/// An informational note prefix.
62	0×	pub fn note() -> String {
63	0×	dim(glyph("›", ">"))
64	0×	}
65
66		/// A section title.
67	0×	pub fn section<T: std::fmt::Display>(v: T) -> String {
68	0×	format!("{} {}", s(glyph("▍", "#")).cyan(), s(v).bold())
69	0×	}
70
71		/// ` key value`, with the key dimmed and padded.
72	0×	pub fn kv<T: std::fmt::Display>(key: &str, value: T) -> String {
73	0×	format!(" {} {value}", dim(format!("{key:<8}")))
74	0×	}
75
76		/// An author name.
77	0×	pub fn author<T: std::fmt::Display>(v: T) -> String {
78	0×	s(v).magenta().to_string()
79	0×	}
80
81		/// A bookmark or reference name.
82	0×	pub fn bookmark<T: std::fmt::Display>(v: T) -> String {
83	0×	s(v).green().bold().to_string()
84	0×	}
85
86		/// The subject line of a message.
87	0×	pub fn subject<T: std::fmt::Display>(v: T) -> String {
88	0×	s(v).bold().to_string()
89	0×	}
90
91		/// A dimmed separator between the parts of a metadata line.
92	0×	pub fn sep() -> String {
93	0×	dim(format!(" {} ", glyph("·", "-")))
94	0×	}
95
96		/// Milliseconds since the epoch as a relative time ("3 minutes ago"), or the
97		/// date when older than a month.
98	7×	pub fn ago(ms: u64) -> String {
99	7×	let now = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).map(\|d\| d.as_millis() as u64).unwrap_or(0);
100	7×	let secs = now.saturating_sub(ms) / 1000;
101	7×	let unit = \|n: u64, w: &str\| format!("{n} {w}{} ago", if n == 1 { "" } else { "s" });
102	7×	match secs {
103	7×	0..=44 => "just now".into(),
104	6×	45..=89 => "a minute ago".into(),
105	5×	90..=2_699 => unit(secs.div_ceil(60), "minute"),
106	4×	2_700..=5_399 => "an hour ago".into(),
107	4×	5_400..=79_199 => unit(secs.div_ceil(3_600), "hour"),
108	3×	79_200..=129_599 => "yesterday".into(),
109	2×	129_600..=2_591_999 => unit(secs.div_ceil(86_400), "day"),
110	1×	_ => super::format::when(ms).split(' ').next().unwrap_or("").to_string(),
111		}
112	7×	}
113
114		/// The bullet for a log entry: the working copy, a head, or an ordinary change.
115	0×	pub fn log_bullet(working_copy: bool, head: bool, conflicted: bool) -> String {
116	0×	if working_copy {
117	0×	s(glyph("◉", "@")).cyan().bold().to_string()
118	0×	} else if conflicted {
119	0×	err(glyph("✱", "!"))
120	0×	} else if head {
121	0×	ok(glyph("●", "*"))
122		} else {
123	0×	dim(glyph("○", "o"))
124		}
125	0×	}
126
127		/// A status glyph and word for a working-copy change.
128	0×	pub fn status_mark(tag: &str) -> String {
129	0×	let (g, a, word) = match tag {
130	0×	"A" => ("✚", "+", "added"),
131	0×	"M" => ("✎", "~", "modified"),
132	0×	"D" => ("✖", "-", "removed"),
133	0×	"X" => ("⚙", "x", "mode"),
134	0×	"C!" => ("‼", "!", "markers"),
135	0×	"R" => ("➜", ">", "renamed"),
136	0×	"V" => ("✔", "r", "resolved"),
137	0×	_ => ("?", "?", "unknown"),
138		};
139	0×	let text = format!("{} {word:<9}", glyph(g, a));
140	0×	self::tag_style(tag, &text)
141	0×	}
142
143	0×	fn tag_style(t: &str, text: &str) -> String {
144	0×	match t {
145	0×	"A" \| "V" => s(text).green().to_string(),
146	0×	"R" => s(text).cyan().to_string(),
147	0×	"M" \| "X" => s(text).yellow().to_string(),
148	0×	"D" \| "C!" => s(text).red().to_string(),
149	0×	_ => text.to_string(),
150		}
151	0×	}
152
153	0×	fn s<T: std::fmt::Display>(v: T) -> StyledObject<T> {
154	0×	style(v)
155	0×	}
156
157		/// A ChangeId prefix.
158	0×	pub fn id<T: std::fmt::Display>(v: T) -> String {
159	0×	s(v).cyan().bold().to_string()
160	0×	}
161		/// A hash prefix.
162	0×	pub fn hash<T: std::fmt::Display>(v: T) -> String {
163	0×	s(v).dim().to_string()
164	0×	}
165	0×	pub fn path<T: std::fmt::Display>(v: T) -> String {
166	0×	s(v).bold().to_string()
167	0×	}
168	0×	pub fn ok<T: std::fmt::Display>(v: T) -> String {
169	0×	s(v).green().to_string()
170	0×	}
171	0×	pub fn warn<T: std::fmt::Display>(v: T) -> String {
172	0×	s(v).yellow().to_string()
173	0×	}
174	0×	pub fn err<T: std::fmt::Display>(v: T) -> String {
175	0×	s(v).red().bold().to_string()
176	0×	}
177	0×	pub fn dim<T: std::fmt::Display>(v: T) -> String {
178	0×	s(v).dim().to_string()
179	0×	}
180	0×	pub fn heading<T: std::fmt::Display>(v: T) -> String {
181	0×	s(v).bold().underlined().to_string()
182	0×	}
183		/// A live spinner with a message, shown only on a terminal. Drop or call
184		/// `done` to clear it; `done` prints the final line in its place.
185		pub struct Spinner {
186		bar: Option<ProgressBar>,
187		}
188
189	0×	pub fn spinner(msg: &str) -> Spinner {
190	0×	if plain() {
191	0×	return Spinner { bar: None };
192	0×	}
193	0×	let bar = ProgressBar::new_spinner();
194	0×	bar.set_style(
195	0×	ProgressStyle::with_template("{spinner:.cyan} {msg}")
196	0×	.unwrap()
197	0×	.tick_strings(&["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏", " "]),
198		);
199	0×	bar.set_message(msg.to_string());
200	0×	bar.enable_steady_tick(Duration::from_millis(80));
201	0×	Spinner { bar: Some(bar) }
202	0×	}
203
204		impl Spinner {
205		/// Replace the spinner with a final line (or print it plainly). The
206		/// line is printed as given: callers start it with their own mark.
207	0×	pub fn done(self, msg: &str) {
208	0×	if let Some(b) = &self.bar {
209	0×	b.finish_and_clear();
210	0×	}
211	0×	println!("{msg}");
212	0×	}
213		/// Say what is happening now: the spinner's message, or, with no
214		/// terminal, a line on stderr, so a long command is never silent.
215	0×	pub fn set(&self, msg: &str) {
216	0×	match &self.bar {
217	0×	Some(b) => b.set_message(msg.to_string()),
218	0×	None => eprintln!("{} {msg}", dim(glyph("›", ">"))),
219		}
220	0×	}
221		/// Clear the spinner without printing.
222	0×	pub fn clear(self) {
223	0×	if let Some(b) = &self.bar {
224	0×	b.finish_and_clear();
225	0×	}
226	0×	}
227		}
228
229		#[cfg(test)]
230		mod tests {
231		use super::*;
232
233		#[test]
234	1×	fn relative_times() {
235	1×	let now = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap().as_millis() as u64;
236	1×	assert_eq!(ago(now), "just now");
237	1×	assert_eq!(ago(now - 60_000), "a minute ago");
238	1×	assert_eq!(ago(now - 5 * 60_000), "5 minutes ago");
239	1×	assert_eq!(ago(now - 3 * 3_600_000), "3 hours ago");
240	1×	assert_eq!(ago(now - 25 * 3_600_000), "yesterday");
241	1×	assert_eq!(ago(now - 4 * 86_400_000), "4 days ago");
242	1×	assert_eq!(ago(0), "1970-01-01");
243	1×	assert_eq!(glyph("✔", ""), if unicode() { "✔" } else { "" });
244	1×	}
245		}

Coverage / src/cli/ui.rs 19.9%

Keyboard