Add a noise level configuration option.

This commit is contained in:
Bauke 2024-01-17 18:43:17 +01:00
parent ba6d4fb0d1
commit 260bcb7ca5
Signed by: Bauke
GPG Key ID: C1C0F29952BCF558
9 changed files with 51 additions and 2 deletions

View File

@ -4,6 +4,8 @@ use std::path::PathBuf;
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use crate::NoiseLevel;
/// General Hooked configuration. /// General Hooked configuration.
#[derive(Debug, Deserialize, Serialize)] #[derive(Debug, Deserialize, Serialize)]
#[serde(default, deny_unknown_fields)] #[serde(default, deny_unknown_fields)]
@ -14,6 +16,9 @@ pub struct General {
/// The directory to use for hooks. /// The directory to use for hooks.
pub directory: PathBuf, pub directory: PathBuf,
/// The noise level tasks should output logs with by default.
pub noise_level: NoiseLevel,
/// Path to a script template for use with the install subcommand. /// Path to a script template for use with the install subcommand.
pub template: Option<PathBuf>, pub template: Option<PathBuf>,
} }
@ -23,6 +28,7 @@ impl Default for General {
Self { Self {
config: PathBuf::from("Hooked.toml"), config: PathBuf::from("Hooked.toml"),
directory: PathBuf::from("hooks"), directory: PathBuf::from("hooks"),
noise_level: NoiseLevel::default(),
template: None, template: None,
} }
} }

View File

@ -9,11 +9,13 @@ use {
mod exit_action; mod exit_action;
mod general; mod general;
mod noise_level;
mod pre_commit; mod pre_commit;
mod task; mod task;
pub use exit_action::*; pub use exit_action::*;
pub use general::*; pub use general::*;
pub use noise_level::*;
pub use pre_commit::*; pub use pre_commit::*;
pub use task::*; pub use task::*;

View File

@ -0,0 +1,24 @@
//! The noise level Hooked should output logs with.
use serde::{Deserialize, Serialize};
/// The noise level Hooked should output logs with.
#[derive(Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum NoiseLevel {
/// Output only errors.
Quiet,
/// Output everything.
Loud,
/// Print a list of tasks and output warnings and errors, this is the default.
Standard,
/// The same as [`NoiseLevel::Standard`] except don't output task names or
/// warnings.
Minimal,
}
impl Default for NoiseLevel {
fn default() -> Self {
Self::Standard
}
}

View File

@ -2,7 +2,7 @@
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use crate::{ExitAction, Task}; use crate::{ExitAction, NoiseLevel, Task};
/// A pre-commit hook. /// A pre-commit hook.
#[derive(Debug, Deserialize, Serialize)] #[derive(Debug, Deserialize, Serialize)]
@ -11,6 +11,10 @@ pub struct PreCommit {
/// Display name for this hook. /// Display name for this hook.
pub name: Option<String>, pub name: Option<String>,
/// The noise level this task should output with.
#[serde(default)]
pub noise_level: NoiseLevel,
/// What to do when the hook exits with a non-zero status code. /// What to do when the hook exits with a non-zero status code.
#[serde(default)] #[serde(default)]
pub on_failure: ExitAction, pub on_failure: ExitAction,

View File

@ -1,14 +1,17 @@
[general] [general]
directory = "hooked" directory = "hooked"
noise_level = "minimal"
template = "test.sh" template = "test.sh"
[[pre_commit]] [[pre_commit]]
name = "Pre Commit 1" name = "Pre Commit 1"
noise_level = "quiet"
command = "exit 0" command = "exit 0"
staged = ["*.txt"] staged = ["*.txt"]
on_failure = "continue" on_failure = "continue"
[[pre_commit]] [[pre_commit]]
name = "Pre Commit 2" name = "Pre Commit 2"
noise_level = "loud"
script = "test.sh" script = "test.sh"
on_failure = "stop" on_failure = "stop"

View File

@ -1,5 +1,5 @@
use { use {
hooked_config::{Config, ExitAction, PreCommit, Task}, hooked_config::{Config, ExitAction, NoiseLevel, PreCommit, Task},
toml::to_string_pretty, toml::to_string_pretty,
}; };
@ -9,6 +9,7 @@ use insta::assert_snapshot;
fn test_serialize() { fn test_serialize() {
let pre_commit_command = PreCommit { let pre_commit_command = PreCommit {
name: Some("Command Test".to_string()), name: Some("Command Test".to_string()),
noise_level: NoiseLevel::Quiet,
on_failure: ExitAction::Continue, on_failure: ExitAction::Continue,
staged: vec!["*.txt".to_string()], staged: vec!["*.txt".to_string()],
task: Task { task: Task {
@ -19,6 +20,7 @@ fn test_serialize() {
let pre_commit_script = PreCommit { let pre_commit_script = PreCommit {
name: Some("Script Test".to_string()), name: Some("Script Test".to_string()),
noise_level: NoiseLevel::Loud,
on_failure: ExitAction::Stop, on_failure: ExitAction::Stop,
staged: vec![], staged: vec![],
task: Task { task: Task {

View File

@ -6,11 +6,13 @@ Config {
general: General { general: General {
config: "Hooked.toml", config: "Hooked.toml",
directory: "hooks", directory: "hooks",
noise_level: Standard,
template: None, template: None,
}, },
pre_commit: [ pre_commit: [
PreCommit { PreCommit {
name: None, name: None,
noise_level: Standard,
on_failure: Stop, on_failure: Stop,
staged: [], staged: [],
task: Task { task: Task {

View File

@ -6,6 +6,7 @@ Config {
general: General { general: General {
config: "Hooked.toml", config: "Hooked.toml",
directory: "hooked", directory: "hooked",
noise_level: Minimal,
template: Some( template: Some(
"test.sh", "test.sh",
), ),
@ -15,6 +16,7 @@ Config {
name: Some( name: Some(
"Pre Commit 1", "Pre Commit 1",
), ),
noise_level: Quiet,
on_failure: Continue, on_failure: Continue,
staged: [ staged: [
"*.txt", "*.txt",
@ -30,6 +32,7 @@ Config {
name: Some( name: Some(
"Pre Commit 2", "Pre Commit 2",
), ),
noise_level: Loud,
on_failure: Stop, on_failure: Stop,
staged: [], staged: [],
task: Task { task: Task {

View File

@ -5,15 +5,18 @@ expression: to_string_pretty(&config).unwrap()
[general] [general]
config = 'Hooked.toml' config = 'Hooked.toml'
directory = 'hooks' directory = 'hooks'
noise_level = 'standard'
[[pre_commit]] [[pre_commit]]
name = 'Command Test' name = 'Command Test'
noise_level = 'quiet'
on_failure = 'continue' on_failure = 'continue'
staged = ['*.txt'] staged = ['*.txt']
command = 'exit 0' command = 'exit 0'
[[pre_commit]] [[pre_commit]]
name = 'Script Test' name = 'Script Test'
noise_level = 'loud'
on_failure = 'stop' on_failure = 'stop'
staged = [] staged = []
script = 'test.sh' script = 'test.sh'