Links in output

Atom’s linter-eslint project holds a list of plugin and plugin rules documentation location pair (see https://github.com/AtomLinter/linter-eslint/blob/master/lib/helpers.js#L72-L104). Basically: "For eslint plugin X, the documentation for every rule is in https://github.com/Gillespie59/eslint-plugin-X/blob/master/docs/' + ruleName + '.md'.

What do use it for, is at the location where errors are shown, to have a clickable link that opens the browser with the documentation page of that link, which allows you to easily read more about the rule and/or the problem it points out. (in the following screenshot, no-undef is clickable)

A while ago, I thought about moving this project to its own repo (that I discussed in one of the points here), and the creators thought it could be a good idea.

I now thought that this could be pretty useful here. Behind an option, there could be new list formatted like this:

accessor-pairs http://eslint.org/docs/rules/accessor-pairs
array-bracket-spacing http://eslint.org/docs/rules/array-bracket-spacing
array-callback-return http://eslint.org/docs/rules/array-callback-return

import/order https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/order.md

which would be clickable in the terminal (hopefully in most terminals, otherwise it’s copy-pastable, which is still nice), and allow you to quickly find out about a rule.

Right now, I’m wondering whether you’d be interested by this functionality. And if so, I’ll be more interested in working on the new repository the plugins (and maybe even integrate it here) 😃 What do you think?

FYI: Currently, as that “list” works, every link for an unknown plugin will redirect to a page to help register it.

[sarbbottam]

looks good 👍

[jfmengels]

Yes, it’s too verbose to be there by default.