phantom-pr 0.2.2 → 0.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/phantom-pr.cjs +20 -0
- package/dist/cli.js +7 -0
- package/dist/cli.js.map +1 -1
- package/node_modules/ignore/LICENSE-MIT +21 -0
- package/node_modules/ignore/README.md +452 -0
- package/node_modules/ignore/index.d.ts +81 -0
- package/node_modules/ignore/index.js +784 -0
- package/node_modules/ignore/legacy.js +681 -0
- package/node_modules/ignore/package.json +87 -0
- package/node_modules/yaml/LICENSE +13 -0
- package/node_modules/yaml/README.md +172 -0
- package/node_modules/yaml/bin.mjs +11 -0
- package/node_modules/yaml/browser/dist/compose/compose-collection.js +88 -0
- package/node_modules/yaml/browser/dist/compose/compose-doc.js +43 -0
- package/node_modules/yaml/browser/dist/compose/compose-node.js +102 -0
- package/node_modules/yaml/browser/dist/compose/compose-scalar.js +86 -0
- package/node_modules/yaml/browser/dist/compose/composer.js +217 -0
- package/node_modules/yaml/browser/dist/compose/resolve-block-map.js +115 -0
- package/node_modules/yaml/browser/dist/compose/resolve-block-scalar.js +198 -0
- package/node_modules/yaml/browser/dist/compose/resolve-block-seq.js +49 -0
- package/node_modules/yaml/browser/dist/compose/resolve-end.js +37 -0
- package/node_modules/yaml/browser/dist/compose/resolve-flow-collection.js +207 -0
- package/node_modules/yaml/browser/dist/compose/resolve-flow-scalar.js +223 -0
- package/node_modules/yaml/browser/dist/compose/resolve-props.js +146 -0
- package/node_modules/yaml/browser/dist/compose/util-contains-newline.js +34 -0
- package/node_modules/yaml/browser/dist/compose/util-empty-scalar-position.js +26 -0
- package/node_modules/yaml/browser/dist/compose/util-flow-indent-check.js +15 -0
- package/node_modules/yaml/browser/dist/compose/util-map-includes.js +13 -0
- package/node_modules/yaml/browser/dist/doc/Document.js +335 -0
- package/node_modules/yaml/browser/dist/doc/anchors.js +71 -0
- package/node_modules/yaml/browser/dist/doc/applyReviver.js +55 -0
- package/node_modules/yaml/browser/dist/doc/createNode.js +88 -0
- package/node_modules/yaml/browser/dist/doc/directives.js +176 -0
- package/node_modules/yaml/browser/dist/errors.js +57 -0
- package/node_modules/yaml/browser/dist/index.js +17 -0
- package/node_modules/yaml/browser/dist/log.js +11 -0
- package/node_modules/yaml/browser/dist/nodes/Alias.js +114 -0
- package/node_modules/yaml/browser/dist/nodes/Collection.js +147 -0
- package/node_modules/yaml/browser/dist/nodes/Node.js +38 -0
- package/node_modules/yaml/browser/dist/nodes/Pair.js +36 -0
- package/node_modules/yaml/browser/dist/nodes/Scalar.js +24 -0
- package/node_modules/yaml/browser/dist/nodes/YAMLMap.js +144 -0
- package/node_modules/yaml/browser/dist/nodes/YAMLSeq.js +113 -0
- package/node_modules/yaml/browser/dist/nodes/addPairToJSMap.js +63 -0
- package/node_modules/yaml/browser/dist/nodes/identity.js +36 -0
- package/node_modules/yaml/browser/dist/nodes/toJS.js +37 -0
- package/node_modules/yaml/browser/dist/parse/cst-scalar.js +214 -0
- package/node_modules/yaml/browser/dist/parse/cst-stringify.js +61 -0
- package/node_modules/yaml/browser/dist/parse/cst-visit.js +97 -0
- package/node_modules/yaml/browser/dist/parse/cst.js +98 -0
- package/node_modules/yaml/browser/dist/parse/lexer.js +717 -0
- package/node_modules/yaml/browser/dist/parse/line-counter.js +39 -0
- package/node_modules/yaml/browser/dist/parse/parser.js +967 -0
- package/node_modules/yaml/browser/dist/public-api.js +102 -0
- package/node_modules/yaml/browser/dist/schema/Schema.js +37 -0
- package/node_modules/yaml/browser/dist/schema/common/map.js +17 -0
- package/node_modules/yaml/browser/dist/schema/common/null.js +15 -0
- package/node_modules/yaml/browser/dist/schema/common/seq.js +17 -0
- package/node_modules/yaml/browser/dist/schema/common/string.js +14 -0
- package/node_modules/yaml/browser/dist/schema/core/bool.js +19 -0
- package/node_modules/yaml/browser/dist/schema/core/float.js +43 -0
- package/node_modules/yaml/browser/dist/schema/core/int.js +38 -0
- package/node_modules/yaml/browser/dist/schema/core/schema.js +23 -0
- package/node_modules/yaml/browser/dist/schema/json/schema.js +62 -0
- package/node_modules/yaml/browser/dist/schema/tags.js +96 -0
- package/node_modules/yaml/browser/dist/schema/yaml-1.1/binary.js +58 -0
- package/node_modules/yaml/browser/dist/schema/yaml-1.1/bool.js +26 -0
- package/node_modules/yaml/browser/dist/schema/yaml-1.1/float.js +46 -0
- package/node_modules/yaml/browser/dist/schema/yaml-1.1/int.js +71 -0
- package/node_modules/yaml/browser/dist/schema/yaml-1.1/merge.js +64 -0
- package/node_modules/yaml/browser/dist/schema/yaml-1.1/omap.js +74 -0
- package/node_modules/yaml/browser/dist/schema/yaml-1.1/pairs.js +78 -0
- package/node_modules/yaml/browser/dist/schema/yaml-1.1/schema.js +39 -0
- package/node_modules/yaml/browser/dist/schema/yaml-1.1/set.js +93 -0
- package/node_modules/yaml/browser/dist/schema/yaml-1.1/timestamp.js +101 -0
- package/node_modules/yaml/browser/dist/stringify/foldFlowLines.js +146 -0
- package/node_modules/yaml/browser/dist/stringify/stringify.js +128 -0
- package/node_modules/yaml/browser/dist/stringify/stringifyCollection.js +143 -0
- package/node_modules/yaml/browser/dist/stringify/stringifyComment.js +20 -0
- package/node_modules/yaml/browser/dist/stringify/stringifyDocument.js +85 -0
- package/node_modules/yaml/browser/dist/stringify/stringifyNumber.js +24 -0
- package/node_modules/yaml/browser/dist/stringify/stringifyPair.js +150 -0
- package/node_modules/yaml/browser/dist/stringify/stringifyString.js +336 -0
- package/node_modules/yaml/browser/dist/util.js +11 -0
- package/node_modules/yaml/browser/dist/visit.js +233 -0
- package/node_modules/yaml/browser/index.js +5 -0
- package/node_modules/yaml/browser/package.json +3 -0
- package/node_modules/yaml/dist/cli.d.ts +8 -0
- package/node_modules/yaml/dist/cli.mjs +201 -0
- package/node_modules/yaml/dist/compose/compose-collection.d.ts +11 -0
- package/node_modules/yaml/dist/compose/compose-collection.js +90 -0
- package/node_modules/yaml/dist/compose/compose-doc.d.ts +7 -0
- package/node_modules/yaml/dist/compose/compose-doc.js +45 -0
- package/node_modules/yaml/dist/compose/compose-node.d.ts +29 -0
- package/node_modules/yaml/dist/compose/compose-node.js +105 -0
- package/node_modules/yaml/dist/compose/compose-scalar.d.ts +5 -0
- package/node_modules/yaml/dist/compose/compose-scalar.js +88 -0
- package/node_modules/yaml/dist/compose/composer.d.ts +63 -0
- package/node_modules/yaml/dist/compose/composer.js +222 -0
- package/node_modules/yaml/dist/compose/resolve-block-map.d.ts +6 -0
- package/node_modules/yaml/dist/compose/resolve-block-map.js +117 -0
- package/node_modules/yaml/dist/compose/resolve-block-scalar.d.ts +11 -0
- package/node_modules/yaml/dist/compose/resolve-block-scalar.js +200 -0
- package/node_modules/yaml/dist/compose/resolve-block-seq.d.ts +6 -0
- package/node_modules/yaml/dist/compose/resolve-block-seq.js +51 -0
- package/node_modules/yaml/dist/compose/resolve-end.d.ts +6 -0
- package/node_modules/yaml/dist/compose/resolve-end.js +39 -0
- package/node_modules/yaml/dist/compose/resolve-flow-collection.d.ts +7 -0
- package/node_modules/yaml/dist/compose/resolve-flow-collection.js +209 -0
- package/node_modules/yaml/dist/compose/resolve-flow-scalar.d.ts +10 -0
- package/node_modules/yaml/dist/compose/resolve-flow-scalar.js +225 -0
- package/node_modules/yaml/dist/compose/resolve-props.d.ts +23 -0
- package/node_modules/yaml/dist/compose/resolve-props.js +148 -0
- package/node_modules/yaml/dist/compose/util-contains-newline.d.ts +2 -0
- package/node_modules/yaml/dist/compose/util-contains-newline.js +36 -0
- package/node_modules/yaml/dist/compose/util-empty-scalar-position.d.ts +2 -0
- package/node_modules/yaml/dist/compose/util-empty-scalar-position.js +28 -0
- package/node_modules/yaml/dist/compose/util-flow-indent-check.d.ts +3 -0
- package/node_modules/yaml/dist/compose/util-flow-indent-check.js +17 -0
- package/node_modules/yaml/dist/compose/util-map-includes.d.ts +4 -0
- package/node_modules/yaml/dist/compose/util-map-includes.js +15 -0
- package/node_modules/yaml/dist/doc/Document.d.ts +141 -0
- package/node_modules/yaml/dist/doc/Document.js +337 -0
- package/node_modules/yaml/dist/doc/anchors.d.ts +24 -0
- package/node_modules/yaml/dist/doc/anchors.js +76 -0
- package/node_modules/yaml/dist/doc/applyReviver.d.ts +9 -0
- package/node_modules/yaml/dist/doc/applyReviver.js +57 -0
- package/node_modules/yaml/dist/doc/createNode.d.ts +17 -0
- package/node_modules/yaml/dist/doc/createNode.js +90 -0
- package/node_modules/yaml/dist/doc/directives.d.ts +49 -0
- package/node_modules/yaml/dist/doc/directives.js +178 -0
- package/node_modules/yaml/dist/errors.d.ts +21 -0
- package/node_modules/yaml/dist/errors.js +62 -0
- package/node_modules/yaml/dist/index.d.ts +25 -0
- package/node_modules/yaml/dist/index.js +50 -0
- package/node_modules/yaml/dist/log.d.ts +3 -0
- package/node_modules/yaml/dist/log.js +19 -0
- package/node_modules/yaml/dist/nodes/Alias.d.ts +29 -0
- package/node_modules/yaml/dist/nodes/Alias.js +116 -0
- package/node_modules/yaml/dist/nodes/Collection.d.ts +73 -0
- package/node_modules/yaml/dist/nodes/Collection.js +151 -0
- package/node_modules/yaml/dist/nodes/Node.d.ts +53 -0
- package/node_modules/yaml/dist/nodes/Node.js +40 -0
- package/node_modules/yaml/dist/nodes/Pair.d.ts +22 -0
- package/node_modules/yaml/dist/nodes/Pair.js +39 -0
- package/node_modules/yaml/dist/nodes/Scalar.d.ts +43 -0
- package/node_modules/yaml/dist/nodes/Scalar.js +27 -0
- package/node_modules/yaml/dist/nodes/YAMLMap.d.ts +53 -0
- package/node_modules/yaml/dist/nodes/YAMLMap.js +147 -0
- package/node_modules/yaml/dist/nodes/YAMLSeq.d.ts +60 -0
- package/node_modules/yaml/dist/nodes/YAMLSeq.js +115 -0
- package/node_modules/yaml/dist/nodes/addPairToJSMap.d.ts +4 -0
- package/node_modules/yaml/dist/nodes/addPairToJSMap.js +65 -0
- package/node_modules/yaml/dist/nodes/identity.d.ts +23 -0
- package/node_modules/yaml/dist/nodes/identity.js +53 -0
- package/node_modules/yaml/dist/nodes/toJS.d.ts +29 -0
- package/node_modules/yaml/dist/nodes/toJS.js +39 -0
- package/node_modules/yaml/dist/options.d.ts +344 -0
- package/node_modules/yaml/dist/parse/cst-scalar.d.ts +64 -0
- package/node_modules/yaml/dist/parse/cst-scalar.js +218 -0
- package/node_modules/yaml/dist/parse/cst-stringify.d.ts +8 -0
- package/node_modules/yaml/dist/parse/cst-stringify.js +63 -0
- package/node_modules/yaml/dist/parse/cst-visit.d.ts +39 -0
- package/node_modules/yaml/dist/parse/cst-visit.js +99 -0
- package/node_modules/yaml/dist/parse/cst.d.ts +109 -0
- package/node_modules/yaml/dist/parse/cst.js +112 -0
- package/node_modules/yaml/dist/parse/lexer.d.ts +87 -0
- package/node_modules/yaml/dist/parse/lexer.js +719 -0
- package/node_modules/yaml/dist/parse/line-counter.d.ts +22 -0
- package/node_modules/yaml/dist/parse/line-counter.js +41 -0
- package/node_modules/yaml/dist/parse/parser.d.ts +84 -0
- package/node_modules/yaml/dist/parse/parser.js +972 -0
- package/node_modules/yaml/dist/public-api.d.ts +44 -0
- package/node_modules/yaml/dist/public-api.js +107 -0
- package/node_modules/yaml/dist/schema/Schema.d.ts +17 -0
- package/node_modules/yaml/dist/schema/Schema.js +39 -0
- package/node_modules/yaml/dist/schema/common/map.d.ts +2 -0
- package/node_modules/yaml/dist/schema/common/map.js +19 -0
- package/node_modules/yaml/dist/schema/common/null.d.ts +4 -0
- package/node_modules/yaml/dist/schema/common/null.js +17 -0
- package/node_modules/yaml/dist/schema/common/seq.d.ts +2 -0
- package/node_modules/yaml/dist/schema/common/seq.js +19 -0
- package/node_modules/yaml/dist/schema/common/string.d.ts +2 -0
- package/node_modules/yaml/dist/schema/common/string.js +16 -0
- package/node_modules/yaml/dist/schema/core/bool.d.ts +4 -0
- package/node_modules/yaml/dist/schema/core/bool.js +21 -0
- package/node_modules/yaml/dist/schema/core/float.d.ts +4 -0
- package/node_modules/yaml/dist/schema/core/float.js +47 -0
- package/node_modules/yaml/dist/schema/core/int.d.ts +4 -0
- package/node_modules/yaml/dist/schema/core/int.js +42 -0
- package/node_modules/yaml/dist/schema/core/schema.d.ts +1 -0
- package/node_modules/yaml/dist/schema/core/schema.js +25 -0
- package/node_modules/yaml/dist/schema/json/schema.d.ts +2 -0
- package/node_modules/yaml/dist/schema/json/schema.js +64 -0
- package/node_modules/yaml/dist/schema/json-schema.d.ts +69 -0
- package/node_modules/yaml/dist/schema/tags.d.ts +48 -0
- package/node_modules/yaml/dist/schema/tags.js +99 -0
- package/node_modules/yaml/dist/schema/types.d.ts +92 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/binary.d.ts +2 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/binary.js +70 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/bool.d.ts +7 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/bool.js +29 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/float.d.ts +4 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/float.js +50 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/int.d.ts +5 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/int.js +76 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/merge.d.ts +9 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/merge.js +68 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/omap.d.ts +22 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/omap.js +77 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/pairs.d.ts +10 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/pairs.js +82 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/schema.d.ts +1 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/schema.js +41 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/set.d.ts +28 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/set.js +96 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/timestamp.d.ts +6 -0
- package/node_modules/yaml/dist/schema/yaml-1.1/timestamp.js +105 -0
- package/node_modules/yaml/dist/stringify/foldFlowLines.d.ts +34 -0
- package/node_modules/yaml/dist/stringify/foldFlowLines.js +151 -0
- package/node_modules/yaml/dist/stringify/stringify.d.ts +21 -0
- package/node_modules/yaml/dist/stringify/stringify.js +131 -0
- package/node_modules/yaml/dist/stringify/stringifyCollection.d.ts +17 -0
- package/node_modules/yaml/dist/stringify/stringifyCollection.js +145 -0
- package/node_modules/yaml/dist/stringify/stringifyComment.d.ts +10 -0
- package/node_modules/yaml/dist/stringify/stringifyComment.js +24 -0
- package/node_modules/yaml/dist/stringify/stringifyDocument.d.ts +4 -0
- package/node_modules/yaml/dist/stringify/stringifyDocument.js +87 -0
- package/node_modules/yaml/dist/stringify/stringifyNumber.d.ts +2 -0
- package/node_modules/yaml/dist/stringify/stringifyNumber.js +26 -0
- package/node_modules/yaml/dist/stringify/stringifyPair.d.ts +3 -0
- package/node_modules/yaml/dist/stringify/stringifyPair.js +152 -0
- package/node_modules/yaml/dist/stringify/stringifyString.d.ts +9 -0
- package/node_modules/yaml/dist/stringify/stringifyString.js +338 -0
- package/node_modules/yaml/dist/test-events.d.ts +4 -0
- package/node_modules/yaml/dist/test-events.js +134 -0
- package/node_modules/yaml/dist/util.d.ts +16 -0
- package/node_modules/yaml/dist/util.js +28 -0
- package/node_modules/yaml/dist/visit.d.ts +102 -0
- package/node_modules/yaml/dist/visit.js +236 -0
- package/node_modules/yaml/package.json +97 -0
- package/node_modules/yaml/util.js +2 -0
- package/package.json +7 -3
|
@@ -0,0 +1,338 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var Scalar = require('../nodes/Scalar.js');
|
|
4
|
+
var foldFlowLines = require('./foldFlowLines.js');
|
|
5
|
+
|
|
6
|
+
const getFoldOptions = (ctx, isBlock) => ({
|
|
7
|
+
indentAtStart: isBlock ? ctx.indent.length : ctx.indentAtStart,
|
|
8
|
+
lineWidth: ctx.options.lineWidth,
|
|
9
|
+
minContentWidth: ctx.options.minContentWidth
|
|
10
|
+
});
|
|
11
|
+
// Also checks for lines starting with %, as parsing the output as YAML 1.1 will
|
|
12
|
+
// presume that's starting a new document.
|
|
13
|
+
const containsDocumentMarker = (str) => /^(%|---|\.\.\.)/m.test(str);
|
|
14
|
+
function lineLengthOverLimit(str, lineWidth, indentLength) {
|
|
15
|
+
if (!lineWidth || lineWidth < 0)
|
|
16
|
+
return false;
|
|
17
|
+
const limit = lineWidth - indentLength;
|
|
18
|
+
const strLen = str.length;
|
|
19
|
+
if (strLen <= limit)
|
|
20
|
+
return false;
|
|
21
|
+
for (let i = 0, start = 0; i < strLen; ++i) {
|
|
22
|
+
if (str[i] === '\n') {
|
|
23
|
+
if (i - start > limit)
|
|
24
|
+
return true;
|
|
25
|
+
start = i + 1;
|
|
26
|
+
if (strLen - start <= limit)
|
|
27
|
+
return false;
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
return true;
|
|
31
|
+
}
|
|
32
|
+
function doubleQuotedString(value, ctx) {
|
|
33
|
+
const json = JSON.stringify(value);
|
|
34
|
+
if (ctx.options.doubleQuotedAsJSON)
|
|
35
|
+
return json;
|
|
36
|
+
const { implicitKey } = ctx;
|
|
37
|
+
const minMultiLineLength = ctx.options.doubleQuotedMinMultiLineLength;
|
|
38
|
+
const indent = ctx.indent || (containsDocumentMarker(value) ? ' ' : '');
|
|
39
|
+
let str = '';
|
|
40
|
+
let start = 0;
|
|
41
|
+
for (let i = 0, ch = json[i]; ch; ch = json[++i]) {
|
|
42
|
+
if (ch === ' ' && json[i + 1] === '\\' && json[i + 2] === 'n') {
|
|
43
|
+
// space before newline needs to be escaped to not be folded
|
|
44
|
+
str += json.slice(start, i) + '\\ ';
|
|
45
|
+
i += 1;
|
|
46
|
+
start = i;
|
|
47
|
+
ch = '\\';
|
|
48
|
+
}
|
|
49
|
+
if (ch === '\\')
|
|
50
|
+
switch (json[i + 1]) {
|
|
51
|
+
case 'u':
|
|
52
|
+
{
|
|
53
|
+
str += json.slice(start, i);
|
|
54
|
+
const code = json.substr(i + 2, 4);
|
|
55
|
+
switch (code) {
|
|
56
|
+
case '0000':
|
|
57
|
+
str += '\\0';
|
|
58
|
+
break;
|
|
59
|
+
case '0007':
|
|
60
|
+
str += '\\a';
|
|
61
|
+
break;
|
|
62
|
+
case '000b':
|
|
63
|
+
str += '\\v';
|
|
64
|
+
break;
|
|
65
|
+
case '001b':
|
|
66
|
+
str += '\\e';
|
|
67
|
+
break;
|
|
68
|
+
case '0085':
|
|
69
|
+
str += '\\N';
|
|
70
|
+
break;
|
|
71
|
+
case '00a0':
|
|
72
|
+
str += '\\_';
|
|
73
|
+
break;
|
|
74
|
+
case '2028':
|
|
75
|
+
str += '\\L';
|
|
76
|
+
break;
|
|
77
|
+
case '2029':
|
|
78
|
+
str += '\\P';
|
|
79
|
+
break;
|
|
80
|
+
default:
|
|
81
|
+
if (code.substr(0, 2) === '00')
|
|
82
|
+
str += '\\x' + code.substr(2);
|
|
83
|
+
else
|
|
84
|
+
str += json.substr(i, 6);
|
|
85
|
+
}
|
|
86
|
+
i += 5;
|
|
87
|
+
start = i + 1;
|
|
88
|
+
}
|
|
89
|
+
break;
|
|
90
|
+
case 'n':
|
|
91
|
+
if (implicitKey ||
|
|
92
|
+
json[i + 2] === '"' ||
|
|
93
|
+
json.length < minMultiLineLength) {
|
|
94
|
+
i += 1;
|
|
95
|
+
}
|
|
96
|
+
else {
|
|
97
|
+
// folding will eat first newline
|
|
98
|
+
str += json.slice(start, i) + '\n\n';
|
|
99
|
+
while (json[i + 2] === '\\' &&
|
|
100
|
+
json[i + 3] === 'n' &&
|
|
101
|
+
json[i + 4] !== '"') {
|
|
102
|
+
str += '\n';
|
|
103
|
+
i += 2;
|
|
104
|
+
}
|
|
105
|
+
str += indent;
|
|
106
|
+
// space after newline needs to be escaped to not be folded
|
|
107
|
+
if (json[i + 2] === ' ')
|
|
108
|
+
str += '\\';
|
|
109
|
+
i += 1;
|
|
110
|
+
start = i + 1;
|
|
111
|
+
}
|
|
112
|
+
break;
|
|
113
|
+
default:
|
|
114
|
+
i += 1;
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
str = start ? str + json.slice(start) : json;
|
|
118
|
+
return implicitKey
|
|
119
|
+
? str
|
|
120
|
+
: foldFlowLines.foldFlowLines(str, indent, foldFlowLines.FOLD_QUOTED, getFoldOptions(ctx, false));
|
|
121
|
+
}
|
|
122
|
+
function singleQuotedString(value, ctx) {
|
|
123
|
+
if (ctx.options.singleQuote === false ||
|
|
124
|
+
(ctx.implicitKey && value.includes('\n')) ||
|
|
125
|
+
/[ \t]\n|\n[ \t]/.test(value) // single quoted string can't have leading or trailing whitespace around newline
|
|
126
|
+
)
|
|
127
|
+
return doubleQuotedString(value, ctx);
|
|
128
|
+
const indent = ctx.indent || (containsDocumentMarker(value) ? ' ' : '');
|
|
129
|
+
const res = "'" + value.replace(/'/g, "''").replace(/\n+/g, `$&\n${indent}`) + "'";
|
|
130
|
+
return ctx.implicitKey
|
|
131
|
+
? res
|
|
132
|
+
: foldFlowLines.foldFlowLines(res, indent, foldFlowLines.FOLD_FLOW, getFoldOptions(ctx, false));
|
|
133
|
+
}
|
|
134
|
+
function quotedString(value, ctx) {
|
|
135
|
+
const { singleQuote } = ctx.options;
|
|
136
|
+
let qs;
|
|
137
|
+
if (singleQuote === false)
|
|
138
|
+
qs = doubleQuotedString;
|
|
139
|
+
else {
|
|
140
|
+
const hasDouble = value.includes('"');
|
|
141
|
+
const hasSingle = value.includes("'");
|
|
142
|
+
if (hasDouble && !hasSingle)
|
|
143
|
+
qs = singleQuotedString;
|
|
144
|
+
else if (hasSingle && !hasDouble)
|
|
145
|
+
qs = doubleQuotedString;
|
|
146
|
+
else
|
|
147
|
+
qs = singleQuote ? singleQuotedString : doubleQuotedString;
|
|
148
|
+
}
|
|
149
|
+
return qs(value, ctx);
|
|
150
|
+
}
|
|
151
|
+
// The negative lookbehind avoids a polynomial search,
|
|
152
|
+
// but isn't supported yet on Safari: https://caniuse.com/js-regexp-lookbehind
|
|
153
|
+
let blockEndNewlines;
|
|
154
|
+
try {
|
|
155
|
+
blockEndNewlines = new RegExp('(^|(?<!\n))\n+(?!\n|$)', 'g');
|
|
156
|
+
}
|
|
157
|
+
catch {
|
|
158
|
+
blockEndNewlines = /\n+(?!\n|$)/g;
|
|
159
|
+
}
|
|
160
|
+
function blockString({ comment, type, value }, ctx, onComment, onChompKeep) {
|
|
161
|
+
const { blockQuote, commentString, lineWidth } = ctx.options;
|
|
162
|
+
// 1. Block can't end in whitespace unless the last line is non-empty.
|
|
163
|
+
// 2. Strings consisting of only whitespace are best rendered explicitly.
|
|
164
|
+
if (!blockQuote || /\n[\t ]+$/.test(value)) {
|
|
165
|
+
return quotedString(value, ctx);
|
|
166
|
+
}
|
|
167
|
+
const indent = ctx.indent ||
|
|
168
|
+
(ctx.forceBlockIndent || containsDocumentMarker(value) ? ' ' : '');
|
|
169
|
+
const literal = blockQuote === 'literal'
|
|
170
|
+
? true
|
|
171
|
+
: blockQuote === 'folded' || type === Scalar.Scalar.BLOCK_FOLDED
|
|
172
|
+
? false
|
|
173
|
+
: type === Scalar.Scalar.BLOCK_LITERAL
|
|
174
|
+
? true
|
|
175
|
+
: !lineLengthOverLimit(value, lineWidth, indent.length);
|
|
176
|
+
if (!value)
|
|
177
|
+
return literal ? '|\n' : '>\n';
|
|
178
|
+
// determine chomping from whitespace at value end
|
|
179
|
+
let chomp;
|
|
180
|
+
let endStart;
|
|
181
|
+
for (endStart = value.length; endStart > 0; --endStart) {
|
|
182
|
+
const ch = value[endStart - 1];
|
|
183
|
+
if (ch !== '\n' && ch !== '\t' && ch !== ' ')
|
|
184
|
+
break;
|
|
185
|
+
}
|
|
186
|
+
let end = value.substring(endStart);
|
|
187
|
+
const endNlPos = end.indexOf('\n');
|
|
188
|
+
if (endNlPos === -1) {
|
|
189
|
+
chomp = '-'; // strip
|
|
190
|
+
}
|
|
191
|
+
else if (value === end || endNlPos !== end.length - 1) {
|
|
192
|
+
chomp = '+'; // keep
|
|
193
|
+
if (onChompKeep)
|
|
194
|
+
onChompKeep();
|
|
195
|
+
}
|
|
196
|
+
else {
|
|
197
|
+
chomp = ''; // clip
|
|
198
|
+
}
|
|
199
|
+
if (end) {
|
|
200
|
+
value = value.slice(0, -end.length);
|
|
201
|
+
if (end[end.length - 1] === '\n')
|
|
202
|
+
end = end.slice(0, -1);
|
|
203
|
+
end = end.replace(blockEndNewlines, `$&${indent}`);
|
|
204
|
+
}
|
|
205
|
+
// determine indent indicator from whitespace at value start
|
|
206
|
+
let startWithSpace = false;
|
|
207
|
+
let startEnd;
|
|
208
|
+
let startNlPos = -1;
|
|
209
|
+
for (startEnd = 0; startEnd < value.length; ++startEnd) {
|
|
210
|
+
const ch = value[startEnd];
|
|
211
|
+
if (ch === ' ')
|
|
212
|
+
startWithSpace = true;
|
|
213
|
+
else if (ch === '\n')
|
|
214
|
+
startNlPos = startEnd;
|
|
215
|
+
else
|
|
216
|
+
break;
|
|
217
|
+
}
|
|
218
|
+
let start = value.substring(0, startNlPos < startEnd ? startNlPos + 1 : startEnd);
|
|
219
|
+
if (start) {
|
|
220
|
+
value = value.substring(start.length);
|
|
221
|
+
start = start.replace(/\n+/g, `$&${indent}`);
|
|
222
|
+
}
|
|
223
|
+
const indentSize = indent ? '2' : '1'; // root is at -1
|
|
224
|
+
// Leading | or > is added later
|
|
225
|
+
let header = (startWithSpace ? indentSize : '') + chomp;
|
|
226
|
+
if (comment) {
|
|
227
|
+
header += ' ' + commentString(comment.replace(/ ?[\r\n]+/g, ' '));
|
|
228
|
+
if (onComment)
|
|
229
|
+
onComment();
|
|
230
|
+
}
|
|
231
|
+
if (!literal) {
|
|
232
|
+
const foldedValue = value
|
|
233
|
+
.replace(/\n+/g, '\n$&')
|
|
234
|
+
.replace(/(?:^|\n)([\t ].*)(?:([\n\t ]*)\n(?![\n\t ]))?/g, '$1$2') // more-indented lines aren't folded
|
|
235
|
+
// ^ more-ind. ^ empty ^ capture next empty lines only at end of indent
|
|
236
|
+
.replace(/\n+/g, `$&${indent}`);
|
|
237
|
+
let literalFallback = false;
|
|
238
|
+
const foldOptions = getFoldOptions(ctx, true);
|
|
239
|
+
if (blockQuote !== 'folded' && type !== Scalar.Scalar.BLOCK_FOLDED) {
|
|
240
|
+
foldOptions.onOverflow = () => {
|
|
241
|
+
literalFallback = true;
|
|
242
|
+
};
|
|
243
|
+
}
|
|
244
|
+
const body = foldFlowLines.foldFlowLines(`${start}${foldedValue}${end}`, indent, foldFlowLines.FOLD_BLOCK, foldOptions);
|
|
245
|
+
if (!literalFallback)
|
|
246
|
+
return `>${header}\n${indent}${body}`;
|
|
247
|
+
}
|
|
248
|
+
value = value.replace(/\n+/g, `$&${indent}`);
|
|
249
|
+
return `|${header}\n${indent}${start}${value}${end}`;
|
|
250
|
+
}
|
|
251
|
+
function plainString(item, ctx, onComment, onChompKeep) {
|
|
252
|
+
const { type, value } = item;
|
|
253
|
+
const { actualString, implicitKey, indent, indentStep, inFlow } = ctx;
|
|
254
|
+
if ((implicitKey && value.includes('\n')) ||
|
|
255
|
+
(inFlow && /[[\]{},]/.test(value))) {
|
|
256
|
+
return quotedString(value, ctx);
|
|
257
|
+
}
|
|
258
|
+
if (/^[\n\t ,[\]{}#&*!|>'"%@`]|^[?-]$|^[?-][ \t]|[\n:][ \t]|[ \t]\n|[\n\t ]#|[\n\t :]$/.test(value)) {
|
|
259
|
+
// not allowed:
|
|
260
|
+
// - '-' or '?'
|
|
261
|
+
// - start with an indicator character (except [?:-]) or /[?-] /
|
|
262
|
+
// - '\n ', ': ' or ' \n' anywhere
|
|
263
|
+
// - '#' not preceded by a non-space char
|
|
264
|
+
// - end with ' ' or ':'
|
|
265
|
+
return implicitKey || inFlow || !value.includes('\n')
|
|
266
|
+
? quotedString(value, ctx)
|
|
267
|
+
: blockString(item, ctx, onComment, onChompKeep);
|
|
268
|
+
}
|
|
269
|
+
if (!implicitKey &&
|
|
270
|
+
!inFlow &&
|
|
271
|
+
type !== Scalar.Scalar.PLAIN &&
|
|
272
|
+
value.includes('\n')) {
|
|
273
|
+
// Where allowed & type not set explicitly, prefer block style for multiline strings
|
|
274
|
+
return blockString(item, ctx, onComment, onChompKeep);
|
|
275
|
+
}
|
|
276
|
+
if (containsDocumentMarker(value)) {
|
|
277
|
+
if (indent === '') {
|
|
278
|
+
ctx.forceBlockIndent = true;
|
|
279
|
+
return blockString(item, ctx, onComment, onChompKeep);
|
|
280
|
+
}
|
|
281
|
+
else if (implicitKey && indent === indentStep) {
|
|
282
|
+
return quotedString(value, ctx);
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
const str = value.replace(/\n+/g, `$&\n${indent}`);
|
|
286
|
+
// Verify that output will be parsed as a string, as e.g. plain numbers and
|
|
287
|
+
// booleans get parsed with those types in v1.2 (e.g. '42', 'true' & '0.9e-3'),
|
|
288
|
+
// and others in v1.1.
|
|
289
|
+
if (actualString) {
|
|
290
|
+
const test = (tag) => tag.default && tag.tag !== 'tag:yaml.org,2002:str' && tag.test?.test(str);
|
|
291
|
+
const { compat, tags } = ctx.doc.schema;
|
|
292
|
+
if (tags.some(test) || compat?.some(test))
|
|
293
|
+
return quotedString(value, ctx);
|
|
294
|
+
}
|
|
295
|
+
return implicitKey
|
|
296
|
+
? str
|
|
297
|
+
: foldFlowLines.foldFlowLines(str, indent, foldFlowLines.FOLD_FLOW, getFoldOptions(ctx, false));
|
|
298
|
+
}
|
|
299
|
+
function stringifyString(item, ctx, onComment, onChompKeep) {
|
|
300
|
+
const { implicitKey, inFlow } = ctx;
|
|
301
|
+
const ss = typeof item.value === 'string'
|
|
302
|
+
? item
|
|
303
|
+
: Object.assign({}, item, { value: String(item.value) });
|
|
304
|
+
let { type } = item;
|
|
305
|
+
if (type !== Scalar.Scalar.QUOTE_DOUBLE) {
|
|
306
|
+
// force double quotes on control characters & unpaired surrogates
|
|
307
|
+
if (/[\x00-\x08\x0b-\x1f\x7f-\x9f\u{D800}-\u{DFFF}]/u.test(ss.value))
|
|
308
|
+
type = Scalar.Scalar.QUOTE_DOUBLE;
|
|
309
|
+
}
|
|
310
|
+
const _stringify = (_type) => {
|
|
311
|
+
switch (_type) {
|
|
312
|
+
case Scalar.Scalar.BLOCK_FOLDED:
|
|
313
|
+
case Scalar.Scalar.BLOCK_LITERAL:
|
|
314
|
+
return implicitKey || inFlow
|
|
315
|
+
? quotedString(ss.value, ctx) // blocks are not valid inside flow containers
|
|
316
|
+
: blockString(ss, ctx, onComment, onChompKeep);
|
|
317
|
+
case Scalar.Scalar.QUOTE_DOUBLE:
|
|
318
|
+
return doubleQuotedString(ss.value, ctx);
|
|
319
|
+
case Scalar.Scalar.QUOTE_SINGLE:
|
|
320
|
+
return singleQuotedString(ss.value, ctx);
|
|
321
|
+
case Scalar.Scalar.PLAIN:
|
|
322
|
+
return plainString(ss, ctx, onComment, onChompKeep);
|
|
323
|
+
default:
|
|
324
|
+
return null;
|
|
325
|
+
}
|
|
326
|
+
};
|
|
327
|
+
let res = _stringify(type);
|
|
328
|
+
if (res === null) {
|
|
329
|
+
const { defaultKeyType, defaultStringType } = ctx.options;
|
|
330
|
+
const t = (implicitKey && defaultKeyType) || defaultStringType;
|
|
331
|
+
res = _stringify(t);
|
|
332
|
+
if (res === null)
|
|
333
|
+
throw new Error(`Unsupported default string type ${t}`);
|
|
334
|
+
}
|
|
335
|
+
return res;
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
exports.stringifyString = stringifyString;
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var identity = require('./nodes/identity.js');
|
|
4
|
+
var publicApi = require('./public-api.js');
|
|
5
|
+
var visit = require('./visit.js');
|
|
6
|
+
|
|
7
|
+
const scalarChar = {
|
|
8
|
+
BLOCK_FOLDED: '>',
|
|
9
|
+
BLOCK_LITERAL: '|',
|
|
10
|
+
PLAIN: ':',
|
|
11
|
+
QUOTE_DOUBLE: '"',
|
|
12
|
+
QUOTE_SINGLE: "'"
|
|
13
|
+
};
|
|
14
|
+
function anchorExists(doc, anchor) {
|
|
15
|
+
let found = false;
|
|
16
|
+
visit.visit(doc, {
|
|
17
|
+
Value(_key, node) {
|
|
18
|
+
if (node.anchor === anchor) {
|
|
19
|
+
found = true;
|
|
20
|
+
return visit.visit.BREAK;
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
});
|
|
24
|
+
return found;
|
|
25
|
+
}
|
|
26
|
+
// test harness for yaml-test-suite event tests
|
|
27
|
+
function testEvents(src) {
|
|
28
|
+
const docs = publicApi.parseAllDocuments(src);
|
|
29
|
+
const errDoc = docs.find(doc => doc.errors.length > 0);
|
|
30
|
+
const error = errDoc ? errDoc.errors[0].message : null;
|
|
31
|
+
const events = ['+STR'];
|
|
32
|
+
try {
|
|
33
|
+
for (let i = 0; i < docs.length; ++i) {
|
|
34
|
+
const doc = docs[i];
|
|
35
|
+
let root = doc.contents;
|
|
36
|
+
if (Array.isArray(root))
|
|
37
|
+
root = root[0];
|
|
38
|
+
const [rootStart] = doc.range || [0];
|
|
39
|
+
const error = doc.errors[0];
|
|
40
|
+
if (error && (!error.pos || error.pos[0] < rootStart))
|
|
41
|
+
throw new Error();
|
|
42
|
+
let docStart = '+DOC';
|
|
43
|
+
if (doc.directives.docStart)
|
|
44
|
+
docStart += ' ---';
|
|
45
|
+
else if (doc.contents &&
|
|
46
|
+
doc.contents.range[2] === doc.contents.range[0] &&
|
|
47
|
+
!doc.contents.anchor &&
|
|
48
|
+
!doc.contents.tag)
|
|
49
|
+
continue;
|
|
50
|
+
events.push(docStart);
|
|
51
|
+
addEvents(events, doc, error?.pos[0] ?? -1, root);
|
|
52
|
+
let docEnd = '-DOC';
|
|
53
|
+
if (doc.directives.docEnd)
|
|
54
|
+
docEnd += ' ...';
|
|
55
|
+
events.push(docEnd);
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
catch (e) {
|
|
59
|
+
return { events, error: error ?? e };
|
|
60
|
+
}
|
|
61
|
+
events.push('-STR');
|
|
62
|
+
return { events, error };
|
|
63
|
+
}
|
|
64
|
+
function addEvents(events, doc, errPos, node) {
|
|
65
|
+
if (!node) {
|
|
66
|
+
events.push('=VAL :');
|
|
67
|
+
return;
|
|
68
|
+
}
|
|
69
|
+
if (errPos !== -1 && identity.isNode(node) && node.range[0] >= errPos)
|
|
70
|
+
throw new Error();
|
|
71
|
+
let props = '';
|
|
72
|
+
let anchor = identity.isScalar(node) || identity.isCollection(node) ? node.anchor : undefined;
|
|
73
|
+
if (anchor) {
|
|
74
|
+
if (/\d$/.test(anchor)) {
|
|
75
|
+
const alt = anchor.replace(/\d$/, '');
|
|
76
|
+
if (anchorExists(doc, alt))
|
|
77
|
+
anchor = alt;
|
|
78
|
+
}
|
|
79
|
+
props = ` &${anchor}`;
|
|
80
|
+
}
|
|
81
|
+
if (identity.isNode(node) && node.tag)
|
|
82
|
+
props += ` <${node.tag}>`;
|
|
83
|
+
if (identity.isMap(node)) {
|
|
84
|
+
const ev = node.flow ? '+MAP {}' : '+MAP';
|
|
85
|
+
events.push(`${ev}${props}`);
|
|
86
|
+
node.items.forEach(({ key, value }) => {
|
|
87
|
+
addEvents(events, doc, errPos, key);
|
|
88
|
+
addEvents(events, doc, errPos, value);
|
|
89
|
+
});
|
|
90
|
+
events.push('-MAP');
|
|
91
|
+
}
|
|
92
|
+
else if (identity.isSeq(node)) {
|
|
93
|
+
const ev = node.flow ? '+SEQ []' : '+SEQ';
|
|
94
|
+
events.push(`${ev}${props}`);
|
|
95
|
+
node.items.forEach(item => {
|
|
96
|
+
addEvents(events, doc, errPos, item);
|
|
97
|
+
});
|
|
98
|
+
events.push('-SEQ');
|
|
99
|
+
}
|
|
100
|
+
else if (identity.isPair(node)) {
|
|
101
|
+
events.push(`+MAP${props}`);
|
|
102
|
+
addEvents(events, doc, errPos, node.key);
|
|
103
|
+
addEvents(events, doc, errPos, node.value);
|
|
104
|
+
events.push('-MAP');
|
|
105
|
+
}
|
|
106
|
+
else if (identity.isAlias(node)) {
|
|
107
|
+
let alias = node.source;
|
|
108
|
+
if (alias && /\d$/.test(alias)) {
|
|
109
|
+
const alt = alias.replace(/\d$/, '');
|
|
110
|
+
if (anchorExists(doc, alt))
|
|
111
|
+
alias = alt;
|
|
112
|
+
}
|
|
113
|
+
events.push(`=ALI${props} *${alias}`);
|
|
114
|
+
}
|
|
115
|
+
else {
|
|
116
|
+
const scalar = scalarChar[String(node.type)];
|
|
117
|
+
if (!scalar)
|
|
118
|
+
throw new Error(`Unexpected node type ${node.type}`);
|
|
119
|
+
const value = node.source
|
|
120
|
+
.replace(/\\/g, '\\\\')
|
|
121
|
+
.replace(/\0/g, '\\0')
|
|
122
|
+
.replace(/\x07/g, '\\a')
|
|
123
|
+
.replace(/\x08/g, '\\b')
|
|
124
|
+
.replace(/\t/g, '\\t')
|
|
125
|
+
.replace(/\n/g, '\\n')
|
|
126
|
+
.replace(/\v/g, '\\v')
|
|
127
|
+
.replace(/\f/g, '\\f')
|
|
128
|
+
.replace(/\r/g, '\\r')
|
|
129
|
+
.replace(/\x1b/g, '\\e');
|
|
130
|
+
events.push(`=VAL${props} ${scalar}${value}`);
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
exports.testEvents = testEvents;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export { createNode } from './doc/createNode';
|
|
2
|
+
export type { CreateNodeContext } from './doc/createNode';
|
|
3
|
+
export { debug, warn } from './log';
|
|
4
|
+
export type { LogLevelId } from './log';
|
|
5
|
+
export { createPair } from './nodes/Pair';
|
|
6
|
+
export { toJS } from './nodes/toJS';
|
|
7
|
+
export type { ToJSContext } from './nodes/toJS';
|
|
8
|
+
export { findPair } from './nodes/YAMLMap';
|
|
9
|
+
export { map as mapTag } from './schema/common/map';
|
|
10
|
+
export { seq as seqTag } from './schema/common/seq';
|
|
11
|
+
export { string as stringTag } from './schema/common/string';
|
|
12
|
+
export { foldFlowLines } from './stringify/foldFlowLines';
|
|
13
|
+
export type { FoldOptions } from './stringify/foldFlowLines';
|
|
14
|
+
export type { StringifyContext } from './stringify/stringify';
|
|
15
|
+
export { stringifyNumber } from './stringify/stringifyNumber';
|
|
16
|
+
export { stringifyString } from './stringify/stringifyString';
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var createNode = require('./doc/createNode.js');
|
|
4
|
+
var log = require('./log.js');
|
|
5
|
+
var Pair = require('./nodes/Pair.js');
|
|
6
|
+
var toJS = require('./nodes/toJS.js');
|
|
7
|
+
var YAMLMap = require('./nodes/YAMLMap.js');
|
|
8
|
+
var map = require('./schema/common/map.js');
|
|
9
|
+
var seq = require('./schema/common/seq.js');
|
|
10
|
+
var string = require('./schema/common/string.js');
|
|
11
|
+
var foldFlowLines = require('./stringify/foldFlowLines.js');
|
|
12
|
+
var stringifyNumber = require('./stringify/stringifyNumber.js');
|
|
13
|
+
var stringifyString = require('./stringify/stringifyString.js');
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
exports.createNode = createNode.createNode;
|
|
18
|
+
exports.debug = log.debug;
|
|
19
|
+
exports.warn = log.warn;
|
|
20
|
+
exports.createPair = Pair.createPair;
|
|
21
|
+
exports.toJS = toJS.toJS;
|
|
22
|
+
exports.findPair = YAMLMap.findPair;
|
|
23
|
+
exports.mapTag = map.map;
|
|
24
|
+
exports.seqTag = seq.seq;
|
|
25
|
+
exports.stringTag = string.string;
|
|
26
|
+
exports.foldFlowLines = foldFlowLines.foldFlowLines;
|
|
27
|
+
exports.stringifyNumber = stringifyNumber.stringifyNumber;
|
|
28
|
+
exports.stringifyString = stringifyString.stringifyString;
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import type { Document } from './doc/Document';
|
|
2
|
+
import type { Alias } from './nodes/Alias';
|
|
3
|
+
import type { Node } from './nodes/Node';
|
|
4
|
+
import type { Pair } from './nodes/Pair';
|
|
5
|
+
import type { Scalar } from './nodes/Scalar';
|
|
6
|
+
import type { YAMLMap } from './nodes/YAMLMap';
|
|
7
|
+
import type { YAMLSeq } from './nodes/YAMLSeq';
|
|
8
|
+
export type visitorFn<T> = (key: number | 'key' | 'value' | null, node: T, path: readonly (Document | Node | Pair)[]) => void | symbol | number | Node | Pair;
|
|
9
|
+
export type visitor = visitorFn<unknown> | {
|
|
10
|
+
Alias?: visitorFn<Alias>;
|
|
11
|
+
Collection?: visitorFn<YAMLMap | YAMLSeq>;
|
|
12
|
+
Map?: visitorFn<YAMLMap>;
|
|
13
|
+
Node?: visitorFn<Alias | Scalar | YAMLMap | YAMLSeq>;
|
|
14
|
+
Pair?: visitorFn<Pair>;
|
|
15
|
+
Scalar?: visitorFn<Scalar>;
|
|
16
|
+
Seq?: visitorFn<YAMLSeq>;
|
|
17
|
+
Value?: visitorFn<Scalar | YAMLMap | YAMLSeq>;
|
|
18
|
+
};
|
|
19
|
+
export type asyncVisitorFn<T> = (key: number | 'key' | 'value' | null, node: T, path: readonly (Document | Node | Pair)[]) => void | symbol | number | Node | Pair | Promise<void | symbol | number | Node | Pair>;
|
|
20
|
+
export type asyncVisitor = asyncVisitorFn<unknown> | {
|
|
21
|
+
Alias?: asyncVisitorFn<Alias>;
|
|
22
|
+
Collection?: asyncVisitorFn<YAMLMap | YAMLSeq>;
|
|
23
|
+
Map?: asyncVisitorFn<YAMLMap>;
|
|
24
|
+
Node?: asyncVisitorFn<Alias | Scalar | YAMLMap | YAMLSeq>;
|
|
25
|
+
Pair?: asyncVisitorFn<Pair>;
|
|
26
|
+
Scalar?: asyncVisitorFn<Scalar>;
|
|
27
|
+
Seq?: asyncVisitorFn<YAMLSeq>;
|
|
28
|
+
Value?: asyncVisitorFn<Scalar | YAMLMap | YAMLSeq>;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Apply a visitor to an AST node or document.
|
|
32
|
+
*
|
|
33
|
+
* Walks through the tree (depth-first) starting from `node`, calling a
|
|
34
|
+
* `visitor` function with three arguments:
|
|
35
|
+
* - `key`: For sequence values and map `Pair`, the node's index in the
|
|
36
|
+
* collection. Within a `Pair`, `'key'` or `'value'`, correspondingly.
|
|
37
|
+
* `null` for the root node.
|
|
38
|
+
* - `node`: The current node.
|
|
39
|
+
* - `path`: The ancestry of the current node.
|
|
40
|
+
*
|
|
41
|
+
* The return value of the visitor may be used to control the traversal:
|
|
42
|
+
* - `undefined` (default): Do nothing and continue
|
|
43
|
+
* - `visit.SKIP`: Do not visit the children of this node, continue with next
|
|
44
|
+
* sibling
|
|
45
|
+
* - `visit.BREAK`: Terminate traversal completely
|
|
46
|
+
* - `visit.REMOVE`: Remove the current node, then continue with the next one
|
|
47
|
+
* - `Node`: Replace the current node, then continue by visiting it
|
|
48
|
+
* - `number`: While iterating the items of a sequence or map, set the index
|
|
49
|
+
* of the next step. This is useful especially if the index of the current
|
|
50
|
+
* node has changed.
|
|
51
|
+
*
|
|
52
|
+
* If `visitor` is a single function, it will be called with all values
|
|
53
|
+
* encountered in the tree, including e.g. `null` values. Alternatively,
|
|
54
|
+
* separate visitor functions may be defined for each `Map`, `Pair`, `Seq`,
|
|
55
|
+
* `Alias` and `Scalar` node. To define the same visitor function for more than
|
|
56
|
+
* one node type, use the `Collection` (map and seq), `Value` (map, seq & scalar)
|
|
57
|
+
* and `Node` (alias, map, seq & scalar) targets. Of all these, only the most
|
|
58
|
+
* specific defined one will be used for each node.
|
|
59
|
+
*/
|
|
60
|
+
export declare function visit(node: Node | Document | null, visitor: visitor): void;
|
|
61
|
+
export declare namespace visit {
|
|
62
|
+
var BREAK: symbol;
|
|
63
|
+
var SKIP: symbol;
|
|
64
|
+
var REMOVE: symbol;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Apply an async visitor to an AST node or document.
|
|
68
|
+
*
|
|
69
|
+
* Walks through the tree (depth-first) starting from `node`, calling a
|
|
70
|
+
* `visitor` function with three arguments:
|
|
71
|
+
* - `key`: For sequence values and map `Pair`, the node's index in the
|
|
72
|
+
* collection. Within a `Pair`, `'key'` or `'value'`, correspondingly.
|
|
73
|
+
* `null` for the root node.
|
|
74
|
+
* - `node`: The current node.
|
|
75
|
+
* - `path`: The ancestry of the current node.
|
|
76
|
+
*
|
|
77
|
+
* The return value of the visitor may be used to control the traversal:
|
|
78
|
+
* - `Promise`: Must resolve to one of the following values
|
|
79
|
+
* - `undefined` (default): Do nothing and continue
|
|
80
|
+
* - `visit.SKIP`: Do not visit the children of this node, continue with next
|
|
81
|
+
* sibling
|
|
82
|
+
* - `visit.BREAK`: Terminate traversal completely
|
|
83
|
+
* - `visit.REMOVE`: Remove the current node, then continue with the next one
|
|
84
|
+
* - `Node`: Replace the current node, then continue by visiting it
|
|
85
|
+
* - `number`: While iterating the items of a sequence or map, set the index
|
|
86
|
+
* of the next step. This is useful especially if the index of the current
|
|
87
|
+
* node has changed.
|
|
88
|
+
*
|
|
89
|
+
* If `visitor` is a single function, it will be called with all values
|
|
90
|
+
* encountered in the tree, including e.g. `null` values. Alternatively,
|
|
91
|
+
* separate visitor functions may be defined for each `Map`, `Pair`, `Seq`,
|
|
92
|
+
* `Alias` and `Scalar` node. To define the same visitor function for more than
|
|
93
|
+
* one node type, use the `Collection` (map and seq), `Value` (map, seq & scalar)
|
|
94
|
+
* and `Node` (alias, map, seq & scalar) targets. Of all these, only the most
|
|
95
|
+
* specific defined one will be used for each node.
|
|
96
|
+
*/
|
|
97
|
+
export declare function visitAsync(node: Node | Document | null, visitor: asyncVisitor): Promise<void>;
|
|
98
|
+
export declare namespace visitAsync {
|
|
99
|
+
var BREAK: symbol;
|
|
100
|
+
var SKIP: symbol;
|
|
101
|
+
var REMOVE: symbol;
|
|
102
|
+
}
|