docs(plugin-eslint): fix code fro new loader

Author: BioPhoton

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

@@ -36,7 +36,7 @@ async function executeLint({
   const outputDir =
     providedOutputDir ?? path.join(DEFAULT_PERSIST_OUTPUT_DIR, 'eslint');
   const filename = `eslint-report-${++rotation}`;
-
+  const outputFile = path.join(outputDir, `${filename}.json`);
   // running as CLI because ESLint#lintFiles() runs out of memory
   await executeProcess({
     command: 'npx',
@@ -45,30 +45,18 @@ async function executeLint({
       ...(eslintrc ? [`--config=${filePathToCliArg(eslintrc)}`] : []),
       ...(typeof eslintrc === 'object' ? ['--no-eslintrc'] : []),
       '--no-error-on-unmatched-pattern',
-      `--format=${path.join(
-        path.dirname(fileURLToPath(import.meta.url)),
-        '../formatter/multiple-formats.js',
-      )}`,
+      '--format=json',
+      `--output-file=${outputFile}`,
       ...toArray(patterns).map(pattern =>
         // globs need to be escaped on Unix
         platform() === 'win32' ? pattern : `'${pattern}'`,
       ),
     ],
     ignoreExitCode: true,
     cwd: process.cwd(),
-    env: {
-      ESLINT_FORMATTER_CONFIG: JSON.stringify({
-        outputDir,
-        filename,
-        formats: ['json'], // Always write JSON to file for tracking
-        terminal: 'stylish', // Always show stylish terminal output for DX
-      }),
-    },
   });
 
-  return readJsonFile<ESLint.LintResult[]>(
-    path.join(outputDir, `${filename}.json`),
-  );
+  return readJsonFile<ESLint.LintResult[]>(outputFile);
 }
 
 function loadRuleOptionsPerFile(

packages/plugin-eslint/src/lib/runner/lint.unit.test.ts

@@ -4,6 +4,14 @@ import { executeProcess } from '@code-pushup/utils';
 import type { ESLintPluginConfig } from '../config.js';
 import { lint } from './lint.js';
 
+/**
+ * Regex pattern to match ESLint report filename format.
+ * Matches: eslint-report.json or eslint-report-{number}.json
+ * - No number: eslint-report.json (no dash)
+ * - With number: eslint-report-123.json (with dash and digits)
+ */
+const ESLINT_REPORT_FILENAME_PATTERN = /eslint-report(?:-\d+)?\.json/;
+
 class MockESLint {
   calculateConfigForFile = vi.fn().mockImplementation(
     (path: string) =>
@@ -133,7 +141,7 @@ describe('lint', () => {
         '--config=".eslintrc.js"',
         '--no-error-on-unmatched-pattern',
         '--format=json',
-        expect.stringMatching(/--output-file=.*eslint-report\.\d+\.json/),
+        expect.stringMatching(ESLINT_REPORT_FILENAME_PATTERN),
         expect.stringMatching(/^'?\*\*\/\*\.js'?$/),
       ],
       ignoreExitCode: true,

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

@@ -27,18 +27,18 @@ export async function loadArtifacts(
       typeof artifacts.generateArtifactsCommand === 'string'
         ? { command: artifacts.generateArtifactsCommand }
         : artifacts.generateArtifactsCommand;
-    await executeProcess({
-      command,
-      args,
-      ignoreExitCode: true,
-    });
 
     // Log the actual command that was executed
     const commandString =
       typeof artifacts.generateArtifactsCommand === 'string'
         ? artifacts.generateArtifactsCommand
         : `${command} ${args.join(' ')}`;
     await ui().logger.log(`$ ${commandString}`);
+    await executeProcess({
+      command,
+      args,
+      ignoreExitCode: true,
+    });
   }
 
   const initialArtifactPaths = Array.isArray(artifacts.artifactsPaths)

packages/plugin-eslint/src/lib/runner/utils.unit.test.ts

@@ -1,14 +1,27 @@
 import type { ESLint } from 'eslint';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { ui } from '@code-pushup/utils';
 import * as utilsModule from '@code-pushup/utils';
 import type { LinterOutput } from './types.js';
 import { loadArtifacts } from './utils.js';
 
+vi.mock('@code-pushup/utils', async () => {
+  const actual = await vi.importActual('@code-pushup/utils');
+  return {
+    ...actual,
+    readJsonFile: vi.fn(),
+    executeProcess: vi.fn(),
+  };
+});
+
+vi.mock('glob', () => ({
+  glob: vi.fn((pattern: string) => Promise.resolve([pattern])),
+}));
+
 describe('loadArtifacts', () => {
   const readJsonFileSpy = vi.spyOn(utilsModule, 'readJsonFile');
   const executeProcessSpy = vi.spyOn(utilsModule, 'executeProcess');
 
-  // Mock data should be raw ESLint.LintResult[] as that's what ESLint CLI outputs
   const mockRawResults1: ESLint.LintResult[] = [
     {
       filePath: '/test/file1.js',
@@ -47,7 +60,6 @@ describe('loadArtifacts', () => {
     },
   ];
 
-  // Expected output after our function wraps raw results in LinterOutput format
   const expectedLinterOutput1: LinterOutput = {
     results: mockRawResults1,
     ruleOptionsPerFile: {},
@@ -60,7 +72,7 @@ describe('loadArtifacts', () => {
 
   const artifactsPaths = ['/path/to/artifact1.json', '/path/to/artifact2.json'];
 
-  beforeEach(async () => {
+  beforeEach(() => {
     vi.clearAllMocks();
     executeProcessSpy.mockResolvedValue({
       stdout: JSON.stringify(mockRawResults1),
@@ -80,6 +92,8 @@ describe('loadArtifacts', () => {
     expect(executeProcessSpy).not.toHaveBeenCalled();
     expect(readJsonFileSpy).toHaveBeenCalledTimes(1);
     expect(readJsonFileSpy).toHaveBeenNthCalledWith(1, artifactsPaths.at(0));
+
+    expect(ui()).not.toHaveLogged('log', expect.stringMatching(/^\$ /));
   });
 
   it('should load multiple artifacts without generateArtifactsCommand', async () => {
@@ -95,6 +109,8 @@ describe('loadArtifacts', () => {
     expect(readJsonFileSpy).toHaveBeenCalledTimes(2);
     expect(readJsonFileSpy).toHaveBeenNthCalledWith(1, artifactsPaths.at(0));
     expect(readJsonFileSpy).toHaveBeenNthCalledWith(2, artifactsPaths.at(1));
+
+    expect(ui()).not.toHaveLogged('log', expect.stringMatching(/^\$ /));
   });
 
   it('should load artifacts with generateArtifactsCommand as string', async () => {
@@ -112,6 +128,7 @@ describe('loadArtifacts', () => {
       command: generateArtifactsCommand,
       ignoreExitCode: true,
     });
+    expect(ui()).toHaveLogged('log', `$ ${generateArtifactsCommand}`);
   });
 
   it('should load artifacts with generateArtifactsCommand as object', async () => {
@@ -131,5 +148,9 @@ describe('loadArtifacts', () => {
       ...generateArtifactsCommand,
       ignoreExitCode: true,
     });
+    expect(ui()).toHaveLogged(
+      'log',
+      '$ nx run-many -t lint --parallel --max-parallel=5',
+    );
   });
 });