Add e2e test that demonstrates IgnoreErrorExtension

Author: ruudk

.github/workflows/e2e-tests.yml

@@ -243,6 +243,10 @@ jobs:
               echo "$OUTPUT"
               ../bashunit -a matches "Note: Using configuration file .+phpstan.neon." "$OUTPUT"
               ../bashunit -a contains 'Result cache not used because the metadata do not match: metaExtensions' "$OUTPUT"
+          - script: |
+              cd e2e/ignore-error-extension
+              composer install
+              ../../bin/phpstan
 
     steps:
       - name: "Checkout"

e2e/ignore-error-extension/.gitignore

@@ -0,0 +1,2 @@
+/vendor
+/composer.lock

e2e/ignore-error-extension/composer.json

@@ -0,0 +1,7 @@
+{
+    "autoload": {
+        "psr-4": {
+            "App\\": "src/"
+        }
+    }
+}

e2e/ignore-error-extension/phpstan-baseline.neon

@@ -0,0 +1,20 @@
+parameters:
+	ignoreErrors:
+		-
+			message: '#^Method App\\HomepageController\:\:contactAction\(\) has parameter \$someUnrelatedError with no type specified\.$#'
+			identifier: missingType.parameter
+			count: 1
+			path: src/HomepageController.php
+
+		-
+			message: '#^Method App\\HomepageController\:\:getSomething\(\) return type has no value type specified in iterable type array\.$#'
+			identifier: missingType.iterableValue
+			count: 1
+			path: src/HomepageController.php
+
+		-
+			message: '#^Method App\\HomepageController\:\:homeAction\(\) has parameter \$someUnrelatedError with no type specified\.$#'
+			identifier: missingType.parameter
+			count: 1
+			path: src/HomepageController.php
+

e2e/ignore-error-extension/phpstan.neon.dist

@@ -0,0 +1,13 @@
+includes:
+	- phpstan-baseline.neon
+
+parameters:
+	level: 9
+	paths:
+		- src
+
+services:
+	-
+		class: App\ControllerActionReturnTypeIgnoreExtension
+		tags:
+			- phpstan.ignoreErrorExtension

e2e/ignore-error-extension/src/ControllerActionReturnTypeIgnoreExtension.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Error;
+use PHPStan\Analyser\IgnoreErrorExtension;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\InClassMethodNode;
+
+// This extension will ignore "missingType.iterableValue" errors for public Action methods inside Controller classes.
+final class ControllerActionReturnTypeIgnoreExtension implements IgnoreErrorExtension
+{
+	public function shouldIgnore(Error $error, Node $node, Scope $scope) : bool
+	{
+		if ($error->getIdentifier() !== 'missingType.iterableValue') {
+			return false;
+		}
+
+		// @phpstan-ignore phpstanApi.instanceofAssumption
+		if (! $node instanceof InClassMethodNode) {
+			return false;
+		}
+
+		if (! str_ends_with($node->getClassReflection()->getName(), 'Controller')) {
+			return false;
+		}
+
+		if (! str_ends_with($node->getMethodReflection()->getName(), 'Action')) {
+			return false;
+		}
+
+		if (! $node->getMethodReflection()->isPublic()) {
+			return false;
+		}
+
+		return true;
+	}
+}

e2e/ignore-error-extension/src/HomepageController.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App;
+
+final class HomepageController
+{
+	public function homeAction($someUnrelatedError = false): array
+	{
+		return [
+			'title' => 'Homepage',
+			'something' => $this->getSomething(),
+		];
+	}
+
+	public function contactAction($someUnrelatedError): array
+	{
+		return [
+			'title' => 'Contact',
+			'something' => $this->getSomething(),
+		];
+	}
+
+	private function getSomething(): array
+	{
+		return [];
+	}
+}