Cli: fix regression where terse synopses are double-escaped

- Always escape help messages and synopses, and rename
  `CliHelpTarget::INTERNAL` to `PLAIN` to better reflect this

Author: lkrms

src/Cli/Catalog/CliHelpTarget.php

@@ -12,9 +12,9 @@
 final class CliHelpTarget extends Enumeration
 {
     /**
-     * Help is used internally
+     * Help is written to a terminal with minimal formatting
      */
-    public const INTERNAL = 0;
+    public const PLAIN = 0;
 
     /**
      * Help is written to a terminal

src/Cli/CliApplication.php

@@ -257,16 +257,16 @@ private function getHelp(string $name, $node, ?CliHelpStyle $style = null): ?str
      */
     private function getUsage(string $name, $node): ?string
     {
-        $style = new CliHelpStyle(CliHelpTarget::INTERNAL, CliHelpStyle::getConsoleWidth());
+        $style = new CliHelpStyle(CliHelpTarget::PLAIN, CliHelpStyle::getConsoleWidth());
 
         $command = $this->getNodeCommand($name, $node);
         $progName = $this->getProgramName();
 
         if ($command) {
-            return Formatter::escapeTags($command->getSynopsis($style)
-                . "\n\nSee '"
-                . ($name === '' ? "$progName --help" : "$progName help $name")
-                . "' for more information.");
+            return $command->getSynopsis($style)
+                . Formatter::escapeTags("\n\nSee '"
+                    . ($name === '' ? "$progName --help" : "$progName help $name")
+                    . "' for more information.");
         }
 
         if (!is_array($node)) {
@@ -279,16 +279,20 @@ private function getUsage(string $name, $node): ?string
         foreach ($node as $childName => $childNode) {
             $command = $this->getNodeCommand(trim("$name $childName"), $childNode);
             if ($command) {
-                $synopses[] = $command->getSynopsis($style);
+                $synopsis = $command->getSynopsis($style);
             } elseif (is_array($childNode)) {
-                $synopses[] = "$fullName $childName <command>";
+                $synopsis = "$fullName $childName <command>";
+                $synopsis = Formatter::escapeTags($synopsis);
+            } else {
+                continue;
             }
+            $synopses[] = $synopsis;
         }
 
-        return Formatter::escapeTags(implode("\n", $synopses)
-            . "\n\nSee '"
-            . Arr::implode(' ', ["$progName help", $name, '<command>'])
-            . "' for more information.");
+        return implode("\n", $synopses)
+            . Formatter::escapeTags("\n\nSee '"
+                . Arr::implode(' ', ["$progName help", $name, '<command>'])
+                . "' for more information.");
     }
 
     /**
@@ -319,7 +323,7 @@ public function run()
             if ($arg === '--version' && !$args) {
                 $appName = $this->getAppName();
                 $version = Package::version(true, true);
-                Console::stdout('__' . $appName . "__ $version");
+                Console::stdout('__' . $appName . '__ ' . $version);
                 return $this;
             }
 

src/Cli/CliCommand.php

@@ -11,7 +11,6 @@
 use Lkrms\Cli\Exception\CliInvalidArgumentsException;
 use Lkrms\Cli\Exception\CliUnknownValueException;
 use Lkrms\Cli\Support\CliHelpStyle;
-use Lkrms\Console\ConsoleFormatter as Formatter;
 use Lkrms\Facade\Console;
 use Lkrms\Utility\Arr;
 use Lkrms\Utility\Package;
@@ -213,7 +212,7 @@ final public function __invoke(string ...$args): int
         if ($this->HasVersionArgument) {
             $appName = $this->App->getAppName();
             $version = Package::version(true, true);
-            Console::stdout("__{$appName}__ $version");
+            Console::stdout('__' . $appName . '__ ' . $version);
             return 0;
         }
 
@@ -616,11 +615,7 @@ private function getOptionsSynopsis(CliHelpStyle $style, ?string &$collapsed = n
             }
 
             $valueName = $option->formatValueName();
-            // Preserve angle brackets around value names if they won't be
-            // formatted differently
-            if (!$style->HasMarkup) {
-                $valueName = Formatter::escapeTags($valueName);
-            }
+            $valueName = $style->maybeEscapeTags($valueName);
 
             if ($option->IsPositional) {
                 if ($option->MultipleAllowed) {
@@ -655,7 +650,7 @@ private function getOptionsSynopsis(CliHelpStyle $style, ?string &$collapsed = n
                     . ($option->ValueRequired
                         ? $esc . ' ' . $valueName . $suffix
                         : $esc . '[' . $valueName . ']' . $suffix)
-                : $prefix . $b . "--{$option->Long}" . $b
+                : $prefix . $b . '--' . $option->Long . $b
                     . ($option->ValueRequired
                         ? $esc . ' ' . $valueName . $suffix
                         : $esc . '[=' . $valueName . ']' . $suffix);
@@ -668,8 +663,8 @@ private function getOptionsSynopsis(CliHelpStyle $style, ?string &$collapsed = n
         }
 
         $collapsed = Arr::implode(' ', [
-            $optionalCount > 1 ? $esc . '[<options>]' : '',
-            $optionalCount === 1 ? $esc . '[<option>]' : '',
+            $optionalCount > 1 ? $esc . '[' . $style->maybeEscapeTags('<options>') . ']' : '',
+            $optionalCount === 1 ? $esc . '[' . $style->maybeEscapeTags('<option>') . ']' : '',
             $required ? implode(' ', $required) : '',
             $positional ? $esc . '[' . $b . '--' . $b . '] ' . implode(' ', $positional) : '',
         ]);

src/Cli/CliOption.php

@@ -363,7 +363,7 @@ public function __construct(
         $this->Short = $this->IsPositional ? null : Str::coalesce($short, null);
         $this->Key = $this->IsPositional ? (string) $this->Name : ($short . '|' . $long);
         $this->ValueName = $this->IsFlag ? null : Str::coalesce($valueName, $this->IsPositional ? Str::toKebabCase((string) $this->Name, '=') : null, 'value');
-        $this->DisplayName = $this->IsPositional ? $this->formatValueName(false) : ($this->Long !== null ? "--{$long}" : "-{$short}");
+        $this->DisplayName = $this->IsPositional ? $this->formatValueName(false) : ($this->Long !== null ? '--' . $long : '-' . $short);
         $this->ValueType = $this->IsFlag ? ($multipleAllowed ? CliOptionValueType::INTEGER : CliOptionValueType::BOOLEAN) : $valueType;
         $this->Delimiter = $multipleAllowed && !$this->IsFlag ? Str::coalesce($delimiter, null) : null;
         $this->Description = $description;

src/Cli/Support/CliHelpStyle.php

@@ -56,7 +56,7 @@ final class CliHelpStyle
     /**
      * @readonly
      */
-    public string $Escape = '';
+    public string $Escape = '\\';
 
     /**
      * @readonly
@@ -109,21 +109,20 @@ final class CliHelpStyle
      * @param CliHelpTarget::* $target
      */
     public function __construct(
-        int $target = CliHelpTarget::INTERNAL,
+        int $target = CliHelpTarget::PLAIN,
         ?int $width = null,
         ?Formatter $formatter = null
     ) {
         $this->Target = $target;
         $this->Width = $width;
 
-        if ($target === CliHelpTarget::INTERNAL) {
+        if ($target === CliHelpTarget::PLAIN) {
             $this->Formatter = $formatter ?: LoopbackFormat::getFormatter();
             return;
         }
 
         $this->HasMarkup = true;
         $this->Italic = '_';
-        $this->Escape = '\\';
 
         switch ($target) {
             case CliHelpTarget::TTY:
@@ -230,6 +229,14 @@ public function buildHelp(array $sections): string
         return Pcre::replace('/^\h++$/m', '', rtrim($help));
     }
 
+    public function maybeEscapeTags(string $string): string
+    {
+        if ($this->HasMarkup) {
+            return $string;
+        }
+        return $this->Formatter->escapeTags($string);
+    }
+
     public static function getConsoleWidth(): ?int
     {
         $width = Console::getWidth();