Merge branch 'fix-cli'

Author: lkrms

.gitattributes

@@ -17,7 +17,6 @@
 /src/Facade/Debug.php linguist-generated
 /src/Facade/Err.php linguist-generated
 /src/Facade/Event.php linguist-generated
-/src/Facade/Format.php linguist-generated
 /src/Facade/Mapper.php linguist-generated
 /src/Facade/Profile.php linguist-generated
 /src/Facade/Sync.php linguist-generated

lk-util/Command/Generate/GenerateBuilder.php

@@ -10,9 +10,9 @@
 use Lkrms\Support\PhpDoc\PhpDoc;
 use Lkrms\Support\PhpDoc\PhpDocTemplateTag;
 use Lkrms\Support\Introspector;
-use Lkrms\Utility\Convert;
 use Lkrms\Utility\Pcre;
 use Lkrms\Utility\Reflect;
+use Lkrms\Utility\Str;
 use Lkrms\Utility\Test;
 use Closure;
 use ReflectionMethod;
@@ -175,7 +175,7 @@ protected function run(string ...$args)
             $writable = $introspector->getWritableProperties();
             $writable = array_combine(
                 array_map(
-                    fn(string $name) => Convert::toCamelCase($name),
+                    fn(string $name) => Str::toCamelCase($name),
                     $writable
                 ),
                 $writable
@@ -210,7 +210,7 @@ protected function run(string ...$args)
 
         if ($_constructor = $this->InputClass->getConstructor()) {
             foreach ($_constructor->getParameters() as $_param) {
-                $name = Convert::toCamelCase($_param->getName());
+                $name = Str::toCamelCase($_param->getName());
                 unset($writable[$name]);
                 $_params[$name] = $_param;
                 // Variables can't be passed to __call by reference, so this
@@ -244,7 +244,7 @@ protected function run(string ...$args)
                     continue;
                 }
                 $_name = $_property->getName();
-                $name = Convert::toCamelCase($_name);
+                $name = Str::toCamelCase($_name);
                 $_allProperties[$name] = $_property;
                 if (array_key_exists($_name, $defaults)) {
                     $_defaultProperties[$name] = $defaults[$_name];
@@ -541,8 +541,8 @@ protected function run(string ...$args)
                         $_method->isStatic() ||
                         strpos($name, '__') === 0 ||
                         isset($phpDoc->TagsByName['deprecated']) ||
-                        in_array(Convert::toCamelCase($name), $names) ||
-                        in_array(Convert::toCamelCase(Pcre::replace('/^(with|get)/i', '', $name)), $names) ||
+                        in_array(Str::toCamelCase($name), $names) ||
+                        in_array(Str::toCamelCase(Pcre::replace('/^(with|get)/i', '', $name)), $names) ||
                         in_array($name, $this->Skip) ||
                         ($this->Forward !== [] && !in_array($name, $this->Forward))) {
                     continue;

lk-util/Command/Generate/GenerateSyncEntity.php

@@ -16,6 +16,7 @@
 use Lkrms\Utility\Convert;
 use Lkrms\Utility\Inflect;
 use Lkrms\Utility\Pcre;
+use Lkrms\Utility\Str;
 use Closure;
 use DateTimeImmutable;
 
@@ -276,7 +277,7 @@ protected function run(string ...$args)
                 ? HttpRequestMethod::POST
                 : $this->HttpMethod;
             $endpoint = $endpoint === null
-                ? '/' . Convert::toKebabCase($class)
+                ? '/' . Str::toKebabCase($class)
                 : $endpoint;
 
             $curler = $provider->getCurler($endpoint);
@@ -309,7 +310,7 @@ protected static function getRemovablePrefixes(): ?array
         $normaliser = $entityClass::normaliser();
         $normaliser =
             fn(string $name): string =>
-                Convert::toPascalCase($normaliser($name));
+                Str::toPascalCase($normaliser($name));
 
         $skip = [];
         foreach ($this->SkipProperties as $property) {

lk-util/Command/Generate/GenerateSyncProvider.php

@@ -13,7 +13,7 @@
 use Lkrms\Sync\Contract\ISyncProvider;
 use Lkrms\Sync\Support\SyncIntrospector;
 use Lkrms\Utility\Arr;
-use Lkrms\Utility\Convert;
+use Lkrms\Utility\Str;
 
 /**
  * Generates provider interfaces for sync entities
@@ -148,11 +148,11 @@ protected function run(string ...$args)
             $this->Operations
         );
 
-        $camelClass = Convert::toCamelCase($class);
+        $camelClass = Str::toCamelCase($class);
         $plural = $this->Plural === null ? $fqcn::plural() : $this->Plural;
 
         if (strcasecmp($class, $plural)) {
-            $camelPlural = Convert::toCamelCase($plural);
+            $camelPlural = Str::toCamelCase($plural);
             $opMethod = [
                 SyncOperation::CREATE => 'create' . $class,
                 SyncOperation::READ => 'get' . $class,

lk-util/Command/Generate/GenerateTests.php

@@ -6,8 +6,8 @@
 use Lkrms\Cli\CliOption;
 use Lkrms\LkUtil\Catalog\EnvVar;
 use Lkrms\LkUtil\Command\Generate\Concept\GenerateCommand;
-use Lkrms\Utility\Convert;
 use Lkrms\Utility\Reflect;
+use Lkrms\Utility\Str;
 
 /**
  * Generates PHPUnit tests
@@ -165,8 +165,8 @@ protected function run(string ...$args)
                 continue;
             }
 
-            $testMethod = Convert::toCamelCase("test_{$method}");
-            $providerMethod = Convert::toCamelCase("{$method}_provider");
+            $testMethod = Str::toCamelCase("test_{$method}");
+            $providerMethod = Str::toCamelCase("{$method}_provider");
 
             $_parameters = $_method->getParameters();
             if ($_method->hasReturnType()) {

scripts/generate.php

@@ -36,7 +36,6 @@
 use Lkrms\Utility\Arr;
 use Lkrms\Utility\Debugging;
 use Lkrms\Utility\File;
-use Lkrms\Utility\Formatters;
 use Lkrms\Utility\System;
 
 $loader = require dirname(__DIR__) . '/vendor/autoload.php';
@@ -50,7 +49,6 @@
     Debugging::class => \Lkrms\Facade\Debug::class,
     ErrorHandler::class => [\Lkrms\Facade\Err::class, '--skip', 'handleShutdown,handleError,handleException'],
     EventDispatcher::class => \Lkrms\Facade\Event::class,
-    Formatters::class => \Lkrms\Facade\Format::class,
     SyncStore::class => \Lkrms\Facade\Sync::class,
     Timekeeper::class => \Lkrms\Facade\Profile::class,
     System::class => \Lkrms\Facade\Sys::class,

src/Cli/Catalog/CliOptionValueType.php

@@ -54,6 +54,17 @@ final class CliOptionValueType extends ConvertibleEnumeration
      */
     public const DIRECTORY = 6;
 
+    /**
+     * Path to an existing file or directory, or a dash ('-') for standard input
+     * or output
+     */
+    public const PATH_OR_DASH = 7;
+
+    /**
+     * Path to an existing file, or a dash ('-') for standard input or output
+     */
+    public const FILE_OR_DASH = 8;
+
     protected static $NameMap = [
         self::BOOLEAN => 'BOOLEAN',
         self::INTEGER => 'INTEGER',
@@ -62,6 +73,8 @@ final class CliOptionValueType extends ConvertibleEnumeration
         self::PATH => 'PATH',
         self::FILE => 'FILE',
         self::DIRECTORY => 'DIRECTORY',
+        self::PATH_OR_DASH => 'PATH_OR_DASH',
+        self::FILE_OR_DASH => 'FILE_OR_DASH',
     ];
 
     protected static $ValueMap = [
@@ -72,5 +85,7 @@ final class CliOptionValueType extends ConvertibleEnumeration
         'PATH' => self::PATH,
         'FILE' => self::FILE,
         'DIRECTORY' => self::DIRECTORY,
+        'PATH_OR_DASH' => self::PATH_OR_DASH,
+        'FILE_OR_DASH' => self::FILE_OR_DASH,
     ];
 }

src/Cli/Catalog/CliOptionVisibility.php

@@ -41,10 +41,32 @@ final class CliOptionVisibility extends Enumeration
      */
     public const COMPLETION = 16;
 
+    /**
+     * Include the option when generating a JSON Schema
+     */
+    public const SCHEMA = 32;
+
     /**
      * Hide the option's default value if not writing help to a terminal
      */
-    public const HIDE_DEFAULT = 32;
+    public const HIDE_DEFAULT = 64;
+
+    /**
+     * Show the option everywhere
+     */
+    public const ALL =
+        CliOptionVisibility::SYNOPSIS
+        | CliOptionVisibility::HELP
+        | CliOptionVisibility::MARKDOWN
+        | CliOptionVisibility::MAN_PAGE
+        | CliOptionVisibility::COMPLETION;
 
-    public const ALL = CliOptionVisibility::SYNOPSIS | CliOptionVisibility::HELP | CliOptionVisibility::MARKDOWN | CliOptionVisibility::MAN_PAGE | CliOptionVisibility::COMPLETION;
+    /**
+     * Show the option everywhere except in command synopses
+     */
+    public const ALL_EXCEPT_SYNOPSIS =
+        CliOptionVisibility::HELP
+        | CliOptionVisibility::MARKDOWN
+        | CliOptionVisibility::MAN_PAGE
+        | CliOptionVisibility::COMPLETION;
 }

src/Cli/CliCommand.php

@@ -593,17 +593,14 @@ final public function getHelp(bool $withMarkup = true, ?int $width = 80, bool $c
                 $synopsis = $line;
             }
 
-            if ($valueName !== null) {
-                $valueName = $formatter->removeTags($valueName);
-                $valueName = strtolower(Convert::splitWords($valueName, null, ' '));
-            }
-
             $lines = [];
             if ($option->Description !== null &&
                     ($description = trim($option->Description)) !== '') {
                 $lines[] = $this->prepareUsage($description, $formatter, $width, $indent);
             }
 
+            $valueName = $option->getValueName();
+
             if ($allowed) {
                 foreach ($allowed as &$value) {
                     $value = sprintf('%s- %s', $indent, $value);
@@ -660,7 +657,7 @@ final public function getHelp(bool $withMarkup = true, ?int $width = 80, bool $c
 
     private function prepareUsage(?string $description, Formatter $formatter, ?int $width, ?string $indent = null): string
     {
-        if (($description ?? '') === '') {
+        if ((string) $description === '') {
             return '';
         }
 
@@ -956,7 +953,7 @@ final protected function getOptionValues(
                     ($option->ValueOptional && $value === null))) {
                 continue;
             }
-            $name = $option->Long ?: $option->Short;
+            $name = $option->Name;
             if ($nameCallback) {
                 $name = $nameCallback($name);
             }
@@ -987,7 +984,7 @@ final protected function getDefaultOptionValues(?callable $nameCallback = null):
         $values = [];
         foreach ($this->Options as $option) {
             $value = $option->ValueOptional ? null : $option->OriginalDefaultValue;
-            $name = $option->Long ?: $option->Short;
+            $name = $option->Name;
             if ($nameCallback) {
                 $name = $nameCallback($name);
             }
@@ -1155,7 +1152,7 @@ final protected function getEffectiveCommandLine(
         $positional = [];
         foreach ($this->Options as $option) {
             $name = null;
-            foreach (Arr::whereNotEmpty([$option->Long, $option->Short]) as $key) {
+            foreach ($option->getNames() as $key) {
                 if (array_key_exists($key, $values)) {
                     $name = $key;
                     break;