@naturalcycles/js-lib 14.252.1 → 14.253.0

package/dist/index.d.ts

@@ -74,6 +74,7 @@ export * from './string/pupa';
 export * from './string/readingTime';
 export * from './string/regex';
 export * from './string/safeJsonStringify';
+export * from './string/slugify';
 export * from './string/string.util';
 export * from './string/stringify';
 export * from './string/url.util';

package/dist/index.js

@@ -78,6 +78,7 @@ tslib_1.__exportStar(require("./string/pupa"), exports);
 tslib_1.__exportStar(require("./string/readingTime"), exports);
 tslib_1.__exportStar(require("./string/regex"), exports);
 tslib_1.__exportStar(require("./string/safeJsonStringify"), exports);
+tslib_1.__exportStar(require("./string/slugify"), exports);
 tslib_1.__exportStar(require("./string/string.util"), exports);
 tslib_1.__exportStar(require("./string/stringify"), exports);
 tslib_1.__exportStar(require("./string/url.util"), exports);

package/dist/string/slugify.d.ts

@@ -0,0 +1,19 @@
+export interface SlugifyOptions {
+    /**
+     * Default: `-`
+     */
+    separator?: string;
+    /**
+     * Default: true
+     */
+    lowercase?: boolean;
+    /**
+     * Default: true
+     */
+    decamelize?: boolean;
+    /**
+     * Default: []
+     */
+    preserveCharacters?: string[];
+}
+export declare function _slugify(s: string, opt?: SlugifyOptions): string;

package/dist/string/slugify.js

@@ -0,0 +1,69 @@
+"use strict";
+// Credit to (adopted from): https://github.com/sindresorhus/slugify/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._slugify = _slugify;
+function _slugify(s, opt = {}) {
+    opt = {
+        separator: '-',
+        lowercase: true,
+        decamelize: true,
+        preserveCharacters: [],
+        ...opt,
+    };
+    if (opt.decamelize) {
+        s = decamelize(s);
+    }
+    const patternSlug = buildPatternSlug(opt);
+    if (opt.lowercase) {
+        s = s.toLowerCase();
+    }
+    // based on https://stackoverflow.com/a/23633850/4919972
+    // Combining Diacritical Marks
+    // https://www.unicode.org/charts/PDF/U0300.pdf
+    // biome-ignore lint/suspicious/noMisleadingCharacterClass: ok
+    s = s.normalize('NFKD').replaceAll(/[\u0300-\u036F]/g, '');
+    // Detect contractions/possessives by looking for any word followed by a `'t`
+    // or `'s` in isolation and then remove it.
+    s = s.replaceAll(/([a-zA-Z\d]+)'([ts])(\s|$)/g, '$1$2$3');
+    s = s.replace(patternSlug, opt.separator);
+    s = s.replaceAll('\\', '');
+    if (opt.separator) {
+        s = removeMootSeparators(s, opt.separator);
+    }
+    return s;
+}
+function buildPatternSlug(options) {
+    let negationSetPattern = String.raw `a-z\d`;
+    negationSetPattern += options.lowercase ? '' : 'A-Z';
+    if (options.preserveCharacters.length > 0) {
+        for (const character of options.preserveCharacters) {
+            if (character === options.separator) {
+                throw new Error(`The separator character \`${options.separator}\` cannot be included in preserved characters: ${options.preserveCharacters}`);
+            }
+            negationSetPattern += escapeStringRegexp(character);
+        }
+    }
+    return new RegExp(`[^${negationSetPattern}]+`, 'g');
+}
+function removeMootSeparators(s, separator) {
+    const escapedSeparator = escapeStringRegexp(separator);
+    return s
+        .replaceAll(new RegExp(`${escapedSeparator}{2,}`, 'g'), separator)
+        .replaceAll(new RegExp(`^${escapedSeparator}|${escapedSeparator}$`, 'g'), '');
+}
+function decamelize(s) {
+    return (s
+        // Separate capitalized words.
+        .replaceAll(/([A-Z]{2,})(\d+)/g, '$1 $2')
+        .replaceAll(/([a-z\d]+)([A-Z]{2,})/g, '$1 $2')
+        .replaceAll(/([a-z\d])([A-Z])/g, '$1 $2')
+        // `[a-rt-z]` matches all lowercase characters except `s`.
+        // This avoids matching plural acronyms like `APIs`.
+        .replaceAll(/([A-Z]+)([A-Z][a-rt-z\d]+)/g, '$1 $2'));
+}
+// based on: https://github.com/sindresorhus/escape-string-regexp/
+function escapeStringRegexp(s) {
+    // Escape characters with special meaning either inside or outside character sets.
+    // Use a simple backslash escape when it’s always valid, and a `\xnn` escape when the simpler form would be disallowed by Unicode patterns’ stricter grammar.
+    return s.replaceAll(/[|\\{}()[\]^$+*?.]/g, String.raw `\$&`).replaceAll('-', String.raw `\x2d`);
+}

package/dist-esm/index.js

@@ -74,6 +74,7 @@ export * from './string/pupa';
 export * from './string/readingTime';
 export * from './string/regex';
 export * from './string/safeJsonStringify';
+export * from './string/slugify';
 export * from './string/string.util';
 export * from './string/stringify';
 export * from './string/url.util';

package/dist-esm/string/slugify.js

@@ -0,0 +1,66 @@
+// Credit to (adopted from): https://github.com/sindresorhus/slugify/
+export function _slugify(s, opt = {}) {
+    opt = {
+        separator: '-',
+        lowercase: true,
+        decamelize: true,
+        preserveCharacters: [],
+        ...opt,
+    };
+    if (opt.decamelize) {
+        s = decamelize(s);
+    }
+    const patternSlug = buildPatternSlug(opt);
+    if (opt.lowercase) {
+        s = s.toLowerCase();
+    }
+    // based on https://stackoverflow.com/a/23633850/4919972
+    // Combining Diacritical Marks
+    // https://www.unicode.org/charts/PDF/U0300.pdf
+    // biome-ignore lint/suspicious/noMisleadingCharacterClass: ok
+    s = s.normalize('NFKD').replaceAll(/[\u0300-\u036F]/g, '');
+    // Detect contractions/possessives by looking for any word followed by a `'t`
+    // or `'s` in isolation and then remove it.
+    s = s.replaceAll(/([a-zA-Z\d]+)'([ts])(\s|$)/g, '$1$2$3');
+    s = s.replace(patternSlug, opt.separator);
+    s = s.replaceAll('\\', '');
+    if (opt.separator) {
+        s = removeMootSeparators(s, opt.separator);
+    }
+    return s;
+}
+function buildPatternSlug(options) {
+    let negationSetPattern = String.raw `a-z\d`;
+    negationSetPattern += options.lowercase ? '' : 'A-Z';
+    if (options.preserveCharacters.length > 0) {
+        for (const character of options.preserveCharacters) {
+            if (character === options.separator) {
+                throw new Error(`The separator character \`${options.separator}\` cannot be included in preserved characters: ${options.preserveCharacters}`);
+            }
+            negationSetPattern += escapeStringRegexp(character);
+        }
+    }
+    return new RegExp(`[^${negationSetPattern}]+`, 'g');
+}
+function removeMootSeparators(s, separator) {
+    const escapedSeparator = escapeStringRegexp(separator);
+    return s
+        .replaceAll(new RegExp(`${escapedSeparator}{2,}`, 'g'), separator)
+        .replaceAll(new RegExp(`^${escapedSeparator}|${escapedSeparator}$`, 'g'), '');
+}
+function decamelize(s) {
+    return (s
+        // Separate capitalized words.
+        .replaceAll(/([A-Z]{2,})(\d+)/g, '$1 $2')
+        .replaceAll(/([a-z\d]+)([A-Z]{2,})/g, '$1 $2')
+        .replaceAll(/([a-z\d])([A-Z])/g, '$1 $2')
+        // `[a-rt-z]` matches all lowercase characters except `s`.
+        // This avoids matching plural acronyms like `APIs`.
+        .replaceAll(/([A-Z]+)([A-Z][a-rt-z\d]+)/g, '$1 $2'));
+}
+// based on: https://github.com/sindresorhus/escape-string-regexp/
+function escapeStringRegexp(s) {
+    // Escape characters with special meaning either inside or outside character sets.
+    // Use a simple backslash escape when it’s always valid, and a `\xnn` escape when the simpler form would be disallowed by Unicode patterns’ stricter grammar.
+    return s.replaceAll(/[|\\{}()[\]^$+*?.]/g, String.raw `\$&`).replaceAll('-', String.raw `\x2d`);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.252.1",
+  "version": "14.253.0",
   "scripts": {
     "prepare": "husky",
     "build": "dev-lib build-esm-cjs",

package/src/index.ts

@@ -74,6 +74,7 @@ export * from './string/pupa'
 export * from './string/readingTime'
 export * from './string/regex'
 export * from './string/safeJsonStringify'
+export * from './string/slugify'
 export * from './string/string.util'
 export * from './string/stringify'
 export * from './string/url.util'

package/src/string/slugify.ts

@@ -0,0 +1,107 @@
+// Credit to (adopted from): https://github.com/sindresorhus/slugify/
+
+export interface SlugifyOptions {
+  /**
+   * Default: `-`
+   */
+  separator?: string
+  /**
+   * Default: true
+   */
+  lowercase?: boolean
+  /**
+   * Default: true
+   */
+  decamelize?: boolean
+  /**
+   * Default: []
+   */
+  preserveCharacters?: string[]
+}
+
+export function _slugify(s: string, opt: SlugifyOptions = {}): string {
+  opt = {
+    separator: '-',
+    lowercase: true,
+    decamelize: true,
+    preserveCharacters: [],
+    ...opt,
+  }
+
+  if (opt.decamelize) {
+    s = decamelize(s)
+  }
+
+  const patternSlug = buildPatternSlug(opt)
+
+  if (opt.lowercase) {
+    s = s.toLowerCase()
+  }
+
+  // based on https://stackoverflow.com/a/23633850/4919972
+  // Combining Diacritical Marks
+  // https://www.unicode.org/charts/PDF/U0300.pdf
+  // biome-ignore lint/suspicious/noMisleadingCharacterClass: ok
+  s = s.normalize('NFKD').replaceAll(/[\u0300-\u036F]/g, '')
+
+  // Detect contractions/possessives by looking for any word followed by a `'t`
+  // or `'s` in isolation and then remove it.
+  s = s.replaceAll(/([a-zA-Z\d]+)'([ts])(\s|$)/g, '$1$2$3')
+
+  s = s.replace(patternSlug, opt.separator!)
+  s = s.replaceAll('\\', '')
+
+  if (opt.separator) {
+    s = removeMootSeparators(s, opt.separator)
+  }
+
+  return s
+}
+
+function buildPatternSlug(options: any): RegExp {
+  let negationSetPattern = String.raw`a-z\d`
+  negationSetPattern += options.lowercase ? '' : 'A-Z'
+
+  if (options.preserveCharacters.length > 0) {
+    for (const character of options.preserveCharacters) {
+      if (character === options.separator) {
+        throw new Error(
+          `The separator character \`${options.separator}\` cannot be included in preserved characters: ${options.preserveCharacters}`,
+        )
+      }
+
+      negationSetPattern += escapeStringRegexp(character)
+    }
+  }
+
+  return new RegExp(`[^${negationSetPattern}]+`, 'g')
+}
+
+function removeMootSeparators(s: string, separator: string): string {
+  const escapedSeparator = escapeStringRegexp(separator)
+
+  return s
+    .replaceAll(new RegExp(`${escapedSeparator}{2,}`, 'g'), separator)
+    .replaceAll(new RegExp(`^${escapedSeparator}|${escapedSeparator}$`, 'g'), '')
+}
+
+function decamelize(s: string): string {
+  return (
+    s
+      // Separate capitalized words.
+      .replaceAll(/([A-Z]{2,})(\d+)/g, '$1 $2')
+      .replaceAll(/([a-z\d]+)([A-Z]{2,})/g, '$1 $2')
+
+      .replaceAll(/([a-z\d])([A-Z])/g, '$1 $2')
+      // `[a-rt-z]` matches all lowercase characters except `s`.
+      // This avoids matching plural acronyms like `APIs`.
+      .replaceAll(/([A-Z]+)([A-Z][a-rt-z\d]+)/g, '$1 $2')
+  )
+}
+
+// based on: https://github.com/sindresorhus/escape-string-regexp/
+function escapeStringRegexp(s: string): string {
+  // Escape characters with special meaning either inside or outside character sets.
+  // Use a simple backslash escape when it’s always valid, and a `\xnn` escape when the simpler form would be disallowed by Unicode patterns’ stricter grammar.
+  return s.replaceAll(/[|\\{}()[\]^$+*?.]/g, String.raw`\$&`).replaceAll('-', String.raw`\x2d`)
+}