Allow to create an InvokableCommand using the make:command command

Move the "Old" Inheritance based command template to a separate template file

Author: Kefisu

src/Maker/MakeCommand.php

@@ -16,16 +16,20 @@
 use Symfony\Bundle\MakerBundle\Generator;
 use Symfony\Bundle\MakerBundle\InputConfiguration;
 use Symfony\Bundle\MakerBundle\Str;
+use Symfony\Bundle\MakerBundle\Util\ClassNameDetails;
 use Symfony\Bundle\MakerBundle\Util\PhpCompatUtil;
 use Symfony\Bundle\MakerBundle\Util\UseStatementGenerator;
+use Symfony\Component\Console\Attribute\Argument;
 use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Attribute\Option;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Command\LazyCommand;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Component\HttpKernel\Kernel;
 
 /**
  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
@@ -60,15 +64,19 @@ public function configureCommand(Command $command, InputConfiguration $inputConf
             ->addArgument('name', InputArgument::OPTIONAL, \sprintf('Choose a command name (e.g. <fg=yellow>app:%s</>)', Str::asCommand(Str::getRandomTerm())))
             ->setHelp($this->getHelpFileContents('MakeCommand.txt'))
         ;
+
+        if ($this->supportsInvokableCommand()) {
+            $command->addOption('invokable', 'i', InputOption::VALUE_NONE, 'Use this option to create an invokable command');
+        }
     }
 
     public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
     {
-        $this->generateInheritanceCommand($input, $io, $generator);
-    }
+        if (true !== $input->getOption('invokable') && $this->supportsInvokableCommand()) {
+            $wantsInvokable = $io->confirm('Would you like this command to be inokvable?', false);
+            $input->setOption('invokable', $wantsInvokable);
+        }
 
-    private function generateInheritanceCommand(InputInterface $input, ConsoleStyle $io, Generator $generator): void
-    {
         $commandName = trim($input->getArgument('name'));
         $commandNameHasAppPrefix = str_starts_with($commandName, 'app:');
 
@@ -79,6 +87,13 @@ private function generateInheritanceCommand(InputInterface $input, ConsoleStyle
             \sprintf('The "%s" command name is not valid because it would be implemented by "%s" class, which is not valid as a PHP class name (it must start with a letter or underscore, followed by any number of letters, numbers, or underscores).', $commandName, Str::asClassName($commandName, 'Command'))
         );
 
+        $input->getOption('invokable') ? 
+            $this->generateInvokableCommand($commandName, $commandClassNameDetails, $io, $generator) : 
+            $this->generateInheritanceCommand($commandName, $commandClassNameDetails, $io, $generator);
+    }
+
+    private function generateInheritanceCommand(string $commandName, ClassNameDetails $commandClassNameDetails, ConsoleStyle $io, Generator $generator): void
+    {
         $useStatements = new UseStatementGenerator([
             Command::class,
             InputArgument::class,
@@ -91,7 +106,7 @@ private function generateInheritanceCommand(InputInterface $input, ConsoleStyle
 
         $generator->generateClass(
             $commandClassNameDetails->getFullName(),
-            'command/Command.tpl.php',
+            'command/InheritanceCommand.tpl.php',
             [
                 'use_statements' => $useStatements,
                 'command_name' => $commandName,
@@ -108,11 +123,44 @@ private function generateInheritanceCommand(InputInterface $input, ConsoleStyle
         ]);
     }
 
+    private function generateInvokableCommand(string $commandName, ClassNameDetails $commandClassNameDetails, ConsoleStyle $io, Generator $generator): void
+    {
+        $useStatements = new UseStatementGenerator([
+            Argument::class,
+            AsCommand::class,
+            Command::class,
+            Option::class,
+            SymfonyStyle::class,
+        ]);
+
+        $generator->generateClass(
+            $commandClassNameDetails->getFullName(),
+            'command/Command.tpl.php',
+            [
+                'use_statements' => $useStatements,
+                'command_name' => $commandName,
+            ]
+        );
+
+        $generator->writeChanges();
+
+        $this->writeSuccessMessage($io);
+        $io->text([
+            'Next: open your new command class and customize it!',
+            'Find the documentation at <fg=yellow>https://symfony.com/doc/current/console.html</>',
+        ]);
+    }
+
     public function configureDependencies(DependencyBuilder $dependencies): void
     {
         $dependencies->addClassDependency(
             Command::class,
             'console'
         );
     }
+    
+    private function supportsInvokableCommand(): bool
+    {
+        return Kernel::VERSION_ID >= 70300;
+    }
 }

templates/command/Command.tpl.php

@@ -8,32 +8,19 @@
     name: '<?= $command_name; ?>',
     description: 'Add a short description for your command',
 )]
-class <?= $class_name; ?> extends Command
+class <?= $class_name; ?>
 {
-    public function __construct()
+    public function __invoke(
+        SymfonyStyle $io,
+        #[Argument] string $arg1 = null,
+        #[Option] bool $option1 = false,
+    ): int
     {
-        parent::__construct();
-    }
-
-    protected function configure(): void
-    {
-        $this
-<?= $set_description ? "            ->setDescription(self::\$defaultDescription)\n" : '' ?>
-            ->addArgument('arg1', InputArgument::OPTIONAL, 'Argument description')
-            ->addOption('option1', null, InputOption::VALUE_NONE, 'Option description')
-        ;
-    }
-
-    protected function execute(InputInterface $input, OutputInterface $output): int
-    {
-        $io = new SymfonyStyle($input, $output);
-        $arg1 = $input->getArgument('arg1');
-
         if ($arg1) {
             $io->note(sprintf('You passed an argument: %s', $arg1));
         }
 
-        if ($input->getOption('option1')) {
+        if ($option1) {
             // ...
         }
 

templates/command/InheritanceCommand.tpl.php

@@ -0,0 +1,45 @@
+<?= "<?php\n"; ?>
+
+namespace <?= $namespace; ?>;
+
+<?= $use_statements; ?>
+
+#[AsCommand(
+    name: '<?= $command_name; ?>',
+    description: 'Add a short description for your command',
+)]
+class <?= $class_name; ?> extends Command
+{
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+<?= $set_description ? "            ->setDescription(self::\$defaultDescription)\n" : '' ?>
+            ->addArgument('arg1', InputArgument::OPTIONAL, 'Argument description')
+            ->addOption('option1', null, InputOption::VALUE_NONE, 'Option description')
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+        $arg1 = $input->getArgument('arg1');
+
+        if ($arg1) {
+            $io->note(sprintf('You passed an argument: %s', $arg1));
+        }
+
+        if ($input->getOption('option1')) {
+            // ...
+        }
+
+        $io->success('You have a new command! Now make it your own! Pass --help to see your options.');
+
+        return Command::SUCCESS;
+    }
+}
+