@code-pushup/utils 0.18.0 → 0.19.0

package/index.js

@@ -1017,16 +1017,140 @@ function executeProcess(cfg) {
   });
 }
 
+// packages/utils/src/lib/transform.ts
+import { platform } from "node:os";
+function toArray(val) {
+  return Array.isArray(val) ? val : [val];
+}
+function objectToKeys(obj) {
+  return Object.keys(obj);
+}
+function objectToEntries(obj) {
+  return Object.entries(obj);
+}
+function countOccurrences(values) {
+  return values.reduce(
+    (acc, value) => ({ ...acc, [value]: (acc[value] ?? 0) + 1 }),
+    {}
+  );
+}
+function distinct(array) {
+  return [...new Set(array)];
+}
+function deepClone(obj) {
+  return obj == null || typeof obj !== "object" ? obj : structuredClone(obj);
+}
+function factorOf(items, filterFn) {
+  const itemCount = items.length;
+  if (!itemCount) {
+    return 1;
+  }
+  const filterCount = items.filter(filterFn).length;
+  return filterCount === 0 ? 1 : (itemCount - filterCount) / itemCount;
+}
+function objectToCliArgs(params) {
+  if (!params) {
+    return [];
+  }
+  return Object.entries(params).flatMap(([key, value]) => {
+    if (key === "_") {
+      return Array.isArray(value) ? value : [`${value}`];
+    }
+    const prefix = key.length === 1 ? "-" : "--";
+    if (Array.isArray(value)) {
+      return value.map((v) => `${prefix}${key}="${v}"`);
+    }
+    if (Array.isArray(value)) {
+      return value.map((v) => `${prefix}${key}="${v}"`);
+    }
+    if (typeof value === "string") {
+      return [`${prefix}${key}="${value}"`];
+    }
+    if (typeof value === "number") {
+      return [`${prefix}${key}=${value}`];
+    }
+    if (typeof value === "boolean") {
+      return [`${prefix}${value ? "" : "no-"}${key}`];
+    }
+    throw new Error(`Unsupported type ${typeof value} for key ${key}`);
+  });
+}
+function toUnixPath(path) {
+  return path.replace(/\\/g, "/");
+}
+function toUnixNewlines(text) {
+  return platform() === "win32" ? text.replace(/\r\n/g, "\n") : text;
+}
+function capitalize(text) {
+  return `${text.charAt(0).toLocaleUpperCase()}${text.slice(
+    1
+  )}`;
+}
+function toNumberPrecision(value, decimalPlaces) {
+  return Number(
+    `${Math.round(
+      Number.parseFloat(`${value}e${decimalPlaces}`)
+    )}e-${decimalPlaces}`
+  );
+}
+function toOrdinal(value) {
+  if (value % 10 === 1 && value % 100 !== 11) {
+    return `${value}st`;
+  }
+  if (value % 10 === 2 && value % 100 !== 12) {
+    return `${value}nd`;
+  }
+  if (value % 10 === 3 && value % 100 !== 13) {
+    return `${value}rd`;
+  }
+  return `${value}th`;
+}
+
+// packages/utils/src/lib/filter-by-slug.ts
+function filterGroupsByAuditSlug(groups, auditSlugs) {
+  const slugs = toArray(auditSlugs);
+  if (slugs.length === 0) {
+    return groups;
+  }
+  return groups.map((group) => ({
+    ...group,
+    refs: filterSlug(group.refs, slugs)
+  })).filter((group) => group.refs.length);
+}
+function filterAuditsBySlug(list, auditSlugs) {
+  const slugs = toArray(auditSlugs);
+  if (slugs.length === 0) {
+    return list;
+  }
+  return filterSlug(list, slugs);
+}
+function filterSlug(refs, slugOrSlugs) {
+  const slugs = toArray(slugOrSlugs);
+  return refs.filter(({ slug }) => slugs.includes(slug));
+}
+
 // packages/utils/src/lib/git.ts
+import { isAbsolute, join as join3, relative } from "node:path";
 import { simpleGit } from "simple-git";
-var git = simpleGit();
-async function getLatestCommit() {
+async function getLatestCommit(git = simpleGit()) {
   const log = await git.log({
     maxCount: 1,
     format: { hash: "%H", message: "%s", author: "%an", date: "%ad" }
   });
   return log.latest;
 }
+function getGitRoot(git = simpleGit()) {
+  return git.revparse("--show-toplevel");
+}
+function formatGitPath(path, gitRoot) {
+  const absolutePath = isAbsolute(path) ? path : join3(process.cwd(), path);
+  const relativePath = relative(gitRoot, absolutePath);
+  return toUnixPath(relativePath);
+}
+async function toGitPath(path, git = simpleGit()) {
+  const gitRoot = await getGitRoot(git);
+  return formatGitPath(path, gitRoot);
+}
 function validateCommitData(commitData, options = {}) {
   const { throwError = false } = options;
   if (!commitData) {
@@ -1049,18 +1173,24 @@ function groupByStatus(results) {
   );
 }
 
-// packages/utils/src/lib/progress.ts
+// packages/utils/src/lib/logging.ts
 import chalk2 from "chalk";
+function link(text) {
+  return chalk2.underline(chalk2.blueBright(text));
+}
+
+// packages/utils/src/lib/progress.ts
+import chalk3 from "chalk";
 import { MultiProgressBars } from "multi-progress-bars";
 var barStyles = {
-  active: (s) => chalk2.green(s),
-  done: (s) => chalk2.gray(s),
-  idle: (s) => chalk2.gray(s)
+  active: (s) => chalk3.green(s),
+  done: (s) => chalk3.gray(s),
+  idle: (s) => chalk3.gray(s)
 };
 var messageStyles = {
-  active: (s) => chalk2.black(s),
-  done: (s) => chalk2.green(chalk2.bold(s)),
-  idle: (s) => chalk2.gray(s)
+  active: (s) => chalk3.black(s),
+  done: (s) => chalk3.green(chalk3.bold(s)),
+  idle: (s) => chalk3.gray(s)
 };
 var mpb;
 function getSingletonProgressBars(options) {
@@ -1140,7 +1270,7 @@ function h3(text) {
 }
 
 // packages/utils/src/lib/reports/md/link.ts
-function link(href, text) {
+function link2(href, text) {
   return `[${text || href}](${href})`;
 }
 
@@ -1191,7 +1321,7 @@ function generateMdReport(report, commitData) {
     (printCategories ? 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")}`
+    `${FOOTER_PREFIX} ${link2(README_LINK, "Code PushUp")}`
   );
 }
 function reportToHeaderSection() {
@@ -1202,7 +1332,7 @@ function reportToOverviewSection(report) {
   const tableContent = [
     reportOverviewTableHeaders,
     ...categories.map(({ title, refs, score }) => [
-      link(`#${slugify(title)}`, title),
+      link2(`#${slugify(title)}`, title),
       `${getRoundScoreMarker(score)} ${style(formatReportScore(score))}`,
       countCategoryAudits(refs, plugins).toString()
     ])
@@ -1234,7 +1364,7 @@ function reportToCategoriesSection(report) {
 }
 function auditItemToCategorySection(audit, plugins) {
   const pluginTitle = getPluginNameFromSlug(audit.plugin, plugins);
-  const auditTitle = link(
+  const auditTitle = link2(
     `#${slugify(audit.title)}-${slugify(pluginTitle)}`,
     audit.title
   );
@@ -1251,7 +1381,7 @@ function groupItemToCategorySection(group, plugins) {
     `${getRoundScoreMarker(groupScore)} ${group.title} (_${pluginTitle}_)`
   );
   const groupAudits = group.audits.reduce((acc, audit) => {
-    const auditTitle = link(
+    const auditTitle = link2(
       `#${slugify(audit.title)}-${slugify(pluginTitle)}`,
       audit.title
     );
@@ -1338,7 +1468,7 @@ function getDocsAndDescription({
   description
 }) {
   if (docsUrl) {
-    const docsLink = link(docsUrl, "\u{1F4D6} Docs");
+    const docsLink = link2(docsUrl, "\u{1F4D6} Docs");
     if (!description) {
       return docsLink + NEW_LINE + NEW_LINE;
     }
@@ -1359,7 +1489,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 chalk4 from "chalk";
 import CliTable3 from "cli-table3";
 function addLine(line = "") {
   return line + NEW_LINE;
@@ -1370,7 +1500,7 @@ function generateStdoutSummary(report) {
 }
 function reportToHeaderSection2(report) {
   const { packageName, version } = report;
-  return `${chalk3.bold(reportHeadlineText)} - ${packageName}@${version}`;
+  return `${chalk4.bold(reportHeadlineText)} - ${packageName}@${version}`;
 }
 function reportToDetailSection(report) {
   const { plugins } = report;
@@ -1390,13 +1520,13 @@ function reportToDetailSection(report) {
           padding: [0, 3, 0, 0]
         },
         {
-          text: chalk3.cyanBright(audit.displayValue || `${audit.value}`),
+          text: chalk4.cyanBright(audit.displayValue || `${audit.value}`),
           width: 10,
           padding: [0, 0, 0, 0]
         }
       );
     });
-    return acc + addLine() + addLine(chalk3.magentaBright.bold(`${title} audits`)) + addLine() + addLine(ui.toString()) + addLine();
+    return acc + addLine() + addLine(chalk4.magentaBright.bold(`${title} audits`)) + addLine() + addLine(ui.toString()) + addLine();
   }, "");
 }
 function reportToOverviewSection2({
@@ -1419,11 +1549,11 @@ function reportToOverviewSection2({
       countCategoryAudits(refs, plugins)
     ])
   );
-  return addLine(chalk3.magentaBright.bold("Categories")) + addLine() + addLine(table.toString());
+  return addLine(chalk4.magentaBright.bold("Categories")) + addLine() + addLine(table.toString());
 }
 function withColor({ score, text }) {
   const formattedScore = text ?? formatReportScore(score);
-  const style2 = text ? chalk3 : chalk3.bold;
+  const style2 = text ? chalk4 : chalk4.bold;
   if (score >= SCORE_COLOR_RANGE.GREEN_MIN) {
     return style2.green(formattedScore);
   }
@@ -1433,99 +1563,6 @@ function withColor({ score, text }) {
   return style2.red(formattedScore);
 }
 
-// packages/utils/src/lib/transform.ts
-import { platform } from "node:os";
-function toArray(val) {
-  return Array.isArray(val) ? val : [val];
-}
-function objectToKeys(obj) {
-  return Object.keys(obj);
-}
-function objectToEntries(obj) {
-  return Object.entries(obj);
-}
-function countOccurrences(values) {
-  return values.reduce(
-    (acc, value) => ({ ...acc, [value]: (acc[value] ?? 0) + 1 }),
-    {}
-  );
-}
-function distinct(array) {
-  return [...new Set(array)];
-}
-function deepClone(obj) {
-  return obj == null || typeof obj !== "object" ? obj : structuredClone(obj);
-}
-function factorOf(items, filterFn) {
-  const itemCount = items.length;
-  if (!itemCount) {
-    return 1;
-  }
-  const filterCount = items.filter(filterFn).length;
-  return filterCount === 0 ? 1 : (itemCount - filterCount) / itemCount;
-}
-function objectToCliArgs(params) {
-  if (!params) {
-    return [];
-  }
-  return Object.entries(params).flatMap(([key, value]) => {
-    if (key === "_") {
-      return Array.isArray(value) ? value : [`${value}`];
-    }
-    const prefix = key.length === 1 ? "-" : "--";
-    if (Array.isArray(value)) {
-      return value.map((v) => `${prefix}${key}="${v}"`);
-    }
-    if (Array.isArray(value)) {
-      return value.map((v) => `${prefix}${key}="${v}"`);
-    }
-    if (typeof value === "string") {
-      return [`${prefix}${key}="${value}"`];
-    }
-    if (typeof value === "number") {
-      return [`${prefix}${key}=${value}`];
-    }
-    if (typeof value === "boolean") {
-      return [`${prefix}${value ? "" : "no-"}${key}`];
-    }
-    throw new Error(`Unsupported type ${typeof value} for key ${key}`);
-  });
-}
-function toUnixPath(path, options) {
-  const unixPath = path.replace(/\\/g, "/");
-  if (options?.toRelative) {
-    return unixPath.replace(`${process.cwd().replace(/\\/g, "/")}/`, "");
-  }
-  return unixPath;
-}
-function toUnixNewlines(text) {
-  return platform() === "win32" ? text.replace(/\r\n/g, "\n") : text;
-}
-function capitalize(text) {
-  return `${text.charAt(0).toLocaleUpperCase()}${text.slice(
-    1
-  )}`;
-}
-function toNumberPrecision(value, decimalPlaces) {
-  return Number(
-    `${Math.round(
-      Number.parseFloat(`${value}e${decimalPlaces}`)
-    )}e-${decimalPlaces}`
-  );
-}
-function toOrdinal(value) {
-  if (value % 10 === 1 && value % 100 !== 11) {
-    return `${value}st`;
-  }
-  if (value % 10 === 2 && value % 100 !== 12) {
-    return `${value}nd`;
-  }
-  if (value % 10 === 3 && value % 100 !== 13) {
-    return `${value}rd`;
-  }
-  return `${value}th`;
-}
-
 // packages/utils/src/lib/reports/scoring.ts
 var GroupRefInvalidError = class extends Error {
   constructor(auditSlug, pluginSlug) {
@@ -1685,35 +1722,6 @@ var verboseUtils = (verbose = false) => ({
   log: getLogVerbose(verbose),
   exec: getExecVerbose(verbose)
 });
-
-// packages/utils/src/lib/logging.ts
-import chalk4 from "chalk";
-function link2(text) {
-  return chalk4.underline(chalk4.blueBright(text));
-}
-
-// packages/utils/src/lib/filter-by-slug.ts
-function filterGroupsByAuditSlug(groups, auditSlugs) {
-  const slugs = toArray(auditSlugs);
-  if (slugs.length === 0) {
-    return groups;
-  }
-  return groups.map((group) => ({
-    ...group,
-    refs: filterSlug(group.refs, slugs)
-  })).filter((group) => group.refs.length);
-}
-function filterAuditsBySlug(list, auditSlugs) {
-  const slugs = toArray(auditSlugs);
-  if (slugs.length === 0) {
-    return list;
-  }
-  return filterSlug(list, slugs);
-}
-function filterSlug(refs, slugOrSlugs) {
-  const slugs = toArray(slugOrSlugs);
-  return refs.filter(({ slug }) => slugs.includes(slug));
-}
 export {
   CODE_PUSHUP_DOMAIN,
   FOOTER_PREFIX,
@@ -1737,16 +1745,17 @@ export {
   findLineNumberInText,
   formatBytes,
   formatDuration,
+  formatGitPath,
   generateMdReport,
   generateStdoutSummary,
+  getGitRoot,
   getLatestCommit,
   getProgressBar,
-  git,
   groupByStatus,
   importEsmModule,
   isPromiseFulfilledResult,
   isPromiseRejectedResult,
-  link2 as link,
+  link,
   loadReport,
   logMultipleFileResults,
   logMultipleResults,
@@ -1764,6 +1773,7 @@ export {
   slugify,
   sortReport,
   toArray,
+  toGitPath,
   toNumberPrecision,
   toOrdinal,
   toUnixNewlines,

package/package.json

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

package/src/index.d.ts

@@ -1,11 +1,13 @@
 export { exists } from '@code-pushup/models';
 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 { filterAuditsBySlug, filterGroupsByAuditSlug, } from './lib/filter-by-slug';
 export { formatBytes, formatDuration, pluralize, pluralizeToken, slugify, truncateDescription, truncateIssueMessage, truncateText, truncateTitle, } from './lib/formatting';
-export { getLatestCommit, git, validateCommitData } from './lib/git';
+export { formatGitPath, getGitRoot, getLatestCommit, toGitPath, validateCommitData, } from './lib/git';
 export { groupByStatus } from './lib/group-by-status';
 export { isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards';
 export { logMultipleResults } from './lib/log-results';
+export { link } from './lib/logging';
 export { ProgressBar, getProgressBar } from './lib/progress';
 export { TERMINAL_WIDTH } from './lib/reports/constants';
 export { generateMdReport } from './lib/reports/generate-md-report';
@@ -15,5 +17,3 @@ export { sortReport } from './lib/reports/sorting';
 export { CODE_PUSHUP_DOMAIN, FOOTER_PREFIX, README_LINK, calcDuration, compareIssueSeverity, loadReport, portalCommitDashboardLink, } 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 } from './lib/logging';
-export { filterAuditsBySlug, filterGroupsByAuditSlug, } from './lib/filter-by-slug';

package/src/lib/git.d.ts

@@ -4,13 +4,15 @@ export type CommitData = {
     author: string;
     date: string;
 };
-export declare const git: import("simple-git").SimpleGit;
-export declare function getLatestCommit(): Promise<({
+export declare function getLatestCommit(git?: import("simple-git").SimpleGit): Promise<({
     hash: string;
     message: string;
     author: string;
     date: string;
 } & import("simple-git").ListLogLine) | null>;
-export declare function validateCommitData(commitData?: unknown, options?: {
+export declare function getGitRoot(git?: import("simple-git").SimpleGit): Promise<string>;
+export declare function formatGitPath(path: string, gitRoot: string): string;
+export declare function toGitPath(path: string, git?: import("simple-git").SimpleGit): Promise<string>;
+export declare function validateCommitData(commitData: CommitData | null, options?: {
     throwError?: boolean;
 }): commitData is CommitData;

package/src/lib/transform.d.ts

@@ -22,9 +22,7 @@ Record<string, ArgumentValue | undefined> | {
  * });
  */
 export declare function objectToCliArgs<T extends object = Record<string, ArgumentValue>>(params?: CliArgsObject<T>): string[];
-export declare function toUnixPath(path: string, options?: {
-    toRelative?: boolean;
-}): string;
+export declare function toUnixPath(path: string): string;
 export declare function toUnixNewlines(text: string): string;
 export declare function capitalize<T extends string>(text: T): Capitalize<T>;
 export declare function toNumberPrecision(value: number, decimalPlaces: number): number;