feat: added generateSlug util

Author: devlargs

src/__tests__/generateSlug.test.ts

@@ -0,0 +1,27 @@
+import { generateSlug } from "../generateSlug";
+
+describe("generateSlug", () => {
+  it("should convert string to lowercase and replace spaces with hyphens", () => {
+    expect(generateSlug("Hello World")).toBe("hello-world");
+  });
+
+  it("should remove special characters and trim hyphens", () => {
+    expect(generateSlug("  Hello @#$ World!  ")).toBe("hello-world");
+  });
+
+  it("should handle multiple consecutive non-alphanumerics", () => {
+    expect(generateSlug("This---is_a_test")).toBe("this-is-a-test");
+  });
+
+  it("should return empty string for input with only non-alphanumerics", () => {
+    expect(generateSlug("!!!")).toBe("");
+  });
+
+  it("should preserve numbers in the slug", () => {
+    expect(generateSlug("Product 123")).toBe("product-123");
+  });
+
+  it("should handle already well-formatted slug", () => {
+    expect(generateSlug("already-slugified")).toBe("already-slugified");
+  });
+});

src/generateSlug.ts

@@ -0,0 +1,6 @@
+export const generateSlug = (str: string): string => {
+  return str
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, "-")
+    .replace(/(^-|-$)/g, "");
+};

src/index.ts

@@ -2,6 +2,7 @@ export { camelToSentenceCase } from "./camelToSentenceCase";
 export { coercedGet } from "./coercedGet";
 export { extractLatLngFromGoogleMapsUrl } from "./extractLatLngFromGoogleMapsUrl";
 export { generatePrefixedId } from "./generatePrefixedId";
+export { generateSlug } from "./generateSlug";
 export { isValidEmail } from "./isValidEmail";
 export { isValidGoogleMapsUrl } from "./isValidGoogleMapsUrl";
 export { isValidHttpUrl } from "./isValidHttpUrl";