feat(cli): use default report paths if --before/--after missing in compare command

matejchalk · matejchalk · commit 1c22dfa46606 · 2025-08-05T09:37:38.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -44,7 +44,7 @@ testem.log
 Thumbs.db
 
 # generated Code PushUp reports
-**/.code-pushup
+/.code-pushup
 
 # Nx workspace cache
 .nx
diff --git a/e2e/cli-e2e/mocks/fixtures/existing-reports/.code-pushup/report-after.json b/e2e/cli-e2e/mocks/fixtures/existing-reports/.code-pushup/report-after.json
diff --git a/e2e/cli-e2e/mocks/fixtures/existing-reports/.code-pushup/report-after.md b/e2e/cli-e2e/mocks/fixtures/existing-reports/.code-pushup/report-after.md
diff --git a/e2e/cli-e2e/mocks/fixtures/existing-reports/.code-pushup/report-before.json b/e2e/cli-e2e/mocks/fixtures/existing-reports/.code-pushup/report-before.json
diff --git a/e2e/cli-e2e/mocks/fixtures/existing-reports/.code-pushup/report-before.md b/e2e/cli-e2e/mocks/fixtures/existing-reports/.code-pushup/report-before.md
diff --git a/e2e/cli-e2e/tests/compare.e2e.test.ts b/e2e/cli-e2e/tests/compare.e2e.test.ts
@@ -39,12 +39,7 @@ describe('CLI compare', () => {
   it('should compare report.json files and create report-diff.json and report-diff.md', async () => {
     await executeProcess({
       command: 'npx',
-      args: [
-        '@code-pushup/cli',
-        'compare',
-        `--before=${path.join('.code-pushup', 'source-report.json')}`,
-        `--after=${path.join('.code-pushup', 'target-report.json')}`,
-      ],
+      args: ['@code-pushup/cli', 'compare'],
       cwd: existingDir,
     });
 
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -279,7 +279,7 @@ Refer to the [Common Command Options](#common-command-options) for the list of a
 | **`--from`**             | `string`  | n/a     | Hash to start in history                                         |
 | **`--to`**               | `string`  | n/a     | Hash to end in history                                           |
 
-### `compare` command
+#### `compare` command
 
 Usage:
 `code-pushup compare --before SOURCE_PATH --after TARGET_PATH [options]`
@@ -289,11 +289,13 @@ Compare 2 reports and produce a report diff file.
 
 In addition to the [Common Command Options](#common-command-options), the following options are recognized by the `compare` command:
 
-| Option         | Required | Type     | Description                         |
-| -------------- | :------: | -------- | ----------------------------------- |
-| **`--before`** |   yes    | `string` | Path to source `report.json`.       |
-| **`--after`**  |   yes    | `string` | Path to target `report.json`.       |
-| **`--label`**  |    no    | `string` | Label for diff (e.g. project name). |
+| Option         | Type     | Default                                | Description                         |
+| -------------- | -------- | -------------------------------------- | ----------------------------------- |
+| **`--before`** | `string` | `.code-pushup/report-before.json` [^1] | Path to source `report.json`.       |
+| **`--after`**  | `string` | `.code-pushup/report-after.json` [^1]  | Path to target `report.json`.       |
+| **`--label`**  | `string` | n/a                                    | Label for diff (e.g. project name). |
+
+[^1]: Uses `persist` config to determine report paths, so default file paths are actually `${persist.outputDir}/${persist.filename}-before.json` and `${persist.outputDir}/${persist.filename}-after.json`.
 
 #### `print-config` command
 
@@ -309,7 +311,7 @@ In addition to the [Common Command Options](#common-command-options), the follow
 | -------------- | :------: | -------- | -------------------------------------------------------- |
 | **`--output`** |    no    | `string` | Path to output file to print config (default is stdout). |
 
-### `merge-diffs` command
+#### `merge-diffs` command
 
 Usage:
 `code-pushup merge-diffs --files PATH_1 PATH_2 ... [options]`
diff --git a/packages/cli/src/lib/implementation/compare.model.ts b/packages/cli/src/lib/implementation/compare.model.ts
@@ -1,3 +1,5 @@
-import type { Diff } from '@code-pushup/utils';
-
-export type CompareOptions = Diff<string> & { label?: string };
+export type CompareOptions = {
+  before?: string;
+  after?: string;
+  label?: string;
+};
diff --git a/packages/cli/src/lib/implementation/compare.options.ts b/packages/cli/src/lib/implementation/compare.options.ts
@@ -9,12 +9,10 @@ export function yargsCompareOptionsDefinition(): Record<
     before: {
       describe: 'Path to source report.json',
       type: 'string',
-      demandOption: true,
     },
     after: {
       describe: 'Path to target report.json',
       type: 'string',
-      demandOption: true,
     },
     label: {
       describe: 'Label for diff (e.g. project name)',
diff --git a/packages/cli/src/lib/yargs-cli.int.test.ts b/packages/cli/src/lib/yargs-cli.int.test.ts
@@ -160,15 +160,6 @@ describe('yargsCli', () => {
     expect(parsedArgv.after).toBe('target-report.json');
   });
 
-  it('should error if required compare option is missing', () => {
-    expect(() =>
-      yargsCli<GeneralCliOptions & CompareOptions>([], {
-        options: { ...options, ...yargsCompareOptionsDefinition() },
-        noExitProcess: true,
-      }).parse(),
-    ).toThrow('Missing required arguments: before, after');
-  });
-
   it('should parse merge-diffs options', async () => {
     const parsedArgv = await yargsCli<GeneralCliOptions & MergeDiffsOptions>(
       [
diff --git a/packages/core/src/lib/compare.ts b/packages/core/src/lib/compare.ts
@@ -27,16 +27,19 @@ import {
 import { loadPortalClient } from './load-portal-client.js';
 
 export async function compareReportFiles(
-  inputPaths: Diff<string>,
+  inputPaths: Partial<Diff<string>>,
   persistConfig: Required<PersistConfig>,
   uploadConfig: UploadConfig | undefined,
   label?: string,
 ): Promise<string[]> {
   const { outputDir, filename, format } = persistConfig;
 
+  const defaultInputPath = (suffix: keyof Diff<string>) =>
+    createReportPath({ outputDir, filename, format: 'json', suffix });
+
   const [reportBefore, reportAfter] = await Promise.all([
-    readJsonFile(inputPaths.before),
-    readJsonFile(inputPaths.after),
+    readJsonFile(inputPaths.before ?? defaultInputPath('before')),
+    readJsonFile(inputPaths.after ?? defaultInputPath('after')),
   ]);
   const reports: Diff<Report> = {
     before: reportSchema.parse(reportBefore),
diff --git a/packages/core/src/lib/compare.unit.test.ts b/packages/core/src/lib/compare.unit.test.ts
@@ -1,5 +1,5 @@
 import { vol } from 'memfs';
-import { readFile } from 'node:fs/promises';
+import * as fs from 'node:fs/promises';
 import path from 'node:path';
 import { getPortalComparisonLink } from '@code-pushup/portal-client';
 import {
@@ -24,26 +24,68 @@ describe('compareReportFiles', () => {
     after: REPORT_MOCK.commit!.hash,
   };
 
+  beforeAll(() => {
+    vi.spyOn(fs, 'readFile');
+  });
+
   beforeEach(() => {
     vol.fromJSON(
       {
-        'source-report.json': JSON.stringify(MINIMAL_REPORT_MOCK),
-        'target-report.json': JSON.stringify(REPORT_MOCK),
+        'report-before.json': JSON.stringify(MINIMAL_REPORT_MOCK),
+        'report-after.json': JSON.stringify(REPORT_MOCK),
       },
       MEMFS_VOLUME,
     );
   });
 
-  it('should create valid report-diff.json from report.json files', async () => {
+  it('should read report files from default locations', async () => {
+    await compareReportFiles(
+      {},
+      { outputDir: MEMFS_VOLUME, filename: 'report', format: ['json'] },
+      undefined,
+    );
+
+    expect(fs.readFile).toHaveBeenCalledWith(
+      path.join(MEMFS_VOLUME, 'report-before.json'),
+    );
+    expect(fs.readFile).toHaveBeenCalledWith(
+      path.join(MEMFS_VOLUME, 'report-after.json'),
+    );
+  });
+
+  it('should read report files from custom locations', async () => {
+    vol.fromJSON(
+      {
+        '.code-pushup/.ci/.prev/report.json': JSON.stringify(REPORT_MOCK),
+        '.code-pushup/.ci/.curr/report.json': JSON.stringify(REPORT_MOCK),
+      },
+      MEMFS_VOLUME,
+    );
+
     await compareReportFiles(
       {
-        before: path.join(MEMFS_VOLUME, 'source-report.json'),
-        after: path.join(MEMFS_VOLUME, 'target-report.json'),
+        before: path.join(MEMFS_VOLUME, '.code-pushup/.ci/.prev/report.json'),
+        after: path.join(MEMFS_VOLUME, '.code-pushup/.ci/.curr/report.json'),
       },
       { outputDir: MEMFS_VOLUME, filename: 'report', format: ['json'] },
       undefined,
     );
 
+    expect(fs.readFile).toHaveBeenCalledWith(
+      path.join(MEMFS_VOLUME, '.code-pushup/.ci/.prev/report.json'),
+    );
+    expect(fs.readFile).toHaveBeenCalledWith(
+      path.join(MEMFS_VOLUME, '.code-pushup/.ci/.curr/report.json'),
+    );
+  });
+
+  it('should create valid report-diff.json from report.json files', async () => {
+    await compareReportFiles(
+      {},
+      { outputDir: MEMFS_VOLUME, filename: 'report', format: ['json'] },
+      undefined,
+    );
+
     const reportsDiffPromise = readJsonFile(
       path.join(MEMFS_VOLUME, 'report-diff.json'),
     );
@@ -55,10 +97,7 @@ describe('compareReportFiles', () => {
 
   it('should create all diff files specified by persist.format', async () => {
     await compareReportFiles(
-      {
-        before: path.join(MEMFS_VOLUME, 'source-report.json'),
-        after: path.join(MEMFS_VOLUME, 'target-report.json'),
-      },
+      {},
       { outputDir: MEMFS_VOLUME, filename: 'report', format: ['json', 'md'] },
       undefined,
     );
@@ -73,10 +112,7 @@ describe('compareReportFiles', () => {
 
   it('should include portal link (fetched using upload config) in Markdown file', async () => {
     await compareReportFiles(
-      {
-        before: path.join(MEMFS_VOLUME, 'source-report.json'),
-        after: path.join(MEMFS_VOLUME, 'target-report.json'),
-      },
+      {},
       { outputDir: MEMFS_VOLUME, filename: 'report', format: ['json', 'md'] },
       {
         server: 'https://api.code-pushup.dev/graphql',
@@ -87,7 +123,7 @@ describe('compareReportFiles', () => {
     );
 
     await expect(
-      readFile(path.join(MEMFS_VOLUME, 'report-diff.md'), 'utf8'),
+      fs.readFile(path.join(MEMFS_VOLUME, 'report-diff.md'), 'utf8'),
     ).resolves.toContain(
       `[🕵️ See full comparison in Code PushUp portal 🔍](https://code-pushup.example.com/portal/dunder-mifflin/website/comparison/${commitShas.before}/${commitShas.after})`,
     );
@@ -108,16 +144,13 @@ describe('compareReportFiles', () => {
 
   it('should not include portal link in Markdown if upload config is missing', async () => {
     await compareReportFiles(
-      {
-        before: path.join(MEMFS_VOLUME, 'source-report.json'),
-        after: path.join(MEMFS_VOLUME, 'target-report.json'),
-      },
+      {},
       { outputDir: MEMFS_VOLUME, filename: 'report', format: ['json', 'md'] },
       undefined,
     );
 
     await expect(
-      readFile(path.join(MEMFS_VOLUME, 'report-diff.md'), 'utf8'),
+      fs.readFile(path.join(MEMFS_VOLUME, 'report-diff.md'), 'utf8'),
     ).resolves.not.toContain(
       '[🕵️ See full comparison in Code PushUp portal 🔍]',
     );
@@ -151,7 +184,7 @@ describe('compareReportFiles', () => {
     );
 
     await expect(
-      readFile(path.join(MEMFS_VOLUME, 'report-diff.md'), 'utf8'),
+      fs.readFile(path.join(MEMFS_VOLUME, 'report-diff.md'), 'utf8'),
     ).resolves.not.toContain(
       '[🕵️ See full comparison in Code PushUp portal 🔍]',
     );
@@ -161,10 +194,7 @@ describe('compareReportFiles', () => {
 
   it('should include portal link in JSON file', async () => {
     await compareReportFiles(
-      {
-        before: path.join(MEMFS_VOLUME, 'source-report.json'),
-        after: path.join(MEMFS_VOLUME, 'target-report.json'),
-      },
+      {},
       { outputDir: MEMFS_VOLUME, filename: 'report', format: ['json', 'md'] },
       {
         server: 'https://api.code-pushup.dev/graphql',
@@ -185,10 +215,7 @@ describe('compareReportFiles', () => {
 
   it('should include label in JSON file', async () => {
     await compareReportFiles(
-      {
-        before: path.join(MEMFS_VOLUME, 'source-report.json'),
-        after: path.join(MEMFS_VOLUME, 'target-report.json'),
-      },
+      {},
       { outputDir: MEMFS_VOLUME, filename: 'report', format: ['json', 'md'] },
       undefined,
       'backoffice',
@@ -243,7 +270,7 @@ describe('compareReports', () => {
     it('should contain all categories/groups/audits in unchanged arrays', () => {
       const reportsDiff = compareReports(mockReports);
       expect(reportsDiff.categories.unchanged).toHaveLength(
-        mockReport.categories.length,
+        mockReport.categories!.length,
       );
       expect(reportsDiff.groups.unchanged).toHaveLength(
         mockReport.plugins.reduce((acc, { groups }) => acc + groups!.length, 0),
@@ -273,7 +300,7 @@ describe('compareReports', () => {
     it('should only have added categories (minimal report has none)', () => {
       const reportsDiff = compareReports(mockReports);
       expect(reportsDiff.categories.added).toHaveLength(
-        REPORT_MOCK.categories.length,
+        REPORT_MOCK.categories!.length,
       );
       expect(reportsDiff.categories.removed).toHaveLength(0);
       expect(reportsDiff.categories.changed).toHaveLength(0);
