CU-86b7kybxx - feat: add file filtering options for pre-commit and pre-push hooks in configuration

Author: IUribeSwapps

.dev-hooks.example.yml

@@ -8,6 +8,10 @@ pre-commit:
   # Enable/disable pre-commit checks (default: true)
   enabled: true
 
+  # Only run if changes include these file patterns (optional)
+  # Supports multiple patterns: "*.py, *.js"
+  # only_for_files: "*.py"
+
   # Commands to run before commit
   commands:
     # Example: Run linter
@@ -32,9 +36,14 @@ pre-push:
   # Skip branch name validation (default: false)
   skip_branch_validation: false
 
+  # Only run commands if changes include these file patterns (optional)
+  # If no matching files are changed, commands are skipped
+  # Supports multiple patterns separated by comma: "*.py, *.js"
+  only_for_files: "*.py"
+
   # Commands to run before push
   commands:
-    # Example: Run tests
+    # Example: Run tests (only if .py files changed)
     - name: "Run Tests"
       run: "pytest"
 
@@ -59,56 +68,58 @@ docker:
 
 # --- Python Project ---
 # pre-commit:
+#   only_for_files: "*.py"
 #   commands:
 #     - name: "Lint"
 #       run: "ruff check ."
 #     - name: "Types"
 #       run: "mypy src/"
-#     - name: "Format"
-#       run: "ruff format --check ."
 # pre-push:
+#   only_for_files: "*.py"
 #   commands:
 #     - name: "Tests"
 #       run: "pytest -v"
 
 # --- Node.js Project ---
 # pre-commit:
+#   only_for_files: "*.js, *.ts, *.tsx"
 #   commands:
 #     - name: "Lint"
 #       run: "npm run lint"
 #     - name: "Types"
 #       run: "npm run typecheck"
 # pre-push:
+#   only_for_files: "*.js, *.ts, *.tsx"
 #   commands:
 #     - name: "Tests"
 #       run: "npm test"
-#     - name: "Build"
-#       run: "npm run build"
 
 # --- PHP/Drupal Project (Dockerized) ---
 # docker:
 #   enabled: true
 #   compose: true
 #   container: "php"
 # pre-commit:
+#   only_for_files: "*.php, *.module, *.inc"
 #   commands:
 #     - name: "PHPCS"
 #       run: "vendor/bin/phpcs --standard=Drupal web/modules/custom"
 # pre-push:
+#   only_for_files: "*.php"
 #   commands:
 #     - name: "PHPUnit"
 #       run: "vendor/bin/phpunit"
 
 # --- Go Project ---
 # pre-commit:
+#   only_for_files: "*.go"
 #   commands:
 #     - name: "Vet"
 #       run: "go vet ./..."
 #     - name: "Fmt"
 #       run: "test -z $(gofmt -l .)"
 # pre-push:
+#   only_for_files: "*.go"
 #   commands:
 #     - name: "Tests"
 #       run: "go test ./..."
-#     - name: "Build"
-#       run: "go build ./..."

README.md

@@ -7,6 +7,7 @@ Git hooks for development workflow automation.
 - **commit-msg**: Validates commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) format (with optional ClickUp ID)
 - **pre-commit**: Runs custom commands (lint, type check, format) from config file
 - **pre-push**: Validates branch naming + runs custom commands (tests) from config file
+- **File filtering**: Only run commands when specific file types are changed
 
 ## Installation
 
@@ -105,6 +106,7 @@ cp .dev-hooks.example.yml .dev-hooks.yml
 # Pre-commit commands (run on every commit)
 pre-commit:
   enabled: true
+  only_for_files: "*.py"  # Only run if .py files are staged
   commands:
     - name: "Lint Check"
       run: "ruff check src/"
@@ -115,6 +117,7 @@ pre-commit:
 pre-push:
   enabled: true
   skip_branch_validation: false
+  only_for_files: "*.py"  # Only run tests if .py files changed
   commands:
     - name: "Run Tests"
       run: "pytest"
@@ -127,6 +130,23 @@ docker:
   compose_file: "docker-compose.yml"
 ```
 
+### File Filtering
+
+Use `only_for_files` to run commands only when specific file types are changed:
+
+```yaml
+pre-commit:
+  only_for_files: "*.py"           # Single pattern
+
+pre-push:
+  only_for_files: "*.py, *.js"     # Multiple patterns (comma-separated)
+```
+
+If no matching files are found, commands are skipped with a message:
+```
+Skipping pre-push commands (no matching files: *.py)
+```
+
 ### Docker Support
 
 For dockerized projects, enable docker execution:

src/dev_tools_hooks/hooks/pre-commit

@@ -2,6 +2,7 @@
 
 # Pre-commit hook for code quality checks
 # Runs custom commands from .dev-hooks.yml (lint, type check, format, etc.)
+# Optionally filtered by file types
 
 # Colors optimized for macOS Terminal
 RED='\x1b[31m'
@@ -91,22 +92,61 @@ yaml_get_commands() {
     ' "$file"
 }
 
+# ============================================================================
+# File Filter Check
+# ============================================================================
+
+has_matching_staged_files() {
+    local filter="$1"
+
+    if [ -z "$filter" ]; then
+        return 0
+    fi
+
+    # Get staged files
+    local staged_files=$(git diff --cached --name-only --diff-filter=ACMR)
+
+    if [ -z "$staged_files" ]; then
+        return 1
+    fi
+
+    # Check if any file matches the filter pattern
+    IFS=',' read -ra patterns <<< "$filter"
+    for pattern in "${patterns[@]}"; do
+        pattern=$(echo "$pattern" | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
+        local regex=$(echo "$pattern" | sed 's/\./\\./g; s/\*/.*/g')
+
+        if echo "$staged_files" | grep -qE "$regex"; then
+            return 0
+        fi
+    done
+
+    return 1
+}
+
 # ============================================================================
 # Run Commands from .dev-hooks.yml
 # ============================================================================
 
 run_commands() {
     if [ ! -f "$CONFIG_FILE" ]; then
-        # No config file, nothing to do
         exit 0
     fi
 
-    # Check if pre-commit is enabled
     local enabled=$(yaml_get "pre-commit.enabled" "$CONFIG_FILE")
     if [ "$enabled" = "false" ]; then
         exit 0
     fi
 
+    # Check file filter
+    local only_for_files=$(yaml_get "pre-commit.only_for_files" "$CONFIG_FILE")
+    if [ -n "$only_for_files" ]; then
+        if ! has_matching_staged_files "$only_for_files"; then
+            echo -e "${DIM}Skipping pre-commit commands (no matching files: ${only_for_files})${NC}"
+            exit 0
+        fi
+    fi
+
     # Check docker settings
     local docker_enabled=$(yaml_get "docker.enabled" "$CONFIG_FILE")
     local docker_compose=$(yaml_get "docker.compose" "$CONFIG_FILE")
@@ -115,7 +155,6 @@ run_commands() {
 
     [ -z "$compose_file" ] && compose_file="docker-compose.yml"
 
-    # Get commands
     local commands=$(yaml_get_commands "pre-commit" "$CONFIG_FILE")
 
     if [ -z "$commands" ]; then
@@ -139,7 +178,6 @@ run_commands() {
         echo -e "${BLUE}▶${NC} ${WHITE}${BOLD}${name}${NC}"
         echo -e "  ${DIM}${cmd}${NC}"
 
-        # Build the actual command
         local full_cmd="$cmd"
 
         if [ "$docker_enabled" = "true" ]; then
@@ -150,7 +188,6 @@ run_commands() {
             fi
         fi
 
-        # Run command
         cd "$PROJECT_ROOT" || exit 1
 
         if eval "$full_cmd"; then