yaml 1.9.1 → 1.10.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yaml",
-  "version": "1.9.1",
+  "version": "1.10.2",
   "license": "ISC",
   "author": "Eemeli Aro <eemeli@gmail.com>",
   "repository": "github:eemeli/yaml",
@@ -10,7 +10,7 @@
     "parser",
     "stringifier"
   ],
-  "homepage": "https://eemeli.org/yaml/",
+  "homepage": "https://eemeli.org/yaml/v1/",
   "files": [
     "browser/",
     "dist/",
@@ -18,7 +18,7 @@
     "*.d.ts",
     "*.js",
     "*.mjs",
-    "!.*.js"
+    "!*config.js"
   ],
   "type": "commonjs",
   "main": "./index.js",
@@ -42,33 +42,33 @@
   },
   "exports": {
     ".": "./index.js",
-    "./": "./",
     "./parse-cst": "./parse-cst.js",
     "./types": [
       {
-        "default": "./types.js",
         "import": "./types.mjs"
       },
       "./types.js"
     ],
     "./util": [
       {
-        "default": "./util.js",
         "import": "./util.mjs"
       },
       "./util.js"
-    ]
+    ],
+    "./": "./"
   },
   "scripts": {
-    "browser:build": "cross-env BABEL_ENV=browser babel src/ --out-dir browser/dist/",
+    "build": "npm run build:node && npm run build:browser",
+    "build:browser": "rollup -c rollup.browser-config.js",
+    "build:node": "rollup -c rollup.node-config.js",
     "clean": "git clean -fdxe node_modules",
-    "dist:build": "babel src/ --out-dir dist/",
-    "build": "npm run dist:build && npm run browser:build",
-    "prettier": "prettier --write .",
     "lint": "eslint src/",
-    "start": "npm run dist:build && node -i -e 'YAML=require(\".\")'",
-    "test": "cross-env TRACE_LEVEL=log jest",
-    "test:trace": "cross-env TRACE_LEVEL=trace,log jest --no-cache",
+    "prettier": "prettier --write .",
+    "start": "cross-env TRACE_LEVEL=log npm run build:node && node -i -e 'YAML=require(\".\")'",
+    "test": "jest",
+    "test:browsers": "cd playground && npm test",
+    "test:dist": "npm run build:node && jest",
+    "test:types": "tsc --lib ES2017 --noEmit tests/typings.ts",
     "docs:install": "cd docs-slate && bundle install",
     "docs:deploy": "cd docs-slate && ./deploy.sh",
     "docs": "cd docs-slate && bundle exec middleman server",
@@ -76,18 +76,6 @@
     "prepublishOnly": "npm run clean && npm test && npm run build"
   },
   "browserslist": "> 0.5%, not dead",
-  "jest": {
-    "collectCoverageFrom": [
-      "src/**/*.js"
-    ],
-    "testMatch": [
-      "**/tests/**/*.js"
-    ],
-    "testPathIgnorePatterns": [
-      "tests/common",
-      "tests/cst/common"
-    ]
-  },
   "prettier": {
     "arrowParens": "avoid",
     "semi": false,
@@ -95,25 +83,22 @@
     "trailingComma": "none"
   },
   "devDependencies": {
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.9.0",
-    "@babel/plugin-proposal-class-properties": "^7.8.3",
-    "@babel/plugin-transform-runtime": "^7.9.0",
-    "@babel/preset-env": "^7.9.5",
+    "@babel/core": "^7.12.10",
+    "@babel/plugin-proposal-class-properties": "^7.12.1",
+    "@babel/preset-env": "^7.12.11",
+    "@rollup/plugin-babel": "^5.2.3",
     "babel-eslint": "^10.1.0",
-    "babel-jest": "^25.3.0",
+    "babel-jest": "^26.6.3",
     "babel-plugin-trace": "^1.1.0",
     "common-tags": "^1.8.0",
-    "cross-env": "^7.0.2",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.10.1",
-    "eslint-plugin-prettier": "^3.1.3",
-    "fast-check": "^1.24.1",
-    "jest": "^25.3.0",
-    "prettier": "^2.0.4"
-  },
-  "dependencies": {
-    "@babel/runtime": "^7.9.2"
+    "cross-env": "^7.0.3",
+    "eslint": "^7.19.0",
+    "eslint-config-prettier": "^7.2.0",
+    "fast-check": "^2.12.0",
+    "jest": "^26.6.3",
+    "prettier": "^2.2.1",
+    "rollup": "^2.38.2",
+    "typescript": "^4.1.3"
   },
   "engines": {
     "node": ">= 6"

package/pair.js

@@ -1,2 +1,2 @@
-module.exports = require('./dist/schema/Pair').Pair
-require('./dist/warnings').warnFileDeprecation(__filename)
+module.exports = require('./dist/types').Pair
+require('./dist/legacy-exports').warnFileDeprecation(__filename)

package/parse-cst.d.ts

@@ -51,6 +51,10 @@ export namespace CST {
     readonly hasComment: boolean
     readonly hasProps: boolean
     readonly jsonLike: boolean
+    readonly rangeAsLinePos: null | {
+      start: { line: number; col: number }
+      end?: { line: number; col: number }
+    }
     readonly rawValue: string | null
     readonly tag:
       | null

package/parse-cst.js

@@ -1 +1 @@
-module.exports = require('./dist/cst/parse').parse
+module.exports = require('./dist/parse-cst').parse

package/scalar.js

@@ -1,2 +1,2 @@
-module.exports = require('./dist/schema/Scalar').Scalar
-require('./dist/warnings').warnFileDeprecation(__filename)
+module.exports = require('./dist/types').Scalar
+require('./dist/legacy-exports').warnFileDeprecation(__filename)

package/schema.js

@@ -1,7 +1,9 @@
-module.exports = require('./dist/schema').Schema
-const opt = require('./dist/tags/options')
-module.exports.nullOptions = opt.nullOptions
-module.exports.strOptions = opt.strOptions
-module.exports.stringify = require('./dist/stringify').stringifyString
+const types = require('./dist/types')
+const util = require('./dist/util')
 
-require('./dist/warnings').warnFileDeprecation(__filename)
+module.exports = types.Schema
+module.exports.nullOptions = types.nullOptions
+module.exports.strOptions = types.strOptions
+module.exports.stringify = util.stringifyString
+
+require('./dist/legacy-exports').warnFileDeprecation(__filename)

package/seq.js

@@ -1,2 +1,2 @@
-module.exports = require('./dist/schema/Seq').YAMLSeq
-require('./dist/warnings').warnFileDeprecation(__filename)
+module.exports = require('./dist/types').YAMLSeq
+require('./dist/legacy-exports').warnFileDeprecation(__filename)

package/types/binary.js

@@ -1,7 +1,8 @@
 'use strict'
 Object.defineProperty(exports, '__esModule', { value: true })
 
-exports.binary = require('../dist/tags/yaml-1.1/binary').binary
+const legacy = require('../dist/legacy-exports')
+exports.binary = legacy.binary
 exports.default = [exports.binary]
 
-require('../dist/warnings').warnFileDeprecation(__filename)
+legacy.warnFileDeprecation(__filename)

package/types/omap.js

@@ -1,2 +1,3 @@
-module.exports = require('../dist/tags/yaml-1.1/omap').omap
-require('../dist/warnings').warnFileDeprecation(__filename)
+const legacy = require('../dist/legacy-exports')
+module.exports = legacy.omap
+legacy.warnFileDeprecation(__filename)

package/types/pairs.js

@@ -1,2 +1,3 @@
-module.exports = require('../dist/tags/yaml-1.1/pairs').pairs
-require('../dist/warnings').warnFileDeprecation(__filename)
+const legacy = require('../dist/legacy-exports')
+module.exports = legacy.pairs
+legacy.warnFileDeprecation(__filename)

package/types/set.js

@@ -1,2 +1,3 @@
-module.exports = require('../dist/tags/yaml-1.1/set').set
-require('../dist/warnings').warnFileDeprecation(__filename)
+const legacy = require('../dist/legacy-exports')
+module.exports = legacy.set
+legacy.warnFileDeprecation(__filename)

package/types/timestamp.js

@@ -1,10 +1,10 @@
 'use strict'
 Object.defineProperty(exports, '__esModule', { value: true })
 
-const ts = require('../dist/tags/yaml-1.1/timestamp')
-exports.default = [ts.intTime, ts.floatTime, ts.timestamp]
-exports.floatTime = ts.floatTime
-exports.intTime = ts.intTime
-exports.timestamp = ts.timestamp
+const legacy = require('../dist/legacy-exports')
+exports.default = [legacy.intTime, legacy.floatTime, legacy.timestamp]
+exports.floatTime = legacy.floatTime
+exports.intTime = legacy.intTime
+exports.timestamp = legacy.timestamp
 
-require('../dist/warnings').warnFileDeprecation(__filename)
+legacy.warnFileDeprecation(__filename)

package/types.d.ts

@@ -22,7 +22,7 @@ export class Schema {
   constructor(options: Schema.Options)
   /**
    * Convert any value into a `Node` using this schema, recursively turning
-   * objects into collectsions.
+   * objects into collections.
    *
    * @param wrapScalars If `true`, also wraps plain values in `Scalar` objects;
    *   if undefined or `false` and `value` is not an object, it will be returned
@@ -35,7 +35,14 @@ export class Schema {
     wrapScalars?: boolean,
     tag?: string,
     ctx?: Schema.CreateNodeContext
-  ): AST.Node
+  ): Node
+  /**
+   * Convert a key and a value into a `Pair` using this schema, recursively
+   * wrapping all values as `Scalar` or `Collection` nodes.
+   *
+   * @param ctx To not wrap scalars, use a context `{ wrapScalars: false }`
+   */
+  createPair(key: any, value: any, ctx?: Schema.CreateNodeContext): Pair
   merge: boolean
   name: Schema.Name
   sortMapEntries: ((a: Pair, b: Pair) => number) | null
@@ -147,7 +154,7 @@ export namespace Schema {
      *   type with the `+` chomping indicator.
      */
     stringify?: (
-      item: AST.Node,
+      item: Node,
       ctx: Schema.StringifyContext,
       onComment?: () => void,
       onChompKeep?: () => void
@@ -170,7 +177,7 @@ export namespace Schema {
      * Turns a CST node into an AST node. If returning a non-`Node` value, the
      * output will be wrapped as a `Scalar`.
      */
-    resolve(doc: Document, cstNode: CST.Node): AST.Node | any
+    resolve(doc: Document, cstNode: CST.Node): Node | any
   }
 
   interface DefaultTag extends BaseTag {
@@ -183,7 +190,7 @@ export namespace Schema {
     /**
      * Alternative form used by default tags; called with `test` match results.
      */
-    resolve(...match: string[]): AST.Node | any
+    resolve(...match: string[]): Node | any
     /**
      * Together with `default` allows for values to be stringified without an
      * explicit tag and detected using a regular expression. For most cases, it's
@@ -194,7 +201,29 @@ export namespace Schema {
   }
 }
 
-export class Scalar extends AST.Node {
+export class Node {
+  /** A comment on or immediately after this */
+  comment?: string | null
+  /** A comment before this */
+  commentBefore?: string | null
+  /** Only available when `keepCstNodes` is set to `true` */
+  cstNode?: CST.Node
+  /**
+   * The [start, end] range of characters of the source parsed
+   * into this node (undefined for pairs or if not parsed)
+   */
+  range?: [number, number] | null
+  /** A blank line before this node and its commentBefore */
+  spaceBefore?: boolean
+  /** A fully qualified tag, if required */
+  tag?: string
+  /** A plain JS representation of this node */
+  toJSON(arg?: any): any
+  /** The type of this node */
+  type?: Type | Pair.Type
+}
+
+export class Scalar extends Node {
   constructor(value: any)
   type?: Scalar.Type
   /**
@@ -203,6 +232,8 @@ export class Scalar extends AST.Node {
    */
   format?: 'BIN' | 'HEX' | 'OCT' | 'TIME'
   value: any
+  toJSON(arg?: any, ctx?: AST.NodeToJsonContext): any
+  toString(): string
 }
 export namespace Scalar {
   type Type =
@@ -213,15 +244,27 @@ export namespace Scalar {
     | Type.QUOTE_SINGLE
 }
 
-export class Pair extends AST.Node {
+export class Alias extends Node {
+  type: Type.ALIAS
+  source: Node
+  cstNode?: CST.Alias
+  toString(ctx: Schema.StringifyContext): string
+}
+
+export class Pair extends Node {
   constructor(key: any, value?: any)
-  toJSON(arg?: any, ctx?: AST.NodeToJsonContext): object | Map<any, any>
   type: Pair.Type.PAIR | Pair.Type.MERGE_PAIR
   /** Always Node or null when parsed, but can be set to anything. */
   key: any
   /** Always Node or null when parsed, but can be set to anything. */
   value: any
   cstNode?: never // no corresponding cstNode
+  toJSON(arg?: any, ctx?: AST.NodeToJsonContext): object | Map<any, any>
+  toString(
+    ctx?: Schema.StringifyContext,
+    onComment?: () => void,
+    onChompKeep?: () => void
+  ): string
 }
 export namespace Pair {
   enum Type {
@@ -230,14 +273,66 @@ export namespace Pair {
   }
 }
 
-export class YAMLMap extends AST.Collection {
+export class Merge extends Pair {
+  type: Pair.Type.MERGE_PAIR
+  /** Always Scalar('<<'), defined by the type specification */
+  key: AST.PlainValue
+  /** Always YAMLSeq<Alias(Map)>, stringified as *A if length = 1 */
+  value: YAMLSeq
+  toString(ctx?: Schema.StringifyContext, onComment?: () => void): string
+}
+
+export class Collection extends Node {
+  type?: Type.MAP | Type.FLOW_MAP | Type.SEQ | Type.FLOW_SEQ | Type.DOCUMENT
+  items: any[]
+  schema?: Schema
+
+  /**
+   * Adds a value to the collection. For `!!map` and `!!omap` the value must
+   * be a Pair instance or a `{ key, value }` object, which may not have a key
+   * that already exists in the map.
+   */
+  add(value: any): void
+  addIn(path: Iterable<any>, value: any): void
+  /**
+   * Removes a value from the collection.
+   * @returns `true` if the item was found and removed.
+   */
+  delete(key: any): boolean
+  deleteIn(path: Iterable<any>): boolean
+  /**
+   * Returns item at `key`, or `undefined` if not found. By default unwraps
+   * scalar values from their surrounding node; to disable set `keepScalar` to
+   * `true` (collections are always returned intact).
+   */
+  get(key: any, keepScalar?: boolean): any
+  getIn(path: Iterable<any>, keepScalar?: boolean): any
+  /**
+   * Checks if the collection includes a value with the key `key`.
+   */
+  has(key: any): boolean
+  hasIn(path: Iterable<any>): boolean
+  /**
+   * Sets a value in this collection. For `!!set`, `value` needs to be a
+   * boolean to add/remove the item from the set.
+   */
+  set(key: any, value: any): void
+  setIn(path: Iterable<any>, value: any): void
+}
+
+export class YAMLMap extends Collection {
   type?: Type.FLOW_MAP | Type.MAP
-  items: Array<Pair | AST.Merge>
+  items: Array<Pair>
   hasAllNullValues(): boolean
   toJSON(arg?: any, ctx?: AST.NodeToJsonContext): object | Map<any, any>
+  toString(
+    ctx?: Schema.StringifyContext,
+    onComment?: () => void,
+    onChompKeep?: () => void
+  ): string
 }
 
-export class YAMLSeq extends AST.Collection {
+export class YAMLSeq extends Collection {
   type?: Type.FLOW_SEQ | Type.SEQ
   delete(key: number | string | Scalar): boolean
   get(key: number | string | Scalar, keepScalar?: boolean): any
@@ -245,80 +340,14 @@ export class YAMLSeq extends AST.Collection {
   set(key: number | string | Scalar, value: any): void
   hasAllNullValues(): boolean
   toJSON(arg?: any, ctx?: AST.NodeToJsonContext): any[]
+  toString(
+    ctx?: Schema.StringifyContext,
+    onComment?: () => void,
+    onChompKeep?: () => void
+  ): string
 }
 
 export namespace AST {
-  type AstNode = ScalarNode | CollectionNode | Alias
-
-  type ScalarNode =
-    | BlockFolded
-    | BlockLiteral
-    | PlainValue
-    | QuoteDouble
-    | QuoteSingle
-
-  type CollectionNode = FlowMap | BlockMap | FlowSeq | BlockSeq
-
-  class Node {
-    /** A comment on or immediately after this */
-    comment?: string | null
-    /** A comment before this */
-    commentBefore?: string | null
-    /** Only available when `keepCstNodes` is set to `true` */
-    cstNode?: CST.Node
-    /**
-     * The [start, end] range of characters of the source parsed
-     * into this node (undefined for pairs or if not parsed)
-     */
-    range?: [number, number] | null
-    /** A blank line before this node and its commentBefore */
-    spaceBefore?: boolean
-    /** A fully qualified tag, if required */
-    tag?: string
-    /** A plain JS representation of this node */
-    toJSON(arg?: any, ctx?: NodeToJsonContext): any
-    /** The type of this node */
-    type?: Type | Pair.Type
-  }
-
-  class Collection extends Node {
-    type?: Type.MAP | Type.FLOW_MAP | Type.SEQ | Type.FLOW_SEQ | Type.DOCUMENT
-    items: any[]
-    schema?: Schema
-
-    /**
-     * Adds a value to the collection. For `!!map` and `!!omap` the value must
-     * be a Pair instance or a `{ key, value }` object, which may not have a key
-     * that already exists in the map.
-     */
-    add(value: any): void
-    addIn(path: Iterable<any>, value: any): void
-    /**
-     * Removes a value from the collection.
-     * @returns `true` if the item was found and removed.
-     */
-    delete(key: any): boolean
-    deleteIn(path: Iterable<any>): boolean
-    /**
-     * Returns item at `key`, or `undefined` if not found. By default unwraps
-     * scalar values from their surrounding node; to disable set `keepScalar` to
-     * `true` (collections are always returned intact).
-     */
-    get(key: any, keepScalar?: boolean): any
-    getIn(path: Iterable<any>, keepScalar?: boolean): any
-    /**
-     * Checks if the collection includes a value with the key `key`.
-     */
-    has(key: any): boolean
-    hasIn(path: Iterable<any>): boolean
-    /**
-     * Sets a value in this collection. For `!!set`, `value` needs to be a
-     * boolean to add/remove the item from the set.
-     */
-    set(key: any, value: any): void
-    setIn(path: Iterable<any>, value: any): void
-  }
-
   interface NodeToJsonContext {
     anchors?: any[]
     doc: Document
@@ -354,20 +383,6 @@ export namespace AST {
     cstNode?: CST.QuoteSingle
   }
 
-  interface Alias extends Node {
-    type: Type.ALIAS
-    source: AstNode
-    cstNode?: CST.Alias
-  }
-
-  interface Merge extends Pair {
-    type: Pair.Type.MERGE_PAIR
-    /** Always Scalar('<<'), defined by the type specification */
-    key: PlainValue
-    /** Always YAMLSeq<Alias(Map)>, stringified as *A if length = 1 */
-    value: YAMLSeq
-  }
-
   interface FlowMap extends YAMLMap {
     type: Type.FLOW_MAP
     cstNode?: CST.FlowMap
@@ -380,13 +395,13 @@ export namespace AST {
 
   interface FlowSeq extends YAMLSeq {
     type: Type.FLOW_SEQ
-    items: Array<AstNode | Pair>
+    items: Array<Node>
     cstNode?: CST.FlowSeq
   }
 
   interface BlockSeq extends YAMLSeq {
     type: Type.SEQ
-    items: Array<AstNode | null>
+    items: Array<Node | null>
     cstNode?: CST.Seq
   }
 }

package/types.js

@@ -1,12 +1,17 @@
-const opt = require('./dist/tags/options')
-exports.binaryOptions = opt.binaryOptions
-exports.boolOptions = opt.boolOptions
-exports.intOptions = opt.intOptions
-exports.nullOptions = opt.nullOptions
-exports.strOptions = opt.strOptions
+const types = require('./dist/types')
 
-exports.Schema = require('./dist/schema').Schema
-exports.YAMLMap = require('./dist/schema/Map').YAMLMap
-exports.YAMLSeq = require('./dist/schema/Seq').YAMLSeq
-exports.Pair = require('./dist/schema/Pair').Pair
-exports.Scalar = require('./dist/schema/Scalar').Scalar
+exports.binaryOptions = types.binaryOptions
+exports.boolOptions = types.boolOptions
+exports.intOptions = types.intOptions
+exports.nullOptions = types.nullOptions
+exports.strOptions = types.strOptions
+
+exports.Schema = types.Schema
+exports.Alias = types.Alias
+exports.Collection = types.Collection
+exports.Merge = types.Merge
+exports.Node = types.Node
+exports.Pair = types.Pair
+exports.Scalar = types.Scalar
+exports.YAMLMap = types.YAMLMap
+exports.YAMLSeq = types.YAMLSeq

package/types.mjs

@@ -1,21 +1,17 @@
-import opt from './dist/tags/options.js'
-export const binaryOptions = opt.binaryOptions
-export const boolOptions = opt.boolOptions
-export const intOptions = opt.intOptions
-export const nullOptions = opt.nullOptions
-export const strOptions = opt.strOptions
+import types from './dist/types.js'
 
-import schema from './dist/schema/index.js'
-export const Schema = schema.Schema
+export const binaryOptions = types.binaryOptions
+export const boolOptions = types.boolOptions
+export const intOptions = types.intOptions
+export const nullOptions = types.nullOptions
+export const strOptions = types.strOptions
 
-import map from './dist/schema/Map.js'
-export const YAMLMap = map.YAMLMap
-
-import seq from './dist/schema/Seq.js'
-export const YAMLSeq = seq.YAMLSeq
-
-import pair from './dist/schema/Pair.js'
-export const Pair = pair.Pair
-
-import scalar from './dist/schema/Scalar.js'
-export const Scalar = scalar.Scalar
+export const Schema = types.Schema
+export const Alias = types.Alias
+export const Collection = types.Collection
+export const Merge = types.Merge
+export const Node = types.Node
+export const Pair = types.Pair
+export const Scalar = types.Scalar
+export const YAMLMap = types.YAMLMap
+export const YAMLSeq = types.YAMLSeq

package/util.js

@@ -1,16 +1,16 @@
-exports.findPair = require('./dist/schema/Map').findPair
-exports.parseMap = require('./dist/schema/parseMap').parseMap
-exports.parseSeq = require('./dist/schema/parseSeq').parseSeq
+const util = require('./dist/util')
 
-const str = require('./dist/stringify')
-exports.stringifyNumber = str.stringifyNumber
-exports.stringifyString = str.stringifyString
-exports.toJSON = require('./dist/toJSON').toJSON
-exports.Type = require('./dist/constants').Type
+exports.findPair = util.findPair
+exports.toJSON = util.toJSON
+exports.parseMap = util.parseMap
+exports.parseSeq = util.parseSeq
 
-const err = require('./dist/errors')
-exports.YAMLError = err.YAMLError
-exports.YAMLReferenceError = err.YAMLReferenceError
-exports.YAMLSemanticError = err.YAMLSemanticError
-exports.YAMLSyntaxError = err.YAMLSyntaxError
-exports.YAMLWarning = err.YAMLWarning
+exports.stringifyNumber = util.stringifyNumber
+exports.stringifyString = util.stringifyString
+exports.Type = util.Type
+
+exports.YAMLError = util.YAMLError
+exports.YAMLReferenceError = util.YAMLReferenceError
+exports.YAMLSemanticError = util.YAMLSemanticError
+exports.YAMLSyntaxError = util.YAMLSyntaxError
+exports.YAMLWarning = util.YAMLWarning