feat: add option to report ignores without comments

calebdw · calebdw · commit 384c8af351a2 · 2025-04-30T15:57:59.000-05:00
diff --git a/conf/config.neon b/conf/config.neon
@@ -96,6 +96,7 @@ parameters:
 		nodesByStringCountMax: 256
 	reportUnmatchedIgnoredErrors: true
 	reportIgnoresWithoutIdentifiers: false
+	reportIgnoresWithoutComments: false
 	typeAliases: []
 	universalObjectCratesClasses:
 		- stdClass
@@ -200,6 +201,7 @@ parameters:
 		- [parameters, ignoreErrors]
 		- [parameters, reportUnmatchedIgnoredErrors]
 		- [parameters, reportIgnoresWithoutIdentifiers]
+		- [parameters, reportIgnoresWithoutComments]
 		- [parameters, tipsOfTheDay]
 		- [parameters, parallel]
 		- [parameters, internalErrorsCountLimit]
@@ -464,6 +466,7 @@ services:
 		arguments:
 			reportUnmatchedIgnoredErrors: %reportUnmatchedIgnoredErrors%
 			reportIgnoresWithoutIdentifiers: %reportIgnoresWithoutIdentifiers%
+			reportIgnoresWithoutComments: %reportIgnoresWithoutComments%
 
 	-
 		class: PHPStan\Analyser\FileAnalyser
diff --git a/conf/parametersSchema.neon b/conf/parametersSchema.neon
@@ -144,6 +144,7 @@ parametersSchema:
 	])
 	reportUnmatchedIgnoredErrors: bool()
 	reportIgnoresWithoutIdentifiers: bool()
+	reportIgnoresWithoutComments: bool()
 	typeAliases: arrayOf(string())
 	universalObjectCratesClasses: listOf(string())
 	stubFiles: listOf(string())
diff --git a/src/Analyser/AnalyserResultFinalizer.php b/src/Analyser/AnalyserResultFinalizer.php
@@ -25,19 +25,17 @@ public function __construct(
 		private LocalIgnoresProcessor $localIgnoresProcessor,
 		private bool $reportUnmatchedIgnoredErrors,
 		private bool $reportIgnoresWithoutIdentifiers,
+		private bool $reportIgnoresWithoutComments,
 	)
 	{
 	}
 
 	public function finalize(AnalyserResult $analyserResult, bool $onlyFiles, bool $debug): FinalizerResult
 	{
-		if (count($analyserResult->getCollectedData()) === 0) {
-			return $this->addUnmatchedIgnoredErrors($this->addIgnoresWithoutIdentifiersErrors($this->mergeFilteredPhpErrors($analyserResult)), [], []);
-		}
-
+		$hasCollectedData = count($analyserResult->getCollectedData()) > 0;
 		$hasInternalErrors = count($analyserResult->getInternalErrors()) > 0 || $analyserResult->hasReachedInternalErrorsCountLimit();
-		if ($hasInternalErrors) {
-			return $this->addUnmatchedIgnoredErrors($this->addIgnoresWithoutIdentifiersErrors($this->mergeFilteredPhpErrors($analyserResult)), [], []);
+		if (! $hasCollectedData || $hasInternalErrors) {
+			return $this->addUnmatchedIgnoredErrors($this->addIgnoresWithoutCommentsErrors($this->addIgnoresWithoutIdentifiersErrors($this->mergeFilteredPhpErrors($analyserResult))), [], []);
 		}
 
 		$nodeType = CollectedDataNode::class;
@@ -131,7 +129,7 @@ public function finalize(AnalyserResult $analyserResult, bool $onlyFiles, bool $
 			$allUnmatchedLineIgnores[$file] = $localIgnoresProcessorResult->getUnmatchedLineIgnores();
 		}
 
-		return $this->addUnmatchedIgnoredErrors($this->addIgnoresWithoutIdentifiersErrors(new AnalyserResult(
+		return $this->addUnmatchedIgnoredErrors($this->addIgnoresWithoutCommentsErrors($this->addIgnoresWithoutIdentifiersErrors(new AnalyserResult(
 			array_merge($errors, $analyserResult->getFilteredPhpErrors()),
 			[],
 			$analyserResult->getAllPhpErrors(),
@@ -144,7 +142,7 @@ public function finalize(AnalyserResult $analyserResult, bool $onlyFiles, bool $
 			$analyserResult->getExportedNodes(),
 			$analyserResult->hasReachedInternalErrorsCountLimit(),
 			$analyserResult->getPeakMemoryUsageBytes(),
-		)), $collectorErrors, $locallyIgnoredCollectorErrors);
+		))), $collectorErrors, $locallyIgnoredCollectorErrors);
 	}
 
 	private function mergeFilteredPhpErrors(AnalyserResult $analyserResult): AnalyserResult
@@ -200,7 +198,7 @@ private function addUnmatchedIgnoredErrors(
 
 					foreach ($identifiers as $identifier) {
 						$errors[] = (new Error(
-							sprintf('No error with identifier %s is reported on line %d.', $identifier, $line),
+							sprintf('No error with identifier %s is reported on line %d.', $identifier['name'], $line),
 							$file,
 							$line,
 							false,
@@ -276,4 +274,56 @@ private function addIgnoresWithoutIdentifiersErrors(AnalyserResult $analyserResu
 		);
 	}
 
+	private function addIgnoresWithoutCommentsErrors(AnalyserResult $analyserResult): AnalyserResult
+	{
+		if (!$this->reportIgnoresWithoutComments) {
+			return $analyserResult;
+		}
+
+		$errors = $analyserResult->getUnorderedErrors();
+		foreach ($analyserResult->getLinesToIgnore() as $file => $data) {
+			foreach ($data as $ignoredFile => $lines) {
+				if ($ignoredFile !== $file) {
+					continue;
+				}
+
+				foreach ($lines as $line => $identifiers) {
+					if ($identifiers === null) {
+						continue;
+					}
+
+					foreach ($identifiers as $identifier) {
+						['name' => $name, 'comment' => $comment] = $identifier;
+						if ($comment !== null) {
+							continue;
+						}
+
+						$errors[] = (new Error(
+							sprintf('Ignore with identifier %s has no comment.', $name),
+							$file,
+							$line,
+							false,
+							$file,
+						))->withIdentifier('ignore.noComment');
+					}
+				}
+			}
+		}
+
+		return new AnalyserResult(
+			$errors,
+			$analyserResult->getFilteredPhpErrors(),
+			$analyserResult->getAllPhpErrors(),
+			$analyserResult->getLocallyIgnoredErrors(),
+			$analyserResult->getLinesToIgnore(),
+			$analyserResult->getUnmatchedLineIgnores(),
+			$analyserResult->getInternalErrors(),
+			$analyserResult->getCollectedData(),
+			$analyserResult->getDependencies(),
+			$analyserResult->getExportedNodes(),
+			$analyserResult->hasReachedInternalErrorsCountLimit(),
+			$analyserResult->getPeakMemoryUsageBytes(),
+		);
+	}
+
 }
diff --git a/src/Analyser/FileAnalyser.php b/src/Analyser/FileAnalyser.php
@@ -38,6 +38,7 @@
 use const E_WARNING;
 
 /**
+ * @phpstan-import-type Identifier from FileAnalyserResult
  * @phpstan-import-type CollectorData from CollectedData
  */
 final class FileAnalyser
@@ -306,15 +307,15 @@ public function analyseFile(
 
 	/**
 	 * @param Node[] $nodes
-	 * @return array<int, non-empty-list<string>|null>
+	 * @return array<int, non-empty-list<Identifier>|null>
 	 */
 	private function getLinesToIgnoreFromTokens(array $nodes): array
 	{
 		if (!isset($nodes[0])) {
 			return [];
 		}
 
-		/** @var array<int, non-empty-list<string>|null> */
+		/** @var array<int, non-empty-list<Identifier>|null> */
 		return $nodes[0]->getAttribute('linesToIgnore', []);
 	}
 
diff --git a/src/Analyser/FileAnalyserResult.php b/src/Analyser/FileAnalyserResult.php
@@ -6,7 +6,8 @@
 use PHPStan\Dependency\RootExportedNode;
 
 /**
- * @phpstan-type LinesToIgnore = array<string, array<int, non-empty-list<string>|null>>
+ * @phpstan-type Identifier = array{name: string, comment: string|null}
+ * @phpstan-type LinesToIgnore = array<string, array<int, non-empty-list<Identifier>|null>>
  * @phpstan-import-type CollectorData from CollectedData
  */
 final class FileAnalyserResult
diff --git a/src/Analyser/LocalIgnoresProcessor.php b/src/Analyser/LocalIgnoresProcessor.php
@@ -47,7 +47,7 @@ public function process(
 				}
 
 				foreach ($identifiers as $i => $ignoredIdentifier) {
-					if ($ignoredIdentifier !== $tmpFileError->getIdentifier()) {
+					if ($ignoredIdentifier['name'] !== $tmpFileError->getIdentifier()) {
 						continue;
 					}
 
@@ -66,7 +66,7 @@ public function process(
 						$unmatchedIgnoredIdentifiers = $unmatchedLineIgnores[$tmpFileError->getFile()][$line];
 						if (is_array($unmatchedIgnoredIdentifiers)) {
 							foreach ($unmatchedIgnoredIdentifiers as $j => $unmatchedIgnoredIdentifier) {
-								if ($ignoredIdentifier !== $unmatchedIgnoredIdentifier) {
+								if ($ignoredIdentifier['name'] !== $unmatchedIgnoredIdentifier['name']) {
 									continue;
 								}
 
diff --git a/src/Parser/RichParser.php b/src/Parser/RichParser.php
@@ -7,13 +7,16 @@
 use PhpParser\NodeTraverser;
 use PhpParser\NodeVisitor\NameResolver;
 use PhpParser\Token;
+use PHPStan\Analyser\FileAnalyserResult;
 use PHPStan\Analyser\Ignore\IgnoreLexer;
 use PHPStan\Analyser\Ignore\IgnoreParseException;
 use PHPStan\DependencyInjection\Container;
 use PHPStan\File\FileReader;
 use PHPStan\ShouldNotHappenException;
 use function array_filter;
+use function array_key_last;
 use function array_map;
+use function array_values;
 use function count;
 use function implode;
 use function in_array;
@@ -30,6 +33,9 @@
 use const T_DOC_COMMENT;
 use const T_WHITESPACE;
 
+/**
+ * @phpstan-import-type Identifier from FileAnalyserResult
+ */
 final class RichParser implements Parser
 {
 
@@ -111,7 +117,7 @@ public function parseString(string $sourceCode): array
 
 	/**
 	 * @param Token[] $tokens
-	 * @return array{lines: array<int, non-empty-list<string>|null>, errors: array<int, non-empty-list<string>>}
+	 * @return array{lines: array<int, non-empty-list<Identifier>|null>, errors: array<int, non-empty-list<string>>}
 	 */
 	private function getLinesToIgnore(array $tokens): array
 	{
@@ -268,33 +274,29 @@ private function getLinesToIgnoreForTokenByIgnoreComment(
 	}
 
 	/**
-	 * @return non-empty-list<string>
+	 * @return non-empty-list<Identifier>
 	 * @throws IgnoreParseException
 	 */
 	private function parseIdentifiers(string $text, int $ignorePos): array
 	{
 		$text = substr($text, $ignorePos + strlen('@phpstan-ignore'));
-		$originalTokens = $this->ignoreLexer->tokenize($text);
-		$tokens = [];
-
-		foreach ($originalTokens as $originalToken) {
-			if ($originalToken[IgnoreLexer::TYPE_OFFSET] === IgnoreLexer::TOKEN_WHITESPACE) {
-				continue;
-			}
-			$tokens[] = $originalToken;
-		}
+		$tokens = $this->ignoreLexer->tokenize($text);
 
 		$c = count($tokens);
 
 		$identifiers = [];
+		$comment = null;
 		$openParenthesisCount = 0;
 		$expected = [IgnoreLexer::TOKEN_IDENTIFIER];
+		$lastTokenTypeLabel = '@phpstan-ignore';
 
 		for ($i = 0; $i < $c; $i++) {
-			$lastTokenTypeLabel = isset($tokenType) ? $this->ignoreLexer->getLabel($tokenType) : '@phpstan-ignore';
+			if (isset($tokenType) && $tokenType !== IgnoreLexer::TOKEN_WHITESPACE) {
+				$lastTokenTypeLabel = $this->ignoreLexer->getLabel($tokenType);
+			}
 			[IgnoreLexer::VALUE_OFFSET => $content, IgnoreLexer::TYPE_OFFSET => $tokenType, IgnoreLexer::LINE_OFFSET => $tokenLine] = $tokens[$i];
 
-			if ($expected !== null && !in_array($tokenType, $expected, true)) {
+			if ($expected !== null && !in_array($tokenType, [...$expected, IgnoreLexer::TOKEN_WHITESPACE], true)) {
 				$tokenTypeLabel = $this->ignoreLexer->getLabel($tokenType);
 				$otherTokenContent = $tokenType === IgnoreLexer::TOKEN_OTHER ? sprintf(" '%s'", $content) : '';
 				$expectedLabels = implode(' or ', array_map(fn ($token) => $this->ignoreLexer->getLabel($token), $expected));
@@ -303,6 +305,9 @@ private function parseIdentifiers(string $text, int $ignorePos): array
 			}
 
 			if ($tokenType === IgnoreLexer::TOKEN_OPEN_PARENTHESIS) {
+				if ($openParenthesisCount > 0) {
+					$comment .= $content;
+				}
 				$openParenthesisCount++;
 				$expected = null;
 				continue;
@@ -311,17 +316,25 @@ private function parseIdentifiers(string $text, int $ignorePos): array
 			if ($tokenType === IgnoreLexer::TOKEN_CLOSE_PARENTHESIS) {
 				$openParenthesisCount--;
 				if ($openParenthesisCount === 0) {
+					$key = array_key_last($identifiers);
+					if ($key !== null) {
+						$identifiers[$key]['comment'] = $comment;
+						$comment = null;
+					}
 					$expected = [IgnoreLexer::TOKEN_COMMA, IgnoreLexer::TOKEN_END];
+				} else {
+					$comment .= $content;
 				}
 				continue;
 			}
 
 			if ($openParenthesisCount > 0) {
+				$comment .= $content;
 				continue; // waiting for comment end
 			}
 
 			if ($tokenType === IgnoreLexer::TOKEN_IDENTIFIER) {
-				$identifiers[] = $content;
+				$identifiers[] = ['name' => $content, 'comment' => null];
 				$expected = [IgnoreLexer::TOKEN_COMMA, IgnoreLexer::TOKEN_END, IgnoreLexer::TOKEN_OPEN_PARENTHESIS];
 				continue;
 			}
@@ -340,7 +353,7 @@ private function parseIdentifiers(string $text, int $ignorePos): array
 			throw new IgnoreParseException('Missing identifier', 1);
 		}
 
-		return $identifiers;
+		return array_values($identifiers);
 	}
 
 }
diff --git a/src/Testing/RuleTestCase.php b/src/Testing/RuleTestCase.php
@@ -242,6 +242,7 @@ private function gatherAnalyserErrorsWithDelayedErrors(array $files): array
 			new LocalIgnoresProcessor(),
 			true,
 			false,
+			false,
 		);
 
 		return [
diff --git a/tests/PHPStan/Analyser/AnalyserTest.php b/tests/PHPStan/Analyser/AnalyserTest.php
@@ -573,6 +573,27 @@ public function testIgnoresWithoutIdentifiersReported(): void
 		}
 	}
 
+	public function testIgnoresWithoutCommentsReported(): void
+	{
+		$expects = [
+			[9, 'variable.undefined'],
+			[12, 'variable.undefined'],
+			[12, 'wrong.id'],
+			[13, 'wrong.id'],
+			[14, 'variable.undefined'],
+		];
+		$result = $this->runAnalyser([], false, [
+			__DIR__ . '/data/ignore-no-comments.php',
+		], true, false, true);
+		$this->assertCount(5, $result);
+		foreach ($expects as $i => $expect) {
+			$this->assertArrayHasKey($i, $result);
+			$this->assertInstanceOf(Error::class, $result[$i]);
+			$this->assertStringContainsString(sprintf('Ignore with identifier %s has no comment.', $expect[1]), $result[$i]->getMessage());
+			$this->assertSame($expect[0], $result[$i]->getLine());
+		}
+	}
+
 	/**
 	 * @dataProvider dataTrueAndFalse
 	 */
@@ -660,6 +681,7 @@ private function runAnalyser(
 		$filePaths,
 		bool $onlyFiles,
 		bool $reportIgnoresWithoutIdentifiers = false,
+		bool $reportIgnoresWithoutComments = false,
 	): array
 	{
 		$analyser = $this->createAnalyser();
@@ -693,6 +715,7 @@ private function runAnalyser(
 			new LocalIgnoresProcessor(),
 			$reportUnmatchedIgnoredErrors,
 			$reportIgnoresWithoutIdentifiers,
+			$reportIgnoresWithoutComments,
 		);
 		$analyserResult = $finalizer->finalize($analyserResult, $onlyFiles, false)->getAnalyserResult();
 
diff --git a/tests/PHPStan/Analyser/data/ignore-no-comments.php b/tests/PHPStan/Analyser/data/ignore-no-comments.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace IgnoreNoComments;
+
+class Foo
+{
+	public function doFoo(): void
+	{
+		echo $foo; // @phpstan-ignore variable.undefined
+		echo $foo; // @phpstan-ignore wrong.id (comment)
+
+		echo $foo, $bar;  // @phpstan-ignore variable.undefined, wrong.id
+		echo $foo, $bar;  // @phpstan-ignore variable.undefined (comment), wrong.id
+		echo $foo, $bar;  // @phpstan-ignore variable.undefined, wrong.id (comment)
+		echo $foo, $bar;  // @phpstan-ignore variable.undefined (comment), wrong.id (comment)
+	}
+
+}
diff --git a/tests/PHPStan/Parser/RichParserTest.php b/tests/PHPStan/Parser/RichParserTest.php

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public function process(`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`foreach ($identifiers as $i => $ignoredIdentifier) {`
`50`		`- if ($ignoredIdentifier !== $tmpFileError->getIdentifier()) {`
	`50`	`+ if ($ignoredIdentifier['name'] !== $tmpFileError->getIdentifier()) {`
`51`	`51`	`continue;`
`52`	`52`	`}`
`53`	`53`
`@@ -66,7 +66,7 @@ public function process(`
`66`	`66`	`$unmatchedIgnoredIdentifiers = $unmatchedLineIgnores[$tmpFileError->getFile()][$line];`
`67`	`67`	`if (is_array($unmatchedIgnoredIdentifiers)) {`
`68`	`68`	`foreach ($unmatchedIgnoredIdentifiers as $j => $unmatchedIgnoredIdentifier) {`
`69`		`- if ($ignoredIdentifier !== $unmatchedIgnoredIdentifier) {`
	`69`	`+ if ($ignoredIdentifier['name'] !== $unmatchedIgnoredIdentifier['name']) {`
`70`	`70`	`continue;`
`71`	`71`	`}`
`72`	`72`