fix: adjust report logic

BioPhoton · BioPhoton · commit 957c86518ec8 · 2025-08-11T21:14:21.000+02:00
diff --git a/e2e/cli-e2e/tests/collect.e2e.test.ts b/e2e/cli-e2e/tests/collect.e2e.test.ts
@@ -61,14 +61,14 @@ describe('CLI collect', () => {
     expect(md).toContain(dummyAuditTitle);
   });
 
-  it('should not create reports if --persist.no-report is given', async () => {
+  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.no-report',
+        '--persist.skipReports',
       ],
       cwd: dummyDir,
     });
diff --git a/packages/ci/src/lib/run-utils.ts b/packages/ci/src/lib/run-utils.ts
@@ -483,7 +483,7 @@ export function configFromPatterns(
       outputDir: interpolate(persist.outputDir, variables),
       filename: interpolate(persist.filename, variables),
       format: persist.format,
-      report: persist.report,
+      skipReports: persist.skipReports,
     },
     ...(upload && {
       upload: {
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -207,18 +207,18 @@ Each example is fully tested to demonstrate best practices for plugin testing as
 
 ### Common Command Options
 
-| Option                      | Type                 | Default  | Description                                                                      |
-| --------------------------- | -------------------- | -------- | -------------------------------------------------------------------------------- |
-| **`--persist.outputDir`**   | `string`             | n/a      | Directory for the produced reports.                                              |
-| **`--persist.filename`**    | `string`             | `report` | Filename for the produced reports without extension.                             |
-| **`--persist.format`**      | `('json' \| 'md')[]` | `json`   | Format(s) of the report file.                                                    |
-| **`--persist.report`**      | `boolean`            | `true`   | Generate the report files for given formats. (useful in combination wit caching) |
-| **`--upload.organization`** | `string`             | n/a      | Organization slug from portal.                                                   |
-| **`--upload.project`**      | `string`             | n/a      | Project slug from portal.                                                        |
-| **`--upload.server`**       | `string`             | n/a      | URL to your portal server.                                                       |
-| **`--upload.apiKey`**       | `string`             | n/a      | API key for the portal server.                                                   |
-| **`--onlyPlugins`**         | `string[]`           | `[]`     | Only run the specified plugins. Applicable to all commands except `upload`.      |
-| **`--skipPlugins`**         | `string[]`           | `[]`     | Skip the specified plugins. Applicable to all commands except `upload`.          |
+| Option                      | Type                 | Default  | Description                                                                 |
+| --------------------------- | -------------------- | -------- | --------------------------------------------------------------------------- |
+| **`--persist.outputDir`**   | `string`             | n/a      | Directory for the produced reports.                                         |
+| **`--persist.filename`**    | `string`             | `report` | Filename for the produced reports without extension.                        |
+| **`--persist.format`**      | `('json' \| 'md')[]` | `json`   | Format(s) of the report file.                                               |
+| **`--persist.skipReports`** | `boolean`            | `false`  | Skip generating report files. (useful in combination wit caching)           |
+| **`--upload.organization`** | `string`             | n/a      | Organization slug from portal.                                              |
+| **`--upload.project`**      | `string`             | n/a      | Project slug from portal.                                                   |
+| **`--upload.server`**       | `string`             | n/a      | URL to your portal server.                                                  |
+| **`--upload.apiKey`**       | `string`             | n/a      | API key for the portal server.                                              |
+| **`--onlyPlugins`**         | `string[]`           | `[]`     | Only run the specified plugins. Applicable to all commands except `upload`. |
+| **`--skipPlugins`**         | `string[]`           | `[]`     | Skip the specified plugins. Applicable to all commands except `upload`.     |
 
 > [!NOTE]  
 > All common options, except `--onlyPlugins` and `--skipPlugins`, can be specified in the configuration file as well.
diff --git a/packages/cli/src/lib/compare/compare-command.unit.test.ts b/packages/cli/src/lib/compare/compare-command.unit.test.ts
@@ -41,7 +41,7 @@ describe('compare-command', () => {
           outputDir: DEFAULT_PERSIST_OUTPUT_DIR,
           filename: DEFAULT_PERSIST_FILENAME,
           format: DEFAULT_PERSIST_FORMAT,
-          report: true,
+          skipReports: false,
         },
         upload: expect.any(Object),
       },
diff --git a/packages/cli/src/lib/implementation/core-config.int.test.ts b/packages/cli/src/lib/implementation/core-config.int.test.ts
@@ -64,7 +64,7 @@ describe('parsing values from CLI and middleware', () => {
       filename: DEFAULT_PERSIST_FILENAME,
       format: DEFAULT_PERSIST_FORMAT,
       outputDir: DEFAULT_PERSIST_OUTPUT_DIR,
-      report: true,
+      skipReports: false,
     });
   });
 
@@ -86,7 +86,7 @@ describe('parsing values from CLI and middleware', () => {
       filename: 'cli-filename',
       format: ['md'],
       outputDir: 'cli-outputDir',
-      report: true,
+      skipReports: false,
     });
   });
 
@@ -103,7 +103,7 @@ describe('parsing values from CLI and middleware', () => {
       filename: 'rc-filename',
       format: ['json', 'md'],
       outputDir: 'rc-outputDir',
-      report: true,
+      skipReports: false,
     });
   });
 
@@ -125,7 +125,7 @@ describe('parsing values from CLI and middleware', () => {
       filename: 'cli-filename',
       format: ['md'],
       outputDir: 'cli-outputDir',
-      report: true,
+      skipReports: false,
     });
   });
 
@@ -145,7 +145,7 @@ describe('parsing values from CLI and middleware', () => {
       filename: 'rc-filename',
       format: DEFAULT_PERSIST_FORMAT,
       outputDir: 'cli-outputdir',
-      report: true,
+      skipReports: false,
     });
   });
 
diff --git a/packages/cli/src/lib/implementation/core-config.middleware.ts b/packages/cli/src/lib/implementation/core-config.middleware.ts
@@ -53,11 +53,7 @@ export async function coreConfigMiddleware<
       format: normalizeFormats(
         cliPersist?.format ?? rcPersist?.format ?? DEFAULT_PERSIST_FORMAT,
       ),
-      report: normalizeBooleanWithNegation(
-        'report',
-        cliPersist as Record<string, unknown>,
-        rcPersist as Record<string, unknown>,
-      ),
+      skipReports: cliPersist?.skipReports ?? rcPersist?.skipReports ?? false,
     },
     ...(upload != null && { upload }),
     ...remainingRcConfig,
diff --git a/packages/cli/src/lib/implementation/core-config.model.ts b/packages/cli/src/lib/implementation/core-config.model.ts
@@ -4,7 +4,7 @@ export type PersistConfigCliOptions = {
   'persist.outputDir'?: string;
   'persist.filename'?: string;
   'persist.format'?: Format;
-  'persist.report'?: boolean;
+  'persist.skipReports'?: boolean;
 };
 
 export type UploadConfigCliOptions = {
diff --git a/packages/cli/src/lib/implementation/core-config.options.ts b/packages/cli/src/lib/implementation/core-config.options.ts
@@ -31,9 +31,9 @@ export function yargsPersistConfigOptionsDefinition(): Record<
       describe: 'Format of the report output. e.g. `md`, `json`',
       type: 'array',
     },
-    'persist.report': {
+    'persist.skipReports': {
       describe:
-        'Generate the report files for given formats. (useful in combination with caching)',
+        'Skip generating report files. (useful in combination with caching)',
       type: 'boolean',
     },
   };
diff --git a/packages/cli/src/lib/merge-diffs/merge-diffs-command.unit.test.ts b/packages/cli/src/lib/merge-diffs/merge-diffs-command.unit.test.ts
@@ -47,7 +47,7 @@ describe('merge-diffs-command', () => {
         outputDir: DEFAULT_PERSIST_OUTPUT_DIR,
         filename: DEFAULT_PERSIST_FILENAME,
         format: DEFAULT_PERSIST_FORMAT,
-        report: true,
+        skipReports: false,
       },
     );
   });
diff --git a/packages/core/src/lib/collect-and-persist.ts b/packages/core/src/lib/collect-and-persist.ts
@@ -21,8 +21,8 @@ export type CollectAndPersistReportsOptions = Pick<
   CoreConfig,
   'plugins' | 'categories'
 > & {
-  persist: Required<Omit<PersistConfig, 'report'>> &
-    Pick<PersistConfig, 'report'>;
+  persist: Required<Omit<PersistConfig, 'skipReports'>> &
+    Pick<PersistConfig, 'skipReports'>;
 } & Partial<GlobalOptions>;
 
 export async function collectAndPersistReports(
@@ -33,10 +33,9 @@ export async function collectAndPersistReports(
   const sortedScoredReport = sortReport(scoreReport(reportResult));
 
   const { persist } = options;
-  const { report: shouldGenerateReport = true, ...persistOptions } =
-    persist ?? {};
+  const { skipReports = false, ...persistOptions } = persist ?? {};
 
-  if (shouldGenerateReport === true) {
+  if (skipReports !== true) {
     const persistResults = await persistReport(
       reportResult,
       sortedScoredReport,
@@ -47,7 +46,7 @@ export async function collectAndPersistReports(
       logPersistedResults(persistResults);
     }
   } else {
-    logger.info('Skipping saving reports as `persist.report` is false');
+    logger.info('Skipping saving reports as `persist.skipReports` is true');
   }
 
   // terminal output
diff --git a/packages/core/src/lib/collect-and-persist.unit.test.ts b/packages/core/src/lib/collect-and-persist.unit.test.ts
@@ -115,7 +115,7 @@ describe('collectAndPersistReports', () => {
     expect(logPersistedResults).toHaveBeenCalled();
   });
 
-  it('should call collect and not persistReport if report options is false in verbose mode', async () => {
+  it('should call collect and not persistReport if skipReports options is true in verbose mode', async () => {
     const sortedScoredReport = sortReport(scoreReport(MINIMAL_REPORT_MOCK));
 
     vi.stubEnv('CP_VERBOSE', 'true');
@@ -126,7 +126,7 @@ describe('collectAndPersistReports', () => {
         outputDir: 'output',
         filename: 'report',
         format: ['md'],
-        report: false,
+        skipReports: true,
       },
       progress: false,
     };
diff --git a/packages/core/src/lib/implementation/persist.ts b/packages/core/src/lib/implementation/persist.ts
@@ -25,7 +25,7 @@ export class PersistError extends Error {
 export async function persistReport(
   report: Report,
   sortedScoredReport: ScoredReport,
-  options: Required<Omit<PersistConfig, 'report'>>,
+  options: Required<Omit<PersistConfig, 'skipReports'>>,
 ): Promise<MultipleFileResults> {
   const { outputDir, filename, format } = options;
 
diff --git a/packages/models/src/lib/persist-config.ts b/packages/models/src/lib/persist-config.ts
@@ -10,7 +10,7 @@ export const persistConfigSchema = z.object({
     .describe('Artifacts file name (without extension)')
     .optional(),
   format: z.array(formatSchema).optional(),
-  report: z.boolean().optional(),
+  skipReports: z.boolean().optional(),
 });
 
 export type PersistConfig = z.infer<typeof persistConfigSchema>;
diff --git a/packages/utils/src/lib/file-system.ts b/packages/utils/src/lib/file-system.ts
@@ -90,7 +90,7 @@ export function createReportPath({
   filename,
   format,
   suffix,
-}: Omit<Required<PersistConfig>, 'format' | 'report'> & {
+}: Pick<Required<PersistConfig>, 'filename' | 'outputDir'> & {
   format: Format;
   suffix?: string;
 }): string {
