Add PHPStan analysis to PRs and mainline pushes

.github/workflows/unit-tests.yml → .github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Unit Tests
+name: CI
 
 on:
   push:
@@ -7,8 +7,8 @@ on:
     branches: [ master ]
 
 jobs:
-  phpunit-tests:
-    name: PHPUnit tests
+  phpunit:
+    name: PHPUnit
     runs-on: ubuntu-latest
 
     steps:
@@ -71,3 +71,48 @@ jobs:
         with:
           name: Test results
           path: test-results
+
+  phpstan:
+    name: PHPStan
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository to the GitHub Actions runner
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      # Install Composer dependencies
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v2
+        with:
+          path: /tmp/composer-cache
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys:
+            ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        uses: php-actions/composer@v6
+        with:
+          working_dir: PodcastGenerator
+          php_version: "8.0"
+          php_extensions: gettext xdebug 
+
+      # For some reason output from the phpunt step doesn't overwrite the
+      # output.log from the composer step? Also, for some reason phpunit runs as
+      # root, which leads to unwanted permissions for the test-results dir, so
+      # we need to create it ourselves first
+      - run: |
+          rm -f PodcastGenerator/output.log
+          mkdir test-results
+
+      # Run PHPStan
+      - name: PHPStan
+        uses: php-actions/phpstan@v2
+        with:
+          php_version: "8.0"
+          php_extensions: gettext xdebug 
+          configuration: phpstan.dist.neon
+          memory_limit: 512M
+          error_format: github
+          args: --no-progress

.vscode/extensions.json

@@ -7,6 +7,7 @@
         "neilbrayfield.php-docblocker",
         "mehedidracula.php-namespace-resolver",
         "obliviousharmony.vscode-php-codesniffer",
-        "recca0120.vscode-phpunit"
+        "renandelmonico.vscode-php-test-explorer",
+        "sanderronde.phpstan-vscode"
     ]
 }

.vscode/settings.json

@@ -1,14 +1,19 @@
 {
     "composer.workingPath": "PodcastGenerator/composer.json",
-    "cSpell.words": [
-        "phpcs"
-    ],
     "phpCodeSniffer.autoExecutable": true,
     "phpCodeSniffer.exclude": [
         "**/vendor/**",
         "tests/coverage/**"
     ],
     "phpCodeSniffer.standard": "Default",
     "phpCodeSniffer.executable": "PodcastGenerator/vendor/bin/phpcs",
-    "phpunit.logpanel": true
+    "phpstan.binPath": "PodcastGenerator/vendor/bin/phpstan",
+    "phpstan.configFile": "phpstan.dist.neon",
+    "phpunit.logpanel": true,
+    "spellchecker.ignoreWordsList": [
+        "phpcs",
+        "PodcastGenerator",
+        "analyse",
+        "excludePaths"
+    ]
 }

PodcastGenerator/composer.json

@@ -59,7 +59,8 @@
         "phpunit/phpunit": "^9.5",
         "phpunit/php-code-coverage": "^9.2",
         "phpcompatibility/php-compatibility": "^9.3",
-        "dealerdirect/phpcodesniffer-composer-installer": "^0.7.2"
+        "dealerdirect/phpcodesniffer-composer-installer": "^0.7.2",
+        "phpstan/phpstan": "^1.8"
     },
     "config": {
         "allow-plugins": {

phpstan.dist.neon

@@ -0,0 +1,14 @@
+parameters:
+  level: 5
+  paths:
+    - PodcastGenerator
+    - tests
+  excludePaths:
+    analyse:
+      - PodcastGenerator/vendor
+  ignoreErrors:
+    - '#Variable \$(config|version) might not be defined.#'
+    -
+      message: '#Variable \$([a-zA-Z0-9\\_]+) might not be defined.#'
+      paths:
+        - PodcastGenerator/themes