Report Full: various message formatting fixes

[jrfnl]

This patch contains three commits addressing separate issues related to the Full report message formatting.

Report Full: fix word wrapping when message contains new lines

The word wrapping was causing unexpected and unintended message formatting if the message contained new lines.

Looking at the file history, prior to PHPCS 2.4.0 line breaks in messages wasn't supported at all. The implementation in PHPCS 2.4.0, however, pads the lines before the word wrapping causing the word wrapping to go haywire.

Test code:

$message = "Lorem ipsum dolor sit amet, consectetur adipiscing elit.\nAenean felis urna, dictum vitae lobortis vitae, maximus nec enim. Etiam euismod placerat efficitur. Nulla eu felis ipsum.\nCras vitae ultrices turpis. Ut consectetur ligula in justo tincidunt mattis.\n\nAliquam fermentum magna id venenatis placerat. Curabitur lobortis nulla sit amet consequat fermentum. Aenean malesuada tristique aliquam. Donec eget placerat nisl.\n\nMorbi mollis, risus vel venenatis accumsan, urna dolor faucibus risus, ut congue purus augue vel ipsum.\nCurabitur nec dolor est. Suspendisse nec quam non ligula aliquam tempus. Donec laoreet maximus leo, in eleifend odio interdum vitae.";

$phpcsFile->addWarning($message, 0, 'Example');

What it used to look like:

phpcs ./file.php --standard=Standard

phpcs -s ./file.php --standard=Standard (with show sources enabled)

What it looks like with this patch applied:

phpcs ./file.php --standard=Standard

phpcs -s ./file.php --standard=Standard (with show sources enabled)

## Report Full: always have the error code on a new line

In most cases it already would be as the error code is often long, but sometimes it wouldn't be, causing decreased readability of the report.

Report Full: fix max report width not being respected when showing sources

The $maxErrorSpace was being given a extra width of 8 when $showSources was true - i.e. when -s was used -, causing the report to be wider than the report-width setting allowed.

Test code:

$message = "Lorem ipsum dolor sit amet, consectetur adipiscing elit.\nAenean felis urna, dictum vitae lobortis vitae, maximus nec enim. Etiam euismod placerat efficitur. Nulla eu felis ipsum.\nCras vitae ultrices turpis. Ut consectetur ligula in justo tincidunt mattis.\n\nAliquam fermentum magna id venenatis placerat. Curabitur lobortis nulla sit amet consequat fermentum. Aenean malesuada tristique aliquam. Donec eget placerat nisl.\n\nMorbi mollis, risus vel venenatis accumsan, urna dolor faucibus risus, ut congue purus augue vel ipsum.\nCurabitur nec dolor est. Suspendisse nec quam non ligula aliquam tempus. Donec laoreet maximus leo, in eleifend odio interdum vitae.";
$message  = str_replace("\n", ' ', $message);
$message  = str_replace('  ', ' ', $message);

$phpcsFile->addWarning($message, 0, 'Example');

What it used to look like:

What it looks like with this patch applied:

[gsherwood]

I haven't had time to look at this yet (not sure when) but wanted to comment to say that changing the full report to always put sources on a new line would be a real pain for me during development (I have plenty of width, not much height) and I would not merge in this as the default option for the report. Those sources have always been on the same line, so I imagine I'm not the only one who would be annoyed by that change.

FYI, my terminal width normally sits at around 160 and most errors and sources fit on one line. If you're at something more like 100, then yes, you're going to be on new lines most of the time, but I don't think it matters that the source stays on the same line if possible.

[jrfnl]

@gsherwood And that's why the three changes are all separate commits. 😎 I'll remove that specific commit.

[jrfnl]

@gsherwood FYI: I've removed the commit adding the line break before the error code and have adjusted the last commit (max report width not being respected) to be in line with that change not being made.

The last line of a long wrapped message may wrap four characters early now, but in my opinion, that's better than the whole message being too wide.

[gsherwood]

Thanks for these fixes, and for removing that error code line change.

[jrfnl]

Thanks for merging this.