Adjust help information display. update chanagelog

Author: inhere

CHANGELOG.md

@@ -1,5 +1,34 @@
 # CHANGELOG
 
+## v2.4.0
+
+> publish at: 2018.07.03
+
+
+
+## v2.3.3
+
+> publish at: 2018.03.15
+
+**update**
+
+- prompt password input use sh instead bash
+- command help display modify
+- modify error display
+- Update README.md
+- add more param type declare 
+
+**new**
+
+- add running sub-command support
+- add disable command support in controller
+- add a built in command for run php dev server
+
+**bug fixed**
+
+- token_get_all not exist for Highlighter
+- fix some errors for phar build
+
 ## v2.3.2
 
 > publish at: 2018.01.26

src/Application.php

@@ -291,9 +291,9 @@ protected function dispatch(string $name)
         $action = '';
 
         // like 'home:index'
-        if (strpos($realName, $sep) > 0) {
-            $input = array_values(array_filter(explode($sep, $realName)));
-            list($realName, $action) = \count($input) > 2 ? array_splice($input, 2) : $input;
+        if (\strpos($realName, $sep) > 0) {
+            $input = \array_values(\array_filter(\explode($sep, $realName)));
+            list($realName, $action) = \count($input) > 2 ? \array_splice($input, 2) : $input;
             $realName = $this->getRealCommandName($realName);
         }
 
@@ -305,17 +305,17 @@ protected function dispatch(string $name)
         if (true !== $this->fire(self::ON_NOT_FOUND, [$this])) {
             $this->output->liteError("The command '{$name}' is not exists in the console application!");
 
-            $commands = array_merge($this->getControllerNames(), $this->getCommandNames());
+            $commands = \array_merge($this->getControllerNames(), $this->getCommandNames());
 
             // find similar command names by similar_text()
             if ($similar = Helper::findSimilar($name, $commands)) {
-                $this->write(sprintf("\nMaybe what you mean is:\n    <info>%s</info>", implode(', ', $similar)));
+                $this->write(\sprintf("\nMaybe what you mean is:\n    <info>%s</info>", implode(', ', $similar)));
             } else {
                 $this->showCommandList(false);
             }
         }
 
-        return 404;
+        return 2;
     }
 
     /**

src/Base/AbstractApplication.php

@@ -418,7 +418,7 @@ public function showHelpInfo($quit = true, string $command = null)
         $sep = $this->delimiter;
 
         $this->output->helpPanel([
-            'usage' => "$script <info>{command}</info> [arg0 arg1=value1 arg2=value2 ...] [--opt -v -h ...]",
+            'usage' => "$script <info>{command}</info> [--opt -v -h ...] [arg0 arg1 arg2=value2 ...]",
             'example' => [
                 "$script test (run a independent command)",
                 "$script home{$sep}index (run a command of the group)",
@@ -471,27 +471,29 @@ public function showCommandList($quit = true)
         $desPlaceholder = 'No description of the command';
 
         // all console controllers
-        $controllerArr[] = PHP_EOL . '- <bold>Group Commands</bold>';
-        $controllers = $this->controllers;
-        ksort($controllers);
+        if ($controllers = $this->controllers) {
+            \ksort($controllers);
+            $controllerArr[] = PHP_EOL . '- <bold>Group Commands</bold>';
+        }
 
         foreach ($controllers as $name => $controller) {
             $hasGroup = true;
             /** @var AbstractCommand $controller */
             $desc = $controller::getDescription() ?: $desPlaceholder;
             $aliases = $this->getCommandAliases($name);
-            $extra = $aliases ? Helper::wrapTag(' [alias: ' . implode(',', $aliases) . ']', 'info') : '';
+            $extra = $aliases ? Helper::wrapTag(' [alias: ' . \implode(',', $aliases) . ']', 'info') : '';
             $controllerArr[$name] = $desc . $extra;
         }
 
-        if (!$hasGroup) {
+        if (!$hasGroup && $this->isDebug()) {
             $controllerArr[] = '... Not register any group command(controller)';
         }
 
         // all independent commands, Independent, Single, Alone
-        $commands = $this->commands;
-        $commandArr[] = PHP_EOL . '- <bold>Alone Commands</bold>';
-        ksort($commands);
+        if ($commands = $this->commands) {
+            $commandArr[] = PHP_EOL . '- <bold>Alone Commands</bold>';
+            \ksort($commands);
+        }
 
         foreach ($commands as $name => $command) {
             $desc = $desPlaceholder;
@@ -513,13 +515,13 @@ public function showCommandList($quit = true)
             $commandArr[$name] = $desc . $extra;
         }
 
-        if (!$hasCommand) {
+        if (!$hasCommand && $this->isDebug()) {
             $commandArr[] = '... Not register any alone command';
         }
 
         // built in commands
         $internalCommands = static::$internalCommands;
-        ksort($internalCommands);
+        \ksort($internalCommands);
 
         // built in options
         $internalOptions = FormatUtil::alignmentOptions(self::$internalOptions);

src/Base/AbstractCommand.php

@@ -488,7 +488,7 @@ protected function showHelpByMethodAnnotations(string $method, string $action =
                 }
 
                 if ($tag === 'usage') {
-                    $help['Usage:'] = $this->annotationVars['fullCommand'] . ' [arguments ...] [options ...]';
+                    $help['Usage:'] = $this->annotationVars['fullCommand'] . ' [--options ...] [arguments ...]';
                 }
 
                 continue;

src/BuiltIn/GenShellAutoComplete.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: inhere
+ * Date: 2018/7/4
+ * Time: 上午10:25
+ */
+
+namespace Inhere\Console\BuiltIn;
+
+/**
+ * Class GenShellAutoComplete
+ * @package Inhere\Console\BuiltIn
+ */
+class GenShellAutoComplete
+{
+
+}

src/Controller.php

@@ -238,7 +238,7 @@ final public function showCommandList()
         $this->beforeShowCommandList();
 
         $ref = new \ReflectionClass($this);
-        $sName = lcfirst(self::getName() ?: $ref->getShortName());
+        $sName = \lcfirst(self::getName() ?: $ref->getShortName());
 
         if (!($classDes = self::getDescription())) {
             $classDes = Annotation::description($ref->getDocComment()) ?: 'No description for the console controller';
@@ -274,7 +274,7 @@ final public function showCommandList()
         }
 
         // sort commands
-        ksort($commands);
+        \ksort($commands);
 
         // move 'help' to last.
         if ($helpCmd = $commands['help'] ?? null) {
@@ -286,19 +286,19 @@ final public function showCommandList()
 
         if ($this->executionAlone) {
             $name = $sName . ' ';
-            $usage = "$script <info>{command}</info> [arguments ...] [options ...]";
+            $usage = "$script <info>{command}</info> [--options ...] [arguments ...]";
         } else {
             $name = $sName . $this->delimiter;
-            $usage = "$script {$name}<info>{command}</info> [arguments ...] [options ...]";
+            $usage = "$script {$name}<info>{command}</info> [--options ...] [arguments ...]";
         }
 
         $this->output->startBuffer();
         $this->output->write(ucfirst($classDes) . PHP_EOL);
         $this->output->mList([
             'Usage:' => $usage,
             //'Group Name:' => "<info>$sName</info>",
-            'Options:' => FormatUtil::alignmentOptions(array_merge(Application::getInternalOptions(), static::$globalOptions)),
-            'Commands:' => $commands,
+            'Global Options:' => FormatUtil::alignmentOptions(array_merge(Application::getInternalOptions(), static::$globalOptions)),
+            'Available Commands:' => $commands,
         ], [
             'sepChar' => '  ',
         ]);

src/IO/Input/ArrayInput.php

@@ -27,14 +27,14 @@ public function __construct(array $argv = null, $parsing = true)
         parent::__construct([], false);
 
         $this->tokens = $argv;
-        $this->script = array_shift($argv);
-        $this->fullScript = implode(' ', $argv);
+        $this->script = \array_shift($argv);
+        $this->fullScript = \implode(' ', $argv);
 
         if ($parsing && $argv) {
             list($this->args, $this->sOpts, $this->lOpts) = InputParser::fromArray($argv);
 
             // collect command. it is first argument.
-            $this->command = isset($this->args[0]) ? array_shift($this->args) : null;
+            $this->command = isset($this->args[0]) ? \array_shift($this->args) : null;
         }
     }
 

src/IO/InputDefinition.php

@@ -22,21 +22,19 @@ class InputDefinition
         'default' => null,
     ];
 
+    /** @var string|array */
     private $example;
+
     /** @var string */
     private $description;
 
-    /**
-     * @var array[]
-     */
+    /** @var array[] */
     private $arguments;
     private $requiredCount = 0;
     private $hasOptional = false;
     private $hasAnArrayArgument = false;
 
-    /**
-     * @var array[]
-     */
+    /** @var array[] */
     private $options;
 
     /** @var array */