Merge branch 'main' into add-plugin-targets

# Conflicts:
#	code-pushup.preset.ts

Author: John Doe

.gitignore

@@ -44,7 +44,7 @@ testem.log
 Thumbs.db
 
 # generated Code PushUp reports
-/.code-pushup
+.code-pushup
 
 # Nx workspace cache
 .nx

code-pushup.preset.ts

@@ -9,6 +9,8 @@ import coveragePlugin, {
 import eslintPlugin, {
   eslintConfigFromAllNxProjects,
 } from './packages/plugin-eslint/src/index.js';
+import type { ESLintTarget } from './packages/plugin-eslint/src/lib/config.js';
+import { nxProjectsToConfig } from './packages/plugin-eslint/src/lib/nx/projects-to-config.js';
 import jsPackagesPlugin from './packages/plugin-js-packages/src/index.js';
 import jsDocsPlugin from './packages/plugin-jsdocs/src/index.js';
 import type { JsDocsPluginTransformedConfig } from './packages/plugin-jsdocs/src/lib/config.js';
@@ -155,6 +157,17 @@ export const jsDocsCoreConfig = (
   ),
 });
 
+export async function eslintConfigFromPublishableNxProjects(): Promise<
+  ESLintTarget[]
+> {
+  const { createProjectGraphAsync } = await import('@nx/devkit');
+  const projectGraph = await createProjectGraphAsync({ exitOnError: false });
+  return nxProjectsToConfig(
+    projectGraph,
+    project => project.tags?.includes('publishable') ?? false,
+  );
+}
+
 export const eslintCoreConfigNx = async (
   projectName?: string,
 ): Promise<CoreConfig> => ({
@@ -165,6 +178,21 @@ export const eslintCoreConfigNx = async (
           patterns: ['.'],
         })
       : await eslintPlugin(await eslintConfigFromAllNxProjects()),
+    {
+      artifacts: {
+        generateArtifactsCommand: {
+          command: 'npx',
+          args: [
+            'nx',
+            'run-many',
+            '-t',
+            'lint-reporter',
+            '--projects=tag:publishable',
+          ],
+        },
+        artifactsPaths: 'packages/*/.code-pushup/eslint/eslint-report.json',
+      },
+    },
   ],
   categories: eslintCategories,
 });

nx.json

@@ -56,16 +56,32 @@
     "lint": {
       "inputs": ["lint-eslint-inputs"],
       "executor": "@nx/linter:eslint",
-      "outputs": ["{options.outputFile}"],
       "cache": true,
       "options": {
+        "errorOnUnmatchedPattern": false,
         "maxWarnings": 0,
         "lintFilePatterns": [
           "{projectRoot}/**/*.ts",
           "{projectRoot}/package.json"
         ]
       }
     },
+    "lint-reporter": {
+      "inputs": ["default", "{workspaceRoot}/eslint.config.?(c)js"],
+      "outputs": ["{projectRoot}/.eslint/**/*.json"],
+      "cache": true,
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "nx lint {projectName}",
+        "args": [
+          "--format",
+          "./packages/plugin-eslint/dist/src/lib/formatter/multiple-formats.js"
+        ],
+        "env": {
+          "ESLINT_FORMATTER_CONFIG": "{\"outputDir\":\"{projectRoot}/.eslint\"}"
+        }
+      }
+    },
     "nxv-pkg-install": {
       "parallelism": false
     },

packages/ci/project.json

@@ -6,6 +6,7 @@
   "targets": {
     "build": {},
     "lint": {},
+    "lint-reporter": {},
     "unit-test": {},
     "int-test": {}
   },

packages/cli/project.json

@@ -6,6 +6,7 @@
   "targets": {
     "build": {},
     "lint": {},
+    "lint-reporter": {},
     "unit-test": {},
     "int-test": {},
     "run-help": {

packages/core/project.json

@@ -6,6 +6,7 @@
   "targets": {
     "build": {},
     "lint": {},
+    "lint-reporter": {},
     "unit-test": {},
     "int-test": {}
   },

packages/core/src/lib/implementation/execute-plugin.ts

@@ -66,8 +66,8 @@ export async function executePlugin(
     ? // IF not null, take the result from cache
       ((await readRunnerResults(pluginMeta.slug, outputDir)) ??
       // ELSE execute the plugin runner
-      (await executePluginRunner(pluginConfig)))
-    : await executePluginRunner(pluginConfig);
+      (await executePluginRunner(pluginConfig, persist)))
+    : await executePluginRunner(pluginConfig, persist);
 
   if (cacheWrite) {
     await writeRunnerResults(pluginMeta.slug, outputDir, {

packages/core/src/lib/implementation/execute-plugin.unit.test.ts

@@ -102,7 +102,7 @@ describe('executePlugin', () => {
 
     await expect(
       executePlugin(MINIMAL_PLUGIN_CONFIG_MOCK, {
-        persist: { outputDir: 'dummy-path-result-is-mocked' },
+        persist: { outputDir: MEMFS_VOLUME },
         cache: { read: true, write: false },
       }),
     ).resolves.toStrictEqual({
@@ -122,6 +122,7 @@ describe('executePlugin', () => {
 
     expect(executePluginRunnerSpy).toHaveBeenCalledWith(
       MINIMAL_PLUGIN_CONFIG_MOCK,
+      { outputDir: MEMFS_VOLUME },
     );
   });
 });
@@ -322,8 +323,8 @@ describe('executePlugins', () => {
           {
             ...MINIMAL_PLUGIN_CONFIG_MOCK,
             runner: {
-              command: 'node',
-              args: ['-v'],
+              command: 'echo',
+              args: ['16'],
               outputFile: 'output.json',
               outputTransform: (outputs: unknown): Promise<AuditOutputs> =>
                 Promise.resolve([
@@ -337,7 +338,7 @@ describe('executePlugins', () => {
             },
           },
         ],
-        persist: { outputDir: '.code-pushup' },
+        persist: { outputDir: MEMFS_VOLUME },
         cache: { read: false, write: false },
       },
       { progress: false },

packages/core/src/lib/implementation/runner.ts

@@ -3,6 +3,7 @@ import { writeFile } from 'node:fs/promises';
 import path from 'node:path';
 import {
   type AuditOutputs,
+  type PersistConfig,
   type PluginConfig,
   type RunnerConfig,
   type RunnerFunction,
@@ -14,6 +15,7 @@ import {
   executeProcess,
   fileExists,
   isVerbose,
+  objectToCliArgs,
   readJsonFile,
   removeDirectoryIfExists,
   ui,
@@ -32,12 +34,13 @@ export type ValidatedRunnerResult = Omit<RunnerResult, 'audits'> & {
 
 export async function executeRunnerConfig(
   cfg: RunnerConfig,
+  config: Required<Pick<PersistConfig, 'outputDir'>>,
 ): Promise<RunnerResult> {
   const { args, command, outputFile, outputTransform } = cfg;
 
   const { duration, date } = await executeProcess({
     command,
-    args,
+    args: [...(args ?? []), ...objectToCliArgs(config)],
     observer: {
       onStdout: stdout => {
         if (isVerbose()) {
@@ -66,12 +69,13 @@ export async function executeRunnerConfig(
 
 export async function executeRunnerFunction(
   runner: RunnerFunction,
+  config: PersistConfig,
 ): Promise<RunnerResult> {
   const date = new Date().toISOString();
   const start = performance.now();
 
   // execute plugin runner
-  const audits = await runner();
+  const audits = await runner(config);
 
   // create runner result
   return {
@@ -96,12 +100,13 @@ export class AuditOutputsMissingAuditError extends Error {
 
 export async function executePluginRunner(
   pluginConfig: Pick<PluginConfig, 'audits' | 'runner'>,
+  persist: Required<Pick<PersistConfig, 'outputDir'>>,
 ): Promise<Omit<RunnerResult, 'audits'> & { audits: AuditOutputs }> {
   const { audits: pluginConfigAudits, runner } = pluginConfig;
   const runnerResult: RunnerResult =
     typeof runner === 'object'
-      ? await executeRunnerConfig(runner)
-      : await executeRunnerFunction(runner);
+      ? await executeRunnerConfig(runner, persist)
+      : await executeRunnerFunction(runner, persist);
   const { audits: unvalidatedAuditOutputs, ...executionMeta } = runnerResult;
 
   const result = auditOutputsSchema.safeParse(unvalidatedAuditOutputs);

packages/create-cli/project.json

@@ -6,6 +6,7 @@
   "targets": {
     "build": {},
     "lint": {},
+    "lint-reporter": {},
     "unit-test": {},
     "exec-node": {
       "dependsOn": ["build"],