32805c2 just: Introduce commit-msg hook for typos — heartwood

Radicle Heartwood Protocol & Stack

just: Introduce commit-msg hook for typos

Adrian Duke committed 22 days ago

commit 32805c26df334a46f05dd0ddfd0ba8e1e1dd5fe3
parent 114992ca64d9cab627d898f99444f6877f7ff4a4

2 files changed +26 -5

modified justfile

@@ -1,4 +1,4 @@

 hooks := "pre-commit pre-push post-checkout"
 hooks := "pre-commit pre-push post-checkout commit-msg"
 hook-script := "scripts/git-hook-template.sh"
 WARN := "⚠️ " + YELLOW + BOLD

@@ -14,6 +14,22 @@ default: check-hooks

 [group('hooks')]
 post-checkout:
 # Run commit-msg checks
 [group('hooks')]
 commit-msg file: (verify-tool "typos" "typos-cli")
     @echo "{{CHECK}}Checking commit message for typos...{{NORMAL}}"
     @while ! typos "{{file}}"; do \
         exec < /dev/tty; \
         echo ""; \
         printf "{{WARN}}Typos found.{{NORMAL}} (e)dit, (c)ontinue, or (a)bort? [E/c/a] "; \
         read -r response; \
         case "$response" in \
             [cC]*) exit 0 ;; \
             [aA]*) exit 1 ;; \
             *) ${EDITOR:-vi} "{{file}}" ;; \
         esac; \
     done
 # Run pre-commit checks
 [group('hooks')]
 pre-commit: format-rust check-rust check-docs check-typos check-spelling check-scripts check-keywords format-nix

@@ -66,8 +82,8 @@ check-spelling: (verify-tool "codespell")

     @echo "{{CHECK}}Checking for code typos...{{NORMAL}}"
     @git ls-files -z | xargs -0 codespell --write-changes --check-filenames
 # just runs with `/bin/sh` which has no doublestar glob
 # expansion, furthermore, `time ls **/*.sh` takes ~5s
 # just runs with `/bin/sh` which has no doublestar glob
 # expansion, furthermore, `time ls **/*.sh` takes ~5s
 # locally. The `find` solution below is fastest ~900ms.
 #
 # Run shellcheck on all shell scripts

modified scripts/git-hook-template.sh

@@ -3,7 +3,7 @@ set -euo pipefail

 readonly HOOK="${HOOK:-$(basename "$0")}"
 if ! [[ "$HOOK" =~ ^(pre-(commit|push)|post-checkout)$ ]]
 if ! [[ "$HOOK" =~ ^(pre-(commit|push)|post-checkout|commit-msg)$ ]]
 then
     echo "Unknown hook '${HOOK}'."
     exit 1

@@ -42,4 +42,9 @@ then

 fi
 # Execute the appropriate just recipe based on the hook name.
 just "$HOOK"
 if [ "$HOOK" = "commit-msg" ]
 then
     just "$HOOK" "$1"
 else
     just "$HOOK"
 fi