[dx] Make registration of custom NodeVisitor is easier (#7669)

* [dx] rename ScopeResolverNodeVisitorInterface, to shorter and more explicit DecoratingNodeVisitorInterface, make its registration simple

* [config] add registerDecoratingNodeVisitor()

Author: TomasVotruba

phpstan.neon

@@ -265,6 +265,11 @@ parameters:
         # see https://github.com/rectorphp/rector-src/actions/runs/11798721617/job/32865546672?pr=6422#step:5:110
         - '#Doing instanceof PHPStan\\Type\\.+ is error\-prone and deprecated#'
 
+        # BC layer on Rector deprecation
+        -
+            path: src/Configuration/RectorConfigBuilder.php
+            identifier: classConstant.deprecatedInterface
+
         # allowed internally only
         -
             message: '#Fetching (deprecated )?class constant (.*?) of (deprecated )?class (Rector\\Set\\ValueObject\\DowngradeLevelSetList|Rector\\Symfony\\Set\\(.*?))#'

src/Configuration/RectorConfigBuilder.php

@@ -4,6 +4,7 @@
 
 namespace Rector\Configuration;
 
+use PhpParser\NodeVisitor;
 use Rector\Bridge\SetProviderCollector;
 use Rector\Bridge\SetRectorsResolver;
 use Rector\Caching\Contract\ValueObject\Storage\CacheStorageInterface;
@@ -18,11 +19,13 @@
 use Rector\Configuration\Levels\LevelRulesResolver;
 use Rector\Configuration\Parameter\SimpleParameterProvider;
 use Rector\Console\Notifier;
+use Rector\Contract\PhpParser\DecoratingNodeVisitorInterface;
 use Rector\Contract\Rector\ConfigurableRectorInterface;
 use Rector\Contract\Rector\RectorInterface;
 use Rector\Doctrine\Set\DoctrineSetList;
 use Rector\Enum\Config\Defaults;
 use Rector\Exception\Configuration\InvalidConfigurationException;
+use Rector\NodeTypeResolver\PHPStan\Scope\Contract\NodeVisitor\ScopeResolverNodeVisitorInterface;
 use Rector\Php\PhpVersionResolver\ComposerJsonPhpVersionResolver;
 use Rector\Php80\Rector\Class_\AnnotationToAttributeRector;
 use Rector\Php80\ValueObject\AnnotationToAttribute;
@@ -1217,11 +1220,33 @@ public function withTreatClassesAsFinal(bool $isTreatClassesAsFinal = true): sel
 
     public function registerService(string $className, ?string $alias = null, ?string $tag = null): self
     {
+        // BC layer since 2.2.9
+        if ($tag === ScopeResolverNodeVisitorInterface::class) {
+            $tag = DecoratingNodeVisitorInterface::class;
+        }
+
         $this->registerServices[] = new RegisteredService($className, $alias, $tag);
 
         return $this;
     }
 
+    /**
+     * DX helper
+     * @see https://getrector.com/documentation/creating-a-node-visitor
+     */
+    public function registerDecoratingNodeVisitor(string $decoratingNodeVisitorClass): self
+    {
+        Assert::isAOf($decoratingNodeVisitorClass, NodeVisitor::class);
+
+        $this->registerServices[] = new RegisteredService(
+            $decoratingNodeVisitorClass,
+            null,
+            DecoratingNodeVisitorInterface::class
+        );
+
+        return $this;
+    }
+
     public function withDowngradeSets(
         bool $php84 = false,
         bool $php83 = false,

src/Contract/PhpParser/DecoratingNodeVisitorInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Contract\PhpParser;
+
+use PhpParser\NodeVisitor;
+
+/**
+ * This interface can be used to tag load node visitor, that will run on parsing files to nodes.
+ * It can be used e.g. to decorate nodes with extra attributes,
+ * that can be used later in rules or services.
+ */
+interface DecoratingNodeVisitorInterface extends NodeVisitor
+{
+}

src/DependencyInjection/LazyContainerFactory.php

@@ -65,6 +65,7 @@
 use Rector\Console\Style\RectorStyle;
 use Rector\Console\Style\SymfonyStyleFactory;
 use Rector\Contract\DependencyInjection\ResetableInterface;
+use Rector\Contract\PhpParser\DecoratingNodeVisitorInterface;
 use Rector\Contract\Rector\RectorInterface;
 use Rector\NodeDecorator\CreatedByRuleDecorator;
 use Rector\NodeNameResolver\Contract\NodeNameResolverInterface;
@@ -94,7 +95,6 @@
 use Rector\NodeTypeResolver\NodeTypeResolver\ScalarTypeResolver;
 use Rector\NodeTypeResolver\NodeTypeResolver\StaticCallMethodCallTypeResolver;
 use Rector\NodeTypeResolver\NodeTypeResolver\TraitTypeResolver;
-use Rector\NodeTypeResolver\PHPStan\Scope\Contract\NodeVisitor\ScopeResolverNodeVisitorInterface;
 use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\ArgNodeVisitor;
 use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\AssignedToNodeVisitor;
 use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\ByRefReturnNodeVisitor;
@@ -231,9 +231,9 @@ final class LazyContainerFactory
     ];
 
     /**
-     * @var array<class-string<ScopeResolverNodeVisitorInterface>>
+     * @var array<class-string<DecoratingNodeVisitorInterface>>
      */
-    private const SCOPE_RESOLVER_NODE_VISITOR_CLASSES = [
+    private const DECORATING_NODE_VISITOR_CLASSES = [
         ArgNodeVisitor::class,
         AssignedToNodeVisitor::class,
         ByRefReturnNodeVisitor::class,
@@ -660,13 +660,13 @@ static function (
         );
 
         $rectorConfig->when(PHPStanNodeScopeResolver::class)
-            ->needs('$nodeVisitors')
-            ->giveTagged(ScopeResolverNodeVisitorInterface::class);
+            ->needs('$decoratingNodeVisitors')
+            ->giveTagged(DecoratingNodeVisitorInterface::class);
 
         $this->registerTagged(
             $rectorConfig,
-            self::SCOPE_RESOLVER_NODE_VISITOR_CLASSES,
-            ScopeResolverNodeVisitorInterface::class
+            self::DECORATING_NODE_VISITOR_CLASSES,
+            DecoratingNodeVisitorInterface::class
         );
 
         $this->createPHPStanServices($rectorConfig);

src/NodeTypeResolver/PHPStan/Scope/Contract/NodeVisitor/ScopeResolverNodeVisitorInterface.php

@@ -6,6 +6,9 @@
 
 use PhpParser\NodeVisitor;
 
+/**
+ * @deprecated Since 2.2.9. Use \Rector\Contract\PhpParser\DecoratingNodeVisitorInterface instead
+ */
 interface ScopeResolverNodeVisitorInterface extends NodeVisitor
 {
 }

src/NodeTypeResolver/PHPStan/Scope/NodeVisitor/ArgNodeVisitor.php

@@ -11,10 +11,10 @@
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\Node\Name;
 use PhpParser\NodeVisitorAbstract;
+use Rector\Contract\PhpParser\DecoratingNodeVisitorInterface;
 use Rector\NodeTypeResolver\Node\AttributeKey;
-use Rector\NodeTypeResolver\PHPStan\Scope\Contract\NodeVisitor\ScopeResolverNodeVisitorInterface;
 
-final class ArgNodeVisitor extends NodeVisitorAbstract implements ScopeResolverNodeVisitorInterface
+final class ArgNodeVisitor extends NodeVisitorAbstract implements DecoratingNodeVisitorInterface
 {
     public function enterNode(Node $node): ?Node
     {

src/NodeTypeResolver/PHPStan/Scope/NodeVisitor/AssignedToNodeVisitor.php

@@ -11,13 +11,13 @@
 use PhpParser\Node\Expr\AssignRef;
 use PhpParser\Node\Expr\List_;
 use PhpParser\NodeVisitorAbstract;
+use Rector\Contract\PhpParser\DecoratingNodeVisitorInterface;
 use Rector\NodeTypeResolver\Node\AttributeKey;
-use Rector\NodeTypeResolver\PHPStan\Scope\Contract\NodeVisitor\ScopeResolverNodeVisitorInterface;
 
 /**
  * Inspired by https://github.com/phpstan/phpstan-src/blob/1.7.x/src/Parser/NewAssignedToPropertyVisitor.php
  */
-final class AssignedToNodeVisitor extends NodeVisitorAbstract implements ScopeResolverNodeVisitorInterface
+final class AssignedToNodeVisitor extends NodeVisitorAbstract implements DecoratingNodeVisitorInterface
 {
     public function enterNode(Node $node): ?Node
     {

src/NodeTypeResolver/PHPStan/Scope/NodeVisitor/ByRefReturnNodeVisitor.php

@@ -10,11 +10,11 @@
 use PhpParser\Node\Stmt\Return_;
 use PhpParser\NodeVisitor;
 use PhpParser\NodeVisitorAbstract;
+use Rector\Contract\PhpParser\DecoratingNodeVisitorInterface;
 use Rector\NodeTypeResolver\Node\AttributeKey;
-use Rector\NodeTypeResolver\PHPStan\Scope\Contract\NodeVisitor\ScopeResolverNodeVisitorInterface;
 use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
 
-final class ByRefReturnNodeVisitor extends NodeVisitorAbstract implements ScopeResolverNodeVisitorInterface
+final class ByRefReturnNodeVisitor extends NodeVisitorAbstract implements DecoratingNodeVisitorInterface
 {
     public function __construct(
         private readonly SimpleCallableNodeTraverser $simpleCallableNodeTraverser

src/NodeTypeResolver/PHPStan/Scope/NodeVisitor/ByRefVariableNodeVisitor.php

@@ -11,11 +11,11 @@
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\FunctionLike;
 use PhpParser\NodeVisitorAbstract;
+use Rector\Contract\PhpParser\DecoratingNodeVisitorInterface;
 use Rector\NodeTypeResolver\Node\AttributeKey;
-use Rector\NodeTypeResolver\PHPStan\Scope\Contract\NodeVisitor\ScopeResolverNodeVisitorInterface;
 use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
 
-final class ByRefVariableNodeVisitor extends NodeVisitorAbstract implements ScopeResolverNodeVisitorInterface
+final class ByRefVariableNodeVisitor extends NodeVisitorAbstract implements DecoratingNodeVisitorInterface
 {
     public function __construct(
         private readonly SimpleCallableNodeTraverser $simpleCallableNodeTraverser

src/NodeTypeResolver/PHPStan/Scope/NodeVisitor/ContextNodeVisitor.php

@@ -34,11 +34,11 @@
 use PhpParser\Node\Stmt\While_;
 use PhpParser\NodeVisitor;
 use PhpParser\NodeVisitorAbstract;
+use Rector\Contract\PhpParser\DecoratingNodeVisitorInterface;
 use Rector\NodeTypeResolver\Node\AttributeKey;
-use Rector\NodeTypeResolver\PHPStan\Scope\Contract\NodeVisitor\ScopeResolverNodeVisitorInterface;
 use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
 
-final class ContextNodeVisitor extends NodeVisitorAbstract implements ScopeResolverNodeVisitorInterface
+final class ContextNodeVisitor extends NodeVisitorAbstract implements DecoratingNodeVisitorInterface
 {
     public function __construct(
         private readonly SimpleCallableNodeTraverser $simpleCallableNodeTraverser