refactor: fix lint formatter usage

Author: BioPhoton

.github/workflows/ci.yml

@@ -49,7 +49,7 @@ jobs:
       - name: Install dependencies
         run: npm ci
       - name: Lint affected projects
-        run: npx nx affected:lint --parallel=3
+        run: ESLINT_FORMATTER_PROJECTS_DIR=packages npx nx affected:lint --parallel=3
 
   unit-test:
     strategy:

code-pushup.preset.ts

@@ -177,7 +177,13 @@ export const eslintCoreConfigNx = async (
           eslintrc: `packages/${projectName}/eslint.config.js`,
           patterns: ['.'],
         })
-      : await eslintPlugin(await eslintConfigFromAllNxProjects()),
+      : await eslintPlugin(await eslintConfigFromAllNxProjects(), {
+          artifacts: {
+            generateArtifactsCommand:
+              'ESLINT_FORMATTER_PROJECTS_DIR=packages NX_TUI=false npx nx run-many -t lint --include="packages/**"',
+            artifactsPaths: ['packages/**/.eslint/eslint-report.json'],
+          },
+        }),
   ],
   categories: eslintCategories,
 });

nx.json

@@ -97,13 +97,15 @@
       "cache": true
     },
     "lint": {
+      "dependsOn": ["eslint-formatter-multiple-formats:build"],
       "inputs": ["lint-eslint-inputs"],
       "executor": "@nx/eslint:lint",
       "outputs": ["{options.outputFile}"],
       "cache": true,
       "options": {
         "errorOnUnmatchedPattern": false,
         "maxWarnings": 0,
+        "format": "./tools/eslint-formatter-multiple-formats/dist/index.js",
         "lintFilePatterns": [
           "{projectRoot}/**/*.ts",
           "{projectRoot}/package.json"
@@ -127,16 +129,12 @@
       }
     },
     "lint-formatter": {
-      "inputs": ["default", "{workspaceRoot}/eslint.config.?(c)js"],
-      "outputs": ["{projectRoot}/.eslint/eslint-report*.json"],
-      "cache": true,
+      "dependsOn": ["eslint-formatter-multiple-formats:build"],
+      "inputs": ["lint-eslint-inputs"],
       "executor": "nx:run-commands",
       "options": {
-        "command": "nx lint {projectName}",
-        "args": ["--format=./dist/eslint-multi-format/index.js"],
-        "env": {
-          "ESLINT_FORMATTER_CONFIG": "{\"outputDir\":\"{projectRoot}/.eslint\"}"
-        }
+        "command": "./tools/scripts/lint-formatter.sh {projectName} {projectRoot}",
+        "cwd": "{workspaceRoot}"
       }
     },
     "nxv-pkg-install": {

packages/utils/project.json

@@ -7,6 +7,7 @@
     "build": {},
     "lint": {},
     "lint-report": {},
+    "lint-formatter": {},
     "perf": {
       "command": "npx tsx --tsconfig=../tsconfig.perf.json",
       "options": {

tools/eslint-formatter-multiple-formats/package.json

@@ -32,8 +32,7 @@
     "access": "public"
   },
   "dependencies": {
-    "eslint-formatter-stylish": "^8.40.0",
-    "@code-pushup/utils": "0.77.0"
+    "ansis": "^3.3.0"
   },
   "peerDependencies": {
     "eslint": "^8.0.0 || ^9.0.0"

tools/eslint-formatter-multiple-formats/project.json

@@ -12,7 +12,7 @@
       "executor": "@nx/vite:build",
       "outputs": ["{options.outputPath}"],
       "options": {
-        "outputPath": "dist/eslint-multi-format"
+        "outputPath": "{projectRoot}/dist"
       }
     }
   }

tools/eslint-formatter-multiple-formats/src/lib/multiple-formats.ts

@@ -1,18 +1,25 @@
 import type { ESLint } from 'eslint';
 import path from 'node:path';
-import type { EslintFormat, FormatterConfig } from './types.js';
+import * as process from 'node:process';
+import type { FormatterConfig } from './types.js';
+import type { EslintFormat } from './utils.js';
 import {
   formatTerminalOutput,
   findConfigFromEnv as getConfigFromEnv,
   persistEslintReports,
 } from './utils.js';
 
-export const DEFAULT_OUTPUT_DIR = path.join(process.cwd(), '.eslint');
+export const DEFAULT_OUTPUT_DIR = '.eslint';
 export const DEFAULT_FILENAME = 'eslint-report';
 export const DEFAULT_FORMATS = ['json'] as EslintFormat[];
 export const DEFAULT_TERMINAL = 'stylish' as EslintFormat;
 
-export const DEFAULT_CONFIG: Required<FormatterConfig> = {
+export const DEFAULT_CONFIG: Required<
+  Pick<
+    FormatterConfig,
+    'outputDir' | 'filename' | 'formats' | 'terminal' | 'verbose'
+  >
+> = {
   outputDir: DEFAULT_OUTPUT_DIR,
   filename: DEFAULT_FILENAME,
   formats: DEFAULT_FORMATS,
@@ -48,19 +55,29 @@ export default function multipleFormats(
   results: ESLint.LintResult[],
   _args?: unknown,
 ): string {
-  const config = { ...DEFAULT_CONFIG, ...getConfigFromEnv(process.env) };
+  const config = {
+    ...DEFAULT_CONFIG,
+    ...getConfigFromEnv(process.env),
+  } satisfies FormatterConfig;
 
   const {
     outputDir = DEFAULT_OUTPUT_DIR,
-    filename = DEFAULT_FILENAME,
-    formats = DEFAULT_FORMATS,
+    projectsDir,
+    projectName = process.env['NX_TASK_TARGET_PROJECT'],
+    filename,
+    formats,
     terminal,
     verbose = false,
   } = config;
 
+  const filalOutputDir =
+    typeof projectName === 'string' && typeof projectsDir === 'string'
+      ? path.join(projectsDir ?? '', projectName ?? '', outputDir)
+      : outputDir;
+
   try {
     persistEslintReports(formats, results, {
-      outputDir,
+      outputDir: filalOutputDir,
       filename,
       verbose,
     });

tools/eslint-formatter-multiple-formats/src/lib/types.ts

@@ -1,9 +1,8 @@
-export type EslintFormat = 'stylish' | 'json' | string;
+import type { EslintFormat, PersistConfig } from './utils.js';
 
-export type FormatterConfig = {
-  outputDir?: string;
-  filename?: string;
+export type FormatterConfig = Omit<PersistConfig, 'format'> & {
+  projectsDir?: string; // e.g. 'apps' or 'packages' to make paths relative to these folders
+  projectName?: string; // e.g. 'utils' or 'models' also auto-derived for Nx environment variables
   formats?: EslintFormat[];
   terminal?: EslintFormat;
-  verbose?: boolean;
 };