introduce a more compact help screen

This is inspired by #9 but implements it in a more elegant way, requiring less conditionals.

Author: splitbrain

examples/complex.php

@@ -31,6 +31,7 @@ protected function setup(Options $options)
  $options->registerOption('load', 'Another flag only for the bar command, requiring an argument', 'l', 'input',
  'bar');
 
+ $options->registerCommand('compact', 'Display the help text in a more compact manner');
  }
 
  /**
@@ -51,6 +52,10 @@ protected function main(Options $options)
  case 'bar':
  $this->success('The bar command was called');
  break;
+ case 'compact':
+ $options->useCompactHelp();
+ echo $options->help();
+ exit;
  default:
  $this->error('No known command was called, we show the default help instead:');
  echo $options->help();
@@ -64,4 +69,4 @@ protected function main(Options $options)
 }
 
 $cli = new Complex();
-$cli->run();
+$cli->run();

src/Options.php

@@ -31,6 +31,9 @@ class Options
  /** @var Colors for colored help output */
  protected $colors;
 
+ /** @var string newline used for spacing help texts */
+ protected $newline = "\n";
+
  /**
  * Constructor
  *
@@ -88,6 +91,16 @@ public function setCommandHelp($help)
  $this->setup['']['commandhelp'] = $help;
  }
 
+ /**
+ * Use a more compact help screen with less new lines
+ *
+ * @param bool $set
+ */
+ public function useCompactHelp($set = true)
+ {
+ $this->newline = $set ? '' : "\n";
+ }
+
  /**
  * Register the names of arguments for help generation and number checking
  *
@@ -366,7 +379,7 @@ public function help()
  $text .= ' ' . $this->bin;
  $mv = 2;
  } else {
- $text .= "\n";
+ $text .= $this->newline;
  $text .= $this->colors->wrap(' ' . $command, Colors::C_PURPLE);
  $mv = 4;
  }
@@ -387,14 +400,14 @@ public function help()
  }
  $text .= ' ' . $out;
  }
- $text .= "\n";
+ $text .= $this->newline;
 
  // 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'] . $this->newline)
  );
  }
 
@@ -425,7 +438,7 @@ public function help()
  array('', $name, $opt['help']),
  array('', 'green', '')
  );
- $text .= "\n";
+ $text .= $this->newline;
  }
  }
 
@@ -435,7 +448,7 @@ public function help()
  $text .= "\n";
  $text .= $this->colors->wrap('ARGUMENTS:', Colors::C_BROWN);
  }
- $text .= "\n";
+ $text .= $this->newline;
  foreach ($this->setup[$command]['args'] as $arg) {
  $name = '<' . $arg['name'] . '>';
 
@@ -456,7 +469,7 @@ public function help()
  array($mv, '*'),
  array('', $commandhelp)
  );
- $text .= "\n";
+ $text .= $this->newline;
  }
  }