feat: add option to report ignores without identifiers

Author: calebdw

conf/config.neon

@@ -96,6 +96,7 @@ parameters:
 	cache:
 		nodesByStringCountMax: 256
 	reportUnmatchedIgnoredErrors: true
+	reportIgnoresWithoutIdentifiers: false
 	typeAliases: []
 	universalObjectCratesClasses:
 		- stdClass
@@ -199,6 +200,7 @@ parameters:
 		- [parameters, errorFormat]
 		- [parameters, ignoreErrors]
 		- [parameters, reportUnmatchedIgnoredErrors]
+		- [parameters, reportIgnoresWithoutIdentifiers]
 		- [parameters, tipsOfTheDay]
 		- [parameters, parallel]
 		- [parameters, internalErrorsCountLimit]
@@ -463,6 +465,7 @@ services:
 		class: PHPStan\Analyser\AnalyserResultFinalizer
 		arguments:
 			reportUnmatchedIgnoredErrors: %reportUnmatchedIgnoredErrors%
+			reportIgnoresWithoutIdentifiers: %reportIgnoresWithoutIdentifiers%
 
 	-
 		class: PHPStan\Analyser\FileAnalyser

conf/parametersSchema.neon

@@ -144,6 +144,7 @@ parametersSchema:
 		nodesByStringCountMax: int()
 	])
 	reportUnmatchedIgnoredErrors: bool()
+	reportIgnoresWithoutIdentifiers: bool()
 	typeAliases: arrayOf(string())
 	universalObjectCratesClasses: listOf(string())
 	stubFiles: listOf(string())

src/Analyser/AnalyserResultFinalizer.php

@@ -24,19 +24,20 @@ public function __construct(
 		private ScopeFactory $scopeFactory,
 		private LocalIgnoresProcessor $localIgnoresProcessor,
 		private bool $reportUnmatchedIgnoredErrors,
+		private bool $reportIgnoresWithoutIdentifiers,
 	)
 	{
 	}
 
 	public function finalize(AnalyserResult $analyserResult, bool $onlyFiles, bool $debug): FinalizerResult
 	{
 		if (count($analyserResult->getCollectedData()) === 0) {
-			return $this->addUnmatchedIgnoredErrors($this->mergeFilteredPhpErrors($analyserResult), [], []);
+			return $this->addUnmatchedIgnoredErrors($this->addIgnoresWithoutIdentifiersErrors($this->mergeFilteredPhpErrors($analyserResult)), [], []);
 		}
 
 		$hasInternalErrors = count($analyserResult->getInternalErrors()) > 0 || $analyserResult->hasReachedInternalErrorsCountLimit();
 		if ($hasInternalErrors) {
-			return $this->addUnmatchedIgnoredErrors($this->mergeFilteredPhpErrors($analyserResult), [], []);
+			return $this->addUnmatchedIgnoredErrors($this->addIgnoresWithoutIdentifiersErrors($this->mergeFilteredPhpErrors($analyserResult)), [], []);
 		}
 
 		$nodeType = CollectedDataNode::class;
@@ -130,7 +131,7 @@ public function finalize(AnalyserResult $analyserResult, bool $onlyFiles, bool $
 			$allUnmatchedLineIgnores[$file] = $localIgnoresProcessorResult->getUnmatchedLineIgnores();
 		}
 
-		return $this->addUnmatchedIgnoredErrors(new AnalyserResult(
+		return $this->addUnmatchedIgnoredErrors($this->addIgnoresWithoutIdentifiersErrors(new AnalyserResult(
 			array_merge($errors, $analyserResult->getFilteredPhpErrors()),
 			[],
 			$analyserResult->getAllPhpErrors(),
@@ -144,7 +145,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
@@ -233,4 +234,50 @@ private function addUnmatchedIgnoredErrors(
 		);
 	}
 
+	private function addIgnoresWithoutIdentifiersErrors(AnalyserResult $analyserResult): AnalyserResult
+	{
+		if (!$this->reportIgnoresWithoutIdentifiers) {
+			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;
+					}
+
+					$errors[] = (new Error(
+						sprintf('Error is ignored with no identifiers on line %d.', $line),
+						$file,
+						$line,
+						false,
+						$file,
+					))->withIdentifier('ignore.noIdentifier');
+				}
+			}
+		}
+
+		return new AnalyserResult(
+			$errors,
+			$analyserResult->getFilteredPhpErrors(),
+			$analyserResult->getAllPhpErrors(),
+			$analyserResult->getLocallyIgnoredErrors(),
+			$analyserResult->getLinesToIgnore(),
+			$analyserResult->getUnmatchedLineIgnores(),
+			$analyserResult->getInternalErrors(),
+			$analyserResult->getCollectedData(),
+			$analyserResult->getDependencies(),
+			$analyserResult->getUsedTraitDependencies(),
+			$analyserResult->getExportedNodes(),
+			$analyserResult->hasReachedInternalErrorsCountLimit(),
+			$analyserResult->getPeakMemoryUsageBytes(),
+		);
+	}
+
 }

src/Command/FixerWorkerCommand.php

@@ -310,7 +310,7 @@ function (array $errors, array $locallyIgnoredErrors, array $analysedFiles) use
 					if ($error->getIdentifier() === null) {
 						continue;
 					}
-					if (!in_array($error->getIdentifier(), ['ignore.count', 'ignore.unmatched', 'ignore.unmatchedLine', 'ignore.unmatchedIdentifier'], true)) {
+					if (!in_array($error->getIdentifier(), ['ignore.count', 'ignore.unmatched', 'ignore.unmatchedLine', 'ignore.unmatchedIdentifier', 'ignore.noIdentifier'], true)) {
 						continue;
 					}
 					$ignoreFileErrors[] = $error;

src/Testing/RuleTestCase.php

@@ -241,6 +241,7 @@ private function gatherAnalyserErrorsWithDelayedErrors(array $files): array
 			$this->createScopeFactory($reflectionProvider, $this->getTypeSpecifier()),
 			new LocalIgnoresProcessor(),
 			true,
+			false,
 		);
 
 		return [

tests/PHPStan/Analyser/AnalyserTest.php

@@ -559,6 +559,20 @@ public function testIgnoreNextLineUnmatched(): void
 		}
 	}
 
+	public function testIgnoresWithoutIdentifiersReported(): void
+	{
+		$result = $this->runAnalyser([], false, [
+			__DIR__ . '/data/ignore-no-identifiers.php',
+		], true, true);
+		$this->assertCount(4, $result);
+		foreach ([10, 12, 15, 18] as $i => $line) {
+			$this->assertArrayHasKey($i, $result);
+			$this->assertInstanceOf(Error::class, $result[$i]);
+			$this->assertStringContainsString('Error is ignored with no identifiers on line', $result[$i]->getMessage());
+			$this->assertSame($line, $result[$i]->getLine());
+		}
+	}
+
 	/**
 	 * @dataProvider dataTrueAndFalse
 	 */
@@ -645,6 +659,7 @@ private function runAnalyser(
 		bool $reportUnmatchedIgnoredErrors,
 		$filePaths,
 		bool $onlyFiles,
+		bool $reportIgnoresWithoutIdentifiers = false,
 	): array
 	{
 		$analyser = $this->createAnalyser();
@@ -677,6 +692,7 @@ private function runAnalyser(
 			),
 			new LocalIgnoresProcessor(),
 			$reportUnmatchedIgnoredErrors,
+			$reportIgnoresWithoutIdentifiers,
 		);
 		$analyserResult = $finalizer->finalize($analyserResult, $onlyFiles, false)->getAnalyserResult();
 

tests/PHPStan/Analyser/data/ignore-no-identifiers.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace IgnoreNoIdentifiers;
+
+class Foo
+{
+
+	public function doFoo(): void
+	{
+		fail(); // @phpstan-ignore-line
+
+		succ(); /** @phpstan-ignore-line reported as unmatched */
+
+		// @phpstan-ignore-next-line
+		fail();
+
+		/** @phpstan-ignore-next-line reported as unmatched */
+		succ();
+	}
+
+}