Allow help to be more compact

hexmode · hexmode · commit 39cad9dad193 · 2019-05-11T19:02:20.000-04:00
diff --git a/src/Options.php b/src/Options.php
@@ -70,7 +70,7 @@ public function setHelp($help)
     }
 
     /**
-     * Sets the help text for the tools commands itself
+     * Sets the help text for the tool's commands
      *
      * @param string $help
      */
@@ -79,6 +79,16 @@ public function setCommandHelp($help)
         $this->setup['']['commandhelp'] = $help;
     }
 
+    /**
+     * Sets the help text for the tools commands itself
+     *
+     * @param boolean $compact
+     */
+    public function setCompactHelp(bool $compact=true)
+    {
+        $this->setup['']['compacthelp'] = $compact;
+    }
+
     /**
      * Register the names of arguments for help generation and number checking
      *
@@ -346,6 +356,8 @@ public function help()
         $hascommands = (count($this->setup) > 1);
         $commandhelp = $this->setup[""]["commandhelp"]
                      ?: 'This tool accepts a command as first parameter as outlined below:';
+        $compacthelp = $this->setup[""]["compacthelp"] ?: false;
+
         foreach ($this->setup as $command => $config) {
             $hasopts = (bool)$this->setup[$command]['opts'];
             $hasargs = (bool)$this->setup[$command]['args'];
@@ -378,21 +390,26 @@ public function help()
                 }
                 $text .= ' ' . $out;
             }
-            $text .= "\n";
+            if (!$compacthelp) {
+                $text .= "\n";
+            }
 
             // usage or command intro
             if ($this->setup[$command]['help']) {
                 $text .= "\n";
                 $text .= $tf->format(
                     array($mv, '*'),
-                    array('', $this->setup[$command]['help'] . "\n")
+                    array('', $this->setup[$command]['help'] 
+                          . (!$compacthelp ?: "\n"))
                 );
             }
 
             // option description
             if ($hasopts) {
                 if (!$command) {
-                    $text .= "\n";
+                    if (!$compacthelp) {
+                        $text .= "\n";
+                    }
                     $text .= $this->colors->wrap('OPTIONS:', Colors::C_BROWN);
                 }
                 $text .= "\n";
@@ -411,12 +428,15 @@ public function help()
                         $name .= ' <' . $opt['needsarg'] . '>';
                     }
 
+                    if (!$compacthelp) {
+                        $text .= "\n";
+                    }
+
                     $text .= $tf->format(
                         array($mv, '30%', '*'),
                         array('', $name, $opt['help']),
                         array('', 'green', '')
                     );
-                    $text .= "\n";
                 }
             }
 
@@ -447,7 +467,9 @@ public function help()
                     array($mv, '*'),
                     array('', $commandhelp)
                 );
-                $text .= "\n";
+                if (!$compacthelp) {
+                    $text .= "\n";
+                }
             }
         }
 
