Merge pull request #158 from PHPCSStandards/feature/add-phpstan

Add PHPStan to QA checks

Author: jrfnl

.gitattributes

@@ -9,6 +9,7 @@
 /.gitignore            export-ignore
 /.github               export-ignore
 /phpcs.xml.dist        export-ignore
+/phpstan.neon.dist     export-ignore
 /phpunit.xml.dist      export-ignore
 /phpunit-bootstrap.php export-ignore
 /PHPCSDebug/Tests      export-ignore

.github/workflows/cs.yml

@@ -97,3 +97,30 @@ jobs:
       - name: Show PHPCS results in PR
         if: ${{ always() && steps.phpcs.outcome == 'failure' }}
         run: cs2pr ./phpcs-report.xml
+
+  phpstan:
+    name: "PHPStan"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 'latest'
+          coverage: none
+          tools: phpstan
+
+      # Install dependencies and handle caching in one go.
+      # Dependencies need to be installed to make sure the PHPCS and PHPUnit classes are recognized.
+      # @link https://github.com/marketplace/actions/install-composer-dependencies
+      - name: Install Composer dependencies
+        uses: "ramsey/composer-install@v3"
+        with:
+          # Bust the cache at least once a month - output format: YYYY-MM.
+          custom-cache-suffix: $(date -u "+%Y-%m")
+
+      - name: Run PHPStan
+        run: phpstan analyse

.gitignore

@@ -5,3 +5,4 @@ composer.lock
 phpcs.xml
 phpunit.xml
 .phpunit.result.cache
+phpstan.neon

phpstan.neon.dist

@@ -0,0 +1,11 @@
+parameters:
+    #phpVersion: 50400 # Needs to be 70100 or higher... sigh...
+    level: 6
+    paths:
+        - bin
+        - PHPCSDebug
+        - Scripts
+        - Tests
+    bootstrapFiles:
+        - phpunit-bootstrap.php
+    treatPhpDocTypesAsCertain: false