Add error identifiers (#49)

TomasVotruba · Dec 13, 2024 · 8f5752b · 8f5752b
1 parent 2ce1475
commit 8f5752b
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 /vendor
 composer.lock
 
+.idea
 /.phpunit.cache
diff --git a/src/Formatter/TypeCoverageFormatter.php b/src/Formatter/TypeCoverageFormatter.php
@@ -15,6 +15,7 @@ final class TypeCoverageFormatter
      */
     public function formatErrors(
         string $message,
+        string $identifier,
         float|int $minimalLevel,
         TypeCountAndMissingTypes $typeCountAndMissingTypes
     ): array {
@@ -42,6 +43,7 @@ public function formatErrors(
 
             foreach ($lines as $line) {
                 $ruleErrors[] = RuleErrorBuilder::message($errorMessage)
+                    ->identifier($identifier)
                     ->file($filePath)
                     ->line($line)
                     ->build();

diff --git a/src/Rules/ConstantTypeCoverageRule.php b/src/Rules/ConstantTypeCoverageRule.php
@@ -25,6 +25,11 @@
      */
     public const ERROR_MESSAGE = 'Out of %d possible constant types, only %d - %.1f %% actually have it. Add more constant types to get over %s %%';
 
+    /**
+     * @var string
+     */
+    private const IDENTIFIER = 'typeCoverage.constantTypeCoverage';
+
     public function __construct(
         private TypeCoverageFormatter $typeCoverageFormatter,
         private Configuration $configuration,
@@ -65,6 +70,7 @@ public function processNode(Node $node, Scope $scope): array
 
         return $this->typeCoverageFormatter->formatErrors(
             self::ERROR_MESSAGE,
+            self::IDENTIFIER,
             $this->configuration->getRequiredConstantTypeLevel(),
             $typeCountAndMissingTypes
         );

diff --git a/src/Rules/ParamTypeCoverageRule.php b/src/Rules/ParamTypeCoverageRule.php
@@ -25,6 +25,11 @@
      */
     public const ERROR_MESSAGE = 'Out of %d possible param types, only %d - %.1f %% actually have it. Add more param types to get over %s %%';
 
+    /**
+     * @var string
+     */
+    private const IDENTIFIER = 'typeCoverage.paramTypeCoverage';
+
     public function __construct(
         private TypeCoverageFormatter $typeCoverageFormatter,
         private Configuration $configuration,
@@ -66,6 +71,7 @@ public function processNode(Node $node, Scope $scope): array
 
         return $this->typeCoverageFormatter->formatErrors(
             self::ERROR_MESSAGE,
+            self::IDENTIFIER,
             $this->configuration->getRequiredParamTypeLevel(),
             $typeCountAndMissingTypes
         );

diff --git a/src/Rules/PropertyTypeCoverageRule.php b/src/Rules/PropertyTypeCoverageRule.php
@@ -25,6 +25,11 @@
      */
     public const ERROR_MESSAGE = 'Out of %d possible property types, only %d - %.1f %% actually have it. Add more property types to get over %s %%';
 
+    /**
+     * @var string
+     */
+    private const IDENTIFIER = 'typeCoverage.propertyTypeCoverage';
+
     public function __construct(
         private TypeCoverageFormatter $typeCoverageFormatter,
         private Configuration $configuration,
@@ -65,6 +70,7 @@ public function processNode(Node $node, Scope $scope): array
 
         return $this->typeCoverageFormatter->formatErrors(
             self::ERROR_MESSAGE,
+            self::IDENTIFIER,
             $this->configuration->getRequiredPropertyTypeLevel(),
             $typeCountAndMissingTypes
         );

diff --git a/src/Rules/ReturnTypeCoverageRule.php b/src/Rules/ReturnTypeCoverageRule.php
@@ -25,6 +25,11 @@
      */
     public const ERROR_MESSAGE = 'Out of %d possible return types, only %d - %.1f %% actually have it. Add more return types to get over %s %%';
 
+    /**
+     * @var string
+     */
+    private const IDENTIFIER = 'typeCoverage.returnTypeCoverage';
+
     public function __construct(
         private TypeCoverageFormatter $typeCoverageFormatter,
         private Configuration $configuration,
@@ -65,6 +70,7 @@ public function processNode(Node $node, Scope $scope): array
 
         return $this->typeCoverageFormatter->formatErrors(
             self::ERROR_MESSAGE,
+            self::IDENTIFIER,
             $this->configuration->getRequiredReturnTypeLevel(),
             $typeCountAndMissingTypes
         );