@code-pushup/eslint-plugin 0.35.0 → 0.42.0

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@code-pushup/eslint-plugin",
-  "version": "0.35.0",
+  "version": "0.42.0",
   "license": "MIT",
   "dependencies": {
-    "@code-pushup/utils": "0.35.0",
-    "@code-pushup/models": "0.35.0",
+    "@code-pushup/utils": "0.42.0",
+    "@code-pushup/models": "0.42.0",
     "eslint": "^8.46.0",
     "zod": "^3.22.4"
   },
@@ -22,7 +22,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/code-pushup/cli.git",
+    "url": "git+https://github.com/code-pushup/cli.git",
     "directory": "packages/plugin-eslint"
   },
   "contributors": [

package/src/lib/config.d.ts

@@ -1,6 +1,6 @@
 import type { ESLint } from 'eslint';
 import { type ZodType, z } from 'zod';
-export declare const eslintPluginConfigSchema: z.ZodObject<{
+export declare const eslintTargetSchema: z.ZodObject<{
     eslintrc: z.ZodUnion<[z.ZodString, ZodType<ESLint.ConfigData<import("eslint").Linter.RulesRecord>, z.ZodTypeDef, ESLint.ConfigData<import("eslint").Linter.RulesRecord>>]>;
     patterns: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
 }, "strip", z.ZodTypeAny, {
@@ -10,9 +10,37 @@ export declare const eslintPluginConfigSchema: z.ZodObject<{
     eslintrc: (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord>) & (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord> | undefined);
     patterns: (string | string[]) & (string | string[] | undefined);
 }>;
-export type ESLintPluginConfig = z.infer<typeof eslintPluginConfigSchema>;
+export type ESLintTarget = z.infer<typeof eslintTargetSchema>;
+export declare const eslintPluginConfigSchema: z.ZodEffects<z.ZodUnion<[z.ZodObject<{
+    eslintrc: z.ZodUnion<[z.ZodString, ZodType<ESLint.ConfigData<import("eslint").Linter.RulesRecord>, z.ZodTypeDef, ESLint.ConfigData<import("eslint").Linter.RulesRecord>>]>;
+    patterns: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+}, "strip", z.ZodTypeAny, {
+    eslintrc: (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord>) & (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord> | undefined);
+    patterns: (string | string[]) & (string | string[] | undefined);
+}, {
+    eslintrc: (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord>) & (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord> | undefined);
+    patterns: (string | string[]) & (string | string[] | undefined);
+}>, z.ZodArray<z.ZodObject<{
+    eslintrc: z.ZodUnion<[z.ZodString, ZodType<ESLint.ConfigData<import("eslint").Linter.RulesRecord>, z.ZodTypeDef, ESLint.ConfigData<import("eslint").Linter.RulesRecord>>]>;
+    patterns: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+}, "strip", z.ZodTypeAny, {
+    eslintrc: (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord>) & (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord> | undefined);
+    patterns: (string | string[]) & (string | string[] | undefined);
+}, {
+    eslintrc: (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord>) & (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord> | undefined);
+    patterns: (string | string[]) & (string | string[] | undefined);
+}>, "many">]>, {
+    eslintrc: (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord>) & (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord> | undefined);
+    patterns: (string | string[]) & (string | string[] | undefined);
+}[], {
+    eslintrc: (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord>) & (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord> | undefined);
+    patterns: (string | string[]) & (string | string[] | undefined);
+} | {
+    eslintrc: (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord>) & (string | ESLint.ConfigData<import("eslint").Linter.RulesRecord> | undefined);
+    patterns: (string | string[]) & (string | string[] | undefined);
+}[]>;
+export type ESLintPluginConfig = z.input<typeof eslintPluginConfigSchema>;
 export type ESLintPluginRunnerConfig = {
-    eslintrc: string;
+    targets: ESLintTarget[];
     slugs: string[];
-    patterns: string[];
 };

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

@@ -1,6 +1,6 @@
-import type { ESLint } from 'eslint';
 import type { Audit, Group } from '@code-pushup/models';
-export declare function listAuditsAndGroups(eslint: ESLint, patterns: string | string[]): Promise<{
+import type { ESLintTarget } from '../config';
+export declare function listAuditsAndGroups(targets: ESLintTarget[]): Promise<{
     audits: Audit[];
     groups: Group[];
 }>;

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

@@ -1,10 +1,11 @@
-import type { ESLint, Rule } from 'eslint';
+import type { Rule } from 'eslint';
+import type { ESLintTarget } from '../config';
 export type RuleData = {
     ruleId: string;
     meta: Rule.RuleMetaData;
     options: unknown[] | undefined;
 };
-export declare function listRules(eslint: ESLint, patterns: string | string[]): Promise<RuleData[]>;
+export declare function listRules(targets: ESLintTarget[]): Promise<RuleData[]>;
 export declare function parseRuleId(ruleId: string): {
     plugin?: string;
     name: string;

package/src/lib/nx/find-all-projects.d.ts

@@ -1,4 +1,4 @@
-import type { ESLintPluginConfig } from '../config';
+import type { ESLintTarget } from '../config';
 /**
  * Finds all Nx projects in workspace and converts their lint configurations to Code PushUp ESLint plugin parameters.
  *
@@ -20,4 +20,4 @@ import type { ESLintPluginConfig } from '../config';
  *
  * @returns ESLint config and patterns, intended to be passed to {@link eslintPlugin}
  */
-export declare function eslintConfigFromNxProjects(): Promise<ESLintPluginConfig>;
+export declare function eslintConfigFromNxProjects(): Promise<ESLintTarget[]>;

package/src/lib/nx/find-project-with-deps.d.ts

@@ -1,4 +1,4 @@
-import type { ESLintPluginConfig } from '../config';
+import type { ESLintTarget } from '../config';
 /**
  * Accepts a target Nx projects, finds projects it depends on, and converts lint configurations to Code PushUp ESLint plugin parameters.
  *
@@ -23,4 +23,4 @@ import type { ESLintPluginConfig } from '../config';
  * @param projectName Nx project serving as main entry point
  * @returns ESLint config and patterns, intended to be passed to {@link eslintPlugin}
  */
-export declare function eslintConfigFromNxProject(projectName: string): Promise<ESLintPluginConfig>;
+export declare function eslintConfigFromNxProject(projectName: string): Promise<ESLintTarget[]>;

package/src/lib/nx/projects-to-config.d.ts

@@ -1,3 +1,3 @@
 import type { ProjectConfiguration, ProjectGraph } from '@nx/devkit';
-import type { ESLintPluginConfig } from '../config';
-export declare function nxProjectsToConfig(projectGraph: ProjectGraph, predicate?: (project: ProjectConfiguration) => boolean): Promise<ESLintPluginConfig>;
+import type { ESLintTarget } from '../config';
+export declare function nxProjectsToConfig(projectGraph: ProjectGraph, predicate?: (project: ProjectConfiguration) => boolean): Promise<ESLintTarget[]>;

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

@@ -1,7 +1,7 @@
 import type { Audit, RunnerConfig } from '@code-pushup/models';
+import { type ESLintTarget } from '../config';
 export declare const WORKDIR: string;
 export declare const RUNNER_OUTPUT_PATH: string;
-export declare const ESLINTRC_PATH: string;
 export declare const PLUGIN_CONFIG_PATH: string;
 export declare function executeRunner(): Promise<void>;
-export declare function createRunnerConfig(scriptPath: string, audits: Audit[], eslintrc: string, patterns: string | string[]): Promise<RunnerConfig>;
+export declare function createRunnerConfig(scriptPath: string, audits: Audit[], targets: ESLintTarget[]): Promise<RunnerConfig>;

package/src/lib/runner/lint.d.ts

@@ -1,3 +1,3 @@
-import { ESLintPluginConfig } from '../config';
+import type { ESLintTarget } from '../config';
 import type { LinterOutput } from './types';
-export declare function lint({ eslintrc, patterns, }: ESLintPluginConfig): Promise<LinterOutput>;
+export declare function lint({ eslintrc, patterns, }: ESLintTarget): Promise<LinterOutput>;

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

@@ -1,3 +1,4 @@
 import type { AuditOutput } from '@code-pushup/models';
 import type { LinterOutput } from './types';
+export declare function mergeLinterOutputs(outputs: LinterOutput[]): LinterOutput;
 export declare function lintResultsToAudits({ results, ruleOptionsPerFile, }: LinterOutput): AuditOutput[];

package/src/lib/setup.d.ts

@@ -1,3 +1,3 @@
 import { ESLint } from 'eslint';
-import { ESLintPluginConfig } from './config';
-export declare function setupESLint(eslintrc: ESLintPluginConfig['eslintrc']): ESLint;
+import type { ESLintTarget } from './config';
+export declare function setupESLint(eslintrc: ESLintTarget['eslintrc']): ESLint;