feature #792 Make commands compatible with LazyCommand (nicolas-grekas)

weaverryan · weaverryan · commit 0a40b0e8e9cc · 2021-01-20T09:15:41.000-05:00
This PR was merged into the 1.0-dev branch. Discussion ---------- Make commands compatible with LazyCommand Sidekick of symfony/symfony#39851 When run with Symfony < 5.3, the generated commands are made forward-compatible with 5.3+ Commits ------- 42c199a Make commands compatible with LazyCommand
diff --git a/src/DependencyInjection/CompilerPass/MakeCommandRegistrationPass.php b/src/DependencyInjection/CompilerPass/MakeCommandRegistrationPass.php
@@ -14,6 +14,7 @@
 use Symfony\Bundle\MakerBundle\Command\MakerCommand;
 use Symfony\Bundle\MakerBundle\MakerInterface;
 use Symfony\Bundle\MakerBundle\Str;
+use Symfony\Component\Console\Command\LazyCommand;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -36,7 +37,18 @@ public function process(ContainerBuilder $container)
             $commandDefinition = new ChildDefinition('maker.auto_command.abstract');
             $commandDefinition->setClass(MakerCommand::class);
             $commandDefinition->replaceArgument(0, new Reference($id));
-            $commandDefinition->addTag('console.command', ['command' => $class::getCommandName()]);
+
+            $tagAttributes = ['command' => $class::getCommandName()];
+
+            if (!method_exists($class, 'getCommandDescription')) {
+                // no-op
+            } elseif (class_exists(LazyCommand::class)) {
+                $tagAttributes['description'] = $class::getCommandDescription();
+            } else {
+                $commandDefinition->addMethodCall('setDescription', [$class::getCommandDescription()]);
+            }
+
+            $commandDefinition->addTag('console.command', $tagAttributes);
 
             $container->setDefinition(sprintf('maker.auto_command.%s', Str::asTwigVariable($class::getCommandName())), $commandDefinition);
         }
diff --git a/src/Maker/MakeAuthenticator.php b/src/Maker/MakeAuthenticator.php
@@ -73,10 +73,14 @@ public static function getCommandName(): string
         return 'make:auth';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a Guard authenticator of different flavors';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConfig)
     {
         $command
-            ->setDescription('Creates a Guard authenticator of different flavors')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeAuth.txt'));
     }
 
diff --git a/src/Maker/MakeCommand.php b/src/Maker/MakeCommand.php
@@ -17,6 +17,7 @@
 use Symfony\Bundle\MakerBundle\InputConfiguration;
 use Symfony\Bundle\MakerBundle\Str;
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Command\LazyCommand;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 
@@ -31,10 +32,14 @@ public static function getCommandName(): string
         return 'make:command';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new console command class';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new console command class')
             ->addArgument('name', InputArgument::OPTIONAL, sprintf('Choose a command name (e.g. <fg=yellow>app:%s</>)', Str::asCommand(Str::getRandomTerm())))
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeCommand.txt'))
         ;
@@ -57,6 +62,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             'command/Command.tpl.php',
             [
                 'command_name' => $commandName,
+                'set_description' => !class_exists(LazyCommand::class),
             ]
         );
 
diff --git a/src/Maker/MakeController.php b/src/Maker/MakeController.php
@@ -34,10 +34,14 @@ public static function getCommandName(): string
         return 'make:controller';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new controller class';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new controller class')
             ->addArgument('controller-class', InputArgument::OPTIONAL, sprintf('Choose a name for your controller class (e.g. <fg=yellow>%sController</>)', Str::asClassName(Str::getRandomTerm())))
             ->addOption('no-template', null, InputOption::VALUE_NONE, 'Use this option to disable template generation')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeController.txt'))
diff --git a/src/Maker/MakeCrud.php b/src/Maker/MakeCrud.php
@@ -59,13 +59,17 @@ public static function getCommandName(): string
         return 'make:crud';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates CRUD for Doctrine entity class';
+    }
+
     /**
      * {@inheritdoc}
      */
     public function configureCommand(Command $command, InputConfiguration $inputConfig)
     {
         $command
-            ->setDescription('Creates CRUD for Doctrine entity class')
             ->addArgument('entity-class', InputArgument::OPTIONAL, sprintf('The class name of the entity to create CRUD (e.g. <fg=yellow>%s</>)', Str::asClassName(Str::getRandomTerm())))
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeCrud.txt'))
         ;
diff --git a/src/Maker/MakeDockerDatabase.php b/src/Maker/MakeDockerDatabase.php
@@ -64,10 +64,14 @@ public static function getCommandName(): string
         return 'make:docker:database';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Adds a database container to your docker-compose.yaml file';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConfig): void
     {
         $command
-            ->setDescription('Adds a database container to your docker-compose.yaml file')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeDockerDatabase.txt'))
         ;
     }
diff --git a/src/Maker/MakeEntity.php b/src/Maker/MakeEntity.php
@@ -75,10 +75,14 @@ public static function getCommandName(): string
         return 'make:entity';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates or updates a Doctrine entity class, and optionally an API Platform resource';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates or updates a Doctrine entity class, and optionally an API Platform resource')
             ->addArgument('name', InputArgument::OPTIONAL, sprintf('Class name of the entity to create or update (e.g. <fg=yellow>%s</>)', Str::asClassName(Str::getRandomTerm())))
             ->addOption('api-resource', 'a', InputOption::VALUE_NONE, 'Mark this class as an API Platform resource (expose a CRUD API for it)')
             ->addOption('regenerate', null, InputOption::VALUE_NONE, 'Instead of adding new fields, simply generate the methods (e.g. getter/setter) for existing fields')
diff --git a/src/Maker/MakeFixtures.php b/src/Maker/MakeFixtures.php
@@ -34,10 +34,14 @@ public static function getCommandName(): string
         return 'make:fixtures';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new class to load Doctrine fixtures';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new class to load Doctrine fixtures')
             ->addArgument('fixtures-class', InputArgument::OPTIONAL, 'The class name of the fixtures to create (e.g. <fg=yellow>AppFixtures</>)')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeFixture.txt'))
         ;
diff --git a/src/Maker/MakeForm.php b/src/Maker/MakeForm.php
@@ -48,10 +48,14 @@ public static function getCommandName(): string
         return 'make:form';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new form class';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new form class')
             ->addArgument('name', InputArgument::OPTIONAL, sprintf('The name of the form class (e.g. <fg=yellow>%sType</>)', Str::asClassName(Str::getRandomTerm())))
             ->addArgument('bound-class', InputArgument::OPTIONAL, 'The name of Entity or fully qualified model class name that the new form will be bound to (empty for none)')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeForm.txt'))
diff --git a/src/Maker/MakeFunctionalTest.php b/src/Maker/MakeFunctionalTest.php
@@ -34,10 +34,14 @@ public static function getCommandName(): string
         return 'make:functional-test';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new functional test class';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new functional test class')
             ->addArgument('name', InputArgument::OPTIONAL, 'The name of the functional test class (e.g. <fg=yellow>DefaultControllerTest</>)')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeFunctionalTest.txt'))
         ;
diff --git a/src/Maker/MakeMessage.php b/src/Maker/MakeMessage.php
@@ -42,10 +42,14 @@ public static function getCommandName(): string
         return 'make:message';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new message and handler';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new message and handler')
             ->addArgument('name', InputArgument::OPTIONAL, 'The name of the message class (e.g. <fg=yellow>SendEmailMessage</>)')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeMessage.txt'))
         ;
diff --git a/src/Maker/MakeMessengerMiddleware.php b/src/Maker/MakeMessengerMiddleware.php
@@ -32,10 +32,14 @@ public static function getCommandName(): string
         return 'make:messenger-middleware';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new messenger middleware';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConfig)
     {
         $command
-            ->setDescription('Creates a new messenger middleware')
             ->addArgument('name', InputArgument::OPTIONAL, 'The name of the middleware class (e.g. <fg=yellow>CustomMiddleware</>)')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeMessage.txt'));
     }
diff --git a/src/Maker/MakeMigration.php b/src/Maker/MakeMigration.php
@@ -48,6 +48,11 @@ public static function getCommandName(): string
         return 'make:migration';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new migration based on database changes';
+    }
+
     public function setApplication(Application $application)
     {
         $this->application = $application;
@@ -56,7 +61,6 @@ public function setApplication(Application $application)
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new migration based on database changes')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeMigration.txt'))
         ;
 
diff --git a/src/Maker/MakeRegistrationForm.php b/src/Maker/MakeRegistrationForm.php
@@ -71,10 +71,14 @@ public static function getCommandName(): string
         return 'make:registration-form';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new registration form system';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new registration form system')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeRegistrationForm.txt'))
         ;
     }
diff --git a/src/Maker/MakeResetPassword.php b/src/Maker/MakeResetPassword.php
@@ -68,10 +68,14 @@ public static function getCommandName(): string
         return 'make:reset-password';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Create controller, entity, and repositories for use with symfonycasts/reset-password-bundle';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConfig)
     {
         $command
-            ->setDescription('Create controller, entity, and repositories for use with symfonycasts/reset-password-bundle')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeResetPassword.txt'))
         ;
     }
diff --git a/src/Maker/MakeSerializerEncoder.php b/src/Maker/MakeSerializerEncoder.php
@@ -30,10 +30,14 @@ public static function getCommandName(): string
         return 'make:serializer:encoder';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new serializer encoder class';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new serializer encoder class')
             ->addArgument('name', InputArgument::OPTIONAL, 'Choose a class name for your encoder (e.g. <fg=yellow>YamlEncoder</>)')
             ->addArgument('format', InputArgument::OPTIONAL, 'Pick your format name (e.g. <fg=yellow>yaml</>)')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeSerializerEncoder.txt'))
diff --git a/src/Maker/MakeSerializerNormalizer.php b/src/Maker/MakeSerializerNormalizer.php
@@ -30,10 +30,14 @@ public static function getCommandName(): string
         return 'make:serializer:normalizer';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new serializer normalizer class';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new serializer normalizer class')
             ->addArgument('name', InputArgument::OPTIONAL, 'Choose a class name for your normalizer (e.g. <fg=yellow>UserNormalizer</>)')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeSerializerNormalizer.txt'))
         ;
diff --git a/src/Maker/MakeSubscriber.php b/src/Maker/MakeSubscriber.php
@@ -41,10 +41,14 @@ public static function getCommandName(): string
         return 'make:subscriber';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new event subscriber class';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new event subscriber class')
             ->addArgument('name', InputArgument::OPTIONAL, 'Choose a class name for your event subscriber (e.g. <fg=yellow>ExceptionSubscriber</>)')
             ->addArgument('event', InputArgument::OPTIONAL, 'What event do you want to subscribe to?')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeSubscriber.txt'))
diff --git a/src/Maker/MakeTwigExtension.php b/src/Maker/MakeTwigExtension.php
@@ -31,10 +31,14 @@ public static function getCommandName(): string
         return 'make:twig-extension';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new Twig extension class';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new Twig extension class')
             ->addArgument('name', InputArgument::OPTIONAL, 'The name of the Twig extension class (e.g. <fg=yellow>AppExtension</>)')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeTwigExtension.txt'))
         ;
diff --git a/src/Maker/MakeUnitTest.php b/src/Maker/MakeUnitTest.php
@@ -30,10 +30,14 @@ public static function getCommandName(): string
         return 'make:unit-test';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new unit test class';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new unit test class')
             ->addArgument('name', InputArgument::OPTIONAL, 'The name of the unit test class (e.g. <fg=yellow>UtilTest</>)')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeUnitTest.txt'))
         ;
diff --git a/src/Maker/MakeUser.php b/src/Maker/MakeUser.php
@@ -67,10 +67,14 @@ public static function getCommandName(): string
         return 'make:user';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new security user class';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new security user class')
             ->addArgument('name', InputArgument::OPTIONAL, 'The name of the security user class (e.g. <fg=yellow>User</>)')
             ->addOption('is-entity', null, InputOption::VALUE_NONE, 'Do you want to store user data in the database (via Doctrine)?')
             ->addOption('identity-property-name', null, InputOption::VALUE_REQUIRED, 'Enter a property name that will be the unique "display" name for the user (e.g. <comment>email, username, uuid</comment>)')
diff --git a/src/Maker/MakeValidator.php b/src/Maker/MakeValidator.php
@@ -32,10 +32,14 @@ public static function getCommandName(): string
         return 'make:validator';
     }
 
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new validator and constraint class';
+    }
+
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates a new validator and constraint class')
             ->addArgument('name', InputArgument::OPTIONAL, 'The name of the validator class (e.g. <fg=yellow>EnabledValidator</>)')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeValidator.txt'))
         ;
diff --git a/src/Maker/MakeVoter.php b/src/Maker/MakeVoter.php
diff --git a/src/MakerInterface.php b/src/MakerInterface.php
diff --git a/src/Resources/skeleton/command/Command.tpl.php b/src/Resources/skeleton/command/Command.tpl.php

Original file line number	Diff line number	Diff line change
`@@ -73,10 +73,14 @@ public static function getCommandName(): string`
`73`	`73`	`return 'make:auth';`
`74`	`74`	`}`
`75`	`75`
	`76`	`+ public static function getCommandDescription(): string`
	`77`	`+ {`
	`78`	`+ return 'Creates a Guard authenticator of different flavors';`
	`79`	`+ }`
	`80`	`+`
`76`	`81`	`public function configureCommand(Command $command, InputConfiguration $inputConfig)`
`77`	`82`	`{`
`78`	`83`	`$command`
`79`		`- ->setDescription('Creates a Guard authenticator of different flavors')`
`80`	`84`	`->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeAuth.txt'));`
`81`	`85`	`}`
`82`	`86`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`	`use Symfony\Bundle\MakerBundle\InputConfiguration;`
`18`	`18`	`use Symfony\Bundle\MakerBundle\Str;`
`19`	`19`	`use Symfony\Component\Console\Command\Command;`
	`20`	`+use Symfony\Component\Console\Command\LazyCommand;`
`20`	`21`	`use Symfony\Component\Console\Input\InputArgument;`
`21`	`22`	`use Symfony\Component\Console\Input\InputInterface;`
`22`	`23`
`@@ -31,10 +32,14 @@ public static function getCommandName(): string`
`31`	`32`	`return 'make:command';`
`32`	`33`	`}`
`33`	`34`
	`35`	`+ public static function getCommandDescription(): string`
	`36`	`+ {`
	`37`	`+ return 'Creates a new console command class';`
	`38`	`+ }`
	`39`	`+`
`34`	`40`	`public function configureCommand(Command $command, InputConfiguration $inputConf)`
`35`	`41`	`{`
`36`	`42`	`$command`
`37`		`- ->setDescription('Creates a new console command class')`
`38`	`43`	`->addArgument('name', InputArgument::OPTIONAL, sprintf('Choose a command name (e.g. <fg=yellow>app:%s</>)', Str::asCommand(Str::getRandomTerm())))`
`39`	`44`	`->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeCommand.txt'))`
`40`	`45`	`;`
`@@ -57,6 +62,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen`
`57`	`62`	`'command/Command.tpl.php',`
`58`	`63`	`[`
`59`	`64`	`'command_name' => $commandName,`
	`65`	`+ 'set_description' => !class_exists(LazyCommand::class),`
`60`	`66`	`]`
`61`	`67`	`);`
`62`	`68`
Original file line number	Diff line number	Diff line change
`@@ -59,13 +59,17 @@ public static function getCommandName(): string`
`59`	`59`	`return 'make:crud';`
`60`	`60`	`}`
`61`	`61`
	`62`	`+ public static function getCommandDescription(): string`
	`63`	`+ {`
	`64`	`+ return 'Creates CRUD for Doctrine entity class';`
	`65`	`+ }`
	`66`	`+`
`62`	`67`	`/**`
`63`	`68`	`* {@inheritdoc}`
`64`	`69`	`*/`
`65`	`70`	`public function configureCommand(Command $command, InputConfiguration $inputConfig)`
`66`	`71`	`{`
`67`	`72`	`$command`
`68`		`- ->setDescription('Creates CRUD for Doctrine entity class')`
`69`	`73`	`->addArgument('entity-class', InputArgument::OPTIONAL, sprintf('The class name of the entity to create CRUD (e.g. <fg=yellow>%s</>)', Str::asClassName(Str::getRandomTerm())))`
`70`	`74`	`->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeCrud.txt'))`
`71`	`75`	`;`
Original file line number	Diff line number	Diff line change
`@@ -64,10 +64,14 @@ public static function getCommandName(): string`
`64`	`64`	`return 'make:docker:database';`
`65`	`65`	`}`
`66`	`66`
	`67`	`+ public static function getCommandDescription(): string`
	`68`	`+ {`
	`69`	`+ return 'Adds a database container to your docker-compose.yaml file';`
	`70`	`+ }`
	`71`	`+`
`67`	`72`	`public function configureCommand(Command $command, InputConfiguration $inputConfig): void`
`68`	`73`	`{`
`69`	`74`	`$command`
`70`		`- ->setDescription('Adds a database container to your docker-compose.yaml file')`
`71`	`75`	`->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeDockerDatabase.txt'))`
`72`	`76`	`;`
`73`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,10 +34,14 @@ public static function getCommandName(): string`
`34`	`34`	`return 'make:fixtures';`
`35`	`35`	`}`
`36`	`36`
	`37`	`+ public static function getCommandDescription(): string`
	`38`	`+ {`
	`39`	`+ return 'Creates a new class to load Doctrine fixtures';`
	`40`	`+ }`
	`41`	`+`
`37`	`42`	`public function configureCommand(Command $command, InputConfiguration $inputConf)`
`38`	`43`	`{`
`39`	`44`	`$command`
`40`		`- ->setDescription('Creates a new class to load Doctrine fixtures')`
`41`	`45`	`->addArgument('fixtures-class', InputArgument::OPTIONAL, 'The class name of the fixtures to create (e.g. <fg=yellow>AppFixtures</>)')`
`42`	`46`	`->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeFixture.txt'))`
`43`	`47`	`;`