@code-pushup/utils 0.8.24 → 0.9.0

package/index.js

@@ -457,7 +457,8 @@ var uploadConfigSchema = z10.object({
     description: "API key with write access to portal (use `process.env` for security)"
   }),
   organization: slugSchema("Organization slug from Code PushUp portal"),
-  project: slugSchema("Project slug from Code PushUp portal")
+  project: slugSchema("Project slug from Code PushUp portal"),
+  timeout: z10.number({ description: "Request timeout in minutes (default is 5)" }).positive().int().optional()
 });
 
 // packages/models/src/lib/core-config.ts
@@ -566,15 +567,15 @@ function pluralize(text) {
   return `${text}s`;
 }
 function formatBytes(bytes, decimals = 2) {
-  bytes = Math.max(bytes, 0);
-  if (!bytes) {
+  const positiveBytes = Math.max(bytes, 0);
+  if (positiveBytes === 0) {
     return "0 B";
   }
   const k = 1024;
   const dm = decimals < 0 ? 0 : decimals;
   const sizes = ["B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"];
-  const i = Math.floor(Math.log(bytes) / Math.log(k));
-  return `${Number.parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
+  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) {
   return `${times} ${Math.abs(times) === 1 ? token : pluralize(token)}`;
@@ -807,8 +808,7 @@ function getSeverityIcon(severity) {
   return "\u2139\uFE0F";
 }
 function calcDuration(start, stop) {
-  stop ??= performance.now();
-  return Math.floor(stop - start);
+  return Math.floor((stop ?? performance.now()) - start);
 }
 function countCategoryAudits(refs, plugins) {
   const groupLookup = plugins.reduce(
@@ -834,15 +834,15 @@ function countCategoryAudits(refs, plugins) {
   }, 0);
 }
 function getAuditByRef({ slug, weight, plugin }, plugins) {
-  const auditPlugin = plugins.find(({ slug: slug2 }) => slug2 === plugin);
+  const auditPlugin = plugins.find((p) => p.slug === plugin);
   if (!auditPlugin) {
     throwIsNotPresentError(`Plugin ${plugin}`, "report");
   }
-  const audit = auditPlugin?.audits.find(
+  const audit = auditPlugin.audits.find(
     ({ slug: auditSlug }) => auditSlug === slug
   );
   if (!audit) {
-    throwIsNotPresentError(`Audit ${slug}`, auditPlugin?.slug);
+    throwIsNotPresentError(`Audit ${slug}`, auditPlugin.slug);
   }
   return {
     ...audit,
@@ -855,24 +855,21 @@ function getGroupWithAudits(refSlug, refPlugin, plugins) {
   if (!plugin) {
     throwIsNotPresentError(`Plugin ${refPlugin}`, "report");
   }
-  const groupWithAudits = plugin?.groups?.find(({ slug }) => slug === refSlug);
+  const groupWithAudits = plugin.groups?.find(({ slug }) => slug === refSlug);
   if (!groupWithAudits) {
-    throwIsNotPresentError(`Group ${refSlug}`, plugin?.slug);
+    throwIsNotPresentError(`Group ${refSlug}`, plugin.slug);
   }
   const groupAudits = groupWithAudits.refs.reduce(
     (acc, ref) => {
       const audit = getAuditByRef(
-        { ...ref, plugin: refPlugin },
+        { ...ref, plugin: refPlugin, type: "audit" },
         plugins
       );
-      if (audit) {
-        return [...acc, audit];
-      }
-      return [...acc];
+      return [...acc, audit];
     },
     []
   );
-  const audits = groupAudits.sort(compareCategoryAudits);
+  const audits = [...groupAudits].sort(compareCategoryAudits);
   return {
     ...groupWithAudits,
     audits
@@ -915,7 +912,8 @@ async function loadReport(options) {
     const content = await readJsonFile(filePath);
     return reportSchema.parse(content);
   }
-  return readTextFile(filePath);
+  const text = await readTextFile(filePath);
+  return text;
 }
 function throwIsNotPresentError(itemName, presentPlace) {
   throw new Error(`${itemName} is not present in ${presentPlace}`);
@@ -970,11 +968,11 @@ function executeProcess(cfg) {
     let stdout = "";
     let stderr = "";
     process2.stdout.on("data", (data) => {
-      stdout += data.toString();
-      onStdout?.(data);
+      stdout += String(data);
+      onStdout?.(String(data));
     });
     process2.stderr.on("data", (data) => {
-      stderr += data.toString();
+      stderr += String(data);
     });
     process2.on("error", (err) => {
       stderr += err.toString();
@@ -994,28 +992,20 @@ function executeProcess(cfg) {
 }
 
 // packages/utils/src/lib/git.ts
-import simpleGit from "simple-git";
+import { simpleGit } from "simple-git";
 var git = simpleGit();
 async function getLatestCommit() {
   const log = await git.log({
     maxCount: 1,
     format: { hash: "%H", message: "%s", author: "%an", date: "%ad" }
   });
-  return log?.latest;
+  return log.latest;
 }
 
 // packages/utils/src/lib/group-by-status.ts
 function groupByStatus(results) {
   return results.reduce(
-    (acc, result) => {
-      if (result.status === "fulfilled") {
-        return { ...acc, fulfilled: [...acc.fulfilled, result] };
-      }
-      if (result.status === "rejected") {
-        return { ...acc, rejected: [...acc.rejected, result] };
-      }
-      return acc;
-    },
+    (acc, result) => result.status === "fulfilled" ? { ...acc, fulfilled: [...acc.fulfilled, result] } : { ...acc, rejected: [...acc.rejected, result] },
     { fulfilled: [], rejected: [] }
   );
 }
@@ -1130,10 +1120,10 @@ function tableMd(data, align) {
   if (data.length === 0) {
     throw new Error("Data can't be empty");
   }
-  align ??= data[0]?.map(() => "c");
+  const alignmentSetting = align ?? data[0]?.map(() => "c");
   const tableContent = data.map((arr) => `|${arr.join("|")}|`);
-  const secondRow = `|${align?.map((s) => alignString.get(s)).join("|")}|`;
-  return tableContent.shift() + NEW_LINE + secondRow + NEW_LINE + tableContent.join(NEW_LINE);
+  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) {
@@ -1186,15 +1176,15 @@ function reportToCategoriesSection(report) {
       category.score
     )} Score:  ${style(formatReportScore(category.score))}`;
     const categoryDocs = getDocsAndDescription(category);
-    const categoryMDItems = category.refs.reduce((acc2, ref) => {
+    const categoryMDItems = category.refs.reduce((refAcc, ref) => {
       if (ref.type === "group") {
         const group = getGroupWithAudits(ref.slug, ref.plugin, plugins);
         const mdGroupItem = groupItemToCategorySection(group, plugins);
-        return acc2 + mdGroupItem + NEW_LINE;
+        return refAcc + mdGroupItem + NEW_LINE;
       } else {
         const audit = getAuditByRef(ref, plugins);
         const mdAuditItem = auditItemToCategorySection(audit, plugins);
-        return acc2 + mdAuditItem + NEW_LINE;
+        return refAcc + mdAuditItem + NEW_LINE;
       }
     }, "");
     return acc + NEW_LINE + categoryTitle + NEW_LINE + NEW_LINE + categoryDocs + categoryScore + NEW_LINE + categoryMDItems;
@@ -1205,7 +1195,7 @@ function auditItemToCategorySection(audit, plugins) {
   const pluginTitle = getPluginNameFromSlug(audit.plugin, plugins);
   const auditTitle = link(
     `#${slugify(audit.title)}-${slugify(pluginTitle)}`,
-    audit?.title
+    audit.title
   );
   return li(
     `${getSquaredScoreMarker(
@@ -1222,69 +1212,57 @@ function groupItemToCategorySection(group, plugins) {
   const groupAudits = group.audits.reduce((acc, audit) => {
     const auditTitle = link(
       `#${slugify(audit.title)}-${slugify(pluginTitle)}`,
-      audit?.title
+      audit.title
     );
-    acc += `  ${li(
+    return `${acc}  ${li(
       `${getSquaredScoreMarker(audit.score)} ${auditTitle} - ${getAuditResult(
         audit
       )}`
-    )}`;
-    acc += NEW_LINE;
-    return acc;
+    )}${NEW_LINE}`;
   }, "");
   return groupTitle + NEW_LINE + groupAudits;
 }
 function reportToAuditsSection(report) {
-  const auditsSection = report.plugins.reduce((acc, plugin) => {
-    const auditsData = plugin.audits.reduce((acc2, audit) => {
+  const auditsSection = report.plugins.reduce((pluginAcc, plugin) => {
+    const auditsData = plugin.audits.reduce((auditAcc, audit) => {
       const auditTitle = `${audit.title} (${getPluginNameFromSlug(
         audit.plugin,
         report.plugins
       )})`;
-      const detailsTitle = `${getSquaredScoreMarker(
-        audit.score
-      )} ${getAuditResult(audit, true)} (score: ${formatReportScore(
-        audit.score
-      )})`;
-      const docsItem = getDocsAndDescription(audit);
-      acc2 += h3(auditTitle);
-      acc2 += NEW_LINE;
-      acc2 += NEW_LINE;
-      if (!audit.details?.issues?.length) {
-        acc2 += detailsTitle;
-        acc2 += NEW_LINE;
-        acc2 += NEW_LINE;
-        acc2 += docsItem;
-        return acc2;
-      }
-      const detailsTableData = [
-        detailsTableHeaders,
-        ...audit.details.issues.map((issue) => {
-          const severity = `${getSeverityIcon(issue.severity)} <i>${issue.severity}</i>`;
-          const message = issue.message;
-          if (!issue.source) {
-            return [severity, message, "", ""];
-          }
-          const file = `<code>${issue.source?.file}</code>`;
-          if (!issue.source.position) {
-            return [severity, message, file, ""];
-          }
-          const { startLine, endLine } = issue.source.position;
-          const line = `${startLine || ""}${endLine && startLine !== endLine ? `-${endLine}` : ""}`;
-          return [severity, message, file, line];
-        })
-      ];
-      const detailsTable = `<h4>Issues</h4>${tableHtml(detailsTableData)}`;
-      acc2 += details(detailsTitle, detailsTable);
-      acc2 += NEW_LINE;
-      acc2 += NEW_LINE;
-      acc2 += docsItem;
-      return acc2;
+      return auditAcc + h3(auditTitle) + NEW_LINE + NEW_LINE + reportToDetailsSection(audit) + NEW_LINE + NEW_LINE + getDocsAndDescription(audit);
     }, "");
-    return acc + auditsData;
+    return pluginAcc + auditsData;
   }, "");
   return h2("\u{1F6E1}\uFE0F Audits") + NEW_LINE + NEW_LINE + auditsSection;
 }
+function reportToDetailsSection(audit) {
+  const detailsTitle = `${getSquaredScoreMarker(audit.score)} ${getAuditResult(
+    audit,
+    true
+  )} (score: ${formatReportScore(audit.score)})`;
+  if (!audit.details?.issues.length) {
+    return detailsTitle;
+  }
+  const detailsTableData = [
+    detailsTableHeaders,
+    ...audit.details.issues.map((issue) => {
+      const severity = `${getSeverityIcon(issue.severity)} <i>${issue.severity}</i>`;
+      const message = issue.message;
+      if (!issue.source) {
+        return [severity, message, "", ""];
+      }
+      const file = `<code>${issue.source.file}</code>`;
+      if (!issue.source.position) {
+        return [severity, message, file, ""];
+      }
+      const { startLine, endLine } = issue.source.position;
+      const line = `${startLine || ""}${endLine && startLine !== endLine ? `-${endLine}` : ""}`;
+      return [severity, message, file, line];
+    })
+  ];
+  const detailsTable = `<h4>Issues</h4>${tableHtml(detailsTableData)}`;
+  return details(detailsTitle, detailsTable);
+}
 function reportToAboutSection(report, commitData) {
   const date = (/* @__PURE__ */ new Date()).toString();
   const { duration, version, plugins, categories } = report;
@@ -1302,11 +1280,11 @@ function reportToAboutSection(report, commitData) {
   ];
   const pluginMetaTable = [
     pluginMetaTableHeaders,
-    ...plugins.map(({ title, version: version2, duration: duration2, audits }) => [
-      title,
-      audits.length.toString(),
-      style(version2 || "", ["c"]),
-      formatDuration(duration2)
+    ...plugins.map((plugin) => [
+      plugin.title,
+      plugin.audits.length.toString(),
+      style(plugin.version || "", ["c"]),
+      formatDuration(plugin.duration)
     ])
   ];
   return (
@@ -1341,7 +1319,7 @@ function getAuditResult(audit, isHtml = false) {
 // packages/utils/src/lib/reports/generate-stdout-summary.ts
 import cliui from "@isaacs/cliui";
 import chalk3 from "chalk";
-import Table from "cli-table3";
+import CliTable3 from "cli-table3";
 function addLine(line = "") {
   return line + NEW_LINE;
 }
@@ -1357,20 +1335,20 @@ function reportToDetailSection(report) {
   return plugins.reduce((acc, plugin) => {
     const { title, audits } = plugin;
     const ui = cliui({ width: TERMINAL_WIDTH });
-    audits.forEach(({ score, title: title2, displayValue, value }) => {
+    audits.forEach((audit) => {
       ui.div(
         {
-          text: withColor({ score, text: "\u25CF" }),
+          text: withColor({ score: audit.score, text: "\u25CF" }),
           width: 2,
           padding: [0, 1, 0, 0]
         },
         {
-          text: title2,
+          text: audit.title,
           // eslint-disable-next-line no-magic-numbers
           padding: [0, 3, 0, 0]
         },
         {
-          text: chalk3.cyanBright(displayValue || `${value}`),
+          text: chalk3.cyanBright(audit.displayValue || `${audit.value}`),
           width: 10,
           padding: [0, 0, 0, 0]
         }
@@ -1383,7 +1361,7 @@ function reportToOverviewSection2({
   categories,
   plugins
 }) {
-  const table = new Table({
+  const table = new CliTable3({
     head: reportRawOverviewTableHeaders,
     colAligns: ["left", "right", "right"],
     style: {
@@ -1431,16 +1409,7 @@ function distinct(array) {
   return [...new Set(array)];
 }
 function deepClone(obj) {
-  if (obj == null || typeof obj !== "object") {
-    return obj;
-  }
-  const cloned = Array.isArray(obj) ? [] : {};
-  for (const key in obj) {
-    if (Object.prototype.hasOwnProperty.call(obj, key)) {
-      cloned[key] = deepClone(obj[key]);
-    }
-  }
-  return cloned;
+  return obj == null || typeof obj !== "object" ? obj : structuredClone(obj);
 }
 function factorOf(items, filterFn) {
   const itemCount = items.length;
@@ -1505,15 +1474,12 @@ function calculateScore(refs, scoreFn) {
   return numerator / denominator;
 }
 function scoreReport(report) {
-  const scoredReport = deepClone(report);
   const allScoredAuditsAndGroups = /* @__PURE__ */ new Map();
-  scoredReport.plugins?.forEach((plugin) => {
-    const { slug, audits } = plugin;
-    const groups = plugin.groups || [];
-    audits.forEach((audit) => {
-      const key = `${slug}-${audit.slug}-audit`;
-      audit.plugin = slug;
-      allScoredAuditsAndGroups.set(key, audit);
+  const scoredPlugins = report.plugins.map((plugin) => {
+    const { slug, audits, groups } = plugin;
+    const updatedAudits = audits.map((audit) => ({ ...audit, plugin: slug }));
+    updatedAudits.forEach((audit) => {
+      allScoredAuditsAndGroups.set(`${slug}-${audit.slug}-audit`, audit);
     });
     function groupScoreFn(ref) {
       const score = allScoredAuditsAndGroups.get(
@@ -1526,13 +1492,15 @@ function scoreReport(report) {
       }
       return score;
     }
-    groups.forEach((group) => {
-      const key = `${slug}-${group.slug}-group`;
-      group.score = calculateScore(group.refs, groupScoreFn);
-      group.plugin = slug;
-      allScoredAuditsAndGroups.set(key, group);
+    const scoredGroups = groups?.map((group) => ({
+      ...group,
+      score: calculateScore(group.refs, groupScoreFn),
+      plugin: slug
+    })) ?? [];
+    scoredGroups.forEach((group) => {
+      allScoredAuditsAndGroups.set(`${slug}-${group.slug}-group`, group);
     });
-    plugin.groups = groups;
+    return { ...plugin, audits: updatedAudits, groups: scoredGroups };
   });
   function catScoreFn(ref) {
     const key = `${ref.plugin}-${ref.slug}-${ref.type}`;
@@ -1544,13 +1512,15 @@ function scoreReport(report) {
     }
     return item.score;
   }
-  const scoredCategoriesMap = /* @__PURE__ */ new Map();
-  for (const category of scoredReport.categories) {
-    category.score = calculateScore(category.refs, catScoreFn);
-    scoredCategoriesMap.set(category.slug, category);
-  }
-  scoredReport.categories = [...scoredCategoriesMap.values()];
-  return scoredReport;
+  const scoredCategories = report.categories.map((category) => ({
+    ...category,
+    score: calculateScore(category.refs, catScoreFn)
+  }));
+  return {
+    ...deepClone(report),
+    plugins: scoredPlugins,
+    categories: scoredCategories
+  };
 }
 
 // packages/utils/src/lib/reports/sorting.ts
@@ -1573,7 +1543,7 @@ function sortReport(report) {
     );
     const sortedAuditsAndGroups = [
       ...groups,
-      ...audits.sort(compareCategoryAudits)
+      ...[...audits].sort(compareCategoryAudits)
     ];
     const sortedRefs = [...category.refs].sort((a, b) => {
       const aIndex = sortedAuditsAndGroups.findIndex(
@@ -1586,7 +1556,14 @@ function sortReport(report) {
     });
     return { ...category, refs: sortedRefs };
   });
-  const sortedPlugins = plugins.map((plugin) => ({
+  return {
+    ...report,
+    categories: sortedCategories,
+    plugins: sortPlugins(plugins)
+  };
+}
+function sortPlugins(plugins) {
+  return plugins.map((plugin) => ({
     ...plugin,
     audits: [...plugin.audits].sort(compareAudits).map(
       (audit) => audit.details?.issues ? {
@@ -1598,11 +1575,6 @@ function sortReport(report) {
       } : audit
     )
   }));
-  return {
-    ...report,
-    categories: sortedCategories,
-    plugins: sortedPlugins
-  };
 }
 
 // packages/utils/src/lib/verbose-utils.ts

package/package.json

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