feat(utils): move project status from heading to paragraph in report-diff.md

Author: matejchalk

packages/utils/src/lib/reports/__snapshots__/report-diff-monorepo-with-portal.md

@@ -2,7 +2,9 @@
 
 🥳 Code PushUp report has **improved** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
 
-## 💼 Project `frontoffice` – improved 🥳
+## 💼 Project `frontoffice`
+
+🥳 Code PushUp report has **improved**.
 
 [🕵️ See full comparison in Code PushUp portal 🔍](https://app.code-pushup.dev/portal/dunder-mifflin/frontoffice/comparison/abcdef0123456789abcdef0123456789abcdef01/0123456789abcdef0123456789abcdef01234567)
 

packages/utils/src/lib/reports/__snapshots__/report-diff-monorepo.md

@@ -2,7 +2,9 @@
 
 🤨 Code PushUp report has both **improvements and regressions** – compared target commit 0123456789abcdef0123456789abcdef01234567 with source commit abcdef0123456789abcdef0123456789abcdef01.
 
-## 💼 Project `console` – improved 🥳
+## 💼 Project `console`
+
+🥳 Code PushUp report has **improved**.
 
 | 🏷️ Category                                                              | ⭐ Previous score | ⭐ Current score |                        🔄 Score change                         |
 | :------------------------------------------------------------------------ | :--------------: | :-------------: | :------------------------------------------------------------: |
@@ -41,7 +43,9 @@
 
 </details>
 
-## 💼 Project `admin` – mixed 🤨
+## 💼 Project `admin`
+
+🤨 Code PushUp report has both **improvements and regressions**.
 
 | 🏷️ Category   | ⭐ Previous score | ⭐ Current score |                         🔄 Score change                          |
 | :------------- | :--------------: | :-------------: | :--------------------------------------------------------------: |
@@ -74,7 +78,9 @@
 
 </details>
 
-## 💼 Project `docs` – regressed 😟
+## 💼 Project `docs`
+
+😟 Code PushUp report has **regressed**.
 
 | 🏷️ Category   | ⭐ Previous score | ⭐ Current score |                         🔄 Score change                          |
 | :------------- | :--------------: | :-------------: | :--------------------------------------------------------------: |

packages/utils/src/lib/reports/generate-md-reports-diff-utils.ts

@@ -152,6 +152,27 @@ function countDiffOutcomes(
   };
 }
 
+export function formatReportOutcome(
+  outcome: DiffOutcome,
+  commits?: ReportsDiff['commits'],
+): InlineText {
+  const outcomeTexts = {
+    positive: md`🥳 Code PushUp report has ${md.bold('improved')}`,
+    negative: md`😟 Code PushUp report has ${md.bold('regressed')}`,
+    mixed: md`🤨 Code PushUp report has both ${md.bold(
+      'improvements and regressions',
+    )}`,
+    unchanged: md`😐 Code PushUp report is ${md.bold('unchanged')}`,
+  };
+
+  if (commits) {
+    const commitsText = `compared target commit ${commits.after.hash} with source commit ${commits.before.hash}`;
+    return md`${outcomeTexts[outcome]} – ${commitsText}.`;
+  }
+
+  return md`${outcomeTexts[outcome]}.`;
+}
+
 export function compareDiffsBy<T extends 'categories' | 'groups' | 'audits'>(
   type: T,
   a: ReportsDiff,

packages/utils/src/lib/reports/generate-md-reports-diff.ts

@@ -13,6 +13,7 @@ import {
   compareDiffsBy,
   createGroupsOrAuditsDetails,
   formatPortalLink,
+  formatReportOutcome,
   formatTitle,
   getDiffChanges,
   mergeDiffOutcomes,
@@ -94,49 +95,24 @@ function createDiffHeaderSection(
   diff: ReportsDiff | ReportsDiff[],
   portalUrl?: string,
 ): MarkdownDocument {
-  const outcomeTexts = {
-    positive: md`🥳 Code PushUp report has ${md.bold('improved')}`,
-    negative: md`😟 Code PushUp report has ${md.bold('regressed')}`,
-    mixed: md`🤨 Code PushUp report has both ${md.bold(
-      'improvements and regressions',
-    )}`,
-    unchanged: md`😐 Code PushUp report is ${md.bold('unchanged')}`,
-  };
   const outcome = mergeDiffOutcomes(
     changesToDiffOutcomes(toArray(diff).flatMap(getDiffChanges)),
   );
-
-  const commits = Array.isArray(diff) ? diff[0]?.commits : diff.commits; // TODO: what if array contains different commit pairs?
-  const commitsText =
-    commits &&
-    `compared target commit ${commits.after.hash} with source commit ${commits.before.hash}`;
+  // TODO: what if array contains different commit pairs?
+  const commits = Array.isArray(diff) ? diff[0]?.commits : diff.commits;
 
   return new MarkdownDocument()
     .heading(HIERARCHY.level_1, 'Code PushUp')
-    .paragraph(
-      commitsText
-        ? md`${outcomeTexts[outcome]} – ${commitsText}.`
-        : outcomeTexts[outcome],
-    )
+    .paragraph(formatReportOutcome(outcome, commits))
     .paragraph(formatPortalLink(portalUrl));
 }
 
 function createDiffProjectSection(
   project: ProjectDiffWithOutcome,
 ): MarkdownDocument {
-  const outcomeTexts = {
-    positive: 'improved 🥳',
-    negative: 'regressed 😟',
-    mixed: 'mixed 🤨',
-    unchanged: 'unchanged 😐',
-  };
-  const outcomeText = outcomeTexts[project.outcome];
-
   return new MarkdownDocument()
-    .heading(
-      HIERARCHY.level_2,
-      md`💼 Project ${md.code(project.name)} – ${outcomeText}`,
-    )
+    .heading(HIERARCHY.level_2, md`💼 Project ${md.code(project.name)}`)
+    .paragraph(formatReportOutcome(project.outcome))
     .paragraph(formatPortalLink(project.portalUrl))
     .$concat(
       createDiffCategoriesSection(project.diff, {