@code-pushup/eslint-plugin/src/lib/eslint-plugin.js

Code PushUp plugin for detecting problems in source code using ESLint.📋

import { createRequire } from 'node:module';
import { validate } from '@code-pushup/models';
import { eslintPluginConfigSchema, eslintPluginOptionsSchema, } from './config.js';
import { ESLINT_PLUGIN_SLUG, ESLINT_PLUGIN_TITLE } from './constants.js';
import { listAuditsAndGroups } from './meta/list.js';
import { createRunnerFunction } from './runner/runner.js';
/**
 * Instantiates Code PushUp ESLint plugin for use in core config.
 *
 * @example
 * import eslintPlugin from '@code-pushup/eslint-plugin'
 *
 * export default {
 *   // ... core config ...
 *   plugins: [
 *     // ... other plugins ...
 *     await eslintPlugin({
 *       eslintrc: '.eslintrc.json',
 *       patterns: ['src', 'test/*.spec.js']
 *     })
 *   ]
 * }
 *
 * @param config Configuration options.
 * @param options Optional settings for customizing the plugin behavior.
 * @returns Plugin configuration as a promise.
 */
export async function eslintPlugin(config, options) {
    const targets = validate(eslintPluginConfigSchema, config);
    const { groups: customGroups, artifacts, scoreTargets, } = options ? validate(eslintPluginOptionsSchema, options) : {};
    const { audits, groups } = await listAuditsAndGroups(targets, customGroups);
    const packageJson = createRequire(import.meta.url)('../../package.json');
    return {
        slug: ESLINT_PLUGIN_SLUG,
        title: ESLINT_PLUGIN_TITLE,
        icon: 'eslint',
        description: 'Official Code PushUp ESLint plugin',
        docsUrl: 'https://www.npmjs.com/package/@code-pushup/eslint-plugin',
        packageName: packageJson.name,
        version: packageJson.version,
        audits,
        groups,
        runner: createRunnerFunction({
            audits,
            targets,
            ...(artifacts ? { artifacts } : {}),
        }),
        ...(scoreTargets && { scoreTargets }),
    };
}
//# sourceMappingURL=eslint-plugin.js.map