chant 0.1.1

Shell glamour - beautiful prompts and output for scripts 🪄
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
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

//! Spinner command.

use glyphs::{style, Color};
use scoria::{Spinner, SpinnerStyle};
use std::io::{stdout, Write};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use std::thread;
use std::time::Duration;

/// Create a spinner.
pub fn spin(title: impl Into<String>) -> Spin {
    Spin::new(title)
}

/// Spinner builder.
pub struct Spin {
    title: String,
    spinner_style: SpinnerStyle,
    color: Option<Color>,
}

impl Spin {
    /// Create a new spinner.
    pub fn new(title: impl Into<String>) -> Self {
        Self {
            title: title.into(),
            spinner_style: SpinnerStyle::Dots,
            color: Some(Color::Cyan),
        }
    }

    /// Set spinner style.
    #[must_use]
    pub fn style(mut self, style: SpinnerStyle) -> Self {
        self.spinner_style = style;
        self
    }

    /// Set spinner color.
    #[must_use]
    pub fn color(mut self, color: Color) -> Self {
        self.color = Some(color);
        self
    }

    /// Run with a closure and show spinner until complete.
    pub fn run<F, T>(self, f: F) -> T
    where
        F: FnOnce() -> T,
    {
        let running = Arc::new(AtomicBool::new(true));
        let running_clone = running.clone();

        let title = self.title.clone();
        let spinner_style = self.spinner_style;
        let color = self.color;

        // Spawn spinner thread
        let spinner_thread = thread::spawn(move || {
            let mut spinner = Spinner::new(spinner_style);
            if let Some(c) = color {
                spinner = spinner.color(c);
            }
            spinner = spinner.title(&title);

            let mut stdout = stdout();

            while running_clone.load(Ordering::Relaxed) {
                print!("\r{}", spinner.view());
                stdout.flush().ok();
                spinner.tick();
                thread::sleep(Duration::from_millis(spinner.interval_ms()));
            }

            // Clear spinner line
            print!("\r{}\r", " ".repeat(title.len() + 10));
            stdout.flush().ok();
        });

        // Run the actual work
        let result = f();

        // Stop spinner
        running.store(false, Ordering::Relaxed);
        spinner_thread.join().ok();

        // Print completion
        println!(
            "{} {}",
            style("✓").fg(Color::Green),
            style(&self.title).dim()
        );

        result
    }

    /// Run with a result and show success/failure.
    pub fn run_result<F, T, E>(self, f: F) -> Result<T, E>
    where
        F: FnOnce() -> Result<T, E>,
    {
        let running = Arc::new(AtomicBool::new(true));
        let running_clone = running.clone();

        let title = self.title.clone();
        let spinner_style = self.spinner_style;
        let color = self.color;

        // Spawn spinner thread
        let spinner_thread = thread::spawn(move || {
            let mut spinner = Spinner::new(spinner_style);
            if let Some(c) = color {
                spinner = spinner.color(c);
            }
            spinner = spinner.title(&title);

            let mut stdout = stdout();

            while running_clone.load(Ordering::Relaxed) {
                print!("\r{}", spinner.view());
                stdout.flush().ok();
                spinner.tick();
                thread::sleep(Duration::from_millis(spinner.interval_ms()));
            }

            // Clear spinner line
            print!("\r{}\r", " ".repeat(title.len() + 10));
            stdout.flush().ok();
        });

        // Run the actual work
        let result = f();

        // Stop spinner
        running.store(false, Ordering::Relaxed);
        spinner_thread.join().ok();

        // Print completion
        match &result {
            Ok(_) => {
                println!(
                    "{} {}",
                    style("✓").fg(Color::Green),
                    style(&self.title).dim()
                );
            }
            Err(_) => {
                println!(
                    "{} {}",
                    style("✗").fg(Color::Red),
                    style(&self.title).dim()
                );
            }
        }

        result
    }
}