@code-pushup/eslint-plugin 0.56.0 → 0.58.0

package/README.md

@@ -93,6 +93,42 @@ Detected ESLint rules are mapped to Code PushUp audits. Audit reports are calcul
 
 5. Run the CLI with `npx code-pushup collect` and view or upload report (refer to [CLI docs](../cli/README.md)).
 
+### Custom groups
+
+You can extend the plugin configuration with custom groups to categorize ESLint rules according to your project's specific needs. Custom groups allow you to assign weights to individual rules, influencing their impact on the report. Rules can be defined as an object with explicit weights or as an array where each rule defaults to a weight of 1. Additionally, you can use wildcard patterns (`*`) to include multiple rules with similar prefixes.
+
+```js
+import eslintPlugin from '@code-pushup/eslint-plugin';
+
+export default {
+  // ...
+  plugins: [
+    // ...
+    await eslintPlugin(
+      { eslintrc: '.eslintrc.js', patterns: ['src/**/*.js'] },
+      {
+        groups: [
+          {
+            slug: 'modern-angular',
+            title: 'Modern Angular',
+            rules: {
+              '@angular-eslint/template/prefer-control-flow': 3,
+              '@angular-eslint/template/prefer-ngsrc': 2,
+              '@angular-eslint/component-selector': 1,
+            },
+          },
+          {
+            slug: 'type-safety',
+            title: 'Type safety',
+            rules: ['@typescript-eslint/no-unsafe-*'],
+          },
+        ],
+      },
+    ),
+  ],
+};
+```
+
 ### Optionally set up categories
 
 1. Reference audits (or groups) which you wish to include in custom categories (use `npx code-pushup print-config` to list audits and groups).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/eslint-plugin",
-  "version": "0.56.0",
+  "version": "0.58.0",
   "license": "MIT",
   "description": "Code PushUp plugin for detecting problems in source code using ESLint.📋",
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/plugin-eslint#readme",
@@ -37,11 +37,10 @@
     "access": "public"
   },
   "type": "module",
-  "main": "./index.js",
-  "types": "./src/index.d.ts",
   "dependencies": {
-    "@code-pushup/utils": "0.56.0",
-    "@code-pushup/models": "0.56.0",
+    "@code-pushup/utils": "0.58.0",
+    "@code-pushup/models": "0.58.0",
+    "yargs": "^17.7.2",
     "zod": "^3.22.4"
   },
   "peerDependencies": {
@@ -52,5 +51,8 @@
     "@nx/devkit": {
       "optional": true
     }
-  }
-}
+  },
+  "module": "./src/index.js",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts"
+}

package/src/bin.js

@@ -0,0 +1,6 @@
+import process from 'node:process';
+import { Parser } from 'yargs/helpers';
+import { executeRunner } from './lib/runner/index.js';
+const { runnerConfigPath, runnerOutputPath } = Parser(process.argv);
+await executeRunner({ runnerConfigPath, runnerOutputPath });
+//# sourceMappingURL=bin.js.map

package/src/bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../../../../packages/plugin-eslint/src/bin.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEpE,MAAM,aAAa,CAAC,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAC,CAAC"}

package/src/index.d.ts

@@ -1,4 +1,4 @@
-import { eslintPlugin } from './lib/eslint-plugin';
+import { eslintPlugin } from './lib/eslint-plugin.js';
 export default eslintPlugin;
-export type { ESLintPluginConfig } from './lib/config';
-export { eslintConfigFromNxProjectAndDeps, eslintConfigFromNxProjects, eslintConfigFromAllNxProjects, eslintConfigFromNxProject, } from './lib/nx';
+export type { ESLintPluginConfig } from './lib/config.js';
+export { eslintConfigFromAllNxProjects, eslintConfigFromNxProject, eslintConfigFromNxProjectAndDeps, eslintConfigFromNxProjects, } from './lib/nx/index.js';

package/src/index.js

@@ -0,0 +1,4 @@
+import { eslintPlugin } from './lib/eslint-plugin.js';
+export default eslintPlugin;
+export { eslintConfigFromAllNxProjects, eslintConfigFromNxProject, eslintConfigFromNxProjectAndDeps, eslintConfigFromNxProjects, } from './lib/nx/index.js';
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/plugin-eslint/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD,eAAe,YAAY,CAAC;AAI5B,OAAO,EACL,6BAA6B,EAC7B,yBAAyB,EACzB,gCAAgC,EAChC,0BAA0B,GAC3B,MAAM,mBAAmB,CAAC"}

package/src/lib/config.d.ts

@@ -61,3 +61,62 @@ export type ESLintPluginRunnerConfig = {
     targets: ESLintTarget[];
     slugs: string[];
 };
+declare const customGroupSchema: z.ZodObject<{
+    slug: z.ZodString;
+    title: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    docsUrl: z.ZodOptional<z.ZodString>;
+    rules: z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodNumber>, Record<string, number>, Record<string, number>>]>;
+}, "strip", z.ZodTypeAny, {
+    slug: string;
+    title: string;
+    rules: string[] | Record<string, number>;
+    description?: string | undefined;
+    docsUrl?: string | undefined;
+}, {
+    slug: string;
+    title: string;
+    rules: string[] | Record<string, number>;
+    description?: string | undefined;
+    docsUrl?: string | undefined;
+}>;
+export type CustomGroup = z.infer<typeof customGroupSchema>;
+export declare const eslintPluginOptionsSchema: z.ZodObject<{
+    groups: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        slug: z.ZodString;
+        title: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        docsUrl: z.ZodOptional<z.ZodString>;
+        rules: z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodNumber>, Record<string, number>, Record<string, number>>]>;
+    }, "strip", z.ZodTypeAny, {
+        slug: string;
+        title: string;
+        rules: string[] | Record<string, number>;
+        description?: string | undefined;
+        docsUrl?: string | undefined;
+    }, {
+        slug: string;
+        title: string;
+        rules: string[] | Record<string, number>;
+        description?: string | undefined;
+        docsUrl?: string | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    groups?: {
+        slug: string;
+        title: string;
+        rules: string[] | Record<string, number>;
+        description?: string | undefined;
+        docsUrl?: string | undefined;
+    }[] | undefined;
+}, {
+    groups?: {
+        slug: string;
+        title: string;
+        rules: string[] | Record<string, number>;
+        description?: string | undefined;
+        docsUrl?: string | undefined;
+    }[] | undefined;
+}>;
+export type ESLintPluginOptions = z.infer<typeof eslintPluginOptionsSchema>;
+export {};

package/src/lib/config.js

@@ -0,0 +1,40 @@
+import { z } from 'zod';
+import { toArray } from '@code-pushup/utils';
+const patternsSchema = z.union([z.string(), z.array(z.string()).min(1)], {
+    description: 'Lint target files. May contain file paths, directory paths or glob patterns',
+});
+const eslintrcSchema = z.string({ description: 'Path to ESLint config file' });
+const eslintTargetObjectSchema = z.object({
+    eslintrc: eslintrcSchema.optional(),
+    patterns: patternsSchema,
+});
+export const eslintTargetSchema = z
+    .union([patternsSchema, eslintTargetObjectSchema])
+    .transform((target) => typeof target === 'string' || Array.isArray(target)
+    ? { patterns: target }
+    : target);
+export const eslintPluginConfigSchema = z
+    .union([eslintTargetSchema, z.array(eslintTargetSchema).min(1)])
+    .transform(toArray);
+const customGroupRulesSchema = z.union([
+    z
+        .array(z.string())
+        .min(1, 'Custom group rules must contain at least 1 element'),
+    z.record(z.string(), z.number()).refine(schema => Object.keys(schema).length > 0, () => ({
+        code: 'too_small',
+        message: 'Custom group rules must contain at least 1 element',
+    })),
+], {
+    description: 'Array of rule IDs with equal weights or object mapping rule IDs to specific weights',
+});
+const customGroupSchema = z.object({
+    slug: z.string({ description: 'Unique group identifier' }),
+    title: z.string({ description: 'Group display title' }),
+    description: z.string({ description: 'Group metadata' }).optional(),
+    docsUrl: z.string({ description: 'Group documentation site' }).optional(),
+    rules: customGroupRulesSchema,
+});
+export const eslintPluginOptionsSchema = z.object({
+    groups: z.array(customGroupSchema).optional(),
+});
+//# sourceMappingURL=config.js.map

package/src/lib/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../../packages/plugin-eslint/src/lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;IACvE,WAAW,EACT,6EAA6E;CAChF,CAAC,CAAC;AAEH,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,4BAA4B,EAAE,CAAC,CAAC;AAE/E,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,QAAQ,EAAE,cAAc,CAAC,QAAQ,EAAE;IACnC,QAAQ,EAAE,cAAc;CACzB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,KAAK,CAAC,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC;KACjD,SAAS,CACR,CAAC,MAAM,EAAsB,EAAE,CAC7B,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;IACjD,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE;IACtB,CAAC,CAAC,MAAM,CACb,CAAC;AAGJ,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,KAAK,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KAC/D,SAAS,CAAC,OAAO,CAAC,CAAC;AAQtB,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CACpC;IACE,CAAC;SACE,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,GAAG,CAAC,CAAC,EAAE,oDAAoD,CAAC;IAC/D,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CACrC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,EACxC,GAAG,EAAE,CAAC,CAAC;QACL,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,oDAAoD;KAC9D,CAAC,CACH;CACF,EACD;IACE,WAAW,EACT,qFAAqF;CACxF,CACF,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,yBAAyB,EAAE,CAAC;IAC1D,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,qBAAqB,EAAE,CAAC;IACvD,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC,CAAC,QAAQ,EAAE;IACnE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,0BAA0B,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzE,KAAK,EAAE,sBAAsB;CAC9B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE;CAC9C,CAAC,CAAC"}

package/src/lib/eslint-plugin.d.ts

@@ -1,5 +1,5 @@
 import type { PluginConfig } from '@code-pushup/models';
-import { type ESLintPluginConfig } from './config';
+import { type ESLintPluginConfig, type ESLintPluginOptions } from './config.js';
 /**
  * Instantiates Code PushUp ESLint plugin for use in core config.
  *
@@ -18,6 +18,7 @@ import { type ESLintPluginConfig } from './config';
  * }
  *
  * @param config Configuration options.
+ * @param options Optional settings for customizing the plugin behavior.
  * @returns Plugin configuration as a promise.
  */
-export declare function eslintPlugin(config: ESLintPluginConfig): Promise<PluginConfig>;
+export declare function eslintPlugin(config: ESLintPluginConfig, options?: ESLintPluginOptions): Promise<PluginConfig>;

package/src/lib/eslint-plugin.js

@@ -0,0 +1,54 @@
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { parseSchema } from '@code-pushup/utils';
+import { eslintPluginConfigSchema, eslintPluginOptionsSchema, } from './config.js';
+import { listAuditsAndGroups } from './meta/index.js';
+import { createRunnerConfig } from './runner/index.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 = parseSchema(eslintPluginConfigSchema, config, {
+        schemaType: 'ESLint plugin config',
+    });
+    const customGroups = options
+        ? parseSchema(eslintPluginOptionsSchema, options, {
+            schemaType: 'ESLint plugin options',
+        }).groups
+        : undefined;
+    const { audits, groups } = await listAuditsAndGroups(targets, customGroups);
+    const runnerScriptPath = path.join(fileURLToPath(path.dirname(import.meta.url)), '..', 'bin.js');
+    const packageJson = createRequire(import.meta.url)('../../package.json');
+    return {
+        slug: 'eslint',
+        title: 'ESLint',
+        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: await createRunnerConfig(runnerScriptPath, audits, targets),
+    };
+}
+//# sourceMappingURL=eslint-plugin.js.map

package/src/lib/eslint-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eslint-plugin.js","sourceRoot":"","sources":["../../../../../packages/plugin-eslint/src/lib/eslint-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAGL,wBAAwB,EACxB,yBAAyB,GAC1B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAA0B,EAC1B,OAA6B;IAE7B,MAAM,OAAO,GAAG,WAAW,CAAC,wBAAwB,EAAE,MAAM,EAAE;QAC5D,UAAU,EAAE,sBAAsB;KACnC,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,OAAO;QAC1B,CAAC,CAAC,WAAW,CAAC,yBAAyB,EAAE,OAAO,EAAE;YAC9C,UAAU,EAAE,uBAAuB;SACpC,CAAC,CAAC,MAAM;QACX,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAE5E,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAChC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAC5C,IAAI,EACJ,QAAQ,CACT,CAAC;IAEF,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAChD,oBAAoB,CACkB,CAAC;IAEzC,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,QAAQ;QACf,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oCAAoC;QACjD,OAAO,EAAE,0DAA0D;QACnE,WAAW,EAAE,WAAW,CAAC,IAAI;QAC7B,OAAO,EAAE,WAAW,CAAC,OAAO;QAE5B,MAAM;QACN,MAAM;QAEN,MAAM,EAAE,MAAM,kBAAkB,CAAC,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC;KACpE,CAAC;AACJ,CAAC"}

package/src/lib/meta/groups.d.ts

@@ -1,4 +1,11 @@
 import type { Group } from '@code-pushup/models';
-import { type RuleData } from './parse';
+import type { CustomGroup } from '../config.js';
+import { type RuleData } from './parse.js';
 export declare function groupsFromRuleTypes(rules: RuleData[]): Group[];
 export declare function groupsFromRuleCategories(rules: RuleData[]): Group[];
+export declare function groupsFromCustomConfig(rules: RuleData[], groups: CustomGroup[]): Group[];
+export declare function createRulesMap(rules: RuleData[]): Record<string, RuleData[]>;
+export declare function resolveGroupRefs(groupRules: Record<string, number>, rulesMap: Record<string, RuleData[]>): {
+    refs: Group['refs'];
+    invalidRules: string[];
+};

package/src/lib/meta/groups.js

@@ -0,0 +1,112 @@
+import { objectToKeys, slugify, ui } from '@code-pushup/utils';
+import { ruleToSlug } from './hash.js';
+import { parseRuleId } from './parse.js';
+import { expandWildcardRules } from './rules.js';
+// docs on meta.type: https://eslint.org/docs/latest/extend/custom-rules#rule-structure
+const typeGroups = {
+    problem: {
+        slug: 'problems',
+        title: 'Problems',
+        description: 'Code that either will cause an error or may cause confusing behavior. Developers should consider this a high priority to resolve.',
+    },
+    suggestion: {
+        slug: 'suggestions',
+        title: 'Suggestions',
+        description: "Something that could be done in a better way but no errors will occur if the code isn't changed.",
+    },
+    layout: {
+        slug: 'formatting',
+        title: 'Formatting',
+        description: 'Primarily about whitespace, semicolons, commas, and parentheses, all the parts of the program that determine how the code looks rather than how it executes.',
+    },
+};
+export function groupsFromRuleTypes(rules) {
+    const allTypes = objectToKeys(typeGroups);
+    const auditSlugsMap = rules.reduce((acc, rule) => rule.meta.type == null
+        ? acc
+        : {
+            ...acc,
+            [rule.meta.type]: [
+                ...(acc[rule.meta.type] ?? []),
+                ruleToSlug(rule),
+            ],
+        }, {});
+    return allTypes
+        .map(type => ({
+        ...typeGroups[type],
+        refs: auditSlugsMap[type]?.map((slug) => ({ slug, weight: 1 })) ??
+            [],
+    }))
+        .filter(group => group.refs.length);
+}
+export function groupsFromRuleCategories(rules) {
+    const categoriesMap = rules.reduce((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]) => ({
+        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, groups) {
+    const rulesMap = createRulesMap(rules);
+    return groups.map(group => {
+        const groupRules = Array.isArray(group.rules)
+            ? Object.fromEntries(group.rules.map(rule => [rule, 1]))
+            : group.rules;
+        const { refs, invalidRules } = resolveGroupRefs(groupRules, rulesMap);
+        if (invalidRules.length > 0 && Object.entries(groupRules).length > 0) {
+            if (refs.length === 0) {
+                throw new Error(`Invalid rule configuration in group ${group.slug}. All rules are invalid.`);
+            }
+            ui().logger.warning(`Some rules in group ${group.slug} are invalid: ${invalidRules.join(', ')}`);
+        }
+        return {
+            slug: group.slug,
+            title: group.title,
+            refs,
+        };
+    });
+}
+export function createRulesMap(rules) {
+    return rules.reduce((acc, rule) => ({
+        ...acc,
+        [rule.id]: [...(acc[rule.id] || []), rule],
+    }), {});
+}
+export function resolveGroupRefs(groupRules, rulesMap) {
+    return Object.entries(groupRules).reduce((acc, [rule, weight]) => {
+        const matchedRuleIds = rule.endsWith('*')
+            ? expandWildcardRules(rule, Object.keys(rulesMap))
+            : [rule];
+        const matchedRefs = matchedRuleIds.flatMap(ruleId => {
+            const matchingRules = rulesMap[ruleId] || [];
+            const weightPerRule = weight / matchingRules.length;
+            return matchingRules.map(ruleData => ({
+                slug: ruleToSlug(ruleData),
+                weight: weightPerRule,
+            }));
+        });
+        return {
+            refs: [...acc.refs, ...matchedRefs],
+            invalidRules: matchedRefs.length > 0
+                ? acc.invalidRules
+                : [...acc.invalidRules, rule],
+        };
+    }, { refs: [], invalidRules: [] });
+}
+//# sourceMappingURL=groups.js.map

package/src/lib/meta/groups.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"groups.js","sourceRoot":"","sources":["../../../../../../packages/plugin-eslint/src/lib/meta/groups.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE/D,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAiB,WAAW,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAIjD,uFAAuF;AACvF,MAAM,UAAU,GAA0C;IACxD,OAAO,EAAE;QACP,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,UAAU;QACjB,WAAW,EACT,mIAAmI;KACtI;IACD,UAAU,EAAE;QACV,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,aAAa;QACpB,WAAW,EACT,kGAAkG;KACrG;IACD,MAAM,EAAE;QACN,IAAI,EAAE,YAAY;QAClB,KAAK,EAAE,YAAY;QACnB,WAAW,EACT,8JAA8J;KACjK;CACF,CAAC;AAEF,MAAM,UAAU,mBAAmB,CAAC,KAAiB;IACnD,MAAM,QAAQ,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;IAE1C,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAChC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CACZ,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI;QACpB,CAAC,CAAC,GAAG;QACL,CAAC,CAAC;YACE,GAAG,GAAG;YACN,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAChB,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC9B,UAAU,CAAC,IAAI,CAAC;aACjB;SACF,EACP,EAAE,CACH,CAAC;IAEF,OAAO,QAAQ;SACZ,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACZ,GAAG,UAAU,CAAC,IAAI,CAAC;QACnB,IAAI,EACF,aAAa,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,EAAY,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;YACnE,EAAE;KACL,CAAC,CAAC;SACF,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,KAAiB;IACxD,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAChC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACZ,yFAAyF;QACzF,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;QAC1C,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,GAAG,CAAC;QACb,CAAC;QACD,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7C,OAAO;YACL,GAAG,GAAG;YACN,CAAC,MAAM,CAAC,EAAE;gBACR,GAAG,GAAG,CAAC,MAAM,CAAC;gBACd,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;aACnE;SACF,CAAC;IACJ,CAAC,EACD,EAAE,CACH,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,EAAE,CAC5E,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAC5B,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAS,EAAE,CAAC,CAAC;QAC7B,IAAI,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC/C,KAAK,EAAE,GAAG,QAAQ,KAAK,MAAM,GAAG;QAChC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;KAC/C,CAAC,CACH,CACF,CAAC;IAEF,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,KAAiB,EACjB,MAAqB;IAErB,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IAEvC,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QACxB,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;YAC3C,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACxD,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC;QAEhB,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,gBAAgB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAEtE,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrE,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CACb,uCAAuC,KAAK,CAAC,IAAI,0BAA0B,CAC5E,CAAC;YACJ,CAAC;YACD,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CACjB,uBAAuB,KAAK,CAAC,IAAI,iBAAiB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC5E,CAAC;QACJ,CAAC;QAED,OAAO;YACL,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,IAAI;SACL,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAiB;IAC9C,OAAO,KAAK,CAAC,MAAM,CACjB,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QACd,GAAG,GAAG;QACN,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC;KAC3C,CAAC,EACF,EAAE,CACH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,UAAkC,EAClC,QAAoC;IAEpC,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAItC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE;QACtB,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACvC,CAAC,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAEX,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAClD,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YAC7C,MAAM,aAAa,GAAG,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC;YAEpD,OAAO,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;gBACpC,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC;gBAC1B,MAAM,EAAE,aAAa;aACtB,CAAC,CAAC,CAAC;QACN,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,GAAG,WAAW,CAAC;YACnC,YAAY,EACV,WAAW,CAAC,MAAM,GAAG,CAAC;gBACpB,CAAC,CAAC,GAAG,CAAC,YAAY;gBAClB,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC;SAClC,CAAC;IACJ,CAAC,EACD,EAAE,IAAI,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,CAC/B,CAAC;AACJ,CAAC"}

package/src/lib/meta/hash.d.ts

@@ -1,2 +1,4 @@
+import { type RuleData } from './parse.js';
+export declare function ruleToSlug(rule: RuleData): string;
 export declare function ruleIdToSlug(ruleId: string, options: unknown[] | undefined): string;
 export declare function jsonHash(data: unknown, bytes?: number): string;

package/src/lib/meta/hash.js

@@ -0,0 +1,19 @@
+import { createHash } from 'node:crypto';
+import { slugify } from '@code-pushup/utils';
+import { resolveRuleOptions } from './parse.js';
+export function ruleToSlug(rule) {
+    return ruleIdToSlug(rule.id, resolveRuleOptions(rule));
+}
+export function ruleIdToSlug(ruleId, options) {
+    const slug = slugify(ruleId);
+    if (!options?.length) {
+        return slug;
+    }
+    return `${slug}-${jsonHash(options)}`;
+}
+export function jsonHash(data, bytes = 8) {
+    return createHash('shake256', { outputLength: bytes })
+        .update(JSON.stringify(data) || 'null')
+        .digest('hex');
+}
+//# sourceMappingURL=hash.js.map

package/src/lib/meta/hash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash.js","sourceRoot":"","sources":["../../../../../../packages/plugin-eslint/src/lib/meta/hash.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAiB,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAE/D,MAAM,UAAU,UAAU,CAAC,IAAc;IACvC,OAAO,YAAY,CAAC,IAAI,CAAC,EAAE,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,MAAc,EACd,OAA8B;IAE9B,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7B,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,GAAG,IAAI,IAAI,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,IAAa,EAAE,KAAK,GAAG,CAAC;IAC/C,OAAO,UAAU,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;SACnD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC;SACtC,MAAM,CAAC,KAAK,CAAC,CAAC;AACnB,CAAC"}

package/src/lib/meta/index.d.ts

@@ -1,7 +1,8 @@
 import type { Audit, Group } from '@code-pushup/models';
-import type { ESLintTarget } from '../config';
-export { detectConfigVersion, type ConfigFormat } from './versions';
-export declare function listAuditsAndGroups(targets: ESLintTarget[]): Promise<{
+import type { CustomGroup, ESLintTarget } from '../config.js';
+export { ruleIdToSlug } from './hash.js';
+export { detectConfigVersion, type ConfigFormat } from './versions/index.js';
+export declare function listAuditsAndGroups(targets: ESLintTarget[], customGroups?: CustomGroup[] | undefined): Promise<{
     audits: Audit[];
     groups: Group[];
 }>;

package/src/lib/meta/index.js

@@ -0,0 +1,19 @@
+import { groupsFromCustomConfig, groupsFromRuleCategories, groupsFromRuleTypes, } from './groups.js';
+import { listRules } from './rules.js';
+import { ruleToAudit } from './transform.js';
+export { ruleIdToSlug } from './hash.js';
+export { detectConfigVersion } from './versions/index.js';
+export async function listAuditsAndGroups(targets, customGroups) {
+    const rules = await listRules(targets);
+    const resolvedCustomGroups = customGroups
+        ? groupsFromCustomConfig(rules, customGroups)
+        : [];
+    const audits = rules.map(ruleToAudit);
+    const groups = [
+        ...groupsFromRuleTypes(rules),
+        ...groupsFromRuleCategories(rules),
+        ...resolvedCustomGroups,
+    ];
+    return { audits, groups };
+}
+//# sourceMappingURL=index.js.map

package/src/lib/meta/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/plugin-eslint/src/lib/meta/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,mBAAmB,GACpB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,mBAAmB,EAAqB,MAAM,qBAAqB,CAAC;AAE7E,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,OAAuB,EACvB,YAAwC;IAExC,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;IAEvC,MAAM,oBAAoB,GAAG,YAAY;QACvC,CAAC,CAAC,sBAAsB,CAAC,KAAK,EAAE,YAAY,CAAC;QAC7C,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAEtC,MAAM,MAAM,GAAG;QACb,GAAG,mBAAmB,CAAC,KAAK,CAAC;QAC7B,GAAG,wBAAwB,CAAC,KAAK,CAAC;QAClC,GAAG,oBAAoB;KACxB,CAAC;IAEF,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAC5B,CAAC"}

package/src/lib/meta/parse.d.ts

@@ -1,6 +1,6 @@
 import type { Linter, Rule } from 'eslint';
 export type RuleData = {
-    ruleId: string;
+    id: string;
     meta: Rule.RuleMetaData;
     options: unknown[] | undefined;
 };
@@ -10,3 +10,4 @@ export declare function parseRuleId(ruleId: string): {
 };
 export declare function isRuleOff(entry: Linter.RuleEntry<unknown[]>): boolean;
 export declare function optionsFromRuleEntry(entry: Linter.RuleEntry<unknown[]>): unknown[];
+export declare function resolveRuleOptions(rule: RuleData): unknown[] | undefined;

package/src/lib/meta/parse.js

@@ -0,0 +1,36 @@
+import { toArray } from '@code-pushup/utils';
+export function parseRuleId(ruleId) {
+    const i = ruleId.startsWith('@')
+        ? ruleId.lastIndexOf('/')
+        : ruleId.indexOf('/');
+    if (i === -1) {
+        return { name: ruleId };
+    }
+    return {
+        plugin: ruleId.slice(0, i),
+        name: ruleId.slice(i + 1),
+    };
+}
+export function isRuleOff(entry) {
+    const level = Array.isArray(entry) ? entry[0] : entry;
+    switch (level) {
+        case 0:
+        case 'off':
+            return true;
+        case 1:
+        case 2:
+        case 'warn':
+        case 'error':
+            return false;
+    }
+}
+export function optionsFromRuleEntry(entry) {
+    return toArray(entry).slice(1);
+}
+export function resolveRuleOptions(rule) {
+    if (rule.options?.length) {
+        return rule.options;
+    }
+    return rule.meta.defaultOptions;
+}
+//# sourceMappingURL=parse.js.map

package/src/lib/meta/parse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.js","sourceRoot":"","sources":["../../../../../../packages/plugin-eslint/src/lib/meta/parse.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAQ7C,MAAM,UAAU,WAAW,CAAC,MAAc;IACxC,MAAM,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC;QAC9B,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC;QACzB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACxB,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACb,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC1B,CAAC;IACD,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;KAC1B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAkC;IAC1D,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAEtD,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,CAAC,CAAC;QACP,KAAK,KAAK;YACR,OAAO,IAAI,CAAC;QACd,KAAK,CAAC,CAAC;QACP,KAAK,CAAC,CAAC;QACP,KAAK,MAAM,CAAC;QACZ,KAAK,OAAO;YACV,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,KAAkC;IAElC,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,IAAc;IAC/C,IAAI,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IACD,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC;AAClC,CAAC"}

package/src/lib/meta/rules.d.ts

@@ -1,3 +1,4 @@
-import type { ESLintTarget } from '../config';
-import type { RuleData } from './parse';
+import type { ESLintTarget } from '../config.js';
+import type { RuleData } from './parse.js';
 export declare function listRules(targets: ESLintTarget[]): Promise<RuleData[]>;
+export declare function expandWildcardRules(wildcard: string, rules: string[]): string[];

package/src/lib/meta/rules.js

@@ -0,0 +1,26 @@
+import { jsonHash } from './hash.js';
+import { detectConfigVersion, selectRulesLoader } from './versions/index.js';
+export async function listRules(targets) {
+    const version = await detectConfigVersion();
+    const loadRulesMap = selectRulesLoader(version);
+    const rulesMap = await targets.reduce(async (acc, target) => {
+        const map = await acc;
+        const rules = await loadRulesMap(target);
+        return rules.reduce(mergeRuleIntoMap, map);
+    }, Promise.resolve({}));
+    return Object.values(rulesMap).flatMap(Object.values);
+}
+function mergeRuleIntoMap(map, rule) {
+    return {
+        ...map,
+        [rule.id]: {
+            ...map[rule.id],
+            [jsonHash(rule.options)]: rule,
+        },
+    };
+}
+export function expandWildcardRules(wildcard, rules) {
+    const prefix = wildcard.slice(0, -1);
+    return rules.filter(rule => rule.startsWith(prefix));
+}
+//# sourceMappingURL=rules.js.map

package/src/lib/meta/rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../../../../../packages/plugin-eslint/src/lib/meta/rules.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAI7E,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,OAAuB;IACrD,MAAM,OAAO,GAAG,MAAM,mBAAmB,EAAE,CAAC;IAC5C,MAAM,YAAY,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEhD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE;QAC1D,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC;QACtB,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,CAAC;QACzC,OAAO,KAAK,CAAC,MAAM,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;IAC7C,CAAC,EAAE,OAAO,CAAC,OAAO,CAAW,EAAE,CAAC,CAAC,CAAC;IAElC,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAW,MAAM,CAAC,MAAM,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAa,EAAE,IAAc;IACrD,OAAO;QACL,GAAG,GAAG;QACN,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;YACT,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACf,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI;SAC/B;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,QAAgB,EAChB,KAAe;IAEf,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACrC,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;AACvD,CAAC"}

package/src/lib/meta/transform.d.ts

@@ -1,3 +1,3 @@
 import type { Audit } from '@code-pushup/models';
-import type { RuleData } from './parse';
-export declare function ruleToAudit({ ruleId, meta, options }: RuleData): Audit;
+import type { RuleData } from './parse.js';
+export declare function ruleToAudit(rule: RuleData): Audit;

package/src/lib/meta/transform.js

@@ -0,0 +1,21 @@
+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

package/src/lib/meta/transform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.js","sourceRoot":"","sources":["../../../../../../packages/plugin-eslint/src/lib/meta/transform.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAGvC,MAAM,UAAU,WAAW,CAAC,IAAc;IACxC,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC;IAClD,MAAM,MAAM,GACV,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;IACvE,MAAM,aAAa,GAAG,MAAM,CAAC,CAAC,CAAC,WAAW,MAAM,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;IAEhE,MAAM,KAAK,GAAa;QACtB,iBAAiB,IAAI,KAAK,aAAa,GAAG;QAC1C,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACpD,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,CAC7B,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/D,IAAI,EAAE,CAAC;KACT,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC;QACtB,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,IAAI,IAAI,CAAC;QACzD,WAAW,EAAE,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpD,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI;YACzB,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SAC5B,CAAC;KACH,CAAC;AACJ,CAAC"}

package/src/lib/meta/versions/detect.d.ts

@@ -1,2 +1,2 @@
-import type { ConfigFormat } from './formats';
+import type { ConfigFormat } from './formats.js';
 export declare function detectConfigVersion(): Promise<ConfigFormat>;