@code-pushup/utils 0.1.1 → 0.3.0

package/index.js

@@ -11,6 +11,11 @@ import { z as z2 } from "zod";
 import { z } from "zod";
 import { MATERIAL_ICONS } from "@code-pushup/portal-client";
 
+// packages/models/src/lib/implementation/limits.ts
+var MAX_SLUG_LENGTH = 128;
+var MAX_TITLE_LENGTH = 256;
+var MAX_DESCRIPTION_LENGTH = 65536;
+
 // packages/models/src/lib/implementation/utils.ts
 var slugRegex = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
 var filenameRegex = /^(?!.*[ \\/:*?"<>|]).+$/;
@@ -46,12 +51,12 @@ function executionMetaSchema(options = {
 function slugSchema(description = "Unique ID (human-readable, URL-safe)") {
   return z.string({ description }).regex(slugRegex, {
     message: "The slug has to follow the pattern [0-9a-z] followed by multiple optional groups of -[0-9a-z]. e.g. my-slug"
-  }).max(128, {
-    message: "slug can be max 128 characters long"
+  }).max(MAX_SLUG_LENGTH, {
+    message: `slug can be max ${MAX_SLUG_LENGTH} characters long`
   });
 }
 function descriptionSchema(description = "Description (markdown)") {
-  return z.string({ description }).max(65536).optional();
+  return z.string({ description }).max(MAX_DESCRIPTION_LENGTH).optional();
 }
 function docsUrlSchema(description = "Documentation site") {
   return urlSchema(description).optional().or(z.string().max(0));
@@ -60,7 +65,7 @@ function urlSchema(description) {
   return z.string({ description }).url();
 }
 function titleSchema(description = "Descriptive name") {
-  return z.string({ description }).max(256);
+  return z.string({ description }).max(MAX_TITLE_LENGTH);
 }
 function metaSchema(options) {
   const {
@@ -566,6 +571,19 @@ function formatDuration(duration) {
   }
   return `${(duration / 1e3).toFixed(2)} s`;
 }
+function truncateText(text, maxChars) {
+  if (text.length <= maxChars) {
+    return text;
+  }
+  const ellipsis = "...";
+  return text.slice(0, maxChars - ellipsis.length) + ellipsis;
+}
+function truncateTitle(text) {
+  return truncateText(text, MAX_TITLE_LENGTH);
+}
+function truncateDescription(text) {
+  return truncateText(text, MAX_DESCRIPTION_LENGTH);
+}
 
 // packages/utils/src/lib/guards.ts
 function isPromiseFulfilledResult(result) {
@@ -606,6 +624,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) {
@@ -624,14 +658,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;
@@ -968,60 +994,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" : ""}>
@@ -1099,6 +1071,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;
@@ -1509,6 +1535,7 @@ export {
   ensureDirectoryExists,
   executeProcess,
   factorOf,
+  fileExists,
   findLineNumberInText,
   formatBytes,
   formatDuration,
@@ -1535,5 +1562,8 @@ export {
   slugify,
   toArray,
   toUnixPath,
+  truncateDescription,
+  truncateText,
+  truncateTitle,
   verboseUtils
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.1.1",
+  "version": "0.3.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, truncateDescription, truncateText, truncateTitle, } 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, factorOf, } 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;

package/src/lib/formatting.d.ts

@@ -3,3 +3,6 @@ export declare function pluralize(text: string): string;
 export declare function formatBytes(bytes: number, decimals?: number): string;
 export declare function pluralizeToken(token: string, times?: number): string;
 export declare function formatDuration(duration: number): string;
+export declare function truncateText(text: string, maxChars: number): string;
+export declare function truncateTitle(text: string): string;
+export declare function truncateDescription(text: string): string;