@code-pushup/utils 0.2.0 → 0.3.1

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) {
@@ -1544,5 +1562,8 @@ export {
   slugify,
   toArray,
   toUnixPath,
+  truncateDescription,
+  truncateText,
+  truncateTitle,
   verboseUtils
 };

package/package.json

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

package/src/index.d.ts

@@ -1,6 +1,6 @@
 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 { 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';

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;