@sopkit/slug 1.0.0

package/README.md

@@ -0,0 +1,49 @@
+# `@sopkit/slug`
+
+Premium, lightweight URL slug generator and text clean-up utility with full Unicode/diacritics support. Part of the SopKit utility ecosystem.
+
+## Online Interactive Tool
+You can use the browser-based interactive version of this tool at [SopKit Slug Generator](https://sopkit.github.io/slug-generator/).
+
+## Features
+- Unicode normalization (decomposes accents and diacritics like `é` ➜ `e`)
+- Custom separators (e.g. `-`, `_`, or custom characters)
+- Case control (force lowercase/preserve case)
+- Strict clean-up filters out special URL-breaking symbols
+- Zero dependencies
+- ESM and CommonJS support
+
+## Installation
+```bash
+npm install @sopkit/slug
+```
+
+## Quick Start
+
+### ESM
+```typescript
+import { slugify, isValid } from "@sopkit/slug";
+
+// Standard slugification
+slugify("Hello World & Universe!"); // "hello-world-universe"
+
+// Accent normalization
+slugify("Café & résumé"); // "cafe-resume"
+
+// Custom options
+slugify("User Profile ID", { separator: "_", lowercase: false }); // "User_Profile_ID"
+
+// Validation
+isValid("hello-world"); // true
+isValid("hello world!"); // false
+```
+
+### CommonJS
+```javascript
+const { slugify } = require("@sopkit/slug");
+
+const slug = slugify("SopKit Slugify"); // "sopkit-slugify"
+```
+
+## License
+MIT © [SopKit](https://sopkit.github.io/)

package/dist/index.cjs

@@ -0,0 +1,66 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  isValid: () => isValid,
+  slugify: () => slugify
+});
+module.exports = __toCommonJS(index_exports);
+function slugify(text, options = {}) {
+  if (typeof text !== "string") {
+    throw new TypeError("Input must be a string");
+  }
+  const {
+    separator = "-",
+    lowercase = true,
+    strict = true
+  } = options;
+  let str = text;
+  str = str.normalize("NFD").replace(/[\u0300-\u036f]/g, "");
+  if (lowercase) {
+    str = str.toLowerCase();
+  }
+  if (strict) {
+    str = str.replace(/[^a-z0-9\s-_]/gi, "");
+  }
+  str = str.trim().replace(/\s+/g, separator).replace(new RegExp(`\\${separator}+`, "g"), separator);
+  if (str.startsWith(separator)) {
+    str = str.slice(separator.length);
+  }
+  if (str.endsWith(separator)) {
+    str = str.slice(0, -separator.length);
+  }
+  return str;
+}
+function isValid(slug, separator = "-") {
+  if (typeof slug !== "string" || slug.trim() === "") {
+    return false;
+  }
+  const escapedSeparator = separator.replace(/[-\/\\^$*+?.()|[\]{}]/g, "\\$&");
+  const regex = new RegExp(`^[a-z0-9]+(${escapedSeparator}[a-z0-9]+)*$`, "i");
+  return regex.test(slug);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  isValid,
+  slugify
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * SopKit Slug Utilities\n * Premium, zero-dependency multilingual URL slug generator.\n * Link: https://sopkit.github.io/slug-generator/\n */\n\nexport interface SlugOptions {\n  /**\n   * Character separator. Defaults to \"-\".\n   */\n  separator?: string;\n  /**\n   * Automatically convert slug to lowercase. Defaults to true.\n   */\n  lowercase?: boolean;\n  /**\n   * Strip non-alphanumeric characters. Defaults to true.\n   */\n  strict?: boolean;\n}\n\n/**\n * Generates a clean URL slug from the given text input.\n * Supports accent removal and basic character normalization.\n */\nexport function slugify(text: string, options: SlugOptions = {}): string {\n  if (typeof text !== \"string\") {\n    throw new TypeError(\"Input must be a string\");\n  }\n\n  const {\n    separator = \"-\",\n    lowercase = true,\n    strict = true\n  } = options;\n\n  let str = text;\n\n  // 1. Normalize unicode characters (remove diacritics/accents)\n  str = str.normalize(\"NFD\").replace(/[\\u0300-\\u036f]/g, \"\");\n\n  // 2. Convert to lowercase if flag set\n  if (lowercase) {\n    str = str.toLowerCase();\n  }\n\n  // 3. Apply separator and remove invalid characters\n  if (strict) {\n    str = str.replace(/[^a-z0-9\\s-_]/gi, \"\");\n  }\n\n  // 4. Replace whitespace and multiple separators\n  str = str.trim()\n    .replace(/\\s+/g, separator)\n    .replace(new RegExp(`\\\\${separator}+`, \"g\"), separator);\n\n  // 5. Clean up leading or trailing separators\n  if (str.startsWith(separator)) {\n    str = str.slice(separator.length);\n  }\n  if (str.endsWith(separator)) {\n    str = str.slice(0, -separator.length);\n  }\n\n  return str;\n}\n\n/**\n * Validates if a string is a valid URL slug (alphanumeric and dashes/underscores).\n */\nexport function isValid(slug: string, separator: string = \"-\"): boolean {\n  if (typeof slug !== \"string\" || slug.trim() === \"\") {\n    return false;\n  }\n  const escapedSeparator = separator.replace(/[-\\/\\\\^$*+?.()|[\\]{}]/g, \"\\\\$&\");\n  const regex = new RegExp(`^[a-z0-9]+(${escapedSeparator}[a-z0-9]+)*$`, \"i\");\n  return regex.test(slug);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAyBO,SAAS,QAAQ,MAAc,UAAuB,CAAC,GAAW;AACvE,MAAI,OAAO,SAAS,UAAU;AAC5B,UAAM,IAAI,UAAU,wBAAwB;AAAA,EAC9C;AAEA,QAAM;AAAA,IACJ,YAAY;AAAA,IACZ,YAAY;AAAA,IACZ,SAAS;AAAA,EACX,IAAI;AAEJ,MAAI,MAAM;AAGV,QAAM,IAAI,UAAU,KAAK,EAAE,QAAQ,oBAAoB,EAAE;AAGzD,MAAI,WAAW;AACb,UAAM,IAAI,YAAY;AAAA,EACxB;AAGA,MAAI,QAAQ;AACV,UAAM,IAAI,QAAQ,mBAAmB,EAAE;AAAA,EACzC;AAGA,QAAM,IAAI,KAAK,EACZ,QAAQ,QAAQ,SAAS,EACzB,QAAQ,IAAI,OAAO,KAAK,SAAS,KAAK,GAAG,GAAG,SAAS;AAGxD,MAAI,IAAI,WAAW,SAAS,GAAG;AAC7B,UAAM,IAAI,MAAM,UAAU,MAAM;AAAA,EAClC;AACA,MAAI,IAAI,SAAS,SAAS,GAAG;AAC3B,UAAM,IAAI,MAAM,GAAG,CAAC,UAAU,MAAM;AAAA,EACtC;AAEA,SAAO;AACT;AAKO,SAAS,QAAQ,MAAc,YAAoB,KAAc;AACtE,MAAI,OAAO,SAAS,YAAY,KAAK,KAAK,MAAM,IAAI;AAClD,WAAO;AAAA,EACT;AACA,QAAM,mBAAmB,UAAU,QAAQ,0BAA0B,MAAM;AAC3E,QAAM,QAAQ,IAAI,OAAO,cAAc,gBAAgB,gBAAgB,GAAG;AAC1E,SAAO,MAAM,KAAK,IAAI;AACxB;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,30 @@
+/**
+ * SopKit Slug Utilities
+ * Premium, zero-dependency multilingual URL slug generator.
+ * Link: https://sopkit.github.io/slug-generator/
+ */
+interface SlugOptions {
+    /**
+     * Character separator. Defaults to "-".
+     */
+    separator?: string;
+    /**
+     * Automatically convert slug to lowercase. Defaults to true.
+     */
+    lowercase?: boolean;
+    /**
+     * Strip non-alphanumeric characters. Defaults to true.
+     */
+    strict?: boolean;
+}
+/**
+ * Generates a clean URL slug from the given text input.
+ * Supports accent removal and basic character normalization.
+ */
+declare function slugify(text: string, options?: SlugOptions): string;
+/**
+ * Validates if a string is a valid URL slug (alphanumeric and dashes/underscores).
+ */
+declare function isValid(slug: string, separator?: string): boolean;
+
+export { type SlugOptions, isValid, slugify };

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+/**
+ * SopKit Slug Utilities
+ * Premium, zero-dependency multilingual URL slug generator.
+ * Link: https://sopkit.github.io/slug-generator/
+ */
+interface SlugOptions {
+    /**
+     * Character separator. Defaults to "-".
+     */
+    separator?: string;
+    /**
+     * Automatically convert slug to lowercase. Defaults to true.
+     */
+    lowercase?: boolean;
+    /**
+     * Strip non-alphanumeric characters. Defaults to true.
+     */
+    strict?: boolean;
+}
+/**
+ * Generates a clean URL slug from the given text input.
+ * Supports accent removal and basic character normalization.
+ */
+declare function slugify(text: string, options?: SlugOptions): string;
+/**
+ * Validates if a string is a valid URL slug (alphanumeric and dashes/underscores).
+ */
+declare function isValid(slug: string, separator?: string): boolean;
+
+export { type SlugOptions, isValid, slugify };

package/dist/index.js

@@ -0,0 +1,40 @@
+// src/index.ts
+function slugify(text, options = {}) {
+  if (typeof text !== "string") {
+    throw new TypeError("Input must be a string");
+  }
+  const {
+    separator = "-",
+    lowercase = true,
+    strict = true
+  } = options;
+  let str = text;
+  str = str.normalize("NFD").replace(/[\u0300-\u036f]/g, "");
+  if (lowercase) {
+    str = str.toLowerCase();
+  }
+  if (strict) {
+    str = str.replace(/[^a-z0-9\s-_]/gi, "");
+  }
+  str = str.trim().replace(/\s+/g, separator).replace(new RegExp(`\\${separator}+`, "g"), separator);
+  if (str.startsWith(separator)) {
+    str = str.slice(separator.length);
+  }
+  if (str.endsWith(separator)) {
+    str = str.slice(0, -separator.length);
+  }
+  return str;
+}
+function isValid(slug, separator = "-") {
+  if (typeof slug !== "string" || slug.trim() === "") {
+    return false;
+  }
+  const escapedSeparator = separator.replace(/[-\/\\^$*+?.()|[\]{}]/g, "\\$&");
+  const regex = new RegExp(`^[a-z0-9]+(${escapedSeparator}[a-z0-9]+)*$`, "i");
+  return regex.test(slug);
+}
+export {
+  isValid,
+  slugify
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * SopKit Slug Utilities\n * Premium, zero-dependency multilingual URL slug generator.\n * Link: https://sopkit.github.io/slug-generator/\n */\n\nexport interface SlugOptions {\n  /**\n   * Character separator. Defaults to \"-\".\n   */\n  separator?: string;\n  /**\n   * Automatically convert slug to lowercase. Defaults to true.\n   */\n  lowercase?: boolean;\n  /**\n   * Strip non-alphanumeric characters. Defaults to true.\n   */\n  strict?: boolean;\n}\n\n/**\n * Generates a clean URL slug from the given text input.\n * Supports accent removal and basic character normalization.\n */\nexport function slugify(text: string, options: SlugOptions = {}): string {\n  if (typeof text !== \"string\") {\n    throw new TypeError(\"Input must be a string\");\n  }\n\n  const {\n    separator = \"-\",\n    lowercase = true,\n    strict = true\n  } = options;\n\n  let str = text;\n\n  // 1. Normalize unicode characters (remove diacritics/accents)\n  str = str.normalize(\"NFD\").replace(/[\\u0300-\\u036f]/g, \"\");\n\n  // 2. Convert to lowercase if flag set\n  if (lowercase) {\n    str = str.toLowerCase();\n  }\n\n  // 3. Apply separator and remove invalid characters\n  if (strict) {\n    str = str.replace(/[^a-z0-9\\s-_]/gi, \"\");\n  }\n\n  // 4. Replace whitespace and multiple separators\n  str = str.trim()\n    .replace(/\\s+/g, separator)\n    .replace(new RegExp(`\\\\${separator}+`, \"g\"), separator);\n\n  // 5. Clean up leading or trailing separators\n  if (str.startsWith(separator)) {\n    str = str.slice(separator.length);\n  }\n  if (str.endsWith(separator)) {\n    str = str.slice(0, -separator.length);\n  }\n\n  return str;\n}\n\n/**\n * Validates if a string is a valid URL slug (alphanumeric and dashes/underscores).\n */\nexport function isValid(slug: string, separator: string = \"-\"): boolean {\n  if (typeof slug !== \"string\" || slug.trim() === \"\") {\n    return false;\n  }\n  const escapedSeparator = separator.replace(/[-\\/\\\\^$*+?.()|[\\]{}]/g, \"\\\\$&\");\n  const regex = new RegExp(`^[a-z0-9]+(${escapedSeparator}[a-z0-9]+)*$`, \"i\");\n  return regex.test(slug);\n}\n"],"mappings":";AAyBO,SAAS,QAAQ,MAAc,UAAuB,CAAC,GAAW;AACvE,MAAI,OAAO,SAAS,UAAU;AAC5B,UAAM,IAAI,UAAU,wBAAwB;AAAA,EAC9C;AAEA,QAAM;AAAA,IACJ,YAAY;AAAA,IACZ,YAAY;AAAA,IACZ,SAAS;AAAA,EACX,IAAI;AAEJ,MAAI,MAAM;AAGV,QAAM,IAAI,UAAU,KAAK,EAAE,QAAQ,oBAAoB,EAAE;AAGzD,MAAI,WAAW;AACb,UAAM,IAAI,YAAY;AAAA,EACxB;AAGA,MAAI,QAAQ;AACV,UAAM,IAAI,QAAQ,mBAAmB,EAAE;AAAA,EACzC;AAGA,QAAM,IAAI,KAAK,EACZ,QAAQ,QAAQ,SAAS,EACzB,QAAQ,IAAI,OAAO,KAAK,SAAS,KAAK,GAAG,GAAG,SAAS;AAGxD,MAAI,IAAI,WAAW,SAAS,GAAG;AAC7B,UAAM,IAAI,MAAM,UAAU,MAAM;AAAA,EAClC;AACA,MAAI,IAAI,SAAS,SAAS,GAAG;AAC3B,UAAM,IAAI,MAAM,GAAG,CAAC,UAAU,MAAM;AAAA,EACtC;AAEA,SAAO;AACT;AAKO,SAAS,QAAQ,MAAc,YAAoB,KAAc;AACtE,MAAI,OAAO,SAAS,YAAY,KAAK,KAAK,MAAM,IAAI;AAClD,WAAO;AAAA,EACT;AACA,QAAM,mBAAmB,UAAU,QAAQ,0BAA0B,MAAM;AAC3E,QAAM,QAAQ,IAAI,OAAO,cAAc,gBAAgB,gBAAgB,GAAG;AAC1E,SAAO,MAAM,KAAK,IAAI;AACxB;","names":[]}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@sopkit/slug",
+  "version": "1.0.0",
+  "description": "Premium, lightweight URL slug generator and text clean-up utility with full Unicode/diacritics support.",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "keywords": [
+    "sopkit",
+    "slug",
+    "slugify",
+    "url",
+    "clean-url",
+    "seo"
+  ],
+  "author": "SopKit",
+  "license": "MIT",
+  "homepage": "https://sopkit.github.io/slug-generator/"
+}

package/src/index.ts

@@ -0,0 +1,78 @@
+/**
+ * SopKit Slug Utilities
+ * Premium, zero-dependency multilingual URL slug generator.
+ * Link: https://sopkit.github.io/slug-generator/
+ */
+
+export interface SlugOptions {
+  /**
+   * Character separator. Defaults to "-".
+   */
+  separator?: string;
+  /**
+   * Automatically convert slug to lowercase. Defaults to true.
+   */
+  lowercase?: boolean;
+  /**
+   * Strip non-alphanumeric characters. Defaults to true.
+   */
+  strict?: boolean;
+}
+
+/**
+ * Generates a clean URL slug from the given text input.
+ * Supports accent removal and basic character normalization.
+ */
+export function slugify(text: string, options: SlugOptions = {}): string {
+  if (typeof text !== "string") {
+    throw new TypeError("Input must be a string");
+  }
+
+  const {
+    separator = "-",
+    lowercase = true,
+    strict = true
+  } = options;
+
+  let str = text;
+
+  // 1. Normalize unicode characters (remove diacritics/accents)
+  str = str.normalize("NFD").replace(/[\u0300-\u036f]/g, "");
+
+  // 2. Convert to lowercase if flag set
+  if (lowercase) {
+    str = str.toLowerCase();
+  }
+
+  // 3. Apply separator and remove invalid characters
+  if (strict) {
+    str = str.replace(/[^a-z0-9\s-_]/gi, "");
+  }
+
+  // 4. Replace whitespace and multiple separators
+  str = str.trim()
+    .replace(/\s+/g, separator)
+    .replace(new RegExp(`\\${separator}+`, "g"), separator);
+
+  // 5. Clean up leading or trailing separators
+  if (str.startsWith(separator)) {
+    str = str.slice(separator.length);
+  }
+  if (str.endsWith(separator)) {
+    str = str.slice(0, -separator.length);
+  }
+
+  return str;
+}
+
+/**
+ * Validates if a string is a valid URL slug (alphanumeric and dashes/underscores).
+ */
+export function isValid(slug: string, separator: string = "-"): boolean {
+  if (typeof slug !== "string" || slug.trim() === "") {
+    return false;
+  }
+  const escapedSeparator = separator.replace(/[-\/\\^$*+?.()|[\]{}]/g, "\\$&");
+  const regex = new RegExp(`^[a-z0-9]+(${escapedSeparator}[a-z0-9]+)*$`, "i");
+  return regex.test(slug);
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*"]
+}

package/tsup.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/index.ts"],
+  format: ["cjs", "esm"],
+  dts: true,
+  clean: true,
+  minify: false,
+  sourcemap: true,
+  splitting: false,
+});