chore(utils): introduce helpers for ordinal numbers, precision and capitalisation

Author: Tlacenka

packages/utils/src/index.ts

@@ -55,13 +55,16 @@ export {
 } from './lib/reports/utils';
 export {
   CliArgsObject,
+  capitalize,
   countOccurrences,
   distinct,
   factorOf,
   objectToCliArgs,
   objectToEntries,
   objectToKeys,
   toArray,
+  toNumberPrecision,
+  toOrdinal,
   toUnixPath,
 } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';

packages/utils/src/lib/transform.ts

@@ -115,3 +115,38 @@ export function toUnixPath(
 
   return unixPath;
 }
+
+export function capitalize<T extends string>(text: T): Capitalize<T> {
+  return `${text.charAt(0).toLocaleUpperCase()}${text.slice(
+    1,
+  )}` as Capitalize<T>;
+}
+
+export function toNumberPrecision(
+  value: number,
+  decimalPlaces: number,
+): number {
+  return Number(
+    `${Math.round(
+      Number.parseFloat(`${value}e${decimalPlaces}`),
+    )}e-${decimalPlaces}`,
+  );
+}
+
+/* eslint-disable no-magic-numbers */
+export function toOrdinal(value: number): string {
+  if (value % 10 === 1 && value % 100 !== 11) {
+    return `${value}st`;
+  }
+
+  if (value % 10 === 2 && value % 100 !== 12) {
+    return `${value}nd`;
+  }
+
+  if (value % 10 === 3 && value % 100 !== 13) {
+    return `${value}rd`;
+  }
+
+  return `${value}th`;
+}
+/* eslint-enable no-magic-numbers */

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

@@ -1,5 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import {
+  capitalize,
   countOccurrences,
   deepClone,
   distinct,
@@ -8,6 +9,8 @@ import {
   objectToEntries,
   objectToKeys,
   toArray,
+  toNumberPrecision,
+  toOrdinal,
   toUnixPath,
 } from './transform';
 
@@ -187,3 +190,49 @@ describe('toUnixPath', () => {
     ).toBe('windows/path/config.ts');
   });
 });
+
+describe('capitalize', () => {
+  it('should transform the first string letter to upper case', () => {
+    expect(capitalize('code PushUp')).toBe('Code PushUp');
+  });
+
+  it('should leave the first string letter in upper case', () => {
+    expect(capitalize('Code PushUp')).toBe('Code PushUp');
+  });
+
+  it('should accept empty string', () => {
+    expect(capitalize('')).toBe('');
+  });
+});
+
+describe('toNumberPrecision', () => {
+  it.each([
+    [12.1, 0, 12],
+    [12.3, 1, 12.3],
+    [12.35, 1, 12.4],
+    [0.001, 2, 0],
+  ])(
+    'should round %d to %d decimal places as %d',
+    (value, decimalPlaces, roundedValue) => {
+      expect(toNumberPrecision(value, decimalPlaces)).toBe(roundedValue);
+    },
+  );
+});
+
+describe('toOrdinal', () => {
+  it.each([
+    [1, '1st'],
+    [2, '2nd'],
+    [3, '3rd'],
+    [5, '5th'],
+    [10, '10th'],
+    [11, '11th'],
+    [12, '12th'],
+    [13, '13th'],
+    [171, '171st'],
+    [172, '172nd'],
+    [173, '173rd'],
+  ])('should covert %d to ordinal as %s', (value, ordinalValue) => {
+    expect(toOrdinal(value)).toBe(ordinalValue);
+  });
+});