Add a basic noise level implementation.

This commit is contained in:
Bauke 2024-01-18 13:52:15 +01:00
parent f0030fd57f
commit 0634e86b3d
Signed by: Bauke
GPG Key ID: C1C0F29952BCF558
3 changed files with 117 additions and 29 deletions

View File

@ -5,34 +5,29 @@ use std::{io::Read, process::exit};
use { use {
color_eyre::{eyre::eyre, Result}, color_eyre::{eyre::eyre, Result},
hooked_config::{Config, ExitAction}, hooked_config::{Config, ExitAction},
owo_colors::{OwoColorize, Style}, owo_colors::OwoColorize,
subprocess::{Exec, Redirection}, subprocess::{Exec, Redirection},
supports_color::Stream,
}; };
use crate::utilities::{globset_from_strings, plural}; use crate::{
printer::{print, PrintType, PRINT_STYLE},
utilities::{globset_from_strings, plural},
};
/// The `run` subcommand. /// The `run` subcommand.
pub fn hooked_run(config: Config, hook_type: String) -> Result<()> { pub fn hooked_run(config: Config, hook_type: String) -> Result<()> {
let (success_style, warn_style, error_style, skipped_style) = let global_noise_level = &config.general.noise_level;
if let Some(_support) = supports_color::on(Stream::Stdout) {
let shared_style = Style::new().bold();
(
shared_style.green(),
shared_style.yellow(),
shared_style.red(),
shared_style.blue(),
)
} else {
(Style::new(), Style::new(), Style::new(), Style::new())
};
if hook_type == "pre-commit" { if hook_type == "pre-commit" {
let hook_count = config.pre_commit.len(); let hook_count = config.pre_commit.len();
println!( print(
"Hooked: Running {} pre-commit {}.", format!(
hook_count, "Hooked: Running {} pre-commit {}.",
plural(hook_count, "hook", None) hook_count,
plural(hook_count, "hook", None)
),
&config.general.noise_level,
PrintType::Info,
); );
'hook_loop: for hook in config.pre_commit { 'hook_loop: for hook in config.pre_commit {
@ -46,10 +41,14 @@ pub fn hooked_run(config: Config, hook_type: String) -> Result<()> {
.capture()? .capture()?
.stdout_str(); .stdout_str();
if !staged_files.lines().any(|line| globs.is_match(line)) { if !staged_files.lines().any(|line| globs.is_match(line)) {
println!( print(
"\t{} {}", format!(
"".style(skipped_style), "\t{} {}",
hook_name.style(skipped_style) "".style(PRINT_STYLE.skipped),
hook_name.style(PRINT_STYLE.skipped)
),
global_noise_level,
PrintType::Info,
); );
continue 'hook_loop; continue 'hook_loop;
} }
@ -84,16 +83,28 @@ pub fn hooked_run(config: Config, hook_type: String) -> Result<()> {
output output
}; };
let (stop, print_output, prefix, style) = let (stop, print_output, prefix, style, print_type) =
match (exit_status.success(), hook.on_failure) { match (exit_status.success(), hook.on_failure) {
(true, _) => (false, false, "", success_style), (true, _) => {
(false, ExitAction::Continue) => (false, true, "", warn_style), (false, false, "", PRINT_STYLE.success, PrintType::Info)
(false, ExitAction::Stop) => (true, true, "", error_style), }
(false, ExitAction::Continue) => {
(false, true, "", PRINT_STYLE.warn, PrintType::Warn)
}
(false, ExitAction::Stop) => {
(true, true, "", PRINT_STYLE.error, PrintType::Error)
}
}; };
println!("\t{} {}", prefix.style(style), hook_name.style(style)); let hook_noise_level =
hook.noise_level.as_ref().unwrap_or(global_noise_level);
print(
format!("\t{} {}", prefix.style(style), hook_name.style(style)),
hook_noise_level,
print_type,
);
if !output.is_empty() && print_output { if !output.is_empty() && print_output {
println!("{}", output); print(output, hook_noise_level, PrintType::Info);
} }
if stop { if stop {

View File

@ -17,6 +17,7 @@ pub const DEFAULT_TEMPLATE: &str = include_str!("templates/default.sh");
pub const HOOK_TYPES: [&str; 1] = ["pre-commit"]; pub const HOOK_TYPES: [&str; 1] = ["pre-commit"];
mod cli; mod cli;
mod printer;
mod utilities; mod utilities;
fn main() -> Result<()> { fn main() -> Result<()> {

View File

@ -0,0 +1,76 @@
//! Shared logic for printing output to the terminal.
use {
hooked_config::NoiseLevel, lazy_static::lazy_static, owo_colors::Style,
std::fmt::Display, supports_color::Stream,
};
/// The available types to print output as.
#[derive(Debug, Eq, PartialEq)]
pub enum PrintType {
/// Print the output as an error line.
Error,
/// Print the output as a warning line.
Warn,
/// Print the output as an information line.
Info,
}
/// The available print styles for colorized output.
#[derive(Debug)]
pub struct PrintStyles {
/// The style for errored hooks output.
pub error: Style,
/// The style for skipped hooks output.
pub skipped: Style,
/// The style for succesful hooks output.
pub success: Style,
/// The style for hooks with warnings.
pub warn: Style,
}
lazy_static! {
pub static ref PRINT_STYLE: PrintStyles = {
let (success_style, warn_style, error_style, skipped_style) =
if let Some(_support) = supports_color::on(Stream::Stdout) {
let shared_style = Style::new().bold();
(
shared_style.green(),
shared_style.yellow(),
shared_style.red(),
shared_style.blue(),
)
} else {
(Style::new(), Style::new(), Style::new(), Style::new())
};
PrintStyles {
error: error_style,
skipped: skipped_style,
success: success_style,
warn: warn_style,
}
};
}
/// Print something to the terminal according to a given [`NoiseLevel`] and
/// [`PrintType`].
pub fn print<D: Display>(
something: D,
noise_level: &NoiseLevel,
print_type: PrintType,
) {
let should_print = match (noise_level, print_type) {
// Only output errors under the quiet noise level.
(NoiseLevel::Quiet, PrintType::Error) => true,
(NoiseLevel::Quiet, _) => false,
// Output everything under loud.
(NoiseLevel::Loud | NoiseLevel::Standard | NoiseLevel::Minimal, _) => true,
};
if !should_print {
return;
}
println!("{something}")
}