Skip to content

[Console] Mention Terminal color mode support #18917

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
merged 1 commit into from
Sep 22, 2023
Merged

[Console] Mention Terminal color mode support #18917

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
15 changes: 13 additions & 2 deletions console.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,8 +575,8 @@ call ``setAutoExit(false)`` on it to get the command result in ``CommandTester``
and extend the normal ``\PHPUnit\Framework\TestCase``.

When testing your commands, it could be useful to understand how your command
reacts on different settings like the width and the height of the terminal.
You have access to such information thanks to the
reacts on different settings like the width and the height of the terminal, or
even the color mode being used. You have access to such information thanks to the
:class:`Symfony\\Component\\Console\\Terminal` class:

use Symfony\Component\Console\Terminal;
Expand All @@ -589,6 +589,17 @@ You have access to such information thanks to the
// gets the number of columns available
$width = $terminal->getWidth();

// gets the color mode
$colorMode = $terminal->getColorMode();

// changes the color mode
$colorMode = $terminal->setColorMode(AnsiColorMode::Ansi24);

.. versionadded:: 6.2

The support for setting and getting the current color mode was introduced
in Symfony 6.2.

Logging Command Errors
----------------------

Expand Down