alp-cli 0.1.6

The native `alp` CLI for ALP SDK embedded projects: board.yaml validate/generate, project scaffolding, toolchain bootstrap, and west build/flash with a stable JSON envelope.
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

// SPDX-License-Identifier: Apache-2.0
//! Spinners for captured, latency-bound commands (`sdk list` HTTP fetch,
//! `sdk install` git clone). Pure presentation, drawn to stderr — it never
//! touches the JSON envelope on stdout.
//!
//! A spinner is shown only in genuine interactive use: a TTY with none of
//! `--format json` / `--quiet` / `--ci` / `--non-interactive`. In every other
//! case (piped output, JSON, CI, the VS Code extension) it resolves to a hidden
//! bar that draws nothing — so logs and the byte-for-byte JSON output stay clean.

use std::io::IsTerminal;
use std::time::Duration;

use indicatif::{ProgressBar, ProgressStyle};

use crate::cli::GlobalArgs;

/// A steady-ticking spinner, or a hidden no-op bar when output isn't an
/// interactive terminal. Call `finish_and_clear()` when the work completes.
pub fn spinner(g: &GlobalArgs, message: &str) -> ProgressBar {
    let interactive =
        !g.is_json() && !g.quiet && !g.ci && !g.non_interactive && std::io::stderr().is_terminal();
    if !interactive {
        return ProgressBar::hidden();
    }

    let pb = ProgressBar::new_spinner();
    // A braille spinner + message; template is static so `with_template` can't fail.
    if let Ok(style) = ProgressStyle::with_template("{spinner:.cyan} {msg}") {
        pb.set_style(style.tick_strings(&["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏", ""]));
    }
    pb.enable_steady_tick(Duration::from_millis(80));
    pb.set_message(message.to_string());
    pb
}

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

    fn args(format: Format, quiet: bool, ci: bool, non_interactive: bool) -> GlobalArgs {
        GlobalArgs {
            project: None,
            board_yaml: None,
            sdk_root: None,
            target: None,
            all: false,
            format,
            verbose: false,
            quiet,
            no_color: false,
            non_interactive,
            ci,
        }
    }

    #[test]
    fn hidden_in_json_quiet_ci_and_non_interactive() {
        // JSON, --quiet, --ci, and --non-interactive each force a hidden bar,
        // regardless of TTY. (Under `cargo test` stderr is non-TTY anyway, so
        // the interactive branch is never taken here either.)
        assert!(spinner(&args(Format::Json, false, false, false), "x").is_hidden());
        assert!(spinner(&args(Format::Text, true, false, false), "x").is_hidden());
        assert!(spinner(&args(Format::Text, false, true, false), "x").is_hidden());
        assert!(spinner(&args(Format::Text, false, false, true), "x").is_hidden());
    }
}