Rules use RuleErrorBuilder

zonuexe · zonuexe · commit 9dce5c1e5697 · 2024-11-13T16:41:47.000+09:00
diff --git a/src/Reflection/ReflectionParser.php b/src/Reflection/ReflectionParser.php
@@ -31,7 +31,7 @@ public function __construct(
         private readonly TypeAwareNodeFinder $typeAwareNodeFinder
     ) {
         $parserFactory = new ParserFactory();
-        $this->parser = $parserFactory->create(ParserFactory::PREFER_PHP7);
+        $this->parser = $parserFactory->createForNewestSupportedVersion();
     }
 
     public function parseMethodReflection(ReflectionMethod|MethodReflection $reflectionMethod): ?ClassMethod
diff --git a/src/ReturnTypeExtension/NodeGetAttributeTypeExtension.php b/src/ReturnTypeExtension/NodeGetAttributeTypeExtension.php
@@ -13,7 +13,6 @@
 use PhpParser\Node\Scalar\String_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\MethodReflection;
-use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Type\DynamicMethodReturnTypeExtension;
 use PHPStan\Type\NullType;
 use PHPStan\Type\ObjectType;
diff --git a/src/Rules/AnnotateRegexClassConstWithRegexLinkRule.php b/src/Rules/AnnotateRegexClassConstWithRegexLinkRule.php
@@ -11,11 +11,13 @@
 use PhpParser\Node\Stmt\ClassConst;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @implements Rule<ClassConst>
  * @see \Symplify\PHPStanRules\Tests\Rules\AnnotateRegexClassConstWithRegexLinkRule\AnnotateRegexClassConstWithRegexLinkRuleTest
  */
 final class AnnotateRegexClassConstWithRegexLinkRule implements Rule, DocumentedRuleInterface
@@ -39,10 +41,6 @@ public function getNodeType(): string
         return ClassConst::class;
     }
 
-    /**
-     * @param ClassConst $node
-     * @return string[]
-     */
     public function processNode(Node $node, Scope $scope): array
     {
         if (count($node->consts) !== 1) {
@@ -69,7 +67,7 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [self::ERROR_MESSAGE];
+        return [RuleErrorBuilder::message(self::ERROR_MESSAGE)->build()];
     }
 
     public function getRuleDefinition(): RuleDefinition
diff --git a/src/Rules/CheckClassNamespaceFollowPsr4Rule.php b/src/Rules/CheckClassNamespaceFollowPsr4Rule.php
@@ -9,6 +9,7 @@
 use PhpParser\Node\Stmt\ClassLike;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use Symplify\PHPStanRules\Composer\ClassNamespaceMatcher;
 use Symplify\PHPStanRules\Composer\ComposerAutoloadResolver;
 use Symplify\PHPStanRules\Composer\Psr4PathValidator;
@@ -17,6 +18,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @implements Rule<ClassLike>
  * @see \Symplify\PHPStanRules\Tests\Rules\CheckClassNamespaceFollowPsr4Rule\CheckClassNamespaceFollowPsr4RuleTest
  */
 final class CheckClassNamespaceFollowPsr4Rule implements Rule, DocumentedRuleInterface
@@ -47,10 +49,6 @@ public function getNodeType(): string
         return ClassLike::class;
     }
 
-    /**
-     * @param ClassLike $node
-     * @return string[]
-     */
     public function processNode(Node $node, Scope $scope): array
     {
         if ($this->autoloadPsr4Paths === []) {
@@ -87,7 +85,7 @@ public function processNode(Node $node, Scope $scope): array
         $namespacePart = substr($namespaceBeforeClass, 0, -1);
         $errorMessage = sprintf(self::ERROR_MESSAGE, $namespacePart);
 
-        return [$errorMessage];
+        return [RuleErrorBuilder::message($errorMessage)->build()];
     }
 
     public function getRuleDefinition(): RuleDefinition
diff --git a/src/Rules/CheckRequiredInterfaceInContractNamespaceRule.php b/src/Rules/CheckRequiredInterfaceInContractNamespaceRule.php
@@ -9,6 +9,7 @@
 use PhpParser\Node\Stmt\Interface_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
@@ -38,10 +39,6 @@ public function getNodeType(): string
         return Interface_::class;
     }
 
-    /**
-     * @param Interface_ $node
-     * @return string[]
-     */
     public function processNode(Node $node, Scope $scope): array
     {
         $namespace = $scope->getNamespace();
@@ -53,7 +50,7 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [self::ERROR_MESSAGE];
+        return [RuleErrorBuilder::message(self::ERROR_MESSAGE)->build()];
     }
 
     public function getRuleDefinition(): RuleDefinition
diff --git a/src/Rules/ClassNameRespectsParentSuffixRule.php b/src/Rules/ClassNameRespectsParentSuffixRule.php
@@ -12,6 +12,8 @@
 use PHPStan\Node\InClassNode;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPUnit\Framework\TestCase;
 use Rector\Rector\AbstractRector;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
@@ -72,7 +74,6 @@ public function getNodeType(): string
 
     /**
      * @param InClassNode $node
-     * @return string[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -117,7 +118,7 @@ class SomeCommand extends Command
     }
 
     /**
-     * @return array<int, string>
+     * @return list<RuleError>
      */
     private function processClassNameAndShort(ClassReflection $classReflection): array
     {
@@ -132,7 +133,7 @@ private function processClassNameAndShort(ClassReflection $classReflection): arr
             }
 
             $errorMessage = sprintf(self::ERROR_MESSAGE, $expectedSuffix);
-            return [$errorMessage];
+            return [RuleErrorBuilder::message($errorMessage)->build()];
         }
 
         return [];
diff --git a/src/Rules/ForbiddenExtendOfNonAbstractClassRule.php b/src/Rules/ForbiddenExtendOfNonAbstractClassRule.php
@@ -14,6 +14,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @implements Rule<InClassNode>
  * @see \Symplify\PHPStanRules\Tests\Rules\ForbiddenExtendOfNonAbstractClassRule\ForbiddenExtendOfNonAbstractClassRuleTest
  */
 final class ForbiddenExtendOfNonAbstractClassRule implements Rule, DocumentedRuleInterface
@@ -31,10 +32,6 @@ public function getNodeType(): string
         return InClassNode::class;
     }
 
-    /**
-     * @param InClassNode $node
-     * @return string[]
-     */
     public function processNode(Node $node, Scope $scope): array
     {
         $classReflection = $node->getClassReflection();
@@ -63,7 +60,7 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [self::ERROR_MESSAGE];
+        return [RuleNodeBuilder::message(self::ERROR_MESSAGE)->build()];
     }
 
     public function getRuleDefinition(): RuleDefinition
diff --git a/src/Rules/NoGlobalConstRule.php b/src/Rules/NoGlobalConstRule.php
@@ -8,6 +8,7 @@
 use PhpParser\Node\Stmt\Const_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
@@ -28,12 +29,9 @@ public function getNodeType(): string
         return Const_::class;
     }
 
-    /**
-     * @param Const_ $node
-     */
     public function processNode(Node $node, Scope $scope): array
     {
-        return [self::ERROR_MESSAGE];
+        return [RuleErrorBuilder::message(self::ERROR_MESSAGE)->build()];
     }
 
     public function getRuleDefinition(): RuleDefinition

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public function __construct(`
`31`	`31`	`private readonly TypeAwareNodeFinder $typeAwareNodeFinder`
`32`	`32`	`) {`
`33`	`33`	`$parserFactory = new ParserFactory();`
`34`		`- $this->parser = $parserFactory->create(ParserFactory::PREFER_PHP7);`
	`34`	`+ $this->parser = $parserFactory->createForNewestSupportedVersion();`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`public function parseMethodReflection(ReflectionMethod\|MethodReflection $reflectionMethod): ?ClassMethod`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`use PhpParser\Node\Stmt\Interface_;`
`10`	`10`	`use PHPStan\Analyser\Scope;`
`11`	`11`	`use PHPStan\Rules\Rule;`
	`12`	`+use PHPStan\Rules\RuleErrorBuilder;`
`12`	`13`	`use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;`
`13`	`14`	`use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;`
`14`	`15`	`use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;`
`@@ -38,10 +39,6 @@ public function getNodeType(): string`
`38`	`39`	`return Interface_::class;`
`39`	`40`	`}`
`40`	`41`
`41`		`- /**`
`42`		`- * @param Interface_ $node`
`43`		`- * @return string[]`
`44`		`- */`
`45`	`42`	`public function processNode(Node $node, Scope $scope): array`
`46`	`43`	`{`
`47`	`44`	`$namespace = $scope->getNamespace();`
`@@ -53,7 +50,7 @@ public function processNode(Node $node, Scope $scope): array`
`53`	`50`	`return [];`
`54`	`51`	`}`
`55`	`52`
`56`		`- return [self::ERROR_MESSAGE];`
	`53`	`+ return [RuleErrorBuilder::message(self::ERROR_MESSAGE)->build()];`
`57`	`54`	`}`
`58`	`55`
`59`	`56`	`public function getRuleDefinition(): RuleDefinition`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,8 @@`
`12`	`12`	`use PHPStan\Node\InClassNode;`
`13`	`13`	`use PHPStan\Reflection\ClassReflection;`
`14`	`14`	`use PHPStan\Rules\Rule;`
	`15`	`+use PHPStan\Rules\RuleError;`
	`16`	`+use PHPStan\Rules\RuleErrorBuilder;`
`15`	`17`	`use PHPUnit\Framework\TestCase;`
`16`	`18`	`use Rector\Rector\AbstractRector;`
`17`	`19`	`use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;`
`@@ -72,7 +74,6 @@ public function getNodeType(): string`
`72`	`74`
`73`	`75`	`/**`
`74`	`76`	`* @param InClassNode $node`
`75`		`- * @return string[]`
`76`	`77`	`*/`
`77`	`78`	`public function processNode(Node $node, Scope $scope): array`
`78`	`79`	`{`
`@@ -117,7 +118,7 @@ class SomeCommand extends Command`
`117`	`118`	`}`
`118`	`119`
`119`	`120`	`/**`
`120`		`- * @return array<int, string>`
	`121`	`+ * @return list<RuleError>`
`121`	`122`	`*/`
`122`	`123`	`private function processClassNameAndShort(ClassReflection $classReflection): array`
`123`	`124`	`{`
`@@ -132,7 +133,7 @@ private function processClassNameAndShort(ClassReflection $classReflection): arr`
`132`	`133`	`}`
`133`	`134`
`134`	`135`	`$errorMessage = sprintf(self::ERROR_MESSAGE, $expectedSuffix);`
`135`		`- return [$errorMessage];`
	`136`	`+ return [RuleErrorBuilder::message($errorMessage)->build()];`
`136`	`137`	`}`
`137`	`138`
`138`	`139`	`return [];`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;`
`15`	`15`
`16`	`16`	`/**`
	`17`	`+ * @implements Rule<InClassNode>`
`17`	`18`	`* @see \Symplify\PHPStanRules\Tests\Rules\ForbiddenExtendOfNonAbstractClassRule\ForbiddenExtendOfNonAbstractClassRuleTest`
`18`	`19`	`*/`
`19`	`20`	`final class ForbiddenExtendOfNonAbstractClassRule implements Rule, DocumentedRuleInterface`
`@@ -31,10 +32,6 @@ public function getNodeType(): string`
`31`	`32`	`return InClassNode::class;`
`32`	`33`	`}`
`33`	`34`
`34`		`- /**`
`35`		`- * @param InClassNode $node`
`36`		`- * @return string[]`
`37`		`- */`
`38`	`35`	`public function processNode(Node $node, Scope $scope): array`
`39`	`36`	`{`
`40`	`37`	`$classReflection = $node->getClassReflection();`
`@@ -63,7 +60,7 @@ public function processNode(Node $node, Scope $scope): array`
`63`	`60`	`return [];`
`64`	`61`	`}`
`65`	`62`
`66`		`- return [self::ERROR_MESSAGE];`
	`63`	`+ return [RuleNodeBuilder::message(self::ERROR_MESSAGE)->build()];`
`67`	`64`	`}`
`68`	`65`
`69`	`66`	`public function getRuleDefinition(): RuleDefinition`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`use PhpParser\Node\Stmt\Const_;`
`9`	`9`	`use PHPStan\Analyser\Scope;`
`10`	`10`	`use PHPStan\Rules\Rule;`
	`11`	`+use PHPStan\Rules\RuleErrorBuilder;`
`11`	`12`	`use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;`
`12`	`13`	`use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;`
`13`	`14`	`use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;`
`@@ -28,12 +29,9 @@ public function getNodeType(): string`
`28`	`29`	`return Const_::class;`
`29`	`30`	`}`
`30`	`31`
`31`		`- /**`
`32`		`- * @param Const_ $node`
`33`		`- */`
`34`	`32`	`public function processNode(Node $node, Scope $scope): array`
`35`	`33`	`{`
`36`		`- return [self::ERROR_MESSAGE];`
	`34`	`+ return [RuleErrorBuilder::message(self::ERROR_MESSAGE)->build()];`
`37`	`35`	`}`
`38`	`36`
`39`	`37`	`public function getRuleDefinition(): RuleDefinition`