feat(string helpers): add string manipulation functions and tests

Release-As: 0.2.1

Author: aprendendofelipe

packages/helpers/src/index.js

@@ -3,3 +3,4 @@ export * from './is.js';
 export * from './merge.js';
 export * from './noop.js';
 export * from './splitConfig.js';
+export * from './strings.js';

packages/helpers/src/strings.js

@@ -0,0 +1,31 @@
+const invisibleCharRegex = '[\\s\\p{C}\u034f\u17b4\u17b5\u2800\u115f\u1160\u3164\uffa0]';
+const trimStartRegex = new RegExp('^' + invisibleCharRegex, 'u');
+const trimEndRegex = new RegExp(invisibleCharRegex + '$', 'u');
+
+export function trimStart(str) {
+  while (trimStartRegex.test(str)) {
+    str = str.replace(trimStartRegex, '');
+  }
+
+  return str;
+}
+
+export function trimEnd(str) {
+  while (trimEndRegex.test(str)) {
+    str = str.replace(trimEndRegex, '');
+  }
+
+  return str;
+}
+
+const graphemeSegmenter = new Intl.Segmenter({ granularity: 'grapheme' });
+
+export function truncate(str, maxLength) {
+  if (!maxLength) return str;
+  if (str.length <= maxLength) return str;
+
+  const graphemes = Array.from(graphemeSegmenter.segment(str), (s) => s.segment);
+  if (graphemes.length <= maxLength) return str;
+
+  return trimEnd(graphemes.slice(0, maxLength - 3).join('')) + '...';
+}

packages/helpers/src/strings.test.js

@@ -0,0 +1,75 @@
+import { trimEnd, trimStart, truncate } from './strings.js';
+
+describe('helpers', () => {
+  describe('trimStart', () => {
+    it('should remove invisible characters from the start of a string', () => {
+      const input = '\u034f\u034fHello';
+      const result = trimStart(input);
+      expect(result).toBe('Hello');
+    });
+
+    it('should return the same string if no invisible characters are at the start', () => {
+      const input = 'Hello';
+      const result = trimStart(input);
+      expect(result).toBe('Hello');
+    });
+  });
+
+  describe('trimEnd', () => {
+    it('should remove invisible characters from the end of a string', () => {
+      const input = 'Hello\u034f\u034f';
+      const result = trimEnd(input);
+      expect(result).toBe('Hello');
+    });
+
+    it('should return the same string if no invisible characters are at the end', () => {
+      const input = 'Hello';
+      const result = trimEnd(input);
+      expect(result).toBe('Hello');
+    });
+  });
+
+  describe('truncate', () => {
+    it('should truncate a string to the specified maxLength and append "..."', () => {
+      const input = 'This is a long string.';
+      const result = truncate(input, 10);
+      expect(result).toBe('This is...');
+    });
+
+    it('should return the original string if it is shorter than maxLength', () => {
+      const input = 'Short';
+      const result = truncate(input, 10);
+      expect(result).toBe('Short');
+    });
+
+    it('should return the original string if maxLength is not provided', () => {
+      const input = 'No max length';
+      const result = truncate(input);
+      expect(result).toBe('No max length');
+    });
+
+    it('should return the original string if maxLength is 0', () => {
+      const input = 'No max length';
+      const result = truncate(input, 0);
+      expect(result).toBe('No max length');
+    });
+
+    it('should handle emojis correctly', () => {
+      const input = '😀 This is a long string with emojis.';
+      const result = truncate(input, 12);
+      expect(result).toBe('😀 This is...');
+    });
+
+    it('should handle emojis at the truncation point', () => {
+      const emoji = '👩‍❤️‍💋‍👨';
+      expect(emoji).toHaveLength(11);
+      const input = `Truncate this ${emoji} string.`;
+
+      expect(truncate(input, 16)).toBe('Truncate this...');
+      expect(truncate(input, 17)).toBe('Truncate this...');
+      expect(truncate(input, 18)).toBe('Truncate this 👩‍❤️‍💋‍👨...');
+      expect(truncate(input, 19)).toBe('Truncate this 👩‍❤️‍💋‍👨...');
+      expect(truncate(input, 20)).toBe('Truncate this 👩‍❤️‍💋‍👨 s...');
+    });
+  });
+});