skip false positive chagne report on RemoveUselessParamTagRector (#3151)

rectorphp · Dec 4, 2022 · 3dea2bd · 3dea2bd
1 parent efd09bb
commit 3dea2bd
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/rules/DeadCode/PhpDoc/TagRemover/ParamTagRemover.php b/rules/DeadCode/PhpDoc/TagRemover/ParamTagRemover.php
@@ -19,12 +19,15 @@ public function __construct(
     ) {
     }
 
-    public function removeParamTagsIfUseless(PhpDocInfo $phpDocInfo, FunctionLike $functionLike): void
+    public function removeParamTagsIfUseless(PhpDocInfo $phpDocInfo, FunctionLike $functionLike): bool
     {
+        $hasChanged = false;
+
         $phpDocNodeTraverser = new PhpDocNodeTraverser();
         $phpDocNodeTraverser->traverseWithCallable($phpDocInfo->getPhpDocNode(), '', function (Node $docNode) use (
             $functionLike,
-            $phpDocInfo
+            $phpDocInfo,
+            &$hasChanged
         ): ?int {
             if (! $docNode instanceof PhpDocTagNode) {
                 return null;
@@ -44,7 +47,10 @@ public function removeParamTagsIfUseless(PhpDocInfo $phpDocInfo, FunctionLike $f
             }
 
             $phpDocInfo->markAsChanged();
+            $hasChanged = true;
             return PhpDocNodeTraverser::NODE_REMOVE;
         });
+
+        return $hasChanged;
     }
 }
diff --git a/rules/DeadCode/Rector/ClassMethod/RemoveUselessParamTagRector.php b/rules/DeadCode/Rector/ClassMethod/RemoveUselessParamTagRector.php
@@ -75,9 +75,8 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        $this->paramTagRemover->removeParamTagsIfUseless($phpDocInfo, $node);
-
-        if ($phpDocInfo->hasChanged()) {
+        $hasChanged = $this->paramTagRemover->removeParamTagsIfUseless($phpDocInfo, $node);
+        if ($hasChanged) {
             return $node;
         }