Add error identifiers (#43)

* Add error identifiers closes #41 * Fix tests
rectorphp · Sep 18, 2024 · 14689aa · 14689aa
1 parent fcb0ea2
commit 14689aa
Show file tree

Hide file tree

Showing 12 changed files with 60 additions and 18 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 /vendor
 composer.lock
 
+.idea
 .phpunit.cache
diff --git a/src/Rules/NarrowPrivateClassMethodParamTypeRule.php b/src/Rules/NarrowPrivateClassMethodParamTypeRule.php
@@ -175,6 +175,7 @@ private function validateParam(Param $param, int $position, Expr $expr, Scope $s
         $errorMessage = sprintf(self::ERROR_MESSAGE, $position + 1, $argTypeAsString);
 
         return RuleErrorBuilder::message($errorMessage)
+            ->identifier('typePerfect.narrowPrivateClassMethodParamType')
             ->line($param->getLine())
             ->build();
     }

diff --git a/src/Rules/NarrowPublicClassMethodParamTypeRule.php b/src/Rules/NarrowPublicClassMethodParamTypeRule.php
@@ -73,6 +73,7 @@ public function processNode(Node $node, Scope $scope): array
                 }
 
                 $ruleErrors[] = RuleErrorBuilder::message(sprintf(self::ERROR_MESSAGE, $uniqueCollectedArgTypesString))
+                    ->identifier('typePerfect.narrowPublicClassMethodParamType')
                     ->file($filePath)
                     ->line($line)
                     ->build();

diff --git a/src/Rules/NarrowReturnObjectTypeRule.php b/src/Rules/NarrowReturnObjectTypeRule.php
@@ -11,6 +11,8 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeWithClassName;
@@ -47,7 +49,7 @@ public function getNodeType(): string
 
     /**
      * @param ClassMethod $node
-     * @return mixed[]
+     * @return RuleError[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -94,7 +96,12 @@ public function processNode(Node $node, Scope $scope): array
 
         /** @var TypeWithClassName $returnExprType */
         $errorMessage = sprintf(self::ERROR_MESSAGE, $returnExprType->getClassName());
-        return [$errorMessage];
+
+        return [
+            RuleErrorBuilder::message($errorMessage)
+                ->identifier('typePerfect.narrowReturnObjectType')
+                ->build(),
+        ];
     }
 
     private function shouldSkipReturnObjectType(ObjectType $objectType): bool

diff --git a/src/Rules/NoArrayAccessOnObjectRule.php b/src/Rules/NoArrayAccessOnObjectRule.php
@@ -8,6 +8,8 @@
 use PhpParser\Node\Expr\ArrayDimFetch;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\ObjectType;
 
 /**
@@ -36,7 +38,7 @@ public function getNodeType(): string
 
     /**
      * @param ArrayDimFetch $node
-     * @return string[]
+     * @return RuleError[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -50,7 +52,9 @@ public function processNode(Node $node, Scope $scope): array
         }
 
         return [
-            self::ERROR_MESSAGE,
+            RuleErrorBuilder::message(self::ERROR_MESSAGE)
+                ->identifier('typePerfect.noArrayAccessOnObject')
+                ->build(),
         ];
     }
 

diff --git a/src/Rules/NoEmptyOnObjectRule.php b/src/Rules/NoEmptyOnObjectRule.php
@@ -8,6 +8,8 @@
 use PhpParser\Node\Expr\Empty_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
 use Rector\TypePerfect\Guard\EmptyIssetGuard;
 
 /**
@@ -32,7 +34,7 @@ public function getNodeType(): string
 
     /**
      * @param Empty_ $node
-     * @return string[]
+     * @return RuleError[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -41,7 +43,9 @@ public function processNode(Node $node, Scope $scope): array
         }
 
         return [
-            self::ERROR_MESSAGE,
+            RuleErrorBuilder::message(self::ERROR_MESSAGE)
+                ->identifier('typePerfect.noEmptyOnObject')
+                ->build(),
         ];
     }
 }
diff --git a/src/Rules/NoIssetOnObjectRule.php b/src/Rules/NoIssetOnObjectRule.php
@@ -8,6 +8,8 @@
 use PhpParser\Node\Expr\Isset_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
 use Rector\TypePerfect\Guard\EmptyIssetGuard;
 
 /**
@@ -34,7 +36,7 @@ public function getNodeType(): string
     /**
      * @param Isset_ $node
      *
-     * @return string[]
+     * @return RuleError[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -44,7 +46,9 @@ public function processNode(Node $node, Scope $scope): array
             }
 
             return [
-                self::ERROR_MESSAGE,
+                RuleErrorBuilder::message(self::ERROR_MESSAGE)
+                    ->identifier('typePerfect.noIssetOnObject')
+                    ->build(),
             ];
         }
 

diff --git a/src/Rules/NoMixedMethodCallerRule.php b/src/Rules/NoMixedMethodCallerRule.php
@@ -9,6 +9,8 @@
 use PhpParser\PrettyPrinter\Standard;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\MixedType;
 use Rector\TypePerfect\Configuration;
@@ -40,7 +42,7 @@ public function getNodeType(): string
 
     /**
      * @param MethodCall $node
-     * @return mixed[]
+     * @return RuleError[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -66,7 +68,9 @@ public function processNode(Node $node, Scope $scope): array
         $printedMethodCall = $this->printerStandard->prettyPrintExpr($node->var);
 
         return [
-            sprintf(self::ERROR_MESSAGE, $printedMethodCall),
+            RuleErrorBuilder::message(sprintf(self::ERROR_MESSAGE, $printedMethodCall))
+                ->identifier('typePerfect.noMixedMethodCaller')
+                ->build(),
         ];
     }
 

diff --git a/src/Rules/NoMixedPropertyFetcherRule.php b/src/Rules/NoMixedPropertyFetcherRule.php
@@ -9,6 +9,8 @@
 use PhpParser\PrettyPrinter\Standard;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\MixedType;
 use Rector\TypePerfect\Configuration;
 
@@ -39,7 +41,7 @@ public function getNodeType(): string
 
     /**
      * @param PropertyFetch $node
-     * @return mixed[]
+     * @return RuleError[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -54,6 +56,10 @@ public function processNode(Node $node, Scope $scope): array
 
         $printedVar = $this->standard->prettyPrintExpr($node->var);
 
-        return [sprintf(self::ERROR_MESSAGE, $printedVar)];
+        return [
+            RuleErrorBuilder::message(sprintf(self::ERROR_MESSAGE, $printedVar))
+                ->identifier('typePerfect.noMixedPropertyFetcher')
+                ->build(),
+        ];
     }
 }
diff --git a/src/Rules/NoParamTypeRemovalRule.php b/src/Rules/NoParamTypeRemovalRule.php
@@ -9,6 +9,8 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\Php\PhpMethodReflection;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\Type;
 use Rector\TypePerfect\Reflection\MethodNodeAnalyser;
@@ -39,7 +41,7 @@ public function getNodeType(): string
 
     /**
      * @param ClassMethod $node
-     * @return string[]
+     * @return RuleError[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -68,7 +70,11 @@ public function processNode(Node $node, Scope $scope): array
             }
 
             // removed param type!
-            return [self::ERROR_MESSAGE];
+            return [
+                RuleErrorBuilder::message(self::ERROR_MESSAGE)
+                    ->identifier('typePerfect.noParamTypeRemoval')
+                    ->build(),
+            ];
         }
 
         return [];

diff --git a/src/Rules/ReturnNullOverFalseRule.php b/src/Rules/ReturnNullOverFalseRule.php
@@ -11,6 +11,8 @@
 use PhpParser\NodeFinder;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\BooleanType;
 use PHPStan\Type\Constant\ConstantBooleanType;
 use Rector\TypePerfect\Configuration;
@@ -44,7 +46,7 @@ public function getNodeType(): string
 
     /**
      * @param ClassMethod $node
-     * @return string[]
+     * @return RuleError[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -90,7 +92,9 @@ public function processNode(Node $node, Scope $scope): array
 
         if (! $hasTrueType && $hasFalseType) {
             return [
-                self::ERROR_MESSAGE,
+                RuleErrorBuilder::message(self::ERROR_MESSAGE)
+                    ->identifier('typePerfect.nullOverFalse')
+                    ->build(),
             ];
         }
 

diff --git a/tests/Rules/NarrowPrivateClassMethodParamTypeRule/Fixture/SkipRecursive.php b/tests/Rules/NarrowPrivateClassMethodParamTypeRule/Fixture/SkipRecursive.php
@@ -13,15 +13,15 @@ class SkipRecursive
     /**
      * @param SomeStaticCall|MethodCall $node
      */
-    public function processNode(Node $node)
+    public function processNode(Node $node): void
     {
         $this->run($node);
     }
 
     /**
      * @param SomeStaticCall|MethodCall $node
      */
-    private function run(Node $node)
+    private function run(Node $node): void
     {
         if ($node->name instanceof MethodCall) {
             $this->run($node->name);