@code-pushup/utils 0.27.1 → 0.29.0

package/index.js

@@ -1004,6 +1004,9 @@ function style(text, styles = ["b"]) {
 function headline(text, hierarchy = 1) {
   return `${"#".repeat(hierarchy)} ${text}`;
 }
+function h1(text) {
+  return headline(text, 1);
+}
 function h2(text) {
   return headline(text, 2);
 }
@@ -1011,6 +1014,11 @@ function h3(text) {
   return headline(text, 3);
 }
 
+// packages/utils/src/lib/reports/md/image.ts
+function image(src, alt) {
+  return `![${alt}](${src})`;
+}
+
 // packages/utils/src/lib/reports/md/link.ts
 function link2(href, text) {
   return `[${text || href}](${href})`;
@@ -1022,6 +1030,11 @@ function li(text, order = "unordered") {
   return `${style2} ${text}`;
 }
 
+// packages/utils/src/lib/reports/md/paragraphs.ts
+function paragraphs(...sections) {
+  return sections.filter(Boolean).join("\n\n");
+}
+
 // packages/utils/src/lib/reports/md/table.ts
 var alignString = /* @__PURE__ */ new Map([
   ["l", ":--"],
@@ -1056,6 +1069,10 @@ function tableHtml(data) {
 function formatReportScore(score) {
   return Math.round(score * 100).toString();
 }
+function formatScoreWithColor(score, options) {
+  const styledNumber = options?.skipBold ? formatReportScore(score) : style(formatReportScore(score));
+  return `${getRoundScoreMarker(score)} ${styledNumber}`;
+}
 function getRoundScoreMarker(score) {
   if (score >= SCORE_COLOR_RANGE.GREEN_MIN) {
     return "\u{1F7E2}";
@@ -1074,6 +1091,30 @@ function getSquaredScoreMarker(score) {
   }
   return "\u{1F7E5}";
 }
+function getDiffMarker(diff) {
+  if (diff > 0) {
+    return "\u2191";
+  }
+  if (diff < 0) {
+    return "\u2193";
+  }
+  return "";
+}
+function colorByScoreDiff(text, diff) {
+  const color = diff > 0 ? "green" : diff < 0 ? "red" : "gray";
+  return shieldsBadge(text, color);
+}
+function shieldsBadge(text, color) {
+  return image(
+    `https://img.shields.io/badge/${encodeURIComponent(text)}-${color}`,
+    text
+  );
+}
+function formatDiffNumber(diff) {
+  const number = Math.abs(diff) === Number.POSITIVE_INFINITY ? "\u221E" : `${Math.abs(diff)}`;
+  const sign = diff < 0 ? "\u2212" : "+";
+  return `${sign}${number}`;
+}
 function getSeverityIcon(severity) {
   if (severity === "error") {
     return "\u{1F6A8}";
@@ -1084,7 +1125,7 @@ function getSeverityIcon(severity) {
   return "\u2139\uFE0F";
 }
 function calcDuration(start, stop) {
-  return Math.floor((stop ?? performance.now()) - start);
+  return Math.round((stop ?? performance.now()) - start);
 }
 function countCategoryAudits(refs, plugins) {
   const groupLookup = plugins.reduce(
@@ -1496,95 +1537,6 @@ function getProgressBar(taskName) {
   };
 }
 
-// packages/utils/src/lib/reports/log-stdout-summary.ts
-import chalk4 from "chalk";
-function log(msg = "") {
-  ui().logger.log(msg);
-}
-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 reportToHeaderSection(report) {
-  const { packageName, version } = report;
-  return `${chalk4.bold(reportHeadlineText)} - ${packageName}@${version}`;
-}
-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();
-  });
-}
-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();
-}
-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/flatten-plugins.ts
 function listGroupsFromAllPlugins(report) {
   return report.plugins.flatMap(
@@ -1603,7 +1555,7 @@ function generateMdReport(report) {
   return (
     // header section
     // eslint-disable-next-line prefer-template
-    reportToHeaderSection2() + NEW_LINE + // categories overview section
+    reportToHeaderSection() + 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
@@ -1611,7 +1563,7 @@ function generateMdReport(report) {
     `${FOOTER_PREFIX} ${link2(README_LINK, "Code PushUp")}`
   );
 }
-function reportToHeaderSection2() {
+function reportToHeaderSection() {
   return headline(reportHeadlineText) + NEW_LINE;
 }
 function reportToOverviewSection(report) {
@@ -1734,7 +1686,7 @@ function reportToDetailsSection(audit) {
 function reportToAboutSection(report) {
   const date = formatDate(/* @__PURE__ */ new Date());
   const { duration, version, commit, plugins, categories } = report;
-  const commitInfo = commit ? `${commit.message} (${commit.hash.slice(0, 7)})` : "N/A";
+  const commitInfo = commit ? `${commit.message} (${commit.hash})` : "N/A";
   const reportMetaTable = [
     reportMetaTableHeaders,
     [
@@ -1784,6 +1736,314 @@ function getAuditResult(audit, isHtml = false) {
   return isHtml ? `<b>${displayValue || value}</b>` : style(String(displayValue || value));
 }
 
+// packages/utils/src/lib/reports/generate-md-reports-diff.ts
+var MAX_ROWS = 100;
+function generateMdReportsDiff(diff) {
+  return paragraphs(
+    formatDiffHeaderSection(diff),
+    formatDiffCategoriesSection(diff),
+    formatDiffGroupsSection(diff),
+    formatDiffAuditsSection(diff)
+  );
+}
+function formatDiffHeaderSection(diff) {
+  const outcomeTexts = {
+    positive: `\u{1F973} Code PushUp report has ${style("improved")}`,
+    negative: `\u{1F61F} Code PushUp report has ${style("regressed")}`,
+    mixed: `\u{1F928} Code PushUp report has both ${style(
+      "improvements and regressions"
+    )}`,
+    unchanged: `\u{1F610} Code PushUp report is ${style("unchanged")}`
+  };
+  const outcome = mergeDiffOutcomes(
+    changesToDiffOutcomes([
+      ...diff.categories.changed,
+      ...diff.groups.changed,
+      ...diff.audits.changed
+    ])
+  );
+  const styleCommits = (commits) => `compared target commit ${commits.after.hash} with source commit ${commits.before.hash}`;
+  return paragraphs(
+    h1("Code PushUp"),
+    diff.commits ? `${outcomeTexts[outcome]} \u2013 ${styleCommits(diff.commits)}.` : `${outcomeTexts[outcome]}.`
+  );
+}
+function formatDiffCategoriesSection(diff) {
+  const { changed, unchanged, added } = diff.categories;
+  const categoriesCount = changed.length + unchanged.length + added.length;
+  const hasChanges = unchanged.length < categoriesCount;
+  if (categoriesCount === 0) {
+    return "";
+  }
+  return paragraphs(
+    h2("\u{1F3F7}\uFE0F Categories"),
+    categoriesCount > 0 && tableMd(
+      [
+        [
+          "\u{1F3F7}\uFE0F Category",
+          hasChanges ? "\u2B50 Current score" : "\u2B50 Score",
+          "\u2B50 Previous score",
+          "\u{1F504} Score change"
+        ],
+        ...sortChanges(changed).map((category) => [
+          category.title,
+          formatScoreWithColor(category.scores.after),
+          formatScoreWithColor(category.scores.before, { skipBold: true }),
+          formatScoreChange(category.scores.diff)
+        ]),
+        ...added.map((category) => [
+          category.title,
+          formatScoreWithColor(category.score),
+          style("n/a (\\*)", ["i"]),
+          style("n/a (\\*)", ["i"])
+        ]),
+        ...unchanged.map((category) => [
+          category.title,
+          formatScoreWithColor(category.score),
+          formatScoreWithColor(category.score, { skipBold: true }),
+          "\u2013"
+        ])
+      ].map((row) => hasChanges ? row : row.slice(0, 2)),
+      hasChanges ? ["l", "c", "c", "c"] : ["l", "c"]
+    ),
+    added.length > 0 && style("(\\*) New category.", ["i"])
+  );
+}
+function formatDiffGroupsSection(diff) {
+  if (diff.groups.changed.length + diff.groups.unchanged.length === 0) {
+    return "";
+  }
+  return paragraphs(
+    h2("\u{1F397}\uFE0F Groups"),
+    formatGroupsOrAuditsDetails("group", diff.groups, {
+      headings: [
+        "\u{1F50C} Plugin",
+        "\u{1F5C3}\uFE0F Group",
+        "\u2B50 Current score",
+        "\u2B50 Previous score",
+        "\u{1F504} Score change"
+      ],
+      rows: sortChanges(diff.groups.changed).map((group) => [
+        group.plugin.title,
+        group.title,
+        formatScoreWithColor(group.scores.after),
+        formatScoreWithColor(group.scores.before, { skipBold: true }),
+        formatScoreChange(group.scores.diff)
+      ]),
+      align: ["l", "l", "c", "c", "c"]
+    })
+  );
+}
+function formatDiffAuditsSection(diff) {
+  return paragraphs(
+    h2("\u{1F6E1}\uFE0F Audits"),
+    formatGroupsOrAuditsDetails("audit", diff.audits, {
+      headings: [
+        "\u{1F50C} Plugin",
+        "\u{1F6E1}\uFE0F Audit",
+        "\u{1F4CF} Current value",
+        "\u{1F4CF} Previous value",
+        "\u{1F504} Value change"
+      ],
+      rows: sortChanges(diff.audits.changed).map((audit) => [
+        audit.plugin.title,
+        audit.title,
+        `${getSquaredScoreMarker(audit.scores.after)} ${style(
+          audit.displayValues.after || audit.values.after.toString()
+        )}`,
+        `${getSquaredScoreMarker(audit.scores.before)} ${audit.displayValues.before || audit.values.before.toString()}`,
+        formatValueChange(audit)
+      ]),
+      align: ["l", "l", "c", "c", "c"]
+    })
+  );
+}
+function formatGroupsOrAuditsDetails(token, { changed, unchanged }, table) {
+  return changed.length === 0 ? summarizeUnchanged(token, { changed, unchanged }) : details(
+    summarizeDiffOutcomes(changesToDiffOutcomes(changed), token),
+    paragraphs(
+      tableMd(
+        [table.headings, ...table.rows.slice(0, MAX_ROWS)],
+        table.align
+      ),
+      changed.length > MAX_ROWS && style(
+        `Only the ${MAX_ROWS} most affected ${pluralize(
+          token
+        )} are listed above for brevity.`,
+        ["i"]
+      ),
+      unchanged.length > 0 && summarizeUnchanged(token, { changed, unchanged })
+    )
+  );
+}
+function formatScoreChange(diff) {
+  const marker = getDiffMarker(diff);
+  const text = formatDiffNumber(Math.round(diff * 100));
+  return colorByScoreDiff(`${marker} ${text}`, diff);
+}
+function formatValueChange({
+  values,
+  scores
+}) {
+  const marker = getDiffMarker(values.diff);
+  const percentage = values.before === 0 ? values.diff > 0 ? Number.POSITIVE_INFINITY : Number.NEGATIVE_INFINITY : Math.round(100 * values.diff / values.before);
+  const text = `${formatDiffNumber(percentage)}\u2009%`;
+  return colorByScoreDiff(`${marker} ${text}`, scores.diff);
+}
+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 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/log-stdout-summary.ts
+import chalk4 from "chalk";
+function log(msg = "") {
+  ui().logger.log(msg);
+}
+function logStdoutSummary(report) {
+  const printCategories = report.categories.length > 0;
+  log(reportToHeaderSection2(report));
+  log();
+  logPlugins(report);
+  if (printCategories) {
+    logCategories(report);
+  }
+  log(`${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`);
+  log();
+}
+function reportToHeaderSection2(report) {
+  const { packageName, version } = report;
+  return `${chalk4.bold(reportHeadlineText)} - ${packageName}@${version}`;
+}
+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();
+  });
+}
+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();
+}
+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/scoring.ts
 var GroupRefInvalidError = class extends Error {
   constructor(auditSlug, pluginSlug) {
@@ -1965,6 +2225,7 @@ export {
   formatDuration,
   formatGitPath,
   generateMdReport,
+  generateMdReportsDiff,
   getCurrentBranchOrTag,
   getGitRoot,
   getLatestCommit,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.27.1",
+  "version": "0.29.0",
   "dependencies": {
     "@code-pushup/models": "*",
     "bundle-require": "^4.0.1",

package/src/index.d.ts

@@ -1,22 +1,23 @@
 export { exists } from '@code-pushup/models';
-export { Diff, matchArrayItemsByKey, comparePairs } from './lib/diff';
+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, 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, getCurrentBranchOrTag, safeCheckout, } from './lib/git';
+export { formatGitPath, getCurrentBranchOrTag, getGitRoot, getLatestCommit, safeCheckout, toGitPath, } from './lib/git';
 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 { 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 { generateMdReportsDiff } from './lib/reports/generate-md-reports-diff';
+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, 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';