Update: add meta.docs.url to rules

(closes #54)

Author: not-an-aardvark

lib/index.js

@@ -11,7 +11,9 @@
 
 const fs = require('fs');
 const path = require('path');
-const PLUGIN_NAME = require('../package').name.replace(/^eslint-plugin-/, '');
+const packageMetadata = require('../package');
+const PLUGIN_NAME = packageMetadata.name.replace(/^eslint-plugin-/, '');
+const PLUGIN_VERSION = packageMetadata.version;
 
 const configFilters = {
   all: () => true,
@@ -26,13 +28,26 @@ const configFilters = {
 // Plugin Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * Loads a given rule from the filesystem and generates its documentation URL
+ * @param {string} ruleName The name of the rule
+ * @returns {Rule} The ESLint rule to export
+ */
+function loadRule (ruleName) {
+  const rule = require(path.join(__dirname, 'rules', ruleName));
+
+  rule.meta.docs.url =
+    `https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v${PLUGIN_VERSION}/docs/rules/${ruleName}.md`;
+
+  return rule;
+}
 
 // import all rules in lib/rules
 const allRules = fs
   .readdirSync(`${__dirname}/rules`)
   .filter(fileName => fileName.endsWith('.js') && /^[^._]/.test(fileName))
   .map(fileName => fileName.replace(/\.js$/, ''))
-  .reduce((rules, ruleName) => Object.assign(rules, { [ruleName]: require(path.join(__dirname, 'rules', ruleName)) }), {});
+  .reduce((rules, ruleName) => Object.assign(rules, { [ruleName]: loadRule(ruleName) }), {});
 
 module.exports.rules = allRules;
 

tests/lib/index.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const assert = require('chai').assert;
+const plugin = require('../..');
+
+describe('exported plugin', () => {
+  describe('adds a meta.docs.url property to each rule', () => {
+    Object.keys(plugin.rules).forEach(ruleName => {
+      it(ruleName, () => {
+        assert.match(
+          plugin.rules[ruleName].meta.docs.url,
+          /^https:\/\/github.com\/not-an-aardvark\/eslint-plugin-eslint-plugin\/tree\/v\d+\.\d+\.\d+\/docs\/rules\/[\w-]+\.md$/
+        );
+      });
+    });
+  });
+});