Chore: adds phpstan support and scanning (#21)

Author: JasonTheAdams

.github/workflows/phpstan.yml

@@ -0,0 +1,44 @@
+name: 'PHPStan Static Analysis'
+
+on:
+    push:
+        branches: [ main, develop ]
+    pull_request:
+        branches: [ main, develop ]
+
+jobs:
+    phpstan:
+        name: PHPStan
+        runs-on: ubuntu-latest
+
+        steps:
+            -   name: Checkout code
+                uses: actions/checkout@v4
+                with:
+                    fetch-depth: 1
+
+            -   name: Setup PHP
+                uses: shivammathur/setup-php@v2
+                with:
+                    php-version: '7.2'
+                    coverage: none
+                    tools: composer:v2
+
+            -   name: Get Composer Cache Directory
+                id: composer-cache
+                run: |
+                    echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+            -   name: Cache Composer 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: Install dependencies
+                run: composer install --prefer-dist --no-progress --no-suggest --no-interaction
+
+            -   name: Run PHPStan
+                run: composer phpstan

composer.json

@@ -23,7 +23,9 @@
         "lucatume/di52": "^3.0",
         "lucatume/wp-browser": "^3.0.14",
         "codeception/module-phpbrowser": "^1.0.0",
-        "codeception/module-asserts": "^1.0.0"
+        "codeception/module-asserts": "^1.0.0",
+        "phpstan/phpstan": "^1.12",
+        "szepeviktor/phpstan-wordpress": "^1.3"
     },
     "autoload": {
         "psr-4": {
@@ -45,5 +47,9 @@
             "type": "git",
             "url": "https://github.com/wordpress/wordpress-develop.git"
         }
-    ]
+    ],
+    "scripts": {
+        "phpstan": "phpstan analyse --memory-limit=512M",
+        "phpstan:baseline": "phpstan analyse --generate-baseline=phpstan-baseline.neon --memory-limit=512M"
+    }
 }

composer.lock

@@ -0,0 +1,26 @@
+includes:
+    - vendor/szepeviktor/phpstan-wordpress/extension.neon
+
+parameters:
+    # Level 5 is a good balance between strictness and practicality
+    level: 5
+
+    # Paths to analyze
+    paths:
+        - src
+
+    # Exclude paths
+    excludePaths:
+        - vendor/*
+        - _wordpress/*
+        - _plugins/*
+
+    # Ignore specific errors if needed
+    ignoreErrors:
+        # Add specific error patterns to ignore here if needed
+
+    # PHP version (must be an integer)
+    phpVersion: 70200
+
+    # Treat missing return types as mixed
+    treatPhpDocTypesAsCertain: false

phpstan.neon

@@ -82,6 +82,7 @@ public static function setHookPrefix(string $prefix)
     /**
      * @since 1.0.0
      *
+     * @return never
      * @throws ValidationExceptionInterface
      */
     public static function throwValidationException()
@@ -118,6 +119,7 @@ public static function setValidationExceptionClass(string $validationExceptionCl
     /**
      * @since 1.0.0
      *
+     * @return never
      * @throws InvalidArgumentException
      */
     public static function throwInvalidArgumentException()
@@ -162,7 +164,7 @@ public static function initialize()
             return;
         }
 
-        if (empty(self::$container)) {
+        if (self::$container === null) {
             throw new RuntimeException('A service container must be set before initializing the library');
         }
 

src/Config.php

@@ -4,7 +4,9 @@
 
 namespace StellarWP\Validation\Exceptions\Contracts;
 
-interface ValidationExceptionInterface
+use Throwable;
+
+interface ValidationExceptionInterface extends Throwable
 {
 
 }

src/Exceptions/Contracts/ValidationExceptionInterface.php

@@ -58,6 +58,7 @@ public static function fromString(?string $options = null): ValidationRule
             $conditionSet->and($rule[0], '=', $rule[1]);
         }
 
+        // @phpstan-ignore-next-line
         return new static($conditionSet);
     }
 

src/Rules/Abstracts/ConditionalRule.php

@@ -35,6 +35,7 @@ public static function id(): string
      */
     public static function fromString(?string $options = null): ValidationRule
     {
+        // @phpstan-ignore-next-line
         return new static($options);
     }