Merge pull request #38 from George-Ogden/spell-check

Spell Check Commit Messages

Author: George-Ogden

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-default_stages: ["pre-commit", "commit-msg", "pre-push"]
+default_stages: ["pre-commit"]
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks

.pre-commit-hooks.yaml

@@ -1,31 +1,43 @@
 - id: dbg-check
-  name: Ensure no `dbg` statements, macros or expressions included in source files.
+  name: Check for `dbg`
+  description: Ensure no `dbg` statements, macros or expressions included in source files.
   entry: ./validate-dbg.sh
   language: script
   types: [text]
 
 - id: pragma-once
-  name: Ensure all header files have `#pragma once` before any other imports.
+  name: Check for `#pragma once`
+  description: Ensure all header files have `#pragma once` before any other imports.
   entry: ./validate-pragma.sh
   language: script
   types_or: [c++, file]
   files: \.(hpp|h\+\+|hxx|cuh)$
 
 - id: check-merge-conflict
-  name: Check for merge-conflicts.
+  name: Check for merge conflicts
+  description: Check for merge-conflicts.
   entry: ./validate-merge-conflict.sh
   language: script
   types: [file]
 
 - id: mypy
-  name: MyPy
+  name: Run MyPy
+  description: MyPy
   entry: ./run-mypy.sh
   language: script
   types: [python]
 
 - id: todo-check
-  name: Check for 'todo' or 'fixme' left in source files.
+  name: Check for `todo`s
+  description: Check for 'todo' or 'fixme' left in source files.
   entry: ./validate-todo.sh
   language: script
   types: [text]
   exclude: ^\.
+
+- id: spell-check-commit-msgs
+  name: Spell check commit message
+  description: Check for spelling errors in commit messages.
+  entry: ./run-spell-check.sh
+  language: script
+  stages: [commit-msg]

README.md

@@ -12,11 +12,12 @@ It may work with other Python versions or operating systems (such as MacOS or WS
 
 This repository provides the following pre-commit hooks:
 
--   [dbg-check](#dbg-check) - ensure no `dbg` statements, macros or imports are included in the source code.
--   [todo-check](#todo-check) - ensure no "todo"s or "fixme"s are left in the source code.
--   [pragma-once](#pragma-once) - ensure all headers start with `#pragma once`.
--   [check-merge-conflict](#check-merge-conflict) - check for merge conflicts.
--   [mypy](#mypy) - run [MyPy](#https://github.com/python/mypy).
+- [dbg-check](#dbg-check) - ensure no `dbg` statements, macros or imports are included in the source code.
+- [todo-check](#todo-check) - ensure no "todo"s or "fixme"s are left in the source code.
+- [pragma-once](#pragma-once) - ensure all headers start with `#pragma once`.
+- [check-merge-conflict](#check-merge-conflict) - check for merge conflicts.
+- [mypy](#mypy) - run [MyPy](#https://github.com/python/mypy).
+- [spell-check-commit-msgs](#spell-check-commit-msgs) - check for spelling errors in commit messages.
 
 ### dbg-check
 
@@ -50,32 +51,43 @@ It allows you to pass in a requirements file using the `-r` or `--requirements-f
 It requires that you have `pip` installed, but if you're using pre-commit, that shouldn't be an issue.
 You can set the MyPy version in the requirements file (eg `mypy==1.17.1`), otherwise, the latest is installed.
 
+### spell-check-commit-msgs
+
+> _[If you] make spelling mistakes in commit messages, it's then a real pain to amend the commit._
+> _And god forbid if you pushed._
+
+This uses [`codespell`](https://github.com/codespell-project/codespell) under the hood, and accepts the same flags via the `args` field, but interactive mode is not supported.
+`codespell` is installed via [`uv`](https://docs.astral.sh/uv/), so you need to have `pip` installed.
+You also need to ensure that you install the `commit-msg` hooks, which you can do with `pre-commit install -t pre-commit -t commit-msg` or adding `default_install_hook_types: ["pre-commit", "commit-msg"]` to the `.pre-commit-config.yaml` (like below).
+
 ## Example Use
 
 Here's a sample `.pre-commit-config.yaml`:
 
 ```yaml
-default_stages: ["pre-commit", "commit-msg", "pre-push"]
+default_stages: ["pre-commit"]
+default_install_hook_types: ["pre-commit", "commit-msg"]
 
 repos:
-    - repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v6.0.0
-      hooks:
-          - id: end-of-file-fixer
-          - id: mixed-line-ending
-          - id: trailing-whitespace
-
-    - repo: https://github.com/George-Ogden/pre-commit-hooks/
-      rev: v1.2.5
-      hooks:
-          - id: dbg-check
-            exclude: ^test/
-          - id: todo-check
-            exclude: README
-          - id: pragma-once
-          - id: check-merge-conflict
-          - id: mypy
-            args: [-r, requirements.txt, --strict]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  - repo: https://github.com/George-Ogden/pre-commit-hooks/
+    rev: v1.3.0
+    hooks:
+      - id: dbg-check
+        exclude: ^test/
+      - id: todo-check
+        exclude: README
+      - id: pragma-once
+      - id: check-merge-conflict
+      - id: mypy
+        args: [-r, requirements.txt, --strict]
+      - id: spell-check-commit-msgs
 ```
 
 ### Development

run-spell-check.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/bash
+
+set -o pipefail
+
+FILENAME="${@: -1}"
+ESCAPED_FILENAME=$(printf '%s\n' "$FILENAME" | sed -e 's/[]\/$*.^[]/\\&/g')
+
+pip install uv -qqq && uv pip install codespell -qqq --system && codespell $@ | sed -E "s,$ESCAPED_FILENAME:[[:digit:]]+,commit message error,"

tests/mypy/test_invalid_import.sh

@@ -3,5 +3,4 @@
 set -e
 DIRECTORY=$(dirname $0)
 
-
 pre-commit run --config $DIRECTORY/test_data/import_error/.pre-commit-config.yaml --files $DIRECTORY/test_data/import_error/import_error.py

tests/mypy/test_requirements_file.sh

@@ -3,5 +3,4 @@
 set -e
 DIRECTORY=$(dirname $0)
 
-
 pre-commit run --config $DIRECTORY/test_data/requirements-file/.pre-commit-config.yaml --files $DIRECTORY/test_data/requirements-file/main.py

tests/spell-check/test_data/empty.txt

@@ -0,0 +1,7 @@
+repos:
+    - repo: .
+      rev: HEAD
+      hooks:
+          - id: spell-check-commit-msgs
+            args:
+              - -L wrod,woo

tests/spell-check/test_data/ignore-error/.pre-commit-config.yaml

@@ -0,0 +1 @@
+This uses a Wrod.

tests/spell-check/test_data/ignore-error/msg.txt

@@ -0,0 +1,4 @@
+Uplod files to repo.
+
+- Includs an error
+- Adn another one tooo