fix(plugin-eslint): pass arguments via config file instead of argv

Author: Tlacenka

packages/plugin-coverage/src/lib/runner/index.ts

@@ -10,7 +10,7 @@ import {
 } from '@code-pushup/utils';
 import { FinalCoveragePluginConfig } from '../config';
 import { applyMaxScoreAboveThreshold } from '../utils';
-import { PLUGIN_CONFIG_PATH, RUNNER_OUTPUT_PATH, WORKDIR } from './constants';
+import { PLUGIN_CONFIG_PATH, RUNNER_OUTPUT_PATH } from './constants';
 import { lcovResultsToAuditOutputs } from './lcov/lcov-runner';
 
 export async function executeRunner(): Promise<void> {
@@ -48,7 +48,7 @@ export async function createRunnerConfig(
   config: FinalCoveragePluginConfig,
 ): Promise<RunnerConfig> {
   // Create JSON config for executeRunner
-  await ensureDirectoryExists(WORKDIR);
+  await ensureDirectoryExists(dirname(PLUGIN_CONFIG_PATH));
   await writeFile(PLUGIN_CONFIG_PATH, JSON.stringify(config));
 
   const threshold = config.perfectScoreThreshold;

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

@@ -509,10 +509,6 @@ exports[`eslintPlugin > should initialize ESLint plugin for React application 1`
   "runner": {
     "args": [
       "<dirname>/bin.js",
-      "no-cond-assign,no-const-assign,no-debugger,no-invalid-regexp,no-undef,no-unreachable-loop,no-unsafe-negation,no-unsafe-optional-chaining,no-unused-vars,use-isnan,valid-typeof,arrow-body-style,camelcase,curly,eqeqeq,max-lines-per-function,max-lines,no-shadow,no-var,object-shorthand,prefer-arrow-callback,prefer-const,prefer-object-spread,yoda,react-jsx-key,react-prop-types,react-react-in-jsx-scope,react-hooks-rules-of-hooks,react-hooks-exhaustive-deps,react-display-name,react-jsx-no-comment-textnodes,react-jsx-no-duplicate-props,react-jsx-no-target-blank,react-jsx-no-undef,react-jsx-uses-react,react-jsx-uses-vars,react-no-children-prop,react-no-danger-with-children,react-no-deprecated,react-no-direct-mutation-state,react-no-find-dom-node,react-no-is-mounted,react-no-render-return-value,react-no-string-refs,react-no-unescaped-entities,react-no-unknown-property,react-require-render-return",
-      ".eslintrc.js",
-      "'src/**/*.js'",
-      "'src/**/*.jsx'",
     ],
     "command": "node",
     "outputFile": "node_modules/.code-pushup/eslint/runner-output.json",

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

@@ -18,3 +18,9 @@ export const eslintPluginConfigSchema = z.object({
 });
 
 export type ESLintPluginConfig = z.infer<typeof eslintPluginConfigSchema>;
+
+export type ESLintPluginRunnerConfig = {
+  eslintrc: string;
+  slugs: string[];
+  patterns: string[];
+};

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

@@ -61,7 +61,7 @@ export async function eslintPlugin(
     audits,
     groups,
 
-    runner: createRunnerConfig(
+    runner: await createRunnerConfig(
       runnerScriptPath,
       audits,
       eslintrcPath,

packages/plugin-eslint/src/lib/runner.integration.test.ts

@@ -1,15 +1,16 @@
 import { ESLint } from 'eslint';
-import { mkdir, rm, writeFile } from 'node:fs/promises';
+import { rm, writeFile } from 'node:fs/promises';
 import os from 'node:os';
 import { dirname, join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { MockInstance, describe, expect, it } from 'vitest';
 import type { AuditOutput, AuditOutputs, Issue } from '@code-pushup/models';
 import { osAgnosticAuditOutputs } from '@code-pushup/test-utils';
-import { readJsonFile } from '@code-pushup/utils';
+import { ensureDirectoryExists, readJsonFile } from '@code-pushup/utils';
 import { listAuditsAndGroups } from './meta';
 import {
   ESLINTRC_PATH,
+  PLUGIN_CONFIG_PATH,
   RUNNER_OUTPUT_PATH,
   createRunnerConfig,
   executeRunner,
@@ -22,17 +23,11 @@ describe.skip('executeRunner', () => {
   let cwdSpy: MockInstance<[], string>;
   let platformSpy: MockInstance<[], NodeJS.Platform>;
 
-  const createArgv = async (eslintrc: string) => {
+  const createPluginConfig = async (eslintrc: string) => {
     const patterns = ['src/**/*.js', 'src/**/*.jsx'];
     const eslint = setupESLint(eslintrc);
     const { audits } = await listAuditsAndGroups(eslint, patterns);
-    const runnerConfig = createRunnerConfig(
-      'bin.js',
-      audits,
-      eslintrc,
-      patterns,
-    );
-    return [runnerConfig.command, ...(runnerConfig.args ?? [])];
+    await createRunnerConfig('bin.js', audits, eslintrc, patterns);
   };
 
   const appDir = join(
@@ -52,7 +47,7 @@ describe.skip('executeRunner', () => {
     const config: ESLint.ConfigData = {
       extends: '@code-pushup',
     };
-    await mkdir(dirname(ESLINTRC_PATH), { recursive: true });
+    await ensureDirectoryExists(dirname(ESLINTRC_PATH));
     await writeFile(ESLINTRC_PATH, JSON.stringify(config));
   });
 
@@ -61,21 +56,20 @@ describe.skip('executeRunner', () => {
     platformSpy.mockRestore();
 
     await rm(ESLINTRC_PATH, { force: true });
+    await rm(PLUGIN_CONFIG_PATH, { force: true });
   });
 
   it('should execute ESLint and create audit results for React application', async () => {
-    const argv = await createArgv('.eslintrc.js');
-
-    await executeRunner(argv);
+    await createPluginConfig('.eslintrc.js');
+    await executeRunner();
 
     const json = await readJsonFile<AuditOutputs>(RUNNER_OUTPUT_PATH);
     expect(osAgnosticAuditOutputs(json)).toMatchSnapshot();
   });
 
   it('should execute runner with inline config using @code-pushup/eslint-config', async () => {
-    const argv = await createArgv(ESLINTRC_PATH);
-
-    await executeRunner(argv);
+    await createPluginConfig(ESLINTRC_PATH);
+    await executeRunner();
 
     const json = await readJsonFile<AuditOutput[]>(RUNNER_OUTPUT_PATH);
     // expect warnings from unicorn/filename-case rule from default config

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

@@ -1,28 +1,28 @@
-import { mkdir, writeFile } from 'node:fs/promises';
-import { platform } from 'node:os';
+import { writeFile } from 'node:fs/promises';
 import { dirname, join } from 'node:path';
 import type { Audit, AuditOutput, RunnerConfig } from '@code-pushup/models';
-import { pluginWorkDir, readJsonFile, toArray } from '@code-pushup/utils';
+import {
+  ensureDirectoryExists,
+  pluginWorkDir,
+  readJsonFile,
+  toArray,
+} from '@code-pushup/utils';
+import { ESLintPluginRunnerConfig } from '../config';
 import { lint } from './lint';
 import { lintResultsToAudits } from './transform';
 
 export const WORKDIR = pluginWorkDir('eslint');
 export const RUNNER_OUTPUT_PATH = join(WORKDIR, 'runner-output.json');
 export const ESLINTRC_PATH = join(process.cwd(), WORKDIR, '.eslintrc.json');
+export const PLUGIN_CONFIG_PATH = join(
+  process.cwd(),
+  WORKDIR,
+  'plugin-config.json',
+);
 
-const AUDIT_SLUGS_SEP = ',';
-
-export async function executeRunner(argv = process.argv): Promise<void> {
-  const [slugs, eslintrc, ...patterns] = argv.slice(2);
-  if (!slugs) {
-    throw new Error('Invalid runner args - missing slugs argument');
-  }
-  if (!eslintrc) {
-    throw new Error('Invalid runner args - missing eslintrc argument');
-  }
-  if (patterns.length === 0) {
-    throw new Error('Invalid runner args - missing patterns argument');
-  }
+export async function executeRunner(): Promise<void> {
+  const { slugs, eslintrc, patterns } =
+    await readJsonFile<ESLintPluginRunnerConfig>(PLUGIN_CONFIG_PATH);
 
   const lintResults = await lint({
     // if file created from inline object, provide inline to preserve relative links
@@ -32,7 +32,7 @@ export async function executeRunner(argv = process.argv): Promise<void> {
   });
   const failedAudits = lintResultsToAudits(lintResults);
 
-  const audits = slugs.split(AUDIT_SLUGS_SEP).map(
+  const audits = slugs.map(
     (slug): AuditOutput =>
       failedAudits.find(audit => audit.slug === slug) ?? {
         slug,
@@ -43,26 +43,27 @@ export async function executeRunner(argv = process.argv): Promise<void> {
       },
   );
 
-  await mkdir(dirname(RUNNER_OUTPUT_PATH), { recursive: true });
+  await ensureDirectoryExists(dirname(RUNNER_OUTPUT_PATH));
   await writeFile(RUNNER_OUTPUT_PATH, JSON.stringify(audits));
 }
 
-export function createRunnerConfig(
+export async function createRunnerConfig(
   scriptPath: string,
   audits: Audit[],
   eslintrc: string,
   patterns: string | string[],
-): RunnerConfig {
+): Promise<RunnerConfig> {
+  const config: ESLintPluginRunnerConfig = {
+    eslintrc,
+    slugs: audits.map(audit => audit.slug),
+    patterns: toArray(patterns),
+  };
+  await ensureDirectoryExists(dirname(PLUGIN_CONFIG_PATH));
+  await writeFile(PLUGIN_CONFIG_PATH, JSON.stringify(config));
+
   return {
     command: 'node',
-    args: [
-      scriptPath,
-      audits.map(audit => audit.slug).join(AUDIT_SLUGS_SEP),
-      eslintrc,
-      ...toArray(patterns).map(pattern =>
-        platform() === 'win32' ? pattern : `'${pattern}'`,
-      ),
-    ],
+    args: [scriptPath],
     outputFile: RUNNER_OUTPUT_PATH,
   };
 }