Fix status tracking in hooks due to subshell variable scope (#25)

* Initial plan

* Fix critical bug in _run_all.sh and add comprehensive hooks documentation

Co-authored-by: djeada <[email protected]>

* Fix subshell bug in last_line_empty.sh and remove_trailing_whitespaces.sh

Co-authored-by: djeada <[email protected]>

* Fix subshell bug in beautify_script.sh

Co-authored-by: djeada <[email protected]>

* Fix shebang placement in _run_all.sh

Co-authored-by: djeada <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: djeada <[email protected]>

Author: Copilot

hooks/README.md

@@ -0,0 +1,110 @@
+# Hooks
+
+This directory contains scripts that can be used as pre-commit hooks or CI checks to maintain code quality in the repository.
+
+## Overview
+
+The hooks are designed to automatically check and fix common issues in bash scripts, such as:
+- Removing carriage return characters (Windows line endings)
+- Ensuring files end with exactly one empty line
+- Removing trailing whitespaces
+- Formatting and linting bash scripts
+
+## Usage
+
+### Running All Hooks
+
+To run all hooks in check mode (without modifying files):
+
+```bash
+./hooks/_run_all.sh
+```
+
+This will execute all hooks with the `--check` option on the `src` directory. It will exit with status 1 if any checks fail.
+
+### Running Individual Hooks
+
+Each hook can be run individually with the following syntax:
+
+```bash
+./hooks/<hook_name>.sh [--check] <path>
+```
+
+- `--check`: Only check if changes are needed, do not modify files
+- `<path>`: File or directory to process
+
+**Examples:**
+
+```bash
+# Check a single file for carriage returns
+./hooks/remove_carriage_return.sh --check src/my_script.sh
+
+# Remove trailing whitespaces from all files in src directory
+./hooks/remove_trailing_whitespaces.sh src
+
+# Check if all files end with exactly one empty line
+./hooks/last_line_empty.sh --check src
+```
+
+## Available Hooks
+
+### beautify_script.sh
+Formats shell scripts using Beautysh and analyzes them with ShellCheck.
+
+**Requirements:**
+- `beautysh` - Install with `pip3 install beautysh`
+- `shellcheck` - Install with `apt-get install shellcheck` (Debian/Ubuntu)
+
+### remove_carriage_return.sh
+Removes carriage return characters (`\r`) from files. This is useful for files that may have been edited on Windows systems.
+
+### last_line_empty.sh
+Ensures that all files end with exactly one empty line. This is a common convention in many projects.
+
+### remove_trailing_whitespaces.sh
+Removes trailing whitespace characters (spaces or tabs) from the end of lines in files.
+
+## Integration
+
+### CI/CD Integration
+
+These hooks are automatically run in the CI pipeline (see `.github/workflows/blank.yml`). The CI will fail if any checks don't pass.
+
+### Git Pre-commit Hook (Optional)
+
+To run these checks before every commit, you can create a git pre-commit hook:
+
+```bash
+cat > .git/hooks/pre-commit << 'EOF'
+#!/usr/bin/env bash
+./hooks/_run_all.sh
+EOF
+chmod +x .git/hooks/pre-commit
+```
+
+This will automatically run all hooks before each commit. If any checks fail, the commit will be aborted.
+
+## How It Works
+
+The scripts in this directory are actually symbolic links to the corresponding scripts in the `src` directory. This allows the same scripts to be used both as utility scripts and as hooks.
+
+The `_run_all.sh` script:
+1. Finds all symbolic links in the `hooks` directory (excluding files starting with `_`)
+2. Executes each script with the `--check` flag
+3. Collects the exit status of all scripts
+4. Exits with status 1 if any check failed
+
+## Troubleshooting
+
+If a hook fails in CI or locally:
+
+1. Read the error message to understand which check failed
+2. Run the specific hook without `--check` to automatically fix the issue:
+   ```bash
+   ./hooks/<hook_name>.sh src
+   ```
+3. Commit the changes and try again
+
+## Note
+
+All hooks respect the `--check` flag. When used with `--check`, they will only report issues without modifying files. Without this flag, they will automatically fix the issues.

hooks/_run_all.sh

@@ -1,5 +1,5 @@
-# hooks/_run_all.sh
 #!/usr/bin/env bash
+# hooks/_run_all.sh
 
 # Ensure tput has something to work with
 export TERM=${TERM:-dumb}
@@ -24,7 +24,8 @@ RESET=$(tput sgr0)
 # Process each path
 for path in "${paths[@]}"; do
     # Find all scripts (not starting with _) in 'hooks' directory
-    find hooks -type l -name "[^_]*.sh" | while read -r script; do
+    # Use process substitution to avoid subshell and preserve status variable
+    while read -r script; do
         echo -e "\nExecuting $script"
 
         # Execute the script with '--check' option
@@ -34,7 +35,7 @@ for path in "${paths[@]}"; do
             echo "${RED}${script} check on ${path} failed${RESET}"
             status=1
         fi
-    done
+    done < <(find hooks -type l -name "[^_]*.sh")
 done
 
 # Exit with 1 if any check failed

src/beautify_script.sh

@@ -70,9 +70,9 @@ process_path() {
     local path="$1"
     local checkonly="$2"
     if [ -d "$path" ]; then
-        find "$path" -type f -name '*.sh' -print0 | while IFS= read -r -d '' file; do
+        while IFS= read -r -d '' file; do
             format_file "$file" "$checkonly"
-        done
+        done < <(find "$path" -type f -name '*.sh' -print0)
     elif [ -f "$path" ]; then
         format_file "$path" "$checkonly"
     else

src/last_line_empty.sh

@@ -136,10 +136,9 @@ process_directory() {
 
     echo "Recursively processing directory: $directory"
     # Use find to traverse
-    find "$directory" -type f -print0 2>/dev/null \
-        | while IFS= read -r -d '' f; do
+    while IFS= read -r -d '' f; do
         process_file "$f"
-    done
+    done < <(find "$directory" -type f -print0 2>/dev/null)
 }
 
 ###############################################################################

src/remove_trailing_whitespaces.sh

@@ -62,9 +62,9 @@ main() {
     local path="$1"
 
     if [ "$path" == '.' ] || [ -d "$path" ]; then
-        find "$path" -maxdepth 10 -type f ! -name "*.tmp" ! -regex ".*/$(basename "$0")" -print0 | while IFS= read -r -d '' file; do
+        while IFS= read -r -d '' file; do
             remove_trailing_whitespaces "$file"
-        done
+        done < <(find "$path" -maxdepth 10 -type f ! -name "*.tmp" ! -regex ".*/$(basename "$0")" -print0)
     elif [ -f "$path" ]; then
         if [ "$(basename "$path")" != "$scriptname" ]; then
             remove_trailing_whitespaces "$path"