@code-pushup/utils 0.8.10 → 0.8.12

package/index.js

@@ -1,7 +1,7 @@
 // packages/utils/src/lib/execute-process.ts
 import { spawn } from "node:child_process";
 
-// packages/utils/src/lib/report.ts
+// packages/utils/src/lib/reports/utils.ts
 import { join as join2 } from "node:path";
 
 // packages/models/src/lib/audit.ts
@@ -38,6 +38,46 @@ function errorItems(items, transform = (items2) => items2.join(", ")) {
 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}`);
+    }
+  );
+  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)`) : [];
+    }
+  );
+  const missingGroupRefs = hasMissingStrings(
+    groupRefsFromCategory,
+    groupRefsFromPlugins
+  );
+  if (Array.isArray(missingGroupRefs) && missingGroupRefs.length > 0) {
+    missingRefs.push(...missingGroupRefs);
+  }
+  return missingRefs.length ? missingRefs : false;
+}
+function missingRefsForCategoriesErrorMsg(categories, plugins) {
+  const missingRefs = getMissingRefsForCategories(categories, plugins);
+  return `The following category references need to point to an audit or group: ${errorItems(
+    missingRefs
+  )}`;
+}
 
 // packages/models/src/lib/implementation/schemas.ts
 function executionMetaSchema(options = {
@@ -96,15 +136,13 @@ function positiveIntSchema(description) {
   return z.number({ description }).int().nonnegative();
 }
 function packageVersionSchema(options) {
-  let { versionDescription, optional } = options || {};
-  versionDescription = versionDescription || "NPM version of the package";
-  optional = !!optional;
+  const { versionDescription = "NPM version of the package", required } = options ?? {};
   const packageSchema = z.string({ description: "NPM package name" });
   const versionSchema = z.string({ description: versionDescription });
   return z.object(
     {
-      packageName: optional ? packageSchema.optional() : packageSchema,
-      version: optional ? versionSchema.optional() : versionSchema
+      packageName: required ? packageSchema : packageSchema.optional(),
+      version: required ? versionSchema : versionSchema.optional()
     },
     { description: "NPM package name and version of a published package" }
   );
@@ -166,7 +204,7 @@ var pluginAuditsSchema = z2.array(auditSchema, {
 );
 function duplicateSlugsInAuditsErrorMsg(audits) {
   const duplicateRefs = getDuplicateSlugsInAudits(audits);
-  return `In plugin audits the slugs are not unique: ${errorItems(
+  return `In plugin audits the following slugs are not unique: ${errorItems(
     duplicateRefs
   )}`;
 }
@@ -355,7 +393,9 @@ function getDuplicateRefsInGroups(groups) {
 }
 function duplicateSlugsInGroupsErrorMsg(groups) {
   const duplicateRefs = getDuplicateSlugsInGroups(groups);
-  return `In groups the slugs are not unique: ${errorItems(duplicateRefs)}`;
+  return `In groups the following slugs are not unique: ${errorItems(
+    duplicateRefs
+  )}`;
 }
 function getDuplicateSlugsInGroups(groups) {
   return Array.isArray(groups) ? hasDuplicateStrings(groups.map(({ slug }) => slug)) : false;
@@ -381,9 +421,7 @@ var onProgressSchema = z8.function().args(z8.unknown()).returns(z8.void());
 var runnerFunctionSchema = z8.function().args(onProgressSchema.optional()).returns(z8.union([auditOutputsSchema, z8.promise(auditOutputsSchema)]));
 
 // packages/models/src/lib/plugin-config.ts
-var pluginMetaSchema = packageVersionSchema({
-  optional: true
-}).merge(
+var pluginMetaSchema = packageVersionSchema().merge(
   metaSchema({
     titleDescription: "Descriptive name",
     descriptionDescription: "Description (markdown)",
@@ -392,7 +430,7 @@ var pluginMetaSchema = packageVersionSchema({
   })
 ).merge(
   z9.object({
-    slug: slugSchema("References plugin. ID (unique within core config)"),
+    slug: slugSchema("Unique plugin slug within core config"),
     icon: materialIconSchema
   })
 );
@@ -409,20 +447,17 @@ var pluginConfigSchema = pluginMetaSchema.merge(pluginDataSchema).refine(
 );
 function missingRefsFromGroupsErrorMsg(pluginCfg) {
   const missingRefs = getMissingRefsFromGroups(pluginCfg);
-  return `In the groups, the following audit ref's needs to point to a audit in this plugin config: ${errorItems(
+  return `The following group references need to point to an existing audit in this plugin config: ${errorItems(
     missingRefs
   )}`;
 }
 function getMissingRefsFromGroups(pluginCfg) {
-  if (pluginCfg?.groups?.length && pluginCfg?.audits?.length) {
-    const groups = pluginCfg?.groups || [];
-    const audits = pluginCfg?.audits || [];
-    return hasMissingStrings(
-      groups.flatMap(({ refs: audits2 }) => audits2.map(({ slug: ref }) => ref)),
-      audits.map(({ slug }) => slug)
-    );
-  }
-  return false;
+  return hasMissingStrings(
+    pluginCfg.groups?.flatMap(
+      ({ refs: audits }) => audits.map(({ slug: ref }) => ref)
+    ) ?? [],
+    pluginCfg.audits.map(({ slug }) => slug)
+  );
 }
 
 // packages/models/src/lib/upload-config.ts
@@ -432,19 +467,15 @@ var uploadConfigSchema = z10.object({
   apiKey: z10.string({
     description: "API key with write access to portal (use `process.env` for security)"
   }),
-  organization: z10.string({
-    description: "Organization in code versioning system"
-  }),
-  project: z10.string({
-    description: "Project in code versioning system"
-  })
+  organization: slugSchema("Organization slug from Code PushUp portal"),
+  project: slugSchema("Project slug from Code PushUp portal")
 });
 
 // packages/models/src/lib/core-config.ts
 var unrefinedCoreConfigSchema = z11.object({
   plugins: z11.array(pluginConfigSchema, {
     description: "List of plugins to be used (official, community-provided, or custom)"
-  }),
+  }).min(1),
   /** portal configuration for persisting results */
   persist: persistConfigSchema.optional(),
   /** portal configuration for uploading results */
@@ -454,52 +485,15 @@ var unrefinedCoreConfigSchema = z11.object({
 var coreConfigSchema = refineCoreConfig(unrefinedCoreConfigSchema);
 function refineCoreConfig(schema) {
   return schema.refine(
-    (coreCfg) => !getMissingRefsForCategories(coreCfg),
+    (coreCfg) => !getMissingRefsForCategories(coreCfg.categories, coreCfg.plugins),
     (coreCfg) => ({
-      message: missingRefsForCategoriesErrorMsg(coreCfg)
+      message: missingRefsForCategoriesErrorMsg(
+        coreCfg.categories,
+        coreCfg.plugins
+      )
     })
   );
 }
-function missingRefsForCategoriesErrorMsg(coreCfg) {
-  const missingRefs = getMissingRefsForCategories(coreCfg);
-  return `In the categories, the following plugin refs do not exist in the provided plugins: ${errorItems(
-    missingRefs
-  )}`;
-}
-function getMissingRefsForCategories(coreCfg) {
-  const missingRefs = [];
-  const auditRefsFromCategory = coreCfg.categories.flatMap(
-    ({ refs }) => refs.filter(({ type }) => type === "audit").map(({ plugin, slug }) => `${plugin}/${slug}`)
-  );
-  const auditRefsFromPlugins = coreCfg.plugins.flatMap(
-    ({ audits, slug: pluginSlug }) => {
-      return audits.map(({ slug }) => `${pluginSlug}/${slug}`);
-    }
-  );
-  const missingAuditRefs = hasMissingStrings(
-    auditRefsFromCategory,
-    auditRefsFromPlugins
-  );
-  if (Array.isArray(missingAuditRefs) && missingAuditRefs.length > 0) {
-    missingRefs.push(...missingAuditRefs);
-  }
-  const groupRefsFromCategory = coreCfg.categories.flatMap(
-    ({ refs }) => refs.filter(({ type }) => type === "group").map(({ plugin, slug }) => `${plugin}#${slug} (group)`)
-  );
-  const groupRefsFromPlugins = coreCfg.plugins.flatMap(
-    ({ groups, slug: pluginSlug }) => {
-      return 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;
-}
 
 // packages/models/src/lib/report.ts
 import { z as z12 } from "zod";
@@ -514,9 +508,32 @@ var pluginReportSchema = pluginMetaSchema.merge(
     audits: z12.array(auditReportSchema),
     groups: z12.array(groupSchema).optional()
   })
+).refine(
+  (pluginReport) => !getMissingRefsFromGroups2(pluginReport.audits, pluginReport.groups ?? []),
+  (pluginReport) => ({
+    message: missingRefsFromGroupsErrorMsg2(
+      pluginReport.audits,
+      pluginReport.groups ?? []
+    )
+  })
 );
+function missingRefsFromGroupsErrorMsg2(audits, groups) {
+  const missingRefs = getMissingRefsFromGroups2(audits, groups);
+  return `group references need to point to an existing audit in this plugin report: ${errorItems(
+    missingRefs
+  )}`;
+}
+function getMissingRefsFromGroups2(audits, groups) {
+  return hasMissingStrings(
+    groups.flatMap(
+      ({ refs: auditRefs }) => auditRefs.map(({ slug: ref }) => ref)
+    ),
+    audits.map(({ slug }) => slug)
+  );
+}
 var reportSchema = packageVersionSchema({
-  versionDescription: "NPM version of the CLI"
+  versionDescription: "NPM version of the CLI",
+  required: true
 }).merge(
   executionMetaSchema({
     descriptionDate: "Start date and time of the collect run",
@@ -526,18 +543,20 @@ var reportSchema = packageVersionSchema({
   z12.object(
     {
       categories: z12.array(categoryConfigSchema),
-      plugins: z12.array(pluginReportSchema)
+      plugins: z12.array(pluginReportSchema).min(1)
     },
     { description: "Collect output data" }
   )
+).refine(
+  (report) => !getMissingRefsForCategories(report.categories, report.plugins),
+  (report) => ({
+    message: missingRefsForCategoriesErrorMsg(
+      report.categories,
+      report.plugins
+    )
+  })
 );
 
-// packages/utils/src/lib/constants.ts
-var SCORE_COLOR_RANGE = {
-  GREEN_MIN: 0.9,
-  YELLOW_MIN: 0.5
-};
-
 // packages/utils/src/lib/file-system.ts
 import { bundleRequire } from "bundle-require";
 import chalk from "chalk";
@@ -721,7 +740,14 @@ function findLineNumberInText(content, pattern) {
   return lineNumber === 0 ? null : lineNumber;
 }
 
-// packages/utils/src/lib/report.ts
+// packages/utils/src/lib/reports/constants.ts
+var NEW_LINE = "\n";
+var SCORE_COLOR_RANGE = {
+  GREEN_MIN: 0.9,
+  YELLOW_MIN: 0.5
+};
+
+// packages/utils/src/lib/reports/utils.ts
 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";
@@ -1004,83 +1030,6 @@ function groupByStatus(results) {
   );
 }
 
-// packages/utils/src/lib/md/details.ts
-function details(title, content, cfg = { open: false }) {
-  return `<details${cfg.open ? " open" : ""}>
-<summary>${title}</summary>
-${content}
-</details>
-`;
-}
-
-// packages/utils/src/lib/md/headline.ts
-function headline(text, hierarchy = 1) {
-  return `${new Array(hierarchy).fill("#").join("")} ${text}`;
-}
-function h2(text) {
-  return headline(text, 2);
-}
-function h3(text) {
-  return headline(text, 3);
-}
-
-// packages/utils/src/lib/md/constants.ts
-var NEW_LINE = "\n";
-
-// packages/utils/src/lib/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");
-  }
-  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);
-}
-function tableHtml(data) {
-  if (data.length === 0) {
-    throw new Error("Data can't be empty");
-  }
-  const _data = data.map((arr, index) => {
-    if (index === 0) {
-      return "<tr>" + arr.map((s) => `<th>${s}</th>`).join("") + "</tr>";
-    }
-    return "<tr>" + arr.map((s) => `<td>${s}</td>`).join("") + "</tr>";
-  });
-  return "<table>" + _data.join("") + "</table>";
-}
-
-// packages/utils/src/lib/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/md/link.ts
-function link(href, text) {
-  return `[${text || href}](${href})`;
-}
-
-// packages/utils/src/lib/md/list.ts
-function li(text, order = "unordered") {
-  const style2 = order === "unordered" ? "-" : "- [ ]";
-  return `${style2} ${text}`;
-}
-
 // packages/utils/src/lib/progress.ts
 import chalk2 from "chalk";
 import { MultiProgressBars } from "multi-progress-bars";
@@ -1135,8 +1084,82 @@ function getProgressBar(taskName) {
   };
 }
 
-// packages/utils/src/lib/report-to-md.ts
-function reportToMd(report, commitData) {
+// 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/md/headline.ts
+function headline(text, hierarchy = 1) {
+  return `${new Array(hierarchy).fill("#").join("")} ${text}`;
+}
+function h2(text) {
+  return headline(text, 2);
+}
+function h3(text) {
+  return headline(text, 3);
+}
+
+// packages/utils/src/lib/reports/md/link.ts
+function link(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");
+  }
+  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);
+}
+function tableHtml(data) {
+  if (data.length === 0) {
+    throw new Error("Data can't be empty");
+  }
+  const _data = data.map((arr, index) => {
+    if (index === 0) {
+      return "<tr>" + arr.map((s) => `<th>${s}</th>`).join("") + "</tr>";
+    }
+    return "<tr>" + arr.map((s) => `<td>${s}</td>`).join("") + "</tr>";
+  });
+  return "<table>" + _data.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;
@@ -1317,14 +1340,14 @@ function getAuditResult(audit, isHtml = false) {
   return isHtml ? `<b>${displayValue || value}</b>` : style(String(displayValue || value));
 }
 
-// packages/utils/src/lib/report-to-stdout.ts
+// packages/utils/src/lib/reports/generate-stdout-summary.ts
 import cliui from "@isaacs/cliui";
 import chalk3 from "chalk";
 import Table from "cli-table3";
 function addLine(line = "") {
   return line + NEW_LINE;
 }
-function reportToStdout(report) {
+function generateStdoutSummary(report) {
   let output = "";
   output += addLine(reportToHeaderSection2(report));
   output += addLine();
@@ -1481,7 +1504,7 @@ function toUnixPath(path, options) {
   return unixPath;
 }
 
-// packages/utils/src/lib/scoring.ts
+// packages/utils/src/lib/reports/scoring.ts
 function calculateScore(refs, scoreFn) {
   const { numerator, denominator } = refs.reduce(
     (acc, ref) => {
@@ -1549,27 +1572,7 @@ function scoreReport(report) {
   return scoredReport;
 }
 
-// packages/utils/src/lib/verbose-utils.ts
-function getLogVerbose(verbose) {
-  return (...args) => {
-    if (verbose) {
-      console.info(...args);
-    }
-  };
-}
-function getExecVerbose(verbose) {
-  return (fn) => {
-    if (verbose) {
-      fn();
-    }
-  };
-}
-var verboseUtils = (verbose) => ({
-  log: getLogVerbose(verbose),
-  exec: getExecVerbose(verbose)
-});
-
-// packages/utils/src/lib/sort-report.ts
+// packages/utils/src/lib/reports/sorting.ts
 function sortReport(report) {
   const { categories, plugins } = report;
   const sortedCategories = categories.map((category) => {
@@ -1618,10 +1621,29 @@ function sortReport(report) {
     plugins: sortedPlugins
   };
 }
+
+// packages/utils/src/lib/verbose-utils.ts
+function getLogVerbose(verbose) {
+  return (...args) => {
+    if (verbose) {
+      console.info(...args);
+    }
+  };
+}
+function getExecVerbose(verbose) {
+  return (fn) => {
+    if (verbose) {
+      fn();
+    }
+  };
+}
+var verboseUtils = (verbose) => ({
+  log: getLogVerbose(verbose),
+  exec: getExecVerbose(verbose)
+});
 export {
   CODE_PUSHUP_DOMAIN,
   FOOTER_PREFIX,
-  NEW_LINE,
   ProcessError,
   README_LINK,
   calcDuration,
@@ -1636,6 +1658,8 @@ export {
   findLineNumberInText,
   formatBytes,
   formatDuration,
+  generateMdReport,
+  generateStdoutSummary,
   getLatestCommit,
   getProgressBar,
   git,
@@ -1654,8 +1678,6 @@ export {
   pluralizeToken,
   readJsonFile,
   readTextFile,
-  reportToMd,
-  reportToStdout,
   scoreReport,
   slugify,
   sortReport,

package/package.json

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

package/src/index.d.ts

@@ -5,12 +5,11 @@ export { getLatestCommit, git } from './lib/git';
 export { groupByStatus } from './lib/group-by-status';
 export { isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards';
 export { logMultipleResults } from './lib/log-results';
-export { NEW_LINE } from './lib/md';
 export { ProgressBar, getProgressBar } from './lib/progress';
-export { CODE_PUSHUP_DOMAIN, FOOTER_PREFIX, README_LINK, calcDuration, compareIssueSeverity, loadReport, } from './lib/report';
-export { reportToMd } from './lib/report-to-md';
-export { reportToStdout } from './lib/report-to-stdout';
-export { ScoredReport, scoreReport } from './lib/scoring';
+export { generateMdReport } from './lib/reports/generate-md-report';
+export { generateStdoutSummary } from './lib/reports/generate-stdout-summary';
+export { ScoredReport, scoreReport } from './lib/reports/scoring';
+export { sortReport } from './lib/reports/sorting';
+export { CODE_PUSHUP_DOMAIN, FOOTER_PREFIX, README_LINK, calcDuration, compareIssueSeverity, loadReport, } from './lib/reports/utils';
 export { CliArgsObject, countOccurrences, distinct, factorOf, objectToCliArgs, objectToEntries, objectToKeys, toArray, toUnixPath, } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';
-export { sortReport } from './lib/sort-report';

package/src/lib/{constants.d.ts → reports/constants.d.ts}

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

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

@@ -0,0 +1,3 @@
+import { CommitData } from '../git';
+import { ScoredReport } from './scoring';
+export declare function generateMdReport(report: ScoredReport, commitData: CommitData | null): string;

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

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

package/src/lib/{md → reports/md}/index.d.ts

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

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

@@ -1 +0,0 @@
-export declare const NEW_LINE = "\n";

package/src/lib/report-to-md.d.ts

@@ -1,3 +0,0 @@
-import { CommitData } from './git';
-import { ScoredReport } from './scoring';
-export declare function reportToMd(report: ScoredReport, commitData: CommitData | null): string;

package/src/lib/report-to-stdout.d.ts

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