@code-pushup/utils 0.26.1 → 0.27.1

package/index.js

@@ -84,6 +84,9 @@ var descriptionSchema = z.string({ description: "Description (markdown)" }).max(
 var urlSchema = z.string().url();
 var docsUrlSchema = urlSchema.optional().or(z.literal("")).describe("Documentation site");
 var titleSchema = z.string({ description: "Descriptive name" }).max(MAX_TITLE_LENGTH);
+var scoreSchema = z.number({
+  description: "Value between 0 and 1"
+}).min(0).max(1);
 function metaSchema(options) {
   const {
     descriptionDescription,
@@ -215,6 +218,8 @@ var issueSchema = z3.object(
 );
 
 // packages/models/src/lib/audit-output.ts
+var auditValueSchema = nonnegativeIntSchema.describe("Raw numeric value");
+var auditDisplayValueSchema = z4.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional();
 var auditDetailsSchema = z4.object(
   {
     issues: z4.array(issueSchema, { description: "List of findings" })
@@ -224,11 +229,9 @@ var auditDetailsSchema = z4.object(
 var auditOutputSchema = z4.object(
   {
     slug: slugSchema.describe("Reference to audit"),
-    displayValue: z4.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional(),
-    value: nonnegativeIntSchema.describe("Raw numeric value"),
-    score: z4.number({
-      description: "Value between 0 and 1"
-    }).min(0).max(1),
+    displayValue: auditDisplayValueSchema,
+    value: auditValueSchema,
+    score: scoreSchema,
     details: auditDetailsSchema.optional()
   },
   { description: "Audit information" }
@@ -551,6 +554,138 @@ var reportSchema = packageVersionSchema({
   })
 );
 
+// packages/models/src/lib/reports-diff.ts
+import { z as z14 } from "zod";
+function makeComparisonSchema(schema) {
+  const sharedDescription = schema.description || "Result";
+  return z14.object({
+    before: schema.describe(`${sharedDescription} (source commit)`),
+    after: schema.describe(`${sharedDescription} (target commit)`)
+  });
+}
+function makeArraysComparisonSchema(diffSchema, resultSchema, description) {
+  return z14.object(
+    {
+      changed: z14.array(diffSchema),
+      unchanged: z14.array(resultSchema),
+      added: z14.array(resultSchema),
+      removed: z14.array(resultSchema)
+    },
+    { description }
+  );
+}
+var scorableMetaSchema = z14.object({ slug: slugSchema, title: titleSchema });
+var scorableWithPluginMetaSchema = scorableMetaSchema.merge(
+  z14.object({
+    plugin: pluginMetaSchema.pick({ slug: true, title: true }).describe("Plugin which defines it")
+  })
+);
+var scorableDiffSchema = scorableMetaSchema.merge(
+  z14.object({
+    scores: makeComparisonSchema(scoreSchema).merge(
+      z14.object({
+        diff: z14.number().min(-1).max(1).describe("Score change (`scores.after - scores.before`)")
+      })
+    ).describe("Score comparison")
+  })
+);
+var scorableWithPluginDiffSchema = scorableDiffSchema.merge(
+  scorableWithPluginMetaSchema
+);
+var categoryDiffSchema = scorableDiffSchema;
+var groupDiffSchema = scorableWithPluginDiffSchema;
+var auditDiffSchema = scorableWithPluginDiffSchema.merge(
+  z14.object({
+    values: makeComparisonSchema(auditValueSchema).merge(
+      z14.object({
+        diff: z14.number().int().describe("Value change (`values.after - values.before`)")
+      })
+    ).describe("Audit `value` comparison"),
+    displayValues: makeComparisonSchema(auditDisplayValueSchema).describe(
+      "Audit `displayValue` comparison"
+    )
+  })
+);
+var categoryResultSchema = scorableMetaSchema.merge(
+  z14.object({ score: scoreSchema })
+);
+var groupResultSchema = scorableWithPluginMetaSchema.merge(
+  z14.object({ score: scoreSchema })
+);
+var auditResultSchema = scorableWithPluginMetaSchema.merge(
+  auditOutputSchema.pick({ score: true, value: true, displayValue: true })
+);
+var reportsDiffSchema = z14.object({
+  commits: makeComparisonSchema(commitSchema).nullable().describe("Commits identifying compared reports"),
+  categories: makeArraysComparisonSchema(
+    categoryDiffSchema,
+    categoryResultSchema,
+    "Changes affecting categories"
+  ),
+  groups: makeArraysComparisonSchema(
+    groupDiffSchema,
+    groupResultSchema,
+    "Changes affecting groups"
+  ),
+  audits: makeArraysComparisonSchema(
+    auditDiffSchema,
+    auditResultSchema,
+    "Changes affecting audits"
+  )
+}).merge(
+  packageVersionSchema({
+    versionDescription: "NPM version of the CLI (when `compare` was run)",
+    required: true
+  })
+).merge(
+  executionMetaSchema({
+    descriptionDate: "Start date and time of the compare run",
+    descriptionDuration: "Duration of the compare run in ms"
+  })
+);
+
+// packages/utils/src/lib/diff.ts
+function matchArrayItemsByKey({
+  before,
+  after,
+  key
+}) {
+  const pairs = [];
+  const added = [];
+  const afterKeys = /* @__PURE__ */ new Set();
+  const keyFn = typeof key === "function" ? key : (item) => item[key];
+  for (const afterItem of after) {
+    const afterKey = keyFn(afterItem);
+    afterKeys.add(afterKey);
+    const match = before.find((beforeItem) => keyFn(beforeItem) === afterKey);
+    if (match) {
+      pairs.push({ before: match, after: afterItem });
+    } else {
+      added.push(afterItem);
+    }
+  }
+  const removed = before.filter(
+    (beforeItem) => !afterKeys.has(keyFn(beforeItem))
+  );
+  return {
+    pairs,
+    added,
+    removed
+  };
+}
+function comparePairs(pairs, equalsFn) {
+  return pairs.reduce(
+    (acc, pair) => ({
+      ...acc,
+      ...equalsFn(pair) ? { unchanged: [...acc.unchanged, pair.after] } : { changed: [...acc.changed, pair] }
+    }),
+    {
+      changed: [],
+      unchanged: []
+    }
+  );
+}
+
 // packages/utils/src/lib/execute-process.ts
 import { spawn } from "node:child_process";
 
@@ -559,7 +694,7 @@ import { join as join2 } from "node:path";
 
 // packages/utils/src/lib/file-system.ts
 import { bundleRequire } from "bundle-require";
-import chalk from "chalk";
+import chalk2 from "chalk";
 import { mkdir, readFile, readdir, rm, stat } from "node:fs/promises";
 import { join } from "node:path";
 
@@ -567,7 +702,10 @@ import { join } from "node:path";
 function slugify(text) {
   return text.trim().toLowerCase().replace(/\s+|\//g, "-").replace(/[^a-z\d-]/g, "");
 }
-function pluralize(text) {
+function pluralize(text, amount) {
+  if (amount != null && Math.abs(amount) === 1) {
+    return text;
+  }
   if (text.endsWith("y")) {
     return `${text.slice(0, -1)}ies`;
   }
@@ -587,7 +725,7 @@ function formatBytes(bytes, decimals = 2) {
   const i = Math.floor(Math.log(positiveBytes) / Math.log(k));
   return `${Number.parseFloat((positiveBytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
 }
-function pluralizeToken(token, times = 0) {
+function pluralizeToken(token, times) {
   return `${times} ${Math.abs(times) === 1 ? token : pluralize(token)}`;
 }
 function formatDuration(duration) {
@@ -633,33 +771,106 @@ function isPromiseRejectedResult(result) {
   return result.status === "rejected";
 }
 
+// packages/utils/src/lib/logging.ts
+import isaacs_cliui from "@isaacs/cliui";
+import { cliui } from "@poppinss/cliui";
+import chalk from "chalk";
+
+// packages/utils/src/lib/reports/constants.ts
+var TERMINAL_WIDTH = 80;
+var NEW_LINE = "\n";
+var SCORE_COLOR_RANGE = {
+  GREEN_MIN: 0.9,
+  YELLOW_MIN: 0.5
+};
+var FOOTER_PREFIX = "Made with \u2764 by";
+var CODE_PUSHUP_DOMAIN = "code-pushup.dev";
+var README_LINK = "https://github.com/flowup/quality-metrics-cli#readme";
+var reportHeadlineText = "Code PushUp Report";
+var reportOverviewTableHeaders = [
+  "\u{1F3F7} Category",
+  "\u2B50 Score",
+  "\u{1F6E1} Audits"
+];
+var reportRawOverviewTableHeaders = ["Category", "Score", "Audits"];
+var reportMetaTableHeaders = [
+  "Commit",
+  "Version",
+  "Duration",
+  "Plugins",
+  "Categories",
+  "Audits"
+];
+var pluginMetaTableHeaders = [
+  "Plugin",
+  "Audits",
+  "Version",
+  "Duration"
+];
+var detailsTableHeaders = [
+  "Severity",
+  "Message",
+  "Source file",
+  "Line(s)"
+];
+
+// packages/utils/src/lib/logging.ts
+var singletonUiInstance;
+function ui() {
+  if (singletonUiInstance === void 0) {
+    singletonUiInstance = cliui();
+  }
+  return {
+    ...singletonUiInstance,
+    row: (args) => {
+      logListItem(args);
+    }
+  };
+}
+var singletonisaacUi;
+function logListItem(args) {
+  if (singletonisaacUi === void 0) {
+    singletonisaacUi = isaacs_cliui({ width: TERMINAL_WIDTH });
+  }
+  singletonisaacUi.div(...args);
+  const content = singletonisaacUi.toString();
+  singletonisaacUi.rows = [];
+  singletonUiInstance?.logger.log(content);
+}
+function link(text) {
+  return chalk.underline(chalk.blueBright(text));
+}
+
 // packages/utils/src/lib/log-results.ts
-function logMultipleResults(results, messagePrefix, succeededCallback, failedCallback) {
-  if (succeededCallback) {
+function logMultipleResults(results, messagePrefix, succeededTransform, failedTransform) {
+  if (succeededTransform) {
     const succeededResults = results.filter(isPromiseFulfilledResult);
     logPromiseResults(
       succeededResults,
       `${messagePrefix} successfully: `,
-      succeededCallback
+      succeededTransform
     );
   }
-  if (failedCallback) {
+  if (failedTransform) {
     const failedResults = results.filter(isPromiseRejectedResult);
     logPromiseResults(
       failedResults,
       `${messagePrefix} failed: `,
-      failedCallback
+      failedTransform
     );
   }
 }
-function logPromiseResults(results, logMessage, callback) {
+function logPromiseResults(results, logMessage, getMsg) {
   if (results.length > 0) {
-    if (results[0]?.status === "fulfilled") {
-      console.info(logMessage);
-    } else {
-      console.warn(logMessage);
-    }
-    results.forEach(callback);
+    const log2 = results[0]?.status === "fulfilled" ? (m) => {
+      ui().logger.success(m);
+    } : (m) => {
+      ui().logger.warning(m);
+    };
+    log2(logMessage);
+    results.forEach((result) => {
+      log2(getMsg(result));
+    });
   }
 }
 
@@ -693,7 +904,7 @@ async function ensureDirectoryExists(baseDir) {
     await mkdir(baseDir, { recursive: true });
     return;
   } catch (error) {
-    console.error(error.message);
+    ui().logger.error(error.message);
     if (error.code !== "EEXIST") {
       throw error;
     }
@@ -705,19 +916,17 @@ async function removeDirectoryIfExists(dir) {
   }
 }
 function logMultipleFileResults(fileResults, messagePrefix) {
-  const succeededCallback = (result) => {
+  const succeededTransform = (result) => {
     const [fileName, size] = result.value;
-    const formattedSize = size ? ` (${chalk.gray(formatBytes(size))})` : "";
-    console.info(`- ${chalk.bold(fileName)}${formattedSize}`);
-  };
-  const failedCallback = (result) => {
-    console.warn(`- ${chalk.bold(result.reason)}`);
+    const formattedSize = size ? ` (${chalk2.gray(formatBytes(size))})` : "";
+    return `- ${chalk2.bold(fileName)}${formattedSize}`;
   };
+  const failedTransform = (result) => `- ${chalk2.bold(result.reason)}`;
   logMultipleResults(
     fileResults,
     messagePrefix,
-    succeededCallback,
-    failedCallback
+    succeededTransform,
+    failedTransform
   );
 }
 var NoExportError = class extends Error {
@@ -765,43 +974,83 @@ function findLineNumberInText(content, pattern) {
   return lineNumber === 0 ? null : lineNumber;
 }
 
-// packages/utils/src/lib/reports/constants.ts
-var TERMINAL_WIDTH = 80;
-var NEW_LINE = "\n";
-var SCORE_COLOR_RANGE = {
-  GREEN_MIN: 0.9,
-  YELLOW_MIN: 0.5
+// packages/utils/src/lib/reports/md/details.ts
+function details(title, content, cfg = { open: false }) {
+  return `<details${cfg.open ? " open" : ""}>
+<summary>${title}</summary>
+
+${content}
+
+</details>
+`;
+}
+
+// packages/utils/src/lib/reports/md/font-style.ts
+var stylesMap = {
+  i: "_",
+  // italic
+  b: "**",
+  // bold
+  s: "~",
+  // strike through
+  c: "`"
+  // code
 };
-var FOOTER_PREFIX = "Made with \u2764 by";
-var CODE_PUSHUP_DOMAIN = "code-pushup.dev";
-var README_LINK = "https://github.com/flowup/quality-metrics-cli#readme";
-var reportHeadlineText = "Code PushUp Report";
-var reportOverviewTableHeaders = [
-  "\u{1F3F7} Category",
-  "\u2B50 Score",
-  "\u{1F6E1} Audits"
-];
-var reportRawOverviewTableHeaders = ["Category", "Score", "Audits"];
-var reportMetaTableHeaders = [
-  "Commit",
-  "Version",
-  "Duration",
-  "Plugins",
-  "Categories",
-  "Audits"
-];
-var pluginMetaTableHeaders = [
-  "Plugin",
-  "Audits",
-  "Version",
-  "Duration"
-];
-var detailsTableHeaders = [
-  "Severity",
-  "Message",
-  "Source file",
-  "Line(s)"
-];
+function style(text, styles = ["b"]) {
+  return styles.reduce((t, s) => `${stylesMap[s]}${t}${stylesMap[s]}`, text);
+}
+
+// packages/utils/src/lib/reports/md/headline.ts
+function headline(text, hierarchy = 1) {
+  return `${"#".repeat(hierarchy)} ${text}`;
+}
+function h2(text) {
+  return headline(text, 2);
+}
+function h3(text) {
+  return headline(text, 3);
+}
+
+// packages/utils/src/lib/reports/md/link.ts
+function link2(href, text) {
+  return `[${text || href}](${href})`;
+}
+
+// packages/utils/src/lib/reports/md/list.ts
+function li(text, order = "unordered") {
+  const style2 = order === "unordered" ? "-" : "- [ ]";
+  return `${style2} ${text}`;
+}
+
+// packages/utils/src/lib/reports/md/table.ts
+var alignString = /* @__PURE__ */ new Map([
+  ["l", ":--"],
+  ["c", ":--:"],
+  ["r", "--:"]
+]);
+function tableMd(data, align) {
+  if (data.length === 0) {
+    throw new Error("Data can't be empty");
+  }
+  const alignmentSetting = align ?? data[0]?.map(() => "c");
+  const tableContent = data.map((arr) => `|${arr.join("|")}|`);
+  const alignmentRow = `|${alignmentSetting?.map((s) => alignString.get(s)).join("|")}|`;
+  return tableContent[0] + NEW_LINE + alignmentRow + NEW_LINE + tableContent.slice(1).join(NEW_LINE);
+}
+function tableHtml(data) {
+  if (data.length === 0) {
+    throw new Error("Data can't be empty");
+  }
+  const tableContent = data.map((arr, index) => {
+    if (index === 0) {
+      const headerRow = arr.map((s) => `<th>${s}</th>`).join("");
+      return `<tr>${headerRow}</tr>`;
+    }
+    const row = arr.map((s) => `<td>${s}</td>`).join("");
+    return `<tr>${row}</tr>`;
+  });
+  return `<table>${tableContent.join("")}</table>`;
+}
 
 // packages/utils/src/lib/reports/utils.ts
 function formatReportScore(score) {
@@ -998,7 +1247,7 @@ var ProcessError = class extends Error {
   }
 };
 function executeProcess(cfg) {
-  const { observer, cwd, command, args } = cfg;
+  const { observer, cwd, command, args, alwaysResolve = false } = cfg;
   const { onStdout, onError, onComplete } = observer ?? {};
   const date = (/* @__PURE__ */ new Date()).toISOString();
   const start = performance.now();
@@ -1018,7 +1267,7 @@ function executeProcess(cfg) {
     });
     process2.on("close", (code) => {
       const timings = { date, duration: calcDuration(start) };
-      if (code === 0) {
+      if (code === 0 || alwaysResolve) {
         onComplete?.();
         resolve({ code, stdout, stderr, ...timings });
       } else {
@@ -1133,14 +1382,14 @@ function toOrdinal(value) {
 
 // packages/utils/src/lib/git.ts
 async function getLatestCommit(git = simpleGit()) {
-  const log = await git.log({
+  const log2 = await git.log({
     maxCount: 1,
     format: { hash: "%H", message: "%s", author: "%an", date: "%aI" }
   });
-  if (!log.latest) {
+  if (!log2.latest) {
     return null;
   }
-  return commitSchema.parse(log.latest);
+  return commitSchema.parse(log2.latest);
 }
 function getGitRoot(git = simpleGit()) {
   return git.revparse("--show-toplevel");
@@ -1154,6 +1403,35 @@ async function toGitPath(path, git = simpleGit()) {
   const gitRoot = await getGitRoot(git);
   return formatGitPath(path, gitRoot);
 }
+async function guardAgainstLocalChanges(git = simpleGit()) {
+  const isClean = await git.status(["-s"]).then((r) => r.files.length === 0);
+  if (!isClean) {
+    throw new Error(
+      "Working directory needs to be clean before we you can proceed. Commit your local changes or stash them."
+    );
+  }
+}
+async function getCurrentBranchOrTag(git = simpleGit()) {
+  try {
+    const branch = await git.branch().then((r) => r.current);
+    if (branch) {
+      return branch;
+    } else {
+      return await git.raw(["describe", "--tags", "--exact-match"]).then((out) => out.trim());
+    }
+  } catch {
+    throw new Error("Could not get current tag or branch.");
+  }
+}
+async function safeCheckout(branchOrHash, forceCleanStatus = false, git = simpleGit()) {
+  if (forceCleanStatus) {
+    await git.raw(["reset", "--hard"]);
+    await git.clean(["f", "d"]);
+    ui().logger.info(`git status cleaned`);
+  }
+  await guardAgainstLocalChanges(git);
+  await git.checkout(branchOrHash);
+}
 
 // packages/utils/src/lib/group-by-status.ts
 function groupByStatus(results) {
@@ -1163,12 +1441,6 @@ function groupByStatus(results) {
   );
 }
 
-// packages/utils/src/lib/logging.ts
-import chalk2 from "chalk";
-function link(text) {
-  return chalk2.underline(chalk2.blueBright(text));
-}
-
 // packages/utils/src/lib/progress.ts
 import chalk3 from "chalk";
 import { MultiProgressBars } from "multi-progress-bars";
@@ -1224,80 +1496,105 @@ function getProgressBar(taskName) {
   };
 }
 
-// packages/utils/src/lib/reports/md/details.ts
-function details(title, content, cfg = { open: false }) {
-  return `<details${cfg.open ? " open" : ""}>
-<summary>${title}</summary>
-${content}
-</details>
-`;
-}
-
-// packages/utils/src/lib/reports/md/font-style.ts
-var stylesMap = {
-  i: "_",
-  // italic
-  b: "**",
-  // bold
-  s: "~",
-  // strike through
-  c: "`"
-  // code
-};
-function style(text, styles = ["b"]) {
-  return styles.reduce((t, s) => `${stylesMap[s]}${t}${stylesMap[s]}`, text);
+// packages/utils/src/lib/reports/log-stdout-summary.ts
+import chalk4 from "chalk";
+function log(msg = "") {
+  ui().logger.log(msg);
 }
-
-// packages/utils/src/lib/reports/md/headline.ts
-function headline(text, hierarchy = 1) {
-  return `${"#".repeat(hierarchy)} ${text}`;
+function logStdoutSummary(report) {
+  const printCategories = report.categories.length > 0;
+  log(reportToHeaderSection(report));
+  log();
+  logPlugins(report);
+  if (printCategories) {
+    logCategories(report);
+  }
+  log(`${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`);
+  log();
 }
-function h2(text) {
-  return headline(text, 2);
+function reportToHeaderSection(report) {
+  const { packageName, version } = report;
+  return `${chalk4.bold(reportHeadlineText)} - ${packageName}@${version}`;
 }
-function h3(text) {
-  return headline(text, 3);
+function logPlugins(report) {
+  const { plugins } = report;
+  plugins.forEach((plugin) => {
+    const { title, audits } = plugin;
+    log();
+    log(chalk4.magentaBright.bold(`${title} audits`));
+    log();
+    audits.forEach((audit) => {
+      ui().row([
+        {
+          text: applyScoreColor({ score: audit.score, text: "\u25CF" }),
+          width: 2,
+          padding: [0, 1, 0, 0]
+        },
+        {
+          text: audit.title,
+          // eslint-disable-next-line no-magic-numbers
+          padding: [0, 3, 0, 0]
+        },
+        {
+          text: chalk4.cyanBright(audit.displayValue || `${audit.value}`),
+          width: 10,
+          padding: [0, 0, 0, 0]
+        }
+      ]);
+    });
+    log();
+  });
 }
-
-// packages/utils/src/lib/reports/md/link.ts
-function link2(href, text) {
-  return `[${text || href}](${href})`;
+function logCategories({ categories, plugins }) {
+  const hAlign = (idx) => idx === 0 ? "left" : "right";
+  const rows = categories.map(({ title, score, refs }) => [
+    title,
+    applyScoreColor({ score }),
+    countCategoryAudits(refs, plugins)
+  ]);
+  const table = ui().table();
+  table.columnWidths([TERMINAL_WIDTH - 9 - 10 - 4, 9, 10]);
+  table.head(
+    reportRawOverviewTableHeaders.map((heading, idx) => ({
+      content: chalk4.cyan(heading),
+      hAlign: hAlign(idx)
+    }))
+  );
+  rows.forEach(
+    (row) => table.row(
+      row.map((content, idx) => ({
+        content: content.toString(),
+        hAlign: hAlign(idx)
+      }))
+    )
+  );
+  log(chalk4.magentaBright.bold("Categories"));
+  log();
+  table.render();
+  log();
 }
-
-// packages/utils/src/lib/reports/md/list.ts
-function li(text, order = "unordered") {
-  const style2 = order === "unordered" ? "-" : "- [ ]";
-  return `${style2} ${text}`;
+function applyScoreColor({ score, text }) {
+  const formattedScore = text ?? formatReportScore(score);
+  const style2 = text ? chalk4 : chalk4.bold;
+  if (score >= SCORE_COLOR_RANGE.GREEN_MIN) {
+    return style2.green(formattedScore);
+  }
+  if (score >= SCORE_COLOR_RANGE.YELLOW_MIN) {
+    return style2.yellow(formattedScore);
+  }
+  return style2.red(formattedScore);
 }
 
-// packages/utils/src/lib/reports/md/table.ts
-var alignString = /* @__PURE__ */ new Map([
-  ["l", ":--"],
-  ["c", ":--:"],
-  ["r", "--:"]
-]);
-function tableMd(data, align) {
-  if (data.length === 0) {
-    throw new Error("Data can't be empty");
-  }
-  const alignmentSetting = align ?? data[0]?.map(() => "c");
-  const tableContent = data.map((arr) => `|${arr.join("|")}|`);
-  const alignmentRow = `|${alignmentSetting?.map((s) => alignString.get(s)).join("|")}|`;
-  return tableContent[0] + NEW_LINE + alignmentRow + NEW_LINE + tableContent.slice(1).join(NEW_LINE);
+// packages/utils/src/lib/reports/flatten-plugins.ts
+function listGroupsFromAllPlugins(report) {
+  return report.plugins.flatMap(
+    (plugin) => plugin.groups?.map((group) => ({ plugin, group })) ?? []
+  );
 }
-function tableHtml(data) {
-  if (data.length === 0) {
-    throw new Error("Data can't be empty");
-  }
-  const tableContent = data.map((arr, index) => {
-    if (index === 0) {
-      const headerRow = arr.map((s) => `<th>${s}</th>`).join("");
-      return `<tr>${headerRow}</tr>`;
-    }
-    const row = arr.map((s) => `<td>${s}</td>`).join("");
-    return `<tr>${row}</tr>`;
-  });
-  return `<table>${tableContent.join("")}</table>`;
+function listAuditsFromAllPlugins(report) {
+  return report.plugins.flatMap(
+    (plugin) => plugin.audits.map((audit) => ({ plugin, audit }))
+  );
 }
 
 // packages/utils/src/lib/reports/generate-md-report.ts
@@ -1306,7 +1603,7 @@ function generateMdReport(report) {
   return (
     // header section
     // eslint-disable-next-line prefer-template
-    reportToHeaderSection() + NEW_LINE + // categories overview section
+    reportToHeaderSection2() + NEW_LINE + // categories overview section
     (printCategories ? reportToOverviewSection(report) + NEW_LINE + NEW_LINE : "") + // categories section
     (printCategories ? reportToCategoriesSection(report) + NEW_LINE + NEW_LINE : "") + // audits section
     reportToAuditsSection(report) + NEW_LINE + NEW_LINE + // about section
@@ -1314,7 +1611,7 @@ function generateMdReport(report) {
     `${FOOTER_PREFIX} ${link2(README_LINK, "Code PushUp")}`
   );
 }
-function reportToHeaderSection() {
+function reportToHeaderSection2() {
   return headline(reportHeadlineText) + NEW_LINE;
 }
 function reportToOverviewSection(report) {
@@ -1487,82 +1784,6 @@ function getAuditResult(audit, isHtml = false) {
   return isHtml ? `<b>${displayValue || value}</b>` : style(String(displayValue || value));
 }
 
-// packages/utils/src/lib/reports/generate-stdout-summary.ts
-import cliui from "@isaacs/cliui";
-import chalk4 from "chalk";
-import CliTable3 from "cli-table3";
-function addLine(line = "") {
-  return line + NEW_LINE;
-}
-function generateStdoutSummary(report) {
-  const printCategories = report.categories.length > 0;
-  return addLine(reportToHeaderSection2(report)) + addLine() + addLine(reportToDetailSection(report)) + (printCategories ? addLine(reportToOverviewSection2(report)) : "") + addLine(`${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`);
-}
-function reportToHeaderSection2(report) {
-  const { packageName, version } = report;
-  return `${chalk4.bold(reportHeadlineText)} - ${packageName}@${version}`;
-}
-function reportToDetailSection(report) {
-  const { plugins } = report;
-  return plugins.reduce((acc, plugin) => {
-    const { title, audits } = plugin;
-    const ui = cliui({ width: TERMINAL_WIDTH });
-    audits.forEach((audit) => {
-      ui.div(
-        {
-          text: withColor({ score: audit.score, text: "\u25CF" }),
-          width: 2,
-          padding: [0, 1, 0, 0]
-        },
-        {
-          text: audit.title,
-          // eslint-disable-next-line no-magic-numbers
-          padding: [0, 3, 0, 0]
-        },
-        {
-          text: chalk4.cyanBright(audit.displayValue || `${audit.value}`),
-          width: 10,
-          padding: [0, 0, 0, 0]
-        }
-      );
-    });
-    return acc + addLine() + addLine(chalk4.magentaBright.bold(`${title} audits`)) + addLine() + addLine(ui.toString()) + addLine();
-  }, "");
-}
-function reportToOverviewSection2({
-  categories,
-  plugins
-}) {
-  const table = new CliTable3({
-    // eslint-disable-next-line no-magic-numbers
-    colWidths: [TERMINAL_WIDTH - 7 - 8 - 4, 7, 8],
-    head: reportRawOverviewTableHeaders,
-    colAligns: ["left", "right", "right"],
-    style: {
-      head: ["cyan"]
-    }
-  });
-  table.push(
-    ...categories.map(({ title, score, refs }) => [
-      title,
-      withColor({ score }),
-      countCategoryAudits(refs, plugins)
-    ])
-  );
-  return addLine(chalk4.magentaBright.bold("Categories")) + addLine() + addLine(table.toString());
-}
-function withColor({ score, text }) {
-  const formattedScore = text ?? formatReportScore(score);
-  const style2 = text ? chalk4 : chalk4.bold;
-  if (score >= SCORE_COLOR_RANGE.GREEN_MIN) {
-    return style2.green(formattedScore);
-  }
-  if (score >= SCORE_COLOR_RANGE.YELLOW_MIN) {
-    return style2.yellow(formattedScore);
-  }
-  return style2.red(formattedScore);
-}
-
 // packages/utils/src/lib/reports/scoring.ts
 var GroupRefInvalidError = class extends Error {
   constructor(auditSlug, pluginSlug) {
@@ -1702,9 +1923,9 @@ function sortPlugins(plugins) {
 
 // packages/utils/src/lib/verbose-utils.ts
 function getLogVerbose(verbose = false) {
-  return (...args) => {
+  return (msg) => {
     if (verbose) {
-      console.info(...args);
+      ui().logger.info(msg);
     }
   };
 }
@@ -1728,6 +1949,7 @@ export {
   calcDuration,
   capitalize,
   compareIssueSeverity,
+  comparePairs,
   countOccurrences,
   crawlFileSystem,
   directoryExists,
@@ -1743,7 +1965,7 @@ export {
   formatDuration,
   formatGitPath,
   generateMdReport,
-  generateStdoutSummary,
+  getCurrentBranchOrTag,
   getGitRoot,
   getLatestCommit,
   getProgressBar,
@@ -1752,9 +1974,13 @@ export {
   isPromiseFulfilledResult,
   isPromiseRejectedResult,
   link,
+  listAuditsFromAllPlugins,
+  listGroupsFromAllPlugins,
   loadReport,
   logMultipleFileResults,
   logMultipleResults,
+  logStdoutSummary,
+  matchArrayItemsByKey,
   objectToCliArgs,
   objectToEntries,
   objectToKeys,
@@ -1764,6 +1990,7 @@ export {
   readJsonFile,
   readTextFile,
   removeDirectoryIfExists,
+  safeCheckout,
   scoreReport,
   slugify,
   sortReport,
@@ -1777,5 +2004,6 @@ export {
   truncateIssueMessage,
   truncateText,
   truncateTitle,
+  ui,
   verboseUtils
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.26.1",
+  "version": "0.27.1",
   "dependencies": {
     "@code-pushup/models": "*",
     "bundle-require": "^4.0.1",
@@ -8,7 +8,7 @@
     "@isaacs/cliui": "^8.0.2",
     "simple-git": "^3.20.0",
     "multi-progress-bars": "^5.0.3",
-    "cli-table3": "^0.6.3"
+    "@poppinss/cliui": "^6.4.0"
   },
   "license": "MIT",
   "homepage": "https://github.com/code-pushup/cli#readme",

package/src/index.d.ts

@@ -1,20 +1,22 @@
 export { exists } from '@code-pushup/models';
+export { Diff, matchArrayItemsByKey, comparePairs } from './lib/diff';
 export { ProcessConfig, ProcessError, ProcessObserver, ProcessResult, executeProcess, } from './lib/execute-process';
 export { CrawlFileSystemOptions, FileResult, MultipleFileResults, crawlFileSystem, directoryExists, ensureDirectoryExists, fileExists, findLineNumberInText, importEsmModule, 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, getLatestCommit, toGitPath, } from './lib/git';
+export { formatGitPath, getGitRoot, getLatestCommit, toGitPath, getCurrentBranchOrTag, safeCheckout, } from './lib/git';
 export { groupByStatus } from './lib/group-by-status';
 export { isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards';
 export { logMultipleResults } from './lib/log-results';
-export { link } from './lib/logging';
 export { ProgressBar, getProgressBar } from './lib/progress';
+export { logStdoutSummary } from './lib/reports/log-stdout-summary';
 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 { generateStdoutSummary } from './lib/reports/generate-stdout-summary';
 export { scoreReport } from './lib/reports/scoring';
 export { sortReport } from './lib/reports/sorting';
-export { ScoredReport } from './lib/reports/types';
+export { ScoredCategoryConfig, ScoredGroup, ScoredReport, } from './lib/reports/types';
 export { calcDuration, compareIssueSeverity, loadReport, } from './lib/reports/utils';
 export { CliArgsObject, capitalize, countOccurrences, distinct, factorOf, objectToCliArgs, objectToEntries, objectToKeys, toArray, toNumberPrecision, toOrdinal, toUnixNewlines, toUnixPath, } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';
+export { link, ui, CliUi, Column } from './lib/logging';

package/src/lib/diff.d.ts

@@ -0,0 +1,15 @@
+export type Diff<T> = {
+    before: T;
+    after: T;
+};
+export declare function matchArrayItemsByKey<T>({ before, after, key, }: Diff<T[]> & {
+    key: keyof T | ((item: T) => unknown);
+}): {
+    pairs: Diff<T>[];
+    added: T[];
+    removed: T[];
+};
+export declare function comparePairs<T>(pairs: Diff<T>[], equalsFn: (pair: Diff<T>) => boolean): {
+    changed: Diff<T>[];
+    unchanged: T[];
+};

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

@@ -71,6 +71,7 @@ export type ProcessConfig = {
     args?: string[];
     cwd?: string;
     observer?: ProcessObserver;
+    alwaysResolve?: boolean;
 };
 /**
  * Process observer object. Contains the onStdout, error and complete function.

package/src/lib/formatting.d.ts

@@ -1,7 +1,7 @@
 export declare function slugify(text: string): string;
-export declare function pluralize(text: string): string;
+export declare function pluralize(text: string, amount?: number): string;
 export declare function formatBytes(bytes: number, decimals?: number): string;
-export declare function pluralizeToken(token: string, times?: number): string;
+export declare function pluralizeToken(token: string, times: number): string;
 export declare function formatDuration(duration: number): string;
 export declare function formatDate(date: Date): string;
 export declare function truncateText(text: string, maxChars: number): string;

package/src/lib/git.d.ts

@@ -5,6 +5,4 @@ export declare function formatGitPath(path: string, gitRoot: string): string;
 export declare function toGitPath(path: string, git?: import("simple-git").SimpleGit): Promise<string>;
 export declare function guardAgainstLocalChanges(git?: import("simple-git").SimpleGit): Promise<void>;
 export declare function getCurrentBranchOrTag(git?: import("simple-git").SimpleGit): Promise<string>;
-export declare function safeCheckout(branchOrHash: string, options?: {
-    forceCleanStatus?: true;
-}, git?: import("simple-git").SimpleGit): Promise<void>;
+export declare function safeCheckout(branchOrHash: string, forceCleanStatus?: boolean, git?: import("simple-git").SimpleGit): Promise<void>;

package/src/lib/log-results.d.ts

@@ -1,2 +1,2 @@
-export declare function logMultipleResults<T>(results: PromiseSettledResult<T>[], messagePrefix: string, succeededCallback?: (result: PromiseFulfilledResult<T>) => void, failedCallback?: (result: PromiseRejectedResult) => void): void;
-export declare function logPromiseResults<T extends PromiseFulfilledResult<unknown> | PromiseRejectedResult>(results: T[], logMessage: string, callback: (result: T) => void): void;
+export declare function logMultipleResults<T>(results: PromiseSettledResult<T>[], messagePrefix: string, succeededTransform?: (result: PromiseFulfilledResult<T>) => string, failedTransform?: (result: PromiseRejectedResult) => string): void;
+export declare function logPromiseResults<T extends PromiseFulfilledResult<unknown> | PromiseRejectedResult>(results: T[], logMessage: string, getMsg: (result: T) => string): void;

package/src/lib/logging.d.ts

@@ -1 +1,21 @@
+import isaacs_cliui from '@isaacs/cliui';
+import { cliui } from '@poppinss/cliui';
+type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
+export type CliUiBase = ReturnType<typeof cliui>;
+type UI = ReturnType<typeof isaacs_cliui>;
+type CliExtension = {
+    row: (r: ArgumentsType<UI['div']>) => void;
+};
+export type Column = {
+    text: string;
+    width?: number;
+    align?: 'right' | 'left' | 'center';
+    padding: number[];
+    border?: boolean;
+};
+export type CliUi = CliUiBase & CliExtension;
+export declare let singletonUiInstance: CliUiBase | undefined;
+export declare function ui(): CliUi;
+export declare function logListItem(args: ArgumentsType<UI['div']>): void;
 export declare function link(text: string): string;
+export {};

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

@@ -0,0 +1,9 @@
+import { 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];
+}[];
+export declare function listAuditsFromAllPlugins<T extends Report>(report: T): {
+    plugin: T['plugins'][number];
+    audit: T['plugins'][number]['audits'][number];
+}[];

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

@@ -0,0 +1,2 @@
+import { ReportsDiff } from '@code-pushup/models';
+export declare function generateMdReportsDiff(diff: ReportsDiff): string;

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

@@ -0,0 +1,2 @@
+import { ScoredReport } from './types';
+export declare function logStdoutSummary(report: ScoredReport): void;

package/src/lib/reports/md/headline.d.ts

@@ -6,6 +6,7 @@ export type Hierarchy = 1 | 2 | 3 | 4 | 5 | 6;
  */
 export declare function headline(text: string, hierarchy?: Hierarchy): string;
 export declare function h(text: string, hierarchy?: Hierarchy): string;
+export declare function h1(text: string): string;
 export declare function h2(text: string): string;
 export declare function h3(text: string): string;
 export declare function h4(text: string): string;

package/src/lib/reports/md/image.d.ts

@@ -0,0 +1 @@
+export declare function image(src: string, alt: string): string;

package/src/lib/reports/md/index.d.ts

@@ -1,6 +1,8 @@
 export * from './details';
 export * from './font-style';
 export * from './headline';
+export * from './image';
 export * from './link';
 export * from './list';
+export * from './paragraphs';
 export * from './table';

package/src/lib/reports/md/paragraphs.d.ts

@@ -0,0 +1 @@
+export declare function paragraphs(...sections: (string | undefined | boolean)[]): string;

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

@@ -19,3 +19,4 @@ export type SortableAuditReport = AuditReport & {
     weight: number;
     plugin: string;
 };
+export type DiffOutcome = 'positive' | 'negative' | 'mixed' | 'unchanged';

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

@@ -1,8 +1,15 @@
 import { AuditReport, CategoryRef, IssueSeverity as CliIssueSeverity, Format, Group, Issue, PersistConfig, Report } from '@code-pushup/models';
 import { ScoredReport, SortableAuditReport, SortableGroup } from './types';
 export declare function formatReportScore(score: number): string;
+export declare function formatScoreWithColor(score: number, options?: {
+    skipBold?: boolean;
+}): string;
 export declare function getRoundScoreMarker(score: number): string;
 export declare function getSquaredScoreMarker(score: number): string;
+export declare function getDiffMarker(diff: number): string;
+export declare function colorByScoreDiff(text: string, diff: number): string;
+export declare function shieldsBadge(text: string, color: string): string;
+export declare function formatDiffNumber(diff: number): string;
 export declare function getSeverityIcon(severity: 'info' | 'warning' | 'error'): string;
 export declare function calcDuration(start: number, stop?: number): number;
 export declare function countWeightedRefs(refs: CategoryRef[]): number;

package/src/lib/verbose-utils.d.ts

@@ -1,4 +1,4 @@
 export declare const verboseUtils: (verbose?: boolean) => {
-    log: (...args: unknown[]) => void;
+    log: (msg: string) => void;
     exec: (fn: () => unknown) => void;
 };

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

@@ -1,2 +0,0 @@
-import { ScoredReport } from './types';
-export declare function generateStdoutSummary(report: ScoredReport): string;