Skip to content

Commit

Permalink
breaking: rename flag package methods
Browse files Browse the repository at this point in the history
  • Loading branch information
inhere committed Oct 26, 2021
1 parent ba69f2e commit a90478f
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 14 deletions.
4 changes: 2 additions & 2 deletions src/Concern/ApplicationHelpTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 <info>{COMMAND}</info> [--opt -v -h ...] [arg0 arg1 arg2=value2 ...]",
Expand Down
6 changes: 3 additions & 3 deletions src/Concern/CommandHelpTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand All @@ -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, [
Expand Down
4 changes: 2 additions & 2 deletions src/Concern/ControllerHelpTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ public function showCommandList(): void

$globalOptions = [];
if ($app = $this->getApp()) {
$globalOptions = $app->getFlags()->getOptsHelpData();
$globalOptions = $app->getFlags()->getOptsHelpLines();
}

$this->output->startBuffer();
Expand All @@ -175,7 +175,7 @@ public function showCommandList(): void
$this->output->writef("<comment>Alias:</comment> %s\n", implode(',', $aliases));
}

$groupOptions = $this->flags->getOptsHelpData();
$groupOptions = $this->flags->getOptsHelpLines();
$this->output->mList([
'Usage:' => $usage,
//'Group Name:' => "<info>$sName</info>",
Expand Down
3 changes: 2 additions & 1 deletion src/Controller.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
use function substr;
use function trim;
use function ucfirst;
use function vdump;

/**
* Class Controller
Expand Down Expand Up @@ -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());
}

/**
Expand Down
12 changes: 8 additions & 4 deletions src/GlobalOption.php
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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'
],
];

/**
Expand Down
4 changes: 2 additions & 2 deletions src/Util/FormatUtil.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit a90478f

Please sign in to comment.