Set editorUrl from xdebug configuration

[cs278]

Recently discovered the editorUrl property but it's a bit of a chore to go and set it in the many projects I have locally.

Fortunately it's possible to reuse the xdebug extensions configuration which a number of other projects do:

• https://github.com/vimeo/psalm/blob/a27feaff099dd4e609c92d7555ca4961591de53d/src/Psalm/Report/ConsoleReport.php#L138
• https://github.com/filp/whoops/blob/075bc0c26631110584175de6523ab3f1652eb28e/src/Whoops/Handler/PrettyPageHandler.php#L141
• https://github.com/symfony/symfony/blob/a90bd41dd757706a8f4b291ab0a076ae49a2da7c/src/Symfony/Component/VarDumper/Dumper/CliDumper.php#L87
• https://github.com/symfony/symfony/blob/a90bd41dd757706a8f4b291ab0a076ae49a2da7c/src/Symfony/Component/ErrorHandler/ErrorRenderer/FileLinkFormatter.php#L41

So there is decent precedent for this, I've searched previous issues/pulls/discussions and only found a single reference to this in the context of PHPStan which kinda incorrectly concluded it wasn't possible.

I'm not sure if my implementation is correct but it certainly works, it was the easiest way I could find of adding a default value to a property at runtime which can be completely overridden by the configuration files. Happy to make any changes that are needed though if the premise is acceptable.

[ondrejmirtes]

Hi, this isn't going to work for multiple reasons.

1. PHPStan's editorUrl and XDebug's file_link_format use different placeholders. PHPStan is using %file and %line, but XDebug is using %f and %l.
2. People sometimes have some JavaScript in their XDebug's file_link_format, as recommended by the manual: https://xdebug.org/docs/all_settings#file_link_format This also isn't something that's going to work in PHPStan's context.

I recommend you to have a global phpstan.neon in your ~ home directory with PHPStan-compatible editorUrl setting, and include it in your environment-specific phpstan.neon in your projects, like this:

includes:
    - /home/cs278/phpstan.neon # my global config
    - phpstan.neon.dist # local project config

More about that here https://phpstan.org/config-reference#multiple-files

[cs278]

1. PHPStan's editorUrl and XDebug's file_link_format use different placeholders. PHPStan is using %file and %line, but XDebug is using %f and %l.

I sorted that by translating the xdebug setting.

2. People sometimes have some JavaScript in their XDebug's file_link_format, as recommended by the manual: xdebug.org/docs/all_settings#file_link_format This also isn't something that's going to work in PHPStan's context.

Was not aware of that, could ignore any prefixed with javascript:

I recommend you to have a global phpstan.neon in your ~ home directory with PHPStan-compatible editorUrl setting, and include it in your environment-specific phpstan.neon in your projects, like this:

Sure, I've seen this advice but sadly it's a bit limiting as it doesn't seem to respect $HOME or ~ to resolve my home directory which varies and isn't tolerant of the file not existing.