PHP baseline contains 3 extra spaces per start of the line

[ruudk]

Bug report

PHPStan 1.10.2

I just generated the baseline as PHP file and noticed that every line is prepended with 3 spaces.

Code snippet that reproduces the problem

<?php declare(strict_types = 1);

$ignoreErrors = [];
   $ignoreErrors[] = [
	'message' => '#^Cannot call method isGivenKind\\(\\) on PhpCsFixer\\\\Tokenizer\\\\Token\\|null\\.$#',
	'count' => 1,
	'path' => __DIR__ . '/src-dev/CodeStyle/SimpleBusCommandBusFixer.php',
];
   $ignoreErrors[] = [
	'message' => '#^Cannot call method isGivenKind\\(\\) on PhpCsFixer\\\\Tokenizer\\\\Token\\|null\\.$#',
	'count' => 1,
	'path' => __DIR__ . '/src-dev/CodeStyle/SimpleBusCommandSeeFixer.php',
];

Expected output

<?php declare(strict_types = 1);

$ignoreErrors = [];
$ignoreErrors[] = [
	'message' => '#^Cannot call method isGivenKind\\(\\) on PhpCsFixer\\\\Tokenizer\\\\Token\\|null\\.$#',
	'count' => 1,
	'path' => __DIR__ . '/src-dev/CodeStyle/SimpleBusCommandBusFixer.php',
];
$ignoreErrors[] = [
	'message' => '#^Cannot call method isGivenKind\\(\\) on PhpCsFixer\\\\Tokenizer\\\\Token\\|null\\.$#',
	'count' => 1,
	'path' => __DIR__ . '/src-dev/CodeStyle/SimpleBusCommandSeeFixer.php',
];

The weird thing is, this is not reflected in the phpstan-src:
https://github.com/phpstan/phpstan-src/blob/8260032bc6b3641ec80a4b11526869b53d250ac6/src/Command/ErrorFormatter/BaselinePhpErrorFormatter.php#L62-L69

But it is in the generated Phar file:

            foreach ($fileErrorsCounts as $message => $count) {
                $template = <<<'PHP'
   $ignoreErrors[] = [
	'message' => %s,
	'count' => %d,
	'path' => __DIR__ . %s,
];
PHP;

So something goes wrong with the conversion to Phar.

Did PHPStan help you today? Did it make you happy in any way?

As always, one of the best things that happened to the PHP ecosystem!

[mergeable]

This bug report is missing a link to reproduction at phpstan.org/try.

It will most likely be closed after manual review.

[ruudk]

Also, instead of sprintf-ing , wouldn't it be faster to use simple string interpolation? Especially on a baseline that hits ten's of thousands of lines.

[ondrejmirtes]

I'm not going to debug that 😊 In the transformation there's Box, PHP-Scoper, and Rector involved. Very complex pipeline. I'd say it doesn't matter...

About the sprintf - unless we can see a notable difference in a benchmark that's not something worth changing either.

[ruudk]

Oke, the annoying thing is, is that I want to modify the baseline in a script, and now have to take these 3 spaces into account (to not make the diff bigger). Would it be OK to convert the HEREDOC to a regular string? I think the problem comes from that.

PS: I could make that PR.

[ruudk]

Btw, that $template variable, is defined inside the foreach, but that should be outside the foreach, right? Or without $template variable and directly inlined into the sprintf call.

[ondrejmirtes]

Yeah, feel free to try anything to improve it 😊 As a CI artifact in a PR here you get the compiled PHAR so you could easily debug the end result this way.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.