Movatterモバイル変換

Skip to content

symfony/symfonyPublic

NotificationsYou must be signed in to change notification settings
Fork9.6k
Star30.4k

[Console] Extract customizable BaseOutputStyle and reusable MessageBlock#42093

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open

hushker wants to merge1 commit intosymfony:7.4

base:7.4

Choose a base branch

fromhushker:SF-39184-symfony-style-decouple-2

Open

[Console] Extract customizable BaseOutputStyle and reusable MessageBlock#42093

hushker wants to merge1 commit intosymfony:7.4fromhushker:SF-39184-symfony-style-decouple-2

Conversation

hushker

Copy link

hushker commentedJul 13, 2021•
edited by OskarStark
Loading

Q	A
Branch?	5.4 for features
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	Fix#39184
License	MIT

There are two purposes of changes:

Make it easy to create custom Console Output Style
Protect SymfonyStyle style guide from overriding

Changes:

SymfonyStyle became the final class to prevent overriding
MessageBlock extracted to provide a reusable method for generating block lines
BaseOutputStyle extracted and could be overridden (const and methods are protected) for customization purpose

Example of customization:

<?phpnamespaceApp\OutputStyle;useSymfony\Component\Console\Formatter\OutputFormatter;useSymfony\Component\Console\Helper\Helper;useSymfony\Component\Console\Style\BaseOutputStyle;class MyCustomOutputStyleextends BaseOutputStyle{protectedconstTITLE_CHAR ='=';protectedconstSECTION_CHAR ='-';protectedconstLISTING_CHAR ='*';protectedconstCOMMENT_STYLE ='<fg=default;bg=default> // </>';protectedconstSUCCESS_STYLE ='fg=black;bg=green';protectedconstERROR_STYLE ='fg=white;bg=gray';protectedconstWARNING_STYLE ='fg=black;bg=yellow';protectedconstNOTE_STYLE ='fg=yellow';protectedconstINFO_STYLE ='fg=green';publicfunctiontitle(string$message)    {$this->autoPrependBlock();$this->writeln(['I want to customize it all',sprintf('<comment>%s</>', OutputFormatter::escapeTrailingBackslash($message)),sprintf('<comment>%s</>',str_repeat(static::TITLE_CHAR, Helper::width(Helper::removeDecoration($this->getFormatter(),$message)))),                       ]);$this->newLine();    }}

We can customize easily by overriding the style constants of whole methods.

@hushker

hushker requested a review fromchalasr as acode owner

July 13, 2021 19:17

@carsonbot

carsonbot added Status: Needs Review Bug Console Deprecation Feature labels

@hushker

hushker force-pushed theSF-39184-symfony-style-decouple-2 branch from991fa8c to1e7a013Compare

July 13, 2021 19:21

@OskarStark

OskarStark requested a review fromjaviereguiluz

July 13, 2021 19:22

@hushker

hushker force-pushed theSF-39184-symfony-style-decouple-2 branch 2 times, most recently from14fd3a1 tob23eccaCompare

July 13, 2021 20:39

chalasr

chalasr requested changes

View reviewed changes

Copy link

Member

chalasr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thanks for the PR.

src/Symfony/Component/Console/Style/BaseOutputStyle.php OutdatedShow resolvedHide resolved

src/Symfony/Component/Console/Style/OutputStyle.phpShow resolvedHide resolved

src/Symfony/Component/Console/Style/SymfonyStyle.php OutdatedShow resolvedHide resolved

src/Symfony/Component/Console/Block/MessageBlock.php OutdatedShow resolvedHide resolved

@carsonbot

carsonbot added Status: Needs Work and removed Status: Needs Review labels

@chalasr

chalasr removed Bug Deprecation labels

@chalasr

chalasr added this to the5.4 milestone

@hushker

hushker force-pushed theSF-39184-symfony-style-decouple-2 branch fromb23ecca to83c91c6Compare

July 14, 2021 16:47

@hushker

[Console] Extract customizable BaseOutputStyle and reusable MessageBlock

ac6611a

@hushker

hushker force-pushed theSF-39184-symfony-style-decouple-2 branch from83c91c6 toac6611aCompare

July 14, 2021 17:51

@chalasr

chalasr self-requested a review

July 14, 2021 17:57

@carsonbot

carsonbot added Status: Needs Review and removed Status: Needs Work labels

@fabpot

fabpot modified the milestones:5.4,6.1

@fabpot

fabpot modified the milestones:6.1,6.2

@nicolas-grekas

nicolas-grekas modified the milestones:6.2,6.3

@nicolas-grekas

nicolas-grekas modified the milestones:6.3,6.4

@nicolas-grekas

nicolas-grekas modified the milestones:6.4,7.1

@xabbuh

xabbuh modified the milestones:7.1,7.2

@fabpot

fabpot modified the milestones:7.2,7.3

@fabpot

fabpot modified the milestones:7.3,7.4

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Labels

Console Feature Status: Needs Review

6 participants

@hushker

@chalasr

@fabpot

@nicolas-grekas

@xabbuh

@carsonbot

[8]ページ先頭

©2009-2025 Movatter.jp