@thi.ng/parse 2.1.9 → 2.2.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-06-09T16:14:01Z
+- **Last updated**: 2022-06-15T13:10:05Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,15 @@ 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.
 
+## [2.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/parse@2.2.0) (2022-06-15)
+
+#### 🚀 Features
+
+- add new transformers (json, numbers) ([2087131](https://github.com/thi-ng/umbrella/commit/2087131))
+  - add xfJson(), json() transform
+  - add int(), hexInt(), float() transform syntax sugar
+  - add `json` as built-in tx for grammar
+
 ### [2.1.8](https://github.com/thi-ng/umbrella/tree/@thi.ng/parse@2.1.8) (2022-06-09)
 
 #### ♻️ Refactoring

package/README.md

@@ -90,7 +90,7 @@ node --experimental-repl-await
 > const parse = await import("@thi.ng/parse");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 5.41 KB
+Package sizes (gzipped, pre-treeshake): ESM: 5.48 KB
 
 ## Dependencies
 
@@ -209,8 +209,10 @@ Syntax sugars for `xform(parser, fn)`:
 - `collect` - collect child results into array
 - `count` - count number of children
 - `discard` - discard result
+- `float` / `int` / `hexInt` - join child results and parse as number
 - `hoist` / `hoistResult` - hoist first child / child result
 - `join` - join child results into string
+- `json` - join child results into string and parse as JSON
 - `nest` - apply another parser to result
 - `print` - print AST
 - `replace` - replace AST node result w/ pre-configured value
@@ -373,12 +375,13 @@ transforms](#transformers):
 - `binary` - parse as binary number
 - `collect` - collect sub terms into array
 - `discard` - discard result
+- `float` - join & parse as floating point number
+- `hex` - join & parse as hex integer
 - `hoist` - replace AST node with its 1st child
 - `hoistR` - use result of 1st child term only
+- `int` - join & parse as integer
 - `join` - join sub terms into single string
-- `float` - parse as floating point number
-- `int` - parse as integer
-- `hex` - parse as hex int
+- `json` - join & parse as JSON
 - `print` - print out node's subtree (AST)
 - `trim` - trim result
 

package/grammar.js

@@ -30,6 +30,7 @@ import { xfCount } from "./xform/count.js";
 import { discard, xfDiscard } from "./xform/discard.js";
 import { hoist, hoistResult, xfHoist, xfHoistResult } from "./xform/hoist.js";
 import { join, xfJoin } from "./xform/join.js";
+import { xfJson } from "./xform/json.js";
 import { nest } from "./xform/nest.js";
 import { xfFloat, xfInt } from "./xform/number.js";
 import { print, xfPrint } from "./xform/print.js";
@@ -248,6 +249,7 @@ export const defGrammar = (rules, env, opts) => {
         hoistR: xfHoistResult,
         int: xfInt(10),
         join: xfJoin,
+        json: xfJson,
         print: xfPrint(),
         trim: xfTrim,
         ...env,

package/index.d.ts

@@ -41,6 +41,7 @@ export * from "./xform/count.js";
 export * from "./xform/discard.js";
 export * from "./xform/hoist.js";
 export * from "./xform/join.js";
+export * from "./xform/json.js";
 export * from "./xform/nest.js";
 export * from "./xform/number.js";
 export * from "./xform/print.js";

package/index.js

@@ -41,6 +41,7 @@ export * from "./xform/count.js";
 export * from "./xform/discard.js";
 export * from "./xform/hoist.js";
 export * from "./xform/join.js";
+export * from "./xform/json.js";
 export * from "./xform/nest.js";
 export * from "./xform/number.js";
 export * from "./xform/print.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/parse",
-  "version": "2.1.9",
+  "version": "2.2.0",
   "description": "Purely functional parser combinators & AST generation for generic inputs",
   "type": "module",
   "module": "./index.js",
@@ -212,6 +212,9 @@
     "./xform/join": {
       "default": "./xform/join.js"
     },
+    "./xform/json": {
+      "default": "./xform/json.js"
+    },
     "./xform/nest": {
       "default": "./xform/nest.js"
     },
@@ -238,5 +241,5 @@
     ],
     "year": 2020
   },
-  "gitHead": "ab0188234419f2d9f471de80871df930e5555bd6\n"
+  "gitHead": "2ce8e0bd338c781f3ad48e125d8af893ab74bb6c\n"
 }

package/xform/json.d.ts

@@ -0,0 +1,15 @@
+import type { Parser, ScopeTransform } from "../api.js";
+/**
+ * First joins all children via {@link xfJoin}, then parses resulting string
+ * using `JSON.parse()`.
+ *
+ * @param scope -
+ */
+export declare const xfJson: ScopeTransform<string>;
+/**
+ * Syntax sugar for `xform(parser, xfJson)`.
+ *
+ * @param parser -
+ */
+export declare const json: (parser: Parser<string>) => Parser<string>;
+//# sourceMappingURL=json.d.ts.map

package/xform/json.js

@@ -0,0 +1,18 @@
+import { xform } from "../combinators/xform.js";
+import { xfJoin } from "./join.js";
+/**
+ * First joins all children via {@link xfJoin}, then parses resulting string
+ * using `JSON.parse()`.
+ *
+ * @param scope -
+ */
+export const xfJson = (scope) => {
+    scope.result = JSON.parse(xfJoin(scope).result);
+    return scope;
+};
+/**
+ * Syntax sugar for `xform(parser, xfJson)`.
+ *
+ * @param parser -
+ */
+export const json = (parser) => xform(parser, xfJson);

package/xform/number.d.ts

@@ -1,4 +1,4 @@
-import type { ScopeTransform } from "../api.js";
+import type { Parser, ScopeTransform } from "../api.js";
 /**
  * Higher order transform. First joins all children via {@link xfJoin},
  * then parses resulting string into an integer with given `radix`.
@@ -6,6 +6,18 @@ import type { ScopeTransform } from "../api.js";
  * @param radix -
  */
 export declare const xfInt: (radix?: number) => ScopeTransform<string>;
+/**
+ * Syntax sugar for `xform(parser, xfInt(10))`
+ *
+ * @param parser
+ */
+export declare const int: (parser: Parser<string>) => Parser<string>;
+/**
+ * Syntax sugar for `xform(parser, xfInt(16))`
+ *
+ * @param parser
+ */
+export declare const hexInt: (parser: Parser<string>) => Parser<string>;
 /**
  * First joins all children via {@link xfJoin}, then parses resulting
  * string into a floating point value.
@@ -13,4 +25,10 @@ export declare const xfInt: (radix?: number) => ScopeTransform<string>;
  * @param scope -
  */
 export declare const xfFloat: ScopeTransform<string>;
+/**
+ * Syntax sugar for `xform(parser, xfFloat)`
+ *
+ * @param parser
+ */
+export declare const float: (parser: Parser<string>) => Parser<string>;
 //# sourceMappingURL=number.d.ts.map

package/xform/number.js

@@ -1,3 +1,4 @@
+import { xform } from "../combinators/xform.js";
 import { xfJoin } from "./join.js";
 /**
  * Higher order transform. First joins all children via {@link xfJoin},
@@ -9,6 +10,18 @@ export const xfInt = (radix = 10) => (scope) => {
     scope.result = parseInt(xfJoin(scope).result, radix);
     return scope;
 };
+/**
+ * Syntax sugar for `xform(parser, xfInt(10))`
+ *
+ * @param parser
+ */
+export const int = (parser) => xform(parser, xfInt(10));
+/**
+ * Syntax sugar for `xform(parser, xfInt(16))`
+ *
+ * @param parser
+ */
+export const hexInt = (parser) => xform(parser, xfInt(16));
 /**
  * First joins all children via {@link xfJoin}, then parses resulting
  * string into a floating point value.
@@ -19,3 +32,9 @@ export const xfFloat = (scope) => {
     scope.result = parseFloat(xfJoin(scope).result);
     return scope;
 };
+/**
+ * Syntax sugar for `xform(parser, xfFloat)`
+ *
+ * @param parser
+ */
+export const float = (parser) => xform(parser, xfFloat);