From 095c9644ed5ec3e930b21af7e7bf7f1fa9e6b83e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kamil=20=C5=BD=C3=A1=C4=8Dek?= <kamil.zacek@gmail.com>
Date: Mon, 3 Feb 2025 12:50:58 +0100
Subject: [PATCH] Teamcity - show rule identifier when verbose output is set

---
 .../ErrorFormatter/TeamcityErrorFormatter.php    |  9 ++++++++-
 .../TeamcityErrorFormatterTest.php               | 16 ++++++++++++++--
 2 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/src/Command/ErrorFormatter/TeamcityErrorFormatter.php b/src/Command/ErrorFormatter/TeamcityErrorFormatter.php
index 8ea1d5bb1e..070896a051 100644
--- a/src/Command/ErrorFormatter/TeamcityErrorFormatter.php
+++ b/src/Command/ErrorFormatter/TeamcityErrorFormatter.php
@@ -10,6 +10,7 @@
 use function count;
 use function is_string;
 use function preg_replace;
+use function sprintf;
 use const PHP_EOL;
 
 /**
@@ -41,9 +42,15 @@ public function formatErrors(AnalysisResult $analysisResult, Output $output): in
 		]);
 
 		foreach ($fileSpecificErrors as $fileSpecificError) {
+			$message = $fileSpecificError->getMessage();
+
+			if ($fileSpecificError->getIdentifier() !== null && $fileSpecificError->canBeIgnored()) {
+				$message .= sprintf(' (🪪 %s)', $fileSpecificError->getIdentifier());
+			}
+
 			$result .= $this->createTeamcityLine('inspection', [
 				'typeId' => 'phpstan',
-				'message' => $fileSpecificError->getMessage(),
+				'message' => $message,
 				'file' => $this->relativePathHelper->getRelativePath($fileSpecificError->getFile()),
 				'line' => $fileSpecificError->getLine(),
 				// additional attributes
diff --git a/tests/PHPStan/Command/ErrorFormatter/TeamcityErrorFormatterTest.php b/tests/PHPStan/Command/ErrorFormatter/TeamcityErrorFormatterTest.php
index 9e91634634..6543fbae67 100644
--- a/tests/PHPStan/Command/ErrorFormatter/TeamcityErrorFormatterTest.php
+++ b/tests/PHPStan/Command/ErrorFormatter/TeamcityErrorFormatterTest.php
@@ -18,6 +18,7 @@ public function dataFormatterOutputProvider(): iterable
 			0,
 			0,
 			'',
+			'',
 		];
 
 		yield [
@@ -76,18 +77,29 @@ public function dataFormatterOutputProvider(): iterable
 ##teamcity[inspection typeId=\'phpstan\' message=\'Bar||nBar2\' file=\'foo.php\' line=\'5\' SEVERITY=\'ERROR\' ignorable=\'1\' tip=\'a tip\']
 ##teamcity[inspection typeId=\'phpstan\' message=\'first generic error\' file=\'.\' SEVERITY=\'ERROR\']
 ##teamcity[inspection typeId=\'phpstan\' message=\'second generic<error>\' file=\'.\' SEVERITY=\'ERROR\']
+',
+		];
+
+		yield [
+			'One file error',
+			1,
+			[4, 2],
+			0,
+			'##teamcity[inspectionType id=\'phpstan\' name=\'phpstan\' category=\'phpstan\' description=\'phpstan Inspection\']
+##teamcity[inspection typeId=\'phpstan\' message=\'Bar||nBar2\' file=\'foo.php\' line=\'\' SEVERITY=\'ERROR\' ignorable=\'1\' tip=\'\']
+##teamcity[inspection typeId=\'phpstan\' message=\'Foobar\Buz (🪪 foobar.buz)\' file=\'foo.php\' line=\'5\' SEVERITY=\'ERROR\' ignorable=\'1\' tip=\'a tip\']
 ',
 		];
 	}
 
 	/**
 	 * @dataProvider dataFormatterOutputProvider
-	 *
+	 * @param array{int, int}|int $numFileErrors
 	 */
 	public function testFormatErrors(
 		string $message,
 		int $exitCode,
-		int $numFileErrors,
+		array|int $numFileErrors,
 		int $numGenericErrors,
 		string $expected,
 	): void