Merge pull request #37 from George-Ogden/spacing

George-Ogden · web-flow · commit 1e3d71b097c1 · 2025-10-05T21:27:47.000+02:00
Improve Output Format
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -0,0 +1,13 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - "master"
+  pull_request:
+    branches:
+      - "master"
+
+jobs:
+  lint:
+    uses: George-Ogden/actions/.github/workflows/lint.yaml@v3.1.0
diff --git a/README.md b/README.md
@@ -59,14 +59,14 @@ default_stages: ["pre-commit", "commit-msg", "pre-push"]
 
 repos:
     - repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v5.0.0
+      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.4
+      rev: v1.2.5
       hooks:
           - id: dbg-check
             exclude: ^test/
diff --git a/tests/dbg-check/test_both_issues.sh b/tests/dbg-check/test_both_issues.sh
@@ -6,5 +6,5 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . dbg-check -v --files $DIRECTORY/test_data/both_issues.cuh | tee $LOG && exit 1
-grep -F both_issues.cuh:1 $LOG
-grep -F both_issues.cuh:4 $LOG
+grep -F 'both_issues.cuh:1: #include <dbg.h>' $LOG
+grep -F 'both_issues.cuh:4: dbg(10);' $LOG
diff --git a/tests/dbg-check/test_expression.sh b/tests/dbg-check/test_expression.sh
@@ -6,4 +6,4 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . dbg-check -v --files $DIRECTORY/test_data/debug_expression.cu | tee $LOG && exit 1
-grep -F debug_expression.cu:2 $LOG
+grep -F 'debug_expression.cu:2: return dbg(-1);' $LOG
diff --git a/tests/dbg-check/test_header_brackets.sh b/tests/dbg-check/test_header_brackets.sh
@@ -6,4 +6,4 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . dbg-check -v --files $DIRECTORY/test_data/debug_header_brackets.hpp | tee $LOG && exit 1
-grep -F debug_header_brackets.hpp:3 $LOG
+grep -F 'debug_header_brackets.hpp:3: #include <dbg.h>' $LOG
diff --git a/tests/dbg-check/test_header_quotes.sh b/tests/dbg-check/test_header_quotes.sh
@@ -6,4 +6,4 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . dbg-check -v --files $DIRECTORY/test_data/debug_header_quotes.hxx | tee $LOG && exit 1
-grep -F debug_header_quotes.hxx:1 $LOG
+grep -F 'debug_header_quotes.hxx:1: #include "dbg.h"' $LOG
diff --git a/tests/dbg-check/test_import.sh b/tests/dbg-check/test_import.sh
@@ -6,4 +6,4 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . dbg-check -v --files $DIRECTORY/test_data/debug_import.py | tee $LOG && exit 1
-grep -F debug_import.py:1 $LOG
+grep -F 'debug_import.py:1: from debug import dbg' $LOG
diff --git a/tests/dbg-check/test_macro.sh b/tests/dbg-check/test_macro.sh
@@ -6,4 +6,4 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . dbg-check -v --files $DIRECTORY/test_data/debug_macro.rs | tee $LOG && exit 1
-grep -F debug_macro.rs:2 $LOG
+grep -F 'debug_macro.rs:2: return dbg!(-1);' $LOG
diff --git a/tests/dbg-check/test_multiple_invalid_files.sh b/tests/dbg-check/test_multiple_invalid_files.sh
@@ -6,7 +6,7 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . dbg-check -v --files $DIRECTORY/test_data/{debug_header_brackets.hpp,debug_statements.cpp,debug_header_quotes.hxx} | tee $LOG && exit 1
-grep -F debug_header_brackets.hpp:3 $LOG
-grep -F debug_statements.cpp:2 $LOG
-grep -F debug_statements.cpp:3 $LOG
-grep -F debug_header_quotes.hxx:1 $LOG
+grep -F 'debug_header_brackets.hpp:3: #include <dbg.h>' $LOG
+grep -F 'debug_statements.cpp:2: dbg(10);' $LOG
+grep -F 'debug_statements.cpp:3: int y = dbg(4);' $LOG
+grep -F 'debug_header_quotes.hxx:1: #include "dbg.h"' $LOG
diff --git a/tests/dbg-check/test_statements.sh b/tests/dbg-check/test_statements.sh
@@ -6,5 +6,5 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . dbg-check -v --files $DIRECTORY/test_data/debug_statements.cpp | tee $LOG && exit 1
-grep -F debug_statements.cpp:2 $LOG
-grep -F debug_statements.cpp:3 $LOG
+grep -F 'debug_statements.cpp:2: dbg(10);' $LOG
+grep -F 'debug_statements.cpp:3: int y = dbg(4);' $LOG
diff --git a/tests/dbg-check/test_symbols_and_spaces.sh b/tests/dbg-check/test_symbols_and_spaces.sh
@@ -6,6 +6,6 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . dbg-check -v --files "$DIRECTORY/test_data/invalid symbols and spaces !@#\$%^&*()'\"[]{}.hpp" | tee $LOG && exit 1
-grep -F "invalid symbols and spaces !@#\$%^&*()'\"[]{}.hpp:1" $LOG
-grep -F "invalid symbols and spaces !@#\$%^&*()'\"[]{}.hpp:4" $LOG
+grep -F "invalid symbols and spaces !@#\$%^&*()'\"[]{}.hpp:1: #include <dbg.h>" $LOG
+grep -F "invalid symbols and spaces !@#\$%^&*()'\"[]{}.hpp:4: dbg(10);" $LOG
 pre-commit try-repo . dbg-check -v --files "$DIRECTORY/test_data/valid symbols and spaces !@#\$%^&*()'\"[]{}.cuh"
diff --git a/tests/merge-conflict/test_js_conflict.sh b/tests/merge-conflict/test_js_conflict.sh
@@ -6,6 +6,6 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . check-merge-conflict -v --files $DIRECTORY/test_data/conflict.js | tee $LOG && exit 1
-grep -F conflict.js:2 $LOG | grep '<<<<<<<'
-grep -F conflict.js:4 $LOG | grep '======='
-grep -F conflict.js:6 $LOG | grep '>>>>>>>'
+grep -F 'conflict.js:2: <<<<<<<' $LOG
+grep -F 'conflict.js:4: =======' $LOG
+grep -F 'conflict.js:6: >>>>>>>' $LOG
diff --git a/tests/merge-conflict/test_lfs_conflict.sh b/tests/merge-conflict/test_lfs_conflict.sh
@@ -6,6 +6,6 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . check-merge-conflict -v --files $DIRECTORY/test_data/lfs-conflict.zip | tee $LOG && exit 1
-grep -F lfs-conflict.zip:2 $LOG | grep '<<<<<<<'
-grep -F lfs-conflict.zip:4 $LOG | grep '======='
-grep -F lfs-conflict.zip:6 $LOG | grep '>>>>>>>'
+grep -F 'lfs-conflict.zip:2: ' $LOG | grep '<<<<<<<'
+grep -F 'lfs-conflict.zip:4: ' $LOG | grep '======='
+grep -F 'lfs-conflict.zip:6: ' $LOG | grep '>>>>>>>'
diff --git a/tests/merge-conflict/test_multiple_conflicts.sh b/tests/merge-conflict/test_multiple_conflicts.sh
@@ -6,9 +6,9 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . check-merge-conflict -v --files $DIRECTORY/test_data/multiple-conflicts.py | tee $LOG && exit 1
-grep -F multiple-conflicts.py:2 $LOG | grep '<<<<<<<'
-grep -F multiple-conflicts.py:4 $LOG | grep '======='
-grep -F multiple-conflicts.py:6 $LOG | grep '>>>>>>>'
-grep -F multiple-conflicts.py:14 $LOG | grep '<<<<<<<'
-grep -F multiple-conflicts.py:16 $LOG | grep '======='
-grep -F multiple-conflicts.py:18 $LOG | grep '>>>>>>>'
+grep -F 'multiple-conflicts.py:2: <<<<<<<' $LOG
+grep -F 'multiple-conflicts.py:4: =======' $LOG
+grep -F 'multiple-conflicts.py:6: >>>>>>>' $LOG
+grep -F 'multiple-conflicts.py:14: <<<<<<<' $LOG
+grep -F 'multiple-conflicts.py:16: =======' $LOG
+grep -F 'multiple-conflicts.py:18: >>>>>>>' $LOG
diff --git a/tests/merge-conflict/test_multiple_invalid_files.sh b/tests/merge-conflict/test_multiple_invalid_files.sh
@@ -6,12 +6,12 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . check-merge-conflict -v --files $DIRECTORY/test_data/{conflict.js,multiple-conflicts.py,no-conflict.rst} | tee $LOG && exit 1
-grep -F multiple-conflicts.py:2 $LOG | grep '<<<<<<<'
-grep -F multiple-conflicts.py:4 $LOG | grep '======='
-grep -F multiple-conflicts.py:6 $LOG | grep '>>>>>>>'
-grep -F multiple-conflicts.py:14 $LOG | grep '<<<<<<<'
-grep -F multiple-conflicts.py:16 $LOG | grep '======='
-grep -F multiple-conflicts.py:18 $LOG | grep '>>>>>>>'
-grep -F conflict.js:2 $LOG | grep '<<<<<<<'
-grep -F conflict.js:4 $LOG | grep '======='
-grep -F conflict.js:6 $LOG | grep '>>>>>>>'
+grep -F 'multiple-conflicts.py:2: ' $LOG | grep '<<<<<<<'
+grep -F 'multiple-conflicts.py:4: ' $LOG | grep '======='
+grep -F 'multiple-conflicts.py:6: ' $LOG | grep '>>>>>>>'
+grep -F 'multiple-conflicts.py:14: ' $LOG | grep '<<<<<<<'
+grep -F 'multiple-conflicts.py:16: ' $LOG | grep '======='
+grep -F 'multiple-conflicts.py:18: ' $LOG | grep '>>>>>>>'
+grep -F 'conflict.js:2: ' $LOG | grep '<<<<<<<'
+grep -F 'conflict.js:4: ' $LOG | grep '======='
+grep -F 'conflict.js:6: ' $LOG | grep '>>>>>>>'
diff --git a/tests/merge-conflict/test_rst_conflict.sh b/tests/merge-conflict/test_rst_conflict.sh
@@ -6,5 +6,5 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . check-merge-conflict -v --files $DIRECTORY/test_data/conflict.rst | tee $LOG && exit 1
-grep -F conflict.rst:1 $LOG | grep '<<<<<<<'
-grep -F conflict.rst:7 $LOG | grep '>>>>>>>'
+grep -F 'conflict.rst:1: <<<<<<<' $LOG
+grep -F 'conflict.rst:7: >>>>>>>' $LOG
diff --git a/tests/merge-conflict/test_symbols_and_spaces.sh b/tests/merge-conflict/test_symbols_and_spaces.sh
@@ -6,7 +6,6 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . check-merge-conflict -v --files "$DIRECTORY/test_data/invalid symbols and spaces !@#\$%^&*()'\"[]{}.jl" | tee $LOG && exit 1
-grep -F "invalid symbols and spaces !@#\$%^&*()'\"[]{}.jl:2" $LOG | grep '<<<<<<<'
-grep -F "invalid symbols and spaces !@#\$%^&*()'\"[]{}.jl:4" $LOG | grep '======='
-grep -F "invalid symbols and spaces !@#\$%^&*()'\"[]{}.jl:6" $LOG | grep '>>>>>>>'
-pre-commit try-repo . check-merge-conflict -v --files "$DIRECTORY/test_data/valid symbols and spaces !@#\$%^&*()'\"[]{}.c"
+grep -F "invalid symbols and spaces !@#\$%^&*()'\"[]{}.jl:2: <<<<<<<" $LOG
+grep -F "invalid symbols and spaces !@#\$%^&*()'\"[]{}.jl:4: =======" $LOG
+grep -F "invalid symbols and spaces !@#\$%^&*()'\"[]{}.jl:6: >>>>>>>" $LOG
diff --git a/tests/todo-check/test_fixme.sh b/tests/todo-check/test_fixme.sh
@@ -6,4 +6,4 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . todo-check -v --files $DIRECTORY/test_data/fixme.jl | tee $LOG && exit 1
-grep -F fixme.jl:2 $LOG
+grep -F 'fixme.jl:2: #fixme' $LOG
diff --git a/tests/todo-check/test_multiple_invalid_files.sh b/tests/todo-check/test_multiple_invalid_files.sh
@@ -6,5 +6,5 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . todo-check -v --files $DIRECTORY/test_data/todo.rs $DIRECTORY/test_data/fixme.jl | tee $LOG && exit 1
-grep -F todo.rs:2 $LOG
-grep -F fixme.jl:2 $LOG
+grep -F 'todo.rs:2: todo!();' $LOG
+grep -F 'fixme.jl:2: #fixme' $LOG
diff --git a/tests/todo-check/test_multiple_todos.sh b/tests/todo-check/test_multiple_todos.sh
@@ -6,6 +6,6 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . todo-check -v --files $DIRECTORY/test_data/multiple_todos.cpp | tee $LOG && exit 1
-grep -F multiple_todos.cpp:1 $LOG
-grep -F multiple_todos.cpp:3 $LOG
-grep -F multiple_todos.cpp:4 $LOG
+grep -F 'multiple_todos.cpp:1: // TODO: blah' $LOG
+grep -F 'multiple_todos.cpp:3: //TODO blah' $LOG
+grep -F 'multiple_todos.cpp:4: /*TODO*/' $LOG
diff --git a/tests/todo-check/test_todo.sh b/tests/todo-check/test_todo.sh
@@ -6,4 +6,4 @@ DIRECTORY=$(dirname $0)
 LOG=`mktemp`
 
 pre-commit try-repo . todo-check -v --files $DIRECTORY/test_data/todo.rs | tee $LOG && exit 1
-grep -F todo.rs:2 $LOG
+grep -F 'todo.rs:2: todo!();' $LOG
diff --git a/utils.sh b/utils.sh
@@ -0,0 +1,14 @@
+cleanup_grep_output() {
+    sed 's/\([[:digit:]]*:\)[[:space:]]*/\1 /'
+}
+
+neat_pattern_search() {
+    local pattern="$1"
+    grep -nE "$pattern" "$file" | cleanup_grep_output > "$LOG"
+}
+
+
+neat_word_search() {
+    local word="$1"
+    grep -nwi "$word" "$file" | cleanup_grep_output > "$LOG"
+}
diff --git a/validate-dbg.sh b/validate-dbg.sh
@@ -2,26 +2,29 @@
 
 LOG=$(mktemp)
 
+. ./utils.sh
+
 EXITCODE=0
 for file in "$@"; do
-    grep -nE 'dbg!? *\(' "$file" > "$LOG"
+    neat_pattern_search 'dbg!? *\('
     while IFS= read -r line; do
         printf "\`dbg\` expression found in %s:%s\n" "$file" "$line"
         EXITCODE=1
     done < "$LOG";
 
-    grep -nE '^[[:space:]]*#include[[:space:]]+(\"dbg\.h\"|<dbg\.h>)[[:space:]]*$' "$file" > "$LOG"
+    neat_pattern_search '^[[:space:]]*#include[[:space:]]+(\"dbg\.h\"|<dbg\.h>)[[:space:]]*$'
     while IFS= read -r line; do
         printf "\`dbg.h\` include found in %s:%s\n" "$file" "$line"
         EXITCODE=1
     done < "$LOG";
 
-    grep -nE '^(.*[[:space:]])?import[[:space:]](.*[[:space:]])?dbg([[:space:]].*)?$' "$file" > "$LOG"
+    neat_pattern_search '^(.*[[:space:]])?import[[:space:]](.*[[:space:]])?dbg([[:space:]].*)?$'
     while IFS= read -r line; do
         printf "\`dbg\` import found in %s:%s\n" "$file" "$line"
         EXITCODE=1
     done < "$LOG";
 
 done
 
+rm -f "$LOG"
 exit $EXITCODE
diff --git a/validate-merge-conflict.sh b/validate-merge-conflict.sh
@@ -2,6 +2,8 @@
 
 LOG=$(mktemp)
 
+. ./utils.sh
+
 CONFLICT_PATTERN='^(<<<<<<<[[:space:]]|=======([[:space:]]|$)|>>>>>>>[[:space:]])'
 declare -a CONFLICT_PATTERNS=(
     '^<<<<<<< '
@@ -13,13 +15,13 @@ declare -a CONFLICT_PATTERNS=(
 EXITCODE=0
 for file in "$@"; do
     file -ib "$file" | grep -qE '^text' || continue
-    grep -nE "$CONFLICT_PATTERN" "$file" > "$LOG"
+    neat_pattern_search "$CONFLICT_PATTERN"
     while IFS= read -r line; do
         for pattern in ${CONFLICT_PATTERNS[@]}; do
             if [[ "${file: -4}" == ".rst" ]] && echo "$pattern" | grep -q '='; then
                 continue
             fi
-            if echo "$line" | cut -d: -f2- | grep -qE "$pattern"; then
+            if echo "$line" | cut -d: -f2- | sed -E 's/^[[:space:]]+//' | grep -qE "$pattern"; then
                 printf "Merge conflict pattern found in %s:%s\n" "$file" "$line"
                 EXITCODE=1
                 break
@@ -28,4 +30,5 @@ for file in "$@"; do
     done < "$LOG";
 done
 
+rm "$LOG"
 exit $EXITCODE
diff --git a/validate-todo.sh b/validate-todo.sh
@@ -2,19 +2,18 @@
 
 LOG=$(mktemp)
 
+. ./utils.sh
+
 EXITCODE=0
 for file in "$@"; do
-    grep -nwi 'todo' "$file" > "$LOG"
-    while IFS= read -r line; do
-        printf "\"todo\" found in %s:%s\n" "$file" "$line"
-        EXITCODE=1
-    done < "$LOG";
-
-    grep -nwi 'fixme' "$file" > "$LOG"
-    while IFS= read -r line; do
-        printf "\"fixme\" found in %s:%s\n" "$file" "$line"
-        EXITCODE=1
-    done < "$LOG";
+    for word in todo fixme; do
+        neat_word_search "$word"
+        while IFS= read -r line; do
+            printf "\"$word\" found in %s:%s\n" "$file" "$line"
+            EXITCODE=1
+        done < "$LOG";
+    done
 done
 
+rm $LOG
 exit $EXITCODE
diff --git a/version.txt b/version.txt
@@ -1 +1 @@
-1.2.4
+1.2.5
