feat(utils): ensure consistent line breaks in stdout report

matejchalk · matejchalk · commit f95b62514412 · 2025-12-08T18:12:40.000+01:00
diff --git a/e2e/cli-e2e/tests/collect.e2e.test.ts b/e2e/cli-e2e/tests/collect.e2e.test.ts
@@ -59,7 +59,7 @@ describe('CLI collect', () => {
 
     const md = await readTextFile(path.join(dummyOutputDir, 'report.md'));
 
-    expect(md).toContain('# Code PushUp Report');
+    expect(md).toContain('# Code PushUp report');
     expect(md).toContain(dummyPluginTitle);
     expect(md).toContain(dummyAuditTitle);
   });
@@ -112,7 +112,7 @@ describe('CLI collect', () => {
 
     expect(code).toBe(0);
 
-    expect(stdout).toContain('Code PushUp Report');
+    expect(stdout).toContain('Code PushUp report');
     expect(stdout).not.toContain('Generated reports');
     expect(stdout).toContain(dummyPluginTitle);
     expect(stdout).toContain(dummyAuditTitle);
diff --git a/packages/ci/mocks/fixtures/outputs/report-after.md b/packages/ci/mocks/fixtures/outputs/report-after.md
@@ -1,4 +1,4 @@
-# Code PushUp Report
+# Code PushUp report
 
 ## 🛡️ Audits
 
diff --git a/packages/ci/mocks/fixtures/outputs/report-before.md b/packages/ci/mocks/fixtures/outputs/report-before.md
@@ -1,4 +1,4 @@
-# Code PushUp Report
+# Code PushUp report
 
 ## 🛡️ Audits
 
diff --git a/packages/cli/docs/custom-plugins.md b/packages/cli/docs/custom-plugins.md
@@ -92,7 +92,7 @@ Execute the CLI with `npx code-pushup collect` and you should the following outp
 <summary> <b>stdout of CLI for the above code</b> (collapsed for brevity) </summary>
 
 ```sh
-Code PushUp Report - @code-pushup/core@x.y.z
+Code PushUp report
 
 My plugin audits
 ● My audit                                                            0
@@ -240,7 +240,7 @@ Now we can execute the CLI with `npx code-pushup collect` and see a similar outp
 <summary> <b>stdout of CLI for the above code</b> (collapsed for brevity) </summary>
 
 ```sh
-Code PushUp Report - @code-pushup/core@x.y.z
+Code PushUp report
 
 File size plugin audits
 ● File size audit                                                            2 files
@@ -371,7 +371,7 @@ Now we can execute the CLI with `npx code-pushup collect` and see a similar outp
 <summary> <b>stdout of CLI for the above code</b> (collapsed for brevity) </summary>
 
 ```sh
-Code PushUp Report - @code-pushup/core@x.y.z
+Code PushUp report
 
 Chrome Lighthosue audits
 ● Largest Contentful Paint                                                0
@@ -656,7 +656,7 @@ Test the output by running `npx code-pushup collect`.
 <summary> <b>stdout of basic lighthouse plugin</b> (collapsed for brevity) </summary>
 
 ```sh
-Code PushUp Report - @code-pushup/core@x.y.z
+Code PushUp report
 
 Chrome Lighthouse audits
 ● Largest Contentful Paint                                                1,3 s
diff --git a/packages/cli/src/lib/autorun/autorun-command.ts b/packages/cli/src/lib/autorun/autorun-command.ts
@@ -36,7 +36,6 @@ export function yargsAutorunCommandObject() {
       };
 
       await collectAndPersistReports(optionsWithFormat);
-      logger.newline();
 
       if (!options.categories?.length) {
         renderCategoriesHint();
diff --git a/packages/cli/src/lib/collect/collect-command.ts b/packages/cli/src/lib/collect/collect-command.ts
@@ -3,7 +3,6 @@ import {
   type CollectAndPersistReportsOptions,
   collectAndPersistReports,
 } from '@code-pushup/core';
-import { logger } from '@code-pushup/utils';
 import {
   printCliCommand,
   renderCategoriesHint,
@@ -24,15 +23,13 @@ export function yargsCollectCommandObject(): CommandModule {
       await collectAndPersistReports(options);
 
       if (!options.categories?.length) {
-        logger.newline();
         renderCategoriesHint();
       }
 
       const { upload } = args as unknown as Record<
         'upload',
         object | undefined
       >;
-      logger.newline();
       if (upload) {
         renderUploadHint();
       } else {
diff --git a/packages/core/src/lib/collect-and-persist.ts b/packages/core/src/lib/collect-and-persist.ts
@@ -43,5 +43,8 @@ export async function collectAndPersistReports(
 
   // terminal output
   logger.newline();
+  logger.newline();
   logStdoutSummary(sortedScoredReport);
+  logger.newline();
+  logger.newline();
 }
diff --git a/packages/utils/src/lib/reports/__snapshots__/generate-md-report.unit.test.ts.snap b/packages/utils/src/lib/reports/__snapshots__/generate-md-report.unit.test.ts.snap
@@ -68,7 +68,7 @@ No unsafe any assignment [📖 Docs](https://web.dev/lcp)
 `;
 
 exports[`generateMdReport > should render complete md report 1`] = `
-"# Code PushUp Report
+"# Code PushUp report
 
 | 🏷 Category                 |   ⭐ Score    | 🛡 Audits |
 | :-------------------------- | :----------: | :-------: |
diff --git a/packages/utils/src/lib/reports/__snapshots__/report-stdout-all-perfect-scores.txt b/packages/utils/src/lib/reports/__snapshots__/report-stdout-all-perfect-scores.txt
@@ -1,11 +1,9 @@
-Code PushUp Report - @code-pushup/core@0.0.1
-
+Code PushUp report
 
 ESLint audits
 
 ●  ... All 47 audits have perfect scores ...
 
-
 Lighthouse audits
 
 ●  Minimize third-party usage                  Third-party code blocked the main
@@ -26,4 +24,3 @@ Categories
 └──────────────────┴─────────┴──────────┘
 
 Made with ❤ by code-pushup.dev
-
diff --git a/packages/utils/src/lib/reports/__snapshots__/report-stdout-no-categories.txt b/packages/utils/src/lib/reports/__snapshots__/report-stdout-no-categories.txt
@@ -1,5 +1,4 @@
-Code PushUp Report - @code-pushup/core@0.0.1
-
+Code PushUp report
 
 ESLint audits
 
@@ -19,7 +18,6 @@ ESLint audits
 ●  Require the use of `===` and `!==`                                  1 warning
 ●  ... + 37 audits with perfect scores ...
 
-
 Lighthouse audits
 
 ●  Minimize third-party usage                  Third-party code blocked the main
@@ -30,4 +28,3 @@ Lighthouse audits
 ●  ... + 2 audits with perfect scores ...
 
 Made with ❤ by code-pushup.dev
-
diff --git a/packages/utils/src/lib/reports/__snapshots__/report-stdout-verbose.txt b/packages/utils/src/lib/reports/__snapshots__/report-stdout-verbose.txt
@@ -1,5 +1,4 @@
-Code PushUp Report - @code-pushup/core@0.0.1
-
+Code PushUp report
 
 ESLint audits
 
@@ -60,7 +59,6 @@ ESLint audits
 ●  Require or disallow "Yoda" conditions                                  passed
 ●  Require using arrow functions for callbacks                            passed
 
-
 Lighthouse audits
 
 ●  Minimize third-party usage       Third-party code blocked the main thread for
@@ -82,4 +80,3 @@ Categories
 └──────────────────┴─────────┴──────────┘
 
 Made with ❤ by code-pushup.dev
-
diff --git a/packages/utils/src/lib/reports/__snapshots__/report-stdout.txt b/packages/utils/src/lib/reports/__snapshots__/report-stdout.txt
@@ -1,5 +1,4 @@
-Code PushUp Report - @code-pushup/core@0.0.1
-
+Code PushUp report
 
 ESLint audits
 
@@ -19,7 +18,6 @@ ESLint audits
 ●  Require the use of `===` and `!==`                                  1 warning
 ●  ... + 37 audits with perfect scores ...
 
-
 Lighthouse audits
 
 ●  Minimize third-party usage                  Third-party code blocked the main
@@ -40,4 +38,3 @@ Categories
 └──────────────────┴─────────┴──────────┘
 
 Made with ❤ by code-pushup.dev
-
diff --git a/packages/utils/src/lib/reports/__snapshots__/report.md b/packages/utils/src/lib/reports/__snapshots__/report.md
@@ -1,4 +1,4 @@
-# Code PushUp Report
+# Code PushUp report
 
 | 🏷 Category                       |  ⭐ Score  | 🛡 Audits |
 | :-------------------------------- | :-------: | :-------: |
diff --git a/packages/utils/src/lib/reports/generate-md-report.unit.test.ts b/packages/utils/src/lib/reports/generate-md-report.unit.test.ts
@@ -670,7 +670,7 @@ describe('generateMdReport', () => {
   it('should render all sections of the report', () => {
     const md = generateMdReport(baseScoredReport);
     // report title
-    expect(md).toMatch('# Code PushUp Report');
+    expect(md).toMatch('# Code PushUp report');
     // categories section heading
     expect(md).toContainMarkdownTableRow([
       '🏷 Category',
@@ -709,7 +709,7 @@ describe('generateMdReport', () => {
   it('should skip categories section when categories are missing', () => {
     const md = generateMdReport({ ...baseScoredReport, categories: undefined });
     expect(md).not.toMatch('## 🏷 Categories');
-    expect(md).toMatch('# Code PushUp Report\n\n## 🛡️ Audits');
+    expect(md).toMatch('# Code PushUp report\n\n## 🛡️ Audits');
   });
 
   it('should render complete md report', () => {
diff --git a/packages/utils/src/lib/reports/log-stdout-summary.ts b/packages/utils/src/lib/reports/log-stdout-summary.ts
@@ -15,26 +15,20 @@ import {
 } from './utils.js';
 
 export function logStdoutSummary(report: ScoredReport): void {
-  const { plugins, categories, packageName, version } = report;
-  logger.info(reportToHeaderSection({ packageName, version }));
+  const { plugins, categories } = report;
+  logger.info(ansis.bold.blue(REPORT_HEADLINE_TEXT));
   logger.newline();
   logPlugins(plugins);
   if (categories && categories.length > 0) {
+    logger.newline();
     logCategories({ plugins, categories });
   }
-  logger.info(`${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`);
   logger.newline();
-}
-
-function reportToHeaderSection({
-  packageName,
-  version,
-}: Pick<ScoredReport, 'packageName' | 'version'>): string {
-  return `${ansis.bold(REPORT_HEADLINE_TEXT)} - ${packageName}@${version}`;
+  logger.info(`${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`);
 }
 
 export function logPlugins(plugins: ScoredReport['plugins']): void {
-  plugins.forEach(plugin => {
+  plugins.forEach((plugin, idx) => {
     const { title, audits } = plugin;
     const filteredAudits =
       logger.isVerbose() || audits.length === 1
@@ -49,6 +43,10 @@ export function logPlugins(plugins: ScoredReport['plugins']): void {
           : `... + ${diff} audits with perfect scores ...`
         : null;
 
+    if (idx > 0) {
+      logger.newline();
+    }
+
     logAudits(title, filteredAudits, footer);
   });
 }
@@ -60,8 +58,6 @@ function logAudits(
 ): void {
   const marker = '●';
 
-  logger.newline();
-
   logger.info(
     formatAsciiTable(
       {
@@ -81,8 +77,6 @@ function logAudits(
       { borderless: true },
     ),
   );
-
-  logger.newline();
 }
 
 export function logCategories({
@@ -107,8 +101,6 @@ export function logCategories({
       { padding: 2 },
     ),
   );
-
-  logger.newline();
 }
 
 export function binaryIconPrefix(

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Code PushUp Report`
	`1`	`+# Code PushUp report`
`2`	`2`
`3`	`3`	`## 🛡️ Audits`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -43,5 +43,8 @@ export async function collectAndPersistReports(`
`43`	`43`
`44`	`44`	`// terminal output`
`45`	`45`	`logger.newline();`
	`46`	`+ logger.newline();`
`46`	`47`	`logStdoutSummary(sortedScoredReport);`
	`48`	`+ logger.newline();`
	`49`	`+ logger.newline();`
`47`	`50`	`}`