@thi.ng/strings 3.3.25 → 3.4.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-02-05T14:42:22Z
+- **Last updated**: 2023-02-27T21:43:54Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,16 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [3.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/strings@3.4.0) (2023-02-27)
+
+#### 🚀 Features
+
+- add more HTML entities ([d617132](https://github.com/thi-ng/umbrella/commit/d617132))
+
+#### 🩹 Bug fixes
+
+- add emoji ranges for slugify/slugifyGH() ([f5cb210](https://github.com/thi-ng/umbrella/commit/f5cb210))
+
 ### [3.3.3](https://github.com/thi-ng/umbrella/tree/@thi.ng/strings@3.3.3) (2022-04-07)
 
 #### ♻️ Refactoring

package/README.md

@@ -140,7 +140,7 @@ For Node.js REPL:
 const strings = await import("@thi.ng/strings");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 4.29 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 4.62 KB
 
 ## Dependencies
 

package/entities.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @remarks
+ * References:
+ * - https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references
+ * - https://www.w3.org/TR/xml-entity-names/byalpha.html
+ */
 export declare const ENTITIES: Record<string, string>;
 export declare const RE_ENTITIES: RegExp;
 export declare const ENTITIES_REV: Record<string, string>;

package/entities.js

@@ -1,22 +1,91 @@
+/**
+ * @remarks
+ * References:
+ * - https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references
+ * - https://www.w3.org/TR/xml-entity-names/byalpha.html
+ */
 export const ENTITIES = {
     "&": "&",
     "<": "&lt;",
     ">": "&gt;",
+    "≤": "&le;",
+    "≥": "&ge;",
     '"': "&quot;",
     "'": "&apos;",
     "—": "&mdash;",
     "–": "&ndash;",
     "…": "&hellip;",
+    "⋮": "&vellip;",
+    "⋯": "&ctdot;",
     "¢": "&cent;",
     "€": "&euro;",
     "£": "&pound;",
     "§": "&sect;",
+    "¶": "&para;",
     "©": "&copy;",
     "®": "&reg;",
     "™": "&trade;",
+    "◂": "&ltrif;",
+    "▸": "&rtrif;",
+    "▴": "&utrif;",
+    "▾": "&dtrif;",
+    "←": "&larr;",
+    "→": "&rarr;",
+    "↑": "&uarr;",
+    "↓": "&darr;",
+    "↵": "&crarr;",
+    "↩": "&larrhk;",
+    "⇐": "&lArr;",
+    "⇒": "&rArr;",
+    "↺": "&olarr;",
+    "↻": "&orarr;",
+    "¹": "&sup1;",
+    "²": "&sup2;",
+    "³": "&sup3;",
+    α: "&alpha;",
+    β: "&beta;",
+    γ: "&gamma;",
+    δ: "&delta;",
+    ε: "&epsi;",
+    θ: "&theta;",
+    λ: "&lambda;",
+    μ: "&mu;",
+    π: "&pi;",
+    σ: "&sigma;",
+    τ: "&tau;",
+    φ: "&phi;",
+    ω: "&omega;",
+    Δ: "&Delta;",
+    Ω: "&Omega;",
+    "∞": "&infin;",
+    "±": "&plusmn;",
+    "⨯": "&Cross;",
+    "°": "&deg;",
+    "∑": "&sum;",
+    "∏": "&prod;",
+    "∫": "&int;",
+    "√": "&radic;",
+    "∠": "&angle;",
+    "∧": "&and;",
+    "∨": "&or;",
+    "∩": "&cap;",
+    "∪": "&cup;",
+    "⊂": "&sub;",
+    "⊃": "&sup;",
+    "∈": "&isin;",
+    "∉": "&notin;",
+    "∅": "&empty;",
+    "⊕": "&oplus;",
+    "⊖": "&ominus;",
+    "⊗": "&otimes;",
+    "⌖": "&target;",
+    "☆": "&star;",
+    "★": "&starf;",
+    "✓": "&check;",
+    "✗": "&cross;",
     "\xa0": "&nbsp;",
 };
-export const RE_ENTITIES = new RegExp(`[${Object.keys(ENTITIES).join("")}]`, "g");
+export const RE_ENTITIES = new RegExp(`[${Object.keys(ENTITIES).join("")}]`, "gu");
 export const ENTITIES_REV = Object.entries(ENTITIES).reduce((acc, [k, v]) => ((acc[v] = k), acc), {});
 export const RE_ENTITIES_REV = new RegExp(`(${Object.keys(ENTITIES_REV).join("|")})`, "g");
 const $esc = (re, index) => (src) => src.replace(re, (x) => index[x]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/strings",
-  "version": "3.3.25",
+  "version": "3.4.0",
   "description": "Various string formatting & utility functions",
   "type": "module",
   "module": "./index.js",
@@ -34,14 +34,14 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.7.1",
-    "@thi.ng/errors": "^2.2.10",
-    "@thi.ng/hex": "^2.3.5",
-    "@thi.ng/memoize": "^3.1.24"
+    "@thi.ng/api": "^8.7.2",
+    "@thi.ng/errors": "^2.2.11",
+    "@thi.ng/hex": "^2.3.6",
+    "@thi.ng/memoize": "^3.1.25"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.34.2",
-    "@thi.ng/testament": "^0.3.10",
+    "@thi.ng/testament": "^0.3.11",
     "rimraf": "^4.1.2",
     "tools": "^0.0.1",
     "typedoc": "^0.23.24",
@@ -200,5 +200,5 @@
   "thi.ng": {
     "year": 2015
   },
-  "gitHead": "2b5a99a8af71670780875637299be9118b01084d\n"
+  "gitHead": "060a3a69281094df70be0e4f326a0ac3bbc3dd1d\n"
 }

package/slugify.d.ts

@@ -5,7 +5,7 @@ import type { Stringer } from "./api.js";
  *
  * @example
  * ```ts
- * slugify("Me, myself (& ëye)!")
+ * slugify("Me, myself (& ëye) 😀!")
  * // "me-myself-and-eye"
  * ```
  *
@@ -18,8 +18,8 @@ export declare const slugify: Stringer<string>;
  *
  * @example
  * ```ts
- * slugifyGH("Me, myself (& ëye)!")
- * // "me-myself--ëye"
+ * slugifyGH("Me, myself (& ëye) 😀!")
+ * // "me-myself--ëye-"
  * ```
  *
  * @param str -

package/slugify.js

@@ -7,21 +7,23 @@ const re = new RegExp(src.split("").join("|"), "g");
  *
  * @example
  * ```ts
- * slugify("Me, myself (& ëye)!")
+ * slugify("Me, myself (& ëye) 😀!")
  * // "me-myself-and-eye"
  * ```
  *
  * @param str -
  */
 export const slugify = (str) => {
-    return str
+    return (str
         .toLowerCase()
         .replace(/\s+/g, "-")
         .replace(re, (c) => dest[src.indexOf(c)])
         .replace(/&+/g, "-and-")
         .replace(/[^\w\-]+/g, "")
+        // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Unicode_Property_Escapes
+        .replace(/\p{Emoji_Presentation}/gu, "")
         .replace(/\-{2,}/g, "-")
-        .replace(/(^-+)|(-+$)/g, "");
+        .replace(/(^-+)|(-+$)/g, ""));
 };
 /**
  * Similar to {@link slugify}, however uses GitHub's anchor naming rules
@@ -29,8 +31,8 @@ export const slugify = (str) => {
  *
  * @example
  * ```ts
- * slugifyGH("Me, myself (& ëye)!")
- * // "me-myself--ëye"
+ * slugifyGH("Me, myself (& ëye) 😀!")
+ * // "me-myself--ëye-"
  * ```
  *
  * @param str -
@@ -44,5 +46,7 @@ export const slugifyGH = (str) => {
         // - https://www.unicode.org/charts/PDF/U2700.pdf (dingbats)
         // - https://www.unicode.org/charts/PDF/U2E00.pdf (supplemental)
         .replace(/[!"#$%&'()*+,./:;<=>?@\[\\\]^`{|}~\u0000-\u001f\u2000-\u206f\u2700-\u27bf\u2e00-\u2e7f]/g, "")
+        // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Unicode_Property_Escapes
+        .replace(/\p{Emoji_Presentation}/gu, "")
         .replace(/\s/g, "-"));
 };