Implement slugify

Author: colinhacks

packages/zod/src/v4/classic/checks.ts

@@ -27,5 +27,6 @@ export {
   _trim as trim,
   _toLowerCase as toLowerCase,
   _toUpperCase as toUpperCase,
+  _slugify as slugify,
   type $RefinementCtx as RefinementCtx,
 } from "../core/index.js";

packages/zod/src/v4/classic/schemas.ts

@@ -252,6 +252,7 @@ export interface _ZodString<T extends core.$ZodStringInternals<unknown> = core.$
   normalize(form?: "NFC" | "NFD" | "NFKC" | "NFKD" | (string & {})): this;
   toLowerCase(): this;
   toUpperCase(): this;
+  slugify(): this;
 }
 
 /** @internal */
@@ -281,6 +282,7 @@ export const _ZodString: core.$constructor<_ZodString> = /*@__PURE__*/ core.$con
   inst.normalize = (...args) => inst.check(checks.normalize(...args));
   inst.toLowerCase = () => inst.check(checks.toLowerCase());
   inst.toUpperCase = () => inst.check(checks.toUpperCase());
+  inst.slugify = () => inst.check(checks.slugify());
 });
 
 export interface ZodString extends _ZodString<core.$ZodStringInternals<string>> {

packages/zod/src/v4/classic/tests/string.test.ts

@@ -803,6 +803,24 @@ test("lowerCase", () => {
   expect(z.string().toUpperCase().parse("asdf")).toEqual("ASDF");
 });
 
+test("slugify", () => {
+  expect(z.string().slugify().parse("Hello World")).toEqual("hello-world");
+  expect(z.string().slugify().parse("  Hello   World  ")).toEqual("hello-world");
+  expect(z.string().slugify().parse("Hello@World#123")).toEqual("helloworld123");
+  expect(z.string().slugify().parse("Hello-World")).toEqual("hello-world");
+  expect(z.string().slugify().parse("Hello_World")).toEqual("hello-world");
+  expect(z.string().slugify().parse("---Hello---World---")).toEqual("hello-world");
+  expect(z.string().slugify().parse("Hello  World")).toEqual("hello-world");
+  expect(z.string().slugify().parse("Hello!@#$%^&*()World")).toEqual("helloworld");
+
+  // can be used with check
+  expect(z.string().check(z.slugify()).parse("Hello World")).toEqual("hello-world");
+
+  // can be chained with other methods
+  expect(z.string().slugify().min(5).parse("Hello World")).toEqual("hello-world");
+  expect(() => z.string().slugify().min(20).parse("Hello World")).toThrow();
+});
+
 // test("IP validation", () => {
 //   const ipSchema = z.string().ip();
 

packages/zod/src/v4/core/api.ts

@@ -1053,6 +1053,10 @@ export function _toLowerCase(): checks.$ZodCheckOverwrite<string> {
 export function _toUpperCase(): checks.$ZodCheckOverwrite<string> {
   return _overwrite((input) => input.toUpperCase());
 }
+// slugify
+export function _slugify(): checks.$ZodCheckOverwrite<string> {
+  return _overwrite((input) => util.slugify(input));
+}
 
 ///////  collections   ///////
 

packages/zod/src/v4/core/util.ts

@@ -351,6 +351,15 @@ export function esc(str: string): string {
   return JSON.stringify(str);
 }
 
+export function slugify(input: string): string {
+  return input
+    .toLowerCase()
+    .trim()
+    .replace(/[^\w\s-]/g, "")
+    .replace(/[\s_-]+/g, "-")
+    .replace(/^-+|-+$/g, "");
+}
+
 export const captureStackTrace: (targetObject: object, constructorOpt?: Function) => void = (
   "captureStackTrace" in Error ? Error.captureStackTrace : (..._args: any[]) => {}
 ) as any;

play.ts

@@ -2,9 +2,6 @@ import * as z from "zod";
 
 z;
 
-const mac = z.stringFormat(
-  "mac",
-  /^(([0-9A-F]{2}([-:])[0-9A-F]{2}(\3[0-9A-F]{2}){4})|([0-9a-f]{2}([-:])[0-9a-f]{2}(\6[0-9a-f]{2}){4}))$/
-);
-
-mac.parse("00:1A:2B:3C:4D:5E");
+// Test slugify
+console.log(z.string().slugify().parse("Hello World"));
+console.log(z.string().check(z.slugify()).parse("Hello World"));