yaml 2.0.0-8 → 2.0.1

package/dist/nodes/Node.d.ts

@@ -1,4 +1,5 @@
 import type { Document } from '../doc/Document.js';
+import { Token } from '../parse/cst.js';
 import type { StringifyContext } from '../stringify/stringify.js';
 import type { Alias } from './Alias.js';
 import type { Pair } from './Pair.js';
@@ -39,6 +40,8 @@ export declare abstract class NodeBase {
     range?: Range | null;
     /** A blank line before this node and its commentBefore */
     spaceBefore?: boolean;
+    /** The CST token that was composed into this node.  */
+    srcToken?: Token;
     /** A fully qualified tag, if required */
     tag?: string;
     /** A plain JS representation of this node */

package/dist/nodes/Pair.d.ts

@@ -1,4 +1,5 @@
 import { CreateNodeContext } from '../doc/createNode.js';
+import type { CollectionItem } from '../parse/cst.js';
 import type { Schema } from '../schema/Schema.js';
 import type { StringifyContext } from '../stringify/stringify.js';
 import { addPairToJSMap } from './addPairToJSMap.js';
@@ -11,6 +12,8 @@ export declare class Pair<K = unknown, V = unknown> {
     key: K;
     /** Always Node or null when parsed, but can be set to anything. */
     value: V | null;
+    /** The CST token that was composed into this pair.  */
+    srcToken?: CollectionItem;
     constructor(key: K, value?: V | null);
     clone(schema?: Schema): Pair<K, V>;
     toJSON(_?: unknown, ctx?: ToJSContext): ReturnType<typeof addPairToJSMap>;

package/dist/nodes/Pair.js

@@ -25,11 +25,11 @@ class Pair {
         return new Pair(key, value);
     }
     toJSON(_, ctx) {
-        const pair = ctx && ctx.mapAsMap ? new Map() : {};
+        const pair = (ctx === null || ctx === void 0 ? void 0 : ctx.mapAsMap) ? new Map() : {};
         return addPairToJSMap.addPairToJSMap(ctx, pair, this);
     }
     toString(ctx, onComment, onChompKeep) {
-        return ctx && ctx.doc
+        return (ctx === null || ctx === void 0 ? void 0 : ctx.doc)
             ? stringifyPair.stringifyPair(this, ctx, onComment, onChompKeep)
             : JSON.stringify(this);
     }

package/dist/nodes/Scalar.d.ts

@@ -1,3 +1,4 @@
+import type { BlockScalar, FlowScalar } from '../parse/cst.js';
 import { NodeBase, Range } from './Node.js';
 import { ToJSContext } from './toJS.js';
 export declare const isScalarValue: (value: unknown) => boolean;
@@ -5,6 +6,7 @@ export declare namespace Scalar {
     interface Parsed extends Scalar {
         range: Range;
         source: string;
+        srcToken?: FlowScalar | BlockScalar;
     }
     type BLOCK_FOLDED = 'BLOCK_FOLDED';
     type BLOCK_LITERAL = 'BLOCK_LITERAL';

package/dist/nodes/Scalar.js

@@ -10,7 +10,7 @@ class Scalar extends Node.NodeBase {
         this.value = value;
     }
     toJSON(arg, ctx) {
-        return ctx && ctx.keep ? this.value : toJS.toJS(this.value, arg, ctx);
+        return (ctx === null || ctx === void 0 ? void 0 : ctx.keep) ? this.value : toJS.toJS(this.value, arg, ctx);
     }
     toString() {
         return String(this.value);

package/dist/nodes/YAMLMap.d.ts

@@ -1,3 +1,4 @@
+import type { BlockMap, FlowCollection } from '../parse/cst.js';
 import type { Schema } from '../schema/Schema.js';
 import type { StringifyContext } from '../stringify/stringify.js';
 import { Collection } from './Collection.js';
@@ -9,6 +10,7 @@ export declare namespace YAMLMap {
     interface Parsed<K extends ParsedNode = ParsedNode, V extends ParsedNode | null = ParsedNode | null> extends YAMLMap<K, V> {
         items: Pair<K, V>[];
         range: Range;
+        srcToken?: BlockMap | FlowCollection;
     }
 }
 export declare class YAMLMap<K = unknown, V = unknown> extends Collection {
@@ -34,6 +36,8 @@ export declare class YAMLMap<K = unknown, V = unknown> extends Collection {
      * @param {Class} Type - If set, forces the returned collection type
      * @returns Instance of Type, Map, or Object
      */
-    toJSON(_?: unknown, ctx?: ToJSContext, Type?: any): any;
+    toJSON<T = unknown>(_?: unknown, ctx?: ToJSContext, Type?: {
+        new (): T;
+    }): any;
     toString(ctx?: StringifyContext, onComment?: () => void, onChompKeep?: () => void): string;
 }

package/dist/nodes/YAMLMap.js

@@ -34,6 +34,7 @@ class YAMLMap extends Collection.Collection {
      *   collection will throw. Otherwise, overwrites the previous value.
      */
     add(pair, overwrite) {
+        var _a;
         let _pair;
         if (Node.isPair(pair))
             _pair = pair;
@@ -44,7 +45,7 @@ class YAMLMap extends Collection.Collection {
         else
             _pair = new Pair.Pair(pair.key, pair.value);
         const prev = findPair(this.items, _pair.key);
-        const sortEntries = this.schema && this.schema.sortMapEntries;
+        const sortEntries = (_a = this.schema) === null || _a === void 0 ? void 0 : _a.sortMapEntries;
         if (prev) {
             if (!overwrite)
                 throw new Error(`Key ${_pair.key} already set`);
@@ -74,7 +75,7 @@ class YAMLMap extends Collection.Collection {
     }
     get(key, keepScalar) {
         const it = findPair(this.items, key);
-        const node = it && it.value;
+        const node = it === null || it === void 0 ? void 0 : it.value;
         return !keepScalar && Node.isScalar(node) ? node.value : node;
     }
     has(key) {
@@ -89,8 +90,8 @@ class YAMLMap extends Collection.Collection {
      * @returns Instance of Type, Map, or Object
      */
     toJSON(_, ctx, Type) {
-        const map = Type ? new Type() : ctx && ctx.mapAsMap ? new Map() : {};
-        if (ctx && ctx.onCreate)
+        const map = Type ? new Type() : (ctx === null || ctx === void 0 ? void 0 : ctx.mapAsMap) ? new Map() : {};
+        if (ctx === null || ctx === void 0 ? void 0 : ctx.onCreate)
             ctx.onCreate(map);
         for (const item of this.items)
             addPairToJSMap.addPairToJSMap(ctx, map, item);
@@ -106,7 +107,7 @@ class YAMLMap extends Collection.Collection {
         if (!ctx.allNullValues && this.hasAllNullValues(false))
             ctx = Object.assign({}, ctx, { allNullValues: true });
         return stringifyCollection.stringifyCollection(this, ctx, {
-            blockItem: n => n.str,
+            blockItemPrefix: '',
             flowChars: { start: '{', end: '}' },
             itemIndent: ctx.indent || '',
             onChompKeep,

package/dist/nodes/YAMLSeq.d.ts

@@ -1,3 +1,4 @@
+import type { BlockSequence, FlowCollection } from '../parse/cst.js';
 import type { Schema } from '../schema/Schema.js';
 import type { StringifyContext } from '../stringify/stringify.js';
 import { Collection } from './Collection.js';
@@ -8,6 +9,7 @@ export declare namespace YAMLSeq {
     interface Parsed<T extends ParsedNode | Pair<ParsedNode, ParsedNode | null> = ParsedNode> extends YAMLSeq<T> {
         items: T[];
         range: Range;
+        srcToken?: BlockSequence | FlowCollection;
     }
 }
 export declare class YAMLSeq<T = unknown> extends Collection {

package/dist/nodes/YAMLSeq.js

@@ -76,7 +76,7 @@ class YAMLSeq extends Collection.Collection {
     }
     toJSON(_, ctx) {
         const seq = [];
-        if (ctx && ctx.onCreate)
+        if (ctx === null || ctx === void 0 ? void 0 : ctx.onCreate)
             ctx.onCreate(seq);
         let i = 0;
         for (const item of this.items)
@@ -87,7 +87,7 @@ class YAMLSeq extends Collection.Collection {
         if (!ctx)
             return JSON.stringify(this);
         return stringifyCollection.stringifyCollection(this, ctx, {
-            blockItem: n => (n.comment ? n.str : `- ${n.str}`),
+            blockItemPrefix: '- ',
             flowChars: { start: '[', end: ']' },
             itemIndent: (ctx.indent || '') + '  ',
             onChompKeep,

package/dist/nodes/addPairToJSMap.js

@@ -8,7 +8,8 @@ var toJS = require('./toJS.js');
 
 const MERGE_KEY = '<<';
 function addPairToJSMap(ctx, map, { key, value }) {
-    if (ctx && ctx.doc.schema.merge && isMergeKey(key)) {
+    if ((ctx === null || ctx === void 0 ? void 0 : ctx.doc.schema.merge) && isMergeKey(key)) {
+        value = Node.isAlias(value) ? value.resolve(ctx.doc) : value;
         if (Node.isSeq(value))
             for (const it of value.items)
                 mergeToJSMap(ctx, map, it);

package/dist/nodes/toJS.js

@@ -13,9 +13,11 @@ var Node = require('./Node.js');
  *   stringification.
  */
 function toJS(value, arg, ctx) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     if (Array.isArray(value))
         return value.map((v, i) => toJS(v, String(i), ctx));
     if (value && typeof value.toJSON === 'function') {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-call
         if (!ctx || !Node.hasAnchor(value))
             return value.toJSON(arg, ctx);
         const data = { aliasCount: 0, count: 1, res: undefined };
@@ -29,7 +31,7 @@ function toJS(value, arg, ctx) {
             ctx.onCreate(res);
         return res;
     }
-    if (typeof value === 'bigint' && !(ctx && ctx.keep))
+    if (typeof value === 'bigint' && !(ctx === null || ctx === void 0 ? void 0 : ctx.keep))
         return Number(value);
     return value;
 }

package/dist/options.d.ts

@@ -5,7 +5,7 @@ import type { ParsedNode } from './nodes/Node.js';
 import type { Pair } from './nodes/Pair.js';
 import type { Scalar } from './nodes/Scalar.js';
 import type { LineCounter } from './parse/line-counter.js';
-import type { SchemaName } from './schema/Schema.js';
+import type { Schema } from './schema/Schema.js';
 import type { Tags } from './schema/tags.js';
 import type { CollectionTag, ScalarTag } from './schema/types.js';
 export declare type ParseOptions = {
@@ -17,6 +17,13 @@ export declare type ParseOptions = {
      * https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/BigInt
      */
     intAsBigInt?: boolean;
+    /**
+     * Include a `srcToken` value on each parsed `Node`, containing the CST token
+     * that was composed into this node.
+     *
+     * Default: `false`
+     */
+    keepSourceTokens?: boolean;
     /**
      * If set, newlines will be tracked, to allow for `lineCounter.linePos(offset)`
      * to provide the `{ line, col }` positions within the input.
@@ -66,9 +73,17 @@ export declare type DocumentOptions = {
      *
      * Default: `"1.2"`
      */
-    version?: '1.1' | '1.2';
+    version?: '1.1' | '1.2' | 'next';
 };
 export declare type SchemaOptions = {
+    /**
+     * When parsing, warn about compatibility issues with the given schema.
+     * When stringifying, use scalar styles that are parsed correctly
+     * by the `compat` schema as well as the actual schema.
+     *
+     * Default: `null`
+     */
+    compat?: string | Tags | null;
     /**
      * Array of additional tags to include in the schema, or a function that may
      * modify the schema's base tag array.
@@ -92,9 +107,18 @@ export declare type SchemaOptions = {
     /**
      * The base schema to use.
      *
-     * Default: `"core"` for YAML 1.2, `"yaml-1.1"` for earlier versions
+     * The core library has built-in support for the following:
+     * - `'failsafe'`: A minimal schema that parses all scalars as strings
+     * - `'core'`: The YAML 1.2 core schema
+     * - `'json'`: The YAML 1.2 JSON schema, with minimal rules for JSON compatibility
+     * - `'yaml-1.1'`: The YAML 1.1 schema
+     *
+     * If using another (custom) schema, the `customTags` array needs to
+     * fully define the schema's tags.
+     *
+     * Default: `'core'` for YAML 1.2, `'yaml-1.1'` for earlier versions
      */
-    schema?: SchemaName;
+    schema?: string | Schema;
     /**
      * When adding to or stringifying a map, sort the entries.
      * If `true`, sort by comparing key values with `<`.
@@ -103,6 +127,10 @@ export declare type SchemaOptions = {
      * Default: `false`
      */
     sortMapEntries?: boolean | ((a: Pair, b: Pair) => number);
+    /**
+     * Override default values for `toString()` options.
+     */
+    toStringDefaults?: ToStringOptions;
 };
 export declare type CreateNodeOptions = {
     /**
@@ -161,6 +189,30 @@ export declare type ToJSOptions = {
     reviver?: Reviver;
 };
 export declare type ToStringOptions = {
+    /**
+     * Use block quote styles for scalar values where applicable.
+     * Set to `false` to disable block quotes completely.
+     *
+     * Default: `true`
+     */
+    blockQuote?: boolean | 'folded' | 'literal';
+    /**
+     * Enforce `'block'` or `'flow'` style on maps and sequences.
+     * Empty collections will always be stringified as `{}` or `[]`.
+     *
+     * Default: `'any'`, allowing each node to set its style separately
+     * with its `flow: boolean` (default `false`) property.
+     */
+    collectionStyle?: 'any' | 'block' | 'flow';
+    /**
+     * Comment stringifier.
+     * Output should be valid for the current schema.
+     *
+     * By default, empty comment lines are left empty,
+     * lines consisting of a single space are replaced by `#`,
+     * and all other lines are prefixed with a `#`.
+     */
+    commentString?: (comment: string) => string;
     /**
      * The default type of string literal used to stringify implicit key values.
      * Output may use other types if required to fully represent the value.
@@ -254,11 +306,12 @@ export declare type ToStringOptions = {
      */
     simpleKeys?: boolean;
     /**
-     * Prefer 'single quote' rather than "double quote" where applicable.
+     * Use 'single quote' rather than "double quote" where applicable.
+     * Set to `false` to disable single quotes completely.
      *
-     * Default: `false`
+     * Default: `null`
      */
-    singleQuote?: boolean;
+    singleQuote?: boolean | null;
     /**
      * String representation for `true`.
      * With the core schema, use `'true'`, `'True'`, or `'TRUE'`.
@@ -275,11 +328,3 @@ export declare type ToStringOptions = {
      */
     verifyAliasOrder?: boolean;
 };
-/**
- * `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.
- */
-export declare const defaultOptions: Required<Omit<ParseOptions, 'lineCounter'> & Omit<DocumentOptions, 'directives'>>;

package/dist/parse/cst-scalar.d.ts

@@ -6,6 +6,12 @@ import type { BlockScalar, FlowScalar, SourceToken, Token } from './cst.js';
  * If `token` is a CST flow or block scalar, determine its string value and a few other attributes.
  * Otherwise, return `null`.
  */
+export declare function resolveAsScalar(token: FlowScalar | BlockScalar, strict?: boolean, onError?: (offset: number, code: ErrorCode, message: string) => void): {
+    value: string;
+    type: Scalar.Type | null;
+    comment: string;
+    range: Range;
+};
 export declare function resolveAsScalar(token: Token | null | undefined, strict?: boolean, onError?: (offset: number, code: ErrorCode, message: string) => void): {
     value: string;
     type: Scalar.Type | null;

package/dist/parse/cst-scalar.js

@@ -5,10 +5,6 @@ var resolveFlowScalar = require('../compose/resolve-flow-scalar.js');
 var errors = require('../errors.js');
 var stringifyString = require('../stringify/stringifyString.js');
 
-/**
- * If `token` is a CST flow or block scalar, determine its string value and a few other attributes.
- * Otherwise, return `null`.
- */
 function resolveAsScalar(token, strict = true, onError) {
     if (token) {
         const _onError = (pos, code, message) => {
@@ -50,7 +46,7 @@ function createScalarToken(value, context) {
         implicitKey,
         indent: indent > 0 ? ' '.repeat(indent) : '',
         inFlow,
-        options: { lineWidth: -1 }
+        options: { blockQuote: true, lineWidth: -1 }
     });
     const end = (_a = context.end) !== null && _a !== void 0 ? _a : [
         { type: 'newline', offset: -1, indent, source: '\n' }
@@ -119,7 +115,7 @@ function setScalarValue(token, value, context = {}) {
         implicitKey: implicitKey || indent === null,
         indent: indent !== null && indent > 0 ? ' '.repeat(indent) : '',
         inFlow,
-        options: { lineWidth: -1 }
+        options: { blockQuote: true, lineWidth: -1 }
     });
     switch (source[0]) {
         case '|':

package/dist/parse/cst-visit.js

@@ -49,7 +49,7 @@ visit.REMOVE = REMOVE;
 visit.itemAtPath = (cst, path) => {
     let item = cst;
     for (const [field, index] of path) {
-        const tok = item && item[field];
+        const tok = item === null || item === void 0 ? void 0 : item[field];
         if (tok && 'items' in tok) {
             item = tok.items[index];
         }
@@ -66,7 +66,7 @@ visit.itemAtPath = (cst, path) => {
 visit.parentCollection = (cst, path) => {
     const parent = visit.itemAtPath(cst, path.slice(0, -1));
     const field = path[path.length - 1][0];
-    const coll = parent && parent[field];
+    const coll = parent === null || parent === void 0 ? void 0 : parent[field];
     if (coll && 'items' in coll)
         return coll;
     throw new Error('Parent collection not found');

package/dist/parse/lexer.js

@@ -150,12 +150,13 @@ class Lexer {
      * @returns A generator of lexical tokens
      */
     *lex(source, incomplete = false) {
+        var _a;
         if (source) {
             this.buffer = this.buffer ? this.buffer + source : source;
             this.lineEndPos = null;
         }
         this.atEnd = !incomplete;
-        let next = this.next || 'stream';
+        let next = (_a = this.next) !== null && _a !== void 0 ? _a : 'stream';
         while (next && (incomplete || this.hasChars(1)))
             next = yield* this.parseNext(next);
     }
@@ -359,14 +360,19 @@ class Lexer {
         let indent = -1;
         do {
             nl = yield* this.pushNewline();
-            sp = yield* this.pushSpaces(true);
-            if (nl > 0)
+            if (nl > 0) {
+                sp = yield* this.pushSpaces(false);
                 this.indentValue = indent = sp;
+            }
+            else {
+                sp = 0;
+            }
+            sp += yield* this.pushSpaces(true);
         } while (nl + sp > 0);
         const line = this.getLine();
         if (line === null)
             return this.setNext('flow');
-        if ((indent !== -1 && indent < this.indentNext) ||
+        if ((indent !== -1 && indent < this.indentNext && line[0] !== '#') ||
             (indent === 0 &&
                 (line.startsWith('---') || line.startsWith('...')) &&
                 isEmpty(line[3]))) {
@@ -384,8 +390,11 @@ class Lexer {
             }
         }
         let n = 0;
-        while (line[n] === ',')
-            n += (yield* this.pushCount(1)) + (yield* this.pushSpaces(true));
+        while (line[n] === ',') {
+            n += yield* this.pushCount(1);
+            n += yield* this.pushSpaces(true);
+            this.flowKey = false;
+        }
         n += yield* this.pushIndicators();
         switch (line[n]) {
             case undefined:
@@ -415,6 +424,7 @@ class Lexer {
             case ':': {
                 const next = this.charAt(1);
                 if (this.flowKey || isEmpty(next) || next === ',') {
+                    this.flowKey = false;
                     yield* this.pushCount(1);
                     yield* this.pushSpaces(true);
                     return 'flow';
@@ -531,9 +541,10 @@ class Lexer {
                 let ch = this.buffer[i];
                 if (ch === '\r')
                     ch = this.buffer[--i];
+                const lastChar = i; // Drop the line if last char not more indented
                 while (ch === ' ' || ch === '\t')
                     ch = this.buffer[--i];
-                if (ch === '\n' && i >= this.pos)
+                if (ch === '\n' && i >= this.pos && i + 1 + indent > lastChar)
                     nl = i;
                 else
                     break;
@@ -616,16 +627,21 @@ class Lexer {
                 return ((yield* this.pushUntil(isNotAnchorChar)) +
                     (yield* this.pushSpaces(true)) +
                     (yield* this.pushIndicators()));
-            case ':':
-            case '?': // this is an error outside flow collections
             case '-': // this is an error
-                if (isEmpty(this.charAt(1))) {
-                    if (this.flowLevel === 0)
+            case '?': // this is an error outside flow collections
+            case ':': {
+                const inFlow = this.flowLevel > 0;
+                const ch1 = this.charAt(1);
+                if (isEmpty(ch1) || (inFlow && invalidFlowScalarChars.includes(ch1))) {
+                    if (!inFlow)
                         this.indentNext = this.indentValue + 1;
+                    else if (this.flowKey)
+                        this.flowKey = false;
                     return ((yield* this.pushCount(1)) +
                         (yield* this.pushSpaces(true)) +
                         (yield* this.pushIndicators()));
                 }
+            }
         }
         return 0;
     }