Linkify rules to ESLint documentation (#33)

Fixes #28

Author: Vadim Demedes

index.js

@@ -5,6 +5,8 @@ const logSymbols = require('log-symbols');
 const plur = require('plur');
 const stringWidth = require('string-width');
 const ansiEscapes = require('ansi-escapes');
+const {supportsHyperlink} = require('supports-hyperlinks');
+const getRuleUrl = require('eslint-rule-docs');
 
 module.exports = results => {
 	const lines = [];
@@ -107,7 +109,8 @@ module.exports = results => {
 				x.severity === 'warning' ? logSymbols.warning : logSymbols.error,
 				' '.repeat(maxLineWidth - x.lineWidth) + chalk.dim(x.line + chalk.gray(':') + x.column),
 				' '.repeat(maxColumnWidth - x.columnWidth) + x.message,
-				' '.repeat(maxMessageWidth - x.messageWidth) + chalk.gray.dim(x.ruleId)
+				' '.repeat(maxMessageWidth - x.messageWidth) +
+				(supportsHyperlink(process.stdout) ? ansiEscapes.link(chalk.dim(x.ruleId), getRuleUrl(x.ruleId).url) : chalk.gray.dim(x.ruleId))
 			];
 
 			if (!showLineNumbers) {

package.json

@@ -29,13 +29,29 @@
 	"dependencies": {
 		"ansi-escapes": "^3.0.0",
 		"chalk": "^2.1.0",
+		"eslint-rule-docs": "^1.1.5",
 		"log-symbols": "^2.0.0",
 		"plur": "^2.1.2",
-		"string-width": "^2.0.0"
+		"string-width": "^2.0.0",
+		"supports-hyperlinks": "^1.0.1"
 	},
 	"devDependencies": {
 		"ava": "*",
 		"strip-ansi": "^4.0.0",
 		"xo": "*"
+	},
+	"ava": {
+		"serial": true
+	},
+	"xo": {
+		"overrides": [
+			{
+				"files": "index.js",
+				"rules": {
+					"prefer-destructuring": 0,
+					"no-else-return": 1
+				}
+			}
+		]
 	}
 }

test/test.js

@@ -1,33 +1,54 @@
 import test from 'ava';
 import stripAnsi from 'strip-ansi';
+import ansiEscapes from 'ansi-escapes';
+import chalk from 'chalk';
 import m from '..';
 import defaultFixture from './fixtures/default';
 import noLineNumbers from './fixtures/no-line-numbers';
 import lineNumbers from './fixtures/line-numbers';
 import sortOrder from './fixtures/sort-by-severity-then-line-then-column';
 
+const enableHyperlinks = () => {
+	process.env.FORCE_HYPERLINK = '1';
+};
+
+const disableHyperlinks = () => {
+	process.env.FORCE_HYPERLINK = '0';
+};
+
 test('output', t => {
+	disableHyperlinks();
 	const output = m(defaultFixture);
 	console.log(output);
 	t.regex(stripAnsi(output), /index\.js:8:2\n/);
 	t.regex(stripAnsi(output), /✖[ ]{3}1:1[ ]{2}AVA should be imported as test.[ ]{6}ava\/use-test/);
 });
 
 test('no line numbers', t => {
+	disableHyperlinks();
 	const output = m(noLineNumbers);
 	console.log(output);
 	t.regex(stripAnsi(output), /index\.js\n/);
 	t.regex(stripAnsi(output), /✖[ ]{2}AVA should be imported as test.[ ]{6}ava\/use-test/);
 });
 
 test('show line numbers', t => {
+	disableHyperlinks();
 	const output = m(lineNumbers);
 	console.log(output);
 	t.regex(stripAnsi(output), /⚠[ ]{3}0:0[ ]{2}Unexpected todo comment.[ ]{13}no-warning-comments/);
 	t.regex(stripAnsi(output), /✖[ ]{3}1:1[ ]{2}AVA should be imported as test.[ ]{6}ava\/use-test/);
 });
 
+test('link rules to documentation when terminal supports links', t => {
+	enableHyperlinks();
+	const output = m(defaultFixture);
+	console.log(output);
+	t.true(output.includes(ansiEscapes.link(chalk.dim('no-warning-comments'), 'https://eslint.org/docs/rules/no-warning-comments')));
+});
+
 test('sort by severity, then line number, then column number', t => {
+	disableHyperlinks();
 	const output = m(sortOrder);
 	const sanitized = stripAnsi(output);
 	const indexes = [
@@ -43,6 +64,7 @@ test('sort by severity, then line number, then column number', t => {
 });
 
 test('display warning total before error total', t => {
+	disableHyperlinks();
 	const output = m(sortOrder);
 	const sanitized = stripAnsi(output);
 	const indexes = [