Improve editor URL

[jdreesen]

Added support for %relFile%.

Also, it will now display the relative file path instead of the editor URL:

Before:

Note that the last (underlined) part is clickable, but has the wrong prefix because PHPStan runs in a Docker container, so the file won't be opened in the IDE.

After:

Now it works.

I've copied the logic from here: https://github.com/phpstan/phpstan-src/blob/fb73c57a4014fe42e2f7bd67f02f47bcb541ea0e/src/Command/ErrorFormatter/TableErrorFormatter.php#L101-L118

[coderabbitai]

📝 Walkthrough

Walkthrough

The modifications add a new dependency, SimpleRelativePathHelper, to the error formatting flow. The service configuration in extension.neon is updated so that the errorFormatter.friendly service now receives this additional helper. In the code, both the FriendlyErrorFormatter and ErrorWriter classes have been modified to accept and store an instance of SimpleRelativePathHelper through updated constructor signatures. The ErrorWriter class now uses the helper to obtain a relative file path for constructing the editor URL, incorporating the helper’s output into the formatting logic along with proper escaping via OutputFormatter::escape. These changes adjust the dependency injection and control flow for error message formatting by integrating the new path helper into the error-processing sequence.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant FEF as FriendlyErrorFormatter
    participant EW as ErrorWriter
    participant SRPH as SimpleRelativePathHelper

    Client->>FEF: Request error formatting
    FEF->>EW: Invoke writeFileSpecificErrors()
    EW->>SRPH: Retrieve relative file path
    SRPH-->>EW: Return relative file path
    EW->>EW: Construct and escape editor URL
    EW-->>FEF: Return formatted error
    FEF-->>Client: Deliver formatted error

Loading

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 PHPStan (2.0.3)

/bin/bash: line 1: /vendor/bin/phpstan: No such file or directory

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 87d5b38 and db18724.

📒 Files selected for processing (3)

• extension.neon (1 hunks)
• src/ErrorFormat/ErrorWriter.php (3 hunks)
• src/FriendlyErrorFormatter.php (3 hunks)

🔇 Additional comments (4)

extension.neon (1)

18-18: LGTM! Service configuration updated correctly.

The addition of simpleRelativePathHelper as a dependency to the errorFormatter.friendly service aligns with the PR's objective to support relative file paths in editor URLs.

src/FriendlyErrorFormatter.php (1)

10-10: LGTM! Class updated correctly to support relative paths.

The changes properly integrate the SimpleRelativePathHelper:

• Added import and property with correct typing
• Updated constructor with logical parameter order
• Correctly passed to ErrorWriter

Also applies to: 20-21, 26-35, 53-53

src/ErrorFormat/ErrorWriter.php (2)

9-10: LGTM! Class updated correctly to support relative paths.

The changes properly integrate the SimpleRelativePathHelper:

• Added import and property with correct typing
• Updated constructor with logical parameter order

Also applies to: 19-20, 25-32

---

82-86: LGTM! URL construction is secure and functional.

The changes properly handle editor URL construction:

• Correctly uses SimpleRelativePathHelper for relative paths
• Properly escapes URL to prevent XSS
• Maintains backward compatibility with existing placeholders

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.