Identifiers in the PHP baseline as real array keys

phpstan · Oct 1, 2024 · f38addd · f38addd · ondrejmirtes · Oct 1, 2024
1 parent 9e7f39e
commit f38addd
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 17 deletions.
diff --git a/src/Command/ErrorFormatter/BaselinePhpErrorFormatter.php b/src/Command/ErrorFormatter/BaselinePhpErrorFormatter.php
@@ -8,7 +8,6 @@
 use PHPStan\File\RelativePathHelper;
 use function array_keys;
 use function count;
-use function implode;
 use function ksort;
 use function preg_quote;
 use function sort;
@@ -74,22 +73,24 @@ public function formatErrors(
 			foreach ($fileErrorsByMessage as $message => [$count, $identifiersInKeys]) {
 				$identifiers = array_keys($identifiersInKeys);
 				sort($identifiers);
-				$identifiersComment = '';
 				if (count($identifiers) > 0) {
-					if (count($identifiers) === 1) {
-						$identifiersComment = "\n\t// identifier: " . $identifiers[0];
-					} else {
-						$identifiersComment = "\n\t// identifiers: " . implode(', ', $identifiers);
+					foreach ($identifiers as $identifier) {
+						$php .= sprintf(
+							"\$ignoreErrors[] = [\n\t'message' => %s,\n\t'identifier' => %s,\n\t'count' => %d,\n\t'path' => __DIR__ . %s,\n];\n",
+							var_export(Helpers::escape('#^' . preg_quote($message, '#') . '$#'), true),
+							var_export(Helpers::escape($identifier), true),
+							var_export($count, true),
+							var_export(Helpers::escape($file), true),
+						);
 					}
+				} else {
+					$php .= sprintf(
+						"\$ignoreErrors[] = [\n\t'message' => %s,\n\t'count' => %d,\n\t'path' => __DIR__ . %s,\n];\n",
+						var_export(Helpers::escape('#^' . preg_quote($message, '#') . '$#'), true),
+						var_export($count, true),
+						var_export(Helpers::escape($file), true),
+					);
 				}
-
-				$php .= sprintf(
-					"\$ignoreErrors[] = [%s\n\t'message' => %s,\n\t'count' => %d,\n\t'path' => __DIR__ . %s,\n];\n",
-					$identifiersComment,
-					var_export(Helpers::escape('#^' . preg_quote($message, '#') . '$#'), true),
-					var_export($count, true),
-					var_export(Helpers::escape($file), true),
-				);
 			}
 		}
 

diff --git a/tests/PHPStan/Command/ErrorFormatter/BaselinePhpErrorFormatterTest.php b/tests/PHPStan/Command/ErrorFormatter/BaselinePhpErrorFormatterTest.php
@@ -80,8 +80,8 @@ public function dataFormatErrors(): iterable
 	'path' => __DIR__ . '/Foo.php',
 ];
 \$ignoreErrors[] = [
-	// identifier: argument.type
 	'message' => '#^Foo with identifier$#',
+	'identifier' => 'argument.type',
 	'count' => 2,
 	'path' => __DIR__ . '/Foo.php',
 ];
@@ -127,14 +127,20 @@ public function dataFormatErrors(): iterable
 	'path' => __DIR__ . '/Foo.php',
 ];
 \$ignoreErrors[] = [
-	// identifier: argument.type
 	'message' => '#^Foo with another message$#',
+	'identifier' => 'argument.type',
 	'count' => 1,
 	'path' => __DIR__ . '/Foo.php',
 ];
 \$ignoreErrors[] = [
-	// identifiers: argument.byRef, argument.type
 	'message' => '#^Foo with same message, different identifier$#',
+	'identifier' => 'argument.byRef',
+	'count' => 2,
+	'path' => __DIR__ . '/Foo.php',
+];
+\$ignoreErrors[] = [
+	'message' => '#^Foo with same message, different identifier$#',
+	'identifier' => 'argument.type',
 	'count' => 2,
 	'path' => __DIR__ . '/Foo.php',
 ];