@code-pushup/core 0.49.0 → 0.50.0

package/index.js

@@ -670,6 +670,8 @@ var auditResultSchema = scorableWithPluginMetaSchema.merge(
 );
 var reportsDiffSchema = z15.object({
   commits: makeComparisonSchema(commitSchema).nullable().describe("Commits identifying compared reports"),
+  portalUrl: urlSchema.optional().describe("Link to comparison page in Code PushUp portal"),
+  label: z15.string().optional().describe("Label (e.g. project name)"),
   categories: makeArraysComparisonSchema(
     categoryDiffSchema,
     categoryResultSchema,
@@ -739,8 +741,24 @@ function comparePairs(pairs, equalsFn) {
   );
 }
 
+// packages/utils/src/lib/errors.ts
+function stringifyError(error) {
+  if (error instanceof Error) {
+    if (error.name === "Error" || error.message.startsWith(error.name)) {
+      return error.message;
+    }
+    return `${error.name}: ${error.message}`;
+  }
+  if (typeof error === "string") {
+    return error;
+  }
+  return JSON.stringify(error);
+}
+
 // packages/utils/src/lib/execute-process.ts
-import { spawn } from "node:child_process";
+import {
+  spawn
+} from "node:child_process";
 
 // packages/utils/src/lib/reports/utils.ts
 import ansis from "ansis";
@@ -867,12 +885,12 @@ function countCategoryAudits(refs, plugins) {
   }, 0);
 }
 function compareCategoryAuditsAndGroups(a, b) {
-  if (a.weight !== b.weight) {
-    return b.weight - a.weight;
-  }
   if (a.score !== b.score) {
     return a.score - b.score;
   }
+  if (a.weight !== b.weight) {
+    return b.weight - a.weight;
+  }
   if ("value" in a && "value" in b && a.value !== b.value) {
     return b.value - a.value;
   }
@@ -964,25 +982,29 @@ var ProcessError = class extends Error {
   }
 };
 function executeProcess(cfg) {
-  const { observer, cwd, command, args, ignoreExitCode = false } = cfg;
-  const { onStdout, onError, onComplete } = observer ?? {};
+  const { command, args, observer, ignoreExitCode = false, ...options } = cfg;
+  const { onStdout, onStderr, onError, onComplete } = observer ?? {};
   const date = (/* @__PURE__ */ new Date()).toISOString();
   const start = performance.now();
   return new Promise((resolve, reject) => {
-    const process2 = spawn(command, args, { cwd, shell: true });
+    const spawnedProcess = spawn(command, args ?? [], {
+      shell: true,
+      ...options
+    });
     let stdout = "";
     let stderr = "";
-    process2.stdout.on("data", (data) => {
+    spawnedProcess.stdout.on("data", (data) => {
       stdout += String(data);
-      onStdout?.(String(data));
+      onStdout?.(String(data), spawnedProcess);
     });
-    process2.stderr.on("data", (data) => {
+    spawnedProcess.stderr.on("data", (data) => {
       stderr += String(data);
+      onStderr?.(String(data), spawnedProcess);
     });
-    process2.on("error", (err) => {
+    spawnedProcess.on("error", (err) => {
       stderr += err.toString();
     });
-    process2.on("close", (code2) => {
+    spawnedProcess.on("close", (code2) => {
       const timings = { date, duration: calcDuration(start) };
       if (code2 === 0 || ignoreExitCode) {
         onComplete?.();
@@ -1181,6 +1203,9 @@ import { isAbsolute, join, relative } from "node:path";
 import { simpleGit } from "simple-git";
 
 // packages/utils/src/lib/transform.ts
+function toArray(val) {
+  return Array.isArray(val) ? val : [val];
+}
 function objectToEntries(obj) {
   return Object.entries(obj);
 }
@@ -1452,7 +1477,10 @@ function getColumnAlignments(tableData) {
 }
 
 // packages/utils/src/lib/reports/formatting.ts
-import { MarkdownDocument, md as md2 } from "build-md";
+import {
+  MarkdownDocument,
+  md as md2
+} from "build-md";
 function tableSection(tableData, options) {
   if (tableData.rows.length === 0) {
     return null;
@@ -1812,19 +1840,111 @@ function reportMetaTable({
 
 // packages/utils/src/lib/reports/generate-md-reports-diff.ts
 import {
-  MarkdownDocument as MarkdownDocument4,
-  md as md5
+  MarkdownDocument as MarkdownDocument5,
+  md as md6
 } from "build-md";
+
+// packages/utils/src/lib/reports/generate-md-reports-diff-utils.ts
+import { MarkdownDocument as MarkdownDocument4, md as md5 } from "build-md";
 var MAX_ROWS = 100;
-function generateMdReportsDiff(diff, portalUrl) {
-  return new MarkdownDocument4().$concat(
-    createDiffHeaderSection(diff, portalUrl),
-    createDiffCategoriesSection(diff),
-    createDiffGroupsSection(diff),
-    createDiffAuditsSection(diff)
-  ).toString();
+function summarizeUnchanged(token, { changed, unchanged }) {
+  const pluralizedCount = changed.length > 0 ? pluralizeToken(`other ${token}`, unchanged.length) : `All of ${pluralizeToken(token, unchanged.length)}`;
+  const pluralizedVerb = unchanged.length === 1 ? "is" : "are";
+  return `${pluralizedCount} ${pluralizedVerb} unchanged.`;
+}
+function summarizeDiffOutcomes(outcomes, token) {
+  return objectToEntries(countDiffOutcomes(outcomes)).filter(
+    (entry) => entry[0] !== "unchanged" && entry[1] > 0
+  ).map(([outcome, count]) => {
+    const formattedCount = `<strong>${count}</strong> ${pluralize(
+      token,
+      count
+    )}`;
+    switch (outcome) {
+      case "positive":
+        return `\u{1F44D} ${formattedCount} improved`;
+      case "negative":
+        return `\u{1F44E} ${formattedCount} regressed`;
+      case "mixed":
+        return `${formattedCount} changed without impacting score`;
+    }
+  }).join(", ");
+}
+function createGroupsOrAuditsDetails(token, { changed, unchanged }, ...[columns, rows]) {
+  if (changed.length === 0) {
+    return new MarkdownDocument4().paragraph(
+      summarizeUnchanged(token, { changed, unchanged })
+    );
+  }
+  return new MarkdownDocument4().table(columns, rows.slice(0, MAX_ROWS)).paragraph(
+    changed.length > MAX_ROWS && md5.italic(
+      `Only the ${MAX_ROWS} most affected ${pluralize(
+        token
+      )} are listed above for brevity.`
+    )
+  ).paragraph(
+    unchanged.length > 0 && summarizeUnchanged(token, { changed, unchanged })
+  );
+}
+function formatTitle({
+  title,
+  docsUrl
+}) {
+  if (docsUrl) {
+    return md5.link(docsUrl, title);
+  }
+  return title;
+}
+function formatPortalLink(portalUrl) {
+  return portalUrl && md5.link(portalUrl, "\u{1F575}\uFE0F See full comparison in Code PushUp portal \u{1F50D}");
+}
+function sortChanges(changes) {
+  return [...changes].sort(
+    (a, b) => Math.abs(b.scores.diff) - Math.abs(a.scores.diff) || Math.abs(b.values?.diff ?? 0) - Math.abs(a.values?.diff ?? 0)
+  );
+}
+function getDiffChanges(diff) {
+  return [
+    ...diff.categories.changed,
+    ...diff.groups.changed,
+    ...diff.audits.changed
+  ];
+}
+function changesToDiffOutcomes(changes) {
+  return changes.map((change) => {
+    if (change.scores.diff > 0) {
+      return "positive";
+    }
+    if (change.scores.diff < 0) {
+      return "negative";
+    }
+    if (change.values != null && change.values.diff !== 0) {
+      return "mixed";
+    }
+    return "unchanged";
+  });
+}
+function mergeDiffOutcomes(outcomes) {
+  if (outcomes.every((outcome) => outcome === "unchanged")) {
+    return "unchanged";
+  }
+  if (outcomes.includes("positive") && !outcomes.includes("negative")) {
+    return "positive";
+  }
+  if (outcomes.includes("negative") && !outcomes.includes("positive")) {
+    return "negative";
+  }
+  return "mixed";
+}
+function countDiffOutcomes(outcomes) {
+  return {
+    positive: outcomes.filter((outcome) => outcome === "positive").length,
+    negative: outcomes.filter((outcome) => outcome === "negative").length,
+    mixed: outcomes.filter((outcome) => outcome === "mixed").length,
+    unchanged: outcomes.filter((outcome) => outcome === "unchanged").length
+  };
 }
-function createDiffHeaderSection(diff, portalUrl) {
+function formatReportOutcome(outcome, commits) {
   const outcomeTexts = {
     positive: md5`🥳 Code PushUp report has ${md5.bold("improved")}`,
     negative: md5`😟 Code PushUp report has ${md5.bold("regressed")}`,
@@ -1833,27 +1953,91 @@ function createDiffHeaderSection(diff, portalUrl) {
     )}`,
     unchanged: md5`😐 Code PushUp report is ${md5.bold("unchanged")}`
   };
+  if (commits) {
+    const commitsText = `compared target commit ${commits.after.hash} with source commit ${commits.before.hash}`;
+    return md5`${outcomeTexts[outcome]} – ${commitsText}.`;
+  }
+  return md5`${outcomeTexts[outcome]}.`;
+}
+function compareDiffsBy(type, a, b) {
+  return sumScoreChanges(b[type].changed) - sumScoreChanges(a[type].changed) || sumConfigChanges(b[type]) - sumConfigChanges(a[type]);
+}
+function sumScoreChanges(changes) {
+  return changes.reduce(
+    (acc, { scores }) => acc + Math.abs(scores.diff),
+    0
+  );
+}
+function sumConfigChanges({
+  added,
+  removed
+}) {
+  return added.length + removed.length;
+}
+
+// packages/utils/src/lib/reports/generate-md-reports-diff.ts
+function generateMdReportsDiff(diff) {
+  return new MarkdownDocument5().$concat(
+    createDiffHeaderSection(diff),
+    createDiffCategoriesSection(diff),
+    createDiffDetailsSection(diff)
+  ).toString();
+}
+function generateMdReportsDiffForMonorepo(diffs) {
+  const diffsWithOutcomes = diffs.map((diff) => ({
+    ...diff,
+    outcome: mergeDiffOutcomes(changesToDiffOutcomes(getDiffChanges(diff)))
+  })).sort(
+    (a, b) => compareDiffsBy("categories", a, b) || compareDiffsBy("groups", a, b) || compareDiffsBy("audits", a, b) || a.label.localeCompare(b.label)
+  );
+  const unchanged = diffsWithOutcomes.filter(
+    ({ outcome }) => outcome === "unchanged"
+  );
+  const changed = diffsWithOutcomes.filter((diff) => !unchanged.includes(diff));
+  return new MarkdownDocument5().$concat(
+    createDiffHeaderSection(diffs),
+    ...changed.map(createDiffProjectSection)
+  ).$if(
+    unchanged.length > 0,
+    (doc) => doc.rule().paragraph(summarizeUnchanged("project", { unchanged, changed }))
+  ).toString();
+}
+function createDiffHeaderSection(diff) {
   const outcome = mergeDiffOutcomes(
-    changesToDiffOutcomes([
-      ...diff.categories.changed,
-      ...diff.groups.changed,
-      ...diff.audits.changed
-    ])
+    changesToDiffOutcomes(toArray(diff).flatMap(getDiffChanges))
   );
-  const styleCommits = (commits) => `compared target commit ${commits.after.hash} with source commit ${commits.before.hash}`;
-  return new MarkdownDocument4().heading(HIERARCHY.level_1, "Code PushUp").paragraph(
-    diff.commits ? md5`${outcomeTexts[outcome]} – ${styleCommits(diff.commits)}.` : outcomeTexts[outcome]
-  ).paragraph(
-    portalUrl && md5.link(portalUrl, "\u{1F575}\uFE0F See full comparison in Code PushUp portal \u{1F50D}")
+  const commits = Array.isArray(diff) ? diff[0]?.commits : diff.commits;
+  const portalUrl = Array.isArray(diff) ? void 0 : diff.portalUrl;
+  return new MarkdownDocument5().heading(HIERARCHY.level_1, "Code PushUp").paragraph(formatReportOutcome(outcome, commits)).paragraph(formatPortalLink(portalUrl));
+}
+function createDiffProjectSection(diff) {
+  return new MarkdownDocument5().heading(HIERARCHY.level_2, md6`💼 Project ${md6.code(diff.label)}`).paragraph(formatReportOutcome(diff.outcome)).paragraph(formatPortalLink(diff.portalUrl)).$concat(
+    createDiffCategoriesSection(diff, {
+      skipHeading: true,
+      skipUnchanged: true
+    }),
+    createDiffDetailsSection(diff, HIERARCHY.level_3)
   );
 }
-function createDiffCategoriesSection(diff) {
+function createDiffCategoriesSection(diff, options) {
   const { changed, unchanged, added } = diff.categories;
+  const { skipHeading, skipUnchanged } = options ?? {};
   const categoriesCount = changed.length + unchanged.length + added.length;
   const hasChanges = unchanged.length < categoriesCount;
   if (categoriesCount === 0) {
     return null;
   }
+  const [columns, rows] = createCategoriesTable(diff, {
+    hasChanges,
+    skipUnchanged
+  });
+  return new MarkdownDocument5().heading(HIERARCHY.level_2, !skipHeading && "\u{1F3F7}\uFE0F Categories").table(columns, rows).paragraph(added.length > 0 && md6.italic("(\\*) New category.")).paragraph(
+    skipUnchanged && unchanged.length > 0 && summarizeUnchanged("category", { changed, unchanged })
+  );
+}
+function createCategoriesTable(diff, options) {
+  const { changed, unchanged, added } = diff.categories;
+  const { hasChanges, skipUnchanged } = options;
   const columns = [
     { heading: "\u{1F3F7}\uFE0F Category", alignment: "left" },
     {
@@ -1874,27 +2058,43 @@ function createDiffCategoriesSection(diff) {
     ]),
     ...added.map((category) => [
       formatTitle(category),
-      md5.italic("n/a (\\*)"),
+      md6.italic("n/a (\\*)"),
       formatScoreWithColor(category.score),
-      md5.italic("n/a (\\*)")
+      md6.italic("n/a (\\*)")
     ]),
-    ...unchanged.map((category) => [
+    ...skipUnchanged ? [] : unchanged.map((category) => [
       formatTitle(category),
       formatScoreWithColor(category.score, { skipBold: true }),
       formatScoreWithColor(category.score),
       "\u2013"
     ])
   ];
-  return new MarkdownDocument4().heading(HIERARCHY.level_2, "\u{1F3F7}\uFE0F Categories").table(
+  return [
     hasChanges ? columns : columns.slice(0, 2),
     rows.map((row) => hasChanges ? row : row.slice(0, 2))
-  ).paragraph(added.length > 0 && md5.italic("(\\*) New category."));
+  ];
 }
-function createDiffGroupsSection(diff) {
+function createDiffDetailsSection(diff, level = HIERARCHY.level_2) {
+  if (diff.groups.changed.length + diff.audits.changed.length === 0) {
+    return null;
+  }
+  const summary = ["group", "audit"].map(
+    (token) => summarizeDiffOutcomes(
+      changesToDiffOutcomes(diff[`${token}s`].changed),
+      token
+    )
+  ).filter(Boolean).join(", ");
+  const details2 = new MarkdownDocument5().$concat(
+    createDiffGroupsSection(diff, level),
+    createDiffAuditsSection(diff, level)
+  );
+  return new MarkdownDocument5().details(summary, details2);
+}
+function createDiffGroupsSection(diff, level) {
   if (diff.groups.changed.length + diff.groups.unchanged.length === 0) {
     return null;
   }
-  return new MarkdownDocument4().heading(HIERARCHY.level_2, "\u{1F5C3}\uFE0F Groups").$concat(
+  return new MarkdownDocument5().heading(level, "\u{1F5C3}\uFE0F Groups").$concat(
     createGroupsOrAuditsDetails(
       "group",
       diff.groups,
@@ -1915,8 +2115,8 @@ function createDiffGroupsSection(diff) {
     )
   );
 }
-function createDiffAuditsSection(diff) {
-  return new MarkdownDocument4().heading(HIERARCHY.level_2, "\u{1F6E1}\uFE0F Audits").$concat(
+function createDiffAuditsSection(diff, level) {
+  return new MarkdownDocument5().heading(level, "\u{1F6E1}\uFE0F Audits").$concat(
     createGroupsOrAuditsDetails(
       "audit",
       diff.audits,
@@ -1931,7 +2131,7 @@ function createDiffAuditsSection(diff) {
         formatTitle(audit.plugin),
         formatTitle(audit),
         `${scoreMarker(audit.scores.before, "square")} ${audit.displayValues.before || audit.values.before.toString()}`,
-        md5`${scoreMarker(audit.scores.after, "square")} ${md5.bold(
+        md6`${scoreMarker(audit.scores.after, "square")} ${md6.bold(
           audit.displayValues.after || audit.values.after.toString()
         )}`,
         formatValueChange(audit)
@@ -1939,96 +2139,6 @@ function createDiffAuditsSection(diff) {
     )
   );
 }
-function createGroupsOrAuditsDetails(token, { changed, unchanged }, ...[columns, rows]) {
-  if (changed.length === 0) {
-    return new MarkdownDocument4().paragraph(
-      summarizeUnchanged(token, { changed, unchanged })
-    );
-  }
-  return new MarkdownDocument4().details(
-    summarizeDiffOutcomes(changesToDiffOutcomes(changed), token),
-    md5`${md5.table(columns, rows.slice(0, MAX_ROWS))}${changed.length > MAX_ROWS ? md5.paragraph(
-      md5.italic(
-        `Only the ${MAX_ROWS} most affected ${pluralize(
-          token
-        )} are listed above for brevity.`
-      )
-    ) : ""}${unchanged.length > 0 ? md5.paragraph(summarizeUnchanged(token, { changed, unchanged })) : ""}`
-  );
-}
-function summarizeUnchanged(token, { changed, unchanged }) {
-  return [
-    changed.length > 0 ? pluralizeToken(`other ${token}`, unchanged.length) : `All of ${pluralizeToken(token, unchanged.length)}`,
-    unchanged.length === 1 ? "is" : "are",
-    "unchanged."
-  ].join(" ");
-}
-function summarizeDiffOutcomes(outcomes, token) {
-  return objectToEntries(countDiffOutcomes(outcomes)).filter(
-    (entry) => entry[0] !== "unchanged" && entry[1] > 0
-  ).map(([outcome, count]) => {
-    const formattedCount = `<strong>${count}</strong> ${pluralize(
-      token,
-      count
-    )}`;
-    switch (outcome) {
-      case "positive":
-        return `\u{1F44D} ${formattedCount} improved`;
-      case "negative":
-        return `\u{1F44E} ${formattedCount} regressed`;
-      case "mixed":
-        return `${formattedCount} changed without impacting score`;
-    }
-  }).join(", ");
-}
-function formatTitle({
-  title,
-  docsUrl
-}) {
-  if (docsUrl) {
-    return md5.link(docsUrl, title);
-  }
-  return title;
-}
-function sortChanges(changes) {
-  return [...changes].sort(
-    (a, b) => Math.abs(b.scores.diff) - Math.abs(a.scores.diff) || Math.abs(b.values?.diff ?? 0) - Math.abs(a.values?.diff ?? 0)
-  );
-}
-function changesToDiffOutcomes(changes) {
-  return changes.map((change) => {
-    if (change.scores.diff > 0) {
-      return "positive";
-    }
-    if (change.scores.diff < 0) {
-      return "negative";
-    }
-    if (change.values != null && change.values.diff !== 0) {
-      return "mixed";
-    }
-    return "unchanged";
-  });
-}
-function mergeDiffOutcomes(outcomes) {
-  if (outcomes.every((outcome) => outcome === "unchanged")) {
-    return "unchanged";
-  }
-  if (outcomes.includes("positive") && !outcomes.includes("negative")) {
-    return "positive";
-  }
-  if (outcomes.includes("negative") && !outcomes.includes("positive")) {
-    return "negative";
-  }
-  return "mixed";
-}
-function countDiffOutcomes(outcomes) {
-  return {
-    positive: outcomes.filter((outcome) => outcome === "positive").length,
-    negative: outcomes.filter((outcome) => outcome === "negative").length,
-    mixed: outcomes.filter((outcome) => outcome === "mixed").length,
-    unchanged: outcomes.filter((outcome) => outcome === "unchanged").length
-  };
-}
 
 // packages/utils/src/lib/reports/load-report.ts
 import { join as join2 } from "node:path";
@@ -2085,7 +2195,8 @@ function logPlugins(report) {
         },
         {
           text: cyanBright(audit.displayValue || `${audit.value}`),
-          width: 10,
+          // eslint-disable-next-line no-magic-numbers
+          width: 20,
           padding: [0, 0, 0, 0]
         }
       ]);
@@ -2238,7 +2349,7 @@ var verboseUtils = (verbose = false) => ({
 
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.49.0";
+var version = "0.50.0";
 
 // packages/core/src/lib/implementation/execute-plugin.ts
 import { bold as bold5 } from "ansis";
@@ -2634,7 +2745,7 @@ function selectMeta(meta) {
 }
 
 // packages/core/src/lib/compare.ts
-async function compareReportFiles(inputPaths, persistConfig, uploadConfig) {
+async function compareReportFiles(inputPaths, persistConfig, uploadConfig, label) {
   const { outputDir, filename, format } = persistConfig;
   const [reportBefore, reportAfter] = await Promise.all([
     readJsonFile(inputPaths.before),
@@ -2644,12 +2755,20 @@ async function compareReportFiles(inputPaths, persistConfig, uploadConfig) {
     before: reportSchema.parse(reportBefore),
     after: reportSchema.parse(reportAfter)
   };
-  const reportsDiff = compareReports(reports);
-  const portalUrl = uploadConfig && reportsDiff.commits && format.includes("md") ? await fetchPortalComparisonLink(uploadConfig, reportsDiff.commits) : void 0;
+  const diff = compareReports(reports);
+  if (label) {
+    diff.label = label;
+  }
+  if (uploadConfig && diff.commits) {
+    diff.portalUrl = await fetchPortalComparisonLink(
+      uploadConfig,
+      diff.commits
+    );
+  }
   return Promise.all(
     format.map(async (fmt) => {
       const outputPath = join5(outputDir, `${filename}-diff.${fmt}`);
-      const content = reportsDiffToFileContent(reportsDiff, fmt, portalUrl);
+      const content = reportsDiffToFileContent(diff, fmt);
       await ensureDirectoryExists(outputDir);
       await writeFile2(outputPath, content);
       return outputPath;
@@ -2679,12 +2798,12 @@ function compareReports(reports) {
     duration
   };
 }
-function reportsDiffToFileContent(reportsDiff, format, portalUrl) {
+function reportsDiffToFileContent(reportsDiff, format) {
   switch (format) {
     case "json":
       return JSON.stringify(reportsDiff, null, 2);
     case "md":
-      return generateMdReportsDiff(reportsDiff, portalUrl ?? void 0);
+      return generateMdReportsDiff(reportsDiff);
   }
 }
 async function fetchPortalComparisonLink(uploadConfig, commits) {
@@ -2956,6 +3075,45 @@ async function autoloadRc(tsconfig) {
     tsconfig
   );
 }
+
+// packages/core/src/lib/merge-diffs.ts
+import { writeFile as writeFile3 } from "node:fs/promises";
+import { basename, dirname, join as join7 } from "node:path";
+async function mergeDiffs(files, persistConfig) {
+  const results = await Promise.allSettled(
+    files.map(async (file) => {
+      const json = await readJsonFile(file).catch((error) => {
+        throw new Error(
+          `Failed to read JSON file ${file} - ${stringifyError(error)}`
+        );
+      });
+      const result = await reportsDiffSchema.safeParseAsync(json);
+      if (!result.success) {
+        throw new Error(
+          `Invalid reports diff in ${file} - ${result.error.message}`
+        );
+      }
+      return { ...result.data, file };
+    })
+  );
+  results.filter(isPromiseRejectedResult).forEach(({ reason }) => {
+    ui().logger.warning(
+      `Skipped invalid report diff - ${stringifyError(reason)}`
+    );
+  });
+  const diffs = results.filter(isPromiseFulfilledResult).map(({ value }) => value);
+  const labeledDiffs = diffs.map((diff) => ({
+    ...diff,
+    label: diff.label || basename(dirname(diff.file))
+    // fallback is parent folder name
+  }));
+  const markdown = generateMdReportsDiffForMonorepo(labeledDiffs);
+  const { outputDir, filename } = persistConfig;
+  const outputPath = join7(outputDir, `${filename}-diff.md`);
+  await ensureDirectoryExists(outputDir);
+  await writeFile3(outputPath, markdown);
+  return outputPath;
+}
 export {
   ConfigPathError,
   PersistDirError,
@@ -2969,6 +3127,7 @@ export {
   executePlugin,
   executePlugins,
   history,
+  mergeDiffs,
   persistReport,
   readRcByPath,
   upload

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "@code-pushup/core",
-  "version": "0.49.0",
+  "version": "0.50.0",
   "license": "MIT",
+  "description": "Core business logic for the used by the Code PushUp CLI",
   "dependencies": {
-    "@code-pushup/models": "0.49.0",
-    "@code-pushup/utils": "0.49.0",
+    "@code-pushup/models": "0.50.0",
+    "@code-pushup/utils": "0.50.0",
     "@code-pushup/portal-client": "^0.9.0",
     "ansis": "^3.3.0"
   },
-  "type": "module",
-  "main": "./index.js",
-  "homepage": "https://github.com/code-pushup/cli#readme",
+  "homepage": "https://github.com/code-pushup/cli/tree/main/packages/core#readme",
   "bugs": {
     "url": "https://github.com/code-pushup/cli/issues"
   },
@@ -19,32 +18,7 @@
     "url": "git+https://github.com/code-pushup/cli.git",
     "directory": "packages/core"
   },
-  "contributors": [
-    {
-      "name": "Igor Katsuba",
-      "email": "igor@katsuba.dev",
-      "url": "https://katsuba.dev"
-    },
-    {
-      "name": "Kateřina Pilátová",
-      "email": "katerina.pilatova@flowup.cz",
-      "url": "https://github.com/Tlacenka"
-    },
-    {
-      "name": "Matěj Chalk",
-      "email": "matej.chalk@flowup.cz",
-      "url": "https://github.com/matejchalk"
-    },
-    {
-      "name": "Michael Hladky",
-      "email": "michael.hladky@push-based.io",
-      "url": "https://push-based.io"
-    },
-    {
-      "name": "Michael Seredenko",
-      "email": "misha.seredenko@push-based.io",
-      "url": "https://github.com/MishaSeredenkoPushBased"
-    }
-  ],
+  "type": "module",
+  "main": "./index.js",
   "types": "./src/index.d.ts"
 }

package/src/index.d.ts

@@ -1,10 +1,11 @@
-export { CollectAndPersistReportsOptions, collectAndPersistReports, } from './lib/collect-and-persist';
+export { type CollectAndPersistReportsOptions, collectAndPersistReports, } from './lib/collect-and-persist';
 export { compareReportFiles, compareReports } from './lib/compare';
-export { CollectOptions, collect } from './lib/implementation/collect';
-export { ReportsToCompare } from './lib/implementation/compare-scorables';
+export { type CollectOptions, collect } from './lib/implementation/collect';
+export type { ReportsToCompare } from './lib/implementation/compare-scorables';
 export { PluginOutputMissingAuditError, executePlugin, executePlugins, } from './lib/implementation/execute-plugin';
 export { PersistDirError, PersistError, persistReport, } from './lib/implementation/persist';
-export { history, HistoryOptions, HistoryOnlyOptions } from './lib/history';
+export { history, type HistoryOptions, type HistoryOnlyOptions, } from './lib/history';
 export { ConfigPathError, autoloadRc, readRcByPath, } from './lib/implementation/read-rc-file';
-export { GlobalOptions } from './lib/types';
-export { UploadOptions, upload } from './lib/upload';
+export type { GlobalOptions } from './lib/types';
+export { type UploadOptions, upload } from './lib/upload';
+export { mergeDiffs } from './lib/merge-diffs';

package/src/lib/collect-and-persist.d.ts

@@ -1,5 +1,5 @@
-import { CoreConfig, PersistConfig } from '@code-pushup/models';
-import { GlobalOptions } from './types';
+import { type CoreConfig, type PersistConfig } from '@code-pushup/models';
+import type { GlobalOptions } from './types';
 export type CollectAndPersistReportsOptions = Required<Pick<CoreConfig, 'plugins' | 'categories'>> & {
     persist: Required<PersistConfig>;
 } & Partial<GlobalOptions>;

package/src/lib/compare.d.ts

@@ -1,4 +1,4 @@
-import { type PersistConfig, Report, ReportsDiff, type UploadConfig } from '@code-pushup/models';
-import { Diff } from '@code-pushup/utils';
-export declare function compareReportFiles(inputPaths: Diff<string>, persistConfig: Required<PersistConfig>, uploadConfig: UploadConfig | undefined): Promise<string[]>;
+import { type PersistConfig, type Report, type ReportsDiff, type UploadConfig } from '@code-pushup/models';
+import { type Diff } from '@code-pushup/utils';
+export declare function compareReportFiles(inputPaths: Diff<string>, persistConfig: Required<PersistConfig>, uploadConfig: UploadConfig | undefined, label?: string): Promise<string[]>;
 export declare function compareReports(reports: Diff<Report>): ReportsDiff;

package/src/lib/history.d.ts

@@ -1,5 +1,5 @@
-import { CoreConfig, PersistConfig, UploadConfig } from '@code-pushup/models';
-import { GlobalOptions } from './types';
+import type { CoreConfig, PersistConfig, UploadConfig } from '@code-pushup/models';
+import type { GlobalOptions } from './types';
 export type HistoryOnlyOptions = {
     targetBranch?: string;
     skipUploads?: boolean;

package/src/lib/implementation/collect.d.ts

@@ -1,5 +1,5 @@
-import { CoreConfig, Report } from '@code-pushup/models';
-import { GlobalOptions } from '../types';
+import type { CoreConfig, Report } from '@code-pushup/models';
+import type { GlobalOptions } from '../types';
 export type CollectOptions = Required<Pick<CoreConfig, 'plugins' | 'categories'>> & Partial<GlobalOptions>;
 /**
  * Run audits, collect plugin output and aggregate it into a JSON object

package/src/lib/implementation/compare-scorables.d.ts

@@ -1,5 +1,5 @@
-import { ReportsDiff } from '@code-pushup/models';
-import { Diff, ScoredReport } from '@code-pushup/utils';
+import type { ReportsDiff } from '@code-pushup/models';
+import { type Diff, type ScoredReport } from '@code-pushup/utils';
 export type ReportsToCompare = Diff<ScoredReport>;
 export declare function compareCategories(reports: ReportsToCompare): ReportsDiff['categories'];
 export declare function compareGroups(reports: ReportsToCompare): ReportsDiff['groups'];

package/src/lib/implementation/execute-plugin.d.ts

@@ -1,4 +1,4 @@
-import { OnProgress, PluginConfig, PluginReport } from '@code-pushup/models';
+import { type OnProgress, type PluginConfig, type PluginReport } from '@code-pushup/models';
 /**
  * Error thrown when plugin output is invalid.
  */

package/src/lib/implementation/persist.d.ts

@@ -1,5 +1,5 @@
-import { PersistConfig, Report } from '@code-pushup/models';
-import { MultipleFileResults } from '@code-pushup/utils';
+import type { PersistConfig, Report } from '@code-pushup/models';
+import { type MultipleFileResults } from '@code-pushup/utils';
 export declare class PersistDirError extends Error {
     constructor(outputDir: string);
 }

package/src/lib/implementation/read-rc-file.d.ts

@@ -1,4 +1,4 @@
-import { CoreConfig } from '@code-pushup/models';
+import { type CoreConfig } from '@code-pushup/models';
 export declare class ConfigPathError extends Error {
     constructor(configPath: string);
 }

package/src/lib/implementation/runner.d.ts

@@ -1,4 +1,4 @@
-import { OnProgress, RunnerConfig, RunnerFunction } from '@code-pushup/models';
+import type { OnProgress, RunnerConfig, RunnerFunction } from '@code-pushup/models';
 export type RunnerResult = {
     date: string;
     duration: number;

package/src/lib/merge-diffs.d.ts

@@ -0,0 +1,2 @@
+import { type PersistConfig } from '@code-pushup/models';
+export declare function mergeDiffs(files: string[], persistConfig: Required<PersistConfig>): Promise<string>;

package/src/lib/normalize.d.ts

@@ -1,3 +1,3 @@
-import { type AuditOutputs, Issue } from '@code-pushup/models';
+import type { AuditOutputs, Issue } from '@code-pushup/models';
 export declare function normalizeIssue(issue: Issue, gitRoot: string): Issue;
 export declare function normalizeAuditOutputs(audits: AuditOutputs): Promise<AuditOutputs>;

package/src/lib/upload.d.ts

@@ -1,6 +1,6 @@
 import { uploadToPortal } from '@code-pushup/portal-client';
-import { PersistConfig, UploadConfig } from '@code-pushup/models';
-import { GlobalOptions } from './types';
+import type { PersistConfig, UploadConfig } from '@code-pushup/models';
+import type { GlobalOptions } from './types';
 export type UploadOptions = {
     upload?: UploadConfig;
 } & {