feat: added camelToSentenceCase util

Author: devlargs

README.md

@@ -10,6 +10,21 @@ npm install largs-utils
 
 ## Functions
 
+### `camelToSentenceCase`
+
+Converts a camelCase or PascalCase string into a readable sentence with spaces.
+
+**Usage:**
+
+```typescript
+import { camelToSentenceCase } from "largs-utils";
+
+console.log(camelToSentenceCase("helloWorld")); // "Hello World"
+console.log(camelToSentenceCase("ThisIsATest")); // "This Is A Test"
+console.log(camelToSentenceCase("JSONParser")); // "JSON Parser"
+console.log(camelToSentenceCase("APITestCase")); // "API Test Case"
+```
+
 ### `coercedGet`
 
 Safely retrieves a value from an object with default handling.

src/__tests__/camelToSentenceCase.test.ts

@@ -0,0 +1,40 @@
+import { camelToSentenceCase } from "..";
+
+describe("camelToSentenceCase", () => {
+  test("should convert camelCase to sentence case", () => {
+    expect(camelToSentenceCase("helloWorld")).toBe("Hello World");
+    expect(camelToSentenceCase("thisIsATest")).toBe("This Is A Test");
+    expect(camelToSentenceCase("convertThisFunction")).toBe(
+      "Convert This Function"
+    );
+  });
+
+  test("should handle PascalCase correctly", () => {
+    expect(camelToSentenceCase("HelloWorld")).toBe("Hello World");
+    expect(camelToSentenceCase("ThisIsATest")).toBe("This Is A Test");
+  });
+
+  test("should handle acronyms within words", () => {
+    expect(camelToSentenceCase("JSONParser")).toBe("JSON Parser");
+    expect(camelToSentenceCase("APITestCase")).toBe("API Test Case");
+  });
+
+  test("should handle single words without modification", () => {
+    expect(camelToSentenceCase("hello")).toBe("Hello");
+    expect(camelToSentenceCase("Test")).toBe("Test");
+  });
+
+  test("should handle already spaced text without adding extra spaces", () => {
+    expect(camelToSentenceCase("Already Spaced Text")).toBe(
+      "Already Spaced Text"
+    );
+  });
+
+  test("should handle empty strings gracefully", () => {
+    expect(camelToSentenceCase("")).toBe("");
+  });
+
+  test("should handle strings with numbers", () => {
+    expect(camelToSentenceCase("version2Update")).toBe("Version2Update");
+  });
+});

src/camelToSentenceCase.ts

@@ -0,0 +1,4 @@
+export const camelToSentenceCase = (str: string): string => {
+  const temp = str.replace(/([A-Z])(?=[A-Z][a-z])|([a-z])(?=[A-Z])/g, "$& ");
+  return temp.charAt(0).toUpperCase() + temp.slice(1);
+};

src/coercedGet.ts

@@ -1,4 +1,3 @@
-// Use this to traverse data without getting undefined errors
 export const coercedGet = (
   obj: Record<string, any>,
   path: string,

src/index.ts

@@ -1,3 +1,4 @@
+export { camelToSentenceCase } from "./camelToSentenceCase";
 export { coercedGet } from "./coercedGet";
-export { shuffleArray } from "./shuffleArray";
 export { isValidEmail } from "./isValidEmail";
+export { shuffleArray } from "./shuffleArray";