Add github action, phpcs-changed, and pre-commit hook via Husky

Author: kraftbj

.github/workflows/phpcs.yml

@@ -0,0 +1,34 @@
+name: Code Standards
+on:
+  pull_request:
+
+jobs:
+  phpcs:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # Required for phpcs-changed to compare with base branch
+        
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '8.1'
+        tools: composer:v2
+        
+    - name: Install Dependencies
+      run: composer install
+        
+    - name: Run PHPCS on changed files
+      run: |
+        CHANGED_FILES=$(git diff --name-only --diff-filter=d origin/${{ github.base_ref }} | grep ".php$" || true)
+        if [ ! -z "$CHANGED_FILES" ]; then
+          vendor/bin/phpcs-changed \
+            --git-base=origin/${{ github.base_ref }} \
+            --phpcs-path=vendor/bin/phpcs \
+            --standard=.phpcs.xml.dist \
+            $CHANGED_FILES
+        else
+          echo "No PHP files changed"
+        fi

.husky/pre-commit

@@ -0,0 +1,2 @@
+#!/bin/sh
+. .husky/pre-commit-phpcbf.sh

.husky/pre-commit-phpcbf.sh

@@ -0,0 +1,53 @@
+#!/bin/sh
+
+# Disable exit on error since we handle exit codes manually
+set +e
+
+# Get list of staged PHP files
+STAGED_PHP_FILES=$(git diff --cached --name-only --diff-filter=d | grep ".php$") || true
+
+# Exit if no PHP files are staged
+if [ -z "$STAGED_PHP_FILES" ]; then
+    exit 0
+fi
+
+echo "Running PHPCBF on staged files..."
+
+# First try to fix what we can with PHPCBF
+echo "$STAGED_PHP_FILES" | xargs vendor/bin/phpcbf
+
+echo 'does this run?'
+
+# Check the return code
+PHPCBF_STATUS=$?
+
+# If files were fixed, add them back to staging
+if [ $PHPCBF_STATUS -ne 3 ]; then
+    echo "$STAGED_PHP_FILES" | xargs git add
+    
+    if [ $PHPCBF_STATUS -eq 1 ] || [ $PHPCBF_STATUS -eq 2 ]; then
+        echo "\nShowing remaining errors after auto-fixing:"
+        echo "$STAGED_PHP_FILES" | xargs vendor/bin/phpcs
+    fi
+fi
+
+# Now run phpcs-changed to check only modified lines
+echo "Checking modified lines with phpcs-changed..."
+STAGED_FILES_SPACE_SEPARATED=$(echo "$STAGED_PHP_FILES" | tr '\n' ' ')
+
+# Run phpcs-changed
+vendor/bin/phpcs-changed\
+    --git-staged\
+    --phpcs-path=vendor/bin/phpcs\
+    --standard=.phpcs.xml.dist\
+    $STAGED_FILES_SPACE_SEPARATED
+
+PHPCS_STATUS=$?
+
+if [ $PHPCS_STATUS -ne 0 ]; then
+    echo "⛔️ Found coding standards violations in changed lines. Please fix them before committing."
+    exit 1
+fi
+
+echo "✅ All coding standards checks passed!"
+exit 0 

composer.json

@@ -15,6 +15,7 @@
     },
     "require-dev": {
         "wp-coding-standards/wpcs": "^3.0",
-        "phpcompatibility/phpcompatibility-wp": "^2.1"
+        "phpcompatibility/phpcompatibility-wp": "^2.1",
+        "sirbrillig/phpcs-changed": "^2.11"
     }
 }

composer.lock

@@ -6,6 +6,7 @@
     "babel-loader": "^9.2.1",
     "css-loader": "^7.1.2",
     "css-minimizer-webpack-plugin": "^7.0.0",
+    "husky": "^9.0.11",
     "mini-css-extract-plugin": "^2.9.1",
     "sass": "^1.79.5",
     "sass-loader": "^16.0.2",
@@ -17,7 +18,8 @@
   "scripts": {
     "build": "webpack",
     "watch": "webpack --watch",
-    "clean": "rm -rf assets/build/js/*.js assets/build/css/*.css assets/build/js/*.map assets/build/css/*.map assets/build/css/*.js"
+    "clean": "rm -rf assets/build/js/*.js assets/build/css/*.css assets/build/js/*.map assets/build/css/*.map assets/build/css/*.js",
+    "prepare": "husky"
   },
   "dependencies": {
     "md5": "^2.3.0"