[Console] Add silent verbosity mode suppressing all output, including…

… errors
symfony · norbertosus · Apr 12, 2024 · Jun 3, 2024 · Jun 20, 2024 · Jun 16, 2024
commit e57e6e0355bf231a6befd5d8ff2940308f0005eb
diff --git a/Application.php b/Application.php
@@ -913,6 +913,9 @@ protected function configureIO(InputInterface $input, OutputInterface $output):
        }

        switch ($shellVerbosity = (int) getenv('SHELL_VERBOSITY')) {
+            case -2:
+                $output->setVerbosity(OutputInterface::VERBOSITY_SILENT);
+                break;
            case -1:
                $output->setVerbosity(OutputInterface::VERBOSITY_QUIET);
                break;
@@ -930,7 +933,10 @@ protected function configureIO(InputInterface $input, OutputInterface $output):
                break;
        }

-        if (true === $input->hasParameterOption(['--quiet', '-q'], true)) {
+        if (true === $input->hasParameterOption(['--silent'], true)) {
+            $output->setVerbosity(OutputInterface::VERBOSITY_SILENT);
+            $shellVerbosity = -2;
+        } elseif (true === $input->hasParameterOption(['--quiet', '-q'], true)) {
            $output->setVerbosity(OutputInterface::VERBOSITY_QUIET);
            $shellVerbosity = -1;
        } else {
@@ -946,7 +952,7 @@ protected function configureIO(InputInterface $input, OutputInterface $output):
            }
        }

-        if (-1 === $shellVerbosity) {
+        if (0 > $shellVerbosity) {
            $input->setInteractive(false);
        }

@@ -1082,7 +1088,8 @@ protected function getDefaultInputDefinition(): InputDefinition
        return new InputDefinition([
            new InputArgument('command', InputArgument::REQUIRED, 'The command to execute'),
            new InputOption('--help', '-h', InputOption::VALUE_NONE, 'Display help for the given command. When no command is given display help for the <info>'.$this->defaultCommand.'</info> command'),
-            new InputOption('--quiet', '-q', InputOption::VALUE_NONE, 'Do not output any message'),
+            new InputOption('--silent', null, InputOption::VALUE_NONE, 'Do not output any message'),
+            new InputOption('--quiet', '-q', InputOption::VALUE_NONE, 'Only errors are displayed. All other output is suppressed'),
            new InputOption('--verbose', '-v|vv|vvv', InputOption::VALUE_NONE, 'Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug'),
            new InputOption('--version', '-V', InputOption::VALUE_NONE, 'Display this application version'),
            new InputOption('--ansi', '', InputOption::VALUE_NEGATABLE, 'Force (or disable --no-ansi) ANSI output', null),

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,8 @@ CHANGELOG

 * Add support for `FORCE_COLOR` environment variable
 * Add `verbosity` argument to `mustRun` process helper method
+ * [BC BREAK] Add silent verbosity (`--silent`/`SHELL_VERBOSITY=-2`) to suppress all output, including errors
+ * Add `OutputInterface::isSilent()`, `Output::isSilent()`, `OutputStyle::isSilent()` methods

 7.1
 ---

diff --git a/Descriptor/ReStructuredTextDescriptor.php b/Descriptor/ReStructuredTextDescriptor.php
@@ -217,6 +217,7 @@ private function getNonDefaultOptions(InputDefinition $definition): array
    {
        $globalOptions = [
            'help',
+            'silent',
            'quiet',
            'verbose',
            'version',

diff --git a/Output/NullOutput.php b/Output/NullOutput.php
@@ -54,14 +54,19 @@ public function setVerbosity(int $level): void

    public function getVerbosity(): int
    {
-        return self::VERBOSITY_QUIET;
+        return self::VERBOSITY_SILENT;
    }

-    public function isQuiet(): bool
+    public function isSilent(): bool
    {
        return true;
    }

+    public function isQuiet(): bool
+    {
+        return false;
+    }
+
    public function isVerbose(): bool
    {
        return false;

diff --git a/Output/Output.php b/Output/Output.php
@@ -17,13 +17,14 @@
 /**
 * Base class for output classes.
 *
- * There are five levels of verbosity:
+ * There are six levels of verbosity:
 *
 *  * normal: no option passed (normal output)
 *  * verbose: -v (more output)
 *  * very verbose: -vv (highly extended output)
 *  * debug: -vvv (all debug output)
- *  * quiet: -q (no output)
+ *  * quiet: -q (only output errors)
+ *  * silent: --silent (no output)
 *
 * @author Fabien Potencier <fabien@symfony.com>
 */
@@ -74,6 +75,11 @@ public function getVerbosity(): int
        return $this->verbosity;
    }

+    public function isSilent(): bool
+    {
+        return self::VERBOSITY_SILENT === $this->verbosity;
+    }
+
    public function isQuiet(): bool
    {
        return self::VERBOSITY_QUIET === $this->verbosity;

diff --git a/Output/OutputInterface.php b/Output/OutputInterface.php
@@ -17,9 +17,12 @@
 * OutputInterface is the interface implemented by all Output classes.
 *
 * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @method bool isSilent()
 */
 interface OutputInterface
 {
+    public const VERBOSITY_SILENT = 8;
    public const VERBOSITY_QUIET = 16;
    public const VERBOSITY_NORMAL = 32;
    public const VERBOSITY_VERBOSE = 64;

diff --git a/Style/OutputStyle.php b/Style/OutputStyle.php
@@ -78,6 +78,12 @@ public function getFormatter(): OutputFormatterInterface
        return $this->output->getFormatter();
    }

+    public function isSilent(): bool
+    {
+        // @deprecated since Symfony 7.2, change to $this->output->isSilent() in 8.0
+        return method_exists($this->output, 'isSilent') ? $this->output->isSilent() : self::VERBOSITY_SILENT === $this->output->getVerbosity();
+    }
+
    public function isQuiet(): bool
    {
        return $this->output->isQuiet();

diff --git a/Tests/ApplicationTest.php b/Tests/ApplicationTest.php
@@ -851,12 +851,15 @@ public function testRenderException()
        putenv('COLUMNS=120');
        $tester = new ApplicationTester($application);

-        $tester->run(['command' => 'foo'], ['decorated' => false, 'capture_stderr_separately' => true]);
+        $tester->run(['command' => 'foo'], ['decorated' => false, 'verbosity' => Output::VERBOSITY_QUIET, 'capture_stderr_separately' => true]);
        $this->assertStringEqualsFile(self::$fixturesPath.'/application_renderexception1.txt', $tester->getErrorOutput(true), '->renderException() renders a pretty exception');

        $tester->run(['command' => 'foo'], ['decorated' => false, 'verbosity' => Output::VERBOSITY_VERBOSE, 'capture_stderr_separately' => true]);
        $this->assertStringContainsString('Exception trace', $tester->getErrorOutput(), '->renderException() renders a pretty exception with a stack trace when verbosity is verbose');

+        $tester->run(['command' => 'foo'], ['decorated' => false, 'verbosity' => Output::VERBOSITY_SILENT, 'capture_stderr_separately' => true]);
+        $this->assertSame('', $tester->getErrorOutput(true), '->renderException() renders nothing in SILENT verbosity');
+
        $tester->run(['command' => 'list', '--foo' => true], ['decorated' => false, 'capture_stderr_separately' => true]);
        $this->assertStringEqualsFile(self::$fixturesPath.'/application_renderexception2.txt', $tester->getErrorOutput(true), '->renderException() renders the command synopsis when an exception occurs in the context of a command');


diff --git a/Tests/Command/CompleteCommandTest.php b/Tests/Command/CompleteCommandTest.php
@@ -119,9 +119,9 @@ public function testCompleteCommandInputDefinition(array $input, array $suggesti

    public static function provideCompleteCommandInputDefinitionInputs()
    {
-        yield 'definition' => [['bin/console', 'hello', '-'], ['--help', '--quiet', '--verbose', '--version', '--ansi', '--no-ansi', '--no-interaction']];
+        yield 'definition' => [['bin/console', 'hello', '-'], ['--help', '--silent', '--quiet', '--verbose', '--version', '--ansi', '--no-ansi', '--no-interaction']];
        yield 'custom' => [['bin/console', 'hello'], ['Fabien', 'Robin', 'Wouter']];
-        yield 'definition-aliased' => [['bin/console', 'ahoy', '-'], ['--help', '--quiet', '--verbose', '--version', '--ansi', '--no-ansi', '--no-interaction']];
+        yield 'definition-aliased' => [['bin/console', 'ahoy', '-'], ['--help', '--silent', '--quiet', '--verbose', '--version', '--ansi', '--no-ansi', '--no-interaction']];
        yield 'custom-aliased' => [['bin/console', 'ahoy'], ['Fabien', 'Robin', 'Wouter']];
    }


diff --git a/Tests/Command/ListCommandTest.php b/Tests/Command/ListCommandTest.php
@@ -80,7 +80,8 @@ public function testExecuteListsCommandsOrder()

 Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
-  -q, --quiet           Do not output any message
+      --silent          Do not output any message
+  -q, --quiet           Only errors are displayed. All other output is suppressed
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question

diff --git a/Tests/Fixtures/application_1.json b/Tests/Fixtures/application_1.json
@@ -29,13 +29,22 @@
                        "description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
                        "default": false
                    },
+                    "silent": {
+                        "name": "--silent",
+                        "shortcut": "",
+                        "accept_value": false,
+                        "is_value_required": false,
+                        "is_multiple": false,
+                        "description": "Do not output any message",
+                        "default": false
+                    },
                    "quiet": {
                        "name": "--quiet",
                        "shortcut": "-q",
                        "accept_value": false,
                        "is_value_required": false,
                        "is_multiple": false,
-                        "description": "Do not output any message",
+                        "description": "Only errors are displayed. All other output is suppressed",
                        "default": false
                    },
                    "verbose": {
@@ -150,13 +159,22 @@
                        "description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
                        "default": false
                    },
+                    "silent": {
+                        "name": "--silent",
+                        "shortcut": "",
+                        "accept_value": false,
+                        "is_value_required": false,
+                        "is_multiple": false,
+                        "description": "Do not output any message",
+                        "default": false
+                    },
                    "quiet": {
                        "name": "--quiet",
                        "shortcut": "-q",
                        "accept_value": false,
                        "is_value_required": false,
                        "is_multiple": false,
-                        "description": "Do not output any message",
+                        "description": "Only errors are displayed. All other output is suppressed",
                        "default": false
                    },
                    "verbose": {
@@ -262,13 +280,22 @@
                        "description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
                        "default": false
                    },
+                    "silent": {
+                        "name": "--silent",
+                        "shortcut": "",
+                        "accept_value": false,
+                        "is_value_required": false,
+                        "is_multiple": false,
+                        "description": "Do not output any message",
+                        "default": false
+                    },
                    "quiet": {
                        "name": "--quiet",
                        "shortcut": "-q",
                        "accept_value": false,
                        "is_value_required": false,
                        "is_multiple": false,
-                        "description": "Do not output any message",
+                        "description": "Only errors are displayed. All other output is suppressed",
                        "default": false
                    },
                    "verbose": {
@@ -365,13 +392,22 @@
                        "description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
                        "default": false
                    },
+                    "silent": {
+                        "name": "--silent",
+                        "shortcut": "",
+                        "accept_value": false,
+                        "is_value_required": false,
+                        "is_multiple": false,
+                        "description": "Do not output any message",
+                        "default": false
+                    },
                    "quiet": {
                        "name": "--quiet",
                        "shortcut": "-q",
                        "accept_value": false,
                        "is_value_required": false,
                        "is_multiple": false,
-                        "description": "Do not output any message",
+                        "description": "Only errors are displayed. All other output is suppressed",
                        "default": false
                    },
                    "verbose": {

diff --git a/Tests/Fixtures/application_1.md b/Tests/Fixtures/application_1.md
@@ -48,7 +48,7 @@ Display help for the given command. When no command is given display help for th
 * Is negatable: no
 * Default: `false`

-#### `--quiet|-q`
+#### `--silent`

 Do not output any message

@@ -58,6 +58,16 @@ Do not output any message
 * Is negatable: no
 * Default: `false`

+#### `--quiet|-q`
+
+Only errors are displayed. All other output is suppressed
+
+* Accept value: no
+* Is value required: no
+* Is multiple: no
+* Is negatable: no
+* Default: `false`
+
 #### `--verbose|-v|-vv|-vvv`

 Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
@@ -159,7 +169,7 @@ Display help for the given command. When no command is given display help for th
 * Is negatable: no
 * Default: `false`

-#### `--quiet|-q`
+#### `--silent`

 Do not output any message

@@ -169,6 +179,16 @@ Do not output any message
 * Is negatable: no
 * Default: `false`

+#### `--quiet|-q`
+
+Only errors are displayed. All other output is suppressed
+
+* Accept value: no
+* Is value required: no
+* Is multiple: no
+* Is negatable: no
+* Default: `false`
+
 #### `--verbose|-v|-vv|-vvv`

 Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
@@ -286,7 +306,7 @@ Display help for the given command. When no command is given display help for th
 * Is negatable: no
 * Default: `false`

-#### `--quiet|-q`
+#### `--silent`

 Do not output any message

@@ -296,6 +316,16 @@ Do not output any message
 * Is negatable: no
 * Default: `false`

+#### `--quiet|-q`
+
+Only errors are displayed. All other output is suppressed
+
+* Accept value: no
+* Is value required: no
+* Is multiple: no
+* Is negatable: no
+* Default: `false`
+
 #### `--verbose|-v|-vv|-vvv`

 Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

diff --git a/Tests/Fixtures/application_1.txt b/Tests/Fixtures/application_1.txt
@@ -5,7 +5,8 @@ Console Tool

 <comment>Options:</comment>
  <info>-h, --help</info>            Display help for the given command. When no command is given display help for the <info>list</info> command
-  <info>-q, --quiet</info>           Do not output any message
+  <info>    --silent</info>          Do not output any message
+  <info>-q, --quiet</info>           Only errors are displayed. All other output is suppressed
  <info>-V, --version</info>         Display this application version
  <info>    --ansi|--no-ansi</info>  Force (or disable --no-ansi) ANSI output
  <info>-n, --no-interaction</info>  Do not ask any interactive question