Add URL to rule documentation to the metadata (#184)

Arcanemagus · sindresorhus · commit aa3daae1d62e · 2018-01-21T20:06:27.000+01:00
diff --git a/rules/assertion-arguments.js b/rules/assertion-arguments.js
@@ -149,6 +149,9 @@ const schema = [{
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		},
 		schema
 	}
 };
diff --git a/rules/assertion-message.js b/rules/assertion-message.js
@@ -67,6 +67,9 @@ const schema = [{
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: util.getDocsUrl('assertion-message', '4211212daf1bfcfff3ebc5d4efdc4ba1a87acbf1')
+		},
 		schema,
 		deprecated: true
 	}
diff --git a/rules/max-asserts.js b/rules/max-asserts.js
@@ -61,6 +61,9 @@ const schema = [{
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		},
 		schema
 	}
 };
diff --git a/rules/no-async-fn-without-await.js b/rules/no-async-fn-without-await.js
@@ -1,6 +1,7 @@
 'use strict';
 const visitIf = require('enhance-visitors').visitIf;
 const createAvaRule = require('../create-ava-rule');
+const util = require('../util');
 
 const create = context => {
 	const ava = createAvaRule();
@@ -48,5 +49,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/no-cb-test.js b/rules/no-cb-test.js
@@ -23,5 +23,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/no-duplicate-modifiers.js b/rules/no-duplicate-modifiers.js
@@ -44,5 +44,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/no-identical-title.js b/rules/no-identical-title.js
@@ -61,5 +61,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/no-ignored-test-files.js b/rules/no-ignored-test-files.js
@@ -102,6 +102,9 @@ const schema = [{
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		},
 		schema
 	}
 };
diff --git a/rules/no-invalid-end.js b/rules/no-invalid-end.js
@@ -25,5 +25,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/no-nested-tests.js b/rules/no-nested-tests.js
@@ -1,6 +1,7 @@
 'use strict';
 const visitIf = require('enhance-visitors').visitIf;
 const createAvaRule = require('../create-ava-rule');
+const util = require('../util');
 
 const create = context => {
 	const ava = createAvaRule();
@@ -31,5 +32,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/no-only-test.js b/rules/no-only-test.js
@@ -32,6 +32,9 @@ const create = context => {
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		},
 		fixable: 'code'
 	}
 };
diff --git a/rules/no-skip-assert.js b/rules/no-skip-assert.js
@@ -24,5 +24,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/no-skip-test.js b/rules/no-skip-test.js
@@ -32,6 +32,9 @@ const create = context => {
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		},
 		fixable: 'code'
 	}
 };
diff --git a/rules/no-statement-after-end.js b/rules/no-statement-after-end.js
@@ -1,5 +1,6 @@
 'use strict';
 const createAvaRule = require('../create-ava-rule');
+const util = require('../util');
 
 // This rule makes heavy use of eslints code path analysis
 // See: http://eslint.org/docs/developer-guide/code-path-analysis.html
@@ -91,5 +92,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/no-todo-implementation.js b/rules/no-todo-implementation.js
@@ -23,5 +23,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/no-todo-test.js b/rules/no-todo-test.js
@@ -1,6 +1,7 @@
 'use strict';
 const visitIf = require('enhance-visitors').visitIf;
 const createAvaRule = require('../create-ava-rule');
+const util = require('../util');
 
 const create = context => {
 	const ava = createAvaRule();
@@ -22,5 +23,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/no-unknown-modifiers.js b/rules/no-unknown-modifiers.js
@@ -42,5 +42,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/prefer-async-await.js b/rules/prefer-async-await.js
@@ -1,6 +1,7 @@
 'use strict';
 const visitIf = require('enhance-visitors').visitIf;
 const createAvaRule = require('../create-ava-rule');
+const util = require('../util');
 
 function containsThen(node) {
 	if (!node ||
@@ -49,5 +50,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/prefer-power-assert.js b/rules/prefer-power-assert.js
@@ -3,6 +3,7 @@ const espurify = require('espurify');
 const visitIf = require('enhance-visitors').visitIf;
 const deepStrictEqual = require('deep-strict-equal');
 const createAvaRule = require('../create-ava-rule');
+const util = require('../util');
 
 const notAllowed = [
 	'truthy',
@@ -79,5 +80,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/test-ended.js b/rules/test-ended.js
@@ -1,6 +1,7 @@
 'use strict';
 const visitIf = require('enhance-visitors').visitIf;
 const createAvaRule = require('../create-ava-rule');
+const util = require('../util');
 
 const create = context => {
 	const ava = createAvaRule();
@@ -41,5 +42,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/test-title.js b/rules/test-title.js
@@ -1,6 +1,7 @@
 'use strict';
 const visitIf = require('enhance-visitors').visitIf;
 const createAvaRule = require('../create-ava-rule');
+const util = require('../util');
 
 const create = context => {
 	const ava = createAvaRule();
@@ -42,6 +43,9 @@ const schema = [{
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		},
 		schema
 	}
 };
diff --git a/rules/use-t-well.js b/rules/use-t-well.js
@@ -104,5 +104,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/use-t.js b/rules/use-t.js
@@ -1,6 +1,7 @@
 'use strict';
 const visitIf = require('enhance-visitors').visitIf;
 const createAvaRule = require('../create-ava-rule');
+const util = require('../util');
 
 const create = context => {
 	const ava = createAvaRule();
@@ -33,5 +34,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/use-test.js b/rules/use-test.js
@@ -1,6 +1,7 @@
 'use strict';
 const espurify = require('espurify');
 const deepStrictEqual = require('deep-strict-equal');
+const util = require('../util');
 
 const avaVariableDeclaratorInitAst = {
 	type: 'CallExpression',
@@ -38,5 +39,9 @@ const create = context => ({
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/rules/use-true-false.js b/rules/use-true-false.js
@@ -86,5 +86,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: util.getDocsUrl()
+		}
+	}
 };
diff --git a/test/util.js b/test/util.js
@@ -0,0 +1,17 @@
+import test from 'ava';
+import util from '../util';
+
+test('returns the URL of the a named rule\'s documentation', t => {
+	const url = 'https://github.com/avajs/eslint-plugin-ava/blob/master/docs/rules/foo.md';
+	t.is(util.getDocsUrl('foo'), url);
+});
+
+test('returns the URL of the a named rule\'s documentation at a commit hash', t => {
+	const url = 'https://github.com/avajs/eslint-plugin-ava/blob/bar/docs/rules/foo.md';
+	t.is(util.getDocsUrl('foo', 'bar'), url);
+});
+
+test('determines the rule name from the file', t => {
+	const url = 'https://github.com/avajs/eslint-plugin-ava/blob/master/docs/rules/util.md';
+	t.is(util.getDocsUrl(), url);
+});
diff --git a/util.js b/util.js
@@ -1,5 +1,6 @@
 'use strict';
 const fs = require('fs');
+const path = require('path');
 
 const functionExpressions = [
 	'FunctionExpression',
@@ -95,6 +96,20 @@ const getMembers = node => {
 
 exports.getMembers = getMembers;
 
+const repoUrl = 'https://github.com/avajs/eslint-plugin-ava';
+/**
+ * Return the URL of the rule's documentation, either from parameter or the
+ * requiring file's name.
+ * @param  {String} ruleName The name of the rule to generate a URL for.
+ * @return {String}          The URL of the rule's documentation.
+ */
+const getDocsUrl = (ruleName, commitHash) => {
+	ruleName = ruleName || path.basename(module.parent.filename, '.js');
+	commitHash = commitHash || 'master';
+	return `${repoUrl}/blob/${commitHash}/docs/rules/${ruleName}.md`;
+};
+exports.getDocsUrl = getDocsUrl;
+
 const assertionMethodsNumArguments = new Map([
 	['deepEqual', 2],
 	['fail', 0],
