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

kbond · 2015-03-25T16:30:58Z

(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

// 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

hhamon · 2015-03-25T17:57:18Z

Nice work :)

cryptiklemur · 2015-03-25T18:02:59Z

Hopefully not too much work to get it in to 2.7 :)

javiereguiluz · 2015-03-25T20:29:02Z

src/Symfony/Component/Console/Style/SymfonyStyle.php

+            $line .= str_repeat(' ', self::MAX_LINE_LENGTH - Helper::strlen($line));
+
+            if ($style) {
+                $line = sprintf('<%s>%s</%s>', $style, $line, $style);


A very minor comment (that you should probably ignore): is not mandatory for the closing style tag to match the opening tag. You can use an empty closing tag to end any styles:

// original code $line = sprintf('<%s>%s</%s>', $style, $line, $style); // simpler code with same effect $line = sprintf('<%s>%s</>', $style, $line);

kbond · 2015-03-26T16:39:17Z

Assuming no one has any problems with this PR I think it is good to go.

wouterj · 2015-03-27T00:39:15Z

src/Symfony/Component/Console/Style/SymfonyStyle.php

+     */
+    public function createProgressBar($max = 0)
+    {
+        $progress = parent::createProgressBar($max);


I think it makes more sense to call the variable "progressBar"

xabbuh · 2015-03-27T16:00:45Z

src/Symfony/Component/Console/Style/SymfonyStyle.php

+    {
+        $progressBar = parent::createProgressBar($max);
+
+        if (!defined('PHP_WINDOWS_VERSION_BUILD')) {


We used the value of the DIRECTORY_SEPARATOR constant instead:

if ('\\' !== DIRECTORY_SEPARATOR) {

fabpot · 2015-03-30T15:50:29Z

I'm going to merge this one now; we will have 2 months to tweak it and make it better.

fabpot · 2015-03-30T15:51:23Z

Thank you @kbond.

…(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)

cryptiklemur · 2015-03-30T15:55:10Z

Thanks @kbond !

kbond · 2015-03-31T12:53:24Z

@javiereguiluz should I start a PR to have the core Symfony commands use the style guide?

javiereguiluz · 2015-03-31T13:18:34Z

@kbond too late :) I've started updating them. See: #14132

But you are right: we need some strategy to coordinate our work updating all the commands.

wouterj · 2015-03-31T14:44:56Z

I would prefer if you could write some documentation about this nice feature (the style thing looks like a nice addition) in a new article called components/console/styles.html or so.

javiereguiluz · 2015-03-31T14:46:13Z

@wouterj we'll do that of course. But we're still in the "trial phase". We want to update a bunch of commands and see how they feel. Then we'll tweak the styles and fix some errors (see #14136 for example). And lastly, we'll publish the documentation that you mentioned.

…s methods (ogizanagi) This PR was merged into the 3.0-dev branch. Discussion ---------- [3.0][Console][OutputStyle] Implements verbosity levels methods | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | N/A - Travis build for #14032 | License | MIT Implements the verbosity level methods from `OutputInterface` for the new `OutputStyle` abstract class in 3.0 branch. Fixes Travis builds with `deps=high` env var for #14032 PR and future console style updates. ========= Related to: #14032, #14057, #14138, #14132, #14172, ... Commits ------- a30f507 [Console] [OutputStyle] Implements verbosity methods

stof · 2015-08-01T23:15:58Z

src/Symfony/Component/Console/Style/SymfonyStyle.php

+    public function progressStart($max = 0)
+    {
+        $this->progressBar = $this->createProgressBar($max);
+        $this->progressBar->start();


I know I'm very late in the party, but this API has a major drawback: you are introducing a shared state for the progress bar again (even though it is less an issue that the previous ProgressHelper as it at least creates a new object when starting a new progress bar)

kbond added 25 commits March 25, 2015 08:47

added console style guide helpers

0c653a0

added FormatterInterface and default formatters

b2bd430

added warning result bar

c71222f

added OutputDecorator

e20283f

added comments

797a485

adjusted some formats

c1c49c8

added newline helper

bdb3704

FormatterInterface::format returns string only

7110316

fix cs

4b30f14

fix string padding

a358431

refactored and simplified

99ebf0e

rename subtitle to section, fix docblocks

4d3e078

refactored

72708d7

added table helper

a59fe02

added question helpers

bafefd6

added style guide table style

d767d28

added StandardQuestionHelper

273c187

added table style to Table defaults

b0d2e6a

added askHidden helper

9d82d6a

fix cs

525be2b

refactored, removed FormatterInterface

16ad7b9

match current style guide

de14472

added vertical padding for blocks

d4d6f52

various fixes

a33d8a7

revert changes to FormatterHelper

18dbdb3

kbond mentioned this pull request Mar 25, 2015

[RFC][Console] Added console style guide helpers #12035

Closed

javiereguiluz reviewed Mar 25, 2015
View reviewed changes

remove StyleInterface::multipleChoice()

8143e77

wouterj reviewed Mar 27, 2015
View reviewed changes

set custom progressbar characters only in non-windows environments

f0cb90a

xabbuh reviewed Mar 27, 2015
View reviewed changes

use DIRECTORY_SEPARATOR to detect Windows

bbdb37c

fabpot closed this Mar 30, 2015

ogizanagi mentioned this pull request Mar 30, 2015

[SecurityBundle] UserPasswordEncoderCommand: Improve & simplify the command usage #14032

Closed

javiereguiluz mentioned this pull request Mar 31, 2015

Update the styles of all the built-in command consoles #14138

Closed

60 tasks

SpacePossum mentioned this pull request Apr 1, 2015

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

Merged

This was referenced Apr 2, 2015

[Console] New styles on commands #14172

Closed

[Console] Allow console listing to be with/without space #14174

Closed

ogizanagi mentioned this pull request Apr 5, 2015

[3.0][Console][OutputStyle] Implements verbosity levels methods #14220

Merged

This was referenced Apr 7, 2015

[5.1][Console][Request] Style Guide helpers laravel/framework#8306

Closed

[5.1][Console][WIP] Laravel Console Style laravel/framework#8338

Closed

cordoval mentioned this pull request Apr 8, 2015

New styling commando's gushphp/gush#402

Merged

3 tasks

stof reviewed Aug 1, 2015
View reviewed changes

javiereguiluz mentioned this pull request Sep 28, 2015

[RFC] Updating the Doctrine commands for the new style guide doctrine/DoctrineBundle#466

Closed

Koc mentioned this pull request Sep 30, 2015

Use SymfonyQuestionHelper instead of QuestionHelper and provide default value for confirm method consolidation/robo#221

Closed

kbond mentioned this pull request Nov 17, 2015

SymfonyStyle: Progress Bar Styling Logic Reversed ? #16577

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

kbond commented Mar 25, 2015

hhamon commented Mar 25, 2015

cryptiklemur commented Mar 25, 2015

javiereguiluz Mar 25, 2015

kbond commented Mar 26, 2015

wouterj Mar 27, 2015

xabbuh Mar 27, 2015

fabpot commented Mar 30, 2015

fabpot commented Mar 30, 2015

cryptiklemur commented Mar 30, 2015

kbond commented Mar 31, 2015

javiereguiluz commented Mar 31, 2015

wouterj commented Mar 31, 2015

javiereguiluz commented Mar 31, 2015

stof Aug 1, 2015

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

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

Conversation

kbond commented Mar 25, 2015

Proposed API

Code

Output

Screenshots

hhamon commented Mar 25, 2015

cryptiklemur commented Mar 25, 2015

javiereguiluz Mar 25, 2015

Choose a reason for hiding this comment

kbond commented Mar 26, 2015

wouterj Mar 27, 2015

Choose a reason for hiding this comment

xabbuh Mar 27, 2015

Choose a reason for hiding this comment

fabpot commented Mar 30, 2015

fabpot commented Mar 30, 2015

cryptiklemur commented Mar 30, 2015

kbond commented Mar 31, 2015

javiereguiluz commented Mar 31, 2015

wouterj commented Mar 31, 2015

javiereguiluz commented Mar 31, 2015

stof Aug 1, 2015

Choose a reason for hiding this comment