should $scope->getFile() return a normalized path?

[staabm]

to ease development of custom PHPStan rules, I think it would be helpful if $scope->getFile() would return a normalized filepath.

that way we would prevent the trap of people comparing the path against constant strings like

        if (('boot.php' === basename($scope->getFile()) || str_contains($scope->getFile(), 'scripts/'))) {
            return [];
        }

in a way which is not cross-operating system compatible.

additionally normalization would prevent the need for writing ugly conditions like

        if (('boot.php' === basename($scope->getFile()) || str_contains($scope->getFile(), 'scripts'. DIRECTORY_SEPARATOR))) {
            return [];
        }

wdyt?

[ondrejmirtes]

What does it currently return and what do you think it should return?

[staabm]

in my current case at hand it returns ...\scripts\portal\myscript.php on windows but .../scripts/portal/myscript.php on linux.

if it would always returns a unix style path (I think thats what most people would expect) - I could not make the mistake of forgetting a check against windows style directory separators

[ondrejmirtes]

Yeah sure, that could work. Since the path looks like this on Linux already, I wouldn't consider this a BC break.

[staabm]

for code like my above example

if (('boot.php' === basename($scope->getFile()) || str_contains($scope->getFile(), 'scripts'. DIRECTORY_SEPARATOR))) {
            return [];
        }

it would be a BC break on windows.. maybe its a bleeding-edge only change then?

[ondrejmirtes]

So we can't actually do it... yeah, BE, or never 😊