symfony · alamirault · May 29, 2024 · May 30, 2024
@@ -11,23 +11,28 @@
 
 namespace Symfony\Component\Console\Attribute;
 
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputDefinition;
+
    /**
  * Service tag to autoconfigure commands.
  */
 #[\Attribute(\Attribute::TARGET_CLASS)]
 class AsCommand
 {
     /**
-     * @param string      $name        The name of the command, used when calling it (i.e. "cache:clear")
-     * @param string|null $description The description of the command, displayed with the help page
-     * @param string[]    $aliases     The list of aliases of the command. The command will be executed when using one of them (i.e. "cache:clean")
-     * @param bool        $hidden      If true, the command won't be shown when listing all the available commands, but it can still be run as any other command
+     * @param string                                             $name        The name of the command, used when calling it (i.e. "cache:clear")
+     * @param string|null                                        $description The description of the command, displayed with the help page
+     * @param string[]                                           $aliases     The list of aliases of the command. The command will be executed when using one of them (i.e. "cache:clean")
+     * @param bool                                               $hidden      If true, the command won't be shown when listing all the available commands, but it can still be run as any other command
+     * @param array<InputArgument|InputArgument>|InputDefinition $definition  The list of argument and option instances
      */
     public function __construct(
         public string $name,
         public ?string $description = null,
         array $aliases = [],
         bool $hidden = false,
+        public array|InputDefinition $definition = [],
     ) {
         if (!$hidden && !$aliases) {
             return;

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.2
+---
+
+ * Add the `definition` option to configure arguments and options in the `AsCommand` attribute
+
 7.1
 ---
 

@@ -100,6 +100,10 @@ public function __construct(?string $name = null)
             $this->setDescription(static::getDefaultDescription() ?? '');
         }
 
+        if ($attribute = (new \ReflectionClass(static::class))->getAttributes(AsCommand::class)) {
+            $this->setDefinition($attribute[0]->newInstance()->definition);
+        }
+
         $this->configure();
     }
 

@@ -462,6 +462,18 @@ public function testDefaultCommand()
    
         $this->assertEquals('foo2', $property->getValue($apl));
     }
+
+    public function testCommandWithDefinitionAttribute()
+    {
+        $this->assertSame('my:command:with-definition', CommandWithDefinition::getDefaultName());
+
+        $command = new CommandWithDefinition();
+
+        $this->assertSame('my:command:with-definition', $command->getName());
+
+        $this->assertTrue($command->getDefinition()->hasArgument('target'));
+        $this->assertTrue($command->getDefinition()->hasOption('symlink'));
+    }
 }
 
 // In order to get an unbound closure, we should create it outside a class
@@ -490,3 +502,14 @@ class MyAnnotatedCommand extends Command
 
     protected static $defaultDescription = 'This description should be ignored.';
 }
+
+#[AsCommand(
+    name: 'my:command:with-definition',
+    definition: [
+        new InputArgument('target', InputArgument::OPTIONAL, 'The target directory', null),
+        new InputOption('symlink', null, InputOption::VALUE_NONE),
+    ]
+)]
+class CommandWithDefinition extends Command
+{
+}