update readme, a bug fixed for Show::helpPanel

Author: inhere

README.md

@@ -9,21 +9,32 @@ a php console application library.
 
 ## usage
 
-```
+```php
 use inhere\console\io\Input;
 use inhere\console\io\Output;
 use inhere\console\App;
 
+$config = [];
 $input = new Input;
 $output = new Output;
-$app = new App([], $input, $output);
+$app = new App($config, $input, $output);
+
+// add command routes
+$app->command('demo', function (Input $in, Output $out) {
+    $cmd = $in->getCommand();
+
+    $out->info('hello, this is a test command: ' . $cmd);
+});
+
+// run
+$app->run();
 ```
 
 ## input
 
 example(in terminal):
 
-```
+```bash
 $ examples/app home/useArg status=2 name=john arg0 -s=test --page=23 --id=23 --id=154 -e dev -v vvv -d -rf --debug --test=false
 ```
 
@@ -48,15 +59,11 @@ var_dump($input->getArgs());
 output:
 
 ```php
-array(3) {            
-  'status' => string(1) "2"       
-  'name' =>  array(3) {          
-    [0] => string(4) "john"  
-    [1] => string(3) "tom"   
-    [2] => string(4) "jack"  
-  }                   
-  [0] => string(4) "arg0"    
-}                     
+array(3) {
+  'status' => string(1) "2"
+  'name' => string(4) "john"
+  [0] => string(4) "arg0"
+}
 ```
 
 get parsed options:
@@ -68,26 +75,23 @@ var_dump($input->getOpts());
 output:
 
 ```php
-array(8) {                  
+array(10) {          
   's' => string(4) "test"   
-  'page' => string(2) "23"  
-  'id' => array(3) {        
-    [0] => string(2) "23"   
-    [1] => string(3) "154"  
-    [2] => string(3) "456"  
-  }                         
+  'e' => string(3) "dev"    
+  'v' => string(3) "vvv"    
   'd' => bool(true)         
   'r' => bool(true)         
   'f' => bool(true)         
-  'debug' => bool(true)     
-  'test' => bool(false)     
-}                           
+  'page' => string(2) "23"     
+  'id' =>   string(3) "154"    
+  'debug' => bool(true)         
+  'test' => bool(false)        
+}
 ```
 
 more method:
 
 ```php
-
 // argument
 $first = $input->getFirstArg(); // 'arg0'
 $status = $input->get('status', 'default'); // '2'
@@ -100,7 +104,7 @@ $test = $input->boolOpt('test') // False
 
 ### get user input:
 
-```
+```php
 echo "Your name:";
 
 $text = $input->read(); 
@@ -122,17 +126,17 @@ $output->write($message);
 
 #### use color style 
 
-![alt text](images/output-color-text.jpg "Title")
+![alt text](images/output-color-text.png "Title")
 
-#### special format  
+#### special format output
 
 - `$output->title()`
 - `$output->section()`
 - `$output->panel()`
 - `$output->table()`
 - `$output->helpPanel()`
 
-![alt text](images/output-panel-table-title.jpg "Title")
+![alt text](images/output-format-msg.png "Title")
 
 ## more interactive
 
@@ -144,7 +148,7 @@ interactive method:
 
 Select one of the options
 
-```
+```php
 select($description, $options, $default = null, $allowExit=true)
 choice($description, $options, $default = null, $allowExit=true)
 ```
@@ -153,14 +157,15 @@ choice($description, $options, $default = null, $allowExit=true)
 
  only values, no setting option
 
-```
+```php
 $select = Interact::select('Your city is ?', [
     'chengdu', 'beijing', 'shanghai'
 ]);
 
 ```
 
 output in terminal:
+
 ```
 Your city is ? 
   0) chengdu
@@ -170,15 +175,15 @@ Your city is ?
 You choice: 0
 ```
 
-```
+```php
 echo $select; // '0'
 ```
 
 - example 2:
 
 custom option, setting a default value.
 
-```
+```php
 $select = Interact::select('Your city is ?', [
     'a' => 'chengdu',
     'b' => 'beijing',
@@ -197,22 +202,21 @@ Your city is?
 You choice[default:a] : b
 ```
 
-```
+```php
 echo $select; // 'b'
 ```
 
 ### `Interact::confirm()`
 
-```
-confirm(string $question, bool $default = true) bool
+```php
+public static function confirm($question, $default = true) bool
 ```
 
 usage:
 
 
-```
+```php
 $result = Interact::confirm('Whether you want to continue ?');
-
 ```
 
 output in terminal:
@@ -224,19 +228,29 @@ Please confirm (yes|no) [default:yes]: n
 
 result: 
 
-```
+```php
 var_dump($result); // bool(false)
 ```
 
 
-### `Interact::question()`
-
-### `Interact::loopAsk()`
+### `Interact::question()`/`Interact::ask()`
 
+```php
+public static function ask($question, $default = null, \Closure $validator = null)
+public static function question($question, $default = null, \Closure $validator = null)
 ```
 
-```
+```php
+ $answer = Interact::ask('Please input your name?', null, function ($answer) {
+     if ( !preg_match('/\w+/', $answer) ) {
+         Interact::error('The name must match "/\w+/"');
 
+         return false;
+     }
+
+     return true;
+  });
+```
 ## License
 
 MIT

examples/HomeController.php

@@ -4,6 +4,7 @@
 
 use inhere\console\Controller;
 use inhere\console\utils\Download;
+use inhere\console\utils\Show;
 use inhere\console\utils\Interact;
 
 /**
@@ -68,14 +69,16 @@ public function blockMsgCommand()
      */
     public function fmtMsgCommand()
     {
-        $this->output->title('title');
+        $this->output->title('title show');
+        echo "\n";
+
         $body = 'If screen size could not be detected, or the indentation is greater than the screen size, the text will not be wrapped.' .
             'Word wrap text with indentation to fit the screen size,' .
             'Word wrap text with indentation to fit the screen size,' .
             'Word wrap text with indentation to fit the screen size,' .
             'Word wrap text with indentation to fit the screen size,';
 
-        $this->output->section('section title', $body, [
+        $this->output->section('section show', $body, [
             'pos' => 'l'
         ]);
 
@@ -84,8 +87,46 @@ public function fmtMsgCommand()
             'help' => 'Show application help information',
             'list' => 'List all group and independent commands',
         ];
-        Interact::panel($commands, 'Internal Commands', '');
-        Interact::aList($commands, 'Internal Commands');
+        Show::panel($commands, 'panel show', '#');
+
+        echo "\n";
+        Show::helpPanel([
+            Show::HELP_DES => 'a help panel description text. (help panel show)',
+            Show::HELP_USAGE => 'a usage text',
+            Show::HELP_ARGUMENTS => [
+                'arg1' => 'arg1 description',
+                'arg2' => 'arg2 description',
+            ],
+            Show::HELP_OPTIONS => [
+                '--opt1' => 'a long option',
+                '-s' => 'a short option',
+                '-d' => 'Run the server on daemon.(default: <comment>false</comment>)',
+                '-h, --help' => 'Display this help message'
+            ],
+        ], false);
+
+        Show::aList($commands, 'aList show');
+
+        Show::table([
+            [
+                'id' => 1,
+                'name' => 'john',
+                'status' => 2,
+                'email' => '[email protected]',
+            ],
+            [
+                'id' => 2,
+                'name' => 'tom',
+                'status' => 0,
+                'email' => '[email protected]',
+            ],
+            [
+                'id' => 3,
+                'name' => 'jack',
+                'status' => 1,
+                'email' => '[email protected]',
+            ],
+        ], 'table show');
     }
 
     /**
@@ -118,7 +159,7 @@ public function confirmCommand()
     }
 
     /**
-     * use <default>Interact::select</default> method
+     * use <normal>Interact::select</normal> method
      *
      */
     public function selectCommand()

images/output-color-text.jpg

@@ -207,7 +207,7 @@ final protected function showCommandList()
         }
 
         $commands[] = "\nFor more information please use: <info>$sName/help [command]</info>";
-        $this->output->aList($commands, '<comment>Sub-Commands:</comment>');
+        $this->output->aList($commands, '<comment>Commands:</comment>');
     }
 
     /**

images/output-color-text.png

@@ -350,7 +350,7 @@ public static function helpPanel(array $config, $showAfterQuit = true)
 
                     // is key-value [ 'key1' => 'text1', 'key2' => 'text2']
                 } else {
-                    $value = Helper::spliceKeyValue($config['commands'], [
+                    $value = Helper::spliceKeyValue($value, [
                         'leftChar' => '  ',
                         'keyStyle' => 'info',
                     ]);