Configure and run PHPStan in CI (#4)

* Configure and run PHPStan in CI * Document iterable array types
networkteam · May 7, 2024 · 4cd0904 · 4cd0904
1 parent 3767fba
commit 4cd0904
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 1 deletion.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -92,3 +92,31 @@ jobs:
     - name: Run functional tests
       run: |
         bin/phpunit --colors -c Build/BuildEssentials/PhpUnit/FunctionalTests.xml Packages/Application/${PACKAGE_NAME}/Tests/Functional
+
+    - name: Run PHPStan
+      run: |
+        composer require --dev networkteam/flow-phpstan
+        cat <<EOF >> phpstan-baseline.neon
+        parameters:
+          ignoreErrors: []
+        EOF
+        cat <<EOF >> phpstan.neon
+        includes:
+          - phpstan-baseline.neon
+          - Packages/Libraries/networkteam/flow-phpstan/extension.neon
+
+        parameters:
+          # 0: basic checks
+          # 1: possibly undefined variable, ...
+          # 2: unknown methods checked on all expressions
+          # 3: return types, types assigned to properties
+          # 4: basic dead code checking
+          # 5: checking types of arguments passed to methods and functions
+          # 6: check for missing typehints
+          # 7: report partially wrong union types
+          # 8: report calling methods and accessing properties on nullable types
+          level: 8
+
+          reportUnmatchedIgnoredErrors: true
+        EOF
+        bin/phpstan analyse Packages/Application/${PACKAGE_NAME}/Classes
diff --git a/Classes/AssetIncludesBuilder.php b/Classes/AssetIncludesBuilder.php
@@ -13,7 +13,7 @@ class AssetIncludesBuilder
 {
     /**
      * @Flow\InjectConfiguration(path="server")
-     * @var array
+     * @var array<mixed>
      */
     protected $serverConfiguration;
 
@@ -110,6 +110,9 @@ private function getManifestPath(): string
         return Files::concatenatePaths([$this->outputPath, $this->manifest]);
     }
 
+    /**
+     * @return array<mixed>
+     */
     private function getManifest(): array
     {
         $manifestPath = $this->getManifestPath();
@@ -120,6 +123,12 @@ private function getManifest(): array
         return $manifestJson;
     }
 
+    /**
+     * @param array<string> $includes
+     * @param array<mixed> $manifestJson
+     * @param array<string> $imports
+     * @return void
+     */
     private function recurseImportedChunksCSS(array &$includes, array $manifestJson, array $imports): void
     {
         foreach ($imports as $import) {
@@ -135,6 +144,12 @@ private function recurseImportedChunksCSS(array &$includes, array $manifestJson,
         }
     }
 
+    /**
+     * @param array<string> $includes
+     * @param array<mixed> $manifestJson
+     * @param array<string> $imports
+     * @return void
+     */
     private function recurseImportedChunkFiles(array &$includes, array $manifestJson, array $imports): void
     {
         foreach ($imports as $import) {