Add an attribute for formatter options (#5805)

* Add an attribute for formatter options * Revert changed to QueueCommands
drush-ops · Nov 5, 2023 · 0175517 · 0175517
1 parent 25b4b82
commit 0175517
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 5 deletions.
diff --git a/src/Attributes/Format.php b/src/Attributes/Format.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drush\Attributes;
+
+use Attribute;
+use Consolidation\AnnotatedCommand\Parser\CommandInfo;
+use Consolidation\OutputFormatters\Options\FormatterOptions;
+use Drush\Boot\Kernels;
+use JetBrains\PhpStorm\ExpectedValues;
+
+#[Attribute(Attribute::TARGET_METHOD)]
+class Format
+{
+    /**
+     * @param ?string $listDelimiter
+     *    The delimiter between fields
+     * @param ?string $tableStyle
+     *    The table style.
+     */
+    public function __construct(
+        public ?string $listDelimiter,
+        # Sadly, \Symfony\Component\Console\Helper\Table::initStyles is private.
+        #[ExpectedValues(['box', 'box-double', 'borderless', 'compact', 'consolidation'])] public ?string $tableStyle
+    ) {
+    }
+
+    public static function handle(\ReflectionAttribute $attribute, CommandInfo $commandInfo)
+    {
+        $instance = $attribute->newInstance();
+        $commandInfo->addAnnotation(FormatterOptions::LIST_DELIMITER, $instance->listDelimiter);
+        $commandInfo->addAnnotation(FormatterOptions::TABLE_STYLE, $instance->tableStyle);
+    }
+}
diff --git a/src/Attributes/Obsolete.php b/src/Attributes/Obsolete.php
@@ -9,7 +9,7 @@
 
 /**
  * Mark commands as obsolete. These commands are omitted from help list and when
- * user tries to run one the commmand's description is shown. Example usage at https://github.com/drush-ops/drush/blob/12.x/src/Commands/LegacyCommands.php
+ * user tries to run one, the command's description is shown. Example usage at https://github.com/drush-ops/drush/blob/12.x/src/Commands/LegacyCommands.php
  */
 #[Attribute(Attribute::TARGET_METHOD)]
 class Obsolete extends NoArgumentsBase

diff --git a/src/Commands/core/CoreCommands.php b/src/Commands/core/CoreCommands.php
@@ -69,8 +69,7 @@ public function globalOptions($options = ['format' => 'table']): RowsOfFields
      * Show Drush version.
      */
     #[CLI\Command(name: self::VERSION)]
-    #[CLI\HookSelector(name: 'table-style', value: 'compact')]
-    #[CLI\HookSelector(name: 'list-delimiter', value: ':')]
+    #[CLI\Format(listDelimiter: ':', tableStyle: 'compact')]
     #[CLI\FieldLabels(labels: ['drush-version' => 'Drush version'])]
     public function version($options = ['format' => 'table']): PropertyList
     {

diff --git a/src/Commands/core/StatusCommands.php b/src/Commands/core/StatusCommands.php
@@ -36,8 +36,7 @@ final class StatusCommands extends DrushCommands implements SiteAliasManagerAwar
     #[CLI\Option(name: 'project', description: 'A comma delimited list of projects. Their paths will be added to path-aliases section.')]
     #[CLI\Usage(name: 'drush core-status --field=files', description: 'Emit just one field, not all the default fields.')]
     #[CLI\Usage(name: 'drush core-status --fields=*', description: 'Emit all fields, not just the default ones.')]
-    #[CLI\HookSelector(name: 'table-style', value: 'compact')]
-    #[CLI\HookSelector(name: 'list-delimiter', value: ':')]
+    #[CLI\Format(listDelimiter: ':', tableStyle: 'compact')]
     #[CLI\FieldLabels(labels: [
         'drupal-version' => 'Drupal version',
         'uri' => 'Site URI',