Add generics to AbstractRector, RectorInterface and ConfigurableRectorInterface

phpstan.neon

@@ -505,3 +505,10 @@ parameters:
         -
             message: '#"@\\simplexml_load_string\(\$junitXml\)" is forbidden to use#'
             path: scripts/remove-unused-deps.php
+
+        # It is difficult to make automatic type inference
+        -
+            message: '#^Method Rector\\Rector\\AbstractRector\:\:cloneNode\(\) should return TClonedNode of PhpParser\\Node but returns PhpParser\\Node\.$#'
+            identifier: return.type
+            count: 1
+            path: src/Rector/AbstractRector.php

rector.php

@@ -9,6 +9,7 @@
 use Rector\Php55\Rector\String_\StringClassNameToClassConstantRector;
 use Rector\Php84\Rector\Class_\DeprecatedAnnotationToDeprecatedAttributeRector;
 use Rector\Symfony\Symfony61\Rector\Class_\CommandConfigureToAttributeRector;
+use Rector\TypeDeclarationDocblocks\Rector\Class_\AddParamTypeToRefactorMethodRector;
 
 return RectorConfig::configure()
     ->withPreparedSets(
@@ -67,4 +68,7 @@
 
         // keep @deprecated annotation, as readable in IDE and tooling
         DeprecatedAnnotationToDeprecatedAttributeRector::class => [__DIR__ . '/src/Set/ValueObject/SetList.php'],
+
+        // This is no longer necessary, as generics have appeared in `AbstractRector`.
+        AddParamTypeToRefactorMethodRector::class,
     ]);

rules/Arguments/Rector/ClassMethod/ArgumentAdderRector.php

@@ -35,6 +35,8 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @extends AbstractRector<MethodCall|StaticCall|Class_>
+ * @implements ConfigurableRectorInterface<MethodCall|StaticCall|Class_>
  * @see \Rector\Tests\Arguments\Rector\ClassMethod\ArgumentAdderRector\ArgumentAdderRectorTest
  */
 final class ArgumentAdderRector extends AbstractRector implements ConfigurableRectorInterface
@@ -100,17 +102,11 @@ public function someMethod($value = true)
         );
     }
 
-    /**
-     * @return array<class-string<Node>>
-     */
     public function getNodeTypes(): array
     {
         return [MethodCall::class, StaticCall::class, Class_::class];
     }
 
-    /**
-     * @param MethodCall|StaticCall|Class_ $node
-     */
     public function refactor(Node $node): MethodCall|StaticCall|Class_|null
     {
         $this->hasChanged = false;

rules/Arguments/Rector/ClassMethod/ReplaceArgumentDefaultValueRector.php

@@ -19,6 +19,8 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @extends AbstractRector<MethodCall|StaticCall|ClassMethod|New_>
+ * @implements ConfigurableRectorInterface<MethodCall|StaticCall|ClassMethod|New_>
  * @api used in rector-symfony
  * @see \Rector\Tests\Arguments\Rector\ClassMethod\ReplaceArgumentDefaultValueRector\ReplaceArgumentDefaultValueRectorTest
  */
@@ -64,17 +66,11 @@ public function getRuleDefinition(): RuleDefinition
         );
     }
 
-    /**
-     * @return array<class-string<Node>>
-     */
     public function getNodeTypes(): array
     {
         return [MethodCall::class, StaticCall::class, ClassMethod::class, New_::class];
     }
 
-    /**
-     * @param MethodCall|StaticCall|ClassMethod|New_ $node
-     */
     public function refactor(Node $node): MethodCall|StaticCall|ClassMethod|New_|null
     {
         if ($node instanceof New_) {

rules/Arguments/Rector/FuncCall/FunctionArgumentDefaultValueReplacerRector.php

@@ -15,6 +15,8 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @extends AbstractRector<FuncCall>
+ * @implements ConfigurableRectorInterface<FuncCall>
  * @see \Rector\Tests\Arguments\Rector\FuncCall\FunctionArgumentDefaultValueReplacerRector\FunctionArgumentDefaultValueReplacerRectorTest
  */
 final class FunctionArgumentDefaultValueReplacerRector extends AbstractRector implements ConfigurableRectorInterface
@@ -47,17 +49,11 @@ public function getRuleDefinition(): RuleDefinition
         ]);
     }
 
-    /**
-     * @return array<class-string<Node>>
-     */
     public function getNodeTypes(): array
     {
         return [FuncCall::class];
     }
 
-    /**
-     * @param FuncCall $node
-     */
     public function refactor(Node $node): FuncCall|null
     {
         $hasChanged = false;

rules/Arguments/Rector/MethodCall/RemoveMethodCallParamRector.php

@@ -20,6 +20,8 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @extends AbstractRector<MethodCall|StaticCall>
+ * @implements ConfigurableRectorInterface<MethodCall|StaticCall>
  * @note used extensively https://github.com/search?q=RemoveMethodCallParamRector%3A%3Aclass+language%3APHP&type=code&l=PHP
  * @see \Rector\Tests\Arguments\Rector\MethodCall\RemoveMethodCallParamRector\RemoveMethodCallParamRectorTest
  */
@@ -65,17 +67,11 @@ public function run(Caller $caller)
         ]);
     }
 
-    /**
-     * @return array<class-string<Node>>
-     */
     public function getNodeTypes(): array
     {
         return [MethodCall::class, StaticCall::class];
     }
 
-    /**
-     * @param MethodCall|StaticCall $node
-     */
     public function refactor(Node $node): ?Node
     {
         $hasChanged = false;

rules/Assert/Rector/ClassMethod/AddAssertArrayFromClassMethodDocblockRector.php

@@ -34,6 +34,8 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * @extends AbstractRector<ClassMethod>
+ * @implements ConfigurableRectorInterface<ClassMethod>
  * @experimental Check generic array key/value types in runtime with assert. Generics for impatient people.
  *
  * @see \Rector\Tests\Assert\Rector\ClassMethod\AddAssertArrayFromClassMethodDocblockRector\AddAssertArrayFromClassMethodDocblockRectorTest
@@ -98,9 +100,6 @@ public function getNodeTypes(): array
         return [ClassMethod::class];
     }
 
-    /**
-     * @param ClassMethod $node
-     */
     public function refactor(Node $node): ?ClassMethod
     {
         $scope = ScopeFetcher::fetch($node);

rules/Carbon/Rector/FuncCall/DateFuncCallToCarbonRector.php

@@ -20,6 +20,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @extends AbstractRector<Minus|FuncCall>
  * @see \Rector\Tests\Carbon\Rector\FuncCall\DateFuncCallToCarbonRector\DateFuncCallToCarbonRectorTest
  */
 final class DateFuncCallToCarbonRector extends AbstractRector
@@ -59,17 +60,11 @@ public function run()
         ]);
     }
 
-    /**
-     * @return array<class-string<Node>>
-     */
     public function getNodeTypes(): array
     {
         return [Minus::class, FuncCall::class];
     }
 
-    /**
-     * @param FuncCall $node
-     */
     public function refactor(Node $node): ?Node
     {
         if ($node instanceof Minus) {

rules/Carbon/Rector/FuncCall/TimeFuncCallToCarbonRector.php

@@ -15,6 +15,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @extends AbstractRector<FuncCall>
  * @see \Rector\Tests\Carbon\Rector\FuncCall\TimeFuncCallToCarbonRector\TimeFuncCallToCarbonRectorTest
  */
 final class TimeFuncCallToCarbonRector extends AbstractRector
@@ -47,17 +48,11 @@ public function run()
         ]);
     }
 
-    /**
-     * @return array<class-string<Node>>
-     */
     public function getNodeTypes(): array
     {
         return [FuncCall::class];
     }
 
-    /**
-     * @param FuncCall $node
-     */
     public function refactor(Node $node): ?Node
     {
         if (! $this->isName($node->name, 'time')) {

rules/Carbon/Rector/MethodCall/DateTimeMethodCallToCarbonRector.php

@@ -16,6 +16,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @extends AbstractRector<MethodCall>
  * @see \Rector\Tests\Carbon\Rector\MethodCall\DateTimeMethodCallToCarbonRector\DateTimeMethodCallToCarbonRectorTest
  */
 final class DateTimeMethodCallToCarbonRector extends AbstractRector
@@ -53,17 +54,11 @@ public function run()
         ]);
     }
 
-    /**
-     * @return array<class-string<Node>>
-     */
     public function getNodeTypes(): array
     {
         return [MethodCall::class];
     }
 
-    /**
-     * @param MethodCall $node
-     */
     public function refactor(Node $node): ?Node
     {
         if (! $node->var instanceof New_) {

rules/Carbon/Rector/New_/DateTimeInstanceToCarbonRector.php

@@ -17,6 +17,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @extends AbstractRector<New_>
  * @see \Rector\Tests\Carbon\Rector\New_\DateTimeInstanceToCarbonRector\DateTimeInstanceToCarbonRectorTest
  */
 final class DateTimeInstanceToCarbonRector extends AbstractRector
@@ -42,17 +43,11 @@ public function getRuleDefinition(): RuleDefinition
         ]);
     }
 
-    /**
-     * @return array<class-string<Node>>
-     */
     public function getNodeTypes(): array
     {
         return [New_::class];
     }
 
-    /**
-     * @param New_ $node
-     */
     public function refactor(Node $node): ?Node
     {
         if ($node->isFirstClassCallable()) {

rules/CodeQuality/Rector/Assign/CombinedAssignRector.php

@@ -15,6 +15,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @extends AbstractRector<Assign>
  * @see \Rector\Tests\CodeQuality\Rector\Assign\CombinedAssignRector\CombinedAssignRectorTest
  */
 final class CombinedAssignRector extends AbstractRector
@@ -32,17 +33,11 @@ public function getRuleDefinition(): RuleDefinition
         );
     }
 
-    /**
-     * @return array<class-string<Node>>
-     */
     public function getNodeTypes(): array
     {
         return [Assign::class];
     }
 
-    /**
-     * @param Assign $node
-     */
     public function refactor(Node $node): ?Node
     {
         if (! $node->expr instanceof BinaryOp) {

rules/CodeQuality/Rector/AssignOp/NewArrayItemConcatAssignToAssignRector.php

@@ -13,6 +13,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @extends AbstractRector<Concat>
  * @see \Rector\Tests\CodeQuality\Rector\AssignOp\NewArrayItemConcatAssignToAssignRector\NewArrayItemConcatAssignToAssignRectorTest
  */
 final class NewArrayItemConcatAssignToAssignRector extends AbstractRector
@@ -40,9 +41,6 @@ public function getNodeTypes(): array
         return [Concat::class];
     }
 
-    /**
-     * @param Concat $node
-     */
     public function refactor(Node $node): ?Assign
     {
         if (! $node->var instanceof ArrayDimFetch) {

rules/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector.php

@@ -19,6 +19,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @extends AbstractRector<Attribute>
  * @see \Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\ExplicitAttributeNamedArgsRectorTest
  */
 final class ExplicitAttributeNamedArgsRector extends AbstractRector implements MinPhpVersionInterface
@@ -52,17 +53,11 @@ class SomeClass
         );
     }
 
-    /**
-     * @return array<class-string<Node>>
-     */
     public function getNodeTypes(): array
     {
         return [Attribute::class];
     }
 
-    /**
-     * @param Attribute $node
-     */
     public function refactor(Node $node): ?Node
     {
         $methodReflection = $this->reflectionResolver->resolveConstructorReflectionFromAttribute($node);

rules/CodeQuality/Rector/Attribute/SortAttributeNamedArgsRector.php

@@ -15,6 +15,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @extends AbstractRector<Node\Attribute>
  * @see \Rector\Tests\CodeQuality\Rector\Attribute\SortAttributeNamedArgsRector\SortAttributeNamedArgsRectorTest
  */
 final class SortAttributeNamedArgsRector extends AbstractRector
@@ -70,9 +71,6 @@ public function getNodeTypes(): array
         return [Attribute::class];
     }
 
-    /**
-     * @param Node\Attribute $node
-     */
     public function refactor(Node $node): ?Node
     {
         $args = $node->args;

rules/CodeQuality/Rector/BooleanAnd/RemoveUselessIsObjectCheckRector.php

@@ -13,6 +13,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @extends AbstractRector<BooleanAnd>
  * @see \Rector\Tests\CodeQuality\Rector\BooleanAnd\RemoveUselessIsObjectCheckRector\RemoveUselessIsObjectCheckRectorTest
  */
 final class RemoveUselessIsObjectCheckRector extends AbstractRector
@@ -25,17 +26,11 @@ public function getRuleDefinition(): RuleDefinition
         );
     }
 
-    /**
-     * @return array<class-string<Node>>
-     */
     public function getNodeTypes(): array
     {
         return [BooleanAnd::class];
     }
 
-    /**
-     * @param BooleanAnd $node
-     */
     public function refactor(Node $node): ?Node
     {
         if ($node->left instanceof FuncCall

rules/CodeQuality/Rector/BooleanAnd/RepeatedAndNotEqualToNotInArrayRector.php

@@ -21,6 +21,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @extends AbstractRector<BooleanAnd>
  * @see \Rector\Tests\CodeQuality\Rector\BooleanAnd\RepeatedAndNotEqualToNotInArrayRector\RepeatedAndNotEqualToNotInArrayRectorTest
  */
 final class RepeatedAndNotEqualToNotInArrayRector extends AbstractRector
@@ -53,17 +54,11 @@ public function getRuleDefinition(): RuleDefinition
         );
     }
 
-    /**
-     * @return array<class-string<Node>>
-     */
     public function getNodeTypes(): array
     {
         return [BooleanAnd::class];
     }
 
-    /**
-     * @param BooleanAnd $node
-     */
     public function refactor(Node $node): ?BooleanNot
     {
         if (! $this->isNotEqualOrNotIdentical($node->right)) {