Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 57fe0bd

Browse filesBrowse files
wouterjwouterj
committed
[Console] Add silent verbosity mode suppressing all output, including errors
1 parent 39e1014 commit 57fe0bd
Copy full SHA for 57fe0bd
Expand file treeCollapse file tree

30 files changed

+394
-63
lines changed

‎UPGRADE-7.2.md

Copy file name to clipboardExpand all lines: UPGRADE-7.2.md
+7Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ Cache
1414
* `igbinary_serialize()` is not used by default when the igbinary extension is installed
1515
* Deprecate making `cache.app` adapter taggable, use the `cache.app.taggable` adapter instead
1616

17+
Console
18+
-------
19+
20+
* [BC BREAK] Add ``--silent`` global option to enable the silent verbosity mode (suppressing all output, including errors)
21+
If a custom command defines the `silent` option, it must be renamed before upgrading.
22+
* Add `isSilent()` method to `OutputInterface`
23+
1724
DependencyInjection
1825
-------------------
1926

‎src/Symfony/Component/Console/Application.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Console/Application.php
+10-3Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -913,6 +913,9 @@ protected function configureIO(InputInterface $input, OutputInterface $output):
913913
}
914914

915915
switch ($shellVerbosity = (int) getenv('SHELL_VERBOSITY')) {
916+
case -2:
917+
$output->setVerbosity(OutputInterface::VERBOSITY_SILENT);
918+
break;
916919
case -1:
917920
$output->setVerbosity(OutputInterface::VERBOSITY_QUIET);
918921
break;
@@ -930,7 +933,10 @@ protected function configureIO(InputInterface $input, OutputInterface $output):
930933
break;
931934
}
932935

933-
if (true === $input->hasParameterOption(['--quiet', '-q'], true)) {
936+
if (true === $input->hasParameterOption(['--silent'], true)) {
937+
$output->setVerbosity(OutputInterface::VERBOSITY_SILENT);
938+
$shellVerbosity = -2;
939+
} elseif (true === $input->hasParameterOption(['--quiet', '-q'], true)) {
934940
$output->setVerbosity(OutputInterface::VERBOSITY_QUIET);
935941
$shellVerbosity = -1;
936942
} else {
@@ -946,7 +952,7 @@ protected function configureIO(InputInterface $input, OutputInterface $output):
946952
}
947953
}
948954

949-
if (-1 === $shellVerbosity) {
955+
if (0 > $shellVerbosity) {
950956
$input->setInteractive(false);
951957
}
952958

@@ -1082,7 +1088,8 @@ protected function getDefaultInputDefinition(): InputDefinition
10821088
return new InputDefinition([
10831089
new InputArgument('command', InputArgument::REQUIRED, 'The command to execute'),
10841090
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'),
1085-
new InputOption('--quiet', '-q', InputOption::VALUE_NONE, 'Do not output any message'),
1091+
new InputOption('--silent', null, InputOption::VALUE_NONE, 'Do not output any message'),
1092+
new InputOption('--quiet', '-q', InputOption::VALUE_NONE, 'Only errors are displayed. All other output is suppressed'),
10861093
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'),
10871094
new InputOption('--version', '-V', InputOption::VALUE_NONE, 'Display this application version'),
10881095
new InputOption('--ansi', '', InputOption::VALUE_NEGATABLE, 'Force (or disable --no-ansi) ANSI output', null),

‎src/Symfony/Component/Console/CHANGELOG.md

Copy file name to clipboardExpand all lines: src/Symfony/Component/Console/CHANGELOG.md
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ CHANGELOG
66

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

1012
7.1
1113
---

‎src/Symfony/Component/Console/Descriptor/ReStructuredTextDescriptor.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Console/Descriptor/ReStructuredTextDescriptor.php
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,7 @@ private function getNonDefaultOptions(InputDefinition $definition): array
217217
{
218218
$globalOptions = [
219219
'help',
220+
'silent',
220221
'quiet',
221222
'verbose',
222223
'version',

‎src/Symfony/Component/Console/Output/NullOutput.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Console/Output/NullOutput.php
+7-2Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,19 @@ public function setVerbosity(int $level): void
5454

5555
public function getVerbosity(): int
5656
{
57-
return self::VERBOSITY_QUIET;
57+
return self::VERBOSITY_SILENT;
5858
}
5959

60-
public function isQuiet(): bool
60+
public function isSilent(): bool
6161
{
6262
return true;
6363
}
6464

65+
public function isQuiet(): bool
66+
{
67+
return false;
68+
}
69+
6570
public function isVerbose(): bool
6671
{
6772
return false;

‎src/Symfony/Component/Console/Output/Output.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Console/Output/Output.php
+8-2Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,14 @@
1717
/**
1818
* Base class for output classes.
1919
*
20-
* There are five levels of verbosity:
20+
* There are six levels of verbosity:
2121
*
2222
* * normal: no option passed (normal output)
2323
* * verbose: -v (more output)
2424
* * very verbose: -vv (highly extended output)
2525
* * debug: -vvv (all debug output)
26-
* * quiet: -q (no output)
26+
* * quiet: -q (only output errors)
27+
* * silent: --silent (no output)
2728
*
2829
* @author Fabien Potencier <fabien@symfony.com>
2930
*/
@@ -74,6 +75,11 @@ public function getVerbosity(): int
7475
return $this->verbosity;
7576
}
7677

78+
public function isSilent(): bool
79+
{
80+
return self::VERBOSITY_SILENT === $this->verbosity;
81+
}
82+
7783
public function isQuiet(): bool
7884
{
7985
return self::VERBOSITY_QUIET === $this->verbosity;

‎src/Symfony/Component/Console/Output/OutputInterface.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Console/Output/OutputInterface.php
+3Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,12 @@
1717
* OutputInterface is the interface implemented by all Output classes.
1818
*
1919
* @author Fabien Potencier <fabien@symfony.com>
20+
*
21+
* @method bool isSilent()
2022
*/
2123
interface OutputInterface
2224
{
25+
public const VERBOSITY_SILENT = 8;
2326
public const VERBOSITY_QUIET = 16;
2427
public const VERBOSITY_NORMAL = 32;
2528
public const VERBOSITY_VERBOSE = 64;

‎src/Symfony/Component/Console/Style/OutputStyle.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Console/Style/OutputStyle.php
+6Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,12 @@ public function getFormatter(): OutputFormatterInterface
7878
return $this->output->getFormatter();
7979
}
8080

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

‎src/Symfony/Component/Console/Tests/ApplicationTest.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Console/Tests/ApplicationTest.php
+4-1Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -851,12 +851,15 @@ public function testRenderException()
851851
putenv('COLUMNS=120');
852852
$tester = new ApplicationTester($application);
853853

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

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

860+
$tester->run(['command' => 'foo'], ['decorated' => false, 'verbosity' => Output::VERBOSITY_SILENT, 'capture_stderr_separately' => true]);
861+
$this->assertSame('', $tester->getErrorOutput(true), '->renderException() renders nothing in SILENT verbosity');
862+
860863
$tester->run(['command' => 'list', '--foo' => true], ['decorated' => false, 'capture_stderr_separately' => true]);
861864
$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');
862865

‎src/Symfony/Component/Console/Tests/Command/CompleteCommandTest.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Console/Tests/Command/CompleteCommandTest.php
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,9 @@ public function testCompleteCommandInputDefinition(array $input, array $suggesti
119119

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

‎src/Symfony/Component/Console/Tests/Command/ListCommandTest.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Console/Tests/Command/ListCommandTest.php
+2-1Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ public function testExecuteListsCommandsOrder()
8080
8181
Options:
8282
-h, --help Display help for the given command. When no command is given display help for the list command
83-
-q, --quiet Do not output any message
83+
--silent Do not output any message
84+
-q, --quiet Only errors are displayed. All other output is suppressed
8485
-V, --version Display this application version
8586
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
8687
-n, --no-interaction Do not ask any interactive question

‎src/Symfony/Component/Console/Tests/Fixtures/application_1.json

Copy file name to clipboardExpand all lines: src/Symfony/Component/Console/Tests/Fixtures/application_1.json
+40-4Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,22 @@
2929
"description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
3030
"default": false
3131
},
32+
"silent": {
33+
"name": "--silent",
34+
"shortcut": "",
35+
"accept_value": false,
36+
"is_value_required": false,
37+
"is_multiple": false,
38+
"description": "Do not output any message",
39+
"default": false
40+
},
3241
"quiet": {
3342
"name": "--quiet",
3443
"shortcut": "-q",
3544
"accept_value": false,
3645
"is_value_required": false,
3746
"is_multiple": false,
38-
"description": "Do not output any message",
47+
"description": "Only errors are displayed. All other output is suppressed",
3948
"default": false
4049
},
4150
"verbose": {
@@ -150,13 +159,22 @@
150159
"description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
151160
"default": false
152161
},
162+
"silent": {
163+
"name": "--silent",
164+
"shortcut": "",
165+
"accept_value": false,
166+
"is_value_required": false,
167+
"is_multiple": false,
168+
"description": "Do not output any message",
169+
"default": false
170+
},
153171
"quiet": {
154172
"name": "--quiet",
155173
"shortcut": "-q",
156174
"accept_value": false,
157175
"is_value_required": false,
158176
"is_multiple": false,
159-
"description": "Do not output any message",
177+
"description": "Only errors are displayed. All other output is suppressed",
160178
"default": false
161179
},
162180
"verbose": {
@@ -262,13 +280,22 @@
262280
"description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
263281
"default": false
264282
},
283+
"silent": {
284+
"name": "--silent",
285+
"shortcut": "",
286+
"accept_value": false,
287+
"is_value_required": false,
288+
"is_multiple": false,
289+
"description": "Do not output any message",
290+
"default": false
291+
},
265292
"quiet": {
266293
"name": "--quiet",
267294
"shortcut": "-q",
268295
"accept_value": false,
269296
"is_value_required": false,
270297
"is_multiple": false,
271-
"description": "Do not output any message",
298+
"description": "Only errors are displayed. All other output is suppressed",
272299
"default": false
273300
},
274301
"verbose": {
@@ -365,13 +392,22 @@
365392
"description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
366393
"default": false
367394
},
395+
"silent": {
396+
"name": "--silent",
397+
"shortcut": "",
398+
"accept_value": false,
399+
"is_value_required": false,
400+
"is_multiple": false,
401+
"description": "Do not output any message",
402+
"default": false
403+
},
368404
"quiet": {
369405
"name": "--quiet",
370406
"shortcut": "-q",
371407
"accept_value": false,
372408
"is_value_required": false,
373409
"is_multiple": false,
374-
"description": "Do not output any message",
410+
"description": "Only errors are displayed. All other output is suppressed",
375411
"default": false
376412
},
377413
"verbose": {

‎src/Symfony/Component/Console/Tests/Fixtures/application_1.md

Copy file name to clipboardExpand all lines: src/Symfony/Component/Console/Tests/Fixtures/application_1.md
+33-3Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Display help for the given command. When no command is given display help for th
4848
* Is negatable: no
4949
* Default: `false`
5050

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

5353
Do not output any message
5454

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

61+
#### `--quiet|-q`
62+
63+
Only errors are displayed. All other output is suppressed
64+
65+
* Accept value: no
66+
* Is value required: no
67+
* Is multiple: no
68+
* Is negatable: no
69+
* Default: `false`
70+
6171
#### `--verbose|-v|-vv|-vvv`
6272

6373
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
159169
* Is negatable: no
160170
* Default: `false`
161171

162-
#### `--quiet|-q`
172+
#### `--silent`
163173

164174
Do not output any message
165175

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

182+
#### `--quiet|-q`
183+
184+
Only errors are displayed. All other output is suppressed
185+
186+
* Accept value: no
187+
* Is value required: no
188+
* Is multiple: no
189+
* Is negatable: no
190+
* Default: `false`
191+
172192
#### `--verbose|-v|-vv|-vvv`
173193

174194
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
286306
* Is negatable: no
287307
* Default: `false`
288308

289-
#### `--quiet|-q`
309+
#### `--silent`
290310

291311
Do not output any message
292312

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

319+
#### `--quiet|-q`
320+
321+
Only errors are displayed. All other output is suppressed
322+
323+
* Accept value: no
324+
* Is value required: no
325+
* Is multiple: no
326+
* Is negatable: no
327+
* Default: `false`
328+
299329
#### `--verbose|-v|-vv|-vvv`
300330

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

‎src/Symfony/Component/Console/Tests/Fixtures/application_1.txt

Copy file name to clipboardExpand all lines: src/Symfony/Component/Console/Tests/Fixtures/application_1.txt
+2-1Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ Console Tool
55

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

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.