yaml 1.3.2 → 1.6.0

package/README.md

@@ -2,7 +2,7 @@
 
 `yaml` is a JavaScript parser and stringifier for [YAML](http://yaml.org/), a human friendly data serialization standard. It supports both parsing and stringifying data using all versions of YAML, along with all common data schemas. As a particularly distinguishing feature, `yaml` fully supports reading and writing comments and blank lines in YAML documents.
 
-The library is released under the ISC open source license, and the code is [available on GitHub](https://github.com/eemeli/yaml/). It runs on Node.js 6 and later with no external dependencies, and in browsers from IE 11 upwards using `@babel/runtime` (Note: not included in dependencies, install separately).
+The library is released under the ISC open source license, and the code is [available on GitHub](https://github.com/eemeli/yaml/). It runs on Node.js 6 and later with no external dependencies, and in browsers from IE 11 upwards (Note: `@babel/runtime` is used only by the `"browser"` entry point).
 
 For more information, see the project's documentation site: [**eemeli.org/yaml**](https://eemeli.org/yaml/)
 
@@ -45,14 +45,12 @@ const YAML = require('yaml')
 - [`YAML.parseDocument(str, options): YAML.Document`](https://eemeli.org/yaml/#parsing-documents)
 
 ```js
-import Map from 'yaml/map'
-import Pair from 'yaml/pair'
-import Seq from 'yaml/seq'
+import { Pair, YAMLMap, YAMLSeq } from 'yaml/types'
 ```
 
-- [`new Map()`](https://eemeli.org/yaml/#creating-nodes)
 - [`new Pair(key, value)`](https://eemeli.org/yaml/#creating-nodes)
-- [`new Seq()`](https://eemeli.org/yaml/#creating-nodes)
+- [`new YAMLMap()`](https://eemeli.org/yaml/#creating-nodes)
+- [`new YAMLSeq()`](https://eemeli.org/yaml/#creating-nodes)
 
 ### CST Parser
 

package/browser/dist/Anchors.js

@@ -26,9 +26,17 @@ var _Seq = _interopRequireDefault(require("./schema/Seq"));
 var Anchors =
 /*#__PURE__*/
 function () {
-  function Anchors() {
+  (0, _createClass2.default)(Anchors, null, [{
+    key: "validAnchorNode",
+    value: function validAnchorNode(node) {
+      return node instanceof _Scalar.default || node instanceof _Seq.default || node instanceof _Map.default;
+    }
+  }]);
+
+  function Anchors(prefix) {
     (0, _classCallCheck2.default)(this, Anchors);
     (0, _defineProperty2.default)(this, "map", {});
+    this.prefix = prefix;
   }
 
   (0, _createClass2.default)(Anchors, [{
@@ -75,6 +83,7 @@ function () {
   }, {
     key: "newName",
     value: function newName(prefix) {
+      if (!prefix) prefix = this.prefix;
       var names = Object.keys(this.map);
 
       for (var i = 1; true; ++i) {
@@ -124,7 +133,7 @@ function () {
       } else {
         if (!name) {
           if (!node) return null;
-          name = this.newName('a');
+          name = this.newName();
         }
 
         map[name] = node;
@@ -132,15 +141,8 @@ function () {
 
       return name;
     }
-  }], [{
-    key: "validAnchorNode",
-    value: function validAnchorNode(node) {
-      return node instanceof _Scalar.default || node instanceof _Seq.default || node instanceof _Map.default;
-    }
   }]);
   return Anchors;
 }();
 
-exports.default = Anchors;
-module.exports = exports.default;
-module.exports.default = exports.default;
+exports.default = Anchors;

package/browser/dist/Document.js

@@ -21,7 +21,7 @@ var _addComment = _interopRequireDefault(require("./addComment"));
 
 var _Anchors = _interopRequireDefault(require("./Anchors"));
 
-var _Node = require("./cst/Node");
+var _constants = require("./constants");
 
 var _errors = require("./errors");
 
@@ -33,14 +33,14 @@ var _Alias = _interopRequireDefault(require("./schema/Alias"));
 
 var _Collection = _interopRequireWildcard(require("./schema/Collection"));
 
-var _Node2 = _interopRequireDefault(require("./schema/Node"));
+var _Node = _interopRequireDefault(require("./schema/Node"));
 
 var _Scalar = _interopRequireDefault(require("./schema/Scalar"));
 
 var _toJSON2 = _interopRequireDefault(require("./toJSON"));
 
 var isCollectionItem = function isCollectionItem(node) {
-  return node && [_Node.Type.MAP_KEY, _Node.Type.MAP_VALUE, _Node.Type.SEQ_ITEM].includes(node.type);
+  return node && [_constants.Type.MAP_KEY, _constants.Type.MAP_VALUE, _constants.Type.SEQ_ITEM].includes(node.type);
 };
 
 var Document =
@@ -48,10 +48,11 @@ var Document =
 function () {
   function Document(options) {
     (0, _classCallCheck2.default)(this, Document);
-    this.anchors = new _Anchors.default();
+    this.anchors = new _Anchors.default(options.anchorPrefix);
     this.commentBefore = null;
     this.comment = null;
     this.contents = null;
+    this.directivesEndMarker = null;
     this.errors = [];
     this.options = options;
     this.schema = null;
@@ -144,15 +145,14 @@ function () {
     }
   }, {
     key: "parse",
-    value: function parse(node) {
-      var _this = this;
-
+    value: function parse(node, prevDoc) {
       if (this.options.keepCstNodes) this.cstNode = node;
       if (this.options.keepNodeTypes) this.type = 'DOCUMENT';
       var _node$directives = node.directives,
           directives = _node$directives === void 0 ? [] : _node$directives,
           _node$contents = node.contents,
           contents = _node$contents === void 0 ? [] : _node$contents,
+          directivesEndMarker = node.directivesEndMarker,
           error = node.error,
           valueRange = node.valueRange;
 
@@ -161,7 +161,73 @@ function () {
         this.errors.push(error);
       }
 
+      this.parseDirectives(directives, prevDoc);
+      if (directivesEndMarker) this.directivesEndMarker = true;
+      this.range = valueRange ? [valueRange.start, valueRange.end] : null;
+      this.setSchema();
+      this.anchors._cstAliases = [];
+      this.parseContents(contents);
+      this.anchors.resolveNodes();
+
+      if (this.options.prettyErrors) {
+        var _iteratorNormalCompletion = true;
+        var _didIteratorError = false;
+        var _iteratorError = undefined;
+
+        try {
+          for (var _iterator = this.errors[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+            var _error = _step.value;
+            if (_error instanceof _errors.YAMLError) _error.makePretty();
+          }
+        } catch (err) {
+          _didIteratorError = true;
+          _iteratorError = err;
+        } finally {
+          try {
+            if (!_iteratorNormalCompletion && _iterator.return != null) {
+              _iterator.return();
+            }
+          } finally {
+            if (_didIteratorError) {
+              throw _iteratorError;
+            }
+          }
+        }
+
+        var _iteratorNormalCompletion2 = true;
+        var _didIteratorError2 = false;
+        var _iteratorError2 = undefined;
+
+        try {
+          for (var _iterator2 = this.warnings[Symbol.iterator](), _step2; !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next()).done); _iteratorNormalCompletion2 = true) {
+            var warn = _step2.value;
+            if (warn instanceof _errors.YAMLError) warn.makePretty();
+          }
+        } catch (err) {
+          _didIteratorError2 = true;
+          _iteratorError2 = err;
+        } finally {
+          try {
+            if (!_iteratorNormalCompletion2 && _iterator2.return != null) {
+              _iterator2.return();
+            }
+          } finally {
+            if (_didIteratorError2) {
+              throw _iteratorError2;
+            }
+          }
+        }
+      }
+
+      return this;
+    }
+  }, {
+    key: "parseDirectives",
+    value: function parseDirectives(directives, prevDoc) {
+      var _this = this;
+
       var directiveComments = [];
+      var hasDirectives = false;
       directives.forEach(function (directive) {
         var comment = directive.comment,
             name = directive.name;
@@ -170,12 +236,14 @@ function () {
           case 'TAG':
             _this.resolveTagDirective(directive);
 
+            hasDirectives = true;
             break;
 
           case 'YAML':
           case 'YAML:1.0':
             _this.resolveYamlDirective(directive);
 
+            hasDirectives = true;
             break;
 
           default:
@@ -189,10 +257,28 @@ function () {
 
         if (comment) directiveComments.push(comment);
       });
-      this.range = valueRange ? [valueRange.start, valueRange.end] : null;
-      this.setSchema();
-      this.anchors._cstAliases = [];
+
+      if (prevDoc && !hasDirectives && '1.1' === (this.version || prevDoc.version || this.options.version)) {
+        var copyTagPrefix = function copyTagPrefix(_ref) {
+          var handle = _ref.handle,
+              prefix = _ref.prefix;
+          return {
+            handle: handle,
+            prefix: prefix
+          };
+        };
+
+        this.tagPrefixes = prevDoc.tagPrefixes.map(copyTagPrefix);
+        this.version = prevDoc.version;
+      }
+
       this.commentBefore = directiveComments.join('\n') || null;
+    }
+  }, {
+    key: "parseContents",
+    value: function parseContents(contents) {
+      var _this2 = this;
+
       var comments = {
         before: [],
         after: []
@@ -204,10 +290,10 @@ function () {
           if (contentNodes.length === 1) {
             var msg = 'Document is not valid YAML (bad indentation?)';
 
-            _this.errors.push(new _errors.YAMLSyntaxError(node, msg));
+            _this2.errors.push(new _errors.YAMLSyntaxError(node, msg));
           }
 
-          var res = _this.resolveNode(node);
+          var res = _this2.resolveNode(node);
 
           if (spaceBefore) {
             res.spaceBefore = true;
@@ -218,12 +304,12 @@ function () {
         } else if (node.comment !== null) {
           var cc = contentNodes.length === 0 ? comments.before : comments.after;
           cc.push(node.comment);
-        } else if (node.type === _Node.Type.BLANK_LINE) {
+        } else if (node.type === _constants.Type.BLANK_LINE) {
           spaceBefore = true;
 
-          if (contentNodes.length === 0 && comments.before.length > 0 && !_this.commentBefore) {
+          if (contentNodes.length === 0 && comments.before.length > 0 && !_this2.commentBefore) {
             // space-separated comments at start are parsed as document comments
-            _this.commentBefore = comments.before.join('\n');
+            _this2.commentBefore = comments.before.join('\n');
             comments.before = [];
           }
         }
@@ -263,8 +349,6 @@ function () {
       }
 
       this.comment = comments.after.join('\n') || null;
-      this.anchors.resolveNodes();
-      return this;
     }
   }, {
     key: "resolveTagDirective",
@@ -373,21 +457,21 @@ function () {
       }
 
       switch (type) {
-        case _Node.Type.BLOCK_FOLDED:
-        case _Node.Type.BLOCK_LITERAL:
-        case _Node.Type.QUOTE_DOUBLE:
-        case _Node.Type.QUOTE_SINGLE:
+        case _constants.Type.BLOCK_FOLDED:
+        case _constants.Type.BLOCK_LITERAL:
+        case _constants.Type.QUOTE_DOUBLE:
+        case _constants.Type.QUOTE_SINGLE:
           return _schema.default.defaultTags.STR;
 
-        case _Node.Type.FLOW_MAP:
-        case _Node.Type.MAP:
+        case _constants.Type.FLOW_MAP:
+        case _constants.Type.MAP:
           return _schema.default.defaultTags.MAP;
 
-        case _Node.Type.FLOW_SEQ:
-        case _Node.Type.SEQ:
+        case _constants.Type.FLOW_SEQ:
+        case _constants.Type.SEQ:
           return _schema.default.defaultTags.SEQ;
 
-        case _Node.Type.PLAIN:
+        case _constants.Type.PLAIN:
           return nonSpecific ? _schema.default.defaultTags.STR : null;
 
         default:
@@ -408,22 +492,22 @@ function () {
         after: []
       };
       var props = isCollectionItem(node.context.parent) ? node.context.parent.props.concat(node.props) : node.props;
-      var _iteratorNormalCompletion = true;
-      var _didIteratorError = false;
-      var _iteratorError = undefined;
+      var _iteratorNormalCompletion3 = true;
+      var _didIteratorError3 = false;
+      var _iteratorError3 = undefined;
 
       try {
-        for (var _iterator = props[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
-          var _step$value = _step.value,
-              start = _step$value.start,
-              end = _step$value.end;
+        for (var _iterator3 = props[Symbol.iterator](), _step3; !(_iteratorNormalCompletion3 = (_step3 = _iterator3.next()).done); _iteratorNormalCompletion3 = true) {
+          var _step3$value = _step3.value,
+              start = _step3$value.start,
+              end = _step3$value.end;
 
           switch (node.context.src[start]) {
-            case _Node.Char.COMMENT:
+            case _constants.Char.COMMENT:
               {
                 if (!node.commentHasRequiredWhitespace(start)) {
-                  var _msg8 = 'Comments must be separated from other tokens by white space characters';
-                  errors.push(new _errors.YAMLSemanticError(node, _msg8));
+                  var _msg7 = 'Comments must be separated from other tokens by white space characters';
+                  errors.push(new _errors.YAMLSemanticError(node, _msg7));
                 }
 
                 var c = node.context.src.slice(start + 1, end);
@@ -438,19 +522,19 @@ function () {
               }
               break;
 
-            case _Node.Char.ANCHOR:
+            case _constants.Char.ANCHOR:
               if (hasAnchor) {
-                var _msg9 = 'A node can have at most one anchor';
-                errors.push(new _errors.YAMLSemanticError(node, _msg9));
+                var _msg8 = 'A node can have at most one anchor';
+                errors.push(new _errors.YAMLSemanticError(node, _msg8));
               }
 
               hasAnchor = true;
               break;
 
-            case _Node.Char.TAG:
+            case _constants.Char.TAG:
               if (hasTag) {
-                var _msg10 = 'A node can have at most one tag';
-                errors.push(new _errors.YAMLSemanticError(node, _msg10));
+                var _msg9 = 'A node can have at most one tag';
+                errors.push(new _errors.YAMLSemanticError(node, _msg9));
               }
 
               hasTag = true;
@@ -458,16 +542,16 @@ function () {
           }
         }
       } catch (err) {
-        _didIteratorError = true;
-        _iteratorError = err;
+        _didIteratorError3 = true;
+        _iteratorError3 = err;
       } finally {
         try {
-          if (!_iteratorNormalCompletion && _iterator.return != null) {
-            _iterator.return();
+          if (!_iteratorNormalCompletion3 && _iterator3.return != null) {
+            _iterator3.return();
           }
         } finally {
-          if (_didIteratorError) {
-            throw _iteratorError;
+          if (_didIteratorError3) {
+            throw _iteratorError3;
           }
         }
       }
@@ -486,7 +570,7 @@ function () {
 
       var res;
 
-      if (node.type === _Node.Type.ALIAS) {
+      if (node.type === _constants.Type.ALIAS) {
         if (hasAnchor || hasTag) {
           var msg = 'An alias node must not specify any properties';
           errors.push(new _errors.YAMLSemanticError(node, msg));
@@ -506,21 +590,16 @@ function () {
         res = new _Alias.default(src);
 
         anchors._cstAliases.push(res);
-
-        if (!src.resolved) {
-          var _msg6 = 'Alias node contains a circular reference, which cannot be resolved as JSON';
-          this.warnings.push(new _errors.YAMLWarning(node, _msg6));
-        }
       } else {
         var tagName = this.resolveTagName(node);
 
         if (tagName) {
           res = schema.resolveNodeWithFallback(this, node, tagName);
         } else {
-          if (node.type !== _Node.Type.PLAIN) {
-            var _msg7 = "Failed to resolve ".concat(node.type, " node here");
+          if (node.type !== _constants.Type.PLAIN) {
+            var _msg6 = "Failed to resolve ".concat(node.type, " node here");
 
-            errors.push(new _errors.YAMLSyntaxError(node, _msg7));
+            errors.push(new _errors.YAMLSyntaxError(node, _msg6));
             return null;
           }
 
@@ -613,16 +692,29 @@ function () {
   }, {
     key: "toJSON",
     value: function toJSON(arg) {
-      var cr = this.warnings.find(function (w) {
-        return /circular reference/.test(w.message);
-      });
-      if (cr) throw new _errors.YAMLSemanticError(cr.source, cr.message);
-      var keep = this.options.keepBlobsInJSON && (typeof arg !== 'string' || !(this.contents instanceof _Scalar.default));
-      var mapAsMap = keep && !!this.options.mapAsMap;
-      return (0, _toJSON2.default)(this.contents, arg, {
+      var _this3 = this;
+
+      var _this$options = this.options,
+          keepBlobsInJSON = _this$options.keepBlobsInJSON,
+          mapAsMap = _this$options.mapAsMap,
+          maxAliasCount = _this$options.maxAliasCount;
+      var keep = keepBlobsInJSON && (typeof arg !== 'string' || !(this.contents instanceof _Scalar.default));
+      var ctx = {
+        doc: this,
         keep: keep,
-        mapAsMap: mapAsMap
+        mapAsMap: keep && !!mapAsMap,
+        maxAliasCount: maxAliasCount
+      };
+      var anchorNames = Object.keys(this.anchors.map);
+      if (anchorNames.length > 0) ctx.anchors = anchorNames.map(function (name) {
+        return {
+          alias: [],
+          aliasCount: 0,
+          count: 1,
+          node: _this3.anchors.map[name]
+        };
       });
+      return (0, _toJSON2.default)(this.contents, arg, ctx);
     }
   }, {
     key: "toString",
@@ -630,7 +722,6 @@ function () {
       if (this.errors.length > 0) throw new Error('Document with errors cannot be stringified');
       this.setSchema();
       var lines = [];
-      if (this.commentBefore) lines.push(this.commentBefore.replace(/^/gm, '#'), '');
       var hasDirectives = false;
 
       if (this.version) {
@@ -645,9 +736,9 @@ function () {
       }
 
       var tagNames = this.listNonDefaultTags();
-      this.tagPrefixes.forEach(function (_ref) {
-        var handle = _ref.handle,
-            prefix = _ref.prefix;
+      this.tagPrefixes.forEach(function (_ref2) {
+        var handle = _ref2.handle,
+            prefix = _ref2.prefix;
 
         if (tagNames.some(function (t) {
           return t.indexOf(prefix) === 0;
@@ -656,7 +747,13 @@ function () {
           hasDirectives = true;
         }
       });
-      if (hasDirectives) lines.push('---');
+      if (hasDirectives || this.directivesEndMarker) lines.push('---');
+
+      if (this.commentBefore) {
+        if (hasDirectives || !this.directivesEndMarker) lines.unshift('');
+        lines.unshift(this.commentBefore.replace(/^/gm, '#'));
+      }
+
       var ctx = {
         anchors: {},
         doc: this,
@@ -666,8 +763,8 @@ function () {
       var contentComment = null;
 
       if (this.contents) {
-        if (this.contents instanceof _Node2.default) {
-          if (this.contents.spaceBefore && hasDirectives) lines.push('');
+        if (this.contents instanceof _Node.default) {
+          if (this.contents.spaceBefore && (hasDirectives || this.directivesEndMarker)) lines.push('');
           if (this.contents.commentBefore) lines.push(this.contents.commentBefore.replace(/^/gm, '#')); // top-level block scalars need to be indented if followed by a comment
 
           ctx.forceBlockIndent = !!this.comment;
@@ -731,6 +828,4 @@ exports.default = Document;
       prefix: _schema.default.defaultPrefix
     }]
   }
-});
-module.exports = exports.default;
-module.exports.default = exports.default;
+});

package/browser/dist/constants.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Type = exports.Char = void 0;
+var Char = {
+  ANCHOR: '&',
+  COMMENT: '#',
+  TAG: '!',
+  DIRECTIVES_END: '-',
+  DOCUMENT_END: '.'
+};
+exports.Char = Char;
+var Type = {
+  ALIAS: 'ALIAS',
+  BLANK_LINE: 'BLANK_LINE',
+  BLOCK_FOLDED: 'BLOCK_FOLDED',
+  BLOCK_LITERAL: 'BLOCK_LITERAL',
+  COMMENT: 'COMMENT',
+  DIRECTIVE: 'DIRECTIVE',
+  DOCUMENT: 'DOCUMENT',
+  FLOW_MAP: 'FLOW_MAP',
+  FLOW_SEQ: 'FLOW_SEQ',
+  MAP: 'MAP',
+  MAP_KEY: 'MAP_KEY',
+  MAP_VALUE: 'MAP_VALUE',
+  PLAIN: 'PLAIN',
+  QUOTE_DOUBLE: 'QUOTE_DOUBLE',
+  QUOTE_SINGLE: 'QUOTE_SINGLE',
+  SEQ: 'SEQ',
+  SEQ_ITEM: 'SEQ_ITEM'
+};
+exports.Type = Type;

package/browser/dist/cst/Alias.js

@@ -56,6 +56,4 @@ function (_Node) {
   return Alias;
 }(_Node2.default);
 
-exports.default = Alias;
-module.exports = exports.default;
-module.exports.default = exports.default;
+exports.default = Alias;

package/browser/dist/cst/BlankLine.js

@@ -1,7 +1,5 @@
 "use strict";
 
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
-
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
 Object.defineProperty(exports, "__esModule", {
@@ -19,7 +17,9 @@ var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/ge
 
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 
-var _Node2 = _interopRequireWildcard(require("./Node"));
+var _constants = require("../constants");
+
+var _Node2 = _interopRequireDefault(require("./Node"));
 
 var _Range = _interopRequireDefault(require("./Range"));
 
@@ -30,7 +30,7 @@ function (_Node) {
 
   function BlankLine() {
     (0, _classCallCheck2.default)(this, BlankLine);
-    return (0, _possibleConstructorReturn2.default)(this, (0, _getPrototypeOf2.default)(BlankLine).call(this, _Node2.Type.BLANK_LINE));
+    return (0, _possibleConstructorReturn2.default)(this, (0, _getPrototypeOf2.default)(BlankLine).call(this, _constants.Type.BLANK_LINE));
   }
 
   (0, _createClass2.default)(BlankLine, [{
@@ -66,6 +66,4 @@ function (_Node) {
   return BlankLine;
 }(_Node2.default);
 
-exports.default = BlankLine;
-module.exports = exports.default;
-module.exports.default = exports.default;
+exports.default = BlankLine;

package/browser/dist/cst/BlockValue.js

@@ -1,7 +1,5 @@
 "use strict";
 
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
-
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
 Object.defineProperty(exports, "__esModule", {
@@ -21,7 +19,9 @@ var _get2 = _interopRequireDefault(require("@babel/runtime/helpers/get"));
 
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 
-var _Node2 = _interopRequireWildcard(require("./Node"));
+var _constants = require("../constants");
+
+var _Node2 = _interopRequireDefault(require("./Node"));
 
 var _Range = _interopRequireDefault(require("./Range"));
 
@@ -222,7 +222,7 @@ function (_Node) {
       }
 
       var bi = indent + this.blockIndent;
-      var folded = this.type === _Node2.Type.BLOCK_FOLDED;
+      var folded = this.type === _constants.Type.BLOCK_FOLDED;
       var atStart = true;
       var str = '';
       var sep = '';