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

Add support for document link to the ruby-lsp #58

Closed
vinistock opened this issue Mar 29, 2022 · 1 comment
Closed

Add support for document link to the ruby-lsp #58

vinistock opened this issue Mar 29, 2022 · 1 comment
Assignees

Comments

@vinistock
Copy link
Member

vinistock commented Mar 29, 2022

The document link request allows us to attach a link to a piece of code. This is very useful to directing people to documentation. Some examples of what we can do:

  • When looking at Sorbet things, link to the Sorbet documentation
  • When looking at Rails things, link to the Rails documentation
  • When looking at GraphQL things, link to the GraphQL documentation
  • When hovering gems on the Gemfile, link to the official repo

Note: remember that if we want to add any internal resources, we'll have to allow this to be configurable somehow.

Idea: since we don't do type checking, we can't be absolutely sure that a method comes from Rails/Sorbet/GraphQL. As a best effort, we can check the parent class and other method invocations within the file to make a best guess before linking to the documentation.

Documentation: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_documentLink

@vinistock vinistock transferred this issue from another repository Apr 8, 2022
@egiurleo egiurleo assigned egiurleo and unassigned egiurleo Jul 7, 2022
@egiurleo
Copy link
Contributor

Support for the DocumentLink request was added in #195.

andyw8 referenced this issue in andyw8/ruby-lsp Mar 2, 2024
…t-eslint/eslint-plugin-5.20.0

Bump @typescript-eslint/eslint-plugin from 5.18.0 to 5.20.0
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

No branches or pull requests

3 participants