Chore: Adopt require-meta-docs-url lint rule internally (#128)

* Chore: adopt `eslint-plugin/require-meta-docs-url` lint rule internally

* Chore: Switch rule doc URLs to use HEAD instead of a version tag

Author: bmish

.eslintrc.js

@@ -35,7 +35,13 @@ module.exports = {
       extends: ['plugin:self/all'],
       rules: {
         'self/report-message-format': ['error', '^[^a-z].*.$'],
-        'self/require-meta-docs-url': 'off',
+        'self/require-meta-docs-url': [
+          'error',
+          {
+            pattern:
+              'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/{{name}}.md',
+          },
+        ],
       },
     },
     {

lib/index.js

@@ -13,7 +13,6 @@ const fs = require('fs');
 const path = require('path');
 const packageMetadata = require('../package');
 const PLUGIN_NAME = packageMetadata.name.replace(/^eslint-plugin-/, '');
-const PLUGIN_VERSION = packageMetadata.version;
 
 const configFilters = {
   all: () => true,
@@ -28,26 +27,13 @@ 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 = Object.fromEntries(fs
   .readdirSync(`${__dirname}/rules`)
   .filter(fileName => fileName.endsWith('.js') && /^[^._]/.test(fileName))
   .map(fileName => fileName.replace(/\.js$/, ''))
-  .map(ruleName => [ruleName, loadRule(ruleName)]));
+  .map(ruleName => [ruleName, require(path.join(__dirname, 'rules', ruleName))])
+);
 
 module.exports.rules = allRules;
 

lib/rules/consistent-output.js

@@ -18,6 +18,7 @@ module.exports = {
       description: 'enforce consistent use of `output` assertions in rule tests',
       category: 'Tests',
       recommended: true,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/consistent-output.md',
     },
     fixable: null, // or "code" or "whitespace"
     schema: [

lib/rules/fixer-return.js

@@ -23,6 +23,7 @@ module.exports = {
       description: 'require fixer functions to return a fix',
       category: 'Rules',
       recommended: true,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/fixer-return.md',
     },
     fixable: null,
     schema: [],

lib/rules/meta-property-ordering.js

@@ -17,6 +17,7 @@ module.exports = {
       description: 'enforce the order of meta properties',
       category: 'Rules',
       recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/meta-property-ordering.md',
     },
     fixable: 'code',
     schema: [{

lib/rules/no-deprecated-context-methods.js

@@ -41,6 +41,7 @@ module.exports = {
       description: 'disallow usage of deprecated methods on rule context objects',
       category: 'Rules',
       recommended: true,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-deprecated-context-methods.md',
     },
     fixable: 'code',
     schema: [],

lib/rules/no-deprecated-report-api.js

@@ -18,6 +18,7 @@ module.exports = {
       description: 'disallow the version of `context.report()` with multiple arguments',
       category: 'Rules',
       recommended: true,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-deprecated-report-api.md',
     },
     fixable: 'code', // or "code" or "whitespace"
     schema: [],

lib/rules/no-identical-tests.js

@@ -18,6 +18,7 @@ module.exports = {
       description: 'disallow identical tests',
       category: 'Tests',
       recommended: true,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-identical-tests.md',
     },
     fixable: 'code',
     schema: [],

lib/rules/no-missing-placeholders.js

@@ -19,6 +19,7 @@ module.exports = {
       description: 'disallow missing placeholders in rule report messages',
       category: 'Rules',
       recommended: true,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-missing-placeholders.md',
     },
     fixable: null,
     schema: [],

lib/rules/no-only-tests.js

@@ -10,6 +10,7 @@ module.exports = {
       description: 'disallow the test case property `only`',
       category: 'Tests',
       recommended: true,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-only-tests.md',
     },
     hasSuggestions: true,
     schema: [],