@code-pushup/utils 0.1.0 → 0.2.0

package/index.js

@@ -548,7 +548,8 @@ function pluralize(text) {
   return `${text}s`;
 }
 function formatBytes(bytes, decimals = 2) {
-  if (!+bytes)
+  bytes = Math.max(bytes, 0);
+  if (!bytes)
     return "0 B";
   const k = 1024;
   const dm = decimals < 0 ? 0 : decimals;
@@ -605,6 +606,22 @@ function logPromiseResults(results, logMessage, callback) {
 }
 
 // packages/utils/src/lib/file-system.ts
+async function readTextFile(path) {
+  const buffer = await readFile(path);
+  return buffer.toString();
+}
+async function readJsonFile(path) {
+  const text = await readTextFile(path);
+  return JSON.parse(text);
+}
+async function fileExists(path) {
+  try {
+    const stats = await stat(path);
+    return stats.isFile();
+  } catch {
+    return false;
+  }
+}
 function toUnixPath(path, options) {
   const unixPath = path.replace(/\\/g, "/");
   if (options?.toRelative) {
@@ -623,14 +640,6 @@ async function ensureDirectoryExists(baseDir) {
     }
   }
 }
-async function readTextFile(path) {
-  const buffer = await readFile(path);
-  return buffer.toString();
-}
-async function readJsonFile(path) {
-  const text = await readTextFile(path);
-  return JSON.parse(text);
-}
 function logMultipleFileResults(fileResults, messagePrefix) {
   const succeededCallback = (result) => {
     const [fileName, size] = result.value;
@@ -967,60 +976,6 @@ async function getLatestCommit() {
   return log?.latest;
 }
 
-// packages/utils/src/lib/progress.ts
-import chalk2 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)
-};
-var messageStyles = {
-  active: (s) => chalk2.black(s),
-  done: (s) => chalk2.green(chalk2.bold(s)),
-  idle: (s) => chalk2.gray(s)
-};
-var mpb;
-function getSingletonProgressBars(options) {
-  if (!mpb) {
-    mpb = new MultiProgressBars({
-      initMessage: "",
-      border: true,
-      ...options
-    });
-  }
-  return mpb;
-}
-function getProgressBar(taskName) {
-  const tasks = getSingletonProgressBars();
-  tasks.addTask(taskName, {
-    type: "percentage",
-    percentage: 0,
-    message: "",
-    barTransformFn: barStyles.idle
-  });
-  return {
-    incrementInSteps: (numPlugins) => {
-      tasks.incrementTask(taskName, {
-        percentage: 1 / numPlugins,
-        barTransformFn: barStyles.active
-      });
-    },
-    updateTitle: (title) => {
-      tasks.updateTask(taskName, {
-        message: title,
-        barTransformFn: barStyles.active
-      });
-    },
-    endProgress: (message = "") => {
-      tasks.done(taskName, {
-        message: messageStyles.done(message),
-        barTransformFn: barStyles.done
-      });
-    }
-  };
-}
-
 // packages/utils/src/lib/md/details.ts
 function details(title, content, cfg = { open: false }) {
   return `<details${cfg.open ? " open" : ""}>
@@ -1098,6 +1053,60 @@ function li(text, order = "unordered") {
   return `${style2} ${text}`;
 }
 
+// packages/utils/src/lib/progress.ts
+import chalk2 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)
+};
+var messageStyles = {
+  active: (s) => chalk2.black(s),
+  done: (s) => chalk2.green(chalk2.bold(s)),
+  idle: (s) => chalk2.gray(s)
+};
+var mpb;
+function getSingletonProgressBars(options) {
+  if (!mpb) {
+    mpb = new MultiProgressBars({
+      initMessage: "",
+      border: true,
+      ...options
+    });
+  }
+  return mpb;
+}
+function getProgressBar(taskName) {
+  const tasks = getSingletonProgressBars();
+  tasks.addTask(taskName, {
+    type: "percentage",
+    percentage: 0,
+    message: "",
+    barTransformFn: barStyles.idle
+  });
+  return {
+    incrementInSteps: (numPlugins) => {
+      tasks.incrementTask(taskName, {
+        percentage: 1 / numPlugins,
+        barTransformFn: barStyles.active
+      });
+    },
+    updateTitle: (title) => {
+      tasks.updateTask(taskName, {
+        message: title,
+        barTransformFn: barStyles.active
+      });
+    },
+    endProgress: (message = "") => {
+      tasks.done(taskName, {
+        message: messageStyles.done(message),
+        barTransformFn: barStyles.done
+      });
+    }
+  };
+}
+
 // packages/utils/src/lib/report-to-md.ts
 function reportToMd(report, commitData) {
   let md = reportToHeaderSection() + NEW_LINE;
@@ -1403,6 +1412,14 @@ function deepClone(obj) {
   }
   return cloned;
 }
+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;
+}
 
 // packages/utils/src/lib/scoring.ts
 function calculateScore(refs, scoreFn) {
@@ -1499,6 +1516,8 @@ export {
   distinct,
   ensureDirectoryExists,
   executeProcess,
+  factorOf,
+  fileExists,
   findLineNumberInText,
   formatBytes,
   formatDuration,

package/package.json

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

package/src/index.d.ts

@@ -1,14 +1,14 @@
 export { CliArgsObject, ProcessConfig, ProcessError, ProcessObserver, ProcessResult, executeProcess, objectToCliArgs, } from './lib/execute-process';
+export { FileResult, MultipleFileResults, crawlFileSystem, ensureDirectoryExists, fileExists, findLineNumberInText, importEsmModule, logMultipleFileResults, pluginWorkDir, readJsonFile, readTextFile, toUnixPath, } from './lib/file-system';
+export { formatBytes, formatDuration, pluralize, pluralizeToken, slugify, } from './lib/formatting';
 export { getLatestCommit, git } from './lib/git';
+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 { readJsonFile, readTextFile, toUnixPath, ensureDirectoryExists, FileResult, MultipleFileResults, logMultipleFileResults, importEsmModule, pluginWorkDir, crawlFileSystem, findLineNumberInText, } from './lib/file-system';
+export { countOccurrences, distinct, factorOf, objectToEntries, objectToKeys, toArray, } from './lib/transformation';
 export { verboseUtils } from './lib/verbose-utils';
-export { toArray, objectToKeys, objectToEntries, countOccurrences, distinct, } from './lib/transformation';
-export { slugify, pluralize, pluralizeToken, formatBytes, formatDuration, } from './lib/formatting';
-export { NEW_LINE } from './lib/md';
-export { logMultipleResults } from './lib/log-results';
-export { isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards';

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

@@ -1,10 +1,11 @@
 import { type Options } from 'bundle-require';
+export declare function readTextFile(path: string): Promise<string>;
+export declare function readJsonFile<T = unknown>(path: string): Promise<T>;
+export declare function fileExists(path: string): Promise<boolean>;
 export declare function toUnixPath(path: string, options?: {
     toRelative?: boolean;
 }): string;
 export declare function ensureDirectoryExists(baseDir: string): Promise<void>;
-export declare function readTextFile(path: string): Promise<string>;
-export declare function readJsonFile<T = unknown>(path: string): Promise<T>;
 export type FileResult = readonly [string] | readonly [string, number];
 export type MultipleFileResults = PromiseSettledResult<FileResult>[];
 export declare function logMultipleFileResults(fileResults: MultipleFileResults, messagePrefix: string): void;