index.js

/**
 * @fileoverview Allows a local ESLint rules directory to be used without a command-line flag
 * @author Teddy Katz
 */

'use strict';

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

const fs = require('fs');
const path = require('path');

//------------------------------------------------------------------------------
// Plugin Definition
//------------------------------------------------------------------------------

const cache = {};

const ruleExtensions = new Set(['.js', '.cjs', '.mjs', '.ts', '.cts', '.mts']);

module.exports = {
  get rules() {
    const RULES_DIR = module.exports.RULES_DIR;
    if (typeof module.exports.RULES_DIR !== 'string' && !Array.isArray(RULES_DIR)) {
      throw new Error('To use eslint-plugin-rulesdir, you must load it beforehand and set the `RULES_DIR` property on the module to a string or an array of strings.');
    }
    const cacheKey = JSON.stringify(RULES_DIR);
    if (!cache[cacheKey]) {
      const rules = Array.isArray(RULES_DIR) ? RULES_DIR : [RULES_DIR];
      const rulesObject = {};
      rules.forEach((rulesDir) => {
        if (!fs.existsSync(rulesDir)) return;
        fs.readdirSync(rulesDir, { withFileTypes: true })
          .forEach((entry) => {
            const absolutePath = path.resolve(rulesDir, entry.name);
            const ruleName = path.basename(absolutePath, path.extname(absolutePath));
            if (rulesObject[ruleName]) {
              throw new Error(`eslint-plugin-rulesdir found two rules with the same name: ${ruleName}`);
            }
            if (entry.isFile()) {
              if (!ruleExtensions.has(path.extname(entry.name))) return;
              if (entry.name.endsWith('.d.ts')) return;
              rulesObject[ruleName] = require(absolutePath);
            }
            if (entry.isDirectory()) {
              const [index] = fs.readdirSync(absolutePath, { withFileTypes: true })
                .filter(subentry => subentry.isFile())
                .filter(subentry => subentry.name.startsWith('index.'))
                .filter(subentry => ruleExtensions.has(path.extname(subentry.name)))
                .filter(subentry => !subentry.name.endsWith('.d.ts'))
                .map(subentry => path.resolve(absolutePath, subentry.name));
              if (index) {
                try {
                  rulesObject[ruleName] = require(path.resolve(absolutePath, index));
                } catch (err) {
                  // Skip unrelated directories
                }
              }
            }
          });
      });
      cache[cacheKey] = rulesObject;
    }
    return cache[cacheKey];
  },
};