[console] [7.3] Fix missing options in InvokableCommandInputAttributeRector (#839)

TomasVotruba · web-flow · commit eec47b7434e4 · 2025-09-10T12:05:13.000+02:00
* keep option details

* add option name

* tidy up

* fix moving option metadata

* Tidy up
diff --git a/composer.json b/composer.json
@@ -23,6 +23,7 @@
         "symfony/security-http": "^6.4",
         "symfony/validator": "^6.4",
         "symfony/web-link": "^6.4",
+        "symplify/phpstan-extensions": "^12.0",
         "symplify/phpstan-rules": "^14.6",
         "symplify/vendor-patches": "^11.3",
         "tomasvotruba/class-leak": "^2.0",
diff --git a/phpstan.neon b/phpstan.neon
@@ -3,6 +3,7 @@ rules:
 
 parameters:
     level: 8
+    errorFormat: symplify
 
     reportUnmatchedIgnoredErrors: false
     treatPhpDocTypesAsCertain: false
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
@@ -44,7 +44,7 @@ use Symfony\Component\Console\Output\OutputInterface;
 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]
+    ?string $argument_with_hyphen, #[\Symfony\Component\Console\Attribute\Option(name: 'option-with-hyphen')]
     $option_with_hyphen): int
     {
         $argument = $argument_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
@@ -46,7 +46,7 @@ use Symfony\Component\Console\Input\InputOption;
 final class SomeCommand
 {
     public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]
-    string $argument, #[\Symfony\Component\Console\Attribute\Option]
+    string $argument, #[\Symfony\Component\Console\Attribute\Option(name: 'option', shortcut: 'o', mode: InputOption::VALUE_NONE, description: 'Option description')]
     $option): int
     {
         $someArgument = $argument;
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
@@ -47,7 +47,7 @@ use Symfony\Component\Console\Input\InputOption;
 final class SomeCommandWithMethodChaining
 {
     public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]
-    string $argument, #[\Symfony\Component\Console\Attribute\Option]
+    string $argument, #[\Symfony\Component\Console\Attribute\Option(name: 'option', shortcut: 'o', mode: InputOption::VALUE_NONE, description: 'Option description')]
     $option): int
     {
         $someArgument = $argument;
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
@@ -52,7 +52,7 @@ final class SomeCommandWithSetHelp
     }
 
     public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]
-    string $argument, #[\Symfony\Component\Console\Attribute\Option]
+    string $argument, #[\Symfony\Component\Console\Attribute\Option(name: 'option', shortcut: 'o', mode: InputOption::VALUE_NONE, description: 'Option description')]
     $option): int
     {
         $someArgument = $argument;
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
@@ -56,9 +56,9 @@ final class WithMultipleArgumentsOptionsFluent
         string $argument1,
         #[\Symfony\Component\Console\Attribute\Argument(name: 'argument2', description: 'Argument2 description')]
         string $argument2,
-        #[\Symfony\Component\Console\Attribute\Option]
+        #[\Symfony\Component\Console\Attribute\Option(name: 'option1', shortcut: 'o', mode: InputOption::VALUE_NONE, description: 'Option1 description')]
         $option1,
-        #[\Symfony\Component\Console\Attribute\Option]
+        #[\Symfony\Component\Console\Attribute\Option(name: 'option2', shortcut: 'p', mode: InputOption::VALUE_NONE, description: 'Option2 description')]
         $option2
     ): int
     {
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
@@ -61,9 +61,9 @@ final class WithMultipleArgumentsOptionsNotFluent
         string $argument1,
         #[\Symfony\Component\Console\Attribute\Argument(name: 'argument2', description: 'Argument2 description')]
         string $argument2,
-        #[\Symfony\Component\Console\Attribute\Option]
+        #[\Symfony\Component\Console\Attribute\Option(name: 'option1', shortcut: 'o', mode: InputOption::VALUE_NONE, description: 'Option1 description')]
         $option1,
-        #[\Symfony\Component\Console\Attribute\Option]
+        #[\Symfony\Component\Console\Attribute\Option(name: 'option2', shortcut: 'p', mode: InputOption::VALUE_NONE, description: 'Option2 description')]
         $option2
     ): int
     {
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
@@ -46,7 +46,7 @@ use Symfony\Component\Console\Input\InputOption;
 final class WithOptionalArgument
 {
     public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]
-    ?string $argument, #[\Symfony\Component\Console\Attribute\Option]
+    ?string $argument, #[\Symfony\Component\Console\Attribute\Option(name: 'option', shortcut: 'o', mode: InputOption::VALUE_NONE, description: 'Option description')]
     $option): int
     {
         $someArgument = $argument;
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
@@ -50,7 +50,7 @@ final class WithOverride
     public function __invoke(
         #[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]
         string $argument,
-        #[\Symfony\Component\Console\Attribute\Option]
+        #[\Symfony\Component\Console\Attribute\Option(name: 'option', shortcut: 'o', mode: InputOption::VALUE_NONE, description: 'Option description')]
         $option
     ): int
     {
diff --git a/rules/Symfony73/NodeAnalyzer/CommandArgumentsAndOptionsResolver.php b/rules/Symfony73/NodeAnalyzer/CommandArgumentsAndOptionsResolver.php
diff --git a/rules/Symfony73/NodeAnalyzer/CommandArgumentsResolver.php b/rules/Symfony73/NodeAnalyzer/CommandArgumentsResolver.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Symfony\Symfony73\NodeAnalyzer;
+
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\Symfony\Symfony73\NodeFinder\MethodCallFinder;
+use Rector\Symfony\Symfony73\ValueObject\CommandArgument;
+
+final readonly class CommandArgumentsResolver
+{
+    public function __construct(
+        private MethodCallFinder $methodCallFinder,
+    ) {
+    }
+
+    /**
+     * @return CommandArgument[]
+     */
+    public function resolve(ClassMethod $configureClassMethod): array
+    {
+        $addArgumentMethodCalls = $this->methodCallFinder->find($configureClassMethod, 'addArgument');
+
+        $commandArguments = [];
+        foreach ($addArgumentMethodCalls as $addArgumentMethodCall) {
+            $addArgumentArgs = $addArgumentMethodCall->getArgs();
+
+            $commandArguments[] = new CommandArgument(
+                $addArgumentArgs[0]->value,
+                $addArgumentArgs[1]->value ?? null,
+                $addArgumentArgs[2]->value ?? null,
+            );
+        }
+
+        return $commandArguments;
+    }
+}
diff --git a/rules/Symfony73/NodeAnalyzer/CommandOptionsResolver.php b/rules/Symfony73/NodeAnalyzer/CommandOptionsResolver.php
@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Symfony\Symfony73\NodeAnalyzer;
+
+use PhpParser\Node\Scalar\String_;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\Exception\ShouldNotHappenException;
+use Rector\Symfony\Symfony73\NodeFinder\MethodCallFinder;
+use Rector\Symfony\Symfony73\ValueObject\CommandOption;
+
+final readonly class CommandOptionsResolver
+{
+    public function __construct(
+        private MethodCallFinder $methodCallFinder,
+    ) {
+    }
+
+    /**
+     * @return CommandOption[]
+     */
+    public function resolve(ClassMethod $configureClassMethod): array
+    {
+        $addOptionMethodCalls = $this->methodCallFinder->find($configureClassMethod, 'addOption');
+
+        $commandOptions = [];
+
+        foreach ($addOptionMethodCalls as $addOptionMethodCall) {
+            $addOptionArgs = $addOptionMethodCall->getArgs();
+
+            $nameArgValue = $addOptionArgs[0]->value;
+            if (! $nameArgValue instanceof String_) {
+                // we need string value, otherwise param will not have a name
+                throw new ShouldNotHappenException('Option name is required');
+            }
+
+            $shortcutExpr = $addOptionArgs[1]->value ?? null;
+            $modeExpr = $addOptionArgs[2]->value ?? null;
+            $descriptionExpr = $addOptionArgs[3]->value ?? null;
+
+            $commandOptions[] = new CommandOption($nameArgValue, $shortcutExpr, $modeExpr, $descriptionExpr);
+        }
+
+        return $commandOptions;
+    }
+}
diff --git a/rules/Symfony73/NodeFactory/CommandInvokeParamsFactory.php b/rules/Symfony73/NodeFactory/CommandInvokeParamsFactory.php
@@ -7,6 +7,7 @@
 use PhpParser\Node\Arg;
 use PhpParser\Node\Attribute;
 use PhpParser\Node\AttributeGroup;
+use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Identifier;
 use PhpParser\Node\Name\FullyQualified;
@@ -86,13 +87,27 @@ private function createOptionParams(array $commandOptions): array
         $optionParams = [];
 
         foreach ($commandOptions as $commandOption) {
-            $optionName = $commandOption->getName();
+            $optionName = $commandOption->getStringName();
             $variableName = str_replace('-', '_', $optionName);
 
             $optionParam = new Param(new Variable($variableName));
-            // @todo fill type or default value
+
+            $optionArgs = [new Arg(value: $commandOption->getName(), name: new Identifier('name'))];
+
+            if ($commandOption->getShortcut() instanceof Expr) {
+                $optionArgs[] = new Arg(value: $commandOption->getShortcut(), name: new Identifier('shortcut'));
+            }
+
+            if ($commandOption->getMode() instanceof Expr) {
+                $optionArgs[] = new Arg(value: $commandOption->getMode(), name: new Identifier('mode'));
+            }
+
+            if ($commandOption->getDescription() instanceof Expr) {
+                $optionArgs[] = new Arg(value: $commandOption->getDescription(), name: new Identifier('description'));
+            }
+
             $optionParam->attrGroups[] = new AttributeGroup([
-                new Attribute(new FullyQualified(SymfonyAttribute::COMMAND_OPTION)),
+                new Attribute(new FullyQualified(SymfonyAttribute::COMMAND_OPTION), $optionArgs),
             ]);
 
             $optionParams[] = $optionParam;
diff --git a/rules/Symfony73/NodeFinder/MethodCallFinder.php b/rules/Symfony73/NodeFinder/MethodCallFinder.php
diff --git a/rules/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector.php b/rules/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector.php
diff --git a/rules/Symfony73/ValueObject/CommandArgument.php b/rules/Symfony73/ValueObject/CommandArgument.php
diff --git a/rules/Symfony73/ValueObject/CommandOption.php b/rules/Symfony73/ValueObject/CommandOption.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
`@@ -44,7 +44,7 @@ use Symfony\Component\Console\Output\OutputInterface;`
`44`	`44`	`class NameWithHyphen`
`45`	`45`	`{`
`46`	`46`	`public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument-with-hyphen', description: 'Argument description')]`
`47`		`- ?string $argument_with_hyphen, #[\Symfony\Component\Console\Attribute\Option]`
	`47`	`+ ?string $argument_with_hyphen, #[\Symfony\Component\Console\Attribute\Option(name: 'option-with-hyphen')]`
`48`	`48`	`$option_with_hyphen): int`
`49`	`49`	`{`
`50`	`50`	`$argument = $argument_with_hyphen;`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ use Symfony\Component\Console\Input\InputOption;`
`46`	`46`	`final class SomeCommand`
`47`	`47`	`{`
`48`	`48`	`public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]`
`49`		`- string $argument, #[\Symfony\Component\Console\Attribute\Option]`
	`49`	`+ string $argument, #[\Symfony\Component\Console\Attribute\Option(name: 'option', shortcut: 'o', mode: InputOption::VALUE_NONE, description: 'Option description')]`
`50`	`50`	`$option): int`
`51`	`51`	`{`
`52`	`52`	`$someArgument = $argument;`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ use Symfony\Component\Console\Input\InputOption;`
`47`	`47`	`final class SomeCommandWithMethodChaining`
`48`	`48`	`{`
`49`	`49`	`public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]`
`50`		`- string $argument, #[\Symfony\Component\Console\Attribute\Option]`
	`50`	`+ string $argument, #[\Symfony\Component\Console\Attribute\Option(name: 'option', shortcut: 'o', mode: InputOption::VALUE_NONE, description: 'Option description')]`
`51`	`51`	`$option): int`
`52`	`52`	`{`
`53`	`53`	`$someArgument = $argument;`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ final class SomeCommandWithSetHelp`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`public function __invoke(#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]`
`55`		`- string $argument, #[\Symfony\Component\Console\Attribute\Option]`
	`55`	`+ string $argument, #[\Symfony\Component\Console\Attribute\Option(name: 'option', shortcut: 'o', mode: InputOption::VALUE_NONE, description: 'Option description')]`
`56`	`56`	`$option): int`
`57`	`57`	`{`
`58`	`58`	`$someArgument = $argument;`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ final class WithOverride`
`50`	`50`	`public function __invoke(`
`51`	`51`	`#[\Symfony\Component\Console\Attribute\Argument(name: 'argument', description: 'Argument description')]`
`52`	`52`	`string $argument,`
`53`		`- #[\Symfony\Component\Console\Attribute\Option]`
	`53`	`+ #[\Symfony\Component\Console\Attribute\Option(name: 'option', shortcut: 'o', mode: InputOption::VALUE_NONE, description: 'Option description')]`
`54`	`54`	`$option`
`55`	`55`	`): int`
`56`	`56`	`{`