breaking: update command register method sign

Author: inhere

src/Concern/ApplicationHelpTrait.php

@@ -15,10 +15,10 @@
 use Inhere\Console\Contract\CommandInterface;
 use Inhere\Console\IO\Input;
 use Inhere\Console\IO\Output;
-use Inhere\Console\Util\FormatUtil;
 use Inhere\Console\Util\Show;
 use Toolkit\Cli\Color\ColorTag;
 use Toolkit\Cli\Style;
+use Toolkit\PFlag\FlagUtil;
 use function array_merge;
 use function basename;
 use function date;
@@ -138,7 +138,7 @@ public function showHelpInfo(string $command = ''): void
         $binName  = $in->getScriptName();
         $helpInfo = [
             'Usage'   => "$binName <info>{command}</info> [--opt -v -h ...] [arg0 arg1 arg2=value2 ...]",
-            'Options' => FormatUtil::alignOptions($globalOptions),
+            'Options' => FlagUtil::alignOptions($globalOptions),
             'Example' => [
                 '- run a command/subcommand:',
                 "$binName test                     run a independent command",
@@ -215,11 +215,11 @@ public function showCommandList(): void
 
         $placeholder = 'No description of the command';
         foreach ($groups as $name => $info) {
-            $options    = $info['options'];
             $controller = $info['handler'];
             /** @var AbstractHandler $controller */
             $desc    = $controller::getDesc() ?: $placeholder;
-            $aliases = $options['aliases'];
+            $config  = $info['config'];
+            $aliases = $config['aliases'];
             $extra   = $aliases ? ColorTag::wrap(' (alias: ' . implode(',', $aliases) . ')', 'info') : '';
 
             // collect
@@ -231,22 +231,22 @@ public function showCommandList(): void
         }
 
         foreach ($commands as $name => $info) {
-            $desc    = $placeholder;
-            $options = $info['options'];
+            $desc   = $placeholder;
+            $config = $info['config'];
             $command = $info['handler'];
 
             /** @var AbstractHandler $command */
             if (is_subclass_of($command, CommandInterface::class)) {
                 $desc = $command::getDesc() ?: $placeholder;
-            } elseif ($msg = $options['desc'] ?? '') {
+            } elseif ($msg = $config['desc'] ?? '') {
                 $desc = $msg;
             } elseif (is_string($command)) {
                 $desc = 'A handler : ' . $command;
             } elseif (is_object($command)) {
                 $desc = 'A handler by ' . get_class($command);
             }
 
-            $aliases = $options['aliases'];
+            $aliases = $config['aliases'];
             $extra   = $aliases ? ColorTag::wrap(' (alias: ' . implode(',', $aliases) . ')', 'info') : '';
 
             $commandArr[$name] = $desc . $extra;
@@ -281,7 +281,7 @@ public function showCommandList(): void
 
         Show::mList([
             'Usage:'              => "$scriptName <info>{COMMAND}</info> [--opt -v -h ...] [arg0 arg1 arg2=value2 ...]",
-            'Options:'            => FormatUtil::alignOptions($globOpts),
+            'Options:'            => FlagUtil::alignOptions($globOpts),
             'Internal Commands:'  => $internalCommands,
             'Available Commands:' => array_merge($groupArr, $commandArr),
         ], [

src/Concern/CommandHelpTrait.php

@@ -11,8 +11,8 @@
 
 use Inhere\Console\Handler\AbstractHandler;
 use Inhere\Console\Console;
-use Inhere\Console\Util\FormatUtil;
 use Toolkit\PFlag\FlagsParser;
+use Toolkit\PFlag\FlagUtil;
 use function implode;
 use function sprintf;
 use function strtr;
@@ -146,7 +146,7 @@ public function showHelpByFlagsParser(FlagsParser $fs, array $aliases = [], stri
 
         $help['Usage:'] = "$path [--options ...] [arguments ...]";
 
-        $help['Options:']  = FormatUtil::alignOptions($fs->getOptsHelpLines());
+        $help['Options:']  = FlagUtil::alignOptions($fs->getOptsHelpLines());
         $help['Argument:'] = $fs->getArgsHelpLines();
         $help['Example:']  = $fs->getExampleHelp();
 
@@ -158,7 +158,7 @@ public function showHelpByFlagsParser(FlagsParser $fs, array $aliases = [], stri
 
         // attached to console app
         if ($this->renderGlobalOption && ($app = $this->getApp())) {
-            $help['Global Options:'] = FormatUtil::alignOptions($app->getFlags()->getOptsHelpLines());
+            $help['Global Options:'] = FlagUtil::alignOptions($app->getFlags()->getOptsHelpLines());
         }
 
         $this->output->mList($help, [

src/Concern/SubCommandsWareTrait.php

@@ -48,7 +48,7 @@ trait SubCommandsWareTrait
      * [
      *  'name' => [
      *      'handler' => MyCommand::class, // allow: string|Closure|CommandInterface
-     *      'options' => []
+     *      'config' => []
      *  ]
      * ]
      */
@@ -83,14 +83,14 @@ protected function dispatchCommand(string $name): void
      *
      * @param string|CommandInterface              $name
      * @param string|Closure|CommandInterface|null $handler
-     * @param array                                $options
+     * @param array                                $config
      *  array:
      *  - aliases     The command aliases
      *  - description The description message
      *
      * @throws InvalidArgumentException
      */
-    public function addSub(string $name, string|Closure|CommandInterface $handler = null, array $options = []): void
+    public function addSub(string $name, string|Closure|CommandInterface $handler = null, array $config = []): void
     {
         if (!$handler && class_exists($name)) {
             /** @var Command $name name is an command class */
@@ -108,7 +108,7 @@ public function addSub(string $name, string|Closure|CommandInterface $handler =
             Helper::throwInvalidArgument("Command '$name' have been registered!");
         }
 
-        $options['aliases'] = isset($options['aliases']) ? (array)$options['aliases'] : [];
+        $config['aliases'] = isset($config['aliases']) ? (array)$config['aliases'] : [];
 
         if (is_string($handler)) {
             if (!class_exists($handler)) {
@@ -127,7 +127,7 @@ public function addSub(string $name, string|Closure|CommandInterface $handler =
 
             // allow define aliases in Command class by Command::aliases()
             if ($aliases = $handler::aliases()) {
-                $options['aliases'] = array_merge($options['aliases'], $aliases);
+                $config['aliases'] = array_merge($config['aliases'], $aliases);
             }
         } elseif (!is_object($handler) || !method_exists($handler, '__invoke')) {
             Helper::throwInvalidArgument(
@@ -140,12 +140,12 @@ public function addSub(string $name, string|Closure|CommandInterface $handler =
         $this->commands[$name] = [
             'type'    => Console::CMD_SINGLE,
             'handler' => $handler,
-            'options' => $options,
+            'config' => $config,
         ];
 
         // has alias option
-        if (isset($options['aliases'])) {
-            $this->setAlias($name, $options['aliases'], true);
+        if (isset($config['aliases'])) {
+            $this->setAlias($name, $config['aliases'], true);
         }
     }
 

src/Contract/ApplicationInterface.php

@@ -59,10 +59,8 @@ public function stop(int $code = 0): void;
      * Register a app group command(by controller)
      *
      * @param string $name The controller name
-     * @param string|ControllerInterface|null $class The controller class
+     * @param class-string|ControllerInterface|null $class The controller class
      * @param array{desc: string, aliases: array} $config config the controller.
-     *                      - aliases   The command aliases
-     *                      - desc      The description message
      *
      * @return static
      * @throws InvalidArgumentException
@@ -72,11 +70,9 @@ public function controller(string $name, ControllerInterface|string $class = nul
     /**
      * Register a app independent console command
      *
-     * @param string|class-string $name
-     * @param string|Closure|CommandInterface|null $handler
+     * @param string $name
+     * @param string|CommandInterface|null|Closure():void $handler
      * @param array{desc: string, aliases: array} $config config the command.
-     *                      - aliases     The command aliases
-     *                      - desc        The description message
      *
      * @return mixed
      * @throws InvalidArgumentException

src/Contract/RouterInterface.php

@@ -10,7 +10,6 @@
 namespace Inhere\Console\Contract;
 
 use Closure;
-use InvalidArgumentException;
 
 /**
  * Interface RouterInterface
@@ -33,25 +32,19 @@ interface RouterInterface
      * @param string|class-string  $name    The controller name
      * @param string|ControllerInterface|null $class   The controller class
      * @param array{aliases: array, desc: string} $config The options config.
-     *                                            - aliases The command aliases
-     *                                            - desc    The description message
      *
      * @return static
-     * @throws InvalidArgumentException
      */
     public function addGroup(string $name, ControllerInterface|string $class = null, array $config = []): static;
 
     /**
      * Register a app independent console command
      *
      * @param string|class-string        $name
-     * @param string|Closure|CommandInterface|null $handler
-     * @param array{aliases: array, desc: string} $config The options config.
-     *                                            - aliases The command aliases
-     *                                            - desc    The description message
+     * @param string|CommandInterface|null|Closure():void $handler
+     * @param array{aliases: array, desc: string, options: array, arguments: array} $config The config.
      *
      * @return static
-     * @throws InvalidArgumentException
      */
     public function addCommand(string $name, string|Closure|CommandInterface $handler = null, array $config = []): static;
 
@@ -60,16 +53,16 @@ public function addCommand(string $name, string|Closure|CommandInterface $handle
      * return  [
      *  type    => 1, // 1 group 2 command
      *  handler => handler class/object/func ...
-     *  options => [
+     *  config => [
+     *      desc => '',
      *      aliases => [],
-     *      description => '',
      *  ],
      * ]
      * ```
      *
      * @param string $name The input command name
      *
-     * @return array return route info array. If not found, will return empty array.
+     * @return array{name:string, cmdId: string, config: array, handler: mixed} return route info. If not found, will return empty array.
      */
     public function match(string $name): array;
 }