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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
use crossterm::event::{read, Event, KeyCode, KeyEvent};
use crossterm::style::{Color, Print};
use crossterm::terminal::ClearType;
use crossterm::{cursor, execute, terminal};
use futures::Future;
use std::io::{stderr, Write};
use termimad::{CompoundStyle, MadSkin};
use tokio::sync::{
oneshot,
oneshot::{error::TryRecvError, Receiver, Sender},
};
use tokio::task::JoinHandle;
use tokio::time;
use crate::error::Result;
const LOADING_SPINNER_DELAY: u64 = 40;
const LOADING_SPINNER_DOTS: [&str; 56] = [
"⢀⠀", "⡀⠀", "⠄⠀", "⢂⠀", "⡂⠀", "⠅⠀", "⢃⠀", "⡃⠀", "⠍⠀", "⢋⠀", "⡋⠀", "⠍⠁", "⢋⠁", "⡋⠁", "⠍⠉", "⠋⠉",
"⠋⠉", "⠉⠙", "⠉⠙", "⠉⠩", "⠈⢙", "⠈⡙", "⢈⠩", "⡀⢙", "⠄⡙", "⢂⠩", "⡂⢘", "⠅⡘", "⢃⠨", "⡃⢐", "⠍⡐", "⢋⠠",
"⡋⢀", "⠍⡁", "⢋⠁", "⡋⠁", "⠍⠉", "⠋⠉", "⠋⠉", "⠉⠙", "⠉⠙", "⠉⠩", "⠈⢙", "⠈⡙", "⠈⠩", "⠀⢙", "⠀⡙", "⠀⠩",
"⠀⢘", "⠀⡘", "⠀⠨", "⠀⢐", "⠀⡐", "⠀⠠", "⠀⢀", "⠀⡀",
];
pub struct Term {
skin: MadSkin,
}
impl Default for Term {
fn default() -> Self {
Term::new()
}
}
struct Spinner {
tx: Sender<()>,
handle: JoinHandle<Result<()>>,
}
impl Term {
pub fn new() -> Self {
let mut skin = MadSkin::default();
skin.inline_code = CompoundStyle::with_fg(Color::Cyan);
skin.code_block.compound_style = CompoundStyle::with_fg(Color::Cyan);
Term { skin }
}
/// Print text to stdout
pub fn print(&self, text: &str) {
println!("Terminal size: {:?}", crossterm::terminal::size());
println!("Calling skin.print_text with: BEGIN\n{}\nEND", text);
self.skin.print_text(text)
}
/// Print text with error styling to stderr
/// Needs mut to temporarily modify styling (e.g. red fg)
pub fn print_error(&mut self, text: &str) -> Result<()> {
self.print_with_style(Color::Red, "✖ ", text)
}
/// Print text with notice styling to stderr
/// Needs mut to temporarily modify styling (e.g. yellow fg)
pub fn print_notice(&mut self, text: &str) -> Result<()> {
self.print_with_style(Color::Yellow, "➜ ", text)
}
fn print_with_style(&mut self, fg: Color, prefix: &str, text: &str) -> Result<()> {
let mut styled_text = String::from(prefix);
styled_text.push_str(text);
// Set fg
self.skin.paragraph.set_fg(fg);
self.skin
.write_text_on(&mut std::io::stderr(), &styled_text)?;
// Unset fg
self.skin
.paragraph
.compound_style
.object_style
.foreground_color = None;
Ok(())
}
/// Blocks and waits for the user to press any key. Returns whether or not that key is the
/// character key `c`.
pub fn wait_for_char(c: char) -> Result<bool> {
let mut pressed = false;
terminal::enable_raw_mode()?;
loop {
match read()? {
Event::Key(KeyEvent {
code: KeyCode::Char(ch),
..
}) if ch == c => {
pressed = true;
break;
}
Event::Key(_) => break,
_ => (),
}
}
terminal::disable_raw_mode()?;
Ok(pressed)
}
/// As it sounds, takes a future and shows a CLI spinner until it's output is ready
pub async fn wrap_spinner<F>(future: F) -> Result<F::Output>
where
F: Future,
{
// Start spinner
let spinner = Spinner::new();
let result = future.await;
// Stop spinner
spinner.stop().await?;
Ok(result)
}
}
impl Spinner {
/// Start a CLI spinner on the current cursor line. To stop it, call `stop` on the returned
/// `Spinner`.
pub fn new() -> Self {
let (tx, rx) = oneshot::channel();
let handle = tokio::spawn(Self::spin(rx));
Spinner { tx, handle }
}
/// Stop the spinner. This requires a bit of cleanup, and so should be `await`ed before doing
/// any other i/o.
pub async fn stop(self) -> Result<()> {
self.tx.send(()).ok();
self.handle.await??;
Ok(())
}
/// Spin until receiver finds unit
async fn spin(mut rx: Receiver<()>) -> Result<()> {
let mut dots = LOADING_SPINNER_DOTS.iter().cycle();
terminal::enable_raw_mode()?;
execute!(
stderr(),
cursor::SavePosition,
cursor::Hide,
terminal::Clear(ClearType::CurrentLine),
)?;
let mut interval = time::interval(time::Duration::from_millis(LOADING_SPINNER_DELAY));
while let Err(TryRecvError::Empty) = rx.try_recv() {
execute!(
stderr(),
cursor::MoveToColumn(0),
terminal::Clear(ClearType::CurrentLine),
Print(dots.next().unwrap())
)?;
interval.tick().await;
}
execute!(
stderr(),
terminal::Clear(ClearType::CurrentLine),
cursor::RestorePosition,
cursor::Show,
)?;
terminal::disable_raw_mode()?;
Ok(())
}
}
pub fn print_error(text: &str) -> Result<()> {
Term::new().print_error(text)
}
|
