Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

output-format: add info about editorUrlTitle #8446

Merged
merged 3 commits into from Dec 16, 2022
Merged

output-format: add info about editorUrlTitle #8446

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f0276a5
output-format: add info about editorUrlTitle
janedbal Dec 1, 2022
574b5f5
since 1.9.3
janedbal Dec 1, 2022
4275f6e
restructuralize
janedbal Dec 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions website/src/user-guide/output-format.md
View file
Open in desktop
Expand Up @@ -63,4 +63,15 @@ To make the text really clickable in your terminal you might need to register th

If you run PHPStan analysis within Docker container (or using other virtualization tools) you may need to use `%relFile%` instead of `%file%`. This will use file's path relative to the current working directory. In the end your `editorUrl` should look like this: `phpstorm://open?file=/path/to/your/project/%%relFile%%&line=%%line%%`.


<div class="text-xs inline-block border border-green-600 text-green-600 bg-green-100 rounded px-1 mb-4">Available in PHPStan 1.9.3</div>

You may also want to change the default title of the clickable link to contain line to be able to quickly copy-paste it to your IDE when used within an environment that is not clickable (like CI output). Here is how:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this sentence is pretty long and hard to read

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about this?

You may also want to change the default title of the clickable link. For example, CI output may contain [file]:[line] to allow you to quickly copy-paste it to your IDE.

```neon
parameters:
editorUrlTitle: '%%relFile%%:%%line%%'
```

--------------------
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the last paragraph should not be considered as 'available since 1.9.3', so I added this line.


Since every team member working on the same project will likely have different absolute path to the project, machine-specific `editorUrl` should be used in `phpstan.neon` [paired with `phpstan.neon.dist` where all the common project settings live](/config-reference#multiple-files).