Merge pull request #19 from mailchimp/feature/12-phpcs-workflow

Add the PHPCS linting GitHub Action Workflow

.github/workflows/phpcs.yml

@@ -0,0 +1,54 @@
+name: PHP Linting
+
+on:
+  push:
+    branches:
+      - develop
+      - main
+    paths:
+      - "**.php"
+  pull_request:
+    branches:
+      - develop
+    paths:
+      - "**.php"
+
+jobs:
+  phpcs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup proper PHP version
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.3
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v44
+        with:
+          files: |
+            **/*.php
+
+      - name: Install dependencies
+        run: composer install --prefer-dist
+
+      - name: Run PHP_CodeSniffer
+        run: |
+          HEAD_REF=$(git rev-parse HEAD)
+          git checkout $HEAD_REF
+          ./vendor/bin/phpcs-changed -s --git --git-base origin/${{ github.base_ref }} ${{ steps.changed-files.outputs.all_changed_files }}

composer.json

@@ -15,11 +15,15 @@
     "php": ">=5.6"
   },
   "require-dev": {
-    "10up/phpcs-composer": "^3.0"
+    "10up/phpcs-composer": "^3.0",
+	  "sirbrillig/phpcs-changed": "^2.11"
   },
   "config": {
     "allow-plugins": {
       "dealerdirect/phpcodesniffer-composer-installer": true
     }
+  },
+  "scripts": {
+    "lint": "phpcs --standard=./phpcs.xml -p -s ."
   }
-}
+}

phpcs.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<ruleset name="TenUp PHPCS">
+	<description>TenUp PHPCS extended.</description>
+
+	<rule ref="10up-Default" />
+
+	<exclude-pattern>*/tests/*</exclude-pattern>
+
+	<config name="minimum_supported_wp_version" value="6.0"/>
+	<config name="testVersion" value="7.4-"/>
+
+	<!-- Exclude the PHPCompatibilityWP ruleset -->
+	<rule ref="PHPCompatibilityWP">
+		<exclude name="PHPCompatibilityWP"/>
+	</rule>
+</ruleset>