@code-pushup/utils 0.29.0 → 0.34.0

package/index.js

@@ -1288,7 +1288,7 @@ var ProcessError = class extends Error {
   }
 };
 function executeProcess(cfg) {
-  const { observer, cwd, command, args, alwaysResolve = false } = cfg;
+  const { observer, cwd, command, args, ignoreExitCode = false } = cfg;
   const { onStdout, onError, onComplete } = observer ?? {};
   const date = (/* @__PURE__ */ new Date()).toISOString();
   const start = performance.now();
@@ -1308,7 +1308,7 @@ function executeProcess(cfg) {
     });
     process2.on("close", (code) => {
       const timings = { date, duration: calcDuration(start) };
-      if (code === 0 || alwaysResolve) {
+      if (code === 0 || ignoreExitCode) {
         onComplete?.();
         resolve({ code, stdout, stderr, ...timings });
       } else {
@@ -1343,6 +1343,9 @@ function objectToKeys(obj) {
 function objectToEntries(obj) {
   return Object.entries(obj);
 }
+function objectFromEntries(entries) {
+  return Object.fromEntries(entries);
+}
 function countOccurrences(values) {
   return values.reduce(
     (acc, value) => ({ ...acc, [value]: (acc[value] ?? 0) + 1 }),
@@ -1396,11 +1399,23 @@ function toUnixPath(path) {
 function toUnixNewlines(text) {
   return platform() === "win32" ? text.replace(/\r\n/g, "\n") : text;
 }
+function fromJsonLines(jsonLines) {
+  const unifiedNewLines = toUnixNewlines(jsonLines).trim();
+  return JSON.parse(`[${unifiedNewLines.split("\n").join(",")}]`);
+}
+function toJsonLines(json) {
+  return json.map((item) => JSON.stringify(item)).join("\n");
+}
 function capitalize(text) {
   return `${text.charAt(0).toLocaleUpperCase()}${text.slice(
     1
   )}`;
 }
+function apostrophize(text, upperCase) {
+  const lastCharMatch = text.match(/(\w)\W*$/);
+  const lastChar = lastCharMatch?.[1] ?? "";
+  return `${text}'${lastChar.toLocaleLowerCase() === "s" ? "" : upperCase ? "S" : "s"}`;
+}
 function toNumberPrecision(value, decimalPlaces) {
   return Number(
     `${Math.round(
@@ -2206,6 +2221,7 @@ export {
   ProcessError,
   README_LINK,
   TERMINAL_WIDTH,
+  apostrophize,
   calcDuration,
   capitalize,
   compareIssueSeverity,
@@ -2224,6 +2240,7 @@ export {
   formatBytes,
   formatDuration,
   formatGitPath,
+  fromJsonLines,
   generateMdReport,
   generateMdReportsDiff,
   getCurrentBranchOrTag,
@@ -2242,6 +2259,7 @@ export {
   logMultipleResults,
   logStdoutSummary,
   matchArrayItemsByKey,
+  objectFromEntries,
   objectToCliArgs,
   objectToEntries,
   objectToKeys,
@@ -2257,6 +2275,7 @@ export {
   sortReport,
   toArray,
   toGitPath,
+  toJsonLines,
   toNumberPrecision,
   toOrdinal,
   toUnixNewlines,

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.29.0",
+  "version": "0.34.0",
   "dependencies": {
-    "@code-pushup/models": "*",
+    "@code-pushup/models": "0.34.0",
     "bundle-require": "^4.0.1",
     "chalk": "^5.3.0",
     "@isaacs/cliui": "^8.0.2",

package/src/index.d.ts

@@ -19,5 +19,5 @@ export { scoreReport } from './lib/reports/scoring';
 export { sortReport } from './lib/reports/sorting';
 export { ScoredCategoryConfig, ScoredGroup, ScoredReport, } from './lib/reports/types';
 export { calcDuration, compareIssueSeverity, loadReport, } from './lib/reports/utils';
-export { CliArgsObject, capitalize, countOccurrences, distinct, factorOf, objectToCliArgs, objectToEntries, objectToKeys, toArray, toNumberPrecision, toOrdinal, toUnixNewlines, toUnixPath, } from './lib/transform';
+export { CliArgsObject, apostrophize, capitalize, countOccurrences, distinct, factorOf, fromJsonLines, objectFromEntries, objectToCliArgs, objectToEntries, objectToKeys, toArray, toJsonLines, toNumberPrecision, toOrdinal, toUnixNewlines, toUnixPath, } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';

package/src/lib/execute-process.d.ts

@@ -71,7 +71,7 @@ export type ProcessConfig = {
     args?: string[];
     cwd?: string;
     observer?: ProcessObserver;
-    alwaysResolve?: boolean;
+    ignoreExitCode?: boolean;
 };
 /**
  * Process observer object. Contains the onStdout, error and complete function.

package/src/lib/file-system.d.ts

@@ -11,7 +11,7 @@ export declare function logMultipleFileResults(fileResults: MultipleFileResults,
 export declare class NoExportError extends Error {
     constructor(filepath: string);
 }
-export declare function importEsmModule(options: Options): Promise<unknown>;
+export declare function importEsmModule<T = unknown>(options: Options): Promise<T>;
 export declare function pluginWorkDir(slug: string): string;
 export type CrawlFileSystemOptions<T> = {
     directory: string;

package/src/lib/transform.d.ts

@@ -1,6 +1,7 @@
 export declare function toArray<T>(val: T | T[]): T[];
 export declare function objectToKeys<T extends object>(obj: T): (keyof T)[];
 export declare function objectToEntries<T extends object>(obj: T): [keyof T, T[keyof T]][];
+export declare function objectFromEntries<K extends PropertyKey, V>(entries: [K, V][]): Record<K, V>;
 export declare function countOccurrences<T extends PropertyKey>(values: T[]): Partial<Record<T, number>>;
 export declare function exists<T>(value: T): value is NonNullable<T>;
 export declare function distinct<T extends string | number | boolean>(array: T[]): T[];
@@ -24,7 +25,10 @@ Record<string, ArgumentValue | undefined> | {
 export declare function objectToCliArgs<T extends object = Record<string, ArgumentValue>>(params?: CliArgsObject<T>): string[];
 export declare function toUnixPath(path: string): string;
 export declare function toUnixNewlines(text: string): string;
+export declare function fromJsonLines<T = unknown>(jsonLines: string): T;
+export declare function toJsonLines<T>(json: T[]): string;
 export declare function capitalize<T extends string>(text: T): Capitalize<T>;
+export declare function apostrophize(text: string, upperCase?: boolean): string;
 export declare function toNumberPrecision(value: number, decimalPlaces: number): number;
 export declare function toOrdinal(value: number): string;
 export {};