From a90478f356400e79976bd1f86627cde778138f71 Mon Sep 17 00:00:00 2001 From: Inhere Date: Tue, 26 Oct 2021 19:49:17 +0800 Subject: [PATCH] breaking: rename flag package methods --- src/Concern/ApplicationHelpTrait.php | 4 ++-- src/Concern/CommandHelpTrait.php | 6 +++--- src/Concern/ControllerHelpTrait.php | 4 ++-- src/Controller.php | 3 ++- src/GlobalOption.php | 12 ++++++++---- src/Util/FormatUtil.php | 4 ++-- 6 files changed, 19 insertions(+), 14 deletions(-) diff --git a/src/Concern/ApplicationHelpTrait.php b/src/Concern/ApplicationHelpTrait.php index 4a47980..54cd17f 100644 --- a/src/Concern/ApplicationHelpTrait.php +++ b/src/Concern/ApplicationHelpTrait.php @@ -125,7 +125,7 @@ public function showHelpInfo(string $command = ''): void // built in options // $globalOptions = self::$globalOptions; - $globalOptions = $this->flags->getOptsHelpData(); + $globalOptions = $this->flags->getOptsHelpLines(); // append generate options: // php examples/app --auto-completion --shell-env zsh --gen-file // php examples/app --auto-completion --shell-env zsh --gen-file stdout @@ -277,7 +277,7 @@ public function showCommandList(): void // built in options // $globOpts = self::$globalOptions; - $globOpts = $this->flags->getOptsHelpData(); + $globOpts = $this->flags->getOptsHelpLines(); Show::mList([ 'Usage:' => "$scriptName {COMMAND} [--opt -v -h ...] [arg0 arg1 arg2=value2 ...]", diff --git a/src/Concern/CommandHelpTrait.php b/src/Concern/CommandHelpTrait.php index 435e431..97bec6d 100644 --- a/src/Concern/CommandHelpTrait.php +++ b/src/Concern/CommandHelpTrait.php @@ -140,8 +140,8 @@ public function showHelpByFlagsParser(FlagsParser $fs, array $aliases = [], stri $help['Usage:'] = "$path [--options ...] [arguments ...]"; - $help['Options:'] = FormatUtil::alignOptions($fs->getOptsHelpData()); - $help['Argument:'] = $fs->getArgsHelpData(); + $help['Options:'] = FormatUtil::alignOptions($fs->getOptsHelpLines()); + $help['Argument:'] = $fs->getArgsHelpLines(); $help['Example:'] = $fs->getExampleHelp(); $help['More Help:'] = $fs->getMoreHelp(); @@ -152,7 +152,7 @@ public function showHelpByFlagsParser(FlagsParser $fs, array $aliases = [], stri // attached to console app if ($app = $this->getApp()) { - $help['Global Options:'] = FormatUtil::alignOptions($app->getFlags()->getOptsHelpData()); + $help['Global Options:'] = FormatUtil::alignOptions($app->getFlags()->getOptsHelpLines()); } $this->output->mList($help, [ diff --git a/src/Concern/ControllerHelpTrait.php b/src/Concern/ControllerHelpTrait.php index 52b68b5..a0b454c 100644 --- a/src/Concern/ControllerHelpTrait.php +++ b/src/Concern/ControllerHelpTrait.php @@ -165,7 +165,7 @@ public function showCommandList(): void $globalOptions = []; if ($app = $this->getApp()) { - $globalOptions = $app->getFlags()->getOptsHelpData(); + $globalOptions = $app->getFlags()->getOptsHelpLines(); } $this->output->startBuffer(); @@ -175,7 +175,7 @@ public function showCommandList(): void $this->output->writef("Alias: %s\n", implode(',', $aliases)); } - $groupOptions = $this->flags->getOptsHelpData(); + $groupOptions = $this->flags->getOptsHelpLines(); $this->output->mList([ 'Usage:' => $usage, //'Group Name:' => "$sName", diff --git a/src/Controller.php b/src/Controller.php index 79bf6a7..41e88e2 100644 --- a/src/Controller.php +++ b/src/Controller.php @@ -40,6 +40,7 @@ use function substr; use function trim; use function ucfirst; +use function vdump; /** * Class Controller @@ -520,7 +521,7 @@ protected function showHelp(): bool */ protected function beforeRenderCommandHelp(array &$help): void { - $help['Group Options:'] = FormatUtil::alignOptions($this->flags->getOptsHelpData()); + $help['Group Options:'] = FormatUtil::alignOptions($this->flags->getOptsHelpLines()); } /** diff --git a/src/GlobalOption.php b/src/GlobalOption.php index 48607f9..b6ebc10 100644 --- a/src/GlobalOption.php +++ b/src/GlobalOption.php @@ -51,9 +51,10 @@ class GlobalOption */ private static $options = [ 'debug' => [ - 'type' => FlagType::INT, - 'desc' => 'Setting the runtime log debug level(quiet 0 - 5 crazy)', - 'envVar' => Console::DEBUG_ENV_KEY, + 'type' => FlagType::INT, + 'desc' => 'Setting the runtime log debug level, quiet 0 - crazy 5', + 'envVar' => Console::DEBUG_ENV_KEY, + 'default' => Console::VERB_ERROR, ], 'ishell' => 'bool;Run application an interactive shell environment', 'profile' => 'bool;Display timing and memory usage information', @@ -104,7 +105,10 @@ class GlobalOption */ protected static $groupOptions = [ // '--help' => 'bool;Display this help message;;;h', - self::SHOW_DISABLED => 'string;Whether display disabled commands', + self::SHOW_DISABLED => [ + 'hidden' => true, + 'desc' => 'Whether display disabled commands' + ], ]; /** diff --git a/src/Util/FormatUtil.php b/src/Util/FormatUtil.php index 75dfe8e..ba43c24 100644 --- a/src/Util/FormatUtil.php +++ b/src/Util/FormatUtil.php @@ -160,10 +160,10 @@ public static function alignOptions(array $options): array } // padding length equals to '-h, ' - if (!strpos($name, ',')) { + if (!str_contains($name, ',')) { $name = ' ' . $name; } else { - $name = str_replace([' ', ','], ['', ', '], $name); + $name = str_replace([',-'], [', -'], $name); } $formatted[$name] = $des;