Use #[AsCommand] to describe commands

Author: nicolas-grekas

Command/AboutCommand.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\Helper;
 use Symfony\Component\Console\Helper\TableSeparator;
@@ -27,18 +28,15 @@
  *
  * @final
  */
+#[AsCommand(name: 'about', description: 'Display information about the current project')]
 class AboutCommand extends Command
 {
-    protected static $defaultName = 'about';
-    protected static $defaultDescription = 'Display information about the current project';
-
     /**
      * {@inheritdoc}
      */
     protected function configure()
     {
         $this
-            ->setDescription(self::$defaultDescription)
             ->setHelp(<<<'EOT'
 The <info>%command.name%</info> command displays information about the current Symfony project.
 

Command/AssetsInstallCommand.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Input\InputArgument;
@@ -33,15 +34,13 @@
  *
  * @final
  */
+#[AsCommand(name: 'assets:install', description: 'Install bundle\'s web assets under a public directory')]
 class AssetsInstallCommand extends Command
 {
     public const METHOD_COPY = 'copy';
     public const METHOD_ABSOLUTE_SYMLINK = 'absolute symlink';
     public const METHOD_RELATIVE_SYMLINK = 'relative symlink';
 
-    protected static $defaultName = 'assets:install';
-    protected static $defaultDescription = 'Install bundle\'s web assets under a public directory';
-
     private $filesystem;
     private $projectDir;
 
@@ -65,7 +64,6 @@ protected function configure()
             ->addOption('symlink', null, InputOption::VALUE_NONE, 'Symlink the assets instead of copying them')
             ->addOption('relative', null, InputOption::VALUE_NONE, 'Make relative symlinks')
             ->addOption('no-cleanup', null, InputOption::VALUE_NONE, 'Do not remove the assets of the bundles that no longer exist')
-            ->setDescription(self::$defaultDescription)
             ->setHelp(<<<'EOT'
 The <info>%command.name%</info> command installs bundle assets into a given
 directory (e.g. the <comment>public</comment> directory).

Command/CacheClearCommand.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Exception\RuntimeException;
 use Symfony\Component\Console\Input\InputInterface;
@@ -33,11 +34,9 @@
  *
  * @final
  */
+#[AsCommand(name: 'cache:clear', description: 'Clear the cache')]
 class CacheClearCommand extends Command
 {
-    protected static $defaultName = 'cache:clear';
-    protected static $defaultDescription = 'Clear the cache';
-
     private $cacheClearer;
     private $filesystem;
 
@@ -59,7 +58,6 @@ protected function configure()
                 new InputOption('no-warmup', '', InputOption::VALUE_NONE, 'Do not warm up the cache'),
                 new InputOption('no-optional-warmers', '', InputOption::VALUE_NONE, 'Skip optional cache warmers (faster)'),
             ])
-            ->setDescription(self::$defaultDescription)
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command clears and warms up the application cache for a given environment
 and debug mode:

Command/CachePoolClearCommand.php

@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\FrameworkBundle\Command;
 
 use Psr\Cache\CacheItemPoolInterface;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Input\InputArgument;
@@ -25,11 +26,9 @@
  *
  * @author Nicolas Grekas <[email protected]>
  */
+#[AsCommand(name: 'cache:pool:clear', description: 'Clear cache pools')]
 final class CachePoolClearCommand extends Command
 {
-    protected static $defaultName = 'cache:pool:clear';
-    protected static $defaultDescription = 'Clear cache pools';
-
     private $poolClearer;
 
     public function __construct(Psr6CacheClearer $poolClearer)
@@ -48,7 +47,6 @@ protected function configure()
             ->setDefinition([
                 new InputArgument('pools', InputArgument::IS_ARRAY | InputArgument::REQUIRED, 'A list of cache pools or cache pool clearers'),
             ])
-            ->setDescription(self::$defaultDescription)
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command clears the given cache pools or cache pool clearers.
 

Command/CachePoolDeleteCommand.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -23,11 +24,9 @@
  *
  * @author Pierre du Plessis <[email protected]>
  */
+#[AsCommand(name: 'cache:pool:delete', description: 'Delete an item from a cache pool')]
 final class CachePoolDeleteCommand extends Command
 {
-    protected static $defaultName = 'cache:pool:delete';
-    protected static $defaultDescription = 'Delete an item from a cache pool';
-
     private $poolClearer;
 
     public function __construct(Psr6CacheClearer $poolClearer)
@@ -47,7 +46,6 @@ protected function configure()
                 new InputArgument('pool', InputArgument::REQUIRED, 'The cache pool from which to delete an item'),
                 new InputArgument('key', InputArgument::REQUIRED, 'The cache key to delete from the pool'),
             ])
-            ->setDescription(self::$defaultDescription)
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> deletes an item from a given cache pool.
 

Command/CachePoolListCommand.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -21,11 +22,9 @@
  *
  * @author Tobias Nyholm <[email protected]>
  */
+#[AsCommand(name: 'cache:pool:list', description: 'List available cache pools')]
 final class CachePoolListCommand extends Command
 {
-    protected static $defaultName = 'cache:pool:list';
-    protected static $defaultDescription = 'List available cache pools';
-
     private $poolNames;
 
     public function __construct(array $poolNames)
@@ -41,7 +40,6 @@ public function __construct(array $poolNames)
     protected function configure()
     {
         $this
-            ->setDescription(self::$defaultDescription)
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command lists all available cache pools.
 EOF

Command/CachePoolPruneCommand.php

@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\FrameworkBundle\Command;
 
 use Symfony\Component\Cache\PruneableInterface;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -22,11 +23,9 @@
  *
  * @author Rob Frawley 2nd <[email protected]>
  */
+#[AsCommand(name: 'cache:pool:prune', description: 'Prune cache pools')]
 final class CachePoolPruneCommand extends Command
 {
-    protected static $defaultName = 'cache:pool:prune';
-    protected static $defaultDescription = 'Prune cache pools';
-
     private $pools;
 
     /**
@@ -45,7 +44,6 @@ public function __construct(iterable $pools)
     protected function configure()
     {
         $this
-            ->setDescription(self::$defaultDescription)
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command deletes all expired items from all pruneable pools.
 

Command/CacheWarmupCommand.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -26,11 +27,9 @@
  *
  * @final
  */
+#[AsCommand(name: 'cache:warmup', description: 'Warm up an empty cache')]
 class CacheWarmupCommand extends Command
 {
-    protected static $defaultName = 'cache:warmup';
-    protected static $defaultDescription = 'Warm up an empty cache';
-
     private $cacheWarmer;
 
     public function __construct(CacheWarmerAggregate $cacheWarmer)
@@ -49,7 +48,6 @@ protected function configure()
             ->setDefinition([
                 new InputOption('no-optional-warmers', '', InputOption::VALUE_NONE, 'Skip optional cache warmers (faster)'),
             ])
-            ->setDescription(self::$defaultDescription)
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command warms up the cache.
 

Command/ConfigDebugCommand.php

@@ -13,6 +13,7 @@
 
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\Definition\Processor;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Exception\LogicException;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -31,11 +32,9 @@
  *
  * @final
  */
+#[AsCommand(name: 'debug:config', description: 'Dump the current configuration for an extension')]
 class ConfigDebugCommand extends AbstractConfigCommand
 {
-    protected static $defaultName = 'debug:config';
-    protected static $defaultDescription = 'Dump the current configuration for an extension';
-
     /**
      * {@inheritdoc}
      */
@@ -46,7 +45,6 @@ protected function configure()
                 new InputArgument('name', InputArgument::OPTIONAL, 'The bundle name or the extension alias'),
                 new InputArgument('path', InputArgument::OPTIONAL, 'The configuration option path'),
             ])
-            ->setDescription(self::$defaultDescription)
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command dumps the current configuration for an
 extension/bundle.

Command/ConfigDumpReferenceCommand.php

@@ -14,6 +14,7 @@
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\Definition\Dumper\XmlReferenceDumper;
 use Symfony\Component\Config\Definition\Dumper\YamlReferenceDumper;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -33,11 +34,9 @@
  *
  * @final
  */
+#[AsCommand(name: 'config:dump-reference', description: 'Dump the default configuration for an extension')]
 class ConfigDumpReferenceCommand extends AbstractConfigCommand
 {
-    protected static $defaultName = 'config:dump-reference';
-    protected static $defaultDescription = 'Dump the default configuration for an extension';
-
     /**
      * {@inheritdoc}
      */
@@ -49,7 +48,6 @@ protected function configure()
                 new InputArgument('path', InputArgument::OPTIONAL, 'The configuration option path'),
                 new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (yaml or xml)', 'yaml'),
             ])
-            ->setDescription(self::$defaultDescription)
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command dumps the default configuration for an
 extension/bundle.