Add getDescription() to command template

cakephp · Oct 8, 2024 · 8be277c · 8be277c
1 parent b6ced75
commit 8be277c
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 8 deletions.
diff --git a/templates/bake/Command/command.twig b/templates/bake/Command/command.twig
@@ -28,18 +28,27 @@
  */
 class {{ name }}Command extends Command
 {
+    /**
+     * Get the command description.
+     *
+     * @return string
+     */
+    public static function getDescription(): string
+    {
+        return 'Command description here.';
+    }
+
     /**
      * Hook method for defining this command's option parser.
      *
-     * @see https://book.cakephp.org/4/en/console-commands/commands.html#defining-arguments-and-options
+     * @see https://book.cakephp.org/5/en/console-commands/commands.html#defining-arguments-and-options
      * @param \Cake\Console\ConsoleOptionParser $parser The parser to be defined
      * @return \Cake\Console\ConsoleOptionParser The built parser.
      */
     public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
     {
-        $parser = parent::buildOptionParser($parser);
-
-        return $parser;
+        return parent::buildOptionParser($parser)
+            ->setDescription(static::getDescription());
     }
 
     /**

diff --git a/tests/comparisons/Command/testBakePlugin.php b/tests/comparisons/Command/testBakePlugin.php
@@ -13,18 +13,27 @@
  */
 class ExampleCommand extends Command
 {
+    /**
+     * Get the command description.
+     *
+     * @return string
+     */
+    public static function getDescription(): string
+    {
+        return 'Command description here.';
+    }
+
     /**
      * Hook method for defining this command's option parser.
      *
-     * @see https://book.cakephp.org/4/en/console-commands/commands.html#defining-arguments-and-options
+     * @see https://book.cakephp.org/5/en/console-commands/commands.html#defining-arguments-and-options
      * @param \Cake\Console\ConsoleOptionParser $parser The parser to be defined
      * @return \Cake\Console\ConsoleOptionParser The built parser.
      */
     public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
     {
-        $parser = parent::buildOptionParser($parser);
-
-        return $parser;
+        return parent::buildOptionParser($parser)
+            ->setDescription(static::getDescription());
     }
 
     /**