Added Rule error identifiers (#10)

* Added Rule error identifiers * Declare nikic/php-parser v4 dependency * Doing instanceof PHPStan\Type\TypeWithClassName is error-prone and deprecated. Use Type::getObjectClassNames() or Type::getObjectClassReflections() instead.
TomasVotruba · Dec 12, 2024 · 1c9472c · 1c9472c
1 parent 0362504
commit 1c9472c
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 19 deletions.
diff --git a/composer.json b/composer.json
@@ -5,7 +5,8 @@
     "license": "MIT",
     "require": {
         "php": "^8.2",
-        "phpstan/phpstan": "^1.10.50"
+        "phpstan/phpstan": "^1.10.50",
+        "nikic/php-parser": "^4"
     },
     "require-dev": {
         "phpstan/extension-installer": "^1.3",

diff --git a/src/Rules/ClassDependencyTreeRule.php b/src/Rules/ClassDependencyTreeRule.php
@@ -12,6 +12,7 @@
 use PHPStan\Reflection\ParameterReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\TypeWithClassName;
 use TomasVotruba\CognitiveComplexity\AstCognitiveComplexityAnalyzer;
 use TomasVotruba\CognitiveComplexity\ClassReflectionParser;
@@ -89,13 +90,13 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [
-            sprintf(
-                self::ERROR_MESSAGE,
-                $totaDependencyTreeComplexity,
-                $this->configuration->getMaxDependencyTreeComplexity()
-            ),
-        ];
+        $message = sprintf(
+            self::ERROR_MESSAGE,
+            $totaDependencyTreeComplexity,
+            $this->configuration->getMaxDependencyTreeComplexity()
+        );
+
+        return [RuleErrorBuilder::message($message)->identifier('complexity.dependencyTree')->build()];
     }
 
     private function isTypeToAnalyse(ClassReflection $classReflection): bool
@@ -112,15 +113,12 @@ private function isTypeToAnalyse(ClassReflection $classReflection): bool
     private function resolveParameterTypeClass(ParameterReflection $parameterReflection): ?Class_
     {
         $parameterType = $parameterReflection->getType();
-        if (! $parameterType instanceof TypeWithClassName) {
-            return null;
-        }
-
-        $parameterClassReflection = $parameterType->getClassReflection();
-        if (! $parameterClassReflection instanceof ClassReflection) {
+        $classReflections = $parameterType->getObjectClassReflections();
+        // XXX add support for union types
+        if (count($classReflections) !== 1) {
             return null;
         }
 
-        return $this->classReflectionParser->parse($parameterClassReflection);
+        return $this->classReflectionParser->parse($classReflections[0]);
     }
 }
diff --git a/src/Rules/ClassLikeCognitiveComplexityRule.php b/src/Rules/ClassLikeCognitiveComplexityRule.php
@@ -9,6 +9,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\InClassNode;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use TomasVotruba\CognitiveComplexity\AstCognitiveComplexityAnalyzer;
 use TomasVotruba\CognitiveComplexity\Configuration;
 
@@ -39,7 +40,6 @@ public function getNodeType(): string
 
     /**
      * @param InClassNode $node
-     * @return string[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -59,6 +59,6 @@ public function processNode(Node $node, Scope $scope): array
             $this->configuration->getMaxClassCognitiveComplexity()
         );
 
-        return [$message];
+        return [RuleErrorBuilder::message($message)->identifier('complexity.classLike')->build()];
     }
 }
diff --git a/src/Rules/FunctionLikeCognitiveComplexityRule.php b/src/Rules/FunctionLikeCognitiveComplexityRule.php
@@ -13,6 +13,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use TomasVotruba\CognitiveComplexity\AstCognitiveComplexityAnalyzer;
 use TomasVotruba\CognitiveComplexity\Configuration;
 use TomasVotruba\CognitiveComplexity\Exception\ShouldNotHappenException;
@@ -53,7 +54,6 @@ public function getNodeType(): string
 
     /**
      * @param FunctionLike $node
-     * @return string[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -75,7 +75,7 @@ public function processNode(Node $node, Scope $scope): array
             $this->configuration->getMaxFunctionCognitiveComplexity()
         );
 
-        return [$message];
+        return [RuleErrorBuilder::message($message)->identifier('complexity.functionLike')->build()];
     }
 
     private function resolveFunctionName(FunctionLike $functionLike, Scope $scope): string