[RFC] The Symfony Console Style Guide #4265

javiereguiluz · 2014-09-24T16:12:04Z

This is the proposal for the new Symfony Console Style Guide. Please review it as soon as you can, because the schedule is pretty tight. We'd like to update most of the commands for Symfony 2.6 version.

Download Symfony Console Style Guide (PDF, 89 KB)

kbond · 2014-09-24T17:10:53Z

I think there should always be 1 blank line before the result bar as well.

javiereguiluz · 2014-09-24T17:44:15Z

@kbond good catch! I've just updated the PDF.

wouterj · 2014-09-24T17:53:24Z

I like the direction the styleguide wants to guide you: Making outputs more consistent and clear. However, I don't like many concrete guides in the styleguide.

General

The behaviour of the current help command and the behaviour of the console component in general is based on the common standard defined as the docopt standard. I don't like it if we move away from that standard, the Symfony Styleguide should only extend it imo.

Specific points

Title hierarchy is shown using the same styles as Markdown - The markdown syntax with underlines only supports 2 levels, is this intended (to limit complexiness)? Otherwise, I would suggest the reSt Symfony standard.
I found the yellow dots to be confusing at first
Result bars being full width are mentioned twice in page 3
I don't like //. We can say there are 2 types of commands: Queries and Actions. For queries, the output of a command is the result of the query. In case of an action, the output is a message keeping the user up to date with the progress of the action. In both cases, the output is needed for the command to be user friendly.
// indicates something that isn't needed in such cases, it has to be removed from the normal verbosity output and be moved to a more verbose output.
Avoid line overflows when the contents are too long - We should define an exact maximum line length imo
I'm -1 on putting the user input on a new line
For confirmation questions, the common convention is to use [nY] (where yes is the default). I would add that to the styleguide.

Please don't take this as an attack on you. I like the time you're putting into the Symfony community and I like it that you're doing the first step on this. However, I just wanted to share my thoughts on the exact guide. (and as always, it's just my opinion, do with it whatever you like :P).

kbond · 2014-09-24T18:20:38Z

I would like to see some additional examples for Questions:

Choice question
Confirmation question
Question with validation error

kbond · 2014-09-24T18:22:23Z

What about exceptions? How should they be styled?

javiereguiluz · 2014-09-24T18:23:57Z

@kbond thanks for noticing all these missing things. Let's do a recap here:

Progress bars
Other types of questions: choice, confirmation, question with error validation)
Exceptions / Errors

kbond · 2014-09-24T18:26:09Z

Also, what about a "Warning" result bar that would be orange or yellow? Might be useful to show "OK but with some errors"

javiereguiluz · 2014-09-24T18:27:07Z

@kbond any existing command that you are aware of that needs that Warning result bar? I'd like to analyze the use case. Thanks.

kbond · 2014-09-24T18:31:48Z

I can't think of any in Symfony core but I can think a use case in one of the bundles I maintain. zenstruck/cache-bundle has a command that warms up the http cache by hitting a list of urls. If all the urls return 200, I would show green, if some returned !200, I would show orange, if all returned !200 I would show red.

ThomasLomas · 2014-09-24T19:33:12Z

I like this a lot. It will also help the community with keeping bundle commands consistent as well.

I like the question styles and it should also tie in nicely with symfony/symfony#11975 which shows the default answer to the user.

javiereguiluz · 2014-09-24T19:51:33Z

@wouterj first, it's impossible that I consider your comment as a personal attack. Everything in the Symfony community is debatable and I repeatedly asked for feedback (positive or negative). Constructive criticism is what's making us win, so keep 'em coming :)

There are a lot of things in your comment, so let's break into three big parts:

Quick comments

Docopt: I don't understand this issue. The command help output is almost identical to that standard. Is there something else we could do?
Title hierarchy: the syntax is Markdown or RST because we want to limit headings to 2 levels. Otherwise, some developers will overcomplicate things.
Yellow dots: I don't know how to show the white spaces. I used the convention of IDEs. If someone is confused too: the yellow dots of the PDF are just for helping us; they won't appear in the console output.
Long lines: very good catch! We need to set a maximum line length for the text dispalyed in ultra wide console widths. I propose to use 120 chars for that limit.

User Input in new line

The rationale for this is showed in this illustration:

Creating a new line for user input allows us to show a perfect alignment. The eye of the user doesn't jump from one point to another to scan the values he/she typed.

In addition, keep in mind that questions may show the default values and the allowed values. This can produce ultra long question lines that can break user input (that's ugly and confusing):

Information and debug messages

This is the most controversial part of the style guide so far. First, I confess that it's a completely personal opinion. I haven't seen this "feature" used anywhere.

Second, my rationale was like this: I like when things are self-explained. This is a title, this is an error message, this is the result of the command, etc. If this info messages don't include some distinctive design, they look like: "hey, here it is some random text. Who knows what's this?

See the illustration for a visual explanation:

javiereguiluz · 2014-09-24T20:46:50Z

I've just uploaded a new version which includes the Progress Bar styles.

kbond · 2014-09-24T20:57:18Z

A lot of commands add or remove files. Should the style guide contain standards for displaying this?

javiereguiluz · 2014-09-24T21:02:34Z

@kbond in my opinion:

If adding/removing files is just one of multiple operations, display it as info message (// created ...)
If adding/removing files is the main operation, show it as a result ([OK] Created ...)

kbond · 2014-09-24T21:20:45Z

For the progress bar, the UTF-8 characters look weird on linux (for me anyway).

Guess it has to do with the font, when I use the default system font it looks better (not great imo)

javiereguiluz · 2014-09-25T05:53:55Z

@kbond it looks awful! Thanks for reporting this error. Any Linux/Mac expert knows which are the correct UTF-8 characters to use for creating good looking progress bar.

stof · 2014-09-25T08:03:54Z

Be careful about using UTF-8 chars for the progressbar: they won't work on Windows

javiereguiluz · 2014-09-25T08:07:35Z

@stof I don't forget about you :) That's why we define different styles for Windows and Mac/Linux (See page 9 of the guide):

cordoval · 2014-09-25T08:08:54Z

linux and mac look uglier, can we have the windows style on mac? it feels more at home

stof · 2014-09-25T08:09:11Z

yeah, I saw it when reading again the updated style guide. We should make them the defaults in the ProgressBar class though, to make it easy

javiereguiluz · 2014-09-25T08:10:48Z

@cordoval it's true that the current style guide should be improved. But I also think that the Windows style is ugly. Anyway, in the Linux world we've had beautiful progress bars since forever. That's why I'm asking for help to any Linux expert who knows what are the UTF8 chars to use.

cordoval · 2014-09-25T08:11:34Z

if it is like brew it would be nice, i think as similar as possible to the standard and beautiful would be a 👍 oh wait nah, it is ugly with ############### signs, so you are good!

javiereguiluz · 2014-09-25T11:13:09Z

@kbond @wouterj the style guide has been updated with:

A new [WARNING] result type.
New styles for all kinds of questions (confirmation, multiple choice, etc.)
The only pending thing is the style of the progress bar.

Sorry for the massive pinging, but I'd love to read the opinions (positive or negative) of the rest of Symfony Core (@webmozart, @Tobion, @romainneutron, @nicolas-grekas, @jakzal) and other heavy users of the console (@pgodel, @hhamon, @pborreli, @jderusse, @lyrixx, @xabbuh, @weaverryan, @ricardclau, @mmoreram, @raulfraile, @aferrandini):

Download Symfony Console Style Guide v 0.89 (PDF, 126 KB)

stof · 2014-09-25T11:29:52Z

I'm not a fan of the 1 space indentation. It makes it harder to write commands, because you have to add an extra space in each place where you wrap your messages. What is the reason to ask for it ?

stof · 2014-09-25T11:35:52Z

For the multi-choice question, be careful that your proposal does not work everywhere. It requires running it a stty to be able to implement it. For Windows or other non-stty environments, the current way where you enter a number to choose the option will need to be kept. See symfony/symfony#11326 for the related PR

hhamon · 2014-09-25T11:42:38Z

Hi Javier,

I really like the work you've done with this document.

I agree with most of the propositions. They look consistent to me for the usage experience but I can't tell for the development experience as long as I need to give a try to some of them.

Regarding the note section, I would suggest to have a light background color like for the caution one.

kbond · 2014-09-25T11:57:18Z

For the admonitions, should the text on lines 2+ be indented to match the first line? I saw you did this for multi-line question validation errors.

javiereguiluz · 2014-09-25T13:03:51Z

@stof about the 1 space indent, the rationale is: this is a pure aesthetic decision. I propose to add this space because things look better (in my opinion) and it allows us to get a perfect alignment of all elements.

Regarding the comment about how hard would be to write commands, thanks to these new helpers the effort should be exactly the same, because the developer would never deal with these aesthetic details.

kbond · 2014-10-03T13:43:19Z

For the caution admonitions, exceptions and result bars, can we pad the blocks vertically. I find them too thin.

javiereguiluz · 2014-10-03T13:53:00Z

@kbon could you please share a quick screenshot to better visualize the problem? Thanks!

kbond · 2014-10-03T13:57:12Z

Screenshots:

javiereguiluz · 2014-10-03T14:01:07Z

You are right, they are too thin :( The problem is that adding a 1 line padding above and bellow could be too much. What do you think?

fabpot · 2014-10-03T14:02:44Z

Adding a line above and below seems crucial to me.

kbond · 2014-10-03T14:06:11Z

I don't think it is required for the note admonition as there is no background color.

javiereguiluz · 2014-10-03T14:07:38Z

@kbond agree! Only when the content has a background color.

kbond · 2014-10-03T14:08:28Z

FYI - the new progressbar style looks bad on my console:

javiereguiluz · 2014-10-03T14:11:00Z

@kbond yes. Anyway, I guess that we can do style tweaks during the stabilization phase. We'll have to check colors and revisit other controversial elements of the style guide.

javiereguiluz · 2014-10-03T14:17:55Z

@kbond for the progress bar, can we make it of the same color as the text? (it should be displayed white in your black console, but it should be black/dark gray for users with light consoles)

…to the current draft of the Symfony Console Style Guide (symfony/symfony-docs#4265)

matthieuauger · 2014-11-29T15:12:16Z

Hi,

Nice work, consistency between console outputs will be great for DX.
What is missing here ? Has the Style Guide already been validated ?

xabbuh · 2015-02-06T10:44:58Z

@javiereguiluz Is there any news about this?

javiereguiluz · 2015-02-06T11:06:20Z

@xabbuh no news at all :( @kbond did a great work transforming this PDF guide into actual code and he created new console methods for commands, but there seems to be no interest in updating all the framework's commands (which is a lot of work by the way).

xabbuh · 2015-02-06T11:11:25Z

@javiereguiluz Can you give a quick overview of what you think would be the next steps? As far as I understand, the guide is finished and people could start reworking all commands. Is that right?

…(kbond) This PR was squashed before being merged into the 2.7 branch (closes #14057). Discussion ---------- [RFC][Console] Added console style guide helpers (v2) *(Rebased to 2.7)* | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #12014, #12035, symfony/symfony-docs#4265 | License | MIT | Doc PR | todo ## Proposed API ### Code ```php // Symfony command protected function execute(InputInterface $input, OutputInterface $output) { $output = new SymfonyStyle($output); $output->title('Lorem Ipsum Dolor Sit Amet'); $output->text(array( 'Duis aute irure dolor in reprehenderit in voluptate velit esse', 'cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat' )); $output->ln(); $output->table(array('Name', 'Method', 'Scheme', 'Host', 'Path'), array( array('admin_post_new', 'ANY', 'ANY', 'ANY', '/admin/post/new'), array('admin_post_show', 'GET', 'ANY', 'ANY', '/admin/post/{id}'), array('admin_post_edit', 'ANY', 'ANY', 'ANY', '/admin/post/{id}/edit'), array('admin_post_delete', 'DELETE', 'ANY', 'ANY', '/admin/post/{id}'), )); $output->caution(array( 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.', 'foo' )); $output->section('Consectetur Adipisicing Elit Sed Do Eiusmod'); $output->listing(array( 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod, tempor incididunt ut labore et dolore magna aliqua.', 'Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo.', 'Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.' )); $customValidator = function ($value) { if ($value == 'foo') { throw new \Exception('cannot be foo'); } return $value; }; // hidden question $output->note($output->askHidden('Hidden question')); // choice questions $output->note($output->choice('Choice question no default', array('choice1', 'choice2'))); $output->note($output->choice('Choice question with default', array('choice1', 'choice2'), 'choice1')); // confirmation questions $output->note($output->confirm('Confirmation with yes default', true) ? 'yes' : 'no'); $output->note($output->confirm('Confirmation with no default', false) ? 'yes' : 'no'); // standard questions $output->note($output->ask('Question no default')); $output->note($output->ask('Question no default and custom validator', null, $customValidator)); $output->note($output->ask('Question with default', 'default')); $output->note($output->ask('Question with default and custom validator', 'default', $customValidator)); $output->note('Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat.'); $output->success('Lorem ipsum dolor sit amet, consectetur adipisicing elit'); $output->error('Duis aute irure dolor in reprehenderit in voluptate velit esse.'); $output->warning('Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi.'); $output->progressStart(100); for ($i = 0; $i < 100; $i++) { usleep(10000); $output->progressAdvance(); } $output->progressFinish(); } ``` ### Output ``` $ php app/console command Lorem Ipsum Dolor Sit Amet ========================== // Duis aute irure dolor in reprehenderit in voluptate velit esse // cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat ------------------- -------- -------- ------ ----------------------- Name Method Scheme Host Path ------------------- -------- -------- ------ ----------------------- admin_post_new ANY ANY ANY /admin/post/new admin_post_show GET ANY ANY /admin/post/{id} admin_post_edit ANY ANY ANY /admin/post/{id}/edit admin_post_delete DELETE ANY ANY /admin/post/{id} ------------------- -------- -------- ------ ----------------------- ! [CAUTION] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et ! dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris. Lorem ipsum dolor sit amet, ! consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim ! veniam, quis nostrud exercitation ullamco laboris. ! ! foo Consectetur Adipisicing Elit Sed Do Eiusmod ------------------------------------------- * Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod, tempor incididunt ut labore et dolore magna aliqua. * Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo. * Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Hidden question: > <f><o><o><enter> ! [NOTE] foo Choice question no default: [0] choice1 [1] choice2 > <enter> [ERROR] Value "" is invalid Choice question no default: [0] choice1 [1] choice2 > 0<enter> ! [NOTE] choice1 Choice question with default [choice1]: [0] choice1 [1] choice2 > 1<enter> ! [NOTE] choice2 Confirmation with yes default (yes/no) [yes]: > <enter> ! [NOTE] yes Confirmation with no default (yes/no) [no]: > <enter> ! [NOTE] no Question no default: > <enter> [ERROR] A value is required. Question no default: > foo<enter> ! [NOTE] foo Question no default and custom validator: > foo<enter> [ERROR] cannot be foo Question no default and custom validator: > <enter> [ERROR] A value is required. Question no default and custom validator: > foo<enter> [ERROR] cannot be foo Question no default and custom validator: > bar<enter> ! [NOTE] bar Question with default [default]: > <enter> ! [NOTE] default Question with default and custom validator [default]: > <enter> ! [NOTE] default ! [NOTE] Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. ! Excepteur sint occaecat cupidatat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu ! fugiat nulla pariatur. Excepteur sint occaecat cupidatat. Duis aute irure dolor in reprehenderit in voluptate velit ! esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat. [OK] Lorem ipsum dolor sit amet, consectetur adipisicing elit [ERROR] Duis aute irure dolor in reprehenderit in voluptate velit esse. [WARNING] Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi. 100/100 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100% ``` ### Screenshots ![screen1](https://cloud.githubusercontent.com/assets/127811/4507077/53bc009c-4b09-11e4-937c-44fe7fe30dc0.png) ![screen2](https://cloud.githubusercontent.com/assets/127811/4507078/53bf982e-4b09-11e4-8b5a-8c44c20ae4d9.png) ![screen](https://cloud.githubusercontent.com/assets/127811/6848451/b2e64848-d3a3-11e4-9916-43bd377684ca.png) Commits ------- 96b4210 [RFC][Console] Added console style guide helpers (v2)

…(kbond) This PR was squashed before being merged into the 2.7 branch (closes #14057). Discussion ---------- [RFC][Console] Added console style guide helpers (v2) *(Rebased to 2.7)* | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #12014, #12035, symfony/symfony-docs#4265 | License | MIT | Doc PR | todo ## Proposed API ### Code ```php // Symfony command protected function execute(InputInterface $input, OutputInterface $output) { $output = new SymfonyStyle($output); $output->title('Lorem Ipsum Dolor Sit Amet'); $output->text(array( 'Duis aute irure dolor in reprehenderit in voluptate velit esse', 'cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat' )); $output->ln(); $output->table(array('Name', 'Method', 'Scheme', 'Host', 'Path'), array( array('admin_post_new', 'ANY', 'ANY', 'ANY', '/admin/post/new'), array('admin_post_show', 'GET', 'ANY', 'ANY', '/admin/post/{id}'), array('admin_post_edit', 'ANY', 'ANY', 'ANY', '/admin/post/{id}/edit'), array('admin_post_delete', 'DELETE', 'ANY', 'ANY', '/admin/post/{id}'), )); $output->caution(array( 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.', 'foo' )); $output->section('Consectetur Adipisicing Elit Sed Do Eiusmod'); $output->listing(array( 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod, tempor incididunt ut labore et dolore magna aliqua.', 'Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo.', 'Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.' )); $customValidator = function ($value) { if ($value == 'foo') { throw new \Exception('cannot be foo'); } return $value; }; // hidden question $output->note($output->askHidden('Hidden question')); // choice questions $output->note($output->choice('Choice question no default', array('choice1', 'choice2'))); $output->note($output->choice('Choice question with default', array('choice1', 'choice2'), 'choice1')); // confirmation questions $output->note($output->confirm('Confirmation with yes default', true) ? 'yes' : 'no'); $output->note($output->confirm('Confirmation with no default', false) ? 'yes' : 'no'); // standard questions $output->note($output->ask('Question no default')); $output->note($output->ask('Question no default and custom validator', null, $customValidator)); $output->note($output->ask('Question with default', 'default')); $output->note($output->ask('Question with default and custom validator', 'default', $customValidator)); $output->note('Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat.'); $output->success('Lorem ipsum dolor sit amet, consectetur adipisicing elit'); $output->error('Duis aute irure dolor in reprehenderit in voluptate velit esse.'); $output->warning('Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi.'); $output->progressStart(100); for ($i = 0; $i < 100; $i++) { usleep(10000); $output->progressAdvance(); } $output->progressFinish(); } ``` ### Output ``` $ php app/console command Lorem Ipsum Dolor Sit Amet ========================== // Duis aute irure dolor in reprehenderit in voluptate velit esse // cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat ------------------- -------- -------- ------ ----------------------- Name Method Scheme Host Path ------------------- -------- -------- ------ ----------------------- admin_post_new ANY ANY ANY /admin/post/new admin_post_show GET ANY ANY /admin/post/{id} admin_post_edit ANY ANY ANY /admin/post/{id}/edit admin_post_delete DELETE ANY ANY /admin/post/{id} ------------------- -------- -------- ------ ----------------------- ! [CAUTION] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et ! dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris. Lorem ipsum dolor sit amet, ! consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim ! veniam, quis nostrud exercitation ullamco laboris. ! ! foo Consectetur Adipisicing Elit Sed Do Eiusmod ------------------------------------------- * Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod, tempor incididunt ut labore et dolore magna aliqua. * Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo. * Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Hidden question: > <f><o><o><enter> ! [NOTE] foo Choice question no default: [0] choice1 [1] choice2 > <enter> [ERROR] Value "" is invalid Choice question no default: [0] choice1 [1] choice2 > 0<enter> ! [NOTE] choice1 Choice question with default [choice1]: [0] choice1 [1] choice2 > 1<enter> ! [NOTE] choice2 Confirmation with yes default (yes/no) [yes]: > <enter> ! [NOTE] yes Confirmation with no default (yes/no) [no]: > <enter> ! [NOTE] no Question no default: > <enter> [ERROR] A value is required. Question no default: > foo<enter> ! [NOTE] foo Question no default and custom validator: > foo<enter> [ERROR] cannot be foo Question no default and custom validator: > <enter> [ERROR] A value is required. Question no default and custom validator: > foo<enter> [ERROR] cannot be foo Question no default and custom validator: > bar<enter> ! [NOTE] bar Question with default [default]: > <enter> ! [NOTE] default Question with default and custom validator [default]: > <enter> ! [NOTE] default ! [NOTE] Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. ! Excepteur sint occaecat cupidatat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu ! fugiat nulla pariatur. Excepteur sint occaecat cupidatat. Duis aute irure dolor in reprehenderit in voluptate velit ! esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat. [OK] Lorem ipsum dolor sit amet, consectetur adipisicing elit [ERROR] Duis aute irure dolor in reprehenderit in voluptate velit esse. [WARNING] Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi. 100/100 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100% ``` ### Screenshots ![screen1](https://cloud.githubusercontent.com/assets/127811/4507077/53bc009c-4b09-11e4-937c-44fe7fe30dc0.png) ![screen2](https://cloud.githubusercontent.com/assets/127811/4507078/53bf982e-4b09-11e4-8b5a-8c44c20ae4d9.png) ![screen](https://cloud.githubusercontent.com/assets/127811/6848451/b2e64848-d3a3-11e4-9916-43bd377684ca.png) Commits ------- 96b4210 [RFC][Console] Added console style guide helpers (v2)

wouterj · 2015-05-02T09:28:04Z

With the new styles now merged into the code and the core commands in progress of being updated, I think it's time to move this issue forward.

I think the best first step is to transform the latest PDF in this issue into reStructured Text formatting in the documentation. This way, we can easily discuss the guide and improve it.

xabbuh · 2015-05-02T17:35:24Z

@javiereguiluz Can you please add a link to the current (final) version of the style guide to your initial description? It would make it easier for people wanting to contribute to find the most recent version.

javiereguiluz · 2016-02-26T12:30:15Z

We can close this as "fixed". The feature is implemented since Symfony 2.7 and the docs are published at https://symfony.com/doc/current/cookbook/console/style.html

This was referenced Sep 24, 2014

[DX] Improve the output of all Symfony commands symfony/symfony#11784

Closed

Add helpers for the new console style guide symfony/symfony#12014

Closed

Tobion mentioned this issue Oct 12, 2014

[FrameworkBundle] [DX] Displays friendly message if the event does not have any registered listeners symfony/symfony#12216

Closed

kongr45gpen added a commit to allejo/bzion that referenced this issue Oct 18, 2014

Add validators to the configuration handler and make sure it adheres …

6e01074

…to the current draft of the Symfony Console Style Guide (symfony/symfony-docs#4265)

cryptiklemur mentioned this issue Oct 23, 2014

Add Console output support for console commands yiisoft/yii2#4791

Closed

5 tasks

kbond mentioned this issue Mar 25, 2015

[RFC][Console] Added console style guide helpers (v2) symfony/symfony#14057

Closed

SpacePossum mentioned this issue Apr 1, 2015

Process output refactor PHP-CS-Fixer/PHP-CS-Fixer#1118

Merged

wouterj added good first issue Ideal for your first contribution! (some Symfony experience may be required) actionable Clear and specific issues ready for anyone to take them. Console labels May 2, 2015

fabpot closed this as completed Feb 26, 2016

ogizanagi mentioned this issue Jul 4, 2017

[Console] Improve warning signal color for SymfonyStyle symfony/symfony#23393

Closed

javiereguiluz mentioned this issue Sep 7, 2017

Updated console error font color symfony/symfony#24125

Closed

[RFC] The Symfony Console Style Guide #4265

[RFC] The Symfony Console Style Guide #4265

Comments

javiereguiluz commented Sep 24, 2014

kbond commented Sep 24, 2014

javiereguiluz commented Sep 24, 2014

wouterj commented Sep 24, 2014

General

Specific points

kbond commented Sep 24, 2014

kbond commented Sep 24, 2014

javiereguiluz commented Sep 24, 2014

kbond commented Sep 24, 2014

javiereguiluz commented Sep 24, 2014

kbond commented Sep 24, 2014

ThomasLomas commented Sep 24, 2014

javiereguiluz commented Sep 24, 2014

Quick comments

User Input in new line

Information and debug messages

javiereguiluz commented Sep 24, 2014

kbond commented Sep 24, 2014

javiereguiluz commented Sep 24, 2014

kbond commented Sep 24, 2014

javiereguiluz commented Sep 25, 2014

stof commented Sep 25, 2014

javiereguiluz commented Sep 25, 2014

cordoval commented Sep 25, 2014

stof commented Sep 25, 2014

javiereguiluz commented Sep 25, 2014

cordoval commented Sep 25, 2014

javiereguiluz commented Sep 25, 2014

stof commented Sep 25, 2014

stof commented Sep 25, 2014

hhamon commented Sep 25, 2014

kbond commented Sep 25, 2014

javiereguiluz commented Sep 25, 2014

kbond commented Oct 3, 2014

javiereguiluz commented Oct 3, 2014

kbond commented Oct 3, 2014

javiereguiluz commented Oct 3, 2014

fabpot commented Oct 3, 2014

kbond commented Oct 3, 2014

javiereguiluz commented Oct 3, 2014

kbond commented Oct 3, 2014

javiereguiluz commented Oct 3, 2014

javiereguiluz commented Oct 3, 2014

matthieuauger commented Nov 29, 2014

xabbuh commented Feb 6, 2015

javiereguiluz commented Feb 6, 2015

xabbuh commented Feb 6, 2015

wouterj commented May 2, 2015

xabbuh commented May 2, 2015

javiereguiluz commented Feb 26, 2016