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

JSDoc link should include 'https://svelte.dev' #10351

Closed
forvate opened this issue Jan 31, 2024 · 0 comments · Fixed by #10365
Closed

JSDoc link should include 'https://svelte.dev' #10351

forvate opened this issue Jan 31, 2024 · 0 comments · Fixed by #10365

Comments

@forvate
Copy link

forvate commented Jan 31, 2024

Describe the bug

While the extension is displaying the documentation about currently hovered function, it wrongly assumes the markdown is correct, while in fact the Svelte documentation is being pulled from a browser, where a [link](/data/server-side-component-api) is properly interpreted to be a path as in an anchor tag, in a context of an editor, it is wrongly assumed to be a link to file located on the users drive as /docs or similar.

Reproduction

While hovering over a documented function from svelte package, any link inside the markdown contains only the route (/docs#etc-etc) and not a full URI (https://svelte.dev/docs#etc-etc)

Expected behaviour

The extension should add back the information about the internet resource as it is no longer markdown meant to be interacted on the website, but in the editor itself.

System Info

  • OS: Arch Linux 6.7.2-arch1-1
  • IDE: VSCode 1.85.2
  • Svelte for VS Code v108.2.1

Which package is the issue about?

Svelte for VS Code extension

Additional Information, eg. Screenshots

example
prompt

Keep in mind this could also be an issue with SvelteKit documentation, and also other code editors could interact badly with the link being a file path and not a URI, which could make it a svelte-language-server issue also.

@forvate forvate added the bug label Jan 31, 2024
@jasonlyu123 jasonlyu123 removed the bug label Jan 31, 2024
@jasonlyu123 jasonlyu123 transferred this issue from sveltejs/language-tools Jan 31, 2024
@jasonlyu123 jasonlyu123 changed the title Inline links in hover information should prepend 'https://svelte.dev', so VSCode doesn't prompt for new file creation. JSDoc link should include 'https://svelte.dev' Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants