yaml 2.0.0-7 → 2.0.0

package/dist/visit.js

@@ -36,29 +36,14 @@ const REMOVE = Symbol('remove node');
  * specific defined one will be used for each node.
  */
 function visit(node, visitor) {
-    if (typeof visitor === 'object' &&
-        (visitor.Collection || visitor.Node || visitor.Value)) {
-        visitor = Object.assign({
-            Alias: visitor.Node,
-            Map: visitor.Node,
-            Scalar: visitor.Node,
-            Seq: visitor.Node
-        }, visitor.Value && {
-            Map: visitor.Value,
-            Scalar: visitor.Value,
-            Seq: visitor.Value
-        }, visitor.Collection && {
-            Map: visitor.Collection,
-            Seq: visitor.Collection
-        }, visitor);
-    }
+    const visitor_ = initVisitor(visitor);
     if (Node.isDocument(node)) {
-        const cd = _visit(null, node.contents, visitor, Object.freeze([node]));
+        const cd = visit_(null, node.contents, visitor_, Object.freeze([node]));
         if (cd === REMOVE)
             node.contents = null;
     }
     else
-        _visit(null, node, visitor, Object.freeze([]));
+        visit_(null, node, visitor_, Object.freeze([]));
 }
 // Without the `as symbol` casts, TS declares these in the `visit`
 // namespace using `var`, but then complains about that because
@@ -69,55 +54,104 @@ visit.BREAK = BREAK;
 visit.SKIP = SKIP;
 /** Remove the current node */
 visit.REMOVE = REMOVE;
-function _visit(key, node, visitor, path) {
-    let ctrl = undefined;
-    if (typeof visitor === 'function')
-        ctrl = visitor(key, node, path);
-    else if (Node.isMap(node)) {
-        if (visitor.Map)
-            ctrl = visitor.Map(key, node, path);
-    }
-    else if (Node.isSeq(node)) {
-        if (visitor.Seq)
-            ctrl = visitor.Seq(key, node, path);
-    }
-    else if (Node.isPair(node)) {
-        if (visitor.Pair)
-            ctrl = visitor.Pair(key, node, path);
+function visit_(key, node, visitor, path) {
+    const ctrl = callVisitor(key, node, visitor, path);
+    if (Node.isNode(ctrl) || Node.isPair(ctrl)) {
+        replaceNode(key, path, ctrl);
+        return visit_(key, ctrl, visitor, path);
     }
-    else if (Node.isScalar(node)) {
-        if (visitor.Scalar)
-            ctrl = visitor.Scalar(key, node, path);
+    if (typeof ctrl !== 'symbol') {
+        if (Node.isCollection(node)) {
+            path = Object.freeze(path.concat(node));
+            for (let i = 0; i < node.items.length; ++i) {
+                const ci = visit_(i, node.items[i], visitor, path);
+                if (typeof ci === 'number')
+                    i = ci - 1;
+                else if (ci === BREAK)
+                    return BREAK;
+                else if (ci === REMOVE) {
+                    node.items.splice(i, 1);
+                    i -= 1;
+                }
+            }
+        }
+        else if (Node.isPair(node)) {
+            path = Object.freeze(path.concat(node));
+            const ck = visit_('key', node.key, visitor, path);
+            if (ck === BREAK)
+                return BREAK;
+            else if (ck === REMOVE)
+                node.key = null;
+            const cv = visit_('value', node.value, visitor, path);
+            if (cv === BREAK)
+                return BREAK;
+            else if (cv === REMOVE)
+                node.value = null;
+        }
     }
-    else if (Node.isAlias(node)) {
-        if (visitor.Alias)
-            ctrl = visitor.Alias(key, node, path);
+    return ctrl;
+}
+/**
+ * Apply an async visitor to an AST node or document.
+ *
+ * Walks through the tree (depth-first) starting from `node`, calling a
+ * `visitor` function with three arguments:
+ *   - `key`: For sequence values and map `Pair`, the node's index in the
+ *     collection. Within a `Pair`, `'key'` or `'value'`, correspondingly.
+ *     `null` for the root node.
+ *   - `node`: The current node.
+ *   - `path`: The ancestry of the current node.
+ *
+ * The return value of the visitor may be used to control the traversal:
+ *   - `Promise`: Must resolve to one of the following values
+ *   - `undefined` (default): Do nothing and continue
+ *   - `visit.SKIP`: Do not visit the children of this node, continue with next
+ *     sibling
+ *   - `visit.BREAK`: Terminate traversal completely
+ *   - `visit.REMOVE`: Remove the current node, then continue with the next one
+ *   - `Node`: Replace the current node, then continue by visiting it
+ *   - `number`: While iterating the items of a sequence or map, set the index
+ *     of the next step. This is useful especially if the index of the current
+ *     node has changed.
+ *
+ * If `visitor` is a single function, it will be called with all values
+ * encountered in the tree, including e.g. `null` values. Alternatively,
+ * separate visitor functions may be defined for each `Map`, `Pair`, `Seq`,
+ * `Alias` and `Scalar` node. To define the same visitor function for more than
+ * one node type, use the `Collection` (map and seq), `Value` (map, seq & scalar)
+ * and `Node` (alias, map, seq & scalar) targets. Of all these, only the most
+ * specific defined one will be used for each node.
+ */
+async function visitAsync(node, visitor) {
+    const visitor_ = initVisitor(visitor);
+    if (Node.isDocument(node)) {
+        const cd = await visitAsync_(null, node.contents, visitor_, Object.freeze([node]));
+        if (cd === REMOVE)
+            node.contents = null;
     }
+    else
+        await visitAsync_(null, node, visitor_, Object.freeze([]));
+}
+// Without the `as symbol` casts, TS declares these in the `visit`
+// namespace using `var`, but then complains about that because
+// `unique symbol` must be `const`.
+/** Terminate visit traversal completely */
+visitAsync.BREAK = BREAK;
+/** Do not visit the children of the current node */
+visitAsync.SKIP = SKIP;
+/** Remove the current node */
+visitAsync.REMOVE = REMOVE;
+async function visitAsync_(key, node, visitor, path) {
+    const ctrl = await callVisitor(key, node, visitor, path);
     if (Node.isNode(ctrl) || Node.isPair(ctrl)) {
-        const parent = path[path.length - 1];
-        if (Node.isCollection(parent)) {
-            parent.items[key] = ctrl;
-        }
-        else if (Node.isPair(parent)) {
-            if (key === 'key')
-                parent.key = ctrl;
-            else
-                parent.value = ctrl;
-        }
-        else if (Node.isDocument(parent)) {
-            parent.contents = ctrl;
-        }
-        else {
-            const pt = Node.isAlias(parent) ? 'alias' : 'scalar';
-            throw new Error(`Cannot replace node with ${pt} parent`);
-        }
-        return _visit(key, ctrl, visitor, path);
+        replaceNode(key, path, ctrl);
+        return visitAsync_(key, ctrl, visitor, path);
     }
     if (typeof ctrl !== 'symbol') {
         if (Node.isCollection(node)) {
             path = Object.freeze(path.concat(node));
             for (let i = 0; i < node.items.length; ++i) {
-                const ci = _visit(i, node.items[i], visitor, path);
+                const ci = await visitAsync_(i, node.items[i], visitor, path);
                 if (typeof ci === 'number')
                     i = ci - 1;
                 else if (ci === BREAK)
@@ -130,12 +164,12 @@ function _visit(key, node, visitor, path) {
         }
         else if (Node.isPair(node)) {
             path = Object.freeze(path.concat(node));
-            const ck = _visit('key', node.key, visitor, path);
+            const ck = await visitAsync_('key', node.key, visitor, path);
             if (ck === BREAK)
                 return BREAK;
             else if (ck === REMOVE)
                 node.key = null;
-            const cv = _visit('value', node.value, visitor, path);
+            const cv = await visitAsync_('value', node.value, visitor, path);
             if (cv === BREAK)
                 return BREAK;
             else if (cv === REMOVE)
@@ -144,5 +178,60 @@ function _visit(key, node, visitor, path) {
     }
     return ctrl;
 }
+function initVisitor(visitor) {
+    if (typeof visitor === 'object' &&
+        (visitor.Collection || visitor.Node || visitor.Value)) {
+        return Object.assign({
+            Alias: visitor.Node,
+            Map: visitor.Node,
+            Scalar: visitor.Node,
+            Seq: visitor.Node
+        }, visitor.Value && {
+            Map: visitor.Value,
+            Scalar: visitor.Value,
+            Seq: visitor.Value
+        }, visitor.Collection && {
+            Map: visitor.Collection,
+            Seq: visitor.Collection
+        }, visitor);
+    }
+    return visitor;
+}
+function callVisitor(key, node, visitor, path) {
+    var _a, _b, _c, _d, _e;
+    if (typeof visitor === 'function')
+        return visitor(key, node, path);
+    if (Node.isMap(node))
+        return (_a = visitor.Map) === null || _a === void 0 ? void 0 : _a.call(visitor, key, node, path);
+    if (Node.isSeq(node))
+        return (_b = visitor.Seq) === null || _b === void 0 ? void 0 : _b.call(visitor, key, node, path);
+    if (Node.isPair(node))
+        return (_c = visitor.Pair) === null || _c === void 0 ? void 0 : _c.call(visitor, key, node, path);
+    if (Node.isScalar(node))
+        return (_d = visitor.Scalar) === null || _d === void 0 ? void 0 : _d.call(visitor, key, node, path);
+    if (Node.isAlias(node))
+        return (_e = visitor.Alias) === null || _e === void 0 ? void 0 : _e.call(visitor, key, node, path);
+    return undefined;
+}
+function replaceNode(key, path, node) {
+    const parent = path[path.length - 1];
+    if (Node.isCollection(parent)) {
+        parent.items[key] = node;
+    }
+    else if (Node.isPair(parent)) {
+        if (key === 'key')
+            parent.key = node;
+        else
+            parent.value = node;
+    }
+    else if (Node.isDocument(parent)) {
+        parent.contents = node;
+    }
+    else {
+        const pt = Node.isAlias(parent) ? 'alias' : 'scalar';
+        throw new Error(`Cannot replace node with ${pt} parent`);
+    }
+}
 
 exports.visit = visit;
+exports.visitAsync = visitAsync;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yaml",
-  "version": "2.0.0-7",
+  "version": "2.0.0",
   "license": "ISC",
   "author": "Eemeli Aro <eemeli@gmail.com>",
   "repository": "github:eemeli/yaml",
@@ -14,6 +14,7 @@
   "files": [
     "browser/",
     "dist/",
+    "util.d.ts",
     "util.js"
   ],
   "type": "commonjs",
@@ -44,9 +45,10 @@
     "prestart": "npm run build:node",
     "start": "node -i -e 'YAML=require(\"./dist/index.js\")'",
     "test": "jest --config config/jest.config.js",
+    "test:all": "npm test && npm run test:types && npm run test:dist && npm run test:dist:types",
     "test:browsers": "cd playground && npm test",
     "test:dist": "npm run build:node && jest --config config/jest.config.js",
-    "test:dist:types": "tsc --allowJs --moduleResolution node --noEmit --target es2017 dist/index.js",
+    "test:dist:types": "tsc --allowJs --moduleResolution node --noEmit --target es5 dist/index.js",
     "test:types": "tsc --noEmit",
     "docs:install": "cd docs-slate && bundle install",
     "docs:deploy": "cd docs-slate && ./deploy.sh",
@@ -68,15 +70,15 @@
     "@babel/plugin-transform-typescript": "^7.12.17",
     "@babel/preset-env": "^7.12.11",
     "@rollup/plugin-babel": "^5.2.3",
-    "@rollup/plugin-replace": "^2.3.4",
+    "@rollup/plugin-replace": "^4.0.0",
     "@rollup/plugin-typescript": "^8.1.1",
-    "@types/jest": "^26.0.20",
-    "@types/node": "^15.6.1",
-    "@typescript-eslint/eslint-plugin": "^4.15.2",
-    "@typescript-eslint/parser": "^4.15.2",
+    "@types/jest": "^27.0.1",
+    "@types/node": "^12.20.47",
+    "@typescript-eslint/eslint-plugin": "^5.3.1",
+    "@typescript-eslint/parser": "^5.3.1",
     "babel-jest": "^27.0.1",
     "cross-env": "^7.0.3",
-    "eslint": "^7.20.0",
+    "eslint": "^8.2.0",
     "eslint-config-prettier": "^8.1.0",
     "fast-check": "^2.12.0",
     "jest": "^27.0.1",
@@ -84,9 +86,9 @@
     "prettier": "^2.2.1",
     "rollup": "^2.38.2",
     "tslib": "^2.1.0",
-    "typescript": "^4.1.3"
+    "typescript": "^4.3.5"
   },
   "engines": {
-    "node": ">= 12"
+    "node": ">= 14"
   }
 }

package/util.d.ts

@@ -0,0 +1,3 @@
+// Workaround for incomplete exports support in TypeScript
+// https://github.com/microsoft/TypeScript/issues/33079
+export * from './dist/util.js'

package/browser/dist/options.js

@@ -1,17 +0,0 @@
-/**
- * `yaml` defines document-specific options in three places: as an argument of
- * parse, create and stringify calls, in the values of `YAML.defaultOptions`,
- * and in the version-dependent `YAML.Document.defaults` object. Values set in
- * `YAML.defaultOptions` override version-dependent defaults, and argument
- * options override both.
- */
-const defaultOptions = {
-    intAsBigInt: false,
-    logLevel: 'warn',
-    prettyErrors: true,
-    strict: true,
-    uniqueKeys: true,
-    version: '1.2'
-};
-
-export { defaultOptions };

package/dist/options.js

@@ -1,19 +0,0 @@
-'use strict';
-
-/**
- * `yaml` defines document-specific options in three places: as an argument of
- * parse, create and stringify calls, in the values of `YAML.defaultOptions`,
- * and in the version-dependent `YAML.Document.defaults` object. Values set in
- * `YAML.defaultOptions` override version-dependent defaults, and argument
- * options override both.
- */
-const defaultOptions = {
-    intAsBigInt: false,
-    logLevel: 'warn',
-    prettyErrors: true,
-    strict: true,
-    uniqueKeys: true,
-    version: '1.2'
-};
-
-exports.defaultOptions = defaultOptions;