breaking: refactor the get opt help data

Author: inhere

src/Concern/HelperRenderTrait.php

@@ -23,6 +23,7 @@
 use function strlen;
 use function strpos;
 use function trim;
+use function ucfirst;
 
 /**
  * trait HelperRenderTrait
@@ -199,8 +200,7 @@ protected function doBuildHelp(array $argDefines, array $optDefines, bool $withC
      */
     protected function formatDesc($define): array
     {
-        $desc = $define['desc'];
-
+        $desc = $define['desc'] ?: 'No description';
         if ($define['required']) {
             $desc = '<red1>*</red1>' . $desc;
         }
@@ -337,6 +337,36 @@ protected function buildOptsForHelp(array $optDefines, bool $hasShortOpt): array
         return $fmtOpts;
     }
 
+    /**
+     * @param string $name
+     * @param array $opt
+     *
+     * @return array<string, string>
+     */
+    protected function buildOptHelpLine(string $name, array $opt): array
+    {
+        $names   = $opt['shorts'];
+        $names[] = $name;
+
+        $helpName = FlagUtil::buildOptHelpName($names);
+
+        // show type name.
+        if ($this->showTypeOnHelp) {
+            $typeName = $opt['helpType'] ?: FlagType::getHelpName($opt['type']);
+            $helpName .= $typeName ? " $typeName" : '';
+        }
+
+        $opt['desc'] = $opt['desc'] ? ucfirst($opt['desc']) : "Option $name";
+
+        // format desc
+        [$desc, $otherLines] = $this->formatDesc($opt);
+        if ($otherLines) {
+            $desc .= "\n" . implode("\n", $otherLines);
+        }
+
+        return [$helpName, $desc];
+    }
+
     /****************************************************************
      * getter/setter methods
      ***************************************************************/

src/Contract/ParserInterface.php

@@ -247,20 +247,32 @@ public function getOpts(): array;
     public function getArgs(): array;
 
     /**
-     * Get args help data
+     * Get args help lines data
+     *
+     * ```php
+     * [
+     *  helpName => format desc,
+     * ]
+     * ```
      *
      * @return array
      * @psalm-return array<string, string>
      */
-    public function getArgsHelpData(): array;
+    public function getArgsHelpLines(): array;
 
     /**
-     * Get opts help data
+     * Get opts help lines data
+     *
+     * ```php
+     * [
+     *  helpName => format desc,
+     * ]
+     * ```
      *
      * @return array
      * @psalm-return array<string, string>
      */
-    public function getOptsHelpData(): array;
+    public function getOptsHelpLines(): array;
 
     public function lock(): void;
 

src/Flags.php

@@ -28,6 +28,7 @@
 use function str_split;
 use function strlen;
 use function substr;
+use function ucfirst;
 
 /**
  * Class Flags
@@ -1009,7 +1010,7 @@ public function getOpts(): array
     /**
      * @return array
      */
-    public function getArgsHelpData(): array
+    public function getArgsHelpLines(): array
     {
         $helpData = [];
         foreach ($this->arguments as $arg) {
@@ -1024,20 +1025,16 @@ public function getArgsHelpData(): array
     /**
      * @return array
      */
-    public function getOptsHelpData(): array
+    public function getOptsHelpLines(): array
     {
         $helpData = [];
         foreach ($this->options as $name => $opt) {
             if ($this->showHiddenOpt === false && $opt['hidden']) {
                 continue;
             }
 
-            $names   = $opt['shorts'];
-            $names[] = $name;
-
-            $helpName = FlagUtil::buildOptHelpName($names);
-            // append
-            $helpData[$helpName] = $opt->getDesc(true);
+            [$helpName, $fmtDesc] = $this->buildOptHelpLine($name, $opt->toArray());
+            $helpData[$helpName]  = $fmtDesc;
         }
 
         return $helpData;

src/SFlags.php

@@ -1012,7 +1012,7 @@ public function getArgs(): array
     /**
      * @return array
      */
-    public function getArgsHelpData(): array
+    public function getArgsHelpLines(): array
     {
         $helpData = [];
         foreach ($this->argDefines as $define) {
@@ -1027,23 +1027,19 @@ public function getArgsHelpData(): array
     /**
      * @return array
      */
-    public function getOptsHelpData(): array
+    public function getOptsHelpLines(): array
     {
-        $helpData = [];
-        foreach ($this->optDefines as $name => $define) {
-            if ($this->showHiddenOpt === false && $define['hidden']) {
+        $helpLines = [];
+        foreach ($this->optDefines as $name => $opt) {
+            if ($this->showHiddenOpt === false && $opt['hidden']) {
                 continue;
             }
 
-            $names   = $define['shorts'];
-            $names[] = $name;
-
-            $helpName = FlagUtil::buildOptHelpName($names);
-
-            $helpData[$helpName] = ucfirst($define['desc']);
+            [$helpName, $fmtDesc] = $this->buildOptHelpLine($name, $opt);
+            $helpLines[$helpName]  = $fmtDesc;
         }
 
-        return $helpData;
+        return $helpLines;
     }
 
     /**