Add rule identifiers

mglaman · mglaman · commit 53772ee6796d · 2024-09-27T16:21:00.000+02:00
diff --git a/src/Rules/Classes/ClassExtendsInternalClassRule.php b/src/Rules/Classes/ClassExtendsInternalClassRule.php
@@ -76,6 +76,7 @@ private function buildError(?string $currentClassName, string $extendedClassName
             '%s extends @internal class %s.',
             $currentClassName !== null ? sprintf('Class %s', $currentClassName) : 'Anonymous class',
             $extendedClassName
-        ));
+        ))
+            ->identifier('class.extendsInternalClass');
     }
 }
diff --git a/src/Rules/Classes/PluginManagerInspectionRule.php b/src/Rules/Classes/PluginManagerInspectionRule.php
@@ -6,6 +6,8 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\ObjectType;
 use function sprintf;
 
@@ -67,7 +69,9 @@ public function processNode(Node $node, Scope $scope): array
         }
 
         if (!$hasAlterInfoSet) {
-            $errors[] = 'Plugin definitions cannot be altered.';
+            $errors[] = RuleErrorBuilder::message('Plugin definitions cannot be altered.')
+                ->identifier('plugin.manager.alterInfoMissing')
+                ->build();
         }
 
         return $errors;
@@ -117,7 +121,9 @@ private function inspectYamlPluginManager(Node\Stmt\Class_ $class): array
         $constructor = $reflection->getConstructor();
 
         if ($constructor->getDeclaringClass()->getName() !== $fqn) {
-            $errors[] = sprintf('%s must override __construct if using YAML plugins.', $fqn);
+            $errors[] = RuleErrorBuilder::message(sprintf('%s must override __construct if using YAML plugins.', $fqn))
+                ->identifier('plugin.manager.yamlPluginConstructor')
+                ->build();
         } else {
             foreach ($class->stmts as $stmt) {
                 if ($stmt instanceof Node\Stmt\ClassMethod && $stmt->name->toString() === '__construct') {
@@ -130,7 +136,9 @@ private function inspectYamlPluginManager(Node\Stmt\Class_ $class): array
                             && ((string)$constructorStmt->class === 'parent')
                             && $constructorStmt->name instanceof Node\Identifier
                             && $constructorStmt->name->name === '__construct') {
-                            $errors[] = sprintf('YAML plugin managers should not invoke its parent constructor.');
+                            $errors[] = RuleErrorBuilder::message('YAML plugin managers should not invoke its parent constructor.')
+                                ->identifier('plugin.manager.yamlPluginConstructor')
+                                ->build();
                         }
                     }
                 }
diff --git a/src/Rules/Deprecations/AccessDeprecatedConstant.php b/src/Rules/Deprecations/AccessDeprecatedConstant.php
@@ -8,6 +8,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use function array_merge;
 use function explode;
 use function sprintf;
@@ -124,7 +125,9 @@ public function processNode(Node $node, Scope $scope): array
         $constantName = $this->reflectionProvider->resolveConstantName($node->name, $scope);
         if (isset($deprecatedConstants[$constantName])) {
             return [
-                sprintf('Call to deprecated constant %s: %s', $constantName, $deprecatedConstants[$constantName])
+                RuleErrorBuilder::message(sprintf('Call to deprecated constant %s: %s', $constantName, $deprecatedConstants[$constantName]))
+                ->identifier('constant.deprecated')
+                ->build()
             ];
         }
         return [];
diff --git a/src/Rules/Deprecations/ConditionManagerCreateInstanceContextConfigurationRule.php b/src/Rules/Deprecations/ConditionManagerCreateInstanceContextConfigurationRule.php
@@ -51,6 +51,7 @@ public function processNode(Node $node, Scope $scope): array
                 return [
                     RuleErrorBuilder::message('Passing context values to plugins via configuration is deprecated in drupal:9.1.0 and will be removed before drupal:10.0.0. Instead, call ::setContextValue() on the plugin itself. See https://www.drupal.org/node/3120980')
                         ->line($node->getStartLine())
+                        ->identifier('drupal.deprecated.pluginConfigurationContextKey')
                         ->build()
                 ];
             }
diff --git a/src/Rules/Deprecations/ConfigEntityConfigExportRule.php b/src/Rules/Deprecations/ConfigEntityConfigExportRule.php
@@ -7,6 +7,7 @@
 use PHPStan\PhpDoc\ResolvedPhpDocBlock;
 use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
 use PHPStan\Reflection\ClassReflection;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
 use function preg_match;
 
@@ -32,7 +33,9 @@ protected function doProcessNode(ClassReflection $reflection, Node\Stmt\Class_ $
         }
         if ($hasMatch === 0) {
             return [
-                'Configuration entity must define a `config_export` key. See https://www.drupal.org/node/2481909',
+                RuleErrorBuilder::message('Configuration entity must define a `config_export` key. See https://www.drupal.org/node/2481909')
+                    ->identifier('drupal.deprecated.configEntityConfigExportKey')
+                    ->build(),
             ];
         }
         return [];
diff --git a/src/Rules/Deprecations/DeprecatedHookImplementation.php b/src/Rules/Deprecations/DeprecatedHookImplementation.php
@@ -98,7 +98,7 @@ private function buildError(string $function_name, string $hook_name, ?string $d
         return [
             RuleErrorBuilder::message(
                 "Function $function_name implements $hook_name which is deprecated$deprecated_description",
-            )->build()
+            )->identifier('drupal.deprecated.hook')->build()
         ];
     }
 }
diff --git a/src/Rules/Deprecations/GetDeprecatedServiceRule.php b/src/Rules/Deprecations/GetDeprecatedServiceRule.php
@@ -7,6 +7,7 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 
 /**
  * @implements Rule<Node\Expr\MethodCall>
@@ -57,7 +58,11 @@ public function processNode(Node $node, Scope $scope): array
 
         $service = $this->serviceMap->getService($serviceName->value);
         if (($service instanceof DrupalServiceDefinition) && $service->isDeprecated()) {
-            return [$service->getDeprecatedDescription()];
+            return [
+                RuleErrorBuilder::message($service->getDeprecatedDescription())
+                    ->identifier('drupal.deprecated.service')
+                    ->build()
+            ];
         }
 
         return [];
diff --git a/src/Rules/Deprecations/PluginAnnotationContextDefinitionsRule.php b/src/Rules/Deprecations/PluginAnnotationContextDefinitionsRule.php
@@ -5,6 +5,7 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ClassReflection;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
 use function preg_match;
 
@@ -30,7 +31,9 @@ protected function doProcessNode(ClassReflection $reflection, Node\Stmt\Class_ $
         }
         if ($hasMatch === 1) {
             return [
-                'Providing context definitions via the "context" key is deprecated in Drupal 8.7.x and will be removed before Drupal 9.0.0. Use the "context_definitions" key instead.',
+                RuleErrorBuilder::message('Providing context definitions via the "context" key is deprecated in Drupal 8.7.x and will be removed before Drupal 9.0.0. Use the "context_definitions" key instead.')
+                    ->identifier('drupal.deprecated.pluginAnnotationContextKey')
+                    ->build(),
             ];
         }
         return [];
diff --git a/src/Rules/Deprecations/StaticServiceDeprecatedServiceRule.php b/src/Rules/Deprecations/StaticServiceDeprecatedServiceRule.php
@@ -7,6 +7,7 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 
 /**
  * @implements Rule<Node\Expr\StaticCall>
@@ -66,7 +67,11 @@ public function processNode(Node $node, Scope $scope): array
 
         $service = $this->serviceMap->getService($serviceName->value);
         if (($service instanceof DrupalServiceDefinition) && $service->isDeprecated()) {
-            return [$service->getDeprecatedDescription()];
+            return [
+                RuleErrorBuilder::message($service->getDeprecatedDescription())
+                    ->identifier('drupal.deprecated.service')
+                    ->build()
+            ];
         }
 
         return [];
diff --git a/src/Rules/Deprecations/SymfonyCmfRouteObjectInterfaceConstantsRule.php b/src/Rules/Deprecations/SymfonyCmfRouteObjectInterfaceConstantsRule.php
@@ -60,14 +60,20 @@ public function processNode(Node $node, Scope $scope): array
             return [
                 RuleErrorBuilder::message(
                     sprintf('The core dependency symfony-cmf/routing is deprecated and %s::%s is not supported.', $className, $constantName)
-                )->tip('Change record: https://www.drupal.org/node/3151009')->build(),
+                )
+                    ->tip('Change record: https://www.drupal.org/node/3151009')
+                    ->identifier('drupal.deprecated.dependency')
+                    ->build(),
             ];
         }
 
         return [
             RuleErrorBuilder::message(
                 sprintf('%s::%s is deprecated and removed in Drupal 10. Use \Drupal\Core\Routing\RouteObjectInterface::%2$s instead.', $className, $constantName)
-            )->tip('Change record: https://www.drupal.org/node/3151009')->build(),
+            )
+                ->tip('Change record: https://www.drupal.org/node/3151009')
+                ->identifier('drupal.deprecated.class')
+                ->build(),
         ];
     }
 }
diff --git a/src/Rules/Deprecations/SymfonyCmfRoutingInClassMethodSignatureRule.php b/src/Rules/Deprecations/SymfonyCmfRoutingInClassMethodSignatureRule.php
@@ -58,6 +58,7 @@ public function processNode(Node $node, Scope $scope): array
             foreach ($parameter->getType()->getReferencedClasses() as $referencedClass) {
                 $referencedClassType = new ObjectType($referencedClass);
                 if ($cmfRouteObjectInterfaceType->equals($referencedClassType)) {
+                    // @todo identifier
                     $errors[] = RuleErrorBuilder::message(
                         sprintf(
                             $errorMessage,
@@ -68,6 +69,7 @@ public function processNode(Node $node, Scope $scope): array
                         )
                     )->tip('Change record: https://www.drupal.org/node/3151009')->build();
                 } elseif ($cmfRouteProviderInterfaceType->equals($referencedClassType)) {
+                    // @todo identifier
                     $errors[] = RuleErrorBuilder::message(
                         sprintf(
                             $errorMessage,
@@ -78,6 +80,7 @@ public function processNode(Node $node, Scope $scope): array
                         )
                     )->tip('Change record: https://www.drupal.org/node/3151009')->build();
                 } elseif ($cmfLazyRouteCollectionType->equals($referencedClassType)) {
+                    // @todo identifier
                     $errors[] = RuleErrorBuilder::message(
                         sprintf(
                             $errorMessage,
@@ -96,6 +99,7 @@ public function processNode(Node $node, Scope $scope): array
         foreach ($returnClasses as $returnClass) {
             $returnType = new ObjectType($returnClass);
             if ($cmfRouteObjectInterfaceType->equals($returnType)) {
+                // @todo identifier
                 $errors[] = RuleErrorBuilder::message(
                     sprintf(
                         $errorMessage,
@@ -106,6 +110,7 @@ public function processNode(Node $node, Scope $scope): array
                     )
                 )->tip('Change record: https://www.drupal.org/node/3151009')->build();
             } elseif ($cmfRouteProviderInterfaceType->equals($returnType)) {
+                // @todo identifier
                 $errors[] = RuleErrorBuilder::message(
                     sprintf(
                         $errorMessage,
@@ -116,6 +121,7 @@ public function processNode(Node $node, Scope $scope): array
                     )
                 )->tip('Change record: https://www.drupal.org/node/3151009')->build();
             } elseif ($cmfLazyRouteCollectionType->equals($returnType)) {
+                // @todo identifier
                 $errors[] = RuleErrorBuilder::message(
                     sprintf(
                         $errorMessage,
diff --git a/src/Rules/Drupal/AccessResultConditionRule.php b/src/Rules/Drupal/AccessResultConditionRule.php
@@ -65,6 +65,7 @@ public function processNode(Node $node, Scope $scope): array
             $rightType = $this->treatPhpDocTypesAsCertain ? $scope->getType($condition->right) : $scope->getNativeType($condition->right);
 
             return [
+                // @todo identifier
                 RuleErrorBuilder::message(sprintf(
                     'Strict comparison using %s between %s and %s will always evaluate to %s.',
                     $condition->getOperatorSigil(),
diff --git a/src/Rules/Drupal/Coder/DiscouragedFunctionsRule.php b/src/Rules/Drupal/Coder/DiscouragedFunctionsRule.php
@@ -56,6 +56,7 @@ public function processNode(Node $node, Scope $scope): array
         ];
 
         if (in_array($name, $discouragedFunctions, true)) {
+            // @todo identifier
             return [sprintf('Calls to function %s should not exist.', $name)];
         }
         return [];
diff --git a/src/Rules/Drupal/DependencySerializationTraitPropertyRule.php b/src/Rules/Drupal/DependencySerializationTraitPropertyRule.php
@@ -30,6 +30,7 @@ public function processNode(Node $node, Scope $scope): array
 
         $errors = [];
         if ($node->isPrivate()) {
+            // @todo identifier
             $errors[] = RuleErrorBuilder::message(
                 sprintf(
                     '%s does not support private properties.',
@@ -38,6 +39,7 @@ public function processNode(Node $node, Scope $scope): array
             )->tip('See https://www.drupal.org/node/3110266')->build();
         }
         if ($node->isReadOnly()) {
+            // @todo identifier
             $errors[] = RuleErrorBuilder::message(
                 sprintf(
                     'Read-only properties are incompatible with %s.',
diff --git a/src/Rules/Drupal/EntityQuery/EntityQueryHasAccessCheckRule.php b/src/Rules/Drupal/EntityQuery/EntityQueryHasAccessCheckRule.php
@@ -44,6 +44,7 @@ public function processNode(Node $node, Scope $scope): array
         }
 
         return [
+            // @todo identifier
             RuleErrorBuilder::message(
                 'Relying on entity queries to check access by default is deprecated in drupal:9.2.0 and an error will be thrown from drupal:10.0.0. Call \Drupal\Core\Entity\Query\QueryInterface::accessCheck() with TRUE or FALSE to specify whether access should be checked.'
             )->tip('See https://www.drupal.org/node/3201242')->build(),
diff --git a/src/Rules/Drupal/GlobalDrupalDependencyInjectionRule.php b/src/Rules/Drupal/GlobalDrupalDependencyInjectionRule.php
@@ -71,6 +71,7 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
+        // @todo identifier
         return [
             '\Drupal calls should be avoided in classes, use dependency injection instead'
         ];
diff --git a/src/Rules/Drupal/LoadIncludes.php b/src/Rules/Drupal/LoadIncludes.php
@@ -53,6 +53,7 @@ public function processNode(Node $node, Scope $scope): array
             $module = $this->extensionMap->getModule($moduleName);
             if ($module === null) {
                 return [
+                    // @todo identifier
                     RuleErrorBuilder::message(sprintf(
                         'File %s could not be loaded from %s::loadInclude because %s module is not found.',
                         $filename,
@@ -80,6 +81,7 @@ public function processNode(Node $node, Scope $scope): array
             ];
         } catch (Throwable $e) {
             return [
+                // @todo identifier
                 RuleErrorBuilder::message(sprintf(
                     'A file could not be loaded from %s::loadInclude',
                     ModuleHandlerInterface::class
diff --git a/src/Rules/Drupal/ModuleLoadInclude.php b/src/Rules/Drupal/ModuleLoadInclude.php
@@ -47,6 +47,7 @@ public function processNode(Node $node, Scope $scope): array
             $module = $this->extensionMap->getModule($moduleName);
             if ($module === null) {
                 return [
+                    // @todo identifier
                     RuleErrorBuilder::message(sprintf(
                         'File %s could not be loaded from module_load_include because %s module is not found.',
                         $filename,
@@ -62,6 +63,7 @@ public function processNode(Node $node, Scope $scope): array
                 return [];
             }
             return [
+                // @todo identifier
                 RuleErrorBuilder::message(sprintf(
                     'File %s could not be loaded from module_load_include.',
                     $module->getPath() . '/' . $filename
@@ -71,6 +73,7 @@ public function processNode(Node $node, Scope $scope): array
             ];
         } catch (Throwable $e) {
             return [
+                // @todo identifier
                 RuleErrorBuilder::message('A file could not be loaded from module_load_include')
                     ->line($node->getStartLine())
                     ->build()
diff --git a/src/Rules/Drupal/PluginManager/PluginManagerSetsCacheBackendRule.php b/src/Rules/Drupal/PluginManager/PluginManagerSetsCacheBackendRule.php
@@ -88,9 +88,11 @@ public function processNode(Node $node, Scope $scope): array
 
         $errors = [];
         if (!$hasCacheBackendSet) {
+            // @todo identifier
             $errors[] = 'Missing cache backend declaration for performance.';
         }
         foreach ($misnamedCacheTagWarnings as $cacheTagWarning) {
+            // @todo identifier
             $errors[] = sprintf('%s cache tag might be unclear and does not contain the cache key in it.', $cacheTagWarning);
         }
 
diff --git a/src/Rules/Drupal/RenderCallbackRule.php b/src/Rules/Drupal/RenderCallbackRule.php
diff --git a/src/Rules/Drupal/RequestStackGetMainRequestRule.php b/src/Rules/Drupal/RequestStackGetMainRequestRule.php
diff --git a/src/Rules/Drupal/TestClassesProtectedPropertyModulesRule.php b/src/Rules/Drupal/TestClassesProtectedPropertyModulesRule.php
diff --git a/src/Rules/Drupal/Tests/BrowserTestBaseDefaultThemeRule.php b/src/Rules/Drupal/Tests/BrowserTestBaseDefaultThemeRule.php
diff --git a/src/Rules/Drupal/Tests/TestClassSuffixNameRule.php b/src/Rules/Drupal/Tests/TestClassSuffixNameRule.php

Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,7 @@ private function buildError(?string $currentClassName, string $extendedClassName`
`76`	`76`	`'%s extends @internal class %s.',`
`77`	`77`	`$currentClassName !== null ? sprintf('Class %s', $currentClassName) : 'Anonymous class',`
`78`	`78`	`$extendedClassName`
`79`		`- ));`
	`79`	`+ ))`
	`80`	`+ ->identifier('class.extendsInternalClass');`
`80`	`81`	`}`
`81`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@ public function processNode(Node $node, Scope $scope): array`
`51`	`51`	`return [`
`52`	`52`	`RuleErrorBuilder::message('Passing context values to plugins via configuration is deprecated in drupal:9.1.0 and will be removed before drupal:10.0.0. Instead, call ::setContextValue() on the plugin itself. See https://www.drupal.org/node/3120980')`
`53`	`53`	`->line($node->getStartLine())`
	`54`	`+ ->identifier('drupal.deprecated.pluginConfigurationContextKey')`
`54`	`55`	`->build()`
`55`	`56`	`];`
`56`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ private function buildError(string $function_name, string $hook_name, ?string $d`
`98`	`98`	`return [`
`99`	`99`	`RuleErrorBuilder::message(`
`100`	`100`	`"Function $function_name implements $hook_name which is deprecated$deprecated_description",`
`101`		`- )->build()`
	`101`	`+ )->identifier('drupal.deprecated.hook')->build()`
`102`	`102`	`];`
`103`	`103`	`}`
`104`	`104`	`}`