feat(cli): include md format by default

Author: matejchalk

packages/cli/src/lib/collect/collect-command.unit.test.ts

@@ -1,5 +1,11 @@
 import { describe, expect, it, vi } from 'vitest';
 import { collectAndPersistReports, readRcByPath } from '@code-pushup/core';
+import {
+  DEFAULT_PERSIST_FILENAME,
+  DEFAULT_PERSIST_FORMAT,
+  DEFAULT_PERSIST_OUTPUT_DIR,
+  PersistConfig,
+} from '@code-pushup/models';
 import { DEFAULT_CLI_CONFIGURATION } from '../../../mocks/constants';
 import { yargsCli } from '../yargs-cli';
 import { yargsCollectCommandObject } from './collect-command';
@@ -31,10 +37,10 @@ describe('collect-command', () => {
     expect(collectAndPersistReports).toHaveBeenCalledWith(
       expect.objectContaining({
         config: '/test/code-pushup.config.ts',
-        persist: expect.objectContaining({
-          filename: 'report',
-          outputDir: '.code-pushup',
-          format: ['json'],
+        persist: expect.objectContaining<Required<PersistConfig>>({
+          filename: DEFAULT_PERSIST_FILENAME,
+          outputDir: DEFAULT_PERSIST_OUTPUT_DIR,
+          format: DEFAULT_PERSIST_FORMAT,
         }),
       }),
     );

packages/cli/src/lib/compare/compare-command.unit.test.ts

@@ -1,6 +1,9 @@
 import { join } from 'node:path';
 import { compareReportFiles } from '@code-pushup/core';
-import { PERSIST_FILENAME, PERSIST_OUTPUT_DIR } from '@code-pushup/models';
+import {
+  DEFAULT_PERSIST_FILENAME,
+  DEFAULT_PERSIST_OUTPUT_DIR,
+} from '@code-pushup/models';
 import { DEFAULT_CLI_CONFIGURATION } from '../../../mocks/constants';
 import { yargsCli } from '../yargs-cli';
 import { yargsCompareCommandObject } from './compare-command';
@@ -27,7 +30,7 @@ describe('compare-command', () => {
       Parameters<typeof compareReportFiles>
     >(
       { before: 'source-report.json', after: 'target-report.json' },
-      join(PERSIST_OUTPUT_DIR, `${PERSIST_FILENAME}-diff.json`),
+      join(DEFAULT_PERSIST_OUTPUT_DIR, `${DEFAULT_PERSIST_FILENAME}-diff.json`),
     );
   });
 });

packages/cli/src/lib/implementation/core-config.integration.test.ts

@@ -1,9 +1,9 @@
 import { describe, expect, vi } from 'vitest';
 import {
   CoreConfig,
-  PERSIST_FILENAME,
-  PERSIST_FORMAT,
-  PERSIST_OUTPUT_DIR,
+  DEFAULT_PERSIST_FILENAME,
+  DEFAULT_PERSIST_FORMAT,
+  DEFAULT_PERSIST_OUTPUT_DIR,
   PersistConfig,
   UploadConfig,
 } from '@code-pushup/models';
@@ -61,9 +61,9 @@ describe('parsing values from CLI and middleware', () => {
     ).parseAsync();
 
     expect(persist).toEqual<PersistConfig>({
-      filename: PERSIST_FILENAME,
-      format: PERSIST_FORMAT,
-      outputDir: PERSIST_OUTPUT_DIR,
+      filename: DEFAULT_PERSIST_FILENAME,
+      format: DEFAULT_PERSIST_FORMAT,
+      outputDir: DEFAULT_PERSIST_OUTPUT_DIR,
     });
   });
 
@@ -139,7 +139,7 @@ describe('parsing values from CLI and middleware', () => {
 
     expect(persist).toEqual<PersistConfig>({
       filename: 'rc-filename',
-      format: PERSIST_FORMAT,
+      format: DEFAULT_PERSIST_FORMAT,
       outputDir: 'cli-outputdir',
     });
   });

packages/cli/src/lib/implementation/core-config.middleware.ts

@@ -1,9 +1,9 @@
 import { autoloadRc, readRcByPath } from '@code-pushup/core';
 import {
   CoreConfig,
-  PERSIST_FILENAME,
-  PERSIST_FORMAT,
-  PERSIST_OUTPUT_DIR,
+  DEFAULT_PERSIST_FILENAME,
+  DEFAULT_PERSIST_FORMAT,
+  DEFAULT_PERSIST_OUTPUT_DIR,
   uploadConfigSchema,
 } from '@code-pushup/models';
 import { CoreConfigCliOptions } from './core-config.model';
@@ -46,9 +46,12 @@ export async function coreConfigMiddleware<
     ...(config != null && { config }),
     persist: {
       outputDir:
-        cliPersist?.outputDir ?? rcPersist?.outputDir ?? PERSIST_OUTPUT_DIR,
-      format: cliPersist?.format ?? rcPersist?.format ?? PERSIST_FORMAT,
-      filename: cliPersist?.filename ?? rcPersist?.filename ?? PERSIST_FILENAME,
+        cliPersist?.outputDir ??
+        rcPersist?.outputDir ??
+        DEFAULT_PERSIST_OUTPUT_DIR,
+      filename:
+        cliPersist?.filename ?? rcPersist?.filename ?? DEFAULT_PERSIST_FILENAME,
+      format: cliPersist?.format ?? rcPersist?.format ?? DEFAULT_PERSIST_FORMAT,
     },
     ...(upload != null && { upload }),
     categories: rcCategories ?? [],

packages/models/src/index.ts

@@ -21,9 +21,9 @@ export {
   SUPPORTED_CONFIG_FILE_FORMATS,
 } from './lib/implementation/configuration';
 export {
-  PERSIST_FILENAME,
-  PERSIST_FORMAT,
-  PERSIST_OUTPUT_DIR,
+  DEFAULT_PERSIST_FILENAME,
+  DEFAULT_PERSIST_FORMAT,
+  DEFAULT_PERSIST_OUTPUT_DIR,
 } from './lib/implementation/constants';
 export {
   MAX_DESCRIPTION_LENGTH,

packages/models/src/lib/implementation/constants.ts

@@ -1,5 +1,5 @@
 import { Format } from '../persist-config';
 
-export const PERSIST_OUTPUT_DIR = '.code-pushup';
-export const PERSIST_FORMAT: Format[] = ['json'];
-export const PERSIST_FILENAME = 'report';
+export const DEFAULT_PERSIST_OUTPUT_DIR = '.code-pushup';
+export const DEFAULT_PERSIST_FILENAME = 'report';
+export const DEFAULT_PERSIST_FORMAT: Format[] = ['json', 'md'];

testing/test-utils/src/lib/utils/dynamic-mocks/persist-config.mock.ts

@@ -1,7 +1,7 @@
 import {
-  PERSIST_FILENAME,
-  PERSIST_FORMAT,
-  PERSIST_OUTPUT_DIR,
+  DEFAULT_PERSIST_FILENAME,
+  DEFAULT_PERSIST_FORMAT,
+  DEFAULT_PERSIST_OUTPUT_DIR,
   PersistConfig,
   persistConfigSchema,
 } from '@code-pushup/models';
@@ -10,9 +10,9 @@ export function persistConfigMock(
   opt?: Partial<PersistConfig>,
 ): Required<PersistConfig> {
   return persistConfigSchema.parse({
-    outputDir: PERSIST_OUTPUT_DIR,
-    filename: PERSIST_FILENAME,
-    format: PERSIST_FORMAT,
+    outputDir: DEFAULT_PERSIST_OUTPUT_DIR,
+    filename: DEFAULT_PERSIST_FILENAME,
+    format: DEFAULT_PERSIST_FORMAT,
     ...opt,
   }) as Required<PersistConfig>;
 }