.travis.yml

@@ -3,6 +3,10 @@ node_js:
   - 'node'
   - 'lts/*'
 
+script:
+  - npm test
+  - npm run test:dist
+
 addons:
   browserstack:
     username: eemeliaro2

README.md

@@ -2,16 +2,16 @@
 
 `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 (Note: `@babel/runtime` is used only by the `"browser"` entry point).
+The library is released under the ISC open source license, and the code is [available on GitHub](https://github.com/eemeli/yaml/). It has no external dependencies and runs on Node.js 6 and later, and in browsers from IE 11 upwards.
+
+For the purposes of versioning, any changes that break any of the endpoints or APIs documented here will be considered semver-major breaking changes. Undocumented library internals may change between minor versions, and previous APIs may be deprecated (but not removed).
 
 For more information, see the project's documentation site: [**eemeli.org/yaml**](https://eemeli.org/yaml/)
 
-> To install:
+To install:
 
 ```sh
 npm install yaml
-# or
-yarn add yaml
 ```
 
 Note: `yaml` 0.x and 1.x are rather different implementations. For the earlier `yaml`, see [tj/js-yaml](https://github.com/tj/js-yaml).

babel.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  plugins: [
+    '@babel/plugin-proposal-class-properties',
+    ['babel-plugin-trace', { strip: true }]
+  ]
+}
+
+if (process.env.NODE_ENV === 'test')
+  module.exports.presets = [['@babel/env', { targets: { node: 'current' } }]]

browser/index.js

@@ -1 +1 @@
-export { YAML as default } from './dist'
+module.exports = require('./dist').YAML

browser/map.js

@@ -1,4 +1,2 @@
-export { YAMLMap as default } from './dist/schema/Map'
-
-import { warnFileDeprecation } from './dist/warnings'
-warnFileDeprecation(__filename)
+module.exports = require('./dist/types').YAMLMap
+require('./dist/legacy-exports').warnFileDeprecation(__filename)

browser/pair.js

@@ -1,4 +1,2 @@
-export { Pair as default } from './dist/schema/Pair'
-
-import { warnFileDeprecation } from './dist/warnings'
-warnFileDeprecation(__filename)
+module.exports = require('./dist/types').Pair
+require('./dist/legacy-exports').warnFileDeprecation(__filename)

browser/parse-cst.js

@@ -1 +1 @@
-export { parse as default } from './dist/cst/parse'
+module.exports = require('./dist/parse-cst').parse

browser/scalar.js

@@ -1,4 +1,2 @@
-export { Scalar as default } from './dist/schema/Scalar'
-
-import { warnFileDeprecation } from './dist/warnings'
-warnFileDeprecation(__filename)
+module.exports = require('./dist/types').Scalar
+require('./dist/legacy-exports').warnFileDeprecation(__filename)

browser/schema.js

@@ -1,12 +1,9 @@
-import { Schema } from './dist/schema'
-import { nullOptions, strOptions } from './dist/tags/options'
-import { stringifyString } from './dist/stringify'
+const types = require('./dist/types')
+const util = require('./dist/util')
 
-Schema.nullOptions = nullOptions
-Schema.strOptions = strOptions
-Schema.stringify = stringifyString
-export { Schema as default }
-export { nullOptions, strOptions, stringifyString as stringify }
+module.exports = types.Schema
+module.exports.nullOptions = types.nullOptions
+module.exports.strOptions = types.strOptions
+module.exports.stringify = util.stringifyString
 
-import { warnFileDeprecation } from './dist/warnings'
-warnFileDeprecation(__filename)
+require('./dist/legacy-exports').warnFileDeprecation(__filename)

browser/seq.js

@@ -1,4 +1,2 @@
-export { YAMLSeq as default } from './dist/schema/Seq'
-
-import { warnFileDeprecation } from './dist/warnings'
-warnFileDeprecation(__filename)
+module.exports = require('./dist/types').YAMLSeq
+require('./dist/legacy-exports').warnFileDeprecation(__filename)

browser/types.js

@@ -1,13 +1 @@
-export {
-  binaryOptions,
-  boolOptions,
-  intOptions,
-  nullOptions,
-  strOptions
-} from './dist/tags/options'
-
-export { Schema } from './dist/schema'
-export { YAMLMap } from './dist/schema/Map'
-export { YAMLSeq } from './dist/schema/Seq'
-export { Pair } from './dist/schema/Pair'
-export { Scalar } from './dist/schema/Scalar'
+export * from './dist/types.js'

browser/types/binary.js

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

browser/types/omap.js

@@ -1,4 +1,3 @@
-export { omap as default } from '../dist/tags/yaml-1.1/omap'
-
-import { warnFileDeprecation } from './dist/warnings'
-warnFileDeprecation(__filename)
+const legacy = require('../dist/legacy-exports')
+module.exports = legacy.omap
+legacy.warnFileDeprecation(__filename)

browser/types/pairs.js

@@ -1,4 +1,3 @@
-export { pairs as default } from '../dist/tags/yaml-1.1/pairs'
-
-import { warnFileDeprecation } from './dist/warnings'
-warnFileDeprecation(__filename)
+const legacy = require('../dist/legacy-exports')
+module.exports = legacy.pairs
+legacy.warnFileDeprecation(__filename)

browser/types/set.js

@@ -1,4 +1,3 @@
-export { set as default } from '../dist/tags/yaml-1.1/set'
-
-import { warnFileDeprecation } from './dist/warnings'
-warnFileDeprecation(__filename)
+const legacy = require('../dist/legacy-exports')
+module.exports = legacy.set
+legacy.warnFileDeprecation(__filename)

browser/types/timestamp.js

@@ -1,6 +1,10 @@
-import { floatTime, intTime, timestamp } from '../dist/tags/yaml-1.1/timestamp'
-export { floatTime, intTime, timestamp }
-export default [intTime, floatTime, timestamp]
+'use strict'
+Object.defineProperty(exports, '__esModule', { value: true })
 
-import { warnFileDeprecation } from './dist/warnings'
-warnFileDeprecation(__filename)
+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
+
+legacy.warnFileDeprecation(__filename)

browser/util.js

@@ -1,18 +1 @@
-export { findPair } from './dist/schema/Map'
-export { parseMap } from './dist/schema/parseMap'
-export { parseSeq } from './dist/schema/parseSeq'
-
-export {
-  stringifyNumber,
-  stringifyString,
-  toJSON,
-  Type
-} from './dist/stringify'
-
-export {
-  YAMLError,
-  YAMLReferenceError,
-  YAMLSemanticError,
-  YAMLSyntaxError,
-  YAMLWarning
-} from './dist/errors'
+export * from './dist/util.js'

docs/01_intro.md

@@ -15,7 +15,7 @@ yarn add yaml
 - Can accept any string as input without throwing, parsing as much YAML out of it as it can, and
 - Supports parsing, modifying, and writing YAML comments.
 
-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).
+The library is released under the ISC open source license, and the code is [available on GitHub](https://github.com/eemeli/yaml/). It has no external dependencies and runs on Node.js 6 and later, and in browsers from IE 11 upwards.
 
 For the purposes of versioning, any changes that break any of the endpoints or APIs documented here will be considered semver-major breaking changes. Undocumented library internals may change between minor versions, and previous APIs may be deprecated (but not removed).
 

docs/03_options.md

@@ -78,12 +78,13 @@ mergeResult.target
 ## Scalar Options
 
 ```js
-YAML.stringify({ 'this is': null })
+// Without simpleKeys, an all-null-values object uses explicit keys & no values
+YAML.stringify({ 'this is': null }, { simpleKeys: true })
 // this is: null
 
 YAML.scalarOptions.null.nullStr = '~'
 YAML.scalarOptions.str.defaultType = 'QUOTE_SINGLE'
-YAML.stringify({ 'this is': null })
+YAML.stringify({ 'this is': null }, { simpleKeys: true })
 // 'this is': ~
 ```
 

docs/04_documents.md

@@ -147,14 +147,15 @@ A description of [alias and merge nodes](#alias-nodes) is included in the next s
 
 #### `YAML.Document#anchors`
 
-| Method                                 | Returns   | Description                                                                                                                |
-| -------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------- |
-| createAlias(node: Node, name?: string) | `Alias`   | Create a new `Alias` node, adding the required anchor for `node`. If `name` is empty, a new anchor name will be generated. |
-| createMergePair(...Node)               | `Merge`   | Create a new `Merge` node with the given source nodes. Non-`Alias` sources will be automatically wrapped.                  |
-| getName(node: Node)                    | `string?` | The anchor name associated with `node`, if set.                                                                            |
-| getNode(name: string)                  | `Node?`   | The node associated with the anchor `name`, if set.                                                                        |
-| newName(prefix: string)                | `string`  | Find an available anchor name with the given `prefix` and a numerical suffix.                                              |
-| setAnchor(node: Node, name?: string)   | `string?` | Associate an anchor with `node`. If `name` is empty, a new name will be generated.                                         |
+| Method                                 | Returns    | Description                                                                                                                |
+| -------------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------- |
+| createAlias(node: Node, name?: string) | `Alias`    | Create a new `Alias` node, adding the required anchor for `node`. If `name` is empty, a new anchor name will be generated. |
+| createMergePair(...Node)               | `Merge`    | Create a new `Merge` node with the given source nodes. Non-`Alias` sources will be automatically wrapped.                  |
+| getName(node: Node)                    | `string?`  | The anchor name associated with `node`, if set.                                                                            |
+| getNames()                             | `string[]` | List of all defined anchor names.                                                                                          |
+| getNode(name: string)                  | `Node?`    | The node associated with the anchor `name`, if set.                                                                        |
+| newName(prefix: string)                | `string`   | Find an available anchor name with the given `prefix` and a numerical suffix.                                              |
+| setAnchor(node: Node, name?: string)   | `string?`  | Associate an anchor with `node`. If `name` is empty, a new name will be generated.                                         |
 
 ```js
 const src = '[{ a: A }, { b: B }]'

docs/05_content_nodes.md

@@ -194,7 +194,7 @@ doc.toString()
 
 To construct a `YAMLSeq` or `YAMLMap`, use [`YAML.createNode()`](#yaml-createnode) with array, object or iterable input, or create the collections directly by importing the classes from `yaml/types`.
 
-Once created, normal array operations may be used to modify the `items` array. New `Pair` objects may created by importing the class from `yaml/types` and using its `new Pair(key, value)` constructor.
+Once created, normal array operations may be used to modify the `items` array. New `Pair` objects may created either by importing the class from `yaml/types` and using its `new Pair(key, value)` constructor, or by using the `doc.schema.createPair(key, value)` method. The latter will recursively wrap the `key` and `value` as nodes.
 
 ## Comments
 

index.d.ts

@@ -1,5 +1,15 @@
 import { CST } from './parse-cst'
-import { AST, Scalar, Schema, YAMLMap, YAMLSeq } from './types'
+import {
+  AST,
+  Alias,
+  Collection,
+  Merge,
+  Node,
+  Scalar,
+  Schema,
+  YAMLMap,
+  YAMLSeq
+} from './types'
 import { Type, YAMLError, YAMLWarning } from './util'
 
 export { AST, CST }
@@ -183,18 +193,19 @@ export namespace scalarOptions {
   }
 }
 
-export class Document extends AST.Collection {
+export class Document extends Collection {
   cstNode?: CST.Document
   constructor(options?: Options)
   tag: never
+  directivesEndMarker?: boolean
   type: Type.DOCUMENT
   /**
    * Anchors associated with the document's nodes;
    * also provides alias & merge node creators.
    */
   anchors: Document.Anchors
   /** The document contents. */
-  contents: AST.AstNode | null
+  contents: any
   /** Errors encountered during parsing. */
   errors: YAMLError[]
   /**
@@ -249,6 +260,7 @@ export class Document extends AST.Collection {
 
 export namespace Document {
   interface Parsed extends Document {
+    contents: Node | null
     /** The schema used with the document. */
     schema: Schema
   }
@@ -258,16 +270,18 @@ export namespace Document {
      * Create a new `Alias` node, adding the required anchor for `node`.
      * If `name` is empty, a new anchor name will be generated.
      */
-    createAlias(node: AST.Node, name?: string): AST.Alias
+    createAlias(node: Node, name?: string): Alias
     /**
      * Create a new `Merge` node with the given source nodes.
      * Non-`Alias` sources will be automatically wrapped.
      */
-    createMergePair(...nodes: AST.Node[]): AST.Merge
+    createMergePair(...nodes: Node[]): Merge
     /** The anchor name associated with `node`, if set. */
-    getName(node: AST.Node): undefined | string
+    getName(node: Node): undefined | string
+    /** List of all defined anchor names. */
+    getNames(): string[]
     /** The node associated with the anchor `name`, if set. */
-    getNode(name: string): undefined | AST.Node
+    getNode(name: string): undefined | Node
     /**
      * Find an available anchor name with the given `prefix` and a
      * numerical suffix.
@@ -277,7 +291,7 @@ export namespace Document {
      * Associate an anchor with `node`. If `name` is empty, a new name will be generated.
      * To remove an anchor, use `setAnchor(null, name)`.
      */
-    setAnchor(node: AST.Node | null, name?: string): void | string
+    setAnchor(node: Node | null, name?: string): void | string
   }
 
   interface TagPrefix {

jest.config.js

@@ -0,0 +1,39 @@
+let moduleNameMapper
+const testPathIgnorePatterns = ['tests/common', 'cst/common']
+
+// The npm script name is significant.
+switch (process.env.npm_lifecycle_event) {
+  case 'test:dist':
+    moduleNameMapper = {}
+    testPathIgnorePatterns.push(
+      'cst/Node',
+      'cst/set-value',
+      'cst/source-utils',
+      'cst/YAML-1.2',
+      'doc/createNode',
+      'doc/errors',
+      'doc/foldFlowLines',
+      'doc/types'
+    )
+    break
+
+  case 'test':
+  default:
+    process.env.TRACE_LEVEL = 'log'
+    moduleNameMapper = {
+      '^\\./dist$': '<rootDir>/src/index.js',
+      '^\\./dist/parse-cst(\\.js)?$': '<rootDir>/src/cst/parse.js',
+      '^\\./dist/types(\\.js)?$': '<rootDir>/src/types.js',
+      '^\\./dist/(.+)$': '<rootDir>/src/$1',
+      '^\\.\\./dist/test-events.js$': '<rootDir>/src/test-events.js'
+    }
+}
+
+module.exports = {
+  collectCoverageFrom: ['src/**/*.js'],
+  moduleNameMapper,
+  testEnvironment: 'node',
+  testMatch: ['**/tests/**/*.js'],
+  testPathIgnorePatterns,
+  transform: { '/(src|tests)/.*\\.js$': 'babel-jest' }
+}

map.js

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