feat(plugin-eslint): add artefact options (#1089)

This PR includes:
- refactor `generateAuditOutputs` to `createRunnerFunction`
- use `createRunnerFunction` instead of `createRunnerConfig`
- update tests

---------

Co-authored-by: AS <ASiuta_ext@mapal-os.com>
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>

Author: 3 people

packages/plugin-eslint/package.json

@@ -41,7 +41,6 @@
     "glob": "^11.0.0",
     "@code-pushup/utils": "0.77.0",
     "@code-pushup/models": "0.77.0",
-    "yargs": "^17.7.2",
     "zod": "^4.0.5"
   },
   "peerDependencies": {

packages/plugin-eslint/src/bin.ts

@@ -346,16 +346,7 @@ exports[`eslintPlugin > should initialize ESLint plugin for React application 1`
   ],
   "icon": "eslint",
   "packageName": "@code-pushup/eslint-plugin",
-  "runner": {
-    "args": [
-      ""<dirname>/bin.js"",
-      "--runnerConfigPath="node_modules/.code-pushup/eslint/<timestamp>/plugin-config.json"",
-      "--runnerOutputPath="node_modules/.code-pushup/eslint/<timestamp>/runner-output.json"",
-    ],
-    "command": "node",
-    "configFile": "node_modules/.code-pushup/eslint/<timestamp>/plugin-config.json",
-    "outputFile": "node_modules/.code-pushup/eslint/<timestamp>/runner-output.json",
-  },
+  "runner": [Function],
   "slug": "eslint",
   "title": "ESLint",
   "version": Any<String>,

packages/plugin-eslint/src/lib/__snapshots__/eslint-plugin.int.test.ts.snap

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { pluginArtifactOptionsSchema } from '@code-pushup/models';
 import { toArray } from '@code-pushup/utils';
 
 const patternsSchema = z
@@ -61,5 +62,6 @@ export type CustomGroup = z.infer<typeof customGroupSchema>;
 
 export const eslintPluginOptionsSchema = z.object({
   groups: z.array(customGroupSchema).optional(),
+  artifacts: pluginArtifactOptionsSchema.optional(),
 });
 export type ESLintPluginOptions = z.infer<typeof eslintPluginOptionsSchema>;

packages/plugin-eslint/src/lib/config.ts

@@ -3,8 +3,7 @@ import path from 'node:path';
 import process from 'node:process';
 import { fileURLToPath } from 'node:url';
 import type { MockInstance } from 'vitest';
-import type { Audit, PluginConfig, RunnerConfig } from '@code-pushup/models';
-import { toUnixPath } from '@code-pushup/utils';
+import type { Audit } from '@code-pushup/models';
 import { eslintPlugin } from './eslint-plugin.js';
 
 describe('eslintPlugin', () => {
@@ -15,27 +14,6 @@ describe('eslintPlugin', () => {
   let cwdSpy: MockInstance<[], string>;
   let platformSpy: MockInstance<[], NodeJS.Platform>;
 
-  const replaceAbsolutePath = (plugin: PluginConfig): PluginConfig => ({
-    ...plugin,
-    runner: {
-      ...(plugin.runner as RunnerConfig),
-      args: (plugin.runner as RunnerConfig).args?.map(arg =>
-        toUnixPath(arg.replace(path.dirname(thisDir), '<dirname>')).replace(
-          /\/eslint\/\d+\//,
-          '/eslint/<timestamp>/',
-        ),
-      ),
-      ...((plugin.runner as RunnerConfig).configFile && {
-        configFile: toUnixPath(
-          (plugin.runner as RunnerConfig).configFile!,
-        ).replace(/\/eslint\/\d+\//, '/eslint/<timestamp>/'),
-      }),
-      outputFile: toUnixPath(
-        (plugin.runner as RunnerConfig).outputFile,
-      ).replace(/\/eslint\/\d+\//, '/eslint/<timestamp>/'),
-    },
-  });
-
   beforeAll(() => {
     cwdSpy = vi.spyOn(process, 'cwd');
     // Linux produces extra quotation marks for globs
@@ -55,7 +33,7 @@ describe('eslintPlugin', () => {
       patterns: ['src/**/*.js', 'src/**/*.jsx'],
     });
 
-    expect(replaceAbsolutePath(plugin)).toMatchSnapshot({
+    expect(plugin).toMatchSnapshot({
       version: expect.any(String),
     });
   });
@@ -68,18 +46,17 @@ describe('eslintPlugin', () => {
     });
 
     // expect rule from extended base eslint.config.js
-    expect(plugin.audits).toContainEqual(
-      expect.objectContaining<Audit>({
-        slug: expect.stringMatching(/^nx-enforce-module-boundaries/),
-        title: expect.any(String),
-        description: expect.stringContaining('sourceTag'),
-      }),
-    );
-    // expect rule from nx-plugin project's eslint.config.js
-    expect(plugin.audits).toContainEqual(
-      expect.objectContaining<Partial<Audit>>({
-        slug: 'nx-nx-plugin-checks',
-      }),
+    expect(plugin.audits).toStrictEqual(
+      expect.arrayContaining([
+        expect.objectContaining<Audit>({
+          slug: expect.stringMatching(/^nx-enforce-module-boundaries/),
+          title: expect.any(String),
+          description: expect.stringContaining('sourceTag'),
+        }),
+        expect.objectContaining<Partial<Audit>>({
+          slug: 'nx-nx-plugin-checks',
+        }),
+      ]),
     );
   });
 
@@ -152,12 +129,30 @@ describe('eslintPlugin', () => {
     await expect(
       // @ts-expect-error simulating invalid non-TS config
       eslintPlugin({ eslintrc: '.eslintrc.json' }),
-    ).rejects.toThrow('Invalid input');
+    ).rejects.toThrow('Failed parsing ESLint plugin config');
   });
 
   it("should throw if eslintrc file doesn't exist", async () => {
     await expect(
       eslintPlugin({ eslintrc: '.eslintrc.yml', patterns: '**/*.js' }),
     ).rejects.toThrow(/Failed to load url .*\.eslintrc.yml/);
   });
+
+  it('should initialize with artifact options', async () => {
+    cwdSpy.mockReturnValue(path.join(fixturesDir, 'todos-app'));
+    const plugin = await eslintPlugin(
+      {
+        eslintrc: 'eslint.config.js',
+        patterns: ['src/**/*.js'],
+      },
+      {
+        artifacts: {
+          artifactsPaths: './artifacts/eslint-output.json',
+          generateArtifactsCommand: 'echo "Generating artifacts"',
+        },
+      },
+    );
+
+    expect(plugin.runner).toBeTypeOf('function');
+  });
 });

packages/plugin-eslint/src/lib/eslint-plugin.int.test.ts

@@ -1,6 +1,4 @@
 import { createRequire } from 'node:module';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
 import type { PluginConfig } from '@code-pushup/models';
 import { parseSchema } from '@code-pushup/utils';
 import {
@@ -11,7 +9,7 @@ import {
 } from './config.js';
 import { ESLINT_PLUGIN_SLUG } from './constants.js';
 import { listAuditsAndGroups } from './meta/index.js';
-import { createRunnerConfig } from './runner/index.js';
+import { createRunnerFunction } from './runner/index.js';
 
 /**
  * Instantiates Code PushUp ESLint plugin for use in core config.
@@ -42,20 +40,14 @@ export async function eslintPlugin(
     schemaType: 'ESLint plugin config',
   });
 
-  const customGroups = options
+  const { groups: customGroups, artifacts } = 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',
   ) as typeof import('../../package.json');
@@ -72,6 +64,10 @@ export async function eslintPlugin(
     audits,
     groups,
 
-    runner: await createRunnerConfig(runnerScriptPath, audits, targets),
+    runner: await createRunnerFunction({
+      audits,
+      targets,
+      ...(artifacts ? { artifacts } : {}),
+    }),
   };
 }

packages/plugin-eslint/src/lib/eslint-plugin.ts

@@ -3,37 +3,29 @@ import path from 'node:path';
 import process from 'node:process';
 import { fileURLToPath } from 'node:url';
 import { type MockInstance, describe, expect, it } from 'vitest';
-import type {
-  AuditOutput,
-  AuditOutputs,
-  Issue,
-  RunnerFilesPaths,
+import {
+  type Audit,
+  type AuditOutput,
+  type AuditOutputs,
+  DEFAULT_PERSIST_OUTPUT_DIR,
+  type Issue,
 } from '@code-pushup/models';
 import { osAgnosticAuditOutputs } from '@code-pushup/test-utils';
-import { readJsonFile } from '@code-pushup/utils';
 import type { ESLintTarget } from './config.js';
 import { listAuditsAndGroups } from './meta/index.js';
-import { createRunnerConfig, executeRunner } from './runner/index.js';
+import { createRunnerFunction } from './runner/index.js';
 
 describe('executeRunner', () => {
   let cwdSpy: MockInstance<[], string>;
   let platformSpy: MockInstance<[], NodeJS.Platform>;
 
-  const createPluginConfig = async (
+  const prepareRunnerArgs = async (
     eslintrc: ESLintTarget['eslintrc'],
-  ): Promise<RunnerFilesPaths> => {
+  ): Promise<{ audits: Audit[]; targets: ESLintTarget[] }> => {
     const patterns = ['src/**/*.js', 'src/**/*.jsx'];
     const targets: ESLintTarget[] = [{ eslintrc, patterns }];
     const { audits } = await listAuditsAndGroups(targets);
-    const { outputFile, configFile } = await createRunnerConfig(
-      'bin.js',
-      audits,
-      targets,
-    );
-    return {
-      runnerOutputPath: outputFile,
-      runnerConfigPath: configFile!,
-    };
+    return { audits, targets };
   };
 
   const appDir = path.join(
@@ -57,24 +49,23 @@ describe('executeRunner', () => {
   });
 
   it('should execute ESLint and create audit results for React application', async () => {
-    const runnerPaths = await createPluginConfig('eslint.config.js');
-    await executeRunner(runnerPaths);
-
-    const json = await readJsonFile<AuditOutputs>(runnerPaths.runnerOutputPath);
-    expect(osAgnosticAuditOutputs(json)).toMatchSnapshot();
+    const args = await prepareRunnerArgs('eslint.config.js');
+    const runnerFn = await createRunnerFunction(args);
+    const res = (await runnerFn({
+      outputDir: DEFAULT_PERSIST_OUTPUT_DIR,
+    })) as AuditOutputs;
+    expect(osAgnosticAuditOutputs(res)).toMatchSnapshot();
   });
 
   it.skipIf(process.platform === 'win32')(
     'should execute runner with custom config using @code-pushup/eslint-config',
     async () => {
-      const runnerPaths = await createPluginConfig(
-        'code-pushup.eslint.config.mjs',
-      );
-      await executeRunner(runnerPaths);
+      const eslintTarget = 'code-pushup.eslint.config.mjs';
+      const runnerFn = await createRunnerFunction({
+        ...(await prepareRunnerArgs(eslintTarget)),
+      });
 
-      const json = await readJsonFile<AuditOutput[]>(
-        runnerPaths.runnerOutputPath,
-      );
+      const json = await runnerFn({ outputDir: DEFAULT_PERSIST_OUTPUT_DIR });
       // expect warnings from unicorn/filename-case rule from default config
       expect(json).toContainEqual(
         expect.objectContaining<Partial<AuditOutput>>({