update some for flag help render

Author: inhere

example/flags-demo.php

@@ -47,6 +47,7 @@
     'type'   => FlagType::STRING,
     'desc'   => 'option name is to lang, desc will print on newline',
     'shorts' => ['d','e'],
+    'alias'  => 'nv',
     // TIP: add validator limit input value.
     'validator' => EnumValidator::new(['one', 'two', 'three']),
 ]);

src/AbstractParser.php

@@ -9,6 +9,8 @@
 use Toolkit\PFlag\Contract\ParserInterface;
 use Toolkit\PFlag\Contract\ValidatorInterface;
 use Toolkit\PFlag\Exception\FlagException;
+use Toolkit\PFlag\Flag\Argument;
+use Toolkit\PFlag\Flag\Option;
 use Toolkit\Stdlib\Arr;
 use Toolkit\Stdlib\Helper\DataHelper;
 use Toolkit\Stdlib\Helper\IntHelper;
@@ -225,6 +227,10 @@ protected function parseRawArgs(array $rawArgs): array
         return $args;
     }
 
+    /****************************************************************
+     * build and render help
+     ***************************************************************/
+
     /**
      * display help messages
      */
@@ -288,22 +294,7 @@ protected function doBuildHelp(array $argDefines, array $optDefines, bool $withC
 
         $nameLen = $this->settings['argNameLen'];
         foreach ($fmtArgs as $hName => $arg) {
-            $desc = $arg['desc'];
-            if ($arg['required']) {
-                $desc = '<red1>*</red1>' . $desc;
-            }
-
-            // default value.
-            if (isset($arg['default']) && $arg['default'] !== null) {
-                $desc .= sprintf('(default <mga>%s</mga>)', DataHelper::toString($arg['default']));
-            }
-
-            // desc has multi line
-            $lines = [];
-            if (strpos($desc, "\n") > 0) {
-                $lines = explode("\n", $desc);
-                $desc  = array_shift($lines);
-            }
+            [$desc, $lines] = $this->formatDesc($arg);
 
             // write to buffer.
             $hName = Str::padRight($hName, $nameLen);
@@ -331,34 +322,7 @@ protected function doBuildHelp(array $argDefines, array $optDefines, bool $withC
         $nameLen  = $this->settings['optNameLen'];
         $maxWidth = $this->settings['descNlOnOptLen'];
         foreach ($fmtOpts as $hName => $opt) {
-            $desc = $opt['desc'];
-
-            if ($opt['required']) {
-                $desc = '<red1>*</red1>' . $desc;
-            }
-
-            // validator limit
-            if (!empty($opt['validator'])) {
-                $v = $opt['validator'];
-
-                /** @see ValidatorInterface */
-                if (is_object($v) && method_exists($v, '__toString')) {
-                    $limit = (string)$v;
-                    $desc  .= $limit ? ' ' . $limit : '';
-                }
-            }
-
-            // default value.
-            if (isset($opt['default']) && $opt['default'] !== null) {
-                $desc .= sprintf('(default <mga>%s</mga>)', DataHelper::toString($opt['default']));
-            }
-
-            // desc has multi line
-            $lines = [];
-            if (strpos($desc, "\n") > 0) {
-                $lines = explode("\n", $desc);
-                $desc  = array_shift($lines);
-            }
+            [$desc, $lines] = $this->formatDesc($opt);
 
             // need echo desc at newline.
             $hName = Str::padRight($hName, $nameLen);
@@ -381,6 +345,46 @@ protected function doBuildHelp(array $argDefines, array $optDefines, bool $withC
         return $withColor ? $buf->clear() : ColorTag::clear($buf->clear());
     }
 
+    /**
+     * @see DEFINE_ITEM for array $define
+     * @param array|Option|Argument $define
+     *
+     * @return array
+     */
+    protected function formatDesc($define): array
+    {
+        $desc = $define['desc'];
+
+        if ($define['required']) {
+            $desc = '<red1>*</red1>' . $desc;
+        }
+
+        // validator limit
+        if (!empty($define['validator'])) {
+            $v = $define['validator'];
+
+            /** @see ValidatorInterface */
+            if (is_object($v) && method_exists($v, '__toString')) {
+                $limit = (string)$v;
+                $desc  .= $limit ? ' ' . $limit : '';
+            }
+        }
+
+        // default value.
+        if (isset($define['default']) && $define['default'] !== null) {
+            $desc .= sprintf('(default <mga>%s</mga>)', DataHelper::toString($define['default']));
+        }
+
+        // desc has multi line
+        $lines = [];
+        if (strpos($desc, "\n") > 0) {
+            $lines = explode("\n", $desc);
+            $desc  = array_shift($lines);
+        }
+
+        return [$desc, $lines];
+    }
+
     /**
      * @param array $argDefines
      *
@@ -391,10 +395,9 @@ protected function buildArgsForHelp(array $argDefines): array
         $fmtArgs = [];
         $maxLen  = $this->settings['argNameLen'];
 
-        /** @var array $arg {@see DEFINE_ITEM} */
+        /** @var array|Argument $arg {@see DEFINE_ITEM} */
         foreach ($argDefines as $arg) {
             $helpName = $arg['name'] ?: 'arg' . $arg['index'];
-
             if ($desc = $arg['desc']) {
                 $desc = trim($desc);
             }
@@ -412,7 +415,7 @@ protected function buildArgsForHelp(array $argDefines): array
                 $helpName .= $typeName ? " $typeName" : '';
             }
 
-            $maxLen = FlagUtil::getMaxInt($maxLen, strlen($helpName));
+            $maxLen = IntHelper::getMax($maxLen, strlen($helpName));
 
             // append
             $fmtArgs[$helpName] = $arg;
@@ -437,9 +440,14 @@ protected function buildOptsForHelp(array $optDefines): array
         $nameLen = $this->settings['optNameLen'];
         ksort($optDefines);
 
-        /** @var array $opt {@see DEFINE_ITEM} */
+        /** @var array|Option $opt {@see DEFINE_ITEM} */
         foreach ($optDefines as $name => $opt) {
-            $names   = $opt['shorts'];
+            $names = $opt['shorts'];
+            /** @see Option support alias name. */
+            if (isset($opt['alias']) && $opt['alias']) {
+                $names[] = $opt['alias'];
+            }
+            // real name.
             $names[] = $name;
 
             if ($desc = $opt['desc']) {
@@ -455,7 +463,7 @@ protected function buildOptsForHelp(array $optDefines): array
                 $helpName .= $typeName ? " $typeName" : '';
             }
 
-            $nameLen = FlagUtil::getMaxInt($nameLen, strlen($helpName));
+            $nameLen = IntHelper::getMax($nameLen, strlen($helpName));
             // append
             $fmtOpts[$helpName] = $opt;
         }

src/Flags.php

@@ -17,6 +17,7 @@
 use function array_shift;
 use function array_slice;
 use function count;
+use function is_array;
 use function is_string;
 use function ltrim;
 use function str_split;
@@ -616,6 +617,10 @@ public function addOptByRule(string $name, $rule): self
         $define = $this->parseRule($rule, $name);
         $option = Option::newByArray($define['name'], $define);
 
+        if (is_array($rule) && isset($rule['alias'])) {
+            $option->setAlias($rule['alias']);
+        }
+
         return $this->addOption($option);
     }