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

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

import { truncateDescription, truncateTitle } from '@code-pushup/utils';
import { ruleToSlug } from './hash.js';
export function ruleToAudit(rule) {
    const name = rule.id.split('/').at(-1) ?? rule.id;
    const plugin = name === rule.id ? null : rule.id.slice(0, rule.id.lastIndexOf('/'));
    const pluginContext = plugin ? `, from _${plugin}_ plugin` : '';
    const lines = [
        `ESLint rule **${name}**${pluginContext}.`,
        ...(rule.options?.length ? ['Custom options:'] : []),
        ...(rule.options?.map(option => ['```json', JSON.stringify(option, null, 2), '```'].join('\n')) ?? []),
    ];
    return {
        slug: ruleToSlug(rule),
        title: truncateTitle(rule.meta.docs?.description ?? name),
        description: truncateDescription(lines.join('\n\n')),
        ...(rule.meta.docs?.url && {
            docsUrl: rule.meta.docs.url,
        }),
    };
}
//# sourceMappingURL=transform.js.map