RegisteredRule attribute

ondrejmirtes · ondrejmirtes · commit ca797f1371b6 · 2025-06-05T09:39:48.000+02:00
diff --git a/conf/config.level0.neon b/conf/config.level0.neon
@@ -2,7 +2,6 @@ parameters:
 	customRulesetUsed: false
 
 rules:
-	- PHPStan\Rules\Api\ApiInstanceofRule
 	- PHPStan\Rules\Api\ApiInstanceofTypeRule
 	- PHPStan\Rules\Api\ApiInstantiationRule
 	- PHPStan\Rules\Api\ApiClassConstFetchRule
@@ -103,6 +102,10 @@ rules:
 	- PHPStan\Rules\Variables\UnsetRule
 	- PHPStan\Rules\Whitespace\FileWhitespaceRule
 
+autowiredAttributeServices:
+	# registers rules with #[RegisteredRule] attribute
+	level: 0
+
 conditionalTags:
 	PHPStan\Rules\InternalTag\RestrictedInternalClassConstantUsageExtension:
 		phpstan.restrictedClassConstantUsageExtension: %featureToggles.internalTag%
diff --git a/conf/config.level1.neon b/conf/config.level1.neon
@@ -14,6 +14,10 @@ rules:
 	- PHPStan\Rules\Variables\IssetRule
 	- PHPStan\Rules\Variables\NullCoalesceRule
 
+autowiredAttributeServices:
+	# registers rules with #[RegisteredRule] attribute
+	level: 1
+
 services:
 	-
 		class: PHPStan\Rules\Constants\ConstantRule
diff --git a/conf/config.level10.neon b/conf/config.level10.neon
@@ -3,3 +3,7 @@ includes:
 
 parameters:
 	checkImplicitMixed: true
+
+autowiredAttributeServices:
+	# registers rules with #[RegisteredRule] attribute
+	level: 10
diff --git a/conf/config.level2.neon b/conf/config.level2.neon
@@ -67,6 +67,10 @@ rules:
 	- PHPStan\Rules\Pure\PureFunctionRule
 	- PHPStan\Rules\Pure\PureMethodRule
 
+autowiredAttributeServices:
+	# registers rules with #[RegisteredRule] attribute
+	level: 2
+
 conditionalTags:
 	PHPStan\Rules\InternalTag\RestrictedInternalPropertyUsageExtension:
 		phpstan.restrictedPropertyUsageExtension: %featureToggles.internalTag%
diff --git a/conf/config.level3.neon b/conf/config.level3.neon
@@ -27,6 +27,10 @@ rules:
 	- PHPStan\Rules\Variables\ParameterOutExecutionEndTypeRule
 	- PHPStan\Rules\Variables\VariableCloningRule
 
+autowiredAttributeServices:
+	# registers rules with #[RegisteredRule] attribute
+	level: 3
+
 parameters:
 	checkPhpDocMethodSignatures: true
 
diff --git a/conf/config.level4.neon b/conf/config.level4.neon
@@ -26,6 +26,10 @@ rules:
 	- PHPStan\Rules\TooWideTypehints\TooWidePropertyTypeRule
 	- PHPStan\Rules\Traits\NotAnalysedTraitRule
 
+autowiredAttributeServices:
+	# registers rules with #[RegisteredRule] attribute
+	level: 4
+
 conditionalTags:
 	PHPStan\Rules\Exceptions\TooWideFunctionThrowTypeRule:
 		phpstan.rules.rule: %exceptions.check.tooWideThrowType%
diff --git a/conf/config.level5.neon b/conf/config.level5.neon
@@ -17,6 +17,10 @@ rules:
 	- PHPStan\Rules\Functions\SortParameterCastableToStringRule
 	- PHPStan\Rules\Regexp\RegularExpressionQuotingRule
 
+autowiredAttributeServices:
+	# registers rules with #[RegisteredRule] attribute
+	level: 5
+
 services:
 	-
 		class: PHPStan\Rules\Functions\RandomIntParametersRule
diff --git a/conf/config.level6.neon b/conf/config.level6.neon
@@ -13,3 +13,7 @@ rules:
 	- PHPStan\Rules\Methods\MissingMethodReturnTypehintRule
 	- PHPStan\Rules\Methods\MissingMethodSelfOutTypeRule
 	- PHPStan\Rules\Properties\MissingPropertyTypehintRule
+
+autowiredAttributeServices:
+	# registers rules with #[RegisteredRule] attribute
+	level: 6
diff --git a/conf/config.level7.neon b/conf/config.level7.neon
@@ -4,3 +4,7 @@ includes:
 parameters:
 	checkUnionTypes: true
 	reportMaybes: true
+
+autowiredAttributeServices:
+	# registers rules with #[RegisteredRule] attribute
+	level: 7
diff --git a/conf/config.level8.neon b/conf/config.level8.neon
@@ -3,3 +3,7 @@ includes:
 
 parameters:
 	checkNullables: true
+
+autowiredAttributeServices:
+	# registers rules with #[RegisteredRule] attribute
+	level: 8
diff --git a/conf/config.level9.neon b/conf/config.level9.neon
@@ -3,3 +3,7 @@ includes:
 
 parameters:
 	checkExplicitMixed: true
+
+autowiredAttributeServices:
+	# registers rules with #[RegisteredRule] attribute
+	level: 9
diff --git a/conf/config.neon b/conf/config.neon
@@ -218,6 +218,9 @@ extensions:
 	autowiredAttributeServices: PHPStan\DependencyInjection\AutowiredAttributeServicesExtension
 	validateServiceTags: PHPStan\DependencyInjection\ValidateServiceTagsExtension
 
+autowiredAttributeServices:
+	level: null
+
 conditionalTags:
 	PHPStan\Rules\Exceptions\MissingCheckedExceptionInFunctionThrowsRule:
 		phpstan.rules.rule: %exceptions.check.missingCheckedExceptionInThrows%
diff --git a/src/DependencyInjection/AutowiredAttributeServicesExtension.php b/src/DependencyInjection/AutowiredAttributeServicesExtension.php
@@ -6,25 +6,35 @@
 use Nette\DI\Definitions\Reference;
 use Nette\DI\Definitions\ServiceDefinition;
 use Nette\DI\Helpers;
+use Nette\Schema\Expect;
+use Nette\Schema\Schema;
 use Nette\Utils\Strings;
 use olvlvl\ComposerAttributeCollector\Attributes;
 use olvlvl\ComposerAttributeCollector\TargetMethodParameter;
+use PHPStan\Rules\LazyRegistry;
 use ReflectionClass;
+use stdClass;
 use function strtolower;
 use function substr;
 
 final class AutowiredAttributeServicesExtension extends CompilerExtension
 {
 
+	public function getConfigSchema(): Schema
+	{
+		return Expect::structure([
+			'level' => Expect::int()->nullable()->required(),
+		]);
+	}
+
 	public function loadConfiguration(): void
 	{
 		require_once __DIR__ . '/../../vendor/attributes.php';
-		$autowiredServiceClasses = Attributes::findTargetClasses(AutowiredService::class);
 		$builder = $this->getContainerBuilder();
 
 		$autowiredParameters = Attributes::findTargetMethodParameters(AutowiredParameter::class);
 
-		foreach ($autowiredServiceClasses as $class) {
+		foreach (Attributes::findTargetClasses(AutowiredService::class) as $class) {
 			$reflection = new ReflectionClass($class->name);
 			$attribute = $class->attribute;
 
@@ -42,6 +52,24 @@ public function loadConfiguration(): void
 				$definition->addTag($tag);
 			}
 		}
+
+		/** @var stdClass&object{level: int|null} $config */
+		$config = $this->getConfig();
+		if ($config->level === null) {
+			return;
+		}
+
+		foreach (Attributes::findTargetClasses(RegisteredRule::class) as $class) {
+			$attribute = $class->attribute;
+			if ($attribute->level > $config->level) {
+				continue;
+			}
+
+			$builder->addDefinition(null)
+				->setFactory($class->name)
+				->setAutowired($class->name)
+				->addTag(LazyRegistry::RULE_TAG);
+		}
 	}
 
 	/**
diff --git a/src/DependencyInjection/RegisteredRule.php b/src/DependencyInjection/RegisteredRule.php
@@ -0,0 +1,21 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\DependencyInjection;
+
+use Attribute;
+
+/**
+ * Registers a rule in the DI container on the set rule level.
+ *
+ * Works thanks to https://github.com/ondrejmirtes/composer-attribute-collector
+ * and AutowiredAttributeServicesExtension.
+ */
+#[Attribute(flags: Attribute::TARGET_CLASS)]
+final class RegisteredRule
+{
+
+	public function __construct(public int $level)
+	{
+	}
+
+}
diff --git a/src/Rules/Api/ApiInstanceofRule.php b/src/Rules/Api/ApiInstanceofRule.php
@@ -4,6 +4,7 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\DependencyInjection\RegisteredRule;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\IdentifierRuleError;
@@ -19,6 +20,7 @@
 /**
  * @implements Rule<Node\Expr\Instanceof_>
  */
+#[RegisteredRule(level: 0)]
 final class ApiInstanceofRule implements Rule
 {
 
diff --git a/src/Rules/Classes/UnusedConstructorParametersRule.php b/src/Rules/Classes/UnusedConstructorParametersRule.php
@@ -6,6 +6,7 @@
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Param;
 use PHPStan\Analyser\Scope;
+use PHPStan\DependencyInjection\RegisteredRule;
 use PHPStan\Internal\SprintfHelper;
 use PHPStan\Node\InClassMethodNode;
 use PHPStan\Rules\Rule;
@@ -20,6 +21,7 @@
 /**
  * @implements Rule<InClassMethodNode>
  */
+#[RegisteredRule(level: 1)]
 final class UnusedConstructorParametersRule implements Rule
 {
 
