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

Make diagnostic code link to linter rule doc in IDE #4141

Merged
merged 3 commits into from
Aug 12, 2024

Conversation

timotheeguerin
Copy link
Member

Saw that eslint extension was doing this. Part solution to #3043 which could also provide an explicit Open documentation Url command

image

For now all the API that gives that is limited to linter as other diagnostic cannot define a url. Due to this limited usage I left the API internal. The goal would be that any diagnostic can define a documentation url and connect to this.

@azure-sdk
Copy link
Collaborator

azure-sdk commented Aug 12, 2024

All changed packages have been documented.

  • @typespec/compiler
Show changes

@typespec/compiler - feature ✏️

Diagnostic code in IDE now link to the linter rule documentation url if applicable

@azure-sdk
Copy link
Collaborator

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

@timotheeguerin timotheeguerin added this pull request to the merge queue Aug 12, 2024
Merged via the queue into microsoft:main with commit 95ef4c3 Aug 12, 2024
22 checks passed
@timotheeguerin timotheeguerin deleted the lsp-diag-url branch August 12, 2024 16:11
sarangan12 pushed a commit to sarangan12/typespec that referenced this pull request Sep 16, 2024
Saw that eslint extension was doing this. Part solution to
microsoft#3043 which could also
provide an explicit `Open documentation Url` command

<img width="568" alt="image"
src="https://github.com/user-attachments/assets/c3a322d2-17c7-45d9-962c-028c1e9cc93c">

For now all the API that gives that is limited to linter as other
diagnostic cannot define a url. Due to this limited usage I left the API
internal. The goal would be that any diagnostic can define a
documentation url and connect to this.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compiler:core Issues for @typespec/compiler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants