Add PHPStan and simplify PHPUnit with wp-env

.distignore

@@ -8,6 +8,7 @@ tests/
 phpunit.xml.dist
 wp-tests-config-sample.php
 phpcs.xml.dist
+phpstan.dist.neon
 composer.json
 composer.lock
 package.json

.github/workflows/coding-standards.yml

@@ -5,59 +5,48 @@ on:
     branches:
       - main
   pull_request:
-
+    branches:
+      - main
   workflow_dispatch:
 
-# Cancels all previous workflow runs for pull requests that have not completed.
-concurrency:
-  # The concurrency group contains the workflow name and the branch name for pull requests
-  # or the commit hash for any other events.
-  group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.sha }}
-  cancel-in-progress: true
-
-# Disable permissions for all available scopes by default.
-# Any needed permissions should be configured at the job level.
-permissions: {}
+permissions:
+  contents: read
 
 jobs:
-  # Runs the PHP coding standards checks.
-  #
-  # Violations are reported inline with annotations.
-  #
-  # Performs the following steps:
-  # - Checks out the repository.
-  # - Sets up PHP.
-  # - Installs Composer dependencies.
-  # - Make Composer packages available globally.
-  # - Runs PHPCS on the full codebase (warnings excluded).
-  # - Ensures version-controlled files are not modified or deleted.
-  phpcs:
-    name: Run coding standards checks
+  lint:
+    name: Lint PHP
     runs-on: ubuntu-latest
-    permissions:
-      contents: read
-    timeout-minutes: 20
 
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup cache
+        uses: actions/cache@v5
         with:
-          show-progress: ${{ runner.debug == '1' && 'true' || 'false' }}
+          key: ${{ runner.os }}-${{ hashFiles('composer.json') }} # Note that lock file will change between runs.
+          path: |
+            .cache
 
-      - name: Set up PHP
-        uses: shivammathur/setup-php@cf4cade2721270509d5b1c766ab3549210a39a2a # v2.33.0
+      - name: Setup Node
+        uses: actions/setup-node@v4
         with:
-          coverage: none
+          cache: 'npm'
+          node-version: '18'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Start the development environment
+        run: npm run env start
 
       - name: Install Composer dependencies
-        uses: ramsey/composer-install@3cf229dc2919194e9e36783941438d17239e8520 # v3.1.1
+        run: npm run test:php:install-deps
 
-      - name: Make Composer packages available globally
-        run: echo "${PWD}/vendor/bin" >> $GITHUB_PATH
+      - name: Lint PHPCS
+        # TODO: Remove the flag once all warnings are fixed.
+        run: npm run lint:php:phpcs -- -- -- --warning-severity=0
 
-      - name: Run PHPCS on all files
-        id: phpcs-files
-        run: phpcs . -n --report-full
+      - name: Run PHPStan
+        run: npm run lint:php:phpstan
 
-      - name: Ensure version-controlled files are not modified during the checks
-        run: git diff --exit-code

.github/workflows/phpunit-tests.yml

@@ -20,155 +20,106 @@ permissions:
   contents: read
 
 jobs:
-  # Runs the PHPUnit tests for FAIR.
-  #
-  # Performs the following steps:
-  # - Checks out the repository.
-  # - Sets up PHP.
-  # - Installs Composer dependencies.
-  # - Installs SVN.
-  # - Installs the test suite.
-  # - Runs the PHPUnit tests.
-  # - Ensures version-controlled files are not modified.
+  generate-matrix:
+    name: Generate PHP and WP version testing matrix
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.generate.outputs.matrix }}
+    steps:
+      - uses: actions/checkout@v6
+      - name: Generate PHP and WP testing matrix
+        id: generate
+        run: echo "matrix=$(node ./bin/github-actions-matrix.js)" >> "$GITHUB_OUTPUT"
+
   phpunit:
     name: Run tests (WP ${{ matrix.wp-version }}, PHP ${{ matrix.php-version }})
     runs-on: ubuntu-latest
+    needs: generate-matrix
+    env:
+      WP_ENV_PHP_VERSION: ${{ matrix.php-version }}
+      WP_ENV_CORE: ${{ matrix.wp-version == 'trunk' && 'WordPress/WordPress' || format( 'https://wordpress.org/wordpress-{0}.zip', matrix.wp-version ) }}
     strategy:
-      matrix:
-        php-version: [ '7.4', '8.0', '8.1', '8.2', '8.3', '8.4' ]
-        wp-version: [ '5.4', '5.5', '5.6', '5.7', '5.8', '5.9', '6.0', '6.1', '6.2', '6.3', '6.4', '6.5', '6.6', '6.7' ]
-        exclude:
-          # PHP 8.4 exclusions
-          - wp-version: '6.6'
-            php-version: '8.4'
-          - wp-version: '6.5'
-            php-version: '8.4'
-          - wp-version: '6.4'
-            php-version: '8.4'
-          - wp-version: '6.3'
-            php-version: '8.4'
-          - wp-version: '6.2'
-            php-version: '8.4'
-          - wp-version: '6.1'
-            php-version: '8.4'
-          - wp-version: '6.0'
-            php-version: '8.4'
-          - wp-version: '5.9'
-            php-version: '8.4'
-          - wp-version: '5.8'
-            php-version: '8.4'
-          - wp-version: '5.7'
-            php-version: '8.4'
-          - wp-version: '5.6'
-            php-version: '8.4'
-          - wp-version: '5.5'
-            php-version: '8.4'
-          - wp-version: '5.4'
-            php-version: '8.4'
-
-          # PHP 8.3 exclusions
-          - wp-version: '6.3'
-            php-version: '8.3'
-          - wp-version: '6.2'
-            php-version: '8.3'
-          - wp-version: '6.1'
-            php-version: '8.3'
-          - wp-version: '6.0'
-            php-version: '8.3'
-          - wp-version: '5.9'
-            php-version: '8.3'
-          - wp-version: '5.8'
-            php-version: '8.3'
-          - wp-version: '5.7'
-            php-version: '8.3'
-          - wp-version: '5.6'
-            php-version: '8.3'
-          - wp-version: '5.5'
-            php-version: '8.3'
-          - wp-version: '5.4'
-            php-version: '8.3'
-
-          # PHP 8.2 exclusions
-          - wp-version: '6.0'
-            php-version: '8.2'
-          - wp-version: '5.9'
-            php-version: '8.2'
-          - wp-version: '5.8'
-            php-version: '8.2'
-          - wp-version: '5.7'
-            php-version: '8.2'
-          - wp-version: '5.6'
-            php-version: '8.2'
-          - wp-version: '5.5'
-            php-version: '8.2'
-          - wp-version: '5.4'
-            php-version: '8.2'
-
-          # PHP 8.1 exclusions
-          - wp-version: '5.8'
-            php-version: '8.1'
-          - wp-version: '5.7'
-            php-version: '8.1'
-          - wp-version: '5.6'
-            php-version: '8.1'
-          - wp-version: '5.5'
-            php-version: '8.1'
-          - wp-version: '5.4'
-            php-version: '8.1'
-
-          # PHP 8 exclusions
-          - wp-version: '5.8' # Should work, currently doesn't.
-            php-version: '8.0'
-          - wp-version: '5.7' # Should work, currently doesn't.
-            php-version: '8.0'
-          - wp-version: '5.6' # Introduced PHP 8 beta support. Should work, currently doesn't.
-            php-version: '8.0'
-          - wp-version: '5.5'
-            php-version: '8.0'
-          - wp-version: '5.4'
-            php-version: '8.0'
+      matrix: ${{ fromJSON( needs.generate-matrix.outputs.matrix ) }}
 
     steps:
       - name: Checkout
-        uses: actions/checkout@master
+        uses: actions/checkout@v6
 
-      - name: Setup MySQL with mysql_native_password
-        uses: shogo82148/actions-setup-mysql@v1
+      - name: Setup Node
+        uses: actions/setup-node@v4
         with:
-          mysql-version: ${{ matrix.wp-version >= '5.0' && '8.0' || '5.6' }}
-          my-cnf: |
-            bind_address=127.0.0.1
-            default-authentication-plugin=mysql_native_password
-          root-password: root
-
-      - name: Set up PHP
-        uses: shivammathur/setup-php@v2
+          cache: 'npm'
+          node-version: '18'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Setup cache
+        uses: actions/cache@v5
         with:
-          php-version: ${{ matrix.php-version }}
-          coverage: none
-          extensions: mysql, mysqli
-          tools: composer, wp-cli, phpunit:${{ matrix.wp-version < '5.1' && '6' || ( matrix.wp-version < '5.9' || matrix.php-version < '8.0' ) && '7' || '9' }}, phpunit-polyfills:^1.1.0
-        env:
-          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          key: ${{ runner.os }}-${{ hashFiles('composer.json') }} # Note that lock file will change between runs.
+          path: |
+            .cache
+            tests/phpunit/cache
 
-      - name: Install Composer dependencies
-        run: composer install --optimize-autoloader --prefer-dist
+      - name: Skip development plugins
+        run: echo '{"plugins":[]}' > .wp-env.override.json
 
-      - name: Install SVN
-        run: sudo apt-get update && sudo apt-get install -y subversion
+      - name: Start the development environment
+        run: npm run env start
 
-      - name: Install test suite
+      - name: Report Versions
         run: |
-          echo "WP_VERSION=${{ matrix.wp-version }}" >> $GITHUB_ENV
-          echo "TMPDIR=${{ runner.temp }}" >> $GITHUB_ENV
-          echo "WP_TESTS_DIR=${{ runner.temp }}/wordpress-tests-lib" >> $GITHUB_ENV
-          echo "WP_CORE_DIR=${{ runner.temp }}/wordpress" >> $GITHUB_ENV
-          TMPDIR=${{ runner.temp }} bash bin/install-wp-tests.sh wordpress_test root root 127.0.0.1 ${{ matrix.wp-version }}
+          npm run env run cli -- php -v
+          npm run env run cli -- wp core version
+
+      - name: Install fresh dependencies for PHP ${{ matrix.php-version }}
+        run: rm composer.lock
+
+      - name: Install dependencies
+        run: npm run cli -- composer require --dev phpunit/phpunit:^${{ matrix.wp-version < '5.1' && '6' || ( matrix.wp-version < '5.9' || matrix.php-version < '8.0' ) && '7' || '9' }}
+
+      - name: Run PHPUnit tests (single site)
+        run: npm run test:php
+
+      - name: Run PHPUnit tests (multisite)
+        run: npm run test:php:multisite
+
+  phpunit-coverage:
+    name: PHPUnit Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
 
-      - name: Run PHPUnit tests
+      - name: Setup cache
+        uses: actions/cache@v5
+        with:
+          key: ${{ runner.os }}-${{ hashFiles('composer.json') }} # Note that lock file will change between runs.
+          path: |
+            .cache
+            tests/phpunit/cache
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          cache: 'npm'
+          node-version: '18'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Start the development environment
+        run: npm run env -- start --xdebug=coverage
+
+      - name: Report Versions
         run: |
-          echo "define('WP_TESTS_PHPUNIT_POLYFILLS_PATH', '$HOME/.composer/vendor/yoast/phpunit-polyfills');" >> ${{ runner.temp }}/wordpress-tests-lib/wp-tests-config.php
-          phpunit
+          npm run env run cli -- php -v
+          npm run env run cli -- php -i | grep xdebug
+          npm run env run cli -- wp core version
+
+      - name: Install Composer dependencies
+        run: npm run test:php:install-deps
 
-      - name: Ensure version-controlled files are not modified or deleted
-        run: git diff --exit-code
+      - name: Generate coverage report
+        run: npm run coverage:php:full

.gitignore

@@ -6,9 +6,10 @@
 .phpunit.result.cache
 phpunit.xml
 phpcs.xml
+phpstan.neon
+.wp-env.override.json
 /tests/phpunit/cache
 /tests/phpunit/coverage
-wp-tests-config.php
 
 # Track placeholders so that empty directories stay in the repo.
 !.gitkeep

.wp-env.json

@@ -1,4 +1,5 @@
 {
+	"$schema": "https://schemas.wp.org/trunk/wp-env.json",
 	"phpVersion": "7.4",
 	"plugins": [
 		"norcross/airplane-mode",