chore: manage git hooks by husky

Author: whisperpine

.husky/commit-msg

@@ -0,0 +1,41 @@
+#!/bin/sh
+
+# Purpose: check commit messages (typos and conventional commits)
+# Usage: make this script the git commit-msg hook
+# Dependencies: typos, cocogitto
+# Date: 2025-09-02
+# Author: Yusong
+
+set -e
+
+# The first argument is the path to the file containing the commit message.
+commit_msg_file="$1"
+# Read the commit message excluding comments (lines starting with #).
+commit_message=$(grep -v '^#' "$commit_msg_file")
+# Check if the commit message is empty.
+if [ -z "$commit_message" ]; then
+  # Git will handle the empty message when exiting with 0.
+  exit 0
+fi
+
+# Run typos on the commit message.
+typos_output=$(echo "$commit_message" | typos --format brief -)
+if [ -n "$typos_output" ]; then
+  echo "Error: Spelling issues found in the commit message."
+  echo "Please fix the typos or use 'git push --no-verify' to bypass."
+  echo
+  echo "Spelling issues:"
+  echo "$typos_output"
+  echo
+  echo "==================== Commit message ======================"
+  echo "$commit_message"
+  echo "==================== Commit message ======================"
+  exit 1
+fi
+
+# Check if the commit message aligns with conventional commits.
+if ! verify_message=$(cog verify "$commit_message" 2>&1); then
+  echo "Error: Commit message violates conventional commits."
+  echo "$verify_message"
+  exit 1
+fi

.husky/post-commit

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+# Purpose: check conventional commits
+# Usage: make this script the git post-commit hook
+# Dependencies: cocogitto
+# Date: 2025-09-02
+# Author: Yusong
+
+set -e
+
+# Check the latest commit message.
+if ! cog check HEAD..HEAD >/dev/null 2>&1; then
+  echo "Error: Commit message violates conventional commits."
+  cog check HEAD..HEAD
+  exit 1
+fi

.husky/pre-commit

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+# Purpose: check typos in all files excluding ./.git
+# Usage: make this script the git pre-commit hook
+# Dependencies: typos
+# Date: 2025-09-02
+# Author: Yusong
+
+set -e
+
+# Check spelling.
+typos --hidden --exclude .git --format brief

.husky/pre-push

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+# Purpose: check conventional commits for those not pushed
+# Usage: make this script the git pre-push hook
+# Dependencies: cocogitto
+# Date: 2025-09-02
+# Author: Yusong
+
+set -e
+
+# Check commit messages that haven't been pushed.
+if ! cog check origin/HEAD..HEAD >/dev/null 2>&1; then
+  echo "Error: Commit message(s) violates conventional commits."
+  cog check origin/HEAD..HEAD
+  exit 1
+fi

flake.nix

@@ -28,13 +28,19 @@
               cocogitto # conventional commit toolkit
               git-cliff # changelog generator
               trivy # scan security issues
+              husky # managing git hooks
+              typos # check misspelling
             ];
             # The shell script executed when the environment is activated.
             shellHook = /* sh */ ''
               # Print the last modified date of "flake.lock".
               git log -1 --format="%cd" --date=format:"%Y-%m-%d" -- flake.lock |
                 awk '{printf "\"flake.lock\" last modified on: %s", $1}' &&
                 echo " ($((($(date +%s) - $(git log -1 --format="%ct" -- flake.lock)) / 86400)) days ago)"
+              # Install git hooks managed by husky.
+              if [ ! -e "./.husky/_" ]; then
+                husky install
+              fi
             '';
           };
         }