feat: slug

Author: Navidtm

src/index.ts

@@ -0,0 +1,2 @@
+export * as vk from './valibot/index.js';
+export * as zk from './zod/index.js';

src/valibot/index.ts

@@ -0,0 +1 @@
+export { slug } from './schemas/slug.js';

src/valibot/schemas/slug.ts

@@ -0,0 +1,33 @@
+import * as v from 'valibot';
+
+/**
+ * Slug schema
+ * - Allows lowercase alphanumeric characters and hyphens
+ * - Hyphens cannot be at the start or end, nor can they be consecutive
+ * - Case insensitive
+ * - No spaces or special characters
+ * - Transforms to lowercase and trims whitespace
+ *
+ * @example
+ * ```ts
+ * import { vk } from 'valikit';
+ *
+ * const postSchema = z.object({
+ *   slug: vk.slug(),
+ * });
+ *
+ * // Valid slugs
+ * postSchema.parse({ slug: 'valid-slug' }); // passes
+ * postSchema.parse({ slug: 'another-valid-slug-123' }); // passes
+ *
+ * // Invalid slugs
+ * postSchema.parse({ slug: 'Invalid-Slug' }); // throws error (uppercase letters)
+ * postSchema.parse({ slug: 'invalid_slug' }); // throws error (underscores)
+ * postSchema.parse({ slug: 'invalid slug' }); // throws error (spaces)
+ * postSchema.parse({ slug: '-leading-hyphen' }); // throws error (leading hyphen)
+ * ```
+ */
+
+const slug = () => v.pipe(v.string(), v.regex(/^[a-z0-9]+(-[a-z0-9]+)*$/));
+
+export { slug };

src/zod/index.ts

@@ -0,0 +1 @@
+export { slug } from './schemas/slug.js';

src/zod/schemas/slug.ts

@@ -0,0 +1,33 @@
+import * as z from 'zod';
+
+/**
+ * Slug schema
+ * - Allows lowercase alphanumeric characters and hyphens
+ * - Hyphens cannot be at the start or end, nor can they be consecutive
+ * - Case insensitive
+ * - No spaces or special characters
+ * - Transforms to lowercase and trims whitespace
+ *
+ * @example
+ * ```ts
+ * import { zk } from 'valikit';
+ *
+ * const postSchema = z.object({
+ *   slug: zk.slug(),
+ * });
+ *
+ * // Valid slugs
+ * postSchema.parse({ slug: 'valid-slug' }); // passes
+ * postSchema.parse({ slug: 'another-valid-slug-123' }); // passes
+ *
+ * // Invalid slugs
+ * postSchema.parse({ slug: 'Invalid-Slug' }); // throws error (uppercase letters)
+ * postSchema.parse({ slug: 'invalid_slug' }); // throws error (underscores)
+ * postSchema.parse({ slug: 'invalid slug' }); // throws error (spaces)
+ * postSchema.parse({ slug: '-leading-hyphen' }); // throws error (leading hyphen)
+ * ```
+ */
+
+const slug = () => z.string().regex(/^[a-z0-9]+(-[a-z0-9]+)*$/);
+
+export { slug };

tests/schemas/slug.test.ts

@@ -0,0 +1,61 @@
+import { describe, expect, it } from 'vitest';
+import * as v from 'valibot';
+
+import { zk, vk } from '../../src';
+
+const testSlug = (slug: string, shouldPass: boolean) => {
+	// Zod
+	const zodResult = zk.slug().safeParse(slug);
+	expect(zodResult.success).toBe(shouldPass);
+
+	// Valibot
+	const valibotResult = v.safeParse(vk.slug(), slug);
+	expect(valibotResult.success).toBe(shouldPass);
+};
+
+describe('slug', () => {
+	describe('valid slugs', () => {
+		const validCases = [
+			{ slug: 'valid-slug', desc: 'basic slug' },
+			{ slug: 'another-valid-slug-123', desc: 'with numbers' },
+			{ slug: 'slug-with-multiple-parts', desc: 'multiple parts' },
+			{ slug: 'a', desc: 'single letter' },
+			{ slug: 'z-0-9', desc: 'mixed letters and numbers' },
+			{ slug: '123', desc: 'only numbers' },
+			{ slug: '1', desc: 'single digit' },
+			{
+				slug: 'very-long-slug-with-many-parts-and-numbers-123',
+				desc: 'long slug',
+			},
+		];
+
+		it.each(validCases)('should pass - %s ("%s")', ({ slug }) => {
+			testSlug(slug, true);
+		});
+	});
+
+	describe('invalid slugs', () => {
+		const invalidCases = [
+			{ slug: 'Invalid-Slug', desc: 'uppercase letters' },
+			{ slug: 'invalid_slug', desc: 'underscores' },
+			{ slug: 'invalid slug', desc: 'spaces' },
+			{ slug: 'invalid@slug!', desc: 'special characters' },
+			{ slug: '', desc: 'empty string' },
+			{ slug: '-leading-hyphen', desc: 'leading hyphen' },
+			{ slug: 'trailing-hyphen-', desc: 'trailing hyphen' },
+			{ slug: 'double--hyphen', desc: 'consecutive hyphens' },
+			{ slug: 'with/slash', desc: 'slash' },
+			{ slug: 'with.dot', desc: 'dot' },
+			{ slug: 'with..dot', desc: 'consecutive dots' },
+			{ slug: '-', desc: 'single hyphen' },
+			{ slug: 'Café', desc: 'unicode characters' },
+			{ slug: 'سلام', desc: 'non-latin characters' },
+			{ slug: ' leading-space', desc: 'leading space' },
+			{ slug: 'trailing-space ', desc: 'trailing space' },
+		];
+
+		it.each(invalidCases)('should fail - %s ("%s")', ({ slug }) => {
+			testSlug(slug, false);
+		});
+	});
+});