feat: support add hidden flag options

Author: inhere

src/Concern/HelperRenderTrait.php

@@ -70,6 +70,11 @@ trait HelperRenderTrait
      */
     protected $showTypeOnHelp = true;
 
+    /**
+     * @var bool
+     */
+    protected $showHiddenOpt = false;
+
     /**
      * Will call it on before print help message
      *
@@ -287,6 +292,11 @@ protected function buildOptsForHelp(array $optDefines, bool $hasShortOpt): array
 
         /** @var array|Option $opt {@see FlagsParser::DEFINE_ITEM} */
         foreach ($optDefines as $name => $opt) {
+            // hidden option
+            if ($this->showHiddenOpt === false && $opt['hidden']) {
+                continue;
+            }
+
             $names = $opt['shorts'];
             /** @see Option support alias name. */
             if (isset($opt['alias']) && $opt['alias']) {
@@ -438,4 +448,12 @@ public function setBeforePrintHelp(callable $beforePrintHelp): void
     {
         $this->beforePrintHelp = $beforePrintHelp;
     }
+
+    /**
+     * @param bool $showHiddenOpt
+     */
+    public function setShowHiddenOpt(bool $showHiddenOpt): void
+    {
+        $this->showHiddenOpt = $showHiddenOpt;
+    }
 }

src/Flag/Option.php

@@ -48,6 +48,11 @@ class Option extends AbstractFlag
      */
     private $shortcut = '';
 
+    /**
+     * @var bool
+     */
+    private $hidden = false;
+
     /**
      * @return bool
      */
@@ -160,6 +165,22 @@ public function getHelpName(): string
         return implode(', ', $nodes);
     }
 
+    /**
+     * @return bool
+     */
+    public function isHidden(): bool
+    {
+        return $this->hidden;
+    }
+
+    /**
+     * @param bool $hidden
+     */
+    public function setHidden(bool $hidden): void
+    {
+        $this->hidden = $hidden;
+    }
+
     /**
      * @return array
      */

src/Flags.php

@@ -1028,6 +1028,10 @@ public function getOptsHelpData(): array
     {
         $helpData = [];
         foreach ($this->options as $name => $opt) {
+            if ($this->showHiddenOpt === false && $opt['hidden']) {
+                continue;
+            }
+
             $names   = $opt['shorts'];
             $names[] = $name;
 

src/FlagsParser.php

@@ -61,6 +61,7 @@ abstract class FlagsParser implements ParserInterface
         'envVar'    => '', // support read value from ENV var
         'default'   => null,
         'shorts'    => [], // only for option. ['a', 'b']
+        'hidden'    => false, // only for option
         // value validator
         'validator' => null,
         // 'category' => null

src/SFlags.php

@@ -1031,6 +1031,10 @@ public function getOptsHelpData(): array
     {
         $helpData = [];
         foreach ($this->optDefines as $name => $define) {
+            if ($this->showHiddenOpt === false && $define['hidden']) {
+                continue;
+            }
+
             $names   = $define['shorts'];
             $names[] = $name;