shellshot 0.5.0

Transform your command-line output into clean, shareable images with a single command.
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

use std::time::Duration;

use indicatif::{ProgressBar, ProgressStyle};
use termwiz::escape::Action;

use crate::terminal_builder::TerminalBuilderError;

pub struct TerminalBuilderProgressBar {
    pub progress_bar: Option<ProgressBar>,
}

impl TerminalBuilderProgressBar {
    pub fn new(quiet: bool) -> Result<Self, TerminalBuilderError> {
        let progress_bar = if quiet {
            None
        } else {
            let pb = ProgressBar::new_spinner();
            pb.set_style(ProgressStyle::default_spinner().template("{spinner} Parsing: {msg}")?);
            pb.enable_steady_tick(Duration::from_millis(80));
            Some(pb)
        };
        Ok(Self { progress_bar })
    }

    pub fn update_progress(&self, action: &Action) {
        let Some(pb) = &self.progress_bar else {
            return;
        };

        match action {
            Action::PrintString(_) | Action::Print(_) => {
                pb.set_message(action.to_string());
            }
            _ => {}
        }
    }

    pub fn finish(&self) {
        let Some(pb) = &self.progress_bar else {
            return;
        };

        pb.finish_and_clear();
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use termwiz::escape::{Action, ControlCode};

    #[test]
    fn new_quiet_true_creates_no_progress_bar() {
        let pb = TerminalBuilderProgressBar::new(true).unwrap();
        assert!(pb.progress_bar.is_none());
    }

    #[test]
    fn new_quiet_false_creates_progress_bar() {
        let pb = TerminalBuilderProgressBar::new(false).unwrap();
        assert!(pb.progress_bar.is_some());
    }

    #[test]
    fn update_progress_does_nothing_when_quiet() {
        let pb = TerminalBuilderProgressBar::new(true).unwrap();

        pb.update_progress(&Action::PrintString("Test Progress Bar".into()));
    }

    #[test]
    fn update_progress_updates_message_for_print_actions() {
        let pb = TerminalBuilderProgressBar::new(false).unwrap();

        let action = Action::PrintString("Test Progress Bar".into());
        pb.update_progress(&action);
    }

    #[test]
    fn update_progress_ignores_non_print_actions() {
        let pb = TerminalBuilderProgressBar::new(false).unwrap();

        let action = Action::Control(ControlCode::LineFeed);
        pb.update_progress(&action);
    }

    #[test]
    fn finish_does_nothing_when_quiet() {
        let pb = TerminalBuilderProgressBar::new(true).unwrap();
        pb.finish();
    }

    #[test]
    fn finish_clears_progress_bar() {
        let pb = TerminalBuilderProgressBar::new(false).unwrap();
        pb.finish();
    }
}