[Console] Support formatted text cutting #22225

ro0NL · 2017-03-30T18:02:42Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes/no
Fixed tickets	#...
License	MIT
Doc PR	symfony/symfony-docs#...

allows cutting a formatted text to a certain width. Actually needed if we want to support max. column widths in tables (see #22156)

$text = 'pre <error>foo bar baz</error> post';
dump('BEFORE');
$output->writeln(wordwrap($output->getFormatter()->format($text), 3, "\n", true), OutputInterface::OUTPUT_RAW);
dump('AFTER');
$output->writeln($output->getFormatter()->format($text, 3), OutputInterface::OUTPUT_RAW);

nicolas-grekas · 2017-04-03T08:23:45Z

src/Symfony/Component/Console/Formatter/OutputFormatter.php

-     * Sets the decorated flag.
-     *
-     * @param bool $decorated Whether to decorate the messages or not
+     * {@inheritdoc}


does this patch apply to lower branches? if yes, should be done there

Will look into that.

nicolas-grekas · 2017-04-03T08:24:59Z

src/Symfony/Component/Console/Formatter/OutputFormatter.php

-     * @param string $message The message to style
-     *
-     * @return string The styled message
+     * {@inheritdoc}


that one is not possible: $width is not in the interface, thus should be documented here

nicolas-grekas · 2017-04-03T08:26:39Z

src/Symfony/Component/Console/Formatter/OutputFormatterInterface.php

     *
     * @return string The styled message
     */
-    public function format($message);
+    public function format($message/*, $width = 0*/);


Changing an interface like that is a hard BC break. Anyone implementing it without extending OutputFormatter will get no deprecation warning.

Any suggestions? Took this approach from LogoutUrlGenerator::registerListener ;) which is not bound to an interface.

Note that this way is the easiest implementation and avoids double processing the formatted text, which is nice.

ro0NL · 2017-04-07T13:39:13Z

Approach updated.. not sure this makes sense either :P but im concerning users extending from OutputFormatter as well as implementing OutputFormatterInterface.

Guess i like the format($message, $width = 0) api.. but maybe the new interface should simply define wrapAndFormat($message, $width) or so.. and let format() forward.

…ro0NL) This PR was merged into the 2.7 branch. Discussion ---------- [Console] Inherit phpdoc from OutputFormatterInterface | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #22225 (comment) | License | MIT | Doc PR | symfony/symfony-docs#...  Commits ------- ff3cb9c [Console] Inherit phpdoc from OutputFormatterInterface

nicolas-grekas · 2017-10-08T15:58:58Z

Moving to 4.1. Rebase on master might be needed, where PHP 7.1 features can be used btw.

fabpot · 2018-03-31T06:09:45Z

@ro0NL Can you tell us the status of this PR? Looks like it should be rebased.

ro0NL · 2018-03-31T08:52:16Z

@fabpot is the current upgrade path OK? If so, suggestions for naming WrappableOutputFormatterInterface welcome :)

but i was hoping we eventually dont need this interface and have OutputInterface::format($message, $width = 0) API... but the current BC policy doesnt allow that right? Hence we're stuck with this interface.

status: needs work

fabpot · 2018-04-04T12:13:34Z

src/Symfony/Component/Console/Formatter/OutputFormatter.php

+            if (__CLASS__ !== get_class($this)) {
+                $r = new \ReflectionMethod($this, __FUNCTION__);
+                if (__CLASS__ !== $r->getDeclaringClass()->getName()) {
+                    @trigger_error(sprintf('Method "%s()" will have a 2nd `$width = 0` argument in version 5.0. Not defining it is deprecated since 4.1.', __METHOD__), E_USER_DEPRECATED);


... in version 5.0, not defining it is deprecated since Symfony 4.1

I don't understand why you want to force people to define the $width. Not setting it explicitly seems fine to me.

Right. I should check for defined no. of arguments on the signature.

ro0NL · 2018-04-04T16:09:58Z

I think the upgrade path is OK now. But i need to have a 2nd look at the fix.. cause im getting different results now as before.

ro0NL · 2018-04-04T16:15:46Z

OK something spiffy is going on

without any src changes etc. in between.. in PHPstorm it seems to consistently format wrong.

Curious if this can be confirmed on some other terminal also.

ro0NL · 2018-04-04T16:16:49Z

It seems to break as soon as it breaks out the window, thus creates a scrollbar. WTF :)

fabpot · 2018-09-04T15:41:32Z

@ro0NL What do we do here? Any ideas how to move forward?

ro0NL · 2018-09-04T16:50:33Z

@fabpot rebased. The breaking format is unrelated (#27832), so if tests are still passing im 👍 to merge. But let me add some rendering tests tomorrow.

ro0NL · 2018-09-04T16:54:21Z

And perhaps rethink WrappableOutputFormatterInterface, overriding the definition of OutputFormatterInterface::format().

Perhaps more explicit WrappableOutputFormatterInterface::formatAndWrap(string $message, int $width) and let the implementation forward to format($message, $width), where OutputFormatter::format() still supports the 2nd arg, but not as part of the interface..

Then again, currently it allows to update OutputFormatterInterface::format() with the 2nd arg in 5.0 IIUC

ro0NL · 2018-09-04T17:06:31Z

Updated. Much cleaner IMHO.

fabpot

Looks much better to me

chalasr · 2018-09-04T20:11:11Z

Nice one! Thanks Roland.

This PR was squashed before being merged into the 4.2-dev branch (closes #22225). Discussion ---------- [Console] Support formatted text cutting | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes/no | Fixed tickets | #...  | License | MIT | Doc PR | symfony/symfony-docs#...  allows cutting a formatted text to a certain width. Actually needed if we want to support max. column widths in tables (see #22156) ```php $text = 'pre <error>foo bar baz</error> post'; dump('BEFORE'); $output->writeln(wordwrap($output->getFormatter()->format($text), 3, "\n", true), OutputInterface::OUTPUT_RAW); dump('AFTER'); $output->writeln($output->getFormatter()->format($text, 3), OutputInterface::OUTPUT_RAW); ``` ![image](https://cloud.githubusercontent.com/assets/1047696/24519346/19c9b0ca-1585-11e7-8437-0bcfb6fab63e.png) Commits ------- 09f8ad9 [Console] Support formatted text cutting

This PR was squashed before being merged into the 4.2-dev branch (closes #28373). Discussion ---------- [Console] Support max column width in Table | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no  | Deprecations? | no | Tests pass? | yes  | Fixed tickets | #22156, #27832 | License | MIT | Doc PR | symfony/symfony-docs#10300 Continuation of #22225 to better preserve spaces (which preserves background colors), using `wordwrap` it caused some issues. Also the wrapping was plain wrong by not taking the current line length into account. While at it, it comes with `Table` integration :) Given ```php $table = new Table($output); $table->setColumnMaxWidth(0, 2); $table->setRow(0, ['pre <error>foo bar baz</error> post']); $table->render(); $table = new Table($output); $table->setColumnMaxWidth(0, 3); $table->setRow(0, ['pre <error>foo bar baz</error> post']); $table->render(); $table = new Table($output); $table->setColumnMaxWidth(0, 4); $table->setRow(0, ['pre <error>foo bar baz</error> post']); $table->render(); ``` ![image](https://user-images.githubusercontent.com/1047696/45101516-f19b5880-b12b-11e8-825f-6a1d84f68f47.png) Commits ------- 175f68f [Console] Support max column width in Table

carsonbot added Status: Needs Review Console Feature labels Mar 30, 2017

nicolas-grekas reviewed Apr 3, 2017

View reviewed changes

nicolas-grekas requested changes Apr 3, 2017

View reviewed changes

nicolas-grekas added this to the 3.4 milestone Apr 3, 2017

ro0NL mentioned this pull request Apr 7, 2017

[Console] Inherit phpdoc from OutputFormatterInterface #22342

Merged

ro0NL mentioned this pull request Apr 28, 2017

Symfony Console Exception reporting doesn't parse style tags. #22552

Closed

nicolas-grekas self-assigned this Aug 31, 2017

nicolas-grekas removed their assignment Sep 16, 2017

nicolas-grekas modified the milestones: 3.4, 4.1 Oct 8, 2017

carsonbot added Status: Needs Work and removed Status: Needs Review labels Mar 31, 2018

fabpot requested changes Apr 4, 2018

View reviewed changes

nicolas-grekas modified the milestones: 4.1, next Apr 20, 2018

ro0NL mentioned this pull request Jul 3, 2018

[Console] Format unset codes break with scrollbar #27832

Closed

fabpot approved these changes Sep 4, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Sep 4, 2018

chalasr approved these changes Sep 4, 2018

View reviewed changes

[Console] Support formatted text cutting

09f8ad9

chalasr merged commit 09f8ad9 into symfony:master Sep 4, 2018

ro0NL deleted the console/cut-format branch September 5, 2018 05:58

This was referenced Sep 5, 2018

[Console] Support max column width in Table #28373

Merged

[Console] Table column max width / formatted text wrapping symfony/symfony-docs#10300

Closed

nicolas-grekas modified the milestones: next, 4.2 Nov 1, 2018

This was referenced Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

Release v4.2.0-BETA1 #29073

Merged

ro0NL mentioned this pull request Mar 11, 2019

[Console] Upgrade word wrapping in SymfonyStyle #30519

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Support formatted text cutting #22225

[Console] Support formatted text cutting #22225

ro0NL commented Mar 30, 2017 •

edited

Loading

nicolas-grekas Apr 3, 2017

ro0NL Apr 3, 2017

nicolas-grekas Apr 3, 2017

nicolas-grekas Apr 3, 2017 •

edited

Loading

ro0NL Apr 3, 2017

ro0NL commented Apr 7, 2017 •

edited

Loading

nicolas-grekas commented Oct 8, 2017

fabpot commented Mar 31, 2018

ro0NL commented Mar 31, 2018 •

edited

Loading

fabpot Apr 4, 2018

fabpot Apr 4, 2018

ro0NL Apr 4, 2018

ro0NL commented Apr 4, 2018

ro0NL commented Apr 4, 2018

ro0NL commented Apr 4, 2018

fabpot commented Sep 4, 2018 •

edited

Loading

ro0NL commented Sep 4, 2018 •

edited

Loading

ro0NL commented Sep 4, 2018 •

edited

Loading

ro0NL commented Sep 4, 2018

fabpot left a comment

chalasr commented Sep 4, 2018 •

edited

Loading

[Console] Support formatted text cutting #22225

[Console] Support formatted text cutting #22225

Conversation

ro0NL commented Mar 30, 2017 • edited Loading

nicolas-grekas Apr 3, 2017

Choose a reason for hiding this comment

ro0NL Apr 3, 2017

Choose a reason for hiding this comment

nicolas-grekas Apr 3, 2017

Choose a reason for hiding this comment

nicolas-grekas Apr 3, 2017 • edited Loading

Choose a reason for hiding this comment

ro0NL Apr 3, 2017

Choose a reason for hiding this comment

ro0NL commented Apr 7, 2017 • edited Loading

nicolas-grekas commented Oct 8, 2017

fabpot commented Mar 31, 2018

ro0NL commented Mar 31, 2018 • edited Loading

fabpot Apr 4, 2018

Choose a reason for hiding this comment

fabpot Apr 4, 2018

Choose a reason for hiding this comment

ro0NL Apr 4, 2018

Choose a reason for hiding this comment

ro0NL commented Apr 4, 2018

ro0NL commented Apr 4, 2018

ro0NL commented Apr 4, 2018

fabpot commented Sep 4, 2018 • edited Loading

ro0NL commented Sep 4, 2018 • edited Loading

ro0NL commented Sep 4, 2018 • edited Loading

ro0NL commented Sep 4, 2018

fabpot left a comment

Choose a reason for hiding this comment

chalasr commented Sep 4, 2018 • edited Loading

ro0NL commented Mar 30, 2017 •

edited

Loading

nicolas-grekas Apr 3, 2017 •

edited

Loading

ro0NL commented Apr 7, 2017 •

edited

Loading

ro0NL commented Mar 31, 2018 •

edited

Loading

fabpot commented Sep 4, 2018 •

edited

Loading

ro0NL commented Sep 4, 2018 •

edited

Loading

ro0NL commented Sep 4, 2018 •

edited

Loading

chalasr commented Sep 4, 2018 •

edited

Loading