Fix detecting invalid PHPDocs

Author: ondrejmirtes

conf/bleedingEdge.neon

@@ -39,7 +39,6 @@ parameters:
 		newRuleLevelHelper: true
 		instanceofType: true
 		paramOutVariance: true
-		allInvalidPhpDocs: true
 		strictStaticMethodTemplateTypeVariance: true
 		propertyVariance: true
 		genericPrototypeMessage: true

conf/config.level2.neon

@@ -146,7 +146,6 @@ services:
 	-
 		class: PHPStan\Rules\PhpDoc\InvalidPhpDocTagValueRule
 		arguments:
-			checkAllInvalidPhpDocs: %featureToggles.allInvalidPhpDocs%
 			invalidPhpDocTagLine: %featureToggles.invalidPhpDocTagLine%
 		tags:
 			- phpstan.rules.rule
@@ -159,8 +158,6 @@ services:
 			- phpstan.rules.rule
 	-
 		class: PHPStan\Rules\PhpDoc\InvalidPHPStanDocTagRule
-		arguments:
-			checkAllInvalidPhpDocs: %featureToggles.allInvalidPhpDocs%
 		tags:
 			- phpstan.rules.rule
 	-

conf/config.neon

@@ -74,7 +74,7 @@ parameters:
 		newRuleLevelHelper: false
 		instanceofType: false
 		paramOutVariance: false
-		allInvalidPhpDocs: false
+
 		strictStaticMethodTemplateTypeVariance: false
 		propertyVariance: false
 		genericPrototypeMessage: false

conf/parametersSchema.neon

@@ -69,7 +69,6 @@ parametersSchema:
 		newRuleLevelHelper: bool()
 		instanceofType: bool()
 		paramOutVariance: bool()
-		allInvalidPhpDocs: bool()
 		strictStaticMethodTemplateTypeVariance: bool()
 		propertyVariance: bool()
 		genericPrototypeMessage: bool()

src/PhpDoc/StubValidator.php

@@ -217,12 +217,15 @@ private function getRuleRegistry(Container $container): RuleRegistry
 			new InvalidPhpDocTagValueRule(
 				$container->getByType(Lexer::class),
 				$container->getByType(PhpDocParser::class),
-				$container->getParameter('featureToggles')['allInvalidPhpDocs'],
 				$container->getParameter('featureToggles')['invalidPhpDocTagLine'],
 			),
 			new IncompatibleParamImmediatelyInvokedCallableRule($fileTypeMapper),
 			new IncompatibleSelfOutTypeRule($unresolvableTypeHelper, $genericObjectTypeCheck),
 			new IncompatibleClassConstantPhpDocTypeRule($genericObjectTypeCheck, $unresolvableTypeHelper),
+			new InvalidPHPStanDocTagRule(
+				$container->getByType(Lexer::class),
+				$container->getByType(PhpDocParser::class),
+			),
 			new InvalidThrowsPhpDocValueRule($fileTypeMapper),
 
 			// level 6
@@ -240,14 +243,6 @@ private function getRuleRegistry(Container $container): RuleRegistry
 			$rules[] = new DuplicateFunctionDeclarationRule($reflector, $relativePathHelper);
 		}
 
-		if ((bool) $container->getParameter('featureToggles')['allInvalidPhpDocs']) {
-			$rules[] = new InvalidPHPStanDocTagRule(
-				$container->getByType(Lexer::class),
-				$container->getByType(PhpDocParser::class),
-				true,
-			);
-		}
-
 		if ((bool) $container->getParameter('featureToggles')['absentTypeChecks']) {
 			$rules[] = new MissingMethodSelfOutTypeRule($missingTypehintCheck);
 

src/Rules/PhpDoc/InvalidPHPStanDocTagRule.php

@@ -15,7 +15,7 @@
 use function str_starts_with;
 
 /**
- * @implements Rule<Node>
+ * @implements Rule<Node\Stmt>
  */
 final class InvalidPHPStanDocTagRule implements Rule
 {
@@ -63,39 +63,23 @@ final class InvalidPHPStanDocTagRule implements Rule
 	public function __construct(
 		private Lexer $phpDocLexer,
 		private PhpDocParser $phpDocParser,
-		private bool $checkAllInvalidPhpDocs,
 	)
 	{
 	}
 
 	public function getNodeType(): string
 	{
-		return Node::class;
+		return Node\Stmt::class;
 	}
 
 	public function processNode(Node $node, Scope $scope): array
 	{
-		if (!$this->checkAllInvalidPhpDocs) {
-			if (
-				!$node instanceof Node\Stmt\ClassLike
-				&& !$node instanceof Node\FunctionLike
-				&& !$node instanceof Node\Stmt\Foreach_
-				&& !$node instanceof Node\Stmt\Property
-				&& !$node instanceof Node\Expr\Assign
-				&& !$node instanceof Node\Expr\AssignRef
-				&& !$node instanceof Node\Stmt\ClassConst
-			) {
-				return [];
-			}
-		} else {
-			// mirrored with InvalidPhpDocTagValueRule
-			if ($node instanceof VirtualNode) {
-				return [];
-			}
-			if ($node instanceof Node\Stmt\Expression) {
-				return [];
-			}
-			if ($node instanceof Node\Expr && !$node instanceof Node\Expr\Assign && !$node instanceof Node\Expr\AssignRef) {
+		// mirrored with InvalidPhpDocTagValueRule
+		if ($node instanceof VirtualNode) {
+			return [];
+		}
+		if ($node instanceof Node\Stmt\Expression) {
+			if (!$node->expr instanceof Node\Expr\Assign && !$node->expr instanceof Node\Expr\AssignRef) {
 				return [];
 			}
 		}

src/Rules/PhpDoc/InvalidPhpDocTagValueRule.php

@@ -18,48 +18,32 @@
 use function str_starts_with;
 
 /**
- * @implements Rule<Node>
+ * @implements Rule<Node\Stmt>
  */
 final class InvalidPhpDocTagValueRule implements Rule
 {
 
 	public function __construct(
 		private Lexer $phpDocLexer,
 		private PhpDocParser $phpDocParser,
-		private bool $checkAllInvalidPhpDocs,
 		private bool $invalidPhpDocTagLine,
 	)
 	{
 	}
 
 	public function getNodeType(): string
 	{
-		return Node::class;
+		return Node\Stmt::class;
 	}
 
 	public function processNode(Node $node, Scope $scope): array
 	{
-		if (!$this->checkAllInvalidPhpDocs) {
-			if (
-				!$node instanceof Node\Stmt\ClassLike
-				&& !$node instanceof Node\FunctionLike
-				&& !$node instanceof Node\Stmt\Foreach_
-				&& !$node instanceof Node\Stmt\Property
-				&& !$node instanceof Node\Expr\Assign
-				&& !$node instanceof Node\Expr\AssignRef
-				&& !$node instanceof Node\Stmt\ClassConst
-			) {
-				return [];
-			}
-		} else {
-			// mirrored with InvalidPHPStanDocTagRule
-			if ($node instanceof VirtualNode) {
-				return [];
-			}
-			if ($node instanceof Node\Stmt\Expression) {
-				return [];
-			}
-			if ($node instanceof Node\Expr && !$node instanceof Node\Expr\Assign && !$node instanceof Node\Expr\AssignRef) {
+		// mirrored with InvalidPHPStanDocTagRule
+		if ($node instanceof VirtualNode) {
+			return [];
+		}
+		if ($node instanceof Node\Stmt\Expression) {
+			if (!$node->expr instanceof Node\Expr\Assign && !$node->expr instanceof Node\Expr\AssignRef) {
 				return [];
 			}
 		}

tests/PHPStan/Rules/PhpDoc/InvalidPHPStanDocTagRuleTest.php

@@ -18,7 +18,6 @@ protected function getRule(): Rule
 		return new InvalidPHPStanDocTagRule(
 			self::getContainer()->getByType(Lexer::class),
 			self::getContainer()->getByType(PhpDocParser::class),
-			true,
 		);
 	}
 

tests/PHPStan/Rules/PhpDoc/InvalidPhpDocTagValueRuleTest.php

@@ -19,7 +19,6 @@ protected function getRule(): Rule
 			self::getContainer()->getByType(Lexer::class),
 			self::getContainer()->getByType(PhpDocParser::class),
 			true,
-			true,
 		);
 	}