Merge branch 'main' into plugin-coverage-test-improvements

Author: AS

.github/workflows/ci.yml

@@ -139,5 +139,7 @@ jobs:
         uses: nrwl/nx-set-shas@v4
       - name: Install dependencies
         run: npm ci
-      - name: Build affected projects
-        run: npx nx affected:build --parallel=3
+      - name: Build all projects # affected is not used to be able to test-releae packages
+        run: npx nx run-many --target=build --parallel=3
+      - name: Test-release packages
+        run: npx pkg-pr-new publish "packages/**/dist"

CHANGELOG.md

@@ -1,3 +1,25 @@
+## 0.74.0 (2025-08-13)
+
+### 🚀 Features
+
+- add audit output caching for execute plugin ([#1057](https://github.com/code-pushup/cli/pull/1057))
+- add report option to cli ([#1058](https://github.com/code-pushup/cli/pull/1058))
+- add caching options to cli ([#1059](https://github.com/code-pushup/cli/pull/1059))
+
+### ❤️ Thank You
+
+- Michael Hladky @BioPhoton
+
+## 0.73.0 (2025-08-08)
+
+### 🚀 Features
+
+- **ci:** add searchCommits option to extend portal cache range ([0b14111f](https://github.com/code-pushup/cli/commit/0b14111f))
+
+### ❤️ Thank You
+
+- Matěj Chalk
+
 ## 0.72.1 (2025-08-06)
 
 ### 🩹 Fixes

code-pushup.preset.ts

@@ -11,9 +11,8 @@ import eslintPlugin, {
   eslintConfigFromNxProject,
 } from './packages/plugin-eslint/src/index.js';
 import jsPackagesPlugin from './packages/plugin-js-packages/src/index.js';
-import jsDocsPlugin, {
-  JsDocsPluginConfig,
-} from './packages/plugin-jsdocs/src/index.js';
+import jsDocsPlugin from './packages/plugin-jsdocs/src/index.js';
+import type { JsDocsPluginTransformedConfig } from './packages/plugin-jsdocs/src/lib/config.js';
 import {
   PLUGIN_SLUG,
   groups,
@@ -98,7 +97,7 @@ export const eslintCategories: CategoryConfig[] = [
 ];
 
 export function getJsDocsCategories(
-  config: JsDocsPluginConfig,
+  config: JsDocsPluginTransformedConfig,
 ): CategoryConfig[] {
   return [
     {
@@ -147,7 +146,7 @@ export const lighthouseCoreConfig = async (
 };
 
 export const jsDocsCoreConfig = (
-  config: JsDocsPluginConfig | string[],
+  config: JsDocsPluginTransformedConfig | string[],
 ): CoreConfig => ({
   plugins: [
     jsDocsPlugin(Array.isArray(config) ? { patterns: config } : config),
@@ -180,28 +179,25 @@ export const typescriptPluginConfig = async (
 export const coverageCoreConfigNx = async (
   projectName?: string,
 ): Promise<CoreConfig> => {
-  if (projectName) {
-    throw new Error('coverageCoreConfigNx for single projects not implemented');
-  }
   const targetNames = ['unit-test', 'int-test'];
-  const targetArgs = [
-    '-t',
-    ...targetNames,
-    '--coverage.enabled',
-    '--skipNxCache',
-  ];
+  const targetArgs = ['-t', ...targetNames];
   return {
     plugins: [
       await coveragePlugin({
         coverageToolCommand: {
           command: 'npx',
-          args: [
-            'nx',
-            projectName ? `run --project ${projectName}` : 'run-many',
-            ...targetArgs,
-          ],
+          args: projectName
+            ? ['nx', 'run-many', '-p', projectName, ...targetArgs]
+            : ['nx', 'run-many', ...targetArgs],
         },
-        reports: await getNxCoveragePaths(targetNames),
+        reports: projectName
+          ? [
+              {
+                pathToProject: `packages/${projectName}`,
+                resultsPath: `packages/${projectName}/coverage/lcov.info`,
+              },
+            ]
+          : await getNxCoveragePaths(targetNames),
       }),
     ],
     categories: coverageCategories,

e2e/ci-e2e/project.json

@@ -4,17 +4,11 @@
   "sourceRoot": "e2e/ci-e2e/src",
   "projectType": "application",
   "targets": {
-    "lint": {
-      "executor": "@nx/linter:eslint",
-      "outputs": ["{options.outputFile}"],
-      "options": {
-        "lintFilePatterns": ["e2e/ci-e2e/**/*.ts"]
-      }
-    },
+    "lint": {},
     "e2e": {
       "executor": "@nx/vite:test",
       "options": {
-        "configFile": "e2e/ci-e2e/vitest.e2e.config.ts"
+        "configFile": "{projectRoot}/vitest.e2e.config.ts"
       }
     }
   },

e2e/cli-e2e/project.json

@@ -4,17 +4,11 @@
   "sourceRoot": "e2e/cli-e2e/src",
   "projectType": "application",
   "targets": {
-    "lint": {
-      "executor": "@nx/linter:eslint",
-      "outputs": ["{options.outputFile}"],
-      "options": {
-        "lintFilePatterns": ["e2e/cli-e2e/**/*.ts"]
-      }
-    },
+    "lint": {},
     "e2e": {
       "executor": "@nx/vite:test",
       "options": {
-        "configFile": "e2e/cli-e2e/vitest.e2e.config.ts"
+        "configFile": "{projectRoot}/vitest.e2e.config.ts"
       }
     }
   },

e2e/cli-e2e/tests/__snapshots__/help.e2e.test.ts.snap

@@ -36,13 +36,23 @@ Global Options:
   -p, --onlyPlugins     List of plugins to run. If not set all plugins are run.
                                                  [array] [default: []]
 
+Cache Options:
+      --cache        Cache runner outputs (both read and write)
+                                                             [boolean]
+      --cache.read   Read runner-output.json from file system
+                                                             [boolean]
+      --cache.write  Write runner-output.json to file system
+                                                             [boolean]
+
 Persist Options:
-      --persist.outputDir  Directory for the produced reports
+      --persist.outputDir    Directory for the produced reports
                                                               [string]
-      --persist.filename   Filename for the produced reports.
+      --persist.filename     Filename for the produced reports.
                                                               [string]
-      --persist.format     Format of the report output. e.g. \`md\`, \`json\`
+      --persist.format       Format of the report output. e.g. \`md\`, \`json\`
                                                                [array]
+      --persist.skipReports  Skip generating report files. (useful in combinatio
+                             n with caching)            [boolean]
 
 Upload Options:
       --upload.organization  Organization slug from portal

e2e/cli-e2e/tests/collect.e2e.test.ts

@@ -7,7 +7,13 @@ import {
   TEST_OUTPUT_DIR,
   teardownTestFolder,
 } from '@code-pushup/test-utils';
-import { executeProcess, readTextFile } from '@code-pushup/utils';
+import {
+  executeProcess,
+  fileExists,
+  readJsonFile,
+  readTextFile,
+} from '@code-pushup/utils';
+import { dummyPluginSlug } from '../mocks/fixtures/dummy-setup/dummy.plugin';
 
 describe('CLI collect', () => {
   const dummyPluginTitle = 'Dummy Plugin';
@@ -61,6 +67,50 @@ describe('CLI collect', () => {
     expect(md).toContain(dummyAuditTitle);
   });
 
+  it('should write runner outputs if --cache is given', async () => {
+    const { code } = await executeProcess({
+      command: 'npx',
+      args: ['@code-pushup/cli', '--no-progress', 'collect', '--cache'],
+      cwd: dummyDir,
+    });
+
+    expect(code).toBe(0);
+
+    await expect(
+      readJsonFile(
+        path.join(dummyOutputDir, dummyPluginSlug, 'runner-output.json'),
+      ),
+    ).resolves.toStrictEqual([
+      {
+        slug: 'dummy-audit',
+        score: 0.3,
+        value: 3,
+      },
+    ]);
+  });
+
+  it('should not create reports if --persist.skipReports is given', async () => {
+    const { code } = await executeProcess({
+      command: 'npx',
+      args: [
+        '@code-pushup/cli',
+        '--no-progress',
+        'collect',
+        '--persist.skipReports',
+      ],
+      cwd: dummyDir,
+    });
+
+    expect(code).toBe(0);
+
+    await expect(
+      fileExists(path.join(dummyOutputDir, 'report.md')),
+    ).resolves.toBeFalsy();
+    await expect(
+      fileExists(path.join(dummyOutputDir, 'report.json')),
+    ).resolves.toBeFalsy();
+  });
+
   it('should print report summary to stdout', async () => {
     const { code, stdout } = await executeProcess({
       command: 'npx',

e2e/create-cli-e2e/project.json

@@ -4,18 +4,12 @@
   "sourceRoot": "examples/create-cli-e2e/src",
   "projectType": "application",
   "targets": {
-    "lint": {
-      "executor": "@nx/linter:eslint",
-      "outputs": ["{options.outputFile}"],
-      "options": {
-        "lintFilePatterns": ["e2e/create-cli-e2e/**/*.ts"]
-      }
-    },
+    "lint": {},
     "e2e": {
       "executor": "@nx/vite:test",
       "options": {
         "keepServerRunning": true,
-        "configFile": "e2e/create-cli-e2e/vitest.e2e.config.ts"
+        "configFile": "{projectRoot}/vitest.e2e.config.ts"
       }
     }
   },

e2e/nx-plugin-e2e/project.json

@@ -4,17 +4,11 @@
   "sourceRoot": "e2e/nx-plugin-e2e/src",
   "projectType": "application",
   "targets": {
-    "lint": {
-      "executor": "@nx/linter:eslint",
-      "outputs": ["{options.outputFile}"],
-      "options": {
-        "lintFilePatterns": ["e2e/nx-plugin-e2e/**/*.ts"]
-      }
-    },
+    "lint": {},
     "e2e": {
       "executor": "@nx/vite:test",
       "options": {
-        "configFile": "e2e/nx-plugin-e2e/vitest.e2e.config.ts"
+        "configFile": "{projectRoot}/vitest.e2e.config.ts"
       }
     }
   },

e2e/plugin-coverage-e2e/project.json

@@ -4,17 +4,11 @@
   "sourceRoot": "e2e/plugin-coverage-e2e/src",
   "projectType": "application",
   "targets": {
-    "lint": {
-      "executor": "@nx/linter:eslint",
-      "outputs": ["{options.outputFile}"],
-      "options": {
-        "lintFilePatterns": ["e2e/plugin-coverage-e2e/**/*.ts"]
-      }
-    },
+    "lint": {},
     "e2e": {
       "executor": "@nx/vite:test",
       "options": {
-        "configFile": "e2e/plugin-coverage-e2e/vitest.e2e.config.ts"
+        "configFile": "{projectRoot}/vitest.e2e.config.ts"
       }
     }
   },