fix: #19 sub-command desc display error

Author: inhere

examples/Controller/HomeController.php

@@ -42,6 +42,7 @@ protected static function commandAliases(): array
             'ml'  => 'multiList',
             'sl'  => 'splitLine',
             'dt'  => 'dynamicText',
+            'da'  => 'defArg',
         ];
     }
 
@@ -50,6 +51,10 @@ protected function init(): void
         parent::init();
 
         $this->addCommentsVar('internalFonts', implode(',', ArtFont::getInternalFonts()));
+
+        $this->setCommandMeta('defArg', [
+            'desc' => 'the command args and opts config use defined configure, it like symfony console, please see defArgConfigure()',
+        ]);
     }
 
     /**
@@ -75,6 +80,7 @@ protected function afterExecute(): void
     /**
      * this is a command's description message
      * the second line text
+     *
      * @usage {command} [arg ...] [--opt ...]
      * @arguments
      *  arg1        argument description 1
@@ -107,15 +113,13 @@ public function disabledCommand(): void
     protected function defArgConfigure(): void
     {
         $this->createDefinition()
-            ->setDescription('the command arg/opt config use defined configure, it like symfony console: argument define by position')
+            // ->setDescription('the command args and opts config use defined configure, it like symfony console, please see defArgConfigure()')
             ->addArgument('name', Input::ARG_REQUIRED, "description for the argument 'name'")
             ->addOption('yes', 'y', Input::OPT_BOOLEAN, "description for the option 'yes'")
             ->addOption('opt1', null, Input::OPT_REQUIRED, "description for the option 'opt1'");
     }
 
-    /**
-     * the command arg/opt config use defined configure, it like symfony console: argument define by position
-     */
+    // desc set at $this->commandMetas.
     public function defArgCommand(): void
     {
         $this->output->dump($this->input->getArgs(), $this->input->getOpts(), $this->input->getBoolOpt('y'));

src/AbstractHandler.php

@@ -101,12 +101,12 @@ abstract class AbstractHandler implements CommandHandlerInterface
     /**
      * @var InputDefinition|null
      */
-    private $definition;
+    protected $definition;
 
     /**
      * @var string
      */
-    private $processTitle = '';
+    protected $processTitle = '';
 
     /**
      * @var array

src/Controller.php

@@ -11,6 +11,7 @@
 use Generator;
 use Inhere\Console\Contract\ControllerInterface;
 use Inhere\Console\IO\Input;
+use Inhere\Console\IO\InputDefinition;
 use Inhere\Console\IO\Output;
 use Inhere\Console\Util\FormatUtil;
 use Inhere\Console\Util\Helper;
@@ -20,8 +21,8 @@
 use ReflectionObject;
 use RuntimeException;
 use Toolkit\Cli\ColorTag;
-use Toolkit\Stdlib\Util\PhpDoc;
 use Toolkit\Stdlib\Str;
+use Toolkit\Stdlib\Util\PhpDoc;
 use function array_flip;
 use function array_keys;
 use function array_merge;
@@ -67,6 +68,7 @@ abstract class Controller extends AbstractHandler implements ControllerInterface
 
     /**
      * Action name, no suffix.
+     * eg: updateCommand() -> action: 'update'
      *
      * @var string
      */
@@ -104,6 +106,21 @@ abstract class Controller extends AbstractHandler implements ControllerInterface
      */
     private $disabledCommands = [];
 
+    /**
+     * Metadata for sub-commands. such as: desc, alias
+     * Notice: you must add metadata on `init()`
+     *
+     * [
+     *  'command real name' => [
+     *      'desc'  => 'sub command description',
+     *      'alias' => [],
+     *   ],
+     * ],
+     *
+     * @var array
+     */
+    protected $commandMetas = [];
+
     /**
      * Define command alias mapping. please rewrite it on sub-class.
      *
@@ -177,11 +194,11 @@ public function run(string $command = '')
         }
 
         $this->action = Str::camelCase($this->getRealCommandName($command));
-
         if (!$this->action) {
             return $this->showHelp();
         }
 
+        // do running
         return parent::run($command);
     }
 
@@ -190,14 +207,32 @@ public function run(string $command = '')
      */
     protected function configure(): void
     {
-        // eg. indexConfigure() for indexCommand()
+        // eg. use `indexConfigure()` for `indexCommand()`
         $method = $this->action . self::CONFIGURE_SUFFIX;
 
         if (method_exists($this, $method)) {
             $this->$method($this->input);
         }
     }
 
+    /**
+     * @return InputDefinition
+     */
+    protected function createDefinition(): InputDefinition
+    {
+        if (!$this->definition) {
+            $this->definition = new InputDefinition();
+
+            // if have been set desc for the sub-command
+            $cmdDesc = $this->commandMetas[$this->action]['desc'] ?? '';
+            if ($cmdDesc) {
+                $this->definition->setDescription($cmdDesc);
+            }
+        }
+
+        return $this->definition;
+    }
+
     /**
      * Run command action in the group
      *
@@ -271,6 +306,9 @@ protected function showHelp(): bool
         return $this->helpCommand() === 0;
     }
 
+    /**
+     * @param array $help
+     */
     protected function beforeRenderCommandHelp(array &$help): void
     {
         $help['Group Options:'] = FormatUtil::alignOptions($this->groupOptions);
@@ -305,7 +343,7 @@ final public function helpCommand(): int
     {
         $action = $this->action;
 
-        // For all sub-commands of the controller
+        // Not input action, for all sub-commands of the controller
         if (!$action && !($action = $this->getFirstArg())) {
             $this->showCommandList();
             return 0;
@@ -354,12 +392,15 @@ final public function showCommandList(): void
         $showDisabled = (bool)$this->getOpt('show-disabled', false);
         $defaultDes   = 'No description message';
 
+        /**
+         * @var $cmd string The command name.
+         */
         foreach ($this->getAllCommandMethods($ref) as $cmd => $m) {
             if (!$cmd) {
                 continue;
             }
 
-            $desc = $defaultDes;
+            $desc = $this->getCommandMeta('desc', $defaultDes, $cmd);
             if ($phpDoc = $m->getDocComment()) {
                 $desc = PhpDoc::firstLine($phpDoc);
             }
@@ -630,4 +671,37 @@ public function setDelimiter(string $delimiter): void
     {
         $this->delimiter = $delimiter;
     }
+
+    /**
+     * @return array
+     */
+    public function getCommandMetas(): array
+    {
+        return $this->commandMetas;
+    }
+
+    /**
+     * @param string $command
+     * @param array  $meta  eg: ['desc' => '', 'alias' => []]
+     */
+    public function setCommandMeta(string $command, array $meta): void
+    {
+        if ($command) {
+            $this->commandMetas[$command] = $meta;
+        }
+    }
+
+    /**
+     * @param string $key
+     * @param null   $default
+     * @param string $command if not set, will use $this->action
+     *
+     * @return mixed|null
+     */
+    public function getCommandMeta(string $key, $default = null, string $command = '')
+    {
+        $action = $command ?: $this->action;
+
+        return $this->commandMetas[$action][$key] ?? $default;
+    }
 }