Add links to rule explanations?

[wmertens]

Not sure if this is possible, but it would be nice to be able to go to a rule definition (like the github issue or eslint docs) when eslint marks something.

So if I see no-use-extend-native it somehow links to https://github.com/dustinspecker/eslint-plugin-no-use-extend-native/blob/master/readme.md

[SamVerschueren]

That would really be a very nice addition. It can be opened when using Cmd + click or something.

I guess it would be easier to implement if we redirect to the npm webpage. For instance to https://www.npmjs.com/package/eslint-plugin-no-use-extend-native. This way we don't have to fetch the repository of that rule. We can start with implementing this and if it looks like it's not enough, we can always improve on that by caching ruleId + GH repo. What do you think?

I'm not entirely sure if this can be implemented in an extension though.

@bpasero Care to chime in?

[darkred]

The ability to add links to diagnostic errors has been added to VSCode since v1.42 (Jan 2020) : see here.

E.g. here is a screenshot of how the related rules of the problems are rendered by this extension vs the ESLint one:

[spence-s]

I currently have this as a WIP - along with other features mentioned in the roadmap. This particular feature needs a patch in xo and also needs some good internal caching strategies to ensure performance. So its just a matter of finding the time. PRs welcome!

[spence-s]

After doing some further research on this - I found that xo primarily relies on the package https://www.npmjs.com/package/eslint-rule-docs which I am using to add rule definition links as well. No need to add this directly to xo.