TableErrorFormatter: allow editor url title configuration

phpstan · Dec 1, 2022 · 6bde609 · 6bde609
1 parent 0710109
commit 6bde609
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 2 deletions.
diff --git a/conf/config.neon b/conf/config.neon
@@ -206,6 +206,7 @@ parameters:
 		- ZEND_THREAD_SAFE
 	customRulesetUsed: null
 	editorUrl: null
+	editorUrlTitle: null
 	errorFormat: null
 	__validate: true
 
@@ -385,6 +386,7 @@ parametersSchema:
 	scanDirectories: listOf(string())
 	fixerTmpDir: string()
 	editorUrl: schema(string(), nullable())
+	editorUrlTitle: schema(string(), nullable())
 	errorFormat: schema(string(), nullable())
 
 	# irrelevant Nette parameters
@@ -2018,6 +2020,7 @@ services:
 			simpleRelativePathHelper: @simpleRelativePathHelper
 			showTipsOfTheDay: %tipsOfTheDay%
 			editorUrl: %editorUrl%
+			editorUrlTitle: %editorUrlTitle%
 
 	errorFormatter.checkstyle:
 		class: PHPStan\Command\ErrorFormatter\CheckstyleErrorFormatter

diff --git a/src/Command/ErrorFormatter/TableErrorFormatter.php b/src/Command/ErrorFormatter/TableErrorFormatter.php
@@ -25,6 +25,7 @@ public function __construct(
 		private CiDetectedErrorFormatter $ciDetectedErrorFormatter,
 		private bool $showTipsOfTheDay,
 		private ?string $editorUrl,
+		private ?string $editorUrlTitle,
 	)
 	{
 	}
@@ -86,7 +87,18 @@ public function formatErrors(
 						[$editorFile, $this->simpleRelativePathHelper->getRelativePath($editorFile), (string) $error->getLine()],
 						$this->editorUrl,
 					);
-					$message .= "\n✏️  <href=" . OutputFormatter::escape($url) . '>' . $this->relativePathHelper->getRelativePath($editorFile) . '</>';
+
+					if (is_string($this->editorUrlTitle)) {
+						$title = str_replace(
+							['%file%', '%relFile%', '%line%'],
+							[$editorFile, $this->simpleRelativePathHelper->getRelativePath($editorFile), (string) $error->getLine()],
+							$this->editorUrlTitle,
+						);
+					} else {
+						$title = $this->relativePathHelper->getRelativePath($editorFile);
+					}
+
+					$message .= "\n✏️  <href=" . OutputFormatter::escape($url) . '>' . $title . '</>';
 				}
 				$rows[] = [
 					$this->formatLineNumber($error->getLine()),

diff --git a/tests/PHPStan/Command/AnalyseApplicationIntegrationTest.php b/tests/PHPStan/Command/AnalyseApplicationIntegrationTest.php
@@ -77,6 +77,7 @@ private function runPath(string $path, int $expectedStatusCode): string
 			),
 			false,
 			null,
+			null,
 		);
 		$analysisResult = $analyserApplication->analyse(
 			[$path],

diff --git a/tests/PHPStan/Command/ErrorFormatter/TableErrorFormatterTest.php b/tests/PHPStan/Command/ErrorFormatter/TableErrorFormatterTest.php
@@ -224,6 +224,15 @@ public function testEditorUrlWithRelativePath(): void
 		$this->assertStringContainsString('editor://custom/path/rel/Foo.php', $this->getOutputContent(true));
 	}
 
+	public function testEditorUrlWithCustomTitle(): void
+	{
+		$formatter = $this->createErrorFormatter('editor://any', '%relFile%:%line%');
+		$error = new Error('Test', 'Foo.php', 12, true, self::DIRECTORY_PATH . '/rel/Foo.php');
+		$formatter->formatErrors(new AnalysisResult([$error], [], [], [], [], false, null, true), $this->getOutput(true));
+
+		$this->assertStringContainsString('rel/Foo.php:12', $this->getOutputContent(true));
+	}
+
 	public function testBug6727(): void
 	{
 		putenv('COLUMNS=30');
@@ -250,7 +259,7 @@ public function testBug6727(): void
 		self::expectNotToPerformAssertions();
 	}
 
-	private function createErrorFormatter(?string $editorUrl): TableErrorFormatter
+	private function createErrorFormatter(?string $editorUrl, ?string $editorUrlTitle = null): TableErrorFormatter
 	{
 		$relativePathHelper = new FuzzyRelativePathHelper(new NullRelativePathHelper(), self::DIRECTORY_PATH, [], '/');
 
@@ -263,6 +272,7 @@ private function createErrorFormatter(?string $editorUrl): TableErrorFormatter
 			),
 			false,
 			$editorUrl,
+			$editorUrlTitle,
 		);
 	}