@code-pushup/utils 0.12.10 → 0.13.0

package/index.js

@@ -1,9 +1,3 @@
-// packages/utils/src/lib/execute-process.ts
-import { spawn } from "node:child_process";
-
-// packages/utils/src/lib/reports/utils.ts
-import { join as join2 } from "node:path";
-
 // packages/models/src/lib/audit.ts
 import { z as z2 } from "zod";
 
@@ -550,6 +544,12 @@ var reportSchema = packageVersionSchema({
   })
 );
 
+// packages/utils/src/lib/execute-process.ts
+import { spawn } from "node:child_process";
+
+// packages/utils/src/lib/reports/utils.ts
+import { join as join2 } from "node:path";
+
 // packages/utils/src/lib/file-system.ts
 import { bundleRequire } from "bundle-require";
 import chalk from "chalk";
@@ -1410,6 +1410,7 @@ function withColor({ score, text }) {
 }
 
 // packages/utils/src/lib/transform.ts
+import { platform } from "node:os";
 function toArray(val) {
   return Array.isArray(val) ? val : [val];
 }
@@ -1473,6 +1474,33 @@ function toUnixPath(path, options) {
   }
   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
 function scoreReport(report) {
@@ -1635,6 +1663,7 @@ export {
   README_LINK,
   TERMINAL_WIDTH,
   calcDuration,
+  capitalize,
   compareIssueSeverity,
   countOccurrences,
   crawlFileSystem,
@@ -1642,6 +1671,7 @@ export {
   distinct,
   ensureDirectoryExists,
   executeProcess,
+  exists,
   factorOf,
   fileExists,
   findLineNumberInText,
@@ -1671,6 +1701,9 @@ export {
   slugify,
   sortReport,
   toArray,
+  toNumberPrecision,
+  toOrdinal,
+  toUnixNewlines,
   toUnixPath,
   truncateDescription,
   truncateIssueMessage,

package/package.json

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

package/src/index.d.ts

@@ -1,3 +1,4 @@
+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, } from './lib/file-system';
 export { formatBytes, formatDuration, pluralize, pluralizeToken, slugify, truncateDescription, truncateIssueMessage, truncateText, truncateTitle, } from './lib/formatting';
@@ -6,11 +7,11 @@ export { groupByStatus } from './lib/group-by-status';
 export { isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards';
 export { logMultipleResults } from './lib/log-results';
 export { ProgressBar, getProgressBar } from './lib/progress';
+export { TERMINAL_WIDTH } from './lib/reports/constants';
 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 { TERMINAL_WIDTH } from './lib/reports/constants';
-export { CliArgsObject, countOccurrences, distinct, factorOf, objectToCliArgs, objectToEntries, objectToKeys, toArray, toUnixPath, } from './lib/transform';
+export { CliArgsObject, capitalize, countOccurrences, distinct, factorOf, objectToCliArgs, objectToEntries, objectToKeys, toArray, toNumberPrecision, toOrdinal, toUnixNewlines, toUnixPath, } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';

package/src/lib/transform.d.ts

@@ -2,6 +2,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 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[];
 export declare function deepClone<T>(obj: T): T;
 export declare function factorOf<T>(items: T[], filterFn: (i: T) => boolean): number;
@@ -24,4 +25,8 @@ export declare function objectToCliArgs<T extends object = Record<string, Argume
 export declare function toUnixPath(path: string, options?: {
     toRelative?: boolean;
 }): 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;
+export declare function toOrdinal(value: number): string;
 export {};