@code-pushup/utils 0.49.0 → 0.50.0

package/index.js

@@ -666,6 +666,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,
@@ -735,8 +737,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";
@@ -863,12 +881,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;
   }
@@ -960,25 +978,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?.();
@@ -1881,7 +1903,10 @@ var html = {
 };
 
 // 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;
@@ -2241,19 +2266,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 createDiffHeaderSection(diff, portalUrl) {
+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 formatReportOutcome(outcome, commits) {
   const outcomeTexts = {
     positive: md5`🥳 Code PushUp report has ${md5.bold("improved")}`,
     negative: md5`😟 Code PushUp report has ${md5.bold("regressed")}`,
@@ -2262,27 +2379,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" },
     {
@@ -2303,27 +2484,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,
@@ -2344,8 +2541,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,
@@ -2360,7 +2557,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)
@@ -2368,96 +2565,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 join3 } from "node:path";
@@ -2514,7 +2621,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]
         }
       ]);
@@ -2693,9 +2801,11 @@ export {
   formatBytes,
   formatDuration,
   formatGitPath,
+  formatReportScore,
   fromJsonLines,
   generateMdReport,
   generateMdReportsDiff,
+  generateMdReportsDiffForMonorepo,
   getCurrentBranchOrTag,
   getGitRoot,
   getHashFromTag,
@@ -2735,6 +2845,7 @@ export {
   slugify,
   sortReport,
   sortSemvers,
+  stringifyError,
   toArray,
   toGitPath,
   toJsonLines,

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.49.0",
+  "version": "0.50.0",
+  "description": "Low-level utilities (helper functions, etc.) used by Code PushUp CLI",
   "dependencies": {
-    "@code-pushup/models": "0.49.0",
+    "@code-pushup/models": "0.50.0",
     "@isaacs/cliui": "^8.0.2",
     "@poppinss/cliui": "^6.4.0",
     "ansis": "^3.3.0",
-    "build-md": "^0.4.1",
+    "build-md": "^0.4.2",
     "bundle-require": "^4.0.1",
     "esbuild": "^0.19.2",
     "multi-progress-bars": "^5.0.3",
@@ -14,7 +15,7 @@
     "simple-git": "^3.20.0"
   },
   "license": "MIT",
-  "homepage": "https://github.com/code-pushup/cli#readme",
+  "homepage": "https://github.com/code-pushup/cli/tree/main/packages/utils#readme",
   "bugs": {
     "url": "https://github.com/code-pushup/cli/issues"
   },
@@ -23,33 +24,6 @@
     "url": "git+https://github.com/code-pushup/cli.git",
     "directory": "packages/utils"
   },
-  "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,29 +1,30 @@
 export { exists } from '@code-pushup/models';
-export { Diff, comparePairs, matchArrayItemsByKey } from './lib/diff';
-export { ProcessConfig, ProcessError, ProcessObserver, ProcessResult, executeProcess, } from './lib/execute-process';
-export { CrawlFileSystemOptions, FileResult, MultipleFileResults, crawlFileSystem, directoryExists, ensureDirectoryExists, fileExists, filePathToCliArg, findLineNumberInText, importModule, logMultipleFileResults, pluginWorkDir, readJsonFile, readTextFile, removeDirectoryIfExists, } from './lib/file-system';
+export { type Diff, comparePairs, matchArrayItemsByKey } from './lib/diff';
+export { stringifyError } from './lib/errors';
+export { type ProcessConfig, ProcessError, type ProcessObserver, type ProcessResult, executeProcess, } from './lib/execute-process';
+export { type CrawlFileSystemOptions, type FileResult, type MultipleFileResults, crawlFileSystem, directoryExists, ensureDirectoryExists, fileExists, filePathToCliArg, findLineNumberInText, importModule, logMultipleFileResults, pluginWorkDir, readJsonFile, readTextFile, removeDirectoryIfExists, } from './lib/file-system';
 export { filterItemRefsBy } from './lib/filter';
 export { formatBytes, formatDuration, pluralize, pluralizeToken, slugify, truncateDescription, truncateIssueMessage, truncateText, truncateTitle, } from './lib/formatting';
 export { formatGitPath, getGitRoot, guardAgainstLocalChanges, safeCheckout, toGitPath, } from './lib/git/git';
-export { LogResult, getCurrentBranchOrTag, getHashFromTag, getHashes, getLatestCommit, getSemverTags, } from './lib/git/git.commits-and-tags';
+export { type LogResult, getCurrentBranchOrTag, getHashFromTag, getHashes, getLatestCommit, getSemverTags, } from './lib/git/git.commits-and-tags';
 export { groupByStatus } from './lib/group-by-status';
 export { isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards';
 export { logMultipleResults } from './lib/log-results';
-export { CliUi, Column, link, ui } from './lib/logging';
+export { type CliUi, type Column, link, ui } from './lib/logging';
 export { mergeConfigs } from './lib/merge-configs';
-export { ProgressBar, getProgressBar } from './lib/progress';
+export { type ProgressBar, getProgressBar } from './lib/progress';
 export { CODE_PUSHUP_DOMAIN, FOOTER_PREFIX, README_LINK, TERMINAL_WIDTH, } from './lib/reports/constants';
 export { listAuditsFromAllPlugins, listGroupsFromAllPlugins, } from './lib/reports/flatten-plugins';
 export { generateMdReport } from './lib/reports/generate-md-report';
-export { generateMdReportsDiff } from './lib/reports/generate-md-reports-diff';
+export { generateMdReportsDiff, generateMdReportsDiffForMonorepo, } from './lib/reports/generate-md-reports-diff';
 export { loadReport } from './lib/reports/load-report';
 export { logStdoutSummary } from './lib/reports/log-stdout-summary';
 export { scoreReport } from './lib/reports/scoring';
 export { sortReport } from './lib/reports/sorting';
-export { ScoredCategoryConfig, ScoredGroup, ScoredReport, } from './lib/reports/types';
-export { calcDuration, compareIssueSeverity } from './lib/reports/utils';
+export type { ScoredCategoryConfig, ScoredGroup, ScoredReport, } from './lib/reports/types';
+export { calcDuration, compareIssueSeverity, formatReportScore, } from './lib/reports/utils';
 export { isSemver, normalizeSemver, sortSemvers } from './lib/semver';
 export * from './lib/text-formats';
-export { CliArgsObject, capitalize, countOccurrences, distinct, factorOf, fromJsonLines, objectFromEntries, objectToCliArgs, objectToEntries, objectToKeys, toArray, toJsonLines, toNumberPrecision, toOrdinal, toUnixNewlines, toUnixPath, } from './lib/transform';
-export { ExcludeNullFromPropertyTypes } from './lib/types';
+export { type CliArgsObject, capitalize, countOccurrences, distinct, factorOf, fromJsonLines, objectFromEntries, objectToCliArgs, objectToEntries, objectToKeys, toArray, toJsonLines, toNumberPrecision, toOrdinal, toUnixNewlines, toUnixPath, } from './lib/transform';
+export type { ExcludeNullFromPropertyTypes, ExtractArray, ExtractArrays, ItemOrArray, Prettify, WithRequired, } from './lib/types';
 export { verboseUtils } from './lib/verbose-utils';

package/src/lib/errors.d.ts

@@ -0,0 +1 @@
+export declare function stringifyError(error: unknown): string;

package/src/lib/execute-process.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import { type ChildProcess, type SpawnOptionsWithStdioTuple, type StdioPipe } from 'node:child_process';
 /**
  * Represents the process result.
  * @category Types
@@ -66,10 +68,9 @@ export declare class ProcessError extends Error {
  * args: ['--version']
  *
  */
-export type ProcessConfig = {
+export type ProcessConfig = Omit<SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioPipe>, 'stdio'> & {
     command: string;
     args?: string[];
-    cwd?: string;
     observer?: ProcessObserver;
     ignoreExitCode?: boolean;
 };
@@ -87,7 +88,8 @@ export type ProcessConfig = {
  *  }
  */
 export type ProcessObserver = {
-    onStdout?: (stdout: string) => void;
+    onStdout?: (stdout: string, sourceProcess?: ChildProcess) => void;
+    onStderr?: (stderr: string, sourceProcess?: ChildProcess) => void;
     onError?: (error: ProcessError) => void;
     onComplete?: () => void;
 };

package/src/lib/git/git.commits-and-tags.d.ts

@@ -1,5 +1,5 @@
-import { LogOptions as SimpleGitLogOptions } from 'simple-git';
-import { Commit } from '@code-pushup/models';
+import { type LogOptions as SimpleGitLogOptions } from 'simple-git';
+import { type Commit } from '@code-pushup/models';
 export declare function getLatestCommit(git?: import("simple-git").SimpleGit): Promise<Commit | null>;
 export declare function getCurrentBranchOrTag(git?: import("simple-git").SimpleGit): Promise<string>;
 export type LogResult = {

package/src/lib/git/git.d.ts

@@ -1,4 +1,4 @@
-import { StatusResult } from 'simple-git';
+import { type StatusResult } from 'simple-git';
 export declare function getGitRoot(git?: import("simple-git").SimpleGit): Promise<string>;
 export declare function formatGitPath(path: string, gitRoot: string): string;
 export declare function toGitPath(path: string, git?: import("simple-git").SimpleGit): Promise<string>;

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

@@ -1,2 +1,2 @@
-import { CoreConfig } from '@code-pushup/models';
+import type { CoreConfig } from '@code-pushup/models';
 export declare function mergeConfigs(config: CoreConfig, ...configs: Partial<CoreConfig>[]): Partial<CoreConfig>;

package/src/lib/progress.d.ts

@@ -1,4 +1,4 @@
-import { CtorOptions, MultiProgressBars } from 'multi-progress-bars';
+import { type CtorOptions, MultiProgressBars } from 'multi-progress-bars';
 type BarStyles = 'active' | 'done' | 'idle';
 type StatusStyles = Record<BarStyles, (s: string) => string>;
 export declare const barStyles: StatusStyles;

package/src/lib/reports/flatten-plugins.d.ts

@@ -1,4 +1,4 @@
-import { Report } from '@code-pushup/models';
+import type { Report } from '@code-pushup/models';
 export declare function listGroupsFromAllPlugins<T extends Report>(report: T): {
     plugin: T['plugins'][number];
     group: NonNullable<T['plugins'][number]['groups']>[number];

package/src/lib/reports/formatting.d.ts

@@ -1,5 +1,5 @@
-import { HeadingLevel, InlineText, MarkdownDocument } from 'build-md';
-import { AuditReport, Table } from '@code-pushup/models';
+import { type HeadingLevel, type InlineText, MarkdownDocument } from 'build-md';
+import type { AuditReport, Table } from '@code-pushup/models';
 export declare function tableSection(tableData: Table, options?: {
     level?: HeadingLevel;
 }): MarkdownDocument | null;

package/src/lib/reports/generate-md-report-categoy-section.d.ts

@@ -1,6 +1,6 @@
-import { InlineText, MarkdownDocument } from 'build-md';
-import { AuditReport } from '@code-pushup/models';
-import { ScoredGroup, ScoredReport } from './types';
+import { type InlineText, MarkdownDocument } from 'build-md';
+import type { AuditReport } from '@code-pushup/models';
+import type { ScoredGroup, ScoredReport } from './types';
 export declare function categoriesOverviewSection(report: Pick<ScoredReport, 'categories' | 'plugins'>): MarkdownDocument;
 export declare function categoriesDetailsSection(report: Pick<ScoredReport, 'categories' | 'plugins'>): MarkdownDocument;
 export declare function categoryRef({ title, score, value, displayValue }: AuditReport, pluginTitle: string): InlineText;

package/src/lib/reports/generate-md-report.d.ts

@@ -1,6 +1,6 @@
-import { InlineText, MarkdownDocument } from 'build-md';
-import { AuditReport, Issue, Report } from '@code-pushup/models';
-import { ScoredReport } from './types';
+import { type InlineText, MarkdownDocument } from 'build-md';
+import type { AuditReport, Issue, Report } from '@code-pushup/models';
+import type { ScoredReport } from './types';
 export declare function auditDetailsAuditValue({ score, value, displayValue, }: AuditReport): InlineText;
 export declare function generateMdReport(report: ScoredReport): string;
 export declare function auditDetailsIssues(issues?: Issue[]): MarkdownDocument | null;

package/src/lib/reports/generate-md-reports-diff-utils.d.ts

@@ -0,0 +1,29 @@
+import { type InlineText, MarkdownDocument } from 'build-md';
+import type { ReportsDiff } from '@code-pushup/models';
+import type { DiffOutcome } from './types';
+export declare function summarizeUnchanged(token: string, { changed, unchanged }: {
+    changed: unknown[];
+    unchanged: unknown[];
+}): string;
+export declare function summarizeDiffOutcomes(outcomes: DiffOutcome[], token: string): string;
+export declare function createGroupsOrAuditsDetails<T extends 'group' | 'audit'>(token: T, { changed, unchanged }: ReportsDiff[`${T}s`], ...[columns, rows]: Parameters<MarkdownDocument['table']>): MarkdownDocument;
+export declare function formatTitle({ title, docsUrl, }: {
+    title: string;
+    docsUrl?: string;
+}): InlineText;
+export declare function formatPortalLink(portalUrl: string | undefined): InlineText | undefined;
+type Change = {
+    scores: {
+        diff: number;
+    };
+    values?: {
+        diff: number;
+    };
+};
+export declare function sortChanges<T extends Change>(changes: T[]): T[];
+export declare function getDiffChanges(diff: ReportsDiff): Change[];
+export declare function changesToDiffOutcomes(changes: Change[]): DiffOutcome[];
+export declare function mergeDiffOutcomes(outcomes: DiffOutcome[]): DiffOutcome;
+export declare function formatReportOutcome(outcome: DiffOutcome, commits?: ReportsDiff['commits']): InlineText;
+export declare function compareDiffsBy<T extends 'categories' | 'groups' | 'audits'>(type: T, a: ReportsDiff, b: ReportsDiff): number;
+export {};

package/src/lib/reports/generate-md-reports-diff.d.ts

@@ -1,2 +1,5 @@
-import { ReportsDiff } from '@code-pushup/models';
-export declare function generateMdReportsDiff(diff: ReportsDiff, portalUrl?: string): string;
+import type { ReportsDiff } from '@code-pushup/models';
+import type { WithRequired } from '../types';
+export declare function generateMdReportsDiff(diff: ReportsDiff): string;
+export type LabeledDiff = WithRequired<ReportsDiff, 'label'>;
+export declare function generateMdReportsDiffForMonorepo(diffs: LabeledDiff[]): string;

package/src/lib/reports/load-report.d.ts

@@ -1,4 +1,4 @@
-import { Format, PersistConfig, Report } from '@code-pushup/models';
+import { type Format, type PersistConfig, type Report } from '@code-pushup/models';
 type LoadedReportFormat<T extends Format> = T extends 'json' ? Report : string;
 export declare function loadReport<T extends Format>(options: Required<Omit<PersistConfig, 'format'>> & {
     format: T;

package/src/lib/reports/log-stdout-summary.d.ts

@@ -1,4 +1,4 @@
-import { ScoredReport } from './types';
+import type { ScoredReport } from './types';
 export declare function logStdoutSummary(report: ScoredReport): void;
 export declare function logCategories({ categories, plugins }: ScoredReport): void;
 export declare function binaryIconPrefix(score: number, isBinary: boolean | undefined): string;

package/src/lib/reports/scoring.d.ts

@@ -1,5 +1,5 @@
-import { Report } from '@code-pushup/models';
-import { ScoredReport } from './types';
+import type { Report } from '@code-pushup/models';
+import type { ScoredReport } from './types';
 export declare class GroupRefInvalidError extends Error {
     constructor(auditSlug: string, pluginSlug: string);
 }

package/src/lib/reports/sorting.d.ts

@@ -1,5 +1,5 @@
-import { CategoryRef, Group } from '@code-pushup/models';
-import { ScoredReport, SortableAuditReport, SortableGroup } from './types';
+import type { CategoryRef, Group } from '@code-pushup/models';
+import type { ScoredReport, SortableAuditReport, SortableGroup } from './types';
 export declare function getSortableAuditByRef({ slug, weight, plugin }: CategoryRef, plugins: ScoredReport['plugins']): SortableAuditReport;
 export declare function getSortedGroupAudits(group: Group, plugin: string, plugins: ScoredReport['plugins']): SortableAuditReport[];
 export declare function getSortableGroupByRef({ plugin, slug, weight }: CategoryRef, plugins: ScoredReport['plugins']): SortableGroup;

package/src/lib/reports/types.d.ts

@@ -1,4 +1,4 @@
-import { AuditReport, CategoryConfig, Group, PluginReport, Report } from '@code-pushup/models';
+import type { AuditReport, CategoryConfig, Group, PluginReport, Report } from '@code-pushup/models';
 export type ScoredCategoryConfig = CategoryConfig & {
     score: number;
 };

package/src/lib/reports/utils.d.ts

@@ -1,7 +1,7 @@
-import { Ansis } from 'ansis';
-import { InlineText } from 'build-md';
-import { AuditDiff, AuditReport, CategoryRef, IssueSeverity as CliIssueSeverity, Issue } from '@code-pushup/models';
-import { ScoredReport, SortableAuditReport, SortableGroup } from './types';
+import { type Ansis } from 'ansis';
+import { type InlineText } from 'build-md';
+import type { AuditDiff, AuditReport, CategoryRef, IssueSeverity as CliIssueSeverity, Issue } from '@code-pushup/models';
+import type { ScoredReport, SortableAuditReport, SortableGroup } from './types';
 export declare function formatReportScore(score: number): string;
 export declare function formatScoreWithColor(score: number, options?: {
     skipBold?: boolean;

package/src/lib/text-formats/html/table.d.ts

@@ -1,2 +1,2 @@
-import { Table } from '@code-pushup/models';
+import type { Table } from '@code-pushup/models';
 export declare function table(tableData: Table): string;

package/src/lib/text-formats/table.d.ts

@@ -1,4 +1,4 @@
-import { Table, TableAlignment, TableColumnObject, TableColumnPrimitive } from '@code-pushup/models';
+import type { Table, TableAlignment, TableColumnObject, TableColumnPrimitive } from '@code-pushup/models';
 export declare function rowToStringArray({ rows, columns }: Table): string[][];
 export declare function columnsToStringArray({ rows, columns, }: Pick<Table, 'columns' | 'rows'>): string[];
 export declare function getColumnAlignmentForKeyAndIndex(targetKey: string, targetIdx: number, columns?: TableColumnObject[]): TableAlignment;

package/src/lib/types.d.ts

@@ -1,3 +1,12 @@
 export type ExcludeNullFromPropertyTypes<T> = {
     [P in keyof T]: Exclude<T[P], null>;
 };
+export type ItemOrArray<T> = T | T[];
+export type ExtractArray<T> = T extends Array<unknown> ? T : never;
+export type ExtractArrays<T extends Record<string, unknown>> = {
+    [K in keyof T]: ExtractArray<T[K]>;
+};
+export type WithRequired<T, K extends keyof T> = Prettify<Omit<T, K> & Required<Pick<T, K>>>;
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+};