@code-pushup/eslint-plugin 0.55.0 → 0.56.0

package/index.js

@@ -4,7 +4,7 @@ import { fileURLToPath } from "node:url";
 
 // packages/plugin-eslint/package.json
 var name = "@code-pushup/eslint-plugin";
-var version = "0.55.0";
+var version = "0.56.0";
 
 // packages/plugin-eslint/src/lib/config.ts
 import { z as z17 } from "zod";
@@ -1263,24 +1263,73 @@ function filterProjectGraph(projectGraph, exclude = []) {
 
 // packages/plugin-eslint/src/lib/nx/utils.ts
 import { join as join5 } from "node:path";
-async function findCodePushupEslintrc(project) {
-  const name2 = "code-pushup.eslintrc";
-  const extensions = ["json", "js", "cjs", "yml", "yaml"];
-  for (const ext of extensions) {
-    const filename = `./${project.root}/${name2}.${ext}`;
-    if (await fileExists(join5(process.cwd(), filename))) {
-      return filename;
-    }
-  }
-  return null;
+var ESLINT_CONFIG_EXTENSIONS = {
+  // https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file-formats
+  flat: ["js", "mjs", "cjs"],
+  // https://eslint.org/docs/latest/use/configure/configuration-files-deprecated
+  legacy: ["json", "js", "cjs", "yml", "yaml"]
+};
+var ESLINT_CONFIG_NAMES = {
+  // https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file-formats
+  flat: ["eslint.config"],
+  // https://eslint.org/docs/latest/use/configure/configuration-files-deprecated
+  legacy: [".eslintrc"]
+};
+var CP_ESLINT_CONFIG_NAMES = {
+  flat: [
+    "code-pushup.eslint.config",
+    "eslint.code-pushup.config",
+    "eslint.config.code-pushup",
+    "eslint.strict.config",
+    "eslint.config.strict"
+  ],
+  legacy: ["code-pushup.eslintrc", ".eslintrc.code-pushup", ".eslintrc.strict"]
+};
+async function findCodePushupEslintConfig(project, format) {
+  return findProjectFile(project, {
+    names: CP_ESLINT_CONFIG_NAMES[format],
+    extensions: ESLINT_CONFIG_EXTENSIONS[format]
+  });
 }
-function getLintFilePatterns(project) {
+async function findEslintConfig(project, format) {
   const options = project.targets?.["lint"]?.options;
-  return options?.lintFilePatterns == null ? [`${project.root}/**/*`] : toArray(options.lintFilePatterns);
+  return options?.eslintConfig ?? await findProjectFile(project, {
+    names: ESLINT_CONFIG_NAMES[format],
+    extensions: ESLINT_CONFIG_EXTENSIONS[format]
+  });
 }
-function getEslintConfig(project) {
+function getLintFilePatterns(project, format) {
   const options = project.targets?.["lint"]?.options;
-  return options?.eslintConfig ?? `./${project.root}/.eslintrc.json`;
+  const defaultPatterns = format === "legacy" ? `${project.root}/**/*` : project.root;
+  const patterns = options?.lintFilePatterns == null ? [defaultPatterns] : toArray(options.lintFilePatterns);
+  if (format === "legacy") {
+    return [
+      ...patterns,
+      // HACK: ESLint.calculateConfigForFile won't find rules included only for subsets of *.ts when globs used
+      // so we explicitly provide additional patterns used by @code-pushup/eslint-config to ensure those rules are included
+      // this workaround is only necessary for legacy configs (rules are detected more reliably in flat configs)
+      `${project.root}/*.spec.ts`,
+      // jest/* and vitest/* rules
+      `${project.root}/*.cy.ts`,
+      // cypress/* rules
+      `${project.root}/*.stories.ts`,
+      // storybook/* rules
+      `${project.root}/.storybook/main.ts`
+      // storybook/no-uninstalled-addons rule
+    ];
+  }
+  return patterns;
+}
+async function findProjectFile(project, file) {
+  for (const name2 of file.names) {
+    for (const ext of file.extensions) {
+      const filename = `./${project.root}/${name2}.${ext}`;
+      if (await fileExists(join5(process.cwd(), filename))) {
+        return filename;
+      }
+    }
+  }
+  return void 0;
 }
 
 // packages/plugin-eslint/src/lib/nx/projects-to-config.ts
@@ -1288,24 +1337,12 @@ async function nxProjectsToConfig(projectGraph, predicate = () => true) {
   const { readProjectsConfigurationFromProjectGraph } = await import("@nx/devkit");
   const projectsConfiguration = readProjectsConfigurationFromProjectGraph(projectGraph);
   const projects = Object.values(projectsConfiguration.projects).filter((project) => "lint" in (project.targets ?? {})).filter(predicate).sort((a, b) => a.root.localeCompare(b.root));
+  const format = await detectConfigVersion();
   return Promise.all(
     projects.map(
       async (project) => ({
-        eslintrc: await findCodePushupEslintrc(project) ?? getEslintConfig(project),
-        patterns: [
-          ...getLintFilePatterns(project),
-          // HACK: ESLint.calculateConfigForFile won't find rules included only for subsets of *.ts when globs used
-          // so we explicitly provide additional patterns used by @code-pushup/eslint-config to ensure those rules are included
-          // this workaround won't be necessary once flat configs are stable (much easier to find all rules)
-          `${project.sourceRoot}/*.spec.ts`,
-          // jest/* and vitest/* rules
-          `${project.sourceRoot}/*.cy.ts`,
-          // cypress/* rules
-          `${project.sourceRoot}/*.stories.ts`,
-          // storybook/* rules
-          `${project.sourceRoot}/.storybook/main.ts`
-          // storybook/no-uninstalled-addons rule
-        ]
+        eslintrc: await findCodePushupEslintConfig(project, format) ?? await findEslintConfig(project, format),
+        patterns: getLintFilePatterns(project, format)
       })
     )
   );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/eslint-plugin",
-  "version": "0.55.0",
+  "version": "0.56.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",
@@ -40,8 +40,8 @@
   "main": "./index.js",
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@code-pushup/utils": "0.55.0",
-    "@code-pushup/models": "0.55.0",
+    "@code-pushup/utils": "0.56.0",
+    "@code-pushup/models": "0.56.0",
     "zod": "^3.22.4"
   },
   "peerDependencies": {

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

@@ -1,5 +1,6 @@
 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<{
     audits: Audit[];
     groups: Group[];

package/src/lib/nx/utils.d.ts

@@ -1,4 +1,5 @@
 import type { ProjectConfiguration } from '@nx/devkit';
-export declare function findCodePushupEslintrc(project: ProjectConfiguration): Promise<string | null>;
-export declare function getLintFilePatterns(project: ProjectConfiguration): string[];
-export declare function getEslintConfig(project: ProjectConfiguration): string | undefined;
+import type { ConfigFormat } from '../meta';
+export declare function findCodePushupEslintConfig(project: ProjectConfiguration, format: ConfigFormat): Promise<string | undefined>;
+export declare function findEslintConfig(project: ProjectConfiguration, format: ConfigFormat): Promise<string | undefined>;
+export declare function getLintFilePatterns(project: ProjectConfiguration, format: ConfigFormat): string[];