Ignore line ending characters when matching code issues against baseline

[bdsl]

I was puzzling over why my Psalm run was passing locally, but had many errors in CI. The answer was that I had autocrlf turned on in git settings, so my local PHP files were in a different format to those generated in the CI environment. Specifically I had many <code> elements in the baseline that ended with &#13;</code>

I wonder if it would be worth making Psalm ignore the 
 (carriage return), and also not add it when generating the baseline.

[psalm-github-bot]

Hey @bdsl, can you reproduce the issue on https://psalm.dev ?

[bdsl]

@psalm-github-bot sorry, psalm.dev doesn't support baselines.

[weirdan]

Remind me how that works: you have CR LF line endings locally, but CR is stripped during commit and reinstated during checkout, right? So CR is never added to the repository and thus is missing on machines with autocrlf disabled?

[bdsl]

In my case I had LF endings locally on a linux machine and CR LF endings on the PHP files in the repo. Git with autocrlf=true converts the php files to my local format on checkout.

Then when I generate a baseline file locally it doesn't match the files as they are in the repository, so Psalm reports errors in the CI environment where autocrlf is set to false.

[weirdan]

But if you don't have CRs locally how they ended up in the baseline (
 is encoded CR)?

[weirdan]

Also, docs say autocrlf always causes files to be stored in the repo with LF line endings.

[bdsl]

Hmm, I'm not 100% sure now - looks like at list some of the files must have had CRLF on my local - quite possibly there was a mixture of both formats, maybe between files maybe even within one file. I'm not entirely sure - I just know that I fixed the issue by generating a new baseline within the CI executor and committing that, and the diff on that commit showed the removal of 
 entities.

[reeperbahnause]

Hey,
I'm facing the same behavior.
In our case the line ending in the git repo is LF. The psalm baseline file was created on a linux dev environment.
Once I checkout the branch for testing psalm on windows the line endings will be changed to CRLF because of the git client configuration autocrlf
Running psalm on windows won't match the baseline rules because of the extra character (for example at the end of a function definition)

Here is an example of the linux baseline file vs the windows baseline file:

[bdsl]

@weirdan I'm happy to try and PR an implementation for this if you think it's the right thing to do for Psalm.

[weirdan]

@bdsl sure, please do

[bdsl]

Will try and get that in in the next few days.

[bdsl]

@weirdan btw, is there a set policy on when to close Psalm issues? Might it make sense to leave it open until there's a release available with the fix?

[weirdan]

That would require some additional automation, while closing them when PR is merged is a Github's native functionality.