cargo_hakari/
output.rs

1// Copyright (c) The cargo-guppy Contributors
2// SPDX-License-Identifier: MIT OR Apache-2.0
3
4use clap::{Parser, ValueEnum};
5use env_logger::fmt::Formatter;
6use log::{Level, LevelFilter, Record};
7use owo_colors::{OwoColorize, Stream, Style};
8use std::{io::Write, sync::Arc};
9
10#[derive(Debug, Parser)]
11#[must_use]
12pub(crate) struct OutputOpts {
13    /// Suppress output
14    #[clap(
15        name = "outputquiet",
16        global = true,
17        long = "quiet",
18        short = 'q',
19        conflicts_with = "outputverbose"
20    )]
21    pub(crate) quiet: bool,
22    /// Produce extra output
23    #[clap(
24        name = "outputverbose",
25        global = true,
26        long = "verbose",
27        short = 'v',
28        conflicts_with = "outputquiet"
29    )]
30    pub(crate) verbose: bool,
31
32    /// Produce color output
33    #[clap(
34        long,
35        value_enum,
36        global = true,
37        default_value_t = Color::Auto,
38    )]
39    pub(crate) color: Color,
40}
41
42impl OutputOpts {
43    pub(crate) fn init(self) -> OutputContext {
44        let OutputOpts {
45            quiet,
46            verbose,
47            color,
48        } = self;
49        let level = if quiet {
50            LevelFilter::Error
51        } else if verbose {
52            LevelFilter::Debug
53        } else {
54            LevelFilter::Info
55        };
56
57        color.init_colored();
58
59        let mut styles = Styles::default();
60        if stderr_supports_color() {
61            styles.colorize();
62        }
63
64        env_logger::Builder::from_default_env()
65            .filter_level(level)
66            .format(format_fn)
67            .init();
68
69        OutputContext {
70            quiet,
71            verbose,
72            color,
73            styles: Arc::new(styles),
74        }
75    }
76}
77
78#[derive(Clone, Debug)]
79#[must_use]
80pub(crate) struct OutputContext {
81    pub(crate) quiet: bool,
82    pub(crate) verbose: bool,
83    pub(crate) color: Color,
84    pub(crate) styles: Arc<Styles>,
85}
86
87fn format_fn(f: &mut Formatter, record: &Record<'_>) -> std::io::Result<()> {
88    match record.level() {
89        Level::Error => writeln!(
90            f,
91            "{} {}",
92            "error:".if_supports_color(Stream::Stderr, |s| s.style(Style::new().bold().red())),
93            record.args()
94        ),
95        Level::Warn => writeln!(
96            f,
97            "{} {}",
98            "warning:".if_supports_color(Stream::Stderr, |s| s.style(Style::new().bold().yellow())),
99            record.args()
100        ),
101        Level::Info => writeln!(
102            f,
103            "{} {}",
104            "info:".if_supports_color(Stream::Stderr, |s| s.bold()),
105            record.args()
106        ),
107        Level::Debug => writeln!(
108            f,
109            "{} {}",
110            "debug:".if_supports_color(Stream::Stderr, |s| s.bold()),
111            record.args()
112        ),
113        _other => Ok(()),
114    }
115}
116
117fn stderr_supports_color() -> bool {
118    match supports_color::on_cached(Stream::Stderr) {
119        Some(level) => level.has_basic,
120        None => false,
121    }
122}
123
124#[derive(Copy, Clone, Debug, PartialEq, Eq, ValueEnum)]
125#[must_use]
126pub enum Color {
127    Auto,
128    Always,
129    Never,
130}
131
132impl Color {
133    fn init_colored(self) {
134        match self {
135            Color::Auto => owo_colors::unset_override(),
136            Color::Always => owo_colors::set_override(true),
137            Color::Never => owo_colors::set_override(false),
138        }
139    }
140
141    pub(crate) fn is_enabled(self) -> bool {
142        match self {
143            // Currently, all output from cargo-hakari goes to stderr.
144            Color::Auto => stderr_supports_color(),
145            Color::Always => true,
146            Color::Never => false,
147        }
148    }
149
150    pub(crate) fn to_arg(self) -> &'static str {
151        match self {
152            Color::Auto => "--color=auto",
153            Color::Always => "--color=always",
154            Color::Never => "--color=never",
155        }
156    }
157}
158
159impl std::str::FromStr for Color {
160    type Err = String;
161
162    fn from_str(s: &str) -> Result<Self, Self::Err> {
163        match s {
164            "auto" => Ok(Color::Auto),
165            "always" => Ok(Color::Always),
166            "never" => Ok(Color::Never),
167            s => Err(format!(
168                "{} is not a valid option, expected `auto`, `always` or `never`",
169                s
170            )),
171        }
172    }
173}
174
175#[derive(Clone, Debug, Default)]
176pub(crate) struct Styles {
177    pub(crate) config_path: Style,
178    pub(crate) command: Style,
179    pub(crate) registry_url: Style,
180    pub(crate) package_name: Style,
181    pub(crate) package_version: Style,
182}
183
184impl Styles {
185    fn colorize(&mut self) {
186        self.config_path = Style::new().blue().bold();
187        self.command = Style::new().bold();
188        self.registry_url = Style::new().magenta().bold();
189        self.package_name = Style::new().bold();
190        self.package_version = Style::new().bold();
191    }
192}
cargo_hakari/output.rs

cargo_hakari/
output.rs
