eslint-doc-generator/dist/lib/plugin-config-resolution.js

Automatic documentation generator for ESLint plugins and rules.

import { existsSync } from 'node:fs';
import { importAbs } from './import.js';
/**
 * ESLint configs can extend other configs, so for convenience, let's resolve all the rules in each config upfront.
 */
export async function resolveConfigsToRules(plugin) {
    const configs = {};
    for (const [configName, config] of Object.entries(plugin.configs || {})) {
        configs[configName] = await resolvePotentiallyFlatConfigs(config);
    }
    return configs;
}
/**
 * Check whether the passed config is an array and iterate over it
 */
async function resolvePotentiallyFlatConfigs(potentiallyFlatConfigs) {
    const rules = {};
    if (Array.isArray(potentiallyFlatConfigs)) {
        for (const config of potentiallyFlatConfigs) {
            Object.assign(rules, await resolvePotentiallyFlatConfigs(config));
        }
    }
    else {
        Object.assign(rules, await resolveConfigRules(potentiallyFlatConfigs));
    }
    return rules;
}
/**
 * Recursively gather all the rules from a config that may extend other configs.
 */
async function resolveConfigRules(config) {
    const rules = { ...config.rules };
    if ('overrides' in config && config.overrides) {
        for (const override of config.overrides) {
            Object.assign(rules, override.rules);
            const extendedRulesFromOverride = await resolveConfigExtends(override.extends || []);
            Object.assign(rules, extendedRulesFromOverride);
        }
    }
    if ('extends' in config && config.extends) {
        const extendedRules = await resolveConfigExtends(config.extends);
        Object.assign(rules, extendedRules);
    }
    return rules;
}
async function resolveConfigExtends(extendItems) {
    const rules = {};
    // eslint-disable-next-line unicorn/no-instanceof-builtins -- using Array.isArray() loses type information about the array.
    for (const extend of extendItems instanceof Array
        ? extendItems
        : [extendItems]) {
        if (['plugin:', 'eslint:'].some((prefix) => extend.startsWith(prefix)) ||
            !existsSync(extend)) {
            // Ignore external configs.
            continue;
        }
        const { default: config } = (await importAbs(extend));
        const extendedRules = await resolveConfigRules(config);
        Object.assign(rules, extendedRules);
    }
    return rules;
}