optimize some logic for command help

Author: inhere

README.md

@@ -31,6 +31,21 @@ $script = \array_shift($argv);
 list($args, $shortOpts, $longOpts) = Flags::parseArgv($argv);
 ```
 
+## Build CLI application
+
+You can quickly build an simple CLI application:
+
+```php
+use Toolkit\Cli\App;
+
+// create app instance
+$app = new App([
+  'desc' => 'this is my cli application',
+]);
+
+
+```
+
 ## PHP file highlight
 
 > This is inspire jakub-onderka/php-console-highlighter

example/liteApp

@@ -1,24 +1,56 @@
 #!/usr/bin/env php
 <?php
 
+use Toolkit\Cli\App;
+
 define('BASE_PATH', dirname(__DIR__));
 
 require dirname(__DIR__) . '/test/boot.php';
 
 // create app instance
-$app = new Toolkit\Cli\App;
+$app = new App([
+    'desc' => 'this is my cli application',
+]);
 
 // register commands
+
+// use closure
 $app->addCommand('test', function ($app) {
     echo "args:\n";
     /** @var Toolkit\Cli\App $app */
+    /** @noinspection ForgottenDebugOutputInspection */
     print_r($app->getArgs());
 
-}, 'the description text for the command: test');
+}, [
+  'desc' => 'the description text for the command: test',
+]);
+
+// Use an object
+$app->addObject(new class
+{
+    public function getHelpConfig(): array
+    {
+        $help = <<<STR
+Options:
+  --info    Output some information
+
+Example:
+  {{command}}
+
+STR;
+
+        return [
+            'name'  => 'list',
+            'desc'  => 'list all swoft components in src/ dir',
+            'help'  => $help,
+        ];
+    }
 
-$app->addCommand('test1', function () {
-    echo "hello\n";
-}, 'the description text for the command: test1');
+    public function __invoke(App $app)
+    {
+        echo "hello\n";
+    }
+});
 
 // run
 $app->run();

src/App.php

@@ -23,6 +23,7 @@
 use function is_string;
 use function ksort;
 use function method_exists;
+use function rtrim;
 use function str_pad;
 use function strlen;
 use function strpos;
@@ -252,6 +253,25 @@ protected function handleException(Throwable $e): int
         return $code;
     }
 
+    /**
+     * @param callable $handler
+     * @param array    $config
+     */
+    public function addObject(callable $handler, array $config = []): void
+    {
+        if (is_object($handler) && method_exists($handler, '__invoke')) {
+            // has config method
+            if (method_exists($handler, 'getHelpConfig')) {
+                $config = $handler->getHelpConfig();
+            }
+
+            $this->addByConfig($handler, $config);
+            return;
+        }
+
+        throw new InvalidArgumentException('Command handler must be an object and has method: __invoke');
+    }
+
     /**
      * @param callable $handler
      * @param array    $config
@@ -377,11 +397,12 @@ public function displayCommandHelp(string $name): void
             ];
         } else {
             $checkVar = true;
-            $userHelp = $config['help'];
+            $userHelp = rtrim($config['help'], "\n");
 
+            $usage = $config['usage'] ?: $usage;
             $nodes = [
                 ucfirst($config['desc']),
-                "<comment>Usage:</comment> \n  " . ($config['usage'] ?: $usage),
+                "<comment>Usage:</comment> \n  $usage\n",
                 $userHelp ? $userHelp . "\n" : ''
             ];
         }