Backward compatibility promise for FileHelper(::absolutizePath)?

[spaze]

Hi,

my extension for disallowing some function/method/etc. calls in the analyzed code allows to specify paths where the otherwise disallowed (say function) call is ok. Users can specify the paths relative to the config file location.

To get the same "format" and structure of the path I'm using PHPStan\File\FileHelper::absolutizePath() so I can compare (using fnmatch) the paths coming from PHPStan and a path created in my extension.

When testing the extension code itself, PHPStan now complains that

Calling PHPStan\File\FileHelper::absolutizePath() is not covered by backward compatibility promise. The method might change in a minor PHPStan version.

because the method is not covered by the backward compatibility promise.

And I'd like to see the method covered with that promise in a future release of PHPStan. Or maybe even the whole FileHelper class as absolutizePath uses other methods internally too but that I don't care much about. Would it be possible?

I could implement the method myself and not use FileHelper at all but then if FileHelper changes internally, my code might also break because suddenly, I might be comparing 🍎 to 🍊.

So just to make sure I'm comparing 🍎 to 🍎, I'd like to use PHPStan's helper.

Or please advise what would be the best way to tackle this.

Thank you! 😇

[ondrejmirtes]

Hi, yeah, you guessed my thought process - "there's nothing specific about PHPStan in this class so everyone can reimplement it by themselves". That said, it's probably still useful for extension developers to sometimes use it, and it's unlikely to change, so I added the @api annotations :) In phpstan/phpstan-src@4f9488e.

Thanks for the suggestion!

[spaze]

Awesome, thank you! ☺️

[canvural]

Hi, the constructor is not covered by BC promise still. So I'm getting Creating new PHPStan\File\FileHelper is not covered by backward compatibility promise.

Is the recommended way is to inject it somehow? If so how can I define the constructor argument to it in the neon file? My usage is like this.

[ondrejmirtes]

Just ask for it in the constructor, you don't need to edit the neon file at all. It's autowired. See this guide: https://phpstan.org/developing-extensions/dependency-injection-configuration

[canvural]

How can I set the workingDirectory for FileHelper then? Does it default to%currentWorkingDirectory% ?

[ondrejmirtes]

Yes: https://github.com/phpstan/phpstan-src/blob/b943ba186376d6b5cdf391f870c3162ce720b3bd/conf/config.neon#L570-L573