@automattic/vip 4.1.3 → 4.1.4

package/node_modules/js-yaml/dist/js-yaml.d.ts

@@ -608,7 +608,8 @@ interface ConstructorOptions {
     json?: boolean;
     /**
      * Maximum total number of keys processed by merge (`<<`) across one load
-     * call. Set to `-1` to disable the limit.
+     * call. Each member of a merge sequence also counts as one key. Set to `-1`
+     * to disable the limit.
      *
      * @defaultValue `10000`
      */
@@ -703,23 +704,6 @@ declare function loadAll(input: string, iterator: LoadAllIterator, options?: Loa
  */
 declare function load(input: string, options?: LoadOptions): unknown;
 
-/**
- * Style bitfields, defined as a class only to initialize their defaults.
- *
- * Manually assigned styles are hints; the presenter may use a fallback when
- * needed to produce valid YAML.
- *
- * @category Nodes
- */
-declare class Style {
-    /** Whether to print the node's tag explicitly. */
-    tagged: boolean;
-    flow: boolean;
-    singleQuoted: boolean;
-    doubleQuoted: boolean;
-    literal: boolean;
-    folded: boolean;
-}
 /** @category Nodes */
 interface NodeBase {
     /**
@@ -727,7 +711,8 @@ interface NodeBase {
      * the printable/verbatim tag spelling.
      */
     tag: string;
-    style: Style;
+    /** Whether to print the node's tag explicitly. */
+    tagged: boolean;
     anchor?: string;
     /** Reserved for the formatting layer; not populated by the dumper yet. */
     commentBefore?: string;
@@ -738,23 +723,27 @@ interface NodeBase {
 /** @category Nodes */
 interface ScalarNode extends NodeBase {
     kind: 'scalar';
+    /** Preferred scalar style; the presenter may fall back when necessary. */
+    style: ScalarStyle;
     value: string;
 }
 /** @category Nodes */
 interface SequenceNode extends NodeBase {
     kind: 'sequence';
+    style: CollectionStyle;
     items: Node[];
 }
 /** @category Nodes */
 interface MappingNode extends NodeBase {
     kind: 'mapping';
+    style: CollectionStyle;
     items: Array<{
         key: Node;
         value: Node;
     }>;
 }
 /** @category Nodes */
-interface AliasNode extends NodeBase {
+interface AliasNode {
     kind: 'alias';
     /** The anchor name this alias points at (`*name`). */
     anchor: string;
@@ -778,6 +767,32 @@ interface Document {
     directives: DocumentDirective[];
 }
 
+/** Scalar presentation state passed to styling rules. @category AST */
+interface ScalarLayout {
+    readonly node: Readonly<ScalarNode>;
+    readonly parent: Readonly<Node> | null;
+    readonly level: number;
+    readonly isKey: boolean;
+    readonly flowOnly: boolean;
+    readonly shiftOfParent: number;
+    readonly shiftOfContent: number;
+    readonly shiftOfFirstLine: number;
+    readonly presenterOptions: Readonly<Required<PresenterOptions>>;
+    /**
+     * Bit mask of allowed styles; each bit corresponds to a {@link SCALAR_STYLE}
+     * value.
+     */
+    allowedStylesMask: number;
+    /**
+     * Selected output style, which styling rules may modify. To avoid overriding
+     * earlier decisions, a rule should normally modify it only while it is
+     * {@link SCALAR_STYLE.PLAIN}.
+     */
+    style: ScalarStyle;
+}
+/** Function signature for scalar styling rules. @category AST */
+type ScalarStyleRule = (layout: ScalarLayout) => void;
+
 /** @category AST */
 interface PresenterOptions {
     /** Schema used when selecting a safe scalar style. */
@@ -801,14 +816,8 @@ interface PresenterOptions {
      */
     seqInlineFirst?: boolean;
     /**
-     * Sorts mapping keys when `true`. A function can be provided to define the
-     * sort order.
-     *
-     * @defaultValue `false`
-     */
-    sortKeys?: boolean | ((a: any, b: any) => number);
-    /**
-     * Maximum line width. Set to `-1` for unlimited width.
+     * Preferred line width for folding. Unbreakable and more-indented lines may
+     * exceed it. Set to `-1` for unlimited width.
      *
      * @defaultValue `80`
      */
@@ -827,7 +836,10 @@ interface PresenterOptions {
      */
     flowSkipCommaSpace?: boolean;
     /**
-     * Omits the space after `:` in flow mappings: `{a: 1}` becomes `{a:1}`.
+     * Omits the space after `:` in flow mappings: `{"a": 1}` becomes `{"a":1}`.
+     *
+     * This forces `quoteFlowKeys`; otherwise `a:1` would be parsed as a single
+     * plain scalar instead of a mapping entry.
      *
      * @defaultValue `false`
      */
@@ -850,6 +862,14 @@ interface PresenterOptions {
      * @defaultValue `false`
      */
     forceQuotes?: boolean;
+    /**
+     * Customizes how strings are rendered as plain, quoted, literal, or folded
+     * scalars. Rules are applied in array order; providing this option replaces
+     * the {@link DEFAULT_SCALAR_STYLE_RULES default rules}.
+     *
+     * @defaultValue `Object.values(DEFAULT_SCALAR_STYLE_RULES)`
+     */
+    scalarStyleRules?: readonly ScalarStyleRule[];
     /**
      * Prints an explicit tag before an anchor: `&ref_0 !!set` becomes
      * `!!set &ref_0`.
@@ -893,7 +913,33 @@ interface DumpOptions extends Omit<PresenterOptions, 'schema'> {
      * @defaultValue `-1`
      */
     flowLevel?: number;
-    /** Mutates the generated AST before it is rendered. */
+    /**
+     * Sorts mapping keys when `true`. A function can be provided to define the
+     * sort order.
+     *
+     * @defaultValue `false`
+     * @deprecated Use {@link transform} to reorder mapping items.
+     */
+    sortKeys?: boolean | ((a: any, b: any) => number);
+    /**
+     * Mutates the generated AST before it is rendered.
+     *
+     * @example Sort mapping keys:
+     *
+     * ```typescript
+     * import { dump, visit } from 'js-yaml'
+     *
+     * dump(value, {
+     *   transform: documents => visit(documents, node => {
+     *     if (node.kind === 'mapping') node.items.sort((a, b) => {
+     *       const x = a.key.kind === 'scalar' ? a.key.value : ''
+     *       const y = b.key.kind === 'scalar' ? b.key.value : ''
+     *       return x.localeCompare(y)
+     *     })
+     *   })
+     * })
+     * ```
+     */
     transform?: (documents: Document[]) => void;
 }
 /**
@@ -980,6 +1026,29 @@ interface FromJsOptions {
  */
 declare function jsToAst(input: unknown, schema: Schema, options?: FromJsOptions): Document[];
 
+/**
+ * Default scalar styling rules in application order.
+ * See [Scalar styling](../../docs/scalar_styling.md) for usage details.
+ *
+ * @category AST
+ */
+declare const DEFAULT_SCALAR_STYLE_RULES: {
+    readonly applyQuoteFlowKeysOption: typeof applyQuoteFlowKeysOption;
+    readonly doubleQuoteForInvisibles: typeof doubleQuoteForInvisibles;
+    readonly doubleQuoteWhitespaceOnly: typeof doubleQuoteWhitespaceOnly;
+    readonly applyForceQuotesOption: typeof applyForceQuotesOption;
+    readonly tryLongOrMultilineAsBlock: typeof tryLongOrMultilineAsBlock;
+    readonly quoteInvalidPlain: typeof quoteInvalidPlain;
+    readonly fallbackToDoubleQuoted: typeof fallbackToDoubleQuoted;
+};
+declare function applyQuoteFlowKeysOption(layout: ScalarLayout): void;
+declare function doubleQuoteForInvisibles(layout: ScalarLayout): void;
+declare function doubleQuoteWhitespaceOnly(layout: ScalarLayout): void;
+declare function applyForceQuotesOption(layout: ScalarLayout): void;
+declare function tryLongOrMultilineAsBlock(layout: ScalarLayout): void;
+declare function quoteInvalidPlain(layout: ScalarLayout): void;
+declare function fallbackToDoubleQuoted(layout: ScalarLayout): void;
+
 /**
  * Return from a visitor to stop the whole traversal.
  *
@@ -1053,5 +1122,5 @@ declare const CHOMPING_STRIP: 2;
 /** @deprecated Use `CHOMPING_MODE.KEEP` instead. @internal */
 declare const CHOMPING_KEEP: 3;
 
-export { CHOMPING_CLIP, CHOMPING_KEEP, CHOMPING_MODE, CHOMPING_STRIP, COLLECTION_STYLE, COLLECTION_STYLE_BLOCK, COLLECTION_STYLE_FLOW, CORE_SCHEMA, DUMP_SCHEMA, EVENT_ALIAS, EVENT_DOCUMENT, EVENT_ID, EVENT_MAPPING, EVENT_POP, EVENT_SCALAR, EVENT_SEQUENCE, FAILSAFE_SCHEMA, JSON_SCHEMA, NOT_RESOLVED, SCALAR_STYLE, SCALAR_STYLE_DOUBLE_QUOTED, SCALAR_STYLE_FOLDED_BLOCK, SCALAR_STYLE_LITERAL_BLOCK, SCALAR_STYLE_PLAIN, SCALAR_STYLE_SINGLE_QUOTED, Schema, Style, VISIT_BREAK, VISIT_SKIP, YAML11_SCHEMA, YAMLException, binaryTag, boolCoreTag, boolJsonTag, boolYaml11Tag, constructFromEvents, defineMappingTag, defineScalarTag, defineSequenceTag, dump, eventsToAst, floatCoreTag, floatJsonTag, floatYaml11Tag, getScalarValue, intCoreTag, intJsonTag, intYaml11Tag, jsToAst, legacyMapTag, load, loadAll, mapTag, mergeTag, nullCoreTag, nullJsonTag, nullYaml11Tag, omapTag, pairsTag, parseEvents, present, realMapTag, seqTag, setTag, strTag, timestampTag, visit };
-export type { AliasEvent, AliasNode, ChompingMode, CollectionStyle, ConstructorOptions, Document, DocumentDirective, DocumentEvent, DumpOptions, Event, EventId, FromEventsOptions, FromJsOptions, LoadOptions, MappingEvent, MappingNode, MappingTagDefinition, MappingTagOptions, Node, NodeBase, ParserOptions, PopEvent, PresenterOptions, ScalarEvent, ScalarNode, ScalarStyle, ScalarTagDefinition, ScalarTagOptions, SequenceEvent, SequenceNode, SequenceTagDefinition, SequenceTagOptions, TagDefinition, VisitContext, Visitor };
+export { CHOMPING_CLIP, CHOMPING_KEEP, CHOMPING_MODE, CHOMPING_STRIP, COLLECTION_STYLE, COLLECTION_STYLE_BLOCK, COLLECTION_STYLE_FLOW, CORE_SCHEMA, DEFAULT_SCALAR_STYLE_RULES, DUMP_SCHEMA, EVENT_ALIAS, EVENT_DOCUMENT, EVENT_ID, EVENT_MAPPING, EVENT_POP, EVENT_SCALAR, EVENT_SEQUENCE, FAILSAFE_SCHEMA, JSON_SCHEMA, NOT_RESOLVED, SCALAR_STYLE, SCALAR_STYLE_DOUBLE_QUOTED, SCALAR_STYLE_FOLDED_BLOCK, SCALAR_STYLE_LITERAL_BLOCK, SCALAR_STYLE_PLAIN, SCALAR_STYLE_SINGLE_QUOTED, Schema, VISIT_BREAK, VISIT_SKIP, YAML11_SCHEMA, YAMLException, binaryTag, boolCoreTag, boolJsonTag, boolYaml11Tag, constructFromEvents, defineMappingTag, defineScalarTag, defineSequenceTag, dump, eventsToAst, floatCoreTag, floatJsonTag, floatYaml11Tag, getScalarValue, intCoreTag, intJsonTag, intYaml11Tag, jsToAst, legacyMapTag, load, loadAll, mapTag, mergeTag, nullCoreTag, nullJsonTag, nullYaml11Tag, omapTag, pairsTag, parseEvents, present, realMapTag, seqTag, setTag, strTag, timestampTag, visit };
+export type { AliasEvent, AliasNode, ChompingMode, CollectionStyle, ConstructorOptions, Document, DocumentDirective, DocumentEvent, DumpOptions, Event, EventId, FromEventsOptions, FromJsOptions, LoadOptions, MappingEvent, MappingNode, MappingTagDefinition, MappingTagOptions, Node, NodeBase, ParserOptions, PopEvent, PresenterOptions, ScalarEvent, ScalarLayout, ScalarNode, ScalarStyle, ScalarStyleRule, ScalarTagDefinition, ScalarTagOptions, SequenceEvent, SequenceNode, SequenceTagDefinition, SequenceTagOptions, TagDefinition, VisitContext, Visitor };