Deprecate Annotated Commands in favor of native Symfony Console commands

src/Application.php

@@ -11,6 +11,7 @@
 use Drush\Boot\DrupalBootLevels;
 use Drush\Command\RemoteCommandProxy;
 use Drush\Config\ConfigAwareTrait;
+use Drush\Event\ConsoleDefinitionsEvent;
 use Drush\Runtime\RedispatchHook;
 use Drush\Runtime\ServiceManager;
 use Drush\Runtime\TildeExpansionHook;
@@ -309,6 +310,8 @@ public function configureAndRegisterCommands(InputInterface $input, OutputInterf
         // any of the configuration steps we do here.
         $this->configureIO($input, $output);
 
+        $this->addListeners($commandfileSearchpath);
+
         // Directly add the yaml-cli commands.
         $this->addCommands($this->serviceManager->instantiateYamlCliCommands());
 
@@ -327,6 +330,9 @@ public function configureAndRegisterCommands(InputInterface $input, OutputInterf
         // Note that Robo::register can accept either Annotated Command
         // command handlers or Symfony Console Command objects.
         Robo::register($this, $commandInstances);
+
+        // Dispatch our custom event. It also fires later in \Drush\Boot\DrupalBoot8::bootstrapDrupalFull.
+        Drush::getContainer()->get('eventDispatcher')->dispatch(new ConsoleDefinitionsEvent($this), ConsoleDefinitionsEvent::class);
     }
 
     /**
@@ -338,4 +344,12 @@ public function renderThrowable(\Throwable $e, OutputInterface $output): void
 
         $this->doRenderThrowable($e, $output);
     }
+
+    // Discover event listeners, and add those that do not require bootstrap.
+    protected function addListeners($commandfileSearchpath): void
+    {
+        $listenerClasses = $this->serviceManager->discoverListeners($commandfileSearchpath, '\Drush');
+        $listenerClasses = $this->serviceManager->filterListeners($listenerClasses);
+        $this->serviceManager->addListeners($listenerClasses, Drush::getContainer());
+    }
 }

src/Attributes/DefaultFields.php

@@ -5,8 +5,25 @@
 namespace Drush\Attributes;
 
 use Attribute;
+use Drush\Formatters\FormatterConfigurationItemProviderInterface;
 
-#[Attribute(Attribute::TARGET_METHOD)]
-class DefaultFields extends \Consolidation\AnnotatedCommand\Attributes\DefaultFields
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
+class DefaultFields implements FormatterConfigurationItemProviderInterface
 {
+    const KEY = 'default-fields';
+
+    /**
+     * @param $fields
+     *   An array of field names to show by default.
+     */
+    public function __construct(public array $fields)
+    {
+    }
+
+    public function getConfigurationItem(\ReflectionAttribute $attribute): array
+    {
+        $args = $attribute->getArguments();
+        return [self::KEY => $args['fields']];
+    }
+
 }

src/Attributes/DefaultTableFields.php

@@ -5,8 +5,24 @@
 namespace Drush\Attributes;
 
 use Attribute;
+use Drush\Formatters\FormatterConfigurationItemProviderInterface;
 
-#[Attribute(Attribute::TARGET_METHOD)]
-class DefaultTableFields extends \Consolidation\AnnotatedCommand\Attributes\DefaultTableFields
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
+class DefaultTableFields implements FormatterConfigurationItemProviderInterface
 {
+    const KEY = 'default-table-fields';
+
+    /**
+     * @param $fields
+     *   An array of field names to show by default when using table formatter.
+     */
+    public function __construct(public array $fields)
+    {
+    }
+
+    public function getConfigurationItem(\ReflectionAttribute $attribute): array
+    {
+        $args = $attribute->getArguments();
+        return [self::KEY => $args['fields']];
+    }
 }

src/Attributes/FieldLabels.php

@@ -1,12 +1,28 @@
 <?php
 
-declare(strict_types=1);
-
 namespace Drush\Attributes;
 
 use Attribute;
+use Drush\Formatters\FormatterConfigurationItemProviderInterface;
 
-#[Attribute(Attribute::TARGET_METHOD)]
-class FieldLabels extends \Consolidation\AnnotatedCommand\Attributes\FieldLabels
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS)]
+class FieldLabels implements FormatterConfigurationItemProviderInterface
 {
+
+    const KEY = 'field-labels';
+
+    /**
+     * @param $labels
+     *   An associative array of field names and labels for display.
+     */
+    public function __construct(
+        public array $labels
+    ) {
+    }
+
+    public function getConfigurationItem(\ReflectionAttribute $attribute): array
+    {
+        $args = $attribute->getArguments();
+        return [self::KEY => $args['labels']];
+    }
 }

src/Attributes/FilterDefaultField.php

@@ -1,12 +1,27 @@
 <?php
 
-declare(strict_types=1);
-
 namespace Drush\Attributes;
 
 use Attribute;
+use Drush\Formatters\FormatterConfigurationItemProviderInterface;
 
-#[Attribute(Attribute::TARGET_METHOD)]
-class FilterDefaultField extends \Consolidation\AnnotatedCommand\Attributes\FilterDefaultField
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS)]
+class FilterDefaultField implements FormatterConfigurationItemProviderInterface
 {
+    const KEY = 'filter-default-field';
+
+    /**
+     * @param $field
+     *   A field name to filter on by default.
+     */
+    public function __construct(
+        public string $field
+    ) {
+    }
+
+    public function getConfigurationItem(\ReflectionAttribute $attribute): array
+    {
+        $args = $attribute->getArguments();
+        return [self::KEY => $args['field']];
+    }
 }

src/Attributes/Format.php

@@ -7,7 +7,6 @@
 use Attribute;
 use Consolidation\AnnotatedCommand\Parser\CommandInfo;
 use Consolidation\OutputFormatters\Options\FormatterOptions;
-use Drush\Boot\Kernels;
 use JetBrains\PhpStorm\ExpectedValues;
 
 #[Attribute(Attribute::TARGET_METHOD)]

src/Attributes/ValidateModulesEnabled.php

@@ -8,7 +8,7 @@
 use Consolidation\AnnotatedCommand\CommandData;
 use Consolidation\AnnotatedCommand\CommandError;
 
-#[Attribute(Attribute::TARGET_METHOD)]
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
 class ValidateModulesEnabled extends ValidatorBase implements ValidatorInterface
 {
     /**

src/Boot/DrupalBoot8.php

@@ -13,11 +13,10 @@
 use Drush\Config\ConfigLocator;
 use Drush\Drupal\DrushLoggerServiceProvider;
 use Drush\Drush;
+use Drush\Event\ConsoleDefinitionsEvent;
 use Drush\Runtime\LegacyServiceFinder;
 use Drush\Runtime\LegacyServiceInstantiator;
 use Drush\Runtime\ServiceManager;
-use Psr\Log\LoggerAwareInterface;
-use Psr\Log\LoggerInterface;
 use Robo\Robo;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -215,12 +214,20 @@ public function bootstrapDrupalFull(BootstrapManager $manager): void
         // Directly add the Drupal core bootstrapped commands.
         Drush::getApplication()->addCommands($this->serviceManager->instantiateDrupalCoreBootstrappedCommands());
 
+        $this->addBootstrapListeners();
+
         $this->addDrupalModuleDrushCommands($manager);
 
+        // Dispatch our custom event. It also fires earlier in \Drush\Application::configureAndRegisterCommands.
+        Drush::getContainer()->get('eventDispatcher')->dispatch(new ConsoleDefinitionsEvent(Drush::getApplication()), ConsoleDefinitionsEvent::class);
+
         // Set a default account to make sure the correct timezone is set
         $this->kernel->getContainer()->get('current_user')->setAccount(new AnonymousUserSession());
     }
 
+    /**
+     * Adds module supplied commands, as well as Drush Console commands that require bootstrap.
+     */
     public function addDrupalModuleDrushCommands(BootstrapManager $manager): void
     {
         $application = Drush::getApplication();
@@ -323,4 +330,17 @@ public function bootstrapDrupalSite(BootstrapManager $manager)
     {
         $this->bootstrapDoDrupalSite($manager);
     }
+
+    // Add the Listeners that require bootstrap.
+    public function addBootstrapListeners(): void
+    {
+        $listenersInThisModule = [];
+        $moduleHandler = \Drupal::moduleHandler();
+        foreach ($moduleHandler->getModuleList() as $moduleId => $extension) {
+            $path = DRUPAL_ROOT . '/' . $extension->getPath() . '/src/Drush';
+            $listenersInThisModule = array_merge($listenersInThisModule, $this->serviceManager->discoverListeners([$path], "\Drupal\\$moduleId\Drush"));
+        }
+        $classes = $this->serviceManager->bootstrapListenerClasses();
+        $this->serviceManager->addListeners(array_merge($listenersInThisModule, $classes), Drush::getContainer(), \Drupal::getContainer());
+    }
 }

src/Commands/core/CoreCommands.php

@@ -4,12 +4,12 @@
 
 namespace Drush\Commands\core;
 
+use Consolidation\OutputFormatters\Options\FormatterOptions;
 use Consolidation\OutputFormatters\StructuredData\PropertyList;
+use Consolidation\OutputFormatters\StructuredData\RowsOfFields;
 use Drush\Attributes as CLI;
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
-use Consolidation\OutputFormatters\StructuredData\RowsOfFields;
-use Consolidation\OutputFormatters\Options\FormatterOptions;
 
 final class CoreCommands extends DrushCommands
 {

src/Commands/core/TwigCommands.php

@@ -4,26 +4,22 @@
 
 namespace Drush\Commands\core;
 
-use Consolidation\OutputFormatters\StructuredData\RowsOfFields;
 use Drupal\Core\DrupalKernelInterface;
 use Drupal\Core\Extension\ModuleExtensionList;
 use Drupal\Core\Extension\ModuleHandlerInterface;
-use Drupal\Core\PhpStorage\PhpStorageFactory;
 use Drupal\Core\State\StateInterface;
 use Drupal\Core\Template\TwigEnvironment;
 use Drush\Attributes as CLI;
 use Drush\Commands\AutowireTrait;
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
-use Drush\Utils\StringUtils;
 use Symfony\Component\Filesystem\Path;
 use Symfony\Component\Finder\Finder;
 
 final class TwigCommands extends DrushCommands
 {
     use AutowireTrait;
 
-    const UNUSED = 'twig:unused';
     const COMPILE = 'twig:compile';
     const DEBUG = 'twig:debug';
 
@@ -36,51 +32,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * Find potentially unused Twig templates.
-     *
-     * Immediately before running this command, web crawl your entire web site. Or
-     * use your Production PHPStorage dir for comparison.
-     */
-    #[CLI\Command(name: self::UNUSED, aliases: [])]
-    #[CLI\Argument(name: 'searchpaths', description: 'A comma delimited list of paths to recursively search')]
-    #[CLI\Usage(name: 'drush twig:unused --field=template /var/www/mass.local/docroot/modules/custom,/var/www/mass.local/docroot/themes/custom', description: 'Output a simple list of potentially unused templates.')]
-    #[CLI\FieldLabels(labels: ['template' => 'Template', 'compiled' => 'Compiled'])]
-    #[CLI\DefaultTableFields(fields: ['template', 'compiled'])]
-    public function unused($searchpaths): RowsOfFields
-    {
-        $unused = [];
-        $phpstorage = PhpStorageFactory::get('twig');
-
-        // Find all templates in the codebase.
-        $files = Finder::create()
-            ->files()
-            ->name('*.html.twig')
-            ->exclude('tests')
-            ->in(StringUtils::csvToArray($searchpaths));
-        $this->logger()->notice(dt('Found !count templates', ['!count' => count($files)]));
-
-        // Check to see if a compiled equivalent exists in PHPStorage
-        foreach ($files as $file) {
-            $relative = Path::makeRelative($file->getRealPath(), Drush::bootstrapManager()->getRoot());
-            $mainCls = $this->twig->getTemplateClass($relative);
-            $cache = $this->twig->getCache();
-            if ($cache) {
-                $key = $cache->generateKey($relative, $mainCls);
-                if (!$phpstorage->exists($key)) {
-                    $unused[$key] = [
-                        'template' => $relative,
-                        'compiled' => $key,
-                    ];
-                }
-            } else {
-                throw new \Exception('There was a problem, please ensure your twig cache is enabled.');
-            }
-        }
-        $this->logger()->notice(dt('Found !count unused', ['!count' => count($unused)]));
-        return new RowsOfFields($unused);
-    }
-
     /**
      * Compile all Twig template(s).
      */