Expose rule documentation link in the API

[silvenon]

Hi, my idea is to do whatever is necessary to make biomejs/biome-zed#58 possible. It would be nice for extensions to provide a way to link to rules so that we can read how to solve the problems that are underlined. It's faster than searching the docs.

[ematipico]

We already have that information. However I don't know how to create an action that opens a link.

If you're able to provide some code example in the wild, we might be able to implement it

[ematipico]

I suspect zed extension uses the same LSP server that the VScode extension uses. Or I might be wrong

[silvenon]

You might be right, I couldn't find a trace of such an implementation in Zed's codebase anywhere.

[silvenon]

So I guess you can close this if it's a duplicate of something else that was already reported.

[ematipico]

I think it's just a matter of checking how the eslint LSP does that.

When you have time and if you want to help, you could check its codebase and find how they implement it

[silvenon]

I may give it a shot because it sounds like an opportunity to learn something about LSPs. Thankfully it's just a nice-to-have so I don't feel pressure to succeed.

[ematipico]

I am going to close this. Our LSP already supports providing links when printing a diagnostic, check the screenshot from VSCode, the biome(lint/style/useConst) is actually a link to the documentation page.

If zed doesn't show it, that's because it doesn't support it yet, so you could ask for a feature request.

[silvenon]

Yeah, that popup looks way better than what Zed shows, and if VS Code can do it, Zed should too, eventually.

If I find anything out I'll submit a PR wherever.