index.js

/**
 * @fileoverview An ESLint plugin for linting ESLint plugins
 * @author Teddy Katz
 */

'use strict';

// ------------------------------------------------------------------------------
// Requirements
// ------------------------------------------------------------------------------

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,
  recommended: rule => rule.meta.docs.recommended,
  rules: rule => rule.meta.docs.category === 'Rules',
  tests: rule => rule.meta.docs.category === 'Tests',
  'rules-recommended': rule => configFilters.recommended(rule) && configFilters.rules(rule),
  'tests-recommended': rule => configFilters.recommended(rule) && configFilters.tests(rule),
};

// ------------------------------------------------------------------------------
// 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) }), {});

module.exports.rules = allRules;

module.exports.configs = Object.keys(configFilters).reduce((configs, configName) => {
  return Object.assign(configs, {
    [configName]: {
      rules: Object.keys(allRules)
        .filter(ruleName => configFilters[configName](allRules[ruleName]))
        .reduce((rules, ruleName) => Object.assign(rules, { [`${PLUGIN_NAME}/${ruleName}`]: 'error' }), {}),
    },
  });
}, {});