Skip to content
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

Jump to bottom

Print necessary output in --quiet mode #1483

Merged
merged 1 commit into from
Oct 2, 2024
Merged

Print necessary output in --quiet mode #1483

Show file tree
Hide file tree
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
90 changes: 78 additions & 12 deletions src/Application.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\StreamableInputInterface;
use Symfony\Component\Console\Output\ConsoleOutputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Terminal;
use Symfony\Component\EventDispatcher\EventDispatcher;
Expand Down Expand Up @@ -66,8 +68,9 @@ protected function getDefaultInputDefinition()
return new InputDefinition([
new InputArgument('command', InputArgument::REQUIRED, 'The command to execute'),
new InputOption('--help', '-h', InputOption::VALUE_NONE, 'Display this help message'),
new InputOption('--verbose', '-v|vv|vvv', InputOption::VALUE_NONE, 'Increase the verbosity of messages'),
new InputOption('--version', '-V', InputOption::VALUE_NONE, 'Display this application version'),
new InputOption('--verbose', '-v|vv|vvv', InputOption::VALUE_NONE, 'Increase the verbosity of messages'),
new InputOption('--quiet', '-q', InputOption::VALUE_NONE, 'Only print necessary output; suppress other messages and errors. This implies --no-interaction. It is ignored in verbose mode.'),
new InputOption('--yes', '-y', InputOption::VALUE_NONE, 'Answer "yes" to confirmation questions; accept the default value for other questions; disable interaction'),
new InputOption(
'--no-interaction',
Expand All @@ -78,9 +81,7 @@ protected function getDefaultInputDefinition()
),
new HiddenInputOption('--ansi', '', InputOption::VALUE_NONE, 'Force ANSI output'),
new HiddenInputOption('--no-ansi', '', InputOption::VALUE_NONE, 'Disable ANSI output'),
// TODO deprecate the following options?
new HiddenInputOption('--no', '-n', InputOption::VALUE_NONE, 'Answer "no" to confirmation questions; accept the default value for other questions; disable interaction'),
new HiddenInputOption('--quiet', '-q', InputOption::VALUE_NONE, 'Do not output any message'),
]);
}

Expand Down Expand Up @@ -320,14 +321,6 @@ public function getHelp()
*/
protected function configureIO(InputInterface $input, OutputInterface $output)
{
// Set the input to non-interactive if the yes or no options are used,
// or if the PLATFORMSH_CLI_NO_INTERACTION variable is not empty.
// The --no-interaction option is handled in the parent method.
if ($input->hasParameterOption(['--yes', '-y', '--no', '-n'])
|| getenv($this->envPrefix . 'NO_INTERACTION')) {
$input->setInteractive(false);
}

// Allow the NO_COLOR, CLICOLOR_FORCE, and TERM environment variables to
// override whether colors are used in the output.
// See: https://no-color.org
Expand All @@ -342,7 +335,80 @@ protected function configureIO(InputInterface $input, OutputInterface $output)
$output->setDecorated(false);
}

parent::configureIO($input, $output);
if ($input->hasParameterOption('--ansi', true)) {
$output->setDecorated(true);
} elseif ($input->hasParameterOption('--no-ansi', true)) {
$output->setDecorated(false);
}

$stdErr = $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output;

if ($input->hasParameterOption(['--yes', '-y', '--no-interaction', '-n', '--no'], true)
|| getenv($this->envPrefix . 'NO_INTERACTION')) {
$input->setInteractive(false);

// Deprecate the -n flag as a shortcut for --no.
// It is confusing as it's a shortcut for --no-interaction in other Symfony Console commands.
if ($input->hasParameterOption('-n', true)) {
$stdErr->writeln('<options=reverse>DEPRECATED</> The -n flag (as a shortcut for --no) is deprecated. It will be removed or changed in a future version.');
}
} elseif (\function_exists('posix_isatty')) {
$inputStream = null;

if ($input instanceof StreamableInputInterface) {
$inputStream = $input->getStream();
}

if (!@posix_isatty($inputStream) && false === getenv('SHELL_INTERACTIVE')) {
$input->setInteractive(false);
}
}

switch ($shellVerbosity = (int) getenv('SHELL_VERBOSITY')) {
case -1: $stdErr->setVerbosity(OutputInterface::VERBOSITY_QUIET); break;
case 1: $output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE); break;
case 2: $output->setVerbosity(OutputInterface::VERBOSITY_VERY_VERBOSE); break;
case 3: $output->setVerbosity(OutputInterface::VERBOSITY_DEBUG); break;
default: $shellVerbosity = 0; break;
}

if ($input->hasParameterOption('-vvv', true)
|| getenv('CLI_DEBUG') || getenv($this->envPrefix . 'DEBUG')) {
$output->setVerbosity(OutputInterface::VERBOSITY_DEBUG);
$shellVerbosity = 3;
} elseif ($input->hasParameterOption('-vv', true)) {
$output->setVerbosity(OutputInterface::VERBOSITY_VERY_VERBOSE);
$shellVerbosity = 2;
} elseif ($input->hasParameterOption(['-v', '--verbose'], true)) {
$output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
$shellVerbosity = 1;
} elseif ($input->hasParameterOption(['--quiet', '-q'], true)) {
$stdErr->setVerbosity(OutputInterface::VERBOSITY_QUIET);
$input->setInteractive(false);
$shellVerbosity = -1;
}

putenv('SHELL_VERBOSITY='.$shellVerbosity);
$_ENV['SHELL_VERBOSITY'] = $shellVerbosity;
$_SERVER['SHELL_VERBOSITY'] = $shellVerbosity;

// Turn off error reporting in quiet mode.
if ($shellVerbosity === -1) {
error_reporting(false);
ini_set('display_errors', '0');
} else {
// Display errors by default. In verbose mode, display all PHP
// error levels except deprecations. Deprecations will only be
// displayed while in debug mode and only if this is enabled via
// the CLI_REPORT_DEPRECATIONS environment variable.
$error_level = ($shellVerbosity >= 1 ? E_ALL : E_PARSE | E_ERROR) & ~E_DEPRECATED;
$report_deprecations = getenv('CLI_REPORT_DEPRECATIONS') || getenv($this->envPrefix . 'REPORT_DEPRECATIONS');
if ($report_deprecations && $shellVerbosity >= 3) {
$error_level |= E_DEPRECATED;
}
error_reporting($error_level);
ini_set('display_errors', 'stderr');
}
}

/**
Expand Down
32 changes: 0 additions & 32 deletions src/Command/CommandBase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,29 +190,6 @@ protected function initialize(InputInterface $input, OutputInterface $output)
$this->environment = null;
$this->remoteContainer = null;

$envPrefix = $this->config()->get('application.env_prefix');
if (getenv('CLI_DEBUG') || getenv($envPrefix . 'DEBUG')) {
$output->setVerbosity(OutputInterface::VERBOSITY_DEBUG);
}

// Tune error reporting.
if ($output->isQuiet()) {
error_reporting(false);
ini_set('display_errors', '0');
} else {
// Display errors by default. In verbose mode, display all PHP
// error levels except deprecations. Deprecations will only be
// displayed while in debug mode and only if this is enabled via
// the CLI_REPORT_DEPRECATIONS environment variable.
$error_level = ($output->isVerbose() ? E_ALL : E_PARSE | E_ERROR) & ~E_DEPRECATED;
$report_deprecations = getenv('CLI_REPORT_DEPRECATIONS') || getenv($envPrefix . 'REPORT_DEPRECATIONS');
if ($report_deprecations && $output->isDebug()) {
$error_level |= E_DEPRECATED;
}
error_reporting($error_level);
ini_set('display_errors', 'stderr');
}

$this->promptLegacyMigrate();

if (!self::$printedApiTokenWarning && $this->onContainer() && (getenv($this->config()->get('application.env_prefix') . 'TOKEN') || $this->api()->hasApiToken(false))) {
Expand All @@ -222,15 +199,6 @@ protected function initialize(InputInterface $input, OutputInterface $output)
$this->stdErr->writeln('');
self::$printedApiTokenWarning = true;
}

// Deprecate the -n flag as a shortcut for --no.
// It is confusing as it's a shortcut for --no-interaction in other Symfony Console commands.
if ($this->input->hasOption('no') && $this->input->getOption('no') && !$this->input->hasParameterOption('--no')) {
$this->labeledMessage(
'DEPRECATED',
'The -n flag (as a shortcut for --no) is deprecated. It will be removed or changed in a future version.'
);
}
}

/**
Expand Down