fix(RenameGarbageParamName): Improve detection of unused variables in function bodies

guanguans · guanguans · commit b5f2a333ee8a · 2026-02-08T21:27:00.000+08:00
- Update the isUsedVariable method to consider functions with only Nop statements as having no relevant code
- Enhance code readability and accuracy in identifying unused parameters
- Prevent false positives in parameter renaming by better handling of empty or no-operation functions
diff --git a/composer.json b/composer.json
@@ -373,6 +373,7 @@
             "ls -lr builds/rector-rules.phar"
         ],
         "rector-rules:list-files": "Guanguans\\RectorRules\\Support\\ComposerScripts::listFiles",
+        "rector-rules:phpdoc-parse": "Guanguans\\RectorRules\\Support\\ComposerScripts::phpdocParse",
         "rector:custom-rule": "@rector custom-rule",
         "rector:list-rules": "@rector list-rules",
         "rector:process": "@rector process --ansi",
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -130,7 +130,7 @@ parameters:
         - identifier: argument.type
         - identifier: cast.int
 #        - identifier: cast.string
-        - identifier: empty.notAllowed
+#        - identifier: empty.notAllowed
         - identifier: encapsedStringPart.nonString
         - identifier: method.childParameterType
         - identifier: return.type
diff --git a/src/Rector/FunctionLike/RenameGarbageParamNameRector.php b/src/Rector/FunctionLike/RenameGarbageParamNameRector.php
@@ -27,6 +27,7 @@
 use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Foreach_;
+use PhpParser\Node\Stmt\Nop;
 use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;
 use PHPStan\Reflection\ClassReflection;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
@@ -268,7 +269,11 @@ private function hasPrototypeMethod(FunctionLike $functionLikeNode): bool
     private function isUsedVariable(FunctionLike $node, Variable $variableNode): bool
     {
         // Skip abstract, interface, empty body function like and foreach.
-        if (property_exists($node, 'stmts') && empty($node->stmts)) {
+        if (
+            property_exists($node, 'stmts') && collect($node->stmts)->every(
+                static fn (Node $stmtNode): bool => $stmtNode instanceof Nop
+            )
+        ) {
             return true;
         }
 
diff --git a/src/Support/ComposerScripts.php b/src/Support/ComposerScripts.php
@@ -19,8 +19,17 @@
 use Composer\Script\Event;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
+use PhpParser\Comment\Doc;
+use PhpParser\Node\Stmt\Nop;
+use PHPStan\PhpDocParser\Ast\AbstractNodeVisitor;
+use PHPStan\PhpDocParser\Ast\Attribute;
+use PHPStan\PhpDocParser\Ast\Node;
+use PHPStan\PhpDocParser\Ast\NodeTraverser;
+use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
+use Rector\BetterPhpDocParser\ValueObject\PhpDocAttributeKey;
 use Rector\Config\RectorConfig;
 use Rector\DependencyInjection\LazyContainerFactory;
+use Rector\PhpParser\Parser\SimplePhpParser;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Input\ArgvInput;
 use Symfony\Component\Console\Input\InputDefinition;
@@ -46,6 +55,8 @@ private function __construct() {}
 
     /**
      * @see https://github.com/rectorphp/rector-src/blob/main/scoper.php
+     * @see \PhpParser\Builder\
+     * @see \PhpParser\BuilderHelpers
      * @see \Rector\Application\ChangedNodeScopeRefresher
      * @see \Rector\BetterPhpDocParser\Comment\CommentsMerger
      * @see \Rector\BetterPhpDocParser\PhpDocManipulator\
@@ -116,6 +127,52 @@ classes(
         return 0;
     }
 
+    /**
+     *@see vendor/nikic/php-parser/bin/php-parse
+     *
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
+     *
+     * @noinspection ForgottenDebugOutputInspection
+     * @noinspection DebugFunctionUsageInspection
+     * @noinspection PhpVoidFunctionResultUsedInspection
+     */
+    public static function phpdocParse(Event $event): void
+    {
+        self::requireAutoload($event);
+
+        $rectorConfig = self::makeRectorConfig();
+        $path = self::makeArgvInput()->getParameterOption('--path', false, true);
+
+        if ($path) {
+            $node = $rectorConfig->make(SimplePhpParser::class)->parseFile($path)[0];
+        } else {
+            do {
+                $docComment = $event->getIO()->ask(\sprintf('Please provide a doc comment to parse:%s', \PHP_EOL));
+            } while (blank($docComment));
+
+            $node = tap(new Nop)->setDocComment(new Doc($docComment));
+        }
+
+        $phpDocNode = $rectorConfig->make(PhpDocInfoFactory::class)->createFromNodeOrEmpty($node)->getPhpDocNode();
+        (new NodeTraverser([
+            new class extends AbstractNodeVisitor {
+                /**
+                 * @noinspection PhpMissingParentCallCommonInspection
+                 */
+                public function enterNode(Node $node): Node
+                {
+                    // $node->setAttribute(Attribute::ORIGINAL_NODE, null);
+                    $node->setAttribute(PhpDocAttributeKey::ORIG_NODE, null);
+                    $node->setAttribute(PhpDocAttributeKey::PARENT, null);
+
+                    return $node;
+                }
+            },
+        ]))->traverse($phpDocNode->children);
+
+        dump($phpDocNode, (string) $phpDocNode);
+    }
+
     public static function makeRectorConfig(): RectorConfig
     {
         static $rectorConfig;
diff --git a/tests/Rector/FunctionLike/RenameGarbageParamNameRector/Fixture/skips.php.inc b/tests/Rector/FunctionLike/RenameGarbageParamNameRector/Fixture/skips.php.inc
@@ -1,10 +1,21 @@
 <?php
 
 /** @noinspection ALL */
+
+use PhpParser\Node;
+use Rector\Rector\AbstractRector;
+use Symfony\Component\OptionsResolver\OptionsResolver as OptionsResolver;
+
 abstract class Foo
 {
     // Skip abstract method.
     abstract public function run($param): void;
+
+    // Skip nop method.
+    protected function configureOptionsResolver(OptionsResolver $optionsResolver): void
+    {
+        // Configure options resolver...
+    }
 }
 
 interface Bar
@@ -13,9 +24,6 @@ interface Bar
     public function run($param): void;
 }
 
-use PhpParser\Node;
-use Rector\Rector\AbstractRector;
-
 final class FooRector extends AbstractRector
 {
     // Skip has prototype method.
