feat(utils): add utility function for truncating texts

Author: matejchalk

packages/utils/src/index.ts

@@ -27,6 +27,9 @@ export {
   pluralize,
   pluralizeToken,
   slugify,
+  truncateDescription,
+  truncateText,
+  truncateTitle,
 } from './lib/formatting';
 export { getLatestCommit, git } from './lib/git';
 export {

packages/utils/src/lib/formatting.ts

@@ -1,3 +1,5 @@
+import { MAX_DESCRIPTION_LENGTH, MAX_TITLE_LENGTH } from '@code-pushup/models';
+
 export function slugify(text: string): string {
   return text
     .trim()
@@ -40,3 +42,19 @@ export function formatDuration(duration: number): string {
   }
   return `${(duration / 1000).toFixed(2)} s`;
 }
+
+export function truncateText(text: string, maxChars: number): string {
+  if (text.length <= maxChars) {
+    return text;
+  }
+  const ellipsis = '...';
+  return text.slice(0, maxChars - ellipsis.length) + ellipsis;
+}
+
+export function truncateTitle(text: string): string {
+  return truncateText(text, MAX_TITLE_LENGTH);
+}
+
+export function truncateDescription(text: string): string {
+  return truncateText(text, MAX_DESCRIPTION_LENGTH);
+}

packages/utils/src/lib/formatting.unit.test.ts

@@ -5,6 +5,7 @@ import {
   pluralize,
   pluralizeToken,
   slugify,
+  truncateText,
 } from './formatting';
 
 describe('slugify', () => {
@@ -78,3 +79,21 @@ describe('formatDuration', () => {
     expect(formatDuration(ms)).toBe(displayValue);
   });
 });
+
+describe('truncateText', () => {
+  it('should replace overflowing text with ellipsis', () => {
+    expect(truncateText('All work and no play makes Jack a dull boy', 32)).toBe(
+      'All work and no play makes Ja...',
+    );
+  });
+
+  it('should produce truncated text which fits within limit', () => {
+    expect(
+      truncateText('All work and no play makes Jack a dull boy', 32).length,
+    ).toBeLessThanOrEqual(32);
+  });
+
+  it('should leave text unchanged when within character limit', () => {
+    expect(truncateText("Here's Johnny!", 32)).toBe("Here's Johnny!");
+  });
+});