#[RegisteredCollector] attribute

Author: ondrejmirtes

conf/config.level4.neon

@@ -2,7 +2,7 @@ includes:
 	- config.level3.neon
 
 autowiredAttributeServices:
-	# registers rules with #[RegisteredRule] attribute
+	# registers rules with #[RegisteredRule] and #[RegisteredCollector] attributes
 	level: 4
 
 conditionalTags:
@@ -17,41 +17,6 @@ parameters:
 	checkAdvancedIsset: true
 
 services:
-	-
-		class: PHPStan\Rules\DeadCode\ConstructorWithoutImpurePointsCollector
-		tags:
-			- phpstan.collector
-
-	-
-		class: PHPStan\Rules\DeadCode\PossiblyPureNewCollector
-		tags:
-			- phpstan.collector
-
-	-
-		class: PHPStan\Rules\DeadCode\FunctionWithoutImpurePointsCollector
-		tags:
-			 - phpstan.collector
-
-	-
-		class: PHPStan\Rules\DeadCode\PossiblyPureFuncCallCollector
-		tags:
-			 - phpstan.collector
-
-	-
-		class: PHPStan\Rules\DeadCode\MethodWithoutImpurePointsCollector
-		tags:
-			 - phpstan.collector
-
-	-
-		class: PHPStan\Rules\DeadCode\PossiblyPureMethodCallCollector
-		tags:
-			 - phpstan.collector
-
-	-
-		class: PHPStan\Rules\DeadCode\PossiblyPureStaticCallCollector
-		tags:
-			 - phpstan.collector
-
 	-
 		class: PHPStan\Rules\Exceptions\TooWideFunctionThrowTypeRule
 
@@ -60,13 +25,3 @@ services:
 
 	-
 		class: PHPStan\Rules\Exceptions\TooWidePropertyHookThrowTypeRule
-
-	-
-		class: PHPStan\Rules\Traits\TraitDeclarationCollector
-		tags:
-			- phpstan.collector
-
-	-
-		class: PHPStan\Rules\Traits\TraitUseCollector
-		tags:
-			- phpstan.collector

src/DependencyInjection/AutowiredAttributeServicesExtension.php

@@ -11,6 +11,7 @@
 use Nette\Utils\Strings;
 use olvlvl\ComposerAttributeCollector\Attributes;
 use olvlvl\ComposerAttributeCollector\TargetMethodParameter;
+use PHPStan\Collectors\RegistryFactory;
 use PHPStan\Rules\LazyRegistry;
 use ReflectionClass;
 use stdClass;
@@ -72,6 +73,20 @@ public function loadConfiguration(): void
 
 			$this->processParameters($class->name, $definition, $autowiredParameters);
 		}
+
+		foreach (Attributes::findTargetClasses(RegisteredCollector::class) as $class) {
+			$attribute = $class->attribute;
+			if ($attribute->level > $config->level) {
+				continue;
+			}
+
+			$definition = $builder->addDefinition(null)
+				->setFactory($class->name)
+				->setAutowired($class->name)
+				->addTag(RegistryFactory::COLLECTOR_TAG);
+
+			$this->processParameters($class->name, $definition, $autowiredParameters);
+		}
 	}
 
 	/**

src/DependencyInjection/AutowiredParameter.php

@@ -5,7 +5,8 @@
 use Attribute;
 
 /**
- * Autowires constructor parameters in service classes using #[AutowiredService] or #[RegisteredRule] attributes.
+ * Autowires constructor parameters in service classes using #[AutowiredService],
+ * #[RegisteredRule] or #[RegisteredCollector] attributes.
  *
  * If ref is omitted, it looks for parameter of the same name.
  *

src/DependencyInjection/RegisteredCollector.php

@@ -0,0 +1,21 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\DependencyInjection;
+
+use Attribute;
+
+/**
+ * Registers a collector 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 RegisteredCollector
+{
+
+	public function __construct(public int $level)
+	{
+	}
+
+}

src/Rules/DeadCode/ConstructorWithoutImpurePointsCollector.php

@@ -5,12 +5,14 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Collectors\Collector;
+use PHPStan\DependencyInjection\RegisteredCollector;
 use PHPStan\Node\MethodReturnStatementsNode;
 use function count;
 
 /**
  * @implements Collector<MethodReturnStatementsNode, string>
  */
+#[RegisteredCollector(level: 4)]
 final class ConstructorWithoutImpurePointsCollector implements Collector
 {
 

src/Rules/DeadCode/FunctionWithoutImpurePointsCollector.php

@@ -5,12 +5,14 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Collectors\Collector;
+use PHPStan\DependencyInjection\RegisteredCollector;
 use PHPStan\Node\FunctionReturnStatementsNode;
 use function count;
 
 /**
  * @implements Collector<FunctionReturnStatementsNode, string>
  */
+#[RegisteredCollector(level: 4)]
 final class FunctionWithoutImpurePointsCollector implements Collector
 {
 

src/Rules/DeadCode/MethodWithoutImpurePointsCollector.php

@@ -5,12 +5,14 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Collectors\Collector;
+use PHPStan\DependencyInjection\RegisteredCollector;
 use PHPStan\Node\MethodReturnStatementsNode;
 use function count;
 
 /**
  * @implements Collector<MethodReturnStatementsNode, array{class-string, string, string}>
  */
+#[RegisteredCollector(level: 4)]
 final class MethodWithoutImpurePointsCollector implements Collector
 {
 

src/Rules/DeadCode/PossiblyPureFuncCallCollector.php

@@ -6,11 +6,13 @@
 use PhpParser\Node\Stmt\Expression;
 use PHPStan\Analyser\Scope;
 use PHPStan\Collectors\Collector;
+use PHPStan\DependencyInjection\RegisteredCollector;
 use PHPStan\Reflection\ReflectionProvider;
 
 /**
  * @implements Collector<Node\Stmt\Expression, array{string, int}>
  */
+#[RegisteredCollector(level: 4)]
 final class PossiblyPureFuncCallCollector implements Collector
 {
 

src/Rules/DeadCode/PossiblyPureMethodCallCollector.php

@@ -6,10 +6,12 @@
 use PhpParser\Node\Stmt\Expression;
 use PHPStan\Analyser\Scope;
 use PHPStan\Collectors\Collector;
+use PHPStan\DependencyInjection\RegisteredCollector;
 
 /**
  * @implements Collector<Node\Stmt\Expression, array{non-empty-list<class-string>, string, int}>
  */
+#[RegisteredCollector(level: 4)]
 final class PossiblyPureMethodCallCollector implements Collector
 {
 

src/Rules/DeadCode/PossiblyPureNewCollector.php

@@ -6,12 +6,14 @@
 use PhpParser\Node\Stmt\Expression;
 use PHPStan\Analyser\Scope;
 use PHPStan\Collectors\Collector;
+use PHPStan\DependencyInjection\RegisteredCollector;
 use PHPStan\Reflection\ReflectionProvider;
 use function strtolower;
 
 /**
  * @implements Collector<Expression, array{string, int}>
  */
+#[RegisteredCollector(level: 4)]
 final class PossiblyPureNewCollector implements Collector
 {
 

src/Rules/DeadCode/PossiblyPureStaticCallCollector.php

@@ -6,10 +6,12 @@
 use PhpParser\Node\Stmt\Expression;
 use PHPStan\Analyser\Scope;
 use PHPStan\Collectors\Collector;
+use PHPStan\DependencyInjection\RegisteredCollector;
 
 /**
  * @implements Collector<Node\Stmt\Expression, array{class-string, string, int}>
  */
+#[RegisteredCollector(level: 4)]
 final class PossiblyPureStaticCallCollector implements Collector
 {
 

src/Rules/Traits/TraitDeclarationCollector.php

@@ -5,10 +5,12 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Collectors\Collector;
+use PHPStan\DependencyInjection\RegisteredCollector;
 
 /**
  * @implements Collector<Node\Stmt\Trait_, array{string, int}>
  */
+#[RegisteredCollector(level: 4)]
 final class TraitDeclarationCollector implements Collector
 {
 

src/Rules/Traits/TraitUseCollector.php

@@ -5,12 +5,14 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Collectors\Collector;
+use PHPStan\DependencyInjection\RegisteredCollector;
 use function array_map;
 use function array_values;
 
 /**
  * @implements Collector<Node\Stmt\TraitUse, list<string>>
  */
+#[RegisteredCollector(level: 4)]
 final class TraitUseCollector implements Collector
 {