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.

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

Transform URIs of hover results #157448

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Semesse
Copy link
Contributor

@Semesse Semesse commented Aug 7, 2022

trying to (partially) fix #157124 with unit tests

file:// and vscode-local:// URIs provided by HoverProviders are now transformed and MarkdownRenderer will render the transformed URI

@ghost
Copy link

ghost commented Aug 7, 2022

CLA assistant check
All CLA requirements met.

Copy link
Member

@jrieken jrieken left a comment

Choose a reason for hiding this comment

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

The uri transformer shouldn't be used directly. The contract is that the at the level of the RPC protocol uri transformation happens - for any URI instance (which is the reason why some "funny" uri extraction happens for markdown)

Can you add some detail what issue you are trying to solve and what repro steps show this? It might be a case of missing to extract a particular uri

@Semesse
Copy link
Contributor Author

Semesse commented Aug 17, 2022

The uri transformer shouldn't be used directly. The contract is that the at the level of the RPC protocol uri transformation happens - for any URI instance (which is the reason why some "funny" uri extraction happens for markdown)

Can you add some detail what issue you are trying to solve and what repro steps show this? It might be a case of missing to extract a particular uri

Thank you for kind reply~ I want to fix URIs' rendered inside hover results because they seem to point to local file system file:// instead of vscode-remote://, here's an example screen record

Kapture.2022-08-17.at.14.03.58.mp4

As you can see in the above clip, {@links xxx} in jsdoc is broken as rendered in markdown. Here's my repo: https://github.com/Semesse/flowp, open src/control/mutex.ts under remote ssh and try to click the link in hovers will trigger the issue (but in theory this should occur in any repo using jsdoc)

Could you give me some insights on how to fix this issue without breaking the contract? :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Transform file:// URIs to remote URI inside comments and hover result markdown in remote mode
5 participants