up: add more methods for get help data

Author: inhere

README.md

@@ -377,6 +377,7 @@ public const DEFINE_ITEM = [
 ## Costom Settings
 
 ```php
+    // -------------------- settings for parse option --------------------
 
     /**
      * Stop parse option on found first argument.

src/Contract/ParserInterface.php

@@ -153,10 +153,20 @@ public function getOpts(): array;
     public function getArgs(): array;
 
     /**
+     * Get args help data
+     *
+     * @return array
+     * @psalm-return array<string, string>
+     */
+    public function getArgsHelpData(): array;
+
+    /**
+     * Get opts help data
+     *
      * @return array
      * @psalm-return array<string, string>
      */
-    public function getOptSimpleDefines(): array;
+    public function getOptsHelpData(): array;
 
     /**
      * @return bool

src/Flags.php

@@ -856,19 +856,34 @@ public function getOpts(): array
     /**
      * @return array
      */
-    public function getOptSimpleDefines(): array
+    public function getArgsHelpData(): array
     {
-        $map = [];
-        foreach ($this->options as $name => $define) {
-            $names   = $define['shorts'];
+        $helpData = [];
+        foreach ($this->arguments as $arg) {
+            $name = $arg->getHelpName();
+            // append
+            $helpData[$name] = $arg->getDesc(true);
+        }
+
+        return $helpData;
+    }
+
+    /**
+     * @return array
+     */
+    public function getOptsHelpData(): array
+    {
+        $helpData = [];
+        foreach ($this->options as $name => $opt) {
+            $names   = $opt['shorts'];
             $names[] = $name;
 
             $helpName = FlagUtil::buildOptHelpName($names);
-
-            $map[$helpName] = $define['desc'];
+            // append
+            $helpData[$helpName] = $opt->getDesc(true);
         }
 
-        return $map;
+        return $helpData;
     }
 
     /**

src/FlagsParser.php

@@ -66,7 +66,7 @@ abstract class FlagsParser implements ParserInterface
     ];
 
     /**
-     * TODO If locked, cannot add option and argument
+     * If locked, cannot add option and argument
      *
      * @var bool
      */

src/SFlags.php

@@ -27,6 +27,7 @@
 use function strpos;
 use function substr;
 use function trim;
+use function ucfirst;
 
 /**
  * Class SFlags
@@ -889,19 +890,34 @@ public function getArgs(): array
     /**
      * @return array
      */
-    public function getOptSimpleDefines(): array
+    public function getArgsHelpData(): array
     {
-        $map = [];
+        $helpData = [];
+        foreach ($this->argDefines as $define) {
+            $name = $define['name'];
+
+            $helpData[$name] = $define['desc'];
+        }
+
+        return $helpData;
+    }
+
+    /**
+     * @return array
+     */
+    public function getOptsHelpData(): array
+    {
+        $helpData = [];
         foreach ($this->optDefines as $name => $define) {
             $names   = $define['shorts'];
             $names[] = $name;
 
             $helpName = FlagUtil::buildOptHelpName($names);
 
-            $map[$helpName] = $define['desc'];
+            $helpData[$helpName] = ucfirst($define['desc']);
         }
 
-        return $map;
+        return $helpData;
     }
 
     /**