@code-pushup/utils 0.8.20 → 0.8.22

package/index.js

@@ -18,59 +18,48 @@ var MAX_DESCRIPTION_LENGTH = 65536;
 var MAX_ISSUE_MESSAGE_LENGTH = 1024;
 
 // packages/models/src/lib/implementation/utils.ts
-var slugRegex = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
+var slugRegex = /^[a-z\d]+(?:-[a-z\d]+)*$/;
 var filenameRegex = /^(?!.*[ \\/:*?"<>|]).+$/;
 function hasDuplicateStrings(strings) {
-  const uniqueStrings = Array.from(new Set(strings));
-  const duplicatedStrings = strings.filter(
-    /* @__PURE__ */ ((i) => (v) => uniqueStrings[i] !== v || !++i)(0)
+  const sortedStrings = [...strings].sort();
+  const duplStrings = sortedStrings.filter(
+    (item, index) => index !== 0 && item === sortedStrings[index - 1]
   );
-  return duplicatedStrings.length === 0 ? false : duplicatedStrings;
+  return duplStrings.length === 0 ? false : [...new Set(duplStrings)];
 }
 function hasMissingStrings(toCheck, existing) {
   const nonExisting = toCheck.filter((s) => !existing.includes(s));
   return nonExisting.length === 0 ? false : nonExisting;
 }
-function errorItems(items, transform = (items2) => items2.join(", ")) {
-  const paredItems = items ? items : [];
-  return transform(paredItems);
+function errorItems(items, transform = (itemArr) => itemArr.join(", ")) {
+  return transform(items || []);
 }
 function exists(value) {
   return value != null;
 }
 function getMissingRefsForCategories(categories, plugins) {
-  const missingRefs = [];
   const auditRefsFromCategory = categories.flatMap(
     ({ refs }) => refs.filter(({ type }) => type === "audit").map(({ plugin, slug }) => `${plugin}/${slug}`)
   );
   const auditRefsFromPlugins = plugins.flatMap(
-    ({ audits, slug: pluginSlug }) => {
-      return audits.map(({ slug }) => `${pluginSlug}/${slug}`);
-    }
+    ({ audits, slug: pluginSlug }) => audits.map(({ slug }) => `${pluginSlug}/${slug}`)
   );
   const missingAuditRefs = hasMissingStrings(
     auditRefsFromCategory,
     auditRefsFromPlugins
   );
-  if (Array.isArray(missingAuditRefs) && missingAuditRefs.length > 0) {
-    missingRefs.push(...missingAuditRefs);
-  }
   const groupRefsFromCategory = categories.flatMap(
     ({ refs }) => refs.filter(({ type }) => type === "group").map(({ plugin, slug }) => `${plugin}#${slug} (group)`)
   );
   const groupRefsFromPlugins = plugins.flatMap(
-    ({ groups, slug: pluginSlug }) => {
-      return Array.isArray(groups) ? groups.map(({ slug }) => `${pluginSlug}#${slug} (group)`) : [];
-    }
+    ({ groups, slug: pluginSlug }) => Array.isArray(groups) ? groups.map(({ slug }) => `${pluginSlug}#${slug} (group)`) : []
   );
   const missingGroupRefs = hasMissingStrings(
     groupRefsFromCategory,
     groupRefsFromPlugins
   );
-  if (Array.isArray(missingGroupRefs) && missingGroupRefs.length > 0) {
-    missingRefs.push(...missingGroupRefs);
-  }
-  return missingRefs.length ? missingRefs : false;
+  const missingRefs = [missingAuditRefs, missingGroupRefs].filter((refs) => Array.isArray(refs) && refs.length > 0).flat();
+  return missingRefs.length > 0 ? missingRefs : false;
 }
 function missingRefsForCategoriesErrorMsg(categories, plugins) {
   const missingRefs = getMissingRefsForCategories(categories, plugins);
@@ -114,7 +103,7 @@ function metaSchema(options) {
     titleDescription,
     docsUrlDescription,
     description
-  } = options || {};
+  } = options ?? {};
   return z.object(
     {
       title: titleSchema(titleDescription),
@@ -569,7 +558,7 @@ function slugify(text) {
 }
 function pluralize(text) {
   if (text.endsWith("y")) {
-    return text.slice(0, -1) + "ies";
+    return `${text.slice(0, -1)}ies`;
   }
   if (text.endsWith("s")) {
     return `${text}es`;
@@ -578,13 +567,14 @@ function pluralize(text) {
 }
 function formatBytes(bytes, decimals = 2) {
   bytes = Math.max(bytes, 0);
-  if (!bytes)
+  if (!bytes) {
     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 `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
+  return `${Number.parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
 }
 function pluralizeToken(token, times = 0) {
   return `${times} ${Math.abs(times) === 1 ? token : pluralize(token)}`;
@@ -640,7 +630,7 @@ function logMultipleResults(results, messagePrefix, succeededCallback, failedCal
   }
 }
 function logPromiseResults(results, logMessage, callback) {
-  if (results.length) {
+  if (results.length > 0) {
     if (results[0]?.status === "fulfilled") {
       console.info(logMessage);
     } else {
@@ -689,9 +679,8 @@ async function ensureDirectoryExists(baseDir) {
 function logMultipleFileResults(fileResults, messagePrefix) {
   const succeededCallback = (result) => {
     const [fileName, size] = result.value;
-    console.info(
-      `- ${chalk.bold(fileName)}` + (size ? ` (${chalk.gray(formatBytes(size))})` : "")
-    );
+    const formattedSize = size ? ` (${chalk.gray(formatBytes(size))})` : "";
+    console.info(`- ${chalk.bold(fileName)}${formattedSize}`);
   };
   const failedCallback = (result) => {
     console.warn(`- ${chalk.bold(result.reason)}`);
@@ -749,6 +738,7 @@ function findLineNumberInText(content, pattern) {
 }
 
 // packages/utils/src/lib/reports/constants.ts
+var TERMINAL_WIDTH = 80;
 var NEW_LINE = "\n";
 var SCORE_COLOR_RANGE = {
   GREEN_MIN: 0.9,
@@ -817,28 +807,20 @@ function getSeverityIcon(severity) {
   return "\u2139\uFE0F";
 }
 function calcDuration(start, stop) {
-  stop = stop !== void 0 ? stop : performance.now();
+  stop ??= performance.now();
   return Math.floor(stop - start);
 }
 function countCategoryAudits(refs, plugins) {
   const groupLookup = plugins.reduce(
     (lookup, plugin) => {
-      if (!plugin.groups.length) {
+      if (plugin.groups.length === 0) {
         return lookup;
       }
       return {
         ...lookup,
-        [plugin.slug]: {
-          ...plugin.groups.reduce(
-            (groupLookup2, group) => {
-              return {
-                ...groupLookup2,
-                [group.slug]: group
-              };
-            },
-            {}
-          )
-        }
+        [plugin.slug]: Object.fromEntries(
+          plugin.groups.map((group) => [group.slug, group])
+        )
       };
     },
     {}
@@ -846,7 +828,7 @@ function countCategoryAudits(refs, plugins) {
   return refs.reduce((acc, ref) => {
     if (ref.type === "group") {
       const groupRefs = groupLookup[ref.plugin]?.[ref.slug]?.refs;
-      return acc + (groupRefs?.length || 0);
+      return acc + (groupRefs?.length ?? 0);
     }
     return acc + 1;
   }, 0);
@@ -952,7 +934,7 @@ function compareIssues(a, b) {
     return 1;
   }
   if (a.source?.file !== b.source?.file) {
-    return a.source?.file.localeCompare(b.source?.file || "") || 0;
+    return a.source?.file.localeCompare(b.source?.file || "") ?? 0;
   }
   if (!a.source?.position && b.source?.position) {
     return -1;
@@ -961,7 +943,7 @@ function compareIssues(a, b) {
     return 1;
   }
   if (a.source?.position?.startLine !== b.source?.position?.startLine) {
-    return (a.source?.position?.startLine || 0) - (b.source?.position?.startLine || 0);
+    return (a.source?.position?.startLine ?? 0) - (b.source?.position?.startLine ?? 0);
   }
   return 0;
 }
@@ -979,12 +961,12 @@ var ProcessError = class extends Error {
   }
 };
 function executeProcess(cfg) {
-  const { observer, cwd } = cfg;
-  const { onStdout, onError, onComplete } = observer || {};
+  const { observer, cwd, command, args } = cfg;
+  const { onStdout, onError, onComplete } = observer ?? {};
   const date = (/* @__PURE__ */ new Date()).toISOString();
   const start = performance.now();
   return new Promise((resolve, reject) => {
-    const process2 = spawn(cfg.command, cfg.args, { cwd, shell: true });
+    const process2 = spawn(command, args, { cwd, shell: true });
     let stdout = "";
     let stderr = "";
     process2.stdout.on("data", (data) => {
@@ -1118,7 +1100,7 @@ function style(text, styles = ["b"]) {
 
 // packages/utils/src/lib/reports/md/headline.ts
 function headline(text, hierarchy = 1) {
-  return `${new Array(hierarchy).fill("#").join("")} ${text}`;
+  return `${"#".repeat(hierarchy)} ${text}`;
 }
 function h2(text) {
   return headline(text, 2);
@@ -1148,45 +1130,50 @@ function tableMd(data, align) {
   if (data.length === 0) {
     throw new Error("Data can't be empty");
   }
-  align = align || data[0]?.map(() => "c");
-  const _data = data.map((arr) => "|" + arr.join("|") + "|");
-  const secondRow = "|" + align?.map((s) => alignString.get(s)).join("|") + "|";
-  return _data.shift() + NEW_LINE + secondRow + NEW_LINE + _data.join(NEW_LINE);
+  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);
 }
 function tableHtml(data) {
   if (data.length === 0) {
     throw new Error("Data can't be empty");
   }
-  const _data = data.map((arr, index) => {
+  const tableContent = data.map((arr, index) => {
     if (index === 0) {
-      return "<tr>" + arr.map((s) => `<th>${s}</th>`).join("") + "</tr>";
+      const headerRow = arr.map((s) => `<th>${s}</th>`).join("");
+      return `<tr>${headerRow}</tr>`;
     }
-    return "<tr>" + arr.map((s) => `<td>${s}</td>`).join("") + "</tr>";
+    const row = arr.map((s) => `<td>${s}</td>`).join("");
+    return `<tr>${row}</tr>`;
   });
-  return "<table>" + _data.join("") + "</table>";
+  return `<table>${tableContent.join("")}</table>`;
 }
 
 // packages/utils/src/lib/reports/generate-md-report.ts
 function generateMdReport(report, commitData) {
-  let md = reportToHeaderSection() + NEW_LINE;
-  md += reportToOverviewSection(report) + NEW_LINE + NEW_LINE;
-  md += reportToCategoriesSection(report) + NEW_LINE + NEW_LINE;
-  md += reportToAuditsSection(report) + NEW_LINE + NEW_LINE;
-  md += reportToAboutSection(report, commitData) + NEW_LINE + NEW_LINE;
-  md += `${FOOTER_PREFIX} ${link(README_LINK, "Code PushUp")}`;
-  return md;
+  return (
+    // header section
+    // eslint-disable-next-line prefer-template
+    reportToHeaderSection() + NEW_LINE + // overview section
+    reportToOverviewSection(report) + NEW_LINE + NEW_LINE + // categories section
+    reportToCategoriesSection(report) + NEW_LINE + NEW_LINE + // audits section
+    reportToAuditsSection(report) + NEW_LINE + NEW_LINE + // about section
+    reportToAboutSection(report, commitData) + NEW_LINE + NEW_LINE + // footer section
+    `${FOOTER_PREFIX} ${link(README_LINK, "Code PushUp")}`
+  );
 }
 function reportToHeaderSection() {
   return headline(reportHeadlineText) + NEW_LINE;
 }
 function reportToOverviewSection(report) {
-  const { categories } = report;
+  const { categories, plugins } = report;
   const tableContent = [
     reportOverviewTableHeaders,
     ...categories.map(({ title, refs, score }) => [
       link(`#${slugify(title)}`, title),
       `${getRoundScoreMarker(score)} ${style(formatReportScore(score))}`,
-      countCategoryAudits(refs, report.plugins).toString()
+      countCategoryAudits(refs, plugins).toString()
     ])
   ];
   return tableMd(tableContent, ["l", "c", "c"]);
@@ -1322,7 +1309,10 @@ function reportToAboutSection(report, commitData) {
       formatDuration(duration2)
     ])
   ];
-  return h2("About") + NEW_LINE + NEW_LINE + `Report was created by [Code PushUp](${README_LINK}) on ${date}.` + NEW_LINE + NEW_LINE + tableMd(reportMetaTable, ["l", "c", "c", "c", "c", "c"]) + NEW_LINE + NEW_LINE + "The following plugins were run:" + NEW_LINE + NEW_LINE + tableMd(pluginMetaTable, ["l", "c", "c", "c"]);
+  return (
+    // eslint-disable-next-line prefer-template
+    h2("About") + NEW_LINE + NEW_LINE + `Report was created by [Code PushUp](${README_LINK}) on ${date}.` + NEW_LINE + NEW_LINE + tableMd(reportMetaTable, ["l", "c", "c", "c", "c", "c"]) + NEW_LINE + NEW_LINE + "The following plugins were run:" + NEW_LINE + NEW_LINE + tableMd(pluginMetaTable, ["l", "c", "c", "c"])
+  );
 }
 function getDocsAndDescription({
   docsUrl,
@@ -1356,13 +1346,7 @@ function addLine(line = "") {
   return line + NEW_LINE;
 }
 function generateStdoutSummary(report) {
-  let output = "";
-  output += addLine(reportToHeaderSection2(report));
-  output += addLine();
-  output += addLine(reportToDetailSection(report));
-  output += addLine(reportToOverviewSection2(report));
-  output += addLine(`${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`);
-  return output;
+  return addLine(reportToHeaderSection2(report)) + addLine() + addLine(reportToDetailSection(report)) + addLine(reportToOverviewSection2(report)) + addLine(`${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`);
 }
 function reportToHeaderSection2(report) {
   const { packageName, version } = report;
@@ -1370,12 +1354,9 @@ function reportToHeaderSection2(report) {
 }
 function reportToDetailSection(report) {
   const { plugins } = report;
-  let output = "";
-  plugins.forEach(({ title, audits }) => {
-    output += addLine();
-    output += addLine(chalk3.magentaBright.bold(`${title} audits`));
-    output += addLine();
-    const ui = cliui({ width: 80 });
+  return plugins.reduce((acc, plugin) => {
+    const { title, audits } = plugin;
+    const ui = cliui({ width: TERMINAL_WIDTH });
     audits.forEach(({ score, title: title2, displayValue, value }) => {
       ui.div(
         {
@@ -1385,6 +1366,7 @@ function reportToDetailSection(report) {
         },
         {
           text: title2,
+          // eslint-disable-next-line no-magic-numbers
           padding: [0, 3, 0, 0]
         },
         {
@@ -1394,17 +1376,13 @@ function reportToDetailSection(report) {
         }
       );
     });
-    output += addLine(ui.toString());
-    output += addLine();
-  });
-  return output;
+    return acc + addLine() + addLine(chalk3.magentaBright.bold(`${title} audits`)) + addLine() + addLine(ui.toString()) + addLine();
+  }, "");
 }
 function reportToOverviewSection2({
   categories,
   plugins
 }) {
-  let output = addLine(chalk3.magentaBright.bold("Categories"));
-  output += addLine();
   const table = new Table({
     head: reportRawOverviewTableHeaders,
     colAligns: ["left", "right", "right"],
@@ -1419,8 +1397,7 @@ function reportToOverviewSection2({
       countCategoryAudits(refs, plugins)
     ])
   );
-  output += addLine(table.toString());
-  return output;
+  return addLine(chalk3.magentaBright.bold("Categories")) + addLine() + addLine(table.toString());
 }
 function withColor({ score, text }) {
   const formattedScore = text ?? formatReportScore(score);
@@ -1451,7 +1428,7 @@ function countOccurrences(values) {
   );
 }
 function distinct(array) {
-  return Array.from(new Set(array));
+  return [...new Set(array)];
 }
 function deepClone(obj) {
   if (obj == null || typeof obj !== "object") {
@@ -1479,11 +1456,7 @@ function objectToCliArgs(params) {
   }
   return Object.entries(params).flatMap(([key, value]) => {
     if (key === "_") {
-      if (Array.isArray(value)) {
-        return value;
-      } else {
-        return [value + ""];
-      }
+      return Array.isArray(value) ? value : [`${value}`];
     }
     const prefix = key.length === 1 ? "-" : "--";
     if (Array.isArray(value)) {
@@ -1507,7 +1480,7 @@ function objectToCliArgs(params) {
 function toUnixPath(path, options) {
   const unixPath = path.replace(/\\/g, "/");
   if (options?.toRelative) {
-    return unixPath.replace(process.cwd().replace(/\\/g, "/") + "/", "");
+    return unixPath.replace(`${process.cwd().replace(/\\/g, "/")}/`, "");
   }
   return unixPath;
 }
@@ -1535,28 +1508,28 @@ function scoreReport(report) {
   const scoredReport = deepClone(report);
   const allScoredAuditsAndGroups = /* @__PURE__ */ new Map();
   scoredReport.plugins?.forEach((plugin) => {
-    const { audits } = plugin;
+    const { slug, audits } = plugin;
     const groups = plugin.groups || [];
     audits.forEach((audit) => {
-      const key = `${plugin.slug}-${audit.slug}-audit`;
-      audit.plugin = plugin.slug;
+      const key = `${slug}-${audit.slug}-audit`;
+      audit.plugin = slug;
       allScoredAuditsAndGroups.set(key, audit);
     });
     function groupScoreFn(ref) {
       const score = allScoredAuditsAndGroups.get(
-        `${plugin.slug}-${ref.slug}-audit`
+        `${slug}-${ref.slug}-audit`
       )?.score;
       if (score == null) {
         throw new Error(
-          `Group has invalid ref - audit with slug ${plugin.slug}-${ref.slug}-audit not found`
+          `Group has invalid ref - audit with slug ${slug}-${ref.slug}-audit not found`
         );
       }
       return score;
     }
     groups.forEach((group) => {
-      const key = `${plugin.slug}-${group.slug}-group`;
+      const key = `${slug}-${group.slug}-group`;
       group.score = calculateScore(group.refs, groupScoreFn);
-      group.plugin = plugin.slug;
+      group.plugin = slug;
       allScoredAuditsAndGroups.set(key, group);
     });
     plugin.groups = groups;
@@ -1576,7 +1549,7 @@ function scoreReport(report) {
     category.score = calculateScore(category.refs, catScoreFn);
     scoredCategoriesMap.set(category.slug, category);
   }
-  scoredReport.categories = Array.from(scoredCategoriesMap.values());
+  scoredReport.categories = [...scoredCategoriesMap.values()];
   return scoredReport;
 }
 
@@ -1602,7 +1575,7 @@ function sortReport(report) {
       ...groups,
       ...audits.sort(compareCategoryAudits)
     ];
-    const sortedRefs = category.refs.slice().sort((a, b) => {
+    const sortedRefs = [...category.refs].sort((a, b) => {
       const aIndex = sortedAuditsAndGroups.findIndex(
         (ref) => ref.slug === a.slug
       );
@@ -1615,13 +1588,15 @@ function sortReport(report) {
   });
   const sortedPlugins = plugins.map((plugin) => ({
     ...plugin,
-    audits: plugin.audits.sort(compareAudits).map((audit) => ({
-      ...audit,
-      details: {
-        ...audit.details,
-        issues: audit?.details?.issues.slice().sort(compareIssues) || []
-      }
-    }))
+    audits: [...plugin.audits].sort(compareAudits).map(
+      (audit) => audit.details?.issues ? {
+        ...audit,
+        details: {
+          ...audit.details,
+          issues: [...audit.details.issues].sort(compareIssues)
+        }
+      } : audit
+    )
   }));
   return {
     ...report,

package/package.json

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

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

@@ -1,3 +1,4 @@
+export declare const TERMINAL_WIDTH = 80;
 export declare const NEW_LINE = "\n";
 export declare const SCORE_COLOR_RANGE: {
     GREEN_MIN: number;

package/src/lib/transform.d.ts

@@ -6,7 +6,8 @@ export declare function distinct<T extends string | number | boolean>(array: T[]
 export declare function deepClone<T>(obj: T): T;
 export declare function factorOf<T>(items: T[], filterFn: (i: T) => boolean): number;
 type ArgumentValue = number | string | boolean | string[];
-export type CliArgsObject<T extends object = Record<string, ArgumentValue>> = T extends never ? Record<string, ArgumentValue | undefined> | {
+export type CliArgsObject<T extends object = Record<string, ArgumentValue>> = T extends never ? // eslint-disable-next-line @typescript-eslint/naming-convention
+Record<string, ArgumentValue | undefined> | {
     _: string;
 } : T;
 /**