#8086 Add colon as prefix of line number in table report, when running in VSCode terminal

Author: LeoVie

src/Command/ErrorFormatter/TableErrorFormatter.php

@@ -11,6 +11,7 @@
 use Symfony\Component\Console\Formatter\OutputFormatter;
 use function array_map;
 use function count;
+use function getenv;
 use function is_string;
 use function sprintf;
 use function str_replace;
@@ -88,7 +89,7 @@ public function formatErrors(
 					$message .= "\n✏️  <href=" . OutputFormatter::escape($url) . '>' . $this->relativePathHelper->getRelativePath($editorFile) . '</>';
 				}
 				$rows[] = [
-					(string) $error->getLine(),
+					$this->formatLineNumber($error->getLine()),
 					$message,
 				];
 			}
@@ -119,4 +120,18 @@ public function formatErrors(
 		return $analysisResult->getTotalErrorsCount() > 0 ? 1 : 0;
 	}
 
+	private function formatLineNumber(?int $lineNumber): string
+	{
+		if ($lineNumber === null) {
+			return '';
+		}
+
+		$isRunningInVSCodeTerminal = getenv('TERM_PROGRAM') === 'vscode';
+		if ($isRunningInVSCodeTerminal) {
+			return ':' . $lineNumber;
+		}
+
+		return (string) $lineNumber;
+	}
+
 }

tests/PHPStan/Command/ErrorFormatter/TableErrorFormatterTest.php

@@ -28,22 +28,24 @@ protected function tearDown(): void
 	public function dataFormatterOutputProvider(): iterable
 	{
 		yield [
-			'No errors',
-			0,
-			0,
-			0,
-			'
+			'message' => 'No errors',
+			'exitCode' => 0,
+			'numFileErrors' => 0,
+			'numGenericErrors' => 0,
+			'extraEnvVars' => [],
+			'expected' => '
  [OK] No errors
 
 ',
 		];
 
 		yield [
-			'One file error',
-			1,
-			1,
-			0,
-			' ------ -------------------------------------------------------------------
+			'message' => 'One file error',
+			'exitCode' => 1,
+			'numFileErrors' => 1,
+			'numGenericErrors' => 0,
+			'extraEnvVars' => [],
+			'expected' => ' ------ -------------------------------------------------------------------
   Line   folder with unicode 😃/file name with "spaces" and unicode 😃.php
  ------ -------------------------------------------------------------------
   4      Foo
@@ -56,11 +58,12 @@ public function dataFormatterOutputProvider(): iterable
 		];
 
 		yield [
-			'One generic error',
-			1,
-			0,
-			1,
-			' -- ---------------------
+			'message' => 'One generic error',
+			'exitCode' => 1,
+			'numFileErrors' => 0,
+			'numGenericErrors' => 1,
+			'extraEnvVars' => [],
+			'expected' => ' -- ---------------------
      Error
  -- ---------------------
      first generic error
@@ -73,11 +76,12 @@ public function dataFormatterOutputProvider(): iterable
 		];
 
 		yield [
-			'Multiple file errors',
-			1,
-			4,
-			0,
-			' ------ -------------------------------------------------------------------
+			'message' => 'Multiple file errors',
+			'exitCode' => 1,
+			'numFileErrors' => 4,
+			'numGenericErrors' => 0,
+			'extraEnvVars' => [],
+			'expected' => ' ------ -------------------------------------------------------------------
   Line   folder with unicode 😃/file name with "spaces" and unicode 😃.php
  ------ -------------------------------------------------------------------
   2      Bar
@@ -100,11 +104,12 @@ public function dataFormatterOutputProvider(): iterable
 		];
 
 		yield [
-			'Multiple generic errors',
-			1,
-			0,
-			2,
-			' -- ----------------------
+			'message' => 'Multiple generic errors',
+			'exitCode' => 1,
+			'numFileErrors' => 0,
+			'numGenericErrors' => 2,
+			'extraEnvVars' => [],
+			'expected' => ' -- ----------------------
      Error
  -- ----------------------
      first generic error
@@ -118,11 +123,12 @@ public function dataFormatterOutputProvider(): iterable
 		];
 
 		yield [
-			'Multiple file, multiple generic errors',
-			1,
-			4,
-			2,
-			' ------ -------------------------------------------------------------------
+			'message' => 'Multiple file, multiple generic errors',
+			'exitCode' => 1,
+			'numFileErrors' => 4,
+			'numGenericErrors' => 2,
+			'extraEnvVars' => [],
+			'expected' => ' ------ -------------------------------------------------------------------
   Line   folder with unicode 😃/file name with "spaces" and unicode 😃.php
  ------ -------------------------------------------------------------------
   2      Bar
@@ -148,6 +154,24 @@ public function dataFormatterOutputProvider(): iterable
 
  [ERROR] Found 6 errors
 
+',
+		];
+
+		yield [
+			'message' => 'One file error, called via Visual Studio Code',
+			'exitCode' => 1,
+			'numFileErrors' => 1,
+			'numGenericErrors' => 0,
+			'extraEnvVars' => ['TERM_PROGRAM=vscode'],
+			'expected' => ' ------ -------------------------------------------------------------------
+  Line   folder with unicode 😃/file name with "spaces" and unicode 😃.php
+ ------ -------------------------------------------------------------------
+  :4     Foo
+ ------ -------------------------------------------------------------------
+
+
+ [ERROR] Found 1 error
+
 ',
 		];
 	}
@@ -161,6 +185,7 @@ public function testFormatErrors(
 		int $exitCode,
 		int $numFileErrors,
 		int $numGenericErrors,
+		array $extraEnvVars,
 		string $expected,
 	): void
 	{
@@ -169,6 +194,10 @@ public function testFormatErrors(
 		}
 		$formatter = $this->createErrorFormatter(null);
 
+		foreach ($extraEnvVars as $envVar) {
+			putenv($envVar);
+		}
+
 		$this->assertSame($exitCode, $formatter->formatErrors(
 			$this->getAnalysisResult($numFileErrors, $numGenericErrors),
 			$this->getOutput(),