@code-pushup/utils 0.6.3 → 0.6.5

package/index.js

@@ -537,6 +537,12 @@ 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";
@@ -761,19 +767,19 @@ function formatReportScore(score) {
   return Math.round(score * 100).toString();
 }
 function getRoundScoreMarker(score) {
-  if (score >= 0.9) {
+  if (score >= SCORE_COLOR_RANGE.GREEN_MIN) {
     return "\u{1F7E2}";
   }
-  if (score >= 0.5) {
+  if (score >= SCORE_COLOR_RANGE.YELLOW_MIN) {
     return "\u{1F7E1}";
   }
   return "\u{1F534}";
 }
 function getSquaredScoreMarker(score) {
-  if (score >= 0.9) {
+  if (score >= SCORE_COLOR_RANGE.GREEN_MIN) {
     return "\u{1F7E9}";
   }
-  if (score >= 0.5) {
+  if (score >= SCORE_COLOR_RANGE.YELLOW_MIN) {
     return "\u{1F7E8}";
   }
   return "\u{1F7E5}";
@@ -978,38 +984,6 @@ function executeProcess(cfg) {
     });
   });
 }
-function objectToCliArgs(params) {
-  if (!params) {
-    return [];
-  }
-  return Object.entries(params).flatMap(([key, value]) => {
-    if (key === "_") {
-      if (Array.isArray(value)) {
-        return value;
-      } else {
-        return [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}`);
-  });
-}
-objectToCliArgs({ z: 5 });
 
 // packages/utils/src/lib/git.ts
 import simpleGit from "simple-git";
@@ -1415,19 +1389,18 @@ function reportToDetailSection(report) {
   return output;
 }
 function withColor({ score, text }) {
-  let str = text ?? formatReportScore(score);
+  const formattedScore = text ?? formatReportScore(score);
   const style2 = text ? chalk3 : chalk3.bold;
-  if (score < 0.5) {
-    str = style2.red(str);
-  } else if (score < 0.9) {
-    str = style2.yellow(str);
-  } else {
-    str = style2.green(str);
+  if (score >= SCORE_COLOR_RANGE.GREEN_MIN) {
+    return style2.green(formattedScore);
   }
-  return str;
+  if (score >= SCORE_COLOR_RANGE.YELLOW_MIN) {
+    return style2.yellow(formattedScore);
+  }
+  return style2.red(formattedScore);
 }
 
-// packages/utils/src/lib/transformation.ts
+// packages/utils/src/lib/transform.ts
 function toArray(val) {
   return Array.isArray(val) ? val : [val];
 }
@@ -1466,6 +1439,37 @@ function factorOf(items, filterFn) {
   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 === "_") {
+      if (Array.isArray(value)) {
+        return value;
+      } else {
+        return [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}`);
+  });
+}
 
 // packages/utils/src/lib/scoring.ts
 function calculateScore(refs, scoreFn) {

package/package.json

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

package/src/index.d.ts

@@ -1,5 +1,5 @@
-export { CliArgsObject, ProcessConfig, ProcessError, ProcessObserver, ProcessResult, executeProcess, objectToCliArgs, } from './lib/execute-process';
-export { FileResult, MultipleFileResults, CrawlFileSystemOptions, crawlFileSystem, ensureDirectoryExists, fileExists, findLineNumberInText, importEsmModule, logMultipleFileResults, pluginWorkDir, readJsonFile, readTextFile, toUnixPath, } from './lib/file-system';
+export { ProcessConfig, ProcessError, ProcessObserver, ProcessResult, executeProcess, } from './lib/execute-process';
+export { CrawlFileSystemOptions, FileResult, MultipleFileResults, crawlFileSystem, ensureDirectoryExists, fileExists, findLineNumberInText, importEsmModule, logMultipleFileResults, pluginWorkDir, readJsonFile, readTextFile, toUnixPath, } from './lib/file-system';
 export { formatBytes, formatDuration, pluralize, pluralizeToken, slugify, truncateDescription, truncateText, truncateTitle, } from './lib/formatting';
 export { getLatestCommit, git } from './lib/git';
 export { isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards';
@@ -10,5 +10,5 @@ export { CODE_PUSHUP_DOMAIN, FOOTER_PREFIX, README_LINK, calcDuration, compareIs
 export { reportToMd } from './lib/report-to-md';
 export { reportToStdout } from './lib/report-to-stdout';
 export { ScoredReport, scoreReport } from './lib/scoring';
-export { countOccurrences, distinct, factorOf, objectToEntries, objectToKeys, toArray, } from './lib/transformation';
+export { CliArgsObject, countOccurrences, distinct, factorOf, objectToCliArgs, objectToEntries, objectToKeys, toArray, } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';

package/src/lib/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const SCORE_COLOR_RANGE: {
+    GREEN_MIN: number;
+    YELLOW_MIN: number;
+};

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

@@ -119,19 +119,3 @@ export type ProcessObserver = {
  * @param cfg - see {@link ProcessConfig}
  */
 export declare function executeProcess(cfg: ProcessConfig): Promise<ProcessResult>;
-type ArgumentValue = number | string | boolean | string[];
-export type CliArgsObject<T extends object = Record<string, ArgumentValue>> = T extends never ? Record<string, ArgumentValue | undefined> | {
-    _: string;
-} : T;
-/**
- * Converts an object with different types of values into an array of command-line arguments.
- *
- * @example
- * const args = objectToProcessArgs({
- *   _: ['node', 'index.js'], // node index.js
- *   name: 'Juanita', // --name=Juanita
- *   formats: ['json', 'md'] // --format=json --format=md
- * });
- */
-export declare function objectToCliArgs<T extends object = Record<string, ArgumentValue>>(params?: CliArgsObject<T>): string[];
-export {};

package/src/lib/transform.d.ts

@@ -0,0 +1,23 @@
+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 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;
+type ArgumentValue = number | string | boolean | string[];
+export type CliArgsObject<T extends object = Record<string, ArgumentValue>> = T extends never ? Record<string, ArgumentValue | undefined> | {
+    _: string;
+} : T;
+/**
+ * Converts an object with different types of values into an array of command-line arguments.
+ *
+ * @example
+ * const args = objectToProcessArgs({
+ *   _: ['node', 'index.js'], // node index.js
+ *   name: 'Juanita', // --name=Juanita
+ *   formats: ['json', 'md'] // --format=json --format=md
+ * });
+ */
+export declare function objectToCliArgs<T extends object = Record<string, ArgumentValue>>(params?: CliArgsObject<T>): string[];
+export {};

package/src/lib/transformation.d.ts

@@ -1,7 +0,0 @@
-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 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;