@code-pushup/utils 0.8.11 → 0.8.13

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
@@ -557,12 +557,6 @@ var reportSchema = packageVersionSchema({
   })
 );
 
-// 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";
@@ -746,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";
@@ -1029,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";
@@ -1160,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;
@@ -1342,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();
@@ -1506,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) => {
@@ -1574,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) => {
@@ -1643,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,
@@ -1661,6 +1658,8 @@ export {
   findLineNumberInText,
   formatBytes,
   formatDuration,
+  generateMdReport,
+  generateStdoutSummary,
   getLatestCommit,
   getProgressBar,
   git,
@@ -1679,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.11",
+  "version": "0.8.13",
   "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;