new convention

Author: simonLeary42

.pre-commit-config.yaml

@@ -110,3 +110,8 @@ repos:
         language: system
         files: ^resources/.*\.php$
         exclude: ^resources/lib/UnityHTTPD\.php$
+      - id: assert-no-assertTrue
+        name: Assert `assertTrue` is not used
+        entry: bash ./test/assert-no-assertTrue.bash
+        language: system
+        files: ^test/.*\.php$

CONTRIBUTING.md

@@ -22,6 +22,8 @@
   This will enable strict mode and throw an exception rather than returning `false`.
 - `UnityHTTPD`'s user-facing error functionality (ex: `badRequest`) should only be called from `webroot/**/*.php`.
   `resources/**/*.php` should throw exceptions instead.
+- No code should call `PHPUnit\Framework\TestCase::assertTrue`, instead `assert`.
+  `assert` is better because it doesn't just say "something is false", it actually shows what is false.
 
 This repository will automatically check PRs for linting compliance.
 

test/assert-no-assertTrue.bash

@@ -0,0 +1,22 @@
+set -euo pipefail
+trap 's=$?; echo "$0: Error on line "$LINENO": $BASH_COMMAND"; exit $s' ERR
+if [[ $# -lt 1 ]]; then
+    echo "at least one argument required"
+    exit 1
+fi
+
+funcs=(assertTrue)
+rc=0
+for func in "${funcs[@]}"; do
+    # --color=never because magit git output log doesn't support it
+    grep_rc=0; grep -H --color=never --line-number -P '\b'"$func"'\s*[\(;]' "$@" || grep_rc=$?
+    case "$grep_rc" in
+        0)
+            echo "$func() is not allowed! use an exception instead."; rc=1 ;;
+        1)
+            : ;; # code is good, do nothing
+        *)
+            echo "grep failed!";  rc=1 ;;
+    esac
+done
+exit "$rc"