@thi.ng/strings 3.0.0 → 3.1.2

package/CHANGELOG.md

@@ -3,6 +3,57 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.1.2](https://github.com/thi-ng/umbrella/compare/@thi.ng/strings@3.1.1...@thi.ng/strings@3.1.2) (2021-10-28)
+
+**Note:** Version bump only for package @thi.ng/strings
+
+
+
+
+
+## [3.1.1](https://github.com/thi-ng/umbrella/compare/@thi.ng/strings@3.1.0...@thi.ng/strings@3.1.1) (2021-10-28)
+
+**Note:** Version bump only for package @thi.ng/strings
+
+
+
+
+
+# [3.1.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/strings@3.0.3...@thi.ng/strings@3.1.0) (2021-10-25)
+
+
+### Features
+
+* **strings:** migrate/add entities, regexes, fns ([57c246d](https://github.com/thi-ng/umbrella/commit/57c246df06279a2e70cfb28ce34ff8d9666b0199))
+
+
+
+
+
+## [3.0.3](https://github.com/thi-ng/umbrella/compare/@thi.ng/strings@3.0.2...@thi.ng/strings@3.0.3) (2021-10-15)
+
+**Note:** Version bump only for package @thi.ng/strings
+
+
+
+
+
+## [3.0.2](https://github.com/thi-ng/umbrella/compare/@thi.ng/strings@3.0.1...@thi.ng/strings@3.0.2) (2021-10-15)
+
+**Note:** Version bump only for package @thi.ng/strings
+
+
+
+
+
+## [3.0.1](https://github.com/thi-ng/umbrella/compare/@thi.ng/strings@3.0.0...@thi.ng/strings@3.0.1) (2021-10-13)
+
+**Note:** Version bump only for package @thi.ng/strings
+
+
+
+
+
 # [3.0.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/strings@2.1.7...@thi.ng/strings@3.0.0) (2021-10-12)
 
 

package/README.md

@@ -133,15 +133,16 @@ ES module import:
 
 [Skypack documentation](https://docs.skypack.dev/)
 
-For NodeJS (v14.6+):
+For Node.js REPL:
 
 ```text
-node --experimental-specifier-resolution=node --experimental-repl-await
+# with flag only for < v16
+node --experimental-repl-await
 
 > const strings = await import("@thi.ng/strings");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 4.12 KB
+Package sizes (gzipped, pre-treeshake): ESM: 4.38 KB
 
 ## Dependencies
 

package/case.d.ts

@@ -1,4 +1,4 @@
-import type { FnS, Stringer } from "./api";
+import type { FnS, Stringer } from "./api.js";
 /**
  * Uppercase string formatter.
  *

package/center.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 /**
  * Returns stringer which pads given input with `ch` (default: space) on
  * both sides and returns fixed width string of given `lineWidth`.

package/center.js

@@ -1,6 +1,6 @@
 import { memoizeJ } from "@thi.ng/memoize/memoizej";
-import { repeat } from "./repeat";
-import { truncate } from "./truncate";
+import { repeat } from "./repeat.js";
+import { truncate } from "./truncate.js";
 /**
  * Returns stringer which pads given input with `ch` (default: space) on
  * both sides and returns fixed width string of given `lineWidth`.

package/entities.d.ts

@@ -0,0 +1,7 @@
+export declare const ENTITIES: Record<string, string>;
+export declare const RE_ENTITIES: RegExp;
+export declare const ENTITIES_REV: Record<string, string>;
+export declare const RE_ENTITIES_REV: RegExp;
+export declare const escapeEntities: (src: string) => string;
+export declare const unescapeEntities: (src: string) => string;
+//# sourceMappingURL=entities.d.ts.map

package/entities.js

@@ -0,0 +1,24 @@
+export const ENTITIES = {
+    "&": "&",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': "&quot;",
+    "'": "&apos;",
+    "—": "&mdash;",
+    "–": "&ndash;",
+    "…": "&hellip;",
+    "¢": "&cent;",
+    "€": "&euro;",
+    "£": "&pound;",
+    "§": "&sect;",
+    "©": "&copy;",
+    "®": "&reg;",
+    "™": "&trade;",
+    "\xa0": "&nbsp;",
+};
+export const RE_ENTITIES = new RegExp(`[${Object.keys(ENTITIES).join("")}]`, "g");
+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]);
+export const escapeEntities = $esc(RE_ENTITIES, ENTITIES);
+export const unescapeEntities = $esc(RE_ENTITIES_REV, ENTITIES_REV);

package/escape.js

@@ -1,4 +1,4 @@
-import { U16, U32 } from "./radix";
+import { U16, U32 } from "./radix.js";
 export const ESCAPES = {
     0: "\0",
     b: "\b",

package/float.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 /**
  * Returns {@link Stringer} which formats numbers to given precision. If
  * `special` is true, then exceptional handling for:

package/float.js

@@ -1,5 +1,5 @@
 import { memoizeJ } from "@thi.ng/memoize/memoizej";
-import { padLeft } from "./pad-left";
+import { padLeft } from "./pad-left.js";
 /**
  * Returns {@link Stringer} which formats numbers to given precision. If
  * `special` is true, then exceptional handling for:

package/groups.js

@@ -1,4 +1,4 @@
-import { charRange } from "./range";
+import { charRange } from "./range.js";
 const defGroup = (...xs) => {
     const acc = {};
     for (let range of xs) {

package/hollerith.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 /**
  * Formats given value `x` as Fortran style Hollerith string.
  *

package/index.d.ts

@@ -1,36 +1,37 @@
-export * from "./api";
-export * from "./ansi";
-export * from "./case";
-export * from "./center";
-export * from "./cursor";
-export * from "./escape";
-export * from "./float";
-export * from "./format";
-export * from "./groups";
-export * from "./hollerith";
-export * from "./initials";
-export * from "./int";
-export * from "./interpolate";
-export * from "./join";
-export * from "./pad-left";
-export * from "./pad-right";
-export * from "./parse";
-export * from "./percent";
-export * from "./radix";
-export * from "./range";
-export * from "./repeat";
-export * from "./ruler";
-export * from "./slugify";
-export * from "./splice";
-export * from "./split";
-export * from "./stringify";
-export * from "./tabs";
-export * from "./trim";
-export * from "./truncate";
-export * from "./truncate-left";
-export * from "./units";
-export * from "./uuid";
-export * from "./vector";
-export * from "./wrap";
-export * from "./word-wrap";
+export * from "./api.js";
+export * from "./ansi.js";
+export * from "./case.js";
+export * from "./center.js";
+export * from "./cursor.js";
+export * from "./entities.js";
+export * from "./escape.js";
+export * from "./float.js";
+export * from "./format.js";
+export * from "./groups.js";
+export * from "./hollerith.js";
+export * from "./initials.js";
+export * from "./int.js";
+export * from "./interpolate.js";
+export * from "./join.js";
+export * from "./pad-left.js";
+export * from "./pad-right.js";
+export * from "./parse.js";
+export * from "./percent.js";
+export * from "./radix.js";
+export * from "./range.js";
+export * from "./repeat.js";
+export * from "./ruler.js";
+export * from "./slugify.js";
+export * from "./splice.js";
+export * from "./split.js";
+export * from "./stringify.js";
+export * from "./tabs.js";
+export * from "./trim.js";
+export * from "./truncate.js";
+export * from "./truncate-left.js";
+export * from "./units.js";
+export * from "./uuid.js";
+export * from "./vector.js";
+export * from "./wrap.js";
+export * from "./word-wrap.js";
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -1,35 +1,36 @@
-export * from "./api";
-export * from "./ansi";
-export * from "./case";
-export * from "./center";
-export * from "./cursor";
-export * from "./escape";
-export * from "./float";
-export * from "./format";
-export * from "./groups";
-export * from "./hollerith";
-export * from "./initials";
-export * from "./int";
-export * from "./interpolate";
-export * from "./join";
-export * from "./pad-left";
-export * from "./pad-right";
-export * from "./parse";
-export * from "./percent";
-export * from "./radix";
-export * from "./range";
-export * from "./repeat";
-export * from "./ruler";
-export * from "./slugify";
-export * from "./splice";
-export * from "./split";
-export * from "./stringify";
-export * from "./tabs";
-export * from "./trim";
-export * from "./truncate";
-export * from "./truncate-left";
-export * from "./units";
-export * from "./uuid";
-export * from "./vector";
-export * from "./wrap";
-export * from "./word-wrap";
+export * from "./api.js";
+export * from "./ansi.js";
+export * from "./case.js";
+export * from "./center.js";
+export * from "./cursor.js";
+export * from "./entities.js";
+export * from "./escape.js";
+export * from "./float.js";
+export * from "./format.js";
+export * from "./groups.js";
+export * from "./hollerith.js";
+export * from "./initials.js";
+export * from "./int.js";
+export * from "./interpolate.js";
+export * from "./join.js";
+export * from "./pad-left.js";
+export * from "./pad-right.js";
+export * from "./parse.js";
+export * from "./percent.js";
+export * from "./radix.js";
+export * from "./range.js";
+export * from "./repeat.js";
+export * from "./ruler.js";
+export * from "./slugify.js";
+export * from "./splice.js";
+export * from "./split.js";
+export * from "./stringify.js";
+export * from "./tabs.js";
+export * from "./trim.js";
+export * from "./truncate.js";
+export * from "./truncate-left.js";
+export * from "./units.js";
+export * from "./uuid.js";
+export * from "./vector.js";
+export * from "./wrap.js";
+export * from "./word-wrap.js";

package/int.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 export declare const int: Stringer<number>;
 export declare const intLocale: (locale?: string) => Stringer<number>;
 //# sourceMappingURL=int.d.ts.map

package/join.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 /**
  * Higher-order version of `Array.join()`. Takes separator string `sep`
  * and returns function which accepts an array and joins all elements w/

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thi.ng/strings",
-    "version": "3.0.0",
+    "version": "3.1.2",
     "description": "Various string formatting & utility functions",
     "type": "module",
     "module": "./index.js",
@@ -34,13 +34,13 @@
         "test": "testament test"
     },
     "dependencies": {
-        "@thi.ng/api": "^8.0.0",
-        "@thi.ng/errors": "^2.0.0",
-        "@thi.ng/hex": "^2.0.0",
-        "@thi.ng/memoize": "^3.0.0"
+        "@thi.ng/api": "^8.0.6",
+        "@thi.ng/errors": "^2.0.6",
+        "@thi.ng/hex": "^2.0.6",
+        "@thi.ng/memoize": "^3.0.6"
     },
     "devDependencies": {
-        "@thi.ng/testament": "^0.1.0"
+        "@thi.ng/testament": "^0.1.6"
     },
     "keywords": [
         "ansi",
@@ -69,6 +69,9 @@
     "publishConfig": {
         "access": "public"
     },
+    "engines": {
+        "node": ">=12.7"
+    },
     "files": [
         "*.js",
         "*.d.ts"
@@ -92,6 +95,9 @@
         "./cursor": {
             "import": "./cursor.js"
         },
+        "./entities": {
+            "import": "./entities.js"
+        },
         "./escape": {
             "import": "./escape.js"
         },
@@ -186,5 +192,5 @@
     "thi.ng": {
         "year": 2015
     },
-    "gitHead": "9ac1344b38b565eb894306fbf72233b6c0b2d115"
+    "gitHead": "c17a556ad25f6882dfa8f806a1d9e8ed7ac7cd71"
 }

package/pad-left.js

@@ -1,5 +1,5 @@
 import { memoizeJ } from "@thi.ng/memoize/memoizej";
-import { repeat } from "./repeat";
+import { repeat } from "./repeat.js";
 /**
  * @param n - target length
  * @param ch - pad character(s)

package/pad-right.js

@@ -1,5 +1,5 @@
 import { memoizeJ } from "@thi.ng/memoize/memoizej";
-import { repeat } from "./repeat";
+import { repeat } from "./repeat.js";
 /**
  * @param n - target length
  * @param ch - pad character(s)

package/percent.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 /**
  * Returns {@link Stringer} which formats given fractions as percentage (e.g.
  * `0.1234 => 12.34%`).

package/radix.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 /**
  * Returns a {@link Stringer} which formats given numbers to `radix`, `len` and
  * with optional prefix (not included in `len`).

package/radix.js

@@ -1,6 +1,6 @@
 import { U16 as $16, U24 as $24, U32 as $32, U64HL, U8 as $8, } from "@thi.ng/hex";
 import { memoizeJ } from "@thi.ng/memoize/memoizej";
-import { repeat } from "./repeat";
+import { repeat } from "./repeat.js";
 /**
  * Returns a {@link Stringer} which formats given numbers to `radix`, `len` and
  * with optional prefix (not included in `len`).

package/ruler.js

@@ -1,4 +1,4 @@
-import { repeat } from "./repeat";
+import { repeat } from "./repeat.js";
 /**
  * Returns a ruler-like string of given `width`, using `a` character for major
  * ticks and `b` for minor ticks.

package/slugify.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 /**
  * Based on:
  * {@link https://medium.com/@matthagemann/the-ultimate-way-to-slugify-a-url-string-in-javascript-b8e4a0d849e1}

package/stringify.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 /**
  * Higher order version of `JSON.stringify()` with the option to treat strings
  * and numbers differently. If `all` is `false` (default), strings and numbers

package/tabs.js

@@ -1,4 +1,4 @@
-import { repeat } from "./repeat";
+import { repeat } from "./repeat.js";
 const nextTab = (x, tabSize) => Math.floor((x + tabSize) / tabSize) * tabSize;
 /**
  * Multi-line version of {@link tabsToSpacesLine}.

package/trim.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 /**
  * Higher order trim function (both sides) with support for user defined
  * trimmable characters (default: whitespace only).

package/truncate-left.d.ts

@@ -1,3 +1,3 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 export declare const truncateLeft: (n: number, prefix?: string) => Stringer<string>;
 //# sourceMappingURL=truncate-left.d.ts.map

package/truncate.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 export declare const truncate: (n: number, suffix?: string) => Stringer<string>;
 /**
  * Alias for {@link truncate}

package/units.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 declare type UnitDefs = [number, string, number?][];
 export declare const units: (exp: UnitDefs, base: string, prec?: number) => Stringer<number>;
 export declare const bits: Stringer<number>;

package/vector.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 /**
  * Higher order formatter for n-D vectors, with each element formatted using
  * `prec` and using optional delimiter and pre/postfixes.

package/vector.js

@@ -1,5 +1,5 @@
 import { memoizeJ } from "@thi.ng/memoize/memoizej";
-import { float } from "./float";
+import { float } from "./float.js";
 /**
  * Higher order formatter for n-D vectors, with each element formatted using
  * `prec` and using optional delimiter and pre/postfixes.

package/word-wrap.d.ts

@@ -1,4 +1,4 @@
-import type { IWordSplit, WordWrapOpts } from "./api";
+import type { IWordSplit, WordWrapOpts } from "./api.js";
 /**
  * Internal representation of a single line (for word wrapping purposes). A thin
  * wrapper of individual word and the _logical_ line length (rather than the

package/word-wrap.js

@@ -1,5 +1,5 @@
-import { lengthAnsi } from "./ansi";
-import { split } from "./split";
+import { lengthAnsi } from "./ansi.js";
+import { split } from "./split.js";
 /**
  * Internal representation of a single line (for word wrapping purposes). A thin
  * wrapper of individual word and the _logical_ line length (rather than the
@@ -8,9 +8,9 @@ import { split } from "./split";
  * @internal
  */
 class Line {
-    n = 0;
-    w = [];
     constructor(word, n) {
+        this.n = 0;
+        this.w = [];
         word != null && this.add(word, n);
     }
     add(word, n = word.length) {

package/wrap.d.ts

@@ -1,4 +1,4 @@
-import type { Stringer } from "./api";
+import type { Stringer } from "./api.js";
 /**
  * Returns a {@link Stringer} which wrap inputs with given `pad` string on
  * both sides.