[console] [7.3] Replace input/output with symfony style if used in InvokableCommandInputAttributeRector (#838)

TomasVotruba · darthf1 · web-flow · commit b00a2c767783 · 2025-09-10T11:36:32.000+02:00
* Create command_with_io.php.inc

* dx

* extract ConsoleOptionAndArgumentMethodCallVariableReplacer

* pass symfony style via execute() if created inside

* remove input/output if not used

---------

Co-authored-by: darthf1 &lt;darthf1@users.noreply.github.com&gt;
diff --git a/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/command_with_io.php.inc b/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/command_with_io.php.inc
@@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\Symfony\Tests\Symfony73\Rector\Class_\InvokableCommandInputAttributeRector\Fixture;
+
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+#[AsCommand('app:my-command')]
+final class MyCommand extends Command
+{
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+        $io->info('Great success!');
+
+        return 1;
+    }
+}
+?>
+-----
+<?php
+
+namespace Rector\Symfony\Tests\Symfony73\Rector\Class_\InvokableCommandInputAttributeRector\Fixture;
+
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+#[AsCommand('app:my-command')]
+final class MyCommand
+{
+    public function __invoke(\Symfony\Component\Console\Style\SymfonyStyle $io): int
+    {
+        $io->info('Great success!');
+        return 1;
+    }
+}
+?>
diff --git a/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/name_with_hyphen.php.inc b/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/name_with_hyphen.php.inc
@@ -45,7 +45,7 @@ class NameWithHyphen
 {
     public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument-with-hyphen', description: 'Argument description')]
     ?string $argument_with_hyphen, #[\Symfony\Component\Console\Attribute\Option]
-    $option_with_hyphen, OutputInterface $output): int
+    $option_with_hyphen): int
     {
         $argument = $argument_with_hyphen;
         $option = $option_with_hyphen;
diff --git a/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/some_command.php.inc b/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/some_command.php.inc
@@ -47,7 +47,7 @@ final class SomeCommand
 {
     public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]
     string $argument, #[\Symfony\Component\Console\Attribute\Option]
-    $option, OutputInterface $output): int
+    $option): int
     {
         $someArgument = $argument;
         $someOption = $option;
diff --git a/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/some_command_with_method_chaining.php.inc b/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/some_command_with_method_chaining.php.inc
@@ -48,7 +48,7 @@ final class SomeCommandWithMethodChaining
 {
     public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]
     string $argument, #[\Symfony\Component\Console\Attribute\Option]
-    $option, OutputInterface $output): int
+    $option): int
     {
         $someArgument = $argument;
         $someOption = $option;
diff --git a/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/some_command_with_set_help.php.inc b/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/some_command_with_set_help.php.inc
@@ -53,7 +53,7 @@ final class SomeCommandWithSetHelp
 
     public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]
     string $argument, #[\Symfony\Component\Console\Attribute\Option]
-    $option, OutputInterface $output): int
+    $option): int
     {
         $someArgument = $argument;
         $someOption = $option;
diff --git a/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/with_multiple_arguments_options_fluent.php.inc b/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/with_multiple_arguments_options_fluent.php.inc
@@ -51,19 +51,22 @@ use Symfony\Component\Console\Input\InputOption;
 #[AsCommand(name: 'some_name')]
 final class WithMultipleArgumentsOptionsFluent
 {
-    public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument1', description: 'Argument1 description')]
-    string $argument1, #[\Symfony\Component\Console\Attribute\Argument(name: 'argument2', description: 'Argument2 description')]
-    string $argument2, #[\Symfony\Component\Console\Attribute\Option]
-    $option1, #[\Symfony\Component\Console\Attribute\Option]
-    $option2, OutputInterface $output): int
+    public function __invoke(
+        #[\Symfony\Component\Console\Attribute\Argument(name: 'argument1', description: 'Argument1 description')]
+        string $argument1,
+        #[\Symfony\Component\Console\Attribute\Argument(name: 'argument2', description: 'Argument2 description')]
+        string $argument2,
+        #[\Symfony\Component\Console\Attribute\Option]
+        $option1,
+        #[\Symfony\Component\Console\Attribute\Option]
+        $option2
+    ): int
     {
         $arg1 = $argument1;
         $arg2 = $argument2;
         $opt1 = $option1;
         $opt2 = $option2;
-
         // ...
-
         return 1;
     }
 }
diff --git a/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/with_multiple_arguments_options_no_fluent.php.inc b/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/with_multiple_arguments_options_no_fluent.php.inc
@@ -56,19 +56,22 @@ use Symfony\Component\Console\Input\InputOption;
 #[AsCommand(name: 'some_name')]
 final class WithMultipleArgumentsOptionsNotFluent
 {
-    public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument1', description: 'Argument1 description')]
-    string $argument1, #[\Symfony\Component\Console\Attribute\Argument(name: 'argument2', description: 'Argument2 description')]
-    string $argument2, #[\Symfony\Component\Console\Attribute\Option]
-    $option1, #[\Symfony\Component\Console\Attribute\Option]
-    $option2, OutputInterface $output): int
+    public function __invoke(
+        #[\Symfony\Component\Console\Attribute\Argument(name: 'argument1', description: 'Argument1 description')]
+        string $argument1,
+        #[\Symfony\Component\Console\Attribute\Argument(name: 'argument2', description: 'Argument2 description')]
+        string $argument2,
+        #[\Symfony\Component\Console\Attribute\Option]
+        $option1,
+        #[\Symfony\Component\Console\Attribute\Option]
+        $option2
+    ): int
     {
         $arg1 = $argument1;
         $arg2 = $argument2;
         $opt1 = $option1;
         $opt2 = $option2;
-
         // ...
-
         return 1;
     }
 }
diff --git a/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/with_optional_argument.php.inc b/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/with_optional_argument.php.inc
@@ -47,7 +47,7 @@ final class WithOptionalArgument
 {
     public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]
     ?string $argument, #[\Symfony\Component\Console\Attribute\Option]
-    $option, OutputInterface $output): int
+    $option): int
     {
         $someArgument = $argument;
         $someOption = $option;
diff --git a/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/with_override.php.inc b/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/with_override.php.inc
@@ -51,8 +51,7 @@ final class WithOverride
         #[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]
         string $argument,
         #[\Symfony\Component\Console\Attribute\Option]
-        $option,
-        OutputInterface $output
+        $option
     ): int
     {
         $someArgument = $argument;
diff --git a/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/without_configure_method.php.inc b/rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/without_configure_method.php.inc
@@ -32,10 +32,9 @@ use Symfony\Component\Console\Output\OutputInterface;
 #[AsCommand(name: 'some_name')]
 final class WithoutConfigure
 {
-    public function __invoke(OutputInterface $output): int
+    public function __invoke(): int
     {
         // ...
-
         return 1;
     }
 }
diff --git a/rules/Symfony73/NodeTransformer/CommandUnusedInputOutputRemover.php b/rules/Symfony73/NodeTransformer/CommandUnusedInputOutputRemover.php
@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Symfony\Symfony73\NodeTransformer;
+
+use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\NodeNameResolver\NodeNameResolver;
+use Rector\PhpParser\Node\BetterNodeFinder;
+
+final readonly class CommandUnusedInputOutputRemover
+{
+    /**
+     * @var string[]
+     */
+    private const VARIABLE_NAMES = ['input', 'output'];
+
+    public function __construct(
+        private NodeNameResolver $nodeNameResolver,
+        private BetterNodeFinder $betterNodeFinder
+    ) {
+
+    }
+
+    public function remove(ClassMethod $executeClassMethod): void
+    {
+        foreach (self::VARIABLE_NAMES as $variableName) {
+            $inputVariable = $this->betterNodeFinder->findVariableOfName($executeClassMethod->stmts, $variableName);
+
+            // is used → skip
+            if ($inputVariable instanceof Variable) {
+                continue;
+            }
+
+            $this->removeParameterByName($executeClassMethod, $variableName);
+        }
+    }
+
+    private function removeParameterByName(ClassMethod $classMethod, string $paramName): void
+    {
+        foreach ($classMethod->getParams() as $key => $param) {
+            if (! $this->nodeNameResolver->isName($param->var, $paramName)) {
+                continue;
+            }
+
+            unset($classMethod->params[$key]);
+        }
+    }
+}
diff --git a/rules/Symfony73/NodeTransformer/ConsoleOptionAndArgumentMethodCallVariableReplacer.php b/rules/Symfony73/NodeTransformer/ConsoleOptionAndArgumentMethodCallVariableReplacer.php
@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Symfony\Symfony73\NodeTransformer;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\ClassConstFetch;
+use PhpParser\Node\Expr\ConstFetch;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Scalar\String_;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\Exception\ShouldNotHappenException;
+use Rector\NodeNameResolver\NodeNameResolver;
+use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
+use Rector\PhpParser\Node\Value\ValueResolver;
+
+final readonly class ConsoleOptionAndArgumentMethodCallVariableReplacer
+{
+    public function __construct(
+        private NodeNameResolver $nodeNameResolver,
+        private SimpleCallableNodeTraverser $simpleCallableNodeTraverser,
+        private ValueResolver $valueResolver,
+    ) {
+
+    }
+
+    public function replace(ClassMethod $executeClassMethod): void
+    {
+        $this->simpleCallableNodeTraverser->traverseNodesWithCallable($executeClassMethod->stmts, function (
+            Node $node
+        ): ?Variable {
+            if (! $node instanceof MethodCall) {
+                return null;
+            }
+
+            if (! $this->nodeNameResolver->isName($node->var, 'input')) {
+                return null;
+            }
+
+            if (! $this->nodeNameResolver->isNames($node->name, ['getOption', 'getArgument'])) {
+                return null;
+            }
+
+            $firstArgValue = $node->getArgs()[0]
+                ->value;
+
+            if ($firstArgValue instanceof ClassConstFetch || $firstArgValue instanceof ConstFetch) {
+                $variableName = $this->valueResolver->getValue($firstArgValue);
+                return new Variable(str_replace('-', '_', $variableName));
+            }
+
+            if (! $firstArgValue instanceof String_) {
+                // unable to resolve argument/option name
+                throw new ShouldNotHappenException();
+            }
+
+            $variableName = $firstArgValue->value;
+            return new Variable(str_replace('-', '_', $variableName));
+        });
+    }
+}
diff --git a/rules/Symfony73/NodeTransformer/OutputInputSymfonyStyleReplacer.php b/rules/Symfony73/NodeTransformer/OutputInputSymfonyStyleReplacer.php
@@ -0,0 +1,98 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Symfony\Symfony73\NodeTransformer;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\Assign;
+use PhpParser\Node\Expr\New_;
+use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Param;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Expression;
+use PhpParser\NodeVisitor;
+use Rector\NodeNameResolver\NodeNameResolver;
+use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
+use Rector\PhpParser\Node\BetterNodeFinder;
+use Rector\Symfony\Enum\SymfonyClass;
+
+final readonly class OutputInputSymfonyStyleReplacer
+{
+    public function __construct(
+        private NodeNameResolver $nodeNameResolver,
+        private BetterNodeFinder $betterNodeFinder,
+        private SimpleCallableNodeTraverser $simpleCallableNodeTraverser,
+    ) {
+    }
+
+    public function replace(ClassMethod $executeClassMethod): void
+    {
+        $symfonyStyleVariableName = $this->matchSymfonyStyleNewVariableName($executeClassMethod);
+
+        // nothing to update here
+        if ($symfonyStyleVariableName === null) {
+            return;
+        }
+
+        // 1. add symfony style param
+        $executeClassMethod->params[] = new Param(
+            new Variable($symfonyStyleVariableName),
+            null,
+            new FullyQualified(SymfonyClass::SYMFONY_STYLE)
+        );
+
+        // 2. remove new symfony style inside
+        $this->simpleCallableNodeTraverser->traverseNodesWithCallable(
+            $executeClassMethod,
+            function (Node $node): ?int {
+                if (! $node instanceof Expression) {
+                    return null;
+                }
+
+                if (! $node->expr instanceof Assign) {
+                    return null;
+                }
+
+                $assign = $node->expr;
+                if (! $this->isSymfonyStyleNewAssign($assign)) {
+                    return null;
+                }
+
+                return NodeVisitor::REMOVE_NODE;
+            }
+        );
+    }
+
+    private function matchSymfonyStyleNewVariableName(ClassMethod $executeClassMethod): ?string
+    {
+        /** @var Assign[] $assigns */
+        $assigns = $this->betterNodeFinder->findInstancesOfScoped($executeClassMethod->stmts, Assign::class);
+
+        foreach ($assigns as $assign) {
+            if (! $this->isSymfonyStyleNewAssign($assign)) {
+                continue;
+            }
+
+            if (! $assign->var instanceof Variable) {
+                continue;
+            }
+
+            return $this->nodeNameResolver->getName($assign->var);
+        }
+
+        return null;
+    }
+
+    private function isSymfonyStyleNewAssign(Assign $assign): bool
+    {
+        if (! $assign->expr instanceof New_) {
+            return false;
+        }
+
+        $new = $assign->expr;
+
+        return $this->nodeNameResolver->isName($new->class, SymfonyClass::SYMFONY_STYLE);
+    }
+}
diff --git a/rules/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector.php b/rules/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector.php
diff --git a/src/Enum/SymfonyClass.php b/src/Enum/SymfonyClass.php
diff --git a/tests/Set/Symfony73/Fixture/command_remove_config.php.inc b/tests/Set/Symfony73/Fixture/command_remove_config.php.inc

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ class NameWithHyphen`
`45`	`45`	`{`
`46`	`46`	`public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument-with-hyphen', description: 'Argument description')]`
`47`	`47`	`?string $argument_with_hyphen, #[\Symfony\Component\Console\Attribute\Option]`
`48`		`- $option_with_hyphen, OutputInterface $output): int`
	`48`	`+ $option_with_hyphen): int`
`49`	`49`	`{`
`50`	`50`	`$argument = $argument_with_hyphen;`
`51`	`51`	`$option = $option_with_hyphen;`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ final class SomeCommand`
`47`	`47`	`{`
`48`	`48`	`public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]`
`49`	`49`	`string $argument, #[\Symfony\Component\Console\Attribute\Option]`
`50`		`- $option, OutputInterface $output): int`
	`50`	`+ $option): int`
`51`	`51`	`{`
`52`	`52`	`$someArgument = $argument;`
`53`	`53`	`$someOption = $option;`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ final class SomeCommandWithMethodChaining`
`48`	`48`	`{`
`49`	`49`	`public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]`
`50`	`50`	`string $argument, #[\Symfony\Component\Console\Attribute\Option]`
`51`		`- $option, OutputInterface $output): int`
	`51`	`+ $option): int`
`52`	`52`	`{`
`53`	`53`	`$someArgument = $argument;`
`54`	`54`	`$someOption = $option;`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ final class SomeCommandWithSetHelp`
`53`	`53`
`54`	`54`	`public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]`
`55`	`55`	`string $argument, #[\Symfony\Component\Console\Attribute\Option]`
`56`		`- $option, OutputInterface $output): int`
	`56`	`+ $option): int`
`57`	`57`	`{`
`58`	`58`	`$someArgument = $argument;`
`59`	`59`	`$someOption = $option;`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ final class WithOptionalArgument`
`47`	`47`	`{`
`48`	`48`	`public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]`
`49`	`49`	`?string $argument, #[\Symfony\Component\Console\Attribute\Option]`
`50`		`- $option, OutputInterface $output): int`
	`50`	`+ $option): int`
`51`	`51`	`{`
`52`	`52`	`$someArgument = $argument;`
`53`	`53`	`$someOption = $option;`
Original file line number	Diff line number	Diff line change
`@@ -32,10 +32,9 @@ use Symfony\Component\Console\Output\OutputInterface;`
`32`	`32`	`#[AsCommand(name: 'some_name')]`
`33`	`33`	`final class WithoutConfigure`
`34`	`34`	`{`
`35`		`- public function __invoke(OutputInterface $output): int`
	`35`	`+ public function __invoke(): int`
`36`	`36`	`{`
`37`	`37`	`// ...`
`38`		`-`
`39`	`38`	`return 1;`
`40`	`39`	`}`
`41`	`40`	`}`