Skip to content

refactor: write the Console runner through its Output #10713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulbalandan merged 1 commit into from
Nov 3, 2026
Merged

refactor: write the Console runner through its Output #10713

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 25 additions & 16 deletions system/CLI/Console.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public function run(array $tokens = [])
$this->setShellVerbosity($output->getVerbosity()->value);

try {
$exitCode = $this->dispatch($arguments);
$exitCode = $this->dispatch($output, $arguments);
} catch (Throwable $e) {
// The spark run keeps the level, so the exception handler renders the uncaught throwable at it.
if (! $fromArgv) {
Expand All @@ -68,7 +68,11 @@ public function run(array $tokens = [])

throw $e;
} finally {
$this->restoreShellVerbosity($previousShellVerbosity, $previousEnvShellVerbosity, $previousServerShellVerbosity);
$this->restoreShellVerbosity(
$previousShellVerbosity,
$previousEnvShellVerbosity,
$previousServerShellVerbosity,
);
}

$output->setVerbosity($previousVerbosity);
Expand Down Expand Up @@ -103,18 +107,20 @@ public function showHeader(bool $suppress = false)
return;
}

CLI::write(sprintf(
$output = CLI::getOutput();

$output->write(sprintf(
'CodeIgniter v%s Command Line Tool - Server Time: %s',
CodeIgniter::CI_VERSION,
date('Y-m-d H:i:s \\U\\T\\CP'),
), 'green');
CLI::newLine();
$output->newLine();
}

/**
* @param list<string> $arguments
*/
private function dispatch(array $arguments): int
private function dispatch(Output $output, array $arguments): int
{
$noHeader = $this->hasParameterOption(['no-header']);

Expand All @@ -139,14 +145,14 @@ private function dispatch(array $arguments): int
$this->showHeader($noHeader || $commands->isHeaderlessCommand($this->command));

if (
$this->isInteractive()
$this->isInteractive($output)
&& ! $commands->hasLegacyCommand($this->command)
&& ! $commands->hasModernCommand($this->command)
) {
$alternatives = $commands->getCommandAlternatives($this->command);

if ($alternatives !== []) {
$alternative = $this->chooseAlternative($alternatives);
$alternative = $this->chooseAlternative($output, $alternatives);

if ($alternative === null) {
return EXIT_ERROR;
Expand All @@ -163,7 +169,7 @@ private function dispatch(array $arguments): int
return $commands->runLegacy($this->command, array_merge($arguments, $legacyOptions));
}

return $commands->runCommand($this->command, $arguments, $this->normalizeVerbosityOptions(), CLI::getOutput());
return $commands->runCommand($this->command, $arguments, $this->normalizeVerbosityOptions(), $output);
}

/**
Expand Down Expand Up @@ -280,15 +286,18 @@ private function restoreShellVerbosity(false|string $process, mixed $env, array|
*
* @param list<string> $alternatives
*/
private function chooseAlternative(array $alternatives): ?string
private function chooseAlternative(Output $output, array $alternatives): ?string
{
CLI::error(lang('CLI.commandNotFound', [$this->command]));
CLI::newLine();
$output->error(lang('CLI.commandNotFound', [$this->command]));
$output->newLine();

$prompt = CLI::getPrompt();
$prompt = new Prompt($output);

if (count($alternatives) === 1) {
return $prompt->ask(lang('CLI.altCommandRun', [$alternatives[0]]), ['y', 'n']) === 'y' ? $alternatives[0] : null;
return $prompt->ask(
lang('CLI.altCommandRun', [$alternatives[0]]),
['y', 'n'],
) === 'y' ? $alternatives[0] : null;
}

$chosen = $prompt->select(lang('CLI.altCommandSelect'), [...$alternatives, lang('CLI.altCommandNone')]);
Expand All @@ -312,11 +321,11 @@ private function hasParameterOption(array $options): bool
return false;
}

private function isInteractive(): bool
private function isInteractive(Output $output): bool
{
return ! $this->hasParameterOption(['no-interaction', 'N'])
&& ! CLI::getOutput()->isQuiet()
&& ! CLI::getInputOutput() instanceof NullInputOutput
&& ! $output->isQuiet()
&& ! $output->getInputOutput() instanceof NullInputOutput
&& defined('STDIN')
&& CLI::streamSupports('stream_isatty', STDIN);
}
Expand Down
Loading