format codes, add more param type define

Author: inhere

README.md

@@ -27,6 +27,7 @@
 - `ArtFont::class` 支持 ansi 图案字体显示（运行 `php examples/app -V` 可以看到效果）
 - `Download::class` 内置的简单的文件下载工具类，带有进度条
 - `Terminal::class` 简单的Terminal屏幕、光标控制操作类
+- `ProcessUtil::class` 简单的进程操作使用类（fork,run,stop,wait ... 等）
 - **TODO** 快速的为当前应用生成 `bash/zsh` 环境下的自动补全脚本
 
 > 下面所有的特性，效果都是运行 `examples/` 中的示例代码 `php examples/app` 展示出来的。基本上涵盖了所有功能，可以直接测试运行
@@ -241,17 +242,17 @@ $app->registerGroups('App\\Console\\Controllers', dirname(__DIR__) . '/Controlle
 
 命令上的注释是可被解析的
 
-- 注释中的 `@usage` `@arguments` `@options` `@example` 在使用帮助命令时，会被解析并显示出来
-- 注释里面同样支持带颜色的文本输出 `eg: this is a command's description <info>message</info>`
-- 上述注释tag里，支持变量替换（例如： `{command}` 会自动替换为当前输入的命令）
 - 当你使用 `php examples/app home -h` 时，可以查看到 `HomeController` 的所有命令描述注释信息
 
   ![group-command-list](docs/screenshots/group-command-list.png)
+- 看到一些命令最后的 `[alias: ...]` 了吗，那是此命令拥有的别名. 
+  - 即用别名也可以访问它，当一个命令太长时可以加别名以方便使用。一个命令可以拥有多个别名
 - 当使用 `php examples/app home:test -h` 时，可以查看到关于 `HomeController::testCommand` 更详细的信息
 
   ![group-command-list](docs/screenshots/command-help.png)
-
-- 看到一些命令最后的 `[alias: ...]` 了吗，那是此命令拥有的别名. 即用别名也可以访问它，当一个命令太长时可以加别名方便使用
+- 注释中的 `@usage` `@arguments` `@options` `@example` 在使用帮助命令时，会被解析并显示出来
+- 注释里面同样支持带颜色的文本输出 `eg: this is a command's description <info>message</info>`
+- 上述注释tag里，支持变量替换（例如： `{command}` 会自动替换为当前输入的命令）
 
 更多请查看 [examples](./examples) 中的示例代码和在目录下运行示例 `php examples/app home` 来查看效果
 

examples/Commands/TestCommand.php

@@ -22,11 +22,11 @@ class TestCommand extends Command
      * test text
      * @usage {name} test message
      * @arguments
-     * arg1  argument description 1
-     * arg2  argument description 2
+     *  arg1        argument description 1
+     *  arg2        argument description 2
      * @options
-     * --long,-s option description 1
-     * --opt    option description 2
+     *  --long,-s   option description 1
+     *  --opt       option description 2
      * @param $input
      * @param $output
      */

examples/Controllers/HomeController.php

@@ -289,7 +289,7 @@ public function pointingCommand()
      * @param Input $input
      * @return int
      */
-    public function progressCommand($input)
+    public function progressCommand($input): int
     {
         $i = 0;
         $total = 120;

src/Application.php

@@ -264,7 +264,7 @@ protected function getFileFilter(): callable
      * @inheritdoc
      * @throws \InvalidArgumentException
      */
-    protected function dispatch($name)
+    protected function dispatch(string $name)
     {
         $sep = $this->delimiter ?: ':';
 
@@ -357,6 +357,7 @@ public function runCommand($name, $believable = false)
      * @param bool $standAlone
      * @return mixed
      * @throws \InvalidArgumentException
+     * @throws \ReflectionException
      */
     public function runAction($name, $action, $believable = false, $standAlone = false)
     {

src/Base/AbstractApplication.php

@@ -174,7 +174,7 @@ public function run($exit = true)
      * @param string $command A command name
      * @return int|mixed
      */
-    abstract protected function dispatch($command);
+    abstract protected function dispatch(string $command);
 
     /**
      * run a independent command
@@ -287,7 +287,7 @@ protected function logError($e)
     /**
      * @param $command
      */
-    protected function filterSpecialCommand($command)
+    protected function filterSpecialCommand(string $command)
     {
         if (!$command) {
             if ($this->input->getSameOpt(['V', 'version'])) {
@@ -484,7 +484,7 @@ public function showCommandList($quit = true)
     /**
      * @param string $name
      * @param string $default
-     * @return string
+     * @return string|null
      */
     public function getCommandMessage($name, $default = null)
     {
@@ -529,7 +529,7 @@ public function addCommandAliases(string $name, $aliases)
      * @param string $name
      * @return string
      */
-    protected function getRealCommandName(string $name)
+    protected function getRealCommandName(string $name): string
     {
         return $this->commandAliases[$name] ?? $name;
     }
@@ -541,15 +541,15 @@ protected function getRealCommandName(string $name)
     /**
      * @return array
      */
-    public function getControllerNames()
+    public function getControllerNames(): array
     {
         return array_keys($this->controllers);
     }
 
     /**
      * @return array
      */
-    public function getCommandNames()
+    public function getCommandNames(): array
     {
         return array_keys($this->commands);
     }
@@ -581,7 +581,7 @@ public function getControllers(): array
      * @param $name
      * @return bool
      */
-    public function isController($name)
+    public function isController(string $name): bool
     {
         return isset($this->controllers[$name]);
     }
@@ -613,7 +613,7 @@ public function getCommands(): array
      * @param $name
      * @return bool
      */
-    public function isCommand($name)
+    public function isCommand(string $name): bool
     {
         return isset($this->commands[$name]);
     }
@@ -683,7 +683,7 @@ public function isInternalCommand(string $name): bool
     /**
      * @return string
      */
-    public function getName()
+    public function getName(): string
     {
         return $this->meta['name'];
     }
@@ -705,7 +705,7 @@ public function setMeta(array $meta)
      * @param null|string $default
      * @return array|string
      */
-    public function getMeta($name = null, $default = null)
+    public function getMeta(string $name = null, $default = null)
     {
         if (!$name) {
             return $this->meta;
@@ -727,7 +727,7 @@ public function isDebug()
      * is profile
      * @return boolean
      */
-    public function isProfile()
+    public function isProfile(): bool
     {
         return (bool)$this->input->getOpt('profile', $this->getMeta('profile'));
     }

src/Base/AbstractCommand.php

@@ -121,7 +121,7 @@ protected function createDefinition()
      * 为命令注解提供可解析解析变量. 可以在命令的注释中使用
      * @return array
      */
-    public function annotationVars()
+    public function annotationVars(): array
     {
         // e.g: `more info see {name}:index`
         return [
@@ -143,7 +143,7 @@ public function annotationVars()
      * @param string $command
      * @return int
      */
-    public function run($command = '')
+    public function run(string $command = ''): int
     {
         // load input definition configure
         $this->configure();
@@ -209,7 +209,7 @@ protected function showHelp(): bool
         $help['global options:'] = FormatUtil::alignmentOptions(Application::getInternalOptions());
 
         if (empty($help['description']) && $this->isAlone()) {
-            $help['description'] = self::getDefinition();
+            $help['description'] = self::getDescription();
         }
 
         $this->output->mList($help, ['sepChar' => '  ']);
@@ -488,7 +488,7 @@ final public static function getName(): string
     /**
      * @return string
      */
-    public static function getDescription()
+    public static function getDescription(): string
     {
         return static::$description;
     }
@@ -529,7 +529,7 @@ public static function setAnnotationTags(array $annotationTags, $replace = false
     }
 
     /**
-     * @return InputDefinition
+     * @return InputDefinition|null
      */
     public function getDefinition()
     {

src/Base/BaseCommandInterface.php

@@ -26,10 +26,10 @@ interface BaseCommandInterface
      * @param string $command
      * @return int
      */
-    public function run($command = '');
+    public function run(string $command = ''): int;
 
     /**
-     * @return InputDefinition
+     * @return InputDefinition|null
      */
     public function getDefinition();
 
@@ -46,5 +46,5 @@ public static function getName(): string;
     /**
      * @return string
      */
-    public static function getDescription();
+    public static function getDescription(): string;
 }

src/Command.php

@@ -51,6 +51,7 @@ abstract class Command extends AbstractCommand implements CommandInterface
 
     /**
      * @return bool
+     * @throws \ReflectionException
      */
     protected function showHelp(): bool
     {

src/Components/ArtFont.php

@@ -86,19 +86,20 @@ protected function loadInternalFonts()
      * display the internal art font
      * @param string $name
      * @param array $opts
-     * @return bool
+     * @return int
      */
-    public function showInternal(string $name, array $opts = [])
+    public function showInternal(string $name, array $opts = []): int
     {
         return $this->show($name, self::INTERNAL_GROUP, $opts);
     }
 
     /**
      * @param string $name
      * @param string $group
-     * @return string
+     * @param array $opts
+     * @return int
      */
-    public function showItalic(string $name, string $group = null, array $opts = [])
+    public function showItalic(string $name, string $group = null, array $opts = []): int
     {
         $opts['type'] = 'italic';
 
@@ -114,9 +115,9 @@ public function showItalic(string $name, string $group = null, array $opts = [])
      * - type => '', // 'italic'
      * - indent => 2,
      * - style => '', // 'info' 'error'
-     * @return bool
+     * @return int
      */
-    public function show(string $name, string $group = null, array $opts = [])
+    public function show(string $name, string $group = null, array $opts = []): int
     {
         $opts = array_merge([
             'type' => '',
@@ -153,20 +154,19 @@ public function show(string $name, string $group = null, array $opts = [])
             return Show::write(Helper::wrapTag($txt, $opts['style']));
         }
 
-        return false;
+        return 0;
     }
 
     /**
      * @param string $name
      * @param string $group
      * @return string
      */
-    public function font(string $name, string $group = null)
+    public function font(string $name, string $group = null): string
     {
         return '';
     }
 
-
     /**
      * @param string $group
      * @param string $path

src/Components/AryBuffer.php

@@ -84,7 +84,7 @@ public function setBody(array $body)
     /**
      * @return string
      */
-    public function toString()
+    public function toString(): string
     {
         return implode($this->delimiter, $this->body);
     }