Skip to main content

cargo_release/ops/
shell.rs

1use std::io::{Write, stdin, stdout};
2
3use anyhow::Context as _;
4use clap::builder::styling::Style;
5use clap_cargo::style::HEADER;
6
7use crate::error::CargoResult;
8
9pub fn confirm(prompt: &str) -> bool {
10    let mut input = String::new();
11
12    console_println(&format!("{prompt} [y/N] "), Style::new());
13
14    stdout().flush().unwrap();
15    stdin().read_line(&mut input).expect("y/n required");
16
17    input.trim().to_lowercase() == "y"
18}
19
20fn console_println(text: &str, style: Style) {
21    let _ = writeln!(anstream::stdout(), "{style}{text}{style:#}");
22}
23
24/// Print a message with a colored title in the style of Cargo shell messages.
25pub fn print(
26    status: &str,
27    message: impl std::fmt::Display,
28    style: Style,
29    justified: bool,
30) -> CargoResult<()> {
31    let mut stderr = anstream::stderr().lock();
32    if justified {
33        write!(stderr, "{style}{status:>12}{style:#}")?;
34    } else {
35        write!(stderr, "{style}{status}{style:#}:")?;
36    }
37
38    writeln!(stderr, " {message:#}").with_context(|| "Failed to write message")?;
39
40    Ok(())
41}
42
43/// Prints the passed in [`Report`][annotate_snippets::Report] to stderr
44pub fn print_report(report: annotate_snippets::Report<'_>) -> CargoResult<()> {
45    let decor_style = if cargo_term_unicode().unwrap_or_else(supports_unicode::supports_unicode) {
46        annotate_snippets::renderer::DecorStyle::Unicode
47    } else {
48        annotate_snippets::renderer::DecorStyle::Ascii
49    };
50    let rendered = annotate_snippets::Renderer::styled()
51        .decor_style(decor_style)
52        .render(report);
53    let mut stderr = anstream::stderr().lock();
54    stderr.write_all(rendered.as_bytes())?;
55    stderr.write_all(b"\n")?;
56    Ok(())
57}
58
59fn cargo_term_unicode() -> Option<bool> {
60    std::env::var_os("CARGO_TERM_UNICODE").map(|v| v == "true")
61}
62
63/// Print a styled action message.
64pub fn status(action: &str, message: impl std::fmt::Display) -> CargoResult<()> {
65    print(action, message, HEADER, true)
66}
67
68/// Print a styled error message.
69pub fn error(message: impl std::fmt::Display) -> CargoResult<()> {
70    let report = &[annotate_snippets::Group::with_title(
71        annotate_snippets::Level::ERROR.primary_title(message.to_string()),
72    )];
73    print_report(report)
74}
75
76/// Print a styled warning message.
77pub fn warn(message: impl std::fmt::Display) -> CargoResult<()> {
78    let report = &[annotate_snippets::Group::with_title(
79        annotate_snippets::Level::WARNING.primary_title(message.to_string()),
80    )];
81    print_report(report)
82}
83
84pub fn note(message: impl std::fmt::Display) -> CargoResult<()> {
85    let report = &[annotate_snippets::Group::with_title(
86        annotate_snippets::Level::NOTE.secondary_title(message.to_string()),
87    )];
88    print_report(report)
89}
90
91pub fn help(message: impl std::fmt::Display) -> CargoResult<()> {
92    let report = &[annotate_snippets::Group::with_title(
93        annotate_snippets::Level::HELP.secondary_title(message.to_string()),
94    )];
95    print_report(report)
96}
97
98pub fn level(level: log::Level) -> Option<annotate_snippets::Level<'static>> {
99    match level {
100        log::Level::Error => Some(annotate_snippets::Level::ERROR),
101        log::Level::Warn => Some(annotate_snippets::Level::WARNING),
102        log::Level::Info => Some(annotate_snippets::Level::NOTE),
103        _ => None,
104    }
105}
106
107pub fn log(level: log::Level, message: impl std::fmt::Display) -> CargoResult<()> {
108    match level {
109        log::Level::Error => error(message),
110        log::Level::Warn => warn(message),
111        log::Level::Info => note(message),
112        _ => {
113            log::log!(level, "{message}");
114            Ok(())
115        }
116    }
117}
118
119/// Print a part of a line with formatting
120pub fn write_stderr(fragment: impl std::fmt::Display, style: &Style) -> CargoResult<()> {
121    write!(anstream::stderr(), "{style}{fragment}{style:#}")?;
122    Ok(())
123}