chore: adopt require-meta-docs-url lint rule internally

Author: bmish

.eslintrc.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const version = require('./package.json').version;
+
 module.exports = {
   root: true,
   plugins: ['node', 'self'],
@@ -20,8 +22,14 @@ module.exports = {
     'require-jsdoc': 'error',
 
     'self/meta-property-ordering': 'off',
-    'self/require-meta-docs-url': 'off',
     'self/report-message-format': ['error', '^[^a-z].*.$'],
+    'self/require-meta-docs-url': [
+      'error',
+      {
+        pattern:
+          `https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v${version}/docs/rules/{{name}}.md`,
+      },
+    ],
   },
   overrides: [
     {

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,12 @@ 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]: loadRule(ruleName) }), {});
+  .reduce((rules, ruleName) => Object.assign(rules, { [ruleName]: require(path.join(__dirname, 'rules', ruleName)) }), {});
 
 module.exports.rules = allRules;
 

lib/rules/consistent-output.js

@@ -17,6 +17,7 @@ module.exports = {
       description: 'enforce consistent use of output assertions in rule tests',
       category: 'Tests',
       recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/consistent-output.md',
     },
     type: 'suggestion',
     fixable: null, // or "code" or "whitespace"

lib/rules/fixer-return.js

@@ -21,6 +21,7 @@ module.exports = {
       description: 'require fixer function to always return a value.',
       category: 'Possible Errors',
       recommended: true,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/fixer-return.md',
     },
     type: 'problem',
     fixable: null,

lib/rules/meta-property-ordering.js

@@ -16,6 +16,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/v3.0.3/docs/rules/meta-property-ordering.md',
     },
     type: 'suggestion',
     fixable: 'code',

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

@@ -40,6 +40,7 @@ module.exports = {
       description: 'disallow usage of deprecated methods on rule context objects',
       category: 'Rules',
       recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/no-deprecated-context-methods.md',
     },
     type: 'suggestion',
     fixable: 'code',

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

@@ -17,6 +17,7 @@ module.exports = {
       description: 'disallow use of the deprecated context.report() API',
       category: 'Rules',
       recommended: true,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/no-deprecated-report-api.md',
     },
     type: 'suggestion',
     fixable: 'code', // or "code" or "whitespace"

lib/rules/no-identical-tests.js

@@ -17,6 +17,7 @@ module.exports = {
       description: 'disallow identical tests',
       category: 'Tests',
       recommended: true,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/no-identical-tests.md',
     },
     type: 'problem',
     fixable: 'code',

lib/rules/no-missing-placeholders.js

@@ -17,6 +17,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/v3.0.3/docs/rules/no-missing-placeholders.md',
     },
     type: 'problem',
     fixable: null,

lib/rules/no-unused-placeholders.js

@@ -17,6 +17,7 @@ module.exports = {
       description: 'disallow unused placeholders in rule report messages',
       category: 'Rules',
       recommended: true,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/no-unused-placeholders.md',
     },
     type: 'problem',
     fixable: null,

lib/rules/no-useless-token-range.js

@@ -17,6 +17,7 @@ module.exports = {
       description: 'disallow unnecessary calls to sourceCode.getFirstToken and sourceCode.getLastToken',
       category: 'Rules',
       recommended: true,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/no-useless-token-range.md',
     },
     type: 'suggestion',
     fixable: 'code',

lib/rules/prefer-object-rule.js

@@ -16,6 +16,7 @@ module.exports = {
       description: 'disallow rule exports where the export is a function.',
       category: 'Rules',
       recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/prefer-object-rule.md',
     },
     messages: {
       preferObject: 'Rules should be declared using the object style.',

lib/rules/prefer-output-null.js

@@ -17,6 +17,7 @@ module.exports = {
       description: 'disallow invalid RuleTester test cases with the output the same as the code.',
       category: 'Tests',
       recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/prefer-output-null.md',
     },
     type: 'suggestion',
     fixable: 'code',

lib/rules/prefer-placeholders.js

@@ -17,6 +17,7 @@ module.exports = {
       description: 'disallow template literals as report messages',
       category: 'Rules',
       recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/prefer-placeholders.md',
     },
     type: 'suggestion',
     fixable: null,

lib/rules/prefer-replace-text.js

@@ -17,6 +17,7 @@ module.exports = {
       description: 'require using replaceText instead of replaceTextRange.',
       category: 'Rules',
       recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/prefer-replace-text.md',
     },
     type: 'suggestion',
     fixable: null,

lib/rules/report-message-format.js

@@ -17,6 +17,7 @@ module.exports = {
       description: 'enforce a consistent format for rule report messages',
       category: 'Rules',
       recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/report-message-format.md',
     },
     type: 'suggestion',
     fixable: null,

lib/rules/require-meta-docs-description.js

@@ -14,7 +14,8 @@ module.exports = {
     docs: {
       description: 'require rules to implement a meta.docs.description property with the correct format',
       category: 'Rules',
-      recommended: false, // TODO: enable it in a major release.
+      recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/require-meta-docs-description.md', // TODO: enable it in a major release.
     },
     type: 'suggestion',
     fixable: null,

lib/rules/require-meta-docs-url.js

@@ -21,6 +21,7 @@ module.exports = {
       description: 'require rules to implement a meta.docs.url property',
       category: 'Rules',
       recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/require-meta-docs-url.md',
     },
     type: 'suggestion',
     fixable: 'code',

lib/rules/require-meta-fixable.js

@@ -17,6 +17,7 @@ module.exports = {
       description: 'require rules to implement a meta.fixable property',
       category: 'Rules',
       recommended: true,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/require-meta-fixable.md',
     },
     type: 'problem',
     schema: [],

lib/rules/require-meta-has-suggestions.js

@@ -13,6 +13,7 @@ module.exports = {
       description: 'require suggestable rules to implement a `meta.hasSuggestions` property',
       category: 'Rules',
       recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/require-meta-has-suggestions.md',
     },
     type: 'problem',
     messages: {

lib/rules/require-meta-schema.js

@@ -12,7 +12,8 @@ module.exports = {
     docs: {
       description: 'require rules to implement a meta.schema property',
       category: 'Rules',
-      recommended: false, // TODO: enable it in a major release.
+      recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/require-meta-schema.md', // TODO: enable it in a major release.
     },
     type: 'suggestion',
     fixable: 'code',

lib/rules/require-meta-type.js

@@ -17,7 +17,8 @@ module.exports = {
     docs: {
       description: 'require rules to implement a meta.type property',
       category: 'Rules',
-      recommended: false, // TODO: enable it in a major release.
+      recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/require-meta-type.md', // TODO: enable it in a major release.
     },
     type: 'problem',
     fixable: null,

lib/rules/test-case-property-ordering.js

@@ -17,6 +17,7 @@ module.exports = {
       description: 'require the properties of a test case to be placed in a consistent order',
       category: 'Tests',
       recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/test-case-property-ordering.md',
     },
     type: 'suggestion',
     fixable: 'code',

lib/rules/test-case-shorthand-strings.js

@@ -17,6 +17,7 @@ module.exports = {
       description: 'enforce consistent usage of shorthand strings for test cases with no options',
       category: 'Tests',
       recommended: false,
+      url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v3.0.3/docs/rules/test-case-shorthand-strings.md',
     },
     type: 'suggestion',
     schema: [{ enum: ['as-needed', 'never', 'consistent', 'consistent-as-needed'] }],