update, merge master feature to php5 branch

inhere · Dec 25, 2017 · 17392fe · 17392fe
1 parent c6695f2
commit 17392fe
Show file tree

Hide file tree

Showing 105 changed files with 4,475 additions and 1,119 deletions.
diff --git a/README.md b/README.md
@@ -4,16 +4,16 @@
 [![Php Version](https://img.shields.io/badge/php-%3E=5.6.0-brightgreen.svg?maxAge=2592000)](https://packagist.org/packages/inhere/console)
 [![Latest Stable Version](http://img.shields.io/packagist/v/inhere/console.svg)](https://packagist.org/packages/inhere/console)
 
-简洁、功能全面的php命令行应用库。提供控制台参数解析, 颜色风格输出, 用户信息交互, 特殊格式信息显示。
+简洁、功能全面的php命令行应用库。提供控制台参数解析, 命令运行，颜色风格输出, 用户信息交互, 特殊格式信息显示。
 
 > 无其他库依赖，可以方便的整合到任何已有项目中。
 
 - 功能全面的命令行的选项参数解析(命名参数，短选项，长选项 ...)
-- 命令行应用, 命令行的 `controller`, `command` 解析运行
+- 命令行应用, 命令行的 `controller`, `command` 解析运行。(支持命令别名)
 - 命令行中功能强大的 `input`, `output` 管理、使用
 - 消息文本的多种颜色风格输出支持(`info`, `comment`, `success`, `danger`, `error` ... ...)
-- 丰富的特殊格式信息显示(`section`, `panel`, `padding`, `help-panel`, `table`, `title`, `list`, `progressBar`)
-- 常用的用户信息交互支持(`select`, `confirm`, `ask/question`)
+- 丰富的特殊格式信息显示(`section`, `panel`, `padding`, `help-panel`, `table`, `title`, `list`, `multiList`, `progressBar`)
+- 常用的用户信息交互支持(`select`, `multiSelect`, `confirm`, `ask/question`, `askPassword/askHiddenInput`)
 - 命令方法注释自动解析（提取为参数 `arguments` 和 选项 `options` 等信息）
 - 类似 `symfony/console` 的预定义参数定义支持(按位置赋予参数值)
 - 输出是 windows,linux 兼容的，不支持颜色的环境会自动去除相关CODE
@@ -34,12 +34,20 @@
 
 ## 安装
 
-- 使用 composer
+- 使用 composer 命令
+
+```bash
+composer require inhere/console
+```
+
+- 使用 composer.json
 
 编辑 `composer.json`，在 `require` 添加
 
 ```
 "inhere/console": "dev-master",
+
+// "inhere/console": "^2.0", // 指定稳定版本
 // "inhere/console": "dev-php5", // for php5
 ```
 
@@ -84,10 +92,12 @@ $app->run();
 
 然后在命令行里执行 `php examples/app`, 立即就可以看到如下输出了:
 
-!['output-commands-info'](images/example-app.png)
+!['app-command-list'](docs/screenshots/app-command-list.png)
 
 > `Independent Commands` 中的 demo 就是我们上面添加的命令
 
+- `[alias: ...]` 命令最后的alias 表明了此命令拥有的别名。 
+
 ## 添加命令
 
 添加命令的方式有三种
@@ -104,7 +114,7 @@ $app->command('demo', function (Input $in, Output $out) {
 }, 'this is message for the command');
 ```
 
-### 继承 `Inhere\Console\Command`
+### 独立命令
 
 通过继承 `Inhere\Console\Command` 添加独立命令
 
@@ -155,7 +165,7 @@ $app->command(TestCommand::class);
 // $app->command('test1', TestCommand::class);
 ```
 
-### 继承 `Inhere\Console\Controller`
+### 命令组
 
 通过继承 `Inhere\Console\Controller` 添加一组命令. 即是命令行的控制器
 
@@ -171,13 +181,29 @@ class HomeController extends Controller
     protected static $description = 'default command controller. there are some command usage examples';
 
     /**
-     * this is a command's description message <info>a color text</info>
+     * this is a command's description message, <cyan>color text</cyan>
      * the second line text
-     * @usage usage message
+     * @usage {command} [arg ...] [--opt ...]
+     * @arguments
+     *  arg1        argument description 1
+     *              the second line
+     *  a2,arg2     argument description 2
+     *              the second line
+     * @options
+     *  -s, --long  option description 1
+     *  --opt       option description 2
      * @example example text one
      *  the second line example
      */
-    public function indexCommand()
+    public function testCommand()
+    {
+        $this->write('hello, welcome!! this is ' . __METHOD__);
+    }
+
+    /**
+     * a example for use color text output on command
+     */
+    public function otherCommand()
     {
         $this->write('hello, welcome!! this is ' . __METHOD__);
     }
@@ -192,13 +218,14 @@ class HomeController extends Controller
 
 - 支持的tag有 `@usage` `@arguments` `@options` `@example`
 - 当你使用 `php examples/app home -h` 时，可以查看到 `HomeController` 的所有命令描述注释信息
-- 当使用 `php examples/app home:index -h` 时，可以查看到关于 `HomeController::indexCommand` 更详细的信息。包括描述注释文本、`@usage` 、`@example`
+
+  ![group-command-list](docs/screenshots/group-command-list.png)
+- 当使用 `php examples/app home:test -h` 时，可以查看到关于 `HomeController::testCommand` 更详细的信息。包括描述注释文本、`@usage` 、`@example`
 
-> 小提示：注释里面同样支持带颜色的文本输出 `eg: this is a command's description <info>message</info>`
+  ![group-command-list](docs/screenshots/group-command-help.png)
 
-- 运行效果(by `php examples/app home`):
+> 小提示：注释里面同样支持带颜色的文本输出 `eg: this is a command's description <info>message</info>`
 
-![command-group-example](./images/example-for-group.png)
 
 更多请查看 [examples](./examples) 中的示例代码和在目录下运行示例 `php examples/app` 来查看效果
 
@@ -360,12 +387,24 @@ $output->write('hello <info>world<info>');
 
 已经内置了常用的风格:
 
-![alt text](images/output-color-text.png "Title")
+![alt text](docs/screenshots/output-color-text.png "Title")
 
 来自于类 `Inhere\Console\Utils\Show`。
 
 > output 实例拥有 `Inhere\Console\Utils\Show` 的所有格式化输出方法。不过都是通过对象式访问的。
 
+- **单独使用颜色风格**
+
+```php
+$style = Inhere\Console\Style\Style::create();
+
+echo $style->render('no color <info>color text</info>');
+
+// 直接使用内置的风格
+echo $style->info('message');
+echo $style->error('message');
+```
+
 ### 标题文本输出
 
 使用 `Show::title()/$output->title()`
@@ -403,13 +442,13 @@ echo "Progress:\n";
 
 $i = 0;
 while ($i <= $total) {
-     $bar->send($i);
+     $bar->send(1);// 发送步进长度，通常是 1
      usleep(50000);
      $i++;
 }
 ```
 
-![show-progress](images/show-progress.png)
+![show-progress](docs/screenshots/progress-demo.png)
 
 ### 列表数据展示输出 
 
@@ -438,7 +477,9 @@ $data = [
 Show::aList($data, $title);
 ```
 
-> 渲染效果请看下面的预览
+> 渲染效果
+
+![fmt-list](docs/screenshots/fmt-list.png)
 
 ### 多列表数据展示输出
 
@@ -467,7 +508,9 @@ $data = [
 Show::mList($data);
 ```
 
-> 渲染效果请看下面的预览
+> 渲染效果
+
+![fmt-multi-list](docs/screenshots/fmt-multi-list.png)
 
 ### 面板展示信息输出
 
@@ -489,7 +532,9 @@ $data = [
 Show::panel($data, 'panel show', '#');
 ```
 
-> 渲染效果请看下面的预览
+> 渲染效果
+
+![fmt-panel](docs/screenshots/fmt-panel.png)
 
 ### 数据表格信息输出
 
@@ -531,7 +576,7 @@ Show::table($data, 'a table', $opts);
 
 > 渲染效果请看下面的预览
 
-![table-show](images/table-show.png)
+![table-show](docs/screenshots/table-show.png)
 
 ### 快速的渲染一个帮助信息面板 
 
@@ -558,9 +603,9 @@ Show::helpPanel([
 ], false);
 ```
 
-### 渲染效果预览
+> 渲染效果预览
 
-![alt text](images/output-format-msg.png "Title")
+![alt text](docs/screenshots/fmt-help-panel.png "Title")
 
 ## 用户交互方法
 

diff --git a/README_en.md b/README_en.md
@@ -12,7 +12,7 @@ a php console application library.
 - console color support, format message output
 - console interactive
 
-[中文README](./README.md)
+> [中文README](./README.md)
 
 ## project
 
@@ -72,7 +72,7 @@ $app->run();
 
 now, you can see:
 
-!['output-commands-info'](images/example-app.png)
+!['app-command-list'](docs/screenshots/app-command-list.png)
 
 ## input
 
@@ -174,7 +174,7 @@ $output->write('hello');
 
 #### use color style 
 
-![alt text](images/output-color-text.png "Title")
+![alt text](docs/screenshots/output-color-text.png "Title")
 
 #### special format output
 
@@ -184,7 +184,7 @@ $output->write('hello');
 - `$output->table()`
 - `$output->helpPanel()`
 
-![alt text](images/output-format-msg.png "Title")
+![alt text](docs/screenshots/output-format-msg.png "Title")
 
 ## more interactive
 

diff --git a/docs/catelog.md b/docs/catelog.md
@@ -0,0 +1,3 @@
+# php 命令行应用库
+
+[简介和安装](intro.md)
diff --git a/examples/baks/cli-color.md → docs/cli-color.md b/examples/baks/cli-color.md → docs/cli-color.md
diff --git a/docs/controller.md b/docs/controller.md
@@ -0,0 +1,34 @@
+# 注册命令
+
+### 注册独立命令
+### 注册组命令
+### 设置命令名称
+### 设置命令描述
+
+## 独立命令
+
+## 组命令(controller)
+
+## 输入定义(InputDefinition)
+
+
+## 设置参数
+
+### 使用名称设置参数
+
+### 根据位置设置参数
+
+```
+$ php examples/app demo john male 43 --opt1 value1 -y
+hello, this in Inhere\Console\examples\DemoCommand::execute
+this is argument and option example:
+                                        the opt1's value
+                                option: opt1 |
+                                     |       |
+php examples/app demo john male 43 --opt1 value1 -y
+        |         |     |    |   |                |
+     script    command  |    |   |______   option: yes, it use shortcat: y, and it is a Input::OPT_BOOLEAN, so no value.
+                        |    |___       |
+                 argument: name  |   argument: age
+                            argument: sex
+```
diff --git a/docs/input-output.md b/docs/input-output.md
@@ -0,0 +1,39 @@
+# input and output
+
+## input
+
+## output
+
+### output buffer
+
+how tu use
+
+- use `Output`
+
+```php
+    // open buffer
+    $this->output->startBuffer();
+
+    $this->output->write('message 0');
+    $this->output->write('message 1');
+    // ....
+    $this->output->write('message n');
+
+    // stop and output buffer
+    $this->output->stopBuffer();
+```
+
+- use `Show`
+
+```php
+    // open buffer
+    Show::startBuffer();
+
+    Show::write('message 0');
+    Show::write('message 1');
+    // ....
+    Show::write('message n');
+
+    // stop and output buffer
+    Show::stopBuffer();
+```
diff --git a/docs/intro.md b/docs/intro.md
@@ -0,0 +1,56 @@
+# 简介
+
+简洁、功能全面的php命令行应用库。提供控制台参数解析, 颜色风格输出, 用户信息交互, 特殊格式信息显示。
+
+> 无其他库依赖，可以方便的整合到任何已有项目中。
+
+- 功能全面的命令行的选项参数解析(命名参数，短选项，长选项 ...)
+- 命令行应用, 命令行的 `controller`, `command` 解析运行
+- 命令行中功能强大的 `input`, `output` 管理、使用
+- 消息文本的多种颜色风格输出支持(`info`, `comment`, `success`, `danger`, `error` ... ...)
+- 丰富的特殊格式信息显示(`section`, `panel`, `padding`, `help-panel`, `table`, `title`, `list`, `progressBar`)
+- 常用的用户信息交互支持(`select`, `confirm`, `ask/question`)
+- 命令方法注释自动解析（提取为参数 `arguments` 和 选项 `options` 等信息）
+- 类似 `symfony/console` 的预定义参数定义支持(按位置赋予参数值)
+- 输出是 windows,linux 兼容的，不支持颜色的环境会自动去除相关CODE
+
+> 下面所有的特性，效果都是运行 `examples/` 中的示例代码 `php examples/app` 展示出来的。下载后可以直接测试体验
+
+
+## 项目地址
+
+- **github** https://github.com/inhere/php-console.git
+- **git@osc** https://git.oschina.net/inhere/php-console.git
+
+**注意：**
+
+- master 分支是要求 `php >= 7` 的(推荐使用)。
+- php5 分支是支持 php5 `php >= 5.5` 的代码分支。
+
+## 安装
+
+- 使用 composer 命令
+
+```bash
+composer require inhere/console
+```
+
+- 使用 composer.json
+
+编辑 `composer.json`，在 `require` 添加
+
+```
+"inhere/console": "dev-master",
+
+// "inhere/console": "^2.0", // 指定稳定版本
+// "inhere/console": "dev-php5", // for php5
+```
+
+然后执行: `composer update`
+
+- 直接拉取
+
+```
+git clone https://git.oschina.net/inhere/php-console.git // git@osc
+git clone https://github.com/inhere/php-console.git // github
+```
diff --git a/docs/screenshots/app-command-list.png b/docs/screenshots/app-command-list.png
diff --git a/docs/screenshots/fmt-help-panel.png b/docs/screenshots/fmt-help-panel.png
diff --git a/docs/screenshots/fmt-list.png b/docs/screenshots/fmt-list.png
diff --git a/docs/screenshots/fmt-multi-list.png b/docs/screenshots/fmt-multi-list.png
diff --git a/docs/screenshots/fmt-panel.png b/docs/screenshots/fmt-panel.png
diff --git a/docs/screenshots/group-command-help.png b/docs/screenshots/group-command-help.png
diff --git a/docs/screenshots/group-command-list.png b/docs/screenshots/group-command-list.png
diff --git a/docs/screenshots/interactive-ask.png b/docs/screenshots/interactive-ask.png
diff --git a/docs/screenshots/interactive-limited-ask.png b/docs/screenshots/interactive-limited-ask.png
diff --git a/images/output-color-text.png → docs/screenshots/output-color-text.png b/images/output-color-text.png → docs/screenshots/output-color-text.png
diff --git a/images/output-format-msg.png → docs/screenshots/output-format-msg.png b/images/output-format-msg.png → docs/screenshots/output-format-msg.png
diff --git a/docs/screenshots/progress-demo.png b/docs/screenshots/progress-demo.png
diff --git a/images/table-show.png → docs/screenshots/table-show.png b/images/table-show.png → docs/screenshots/table-show.png
diff --git a/images/use-arg-position.png → docs/screenshots/use-definition-args.png b/images/use-arg-position.png → docs/screenshots/use-definition-args.png