JsonErrorFormatter - strip console-specific characters from tip

ondrejmirtes · ondrejmirtes · commit 6419da745ae4 · 2023-01-23T17:12:08.000+01:00
diff --git a/src/Command/ErrorFormatter/JsonErrorFormatter.php b/src/Command/ErrorFormatter/JsonErrorFormatter.php
@@ -5,6 +5,7 @@
 use Nette\Utils\Json;
 use PHPStan\Command\AnalysisResult;
 use PHPStan\Command\Output;
+use Symfony\Component\Console\Formatter\OutputFormatter;
 use function array_key_exists;
 use function count;
 
@@ -26,6 +27,8 @@ public function formatErrors(AnalysisResult $analysisResult, Output $output): in
 			'errors' => [],
 		];
 
+		$tipFormatter = new OutputFormatter(false);
+
 		foreach ($analysisResult->getFileSpecificErrors() as $fileSpecificError) {
 			$file = $fileSpecificError->getFile();
 			if (!array_key_exists($file, $errorsArray['files'])) {
@@ -43,7 +46,7 @@ public function formatErrors(AnalysisResult $analysisResult, Output $output): in
 			];
 
 			if ($fileSpecificError->getTip() !== null) {
-				$message['tip'] = $fileSpecificError->getTip();
+				$message['tip'] = $tipFormatter->format($fileSpecificError->getTip());
 			}
 
 			$errorsArray['files'][$file]['messages'][] = $message;
diff --git a/tests/PHPStan/Command/ErrorFormatter/JsonErrorFormatterTest.php b/tests/PHPStan/Command/ErrorFormatter/JsonErrorFormatterTest.php
@@ -2,6 +2,9 @@
 
 namespace PHPStan\Command\ErrorFormatter;
 
+use Nette\Utils\Json;
+use PHPStan\Analyser\Error;
+use PHPStan\Command\AnalysisResult;
 use PHPStan\Testing\ErrorFormatterTestCase;
 use function sprintf;
 
@@ -235,4 +238,26 @@ public function testFormatErrors(
 		$this->assertJsonStringEqualsJsonString($expected, $this->getOutputContent(), sprintf('%s: JSON do not match', $message));
 	}
 
+	public function dataFormatTip(): iterable
+	{
+		yield ['tip', 'tip'];
+		yield ['<fg=cyan>%configurationFile%</>', '%configurationFile%'];
+		yield ['this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.', 'this check by setting treatPhpDocTypesAsCertain: false in your %configurationFile%.'];
+	}
+
+	/**
+	 * @dataProvider dataFormatTip
+	 */
+	public function testFormatTip(string $tip, string $expectedTip): void
+	{
+		$formatter = new JsonErrorFormatter(false);
+		$formatter->formatErrors(new AnalysisResult([
+			new Error('Foo', '/foo/bar.php', 1, true, null, null, $tip),
+		], [], [], [], [], false, null, true, 0), $this->getOutput());
+
+		$content = $this->getOutputContent();
+		$json = Json::decode($content, Json::FORCE_ARRAY);
+		$this->assertSame($expectedTip, $json['files']['/foo/bar.php']['messages'][0]['tip']);
+	}
+
 }
