Function groupsFromRuleCategories

packages/plugin-eslint/src/lib/meta/groups.ts:60–91

(rules: RuleData[])

}

export function groupsFromRuleCategories(rules: RuleData[]): Group[] {
  const categoriesMap = rules.reduce<Record<string, Record<string, string[]>>>(
    (acc, rule) => {
      // meta.docs.category still used by some popular plugins (e.g. import, react, functional)
      const category = rule.meta.docs?.category;
      if (!category) {
        return acc;
      }
      const { plugin = '' } = parseRuleId(rule.id);
      return {
        ...acc,
        [plugin]: {
          ...acc[plugin],
          [category]: [...(acc[plugin]?.[category] ?? []), ruleToSlug(rule)],
        },
      };
    },
    {},
  );

  const groups = Object.entries(categoriesMap).flatMap(([plugin, categories]) =>
    Object.entries(categories).map(
      ([category, slugs]): Group => ({
        slug: `${slugify(plugin)}-${slugify(category)}`,
        title: `${category} (${plugin})`,
        refs: slugs.map(slug => ({ slug, weight: 1 })),
      }),
    ),
  );

  return groups.toSorted((a, b) => a.slug.localeCompare(b.slug));
}

export function groupsFromCustomConfig(
  rules: RuleData[],