Add a noise level configuration option.

.envrc

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+use flake

.gitignore

@@ -1,9 +1,5 @@
-# Generated by Cargo
+.direnv/
-debug/
-target/
-
-# Code coverage results
 coverage/
-
+debug/
-# mdBook output
 hooked-book/book/
+target/

Cargo.toml

@@ -3,3 +3,11 @@ members = [
   "hooked-cli",
   "hooked-config"
 ]
+resolver = "2"
+
+[workspace.lints.clippy]
+missing_docs_in_private_items = "warn"
+
+[workspace.lints.rust]
+missing_docs = "warn"
+unsafe_code = "forbid"

flake.lock

@@ -0,0 +1,59 @@
+{
+  "nodes": {
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1705309234,
+        "narHash": "sha256-uNRRNRKmJyCRC/8y1RqBkqWBLM034y4qN7EprSdmgyA=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "1ef2e671c3b0c19053962c07dbda38332dcebf26",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1705403940,
+        "narHash": "sha256-bl7E3w35Bleiexg01WsN0RuAQEL23HaQeNBC2zjt+9w=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "f0326542989e1bdac955ad6269b334a8da4b0c95",
+        "type": "github"
+      },
+      "original": {
+        "id": "nixpkgs",
+        "type": "indirect"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

flake.nix

@@ -0,0 +1,13 @@
+{
+  inputs.flake-utils.url = "github:numtide/flake-utils";
+
+  outputs = { self, nixpkgs, flake-utils }:
+    flake-utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = nixpkgs.legacyPackages.${system};
+      in
+      {
+        devShells.default = import ./shell.nix { inherit pkgs; };
+      }
+    );
+}

hooked-cli/Cargo.toml

@@ -14,6 +14,9 @@ edition = "2021"
 name = "hooked"
 path = "source/main.rs"
 
+[lints]
+workspace = true
+
 [dependencies]
 color-eyre = "0.6.2"
 globset = "0.4.9"

hooked-cli/source/cli/cli_reference.rs

@@ -31,7 +31,7 @@ pub fn hooked_cli_reference(
     for command_name in commands_to_document {
       let output = Command::new("cargo")
         .env("NO_COLOR", "1")
-        .args(&["run", "-q", "--", command_name, "--help"])
+        .args(["run", "-q", "--", command_name, "--help"])
         .output()
         .unwrap();
       let usage = str::from_utf8(&output.stdout).unwrap().trim().to_string();
@@ -44,7 +44,7 @@ pub fn hooked_cli_reference(
   let mut context = Context::new();
   context.insert("commands", &commands);
   write(
-    &out_path,
+    out_path,
     Tera::one_off(REFERENCE_TEMPLATE, &context, false)?,
   )?;
 

hooked-cli/source/main.rs

@@ -2,9 +2,6 @@
 //!
 //! > **Git hooks manager.**
 
-#![forbid(unsafe_code)]
-#![warn(missing_docs, clippy::missing_docs_in_private_items)]
-
 use {
   clap::Parser,
   color_eyre::{install, Result},

hooked-cli/source/utilities/mod.rs

@@ -20,7 +20,7 @@ pub fn plural(count: usize, singular: &str, plural: Option<&str>) -> String {
 pub fn globset_from_strings(input: &[String]) -> Result<GlobSet> {
   let mut builder = GlobSetBuilder::new();
   for glob in input {
-    builder.add(Glob::new(&glob)?);
+    builder.add(Glob::new(glob)?);
   }
 
   builder.build().map_err(Into::into)

hooked-config/Cargo.toml

@@ -13,6 +13,9 @@ edition = "2021"
 [lib]
 path = "source/lib.rs"
 
+[lints]
+workspace = true
+
 [dependencies]
 color-eyre = "0.6.2"
 toml = "0.5.9"

hooked-config/source/config/exit_action.rs

@@ -6,7 +6,9 @@ use serde::{Deserialize, Serialize};
 #[derive(Debug, Deserialize, Eq, PartialEq, Serialize)]
 #[serde(rename_all = "snake_case")]
 pub enum ExitAction {
+  /// Regardless of the hook's exit code, allow Hooked to continue.
   Continue,
+  /// Stop on a non-zero hook exit code.
   Stop,
 }
 

hooked-config/source/config/general.rs

@@ -4,6 +4,8 @@ use std::path::PathBuf;
 
 use serde::{Deserialize, Serialize};
 
+use crate::NoiseLevel;
+
 /// General Hooked configuration.
 #[derive(Debug, Deserialize, Serialize)]
 #[serde(default, deny_unknown_fields)]
@@ -14,6 +16,9 @@ pub struct General {
   /// The directory to use for hooks.
   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.
   pub template: Option<PathBuf>,
 }
@@ -23,6 +28,7 @@ impl Default for General {
     Self {
       config: PathBuf::from("Hooked.toml"),
       directory: PathBuf::from("hooks"),
+      noise_level: NoiseLevel::default(),
       template: None,
     }
   }

hooked-config/source/config/mod.rs

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

hooked-config/source/config/noise_level.rs

@@ -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
+  }
+}

hooked-config/source/config/pre_commit.rs

@@ -2,7 +2,7 @@
 
 use serde::{Deserialize, Serialize};
 
-use crate::{ExitAction, Task};
+use crate::{ExitAction, NoiseLevel, Task};
 
 /// A pre-commit hook.
 #[derive(Debug, Deserialize, Serialize)]
@@ -11,6 +11,10 @@ pub struct PreCommit {
   /// Display name for this hook.
   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.
   #[serde(default)]
   pub on_failure: ExitAction,

hooked-config/tests/parsing/with-hooks.toml

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

hooked-config/tests/serialize.rs

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

hooked-config/tests/snapshots/parsing__defaults.snap

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

hooked-config/tests/snapshots/parsing__with-hooks.snap

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

hooked-config/tests/snapshots/serialize__serialize.snap

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

shell.nix

@@ -0,0 +1,7 @@
+{ pkgs ? import <nixpkgs> { } }:
+
+with pkgs;
+
+mkShell rec {
+  packages = [ cargo-make mdbook mdbook-linkcheck ];
+}