Function ruleToAudit

packages/plugin-eslint/src/lib/meta/transform.ts:6–28

(rule: RuleData)

import type { RuleData } from './parse.js';

export function ruleToAudit(rule: RuleData): Audit {
  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: string[] = [
    `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,
    }),
  };
}