cdklabs-projen-project-types 0.0.2

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.
Files changed (240) hide show
  1. package/.gitattributes +22 -0
  2. package/.jsii +421 -0
  3. package/API.md +14712 -0
  4. package/LICENSE +202 -0
  5. package/README.md +1 -0
  6. package/lib/cdk.d.ts +40 -0
  7. package/lib/cdk.js +68 -0
  8. package/lib/cdklabs.d.ts +45 -0
  9. package/lib/cdklabs.js +101 -0
  10. package/lib/index.d.ts +2 -0
  11. package/lib/index.js +15 -0
  12. package/lib/private.d.ts +13 -0
  13. package/lib/private.js +25 -0
  14. package/node_modules/yaml/LICENSE +13 -0
  15. package/node_modules/yaml/README.md +143 -0
  16. package/node_modules/yaml/browser/dist/compose/compose-collection.js +59 -0
  17. package/node_modules/yaml/browser/dist/compose/compose-doc.js +40 -0
  18. package/node_modules/yaml/browser/dist/compose/compose-node.js +92 -0
  19. package/node_modules/yaml/browser/dist/compose/compose-scalar.js +80 -0
  20. package/node_modules/yaml/browser/dist/compose/composer.js +217 -0
  21. package/node_modules/yaml/browser/dist/compose/resolve-block-map.js +110 -0
  22. package/node_modules/yaml/browser/dist/compose/resolve-block-scalar.js +194 -0
  23. package/node_modules/yaml/browser/dist/compose/resolve-block-seq.js +45 -0
  24. package/node_modules/yaml/browser/dist/compose/resolve-end.js +37 -0
  25. package/node_modules/yaml/browser/dist/compose/resolve-flow-collection.js +200 -0
  26. package/node_modules/yaml/browser/dist/compose/resolve-flow-scalar.js +223 -0
  27. package/node_modules/yaml/browser/dist/compose/resolve-props.js +134 -0
  28. package/node_modules/yaml/browser/dist/compose/util-contains-newline.js +34 -0
  29. package/node_modules/yaml/browser/dist/compose/util-empty-scalar-position.js +27 -0
  30. package/node_modules/yaml/browser/dist/compose/util-flow-indent-check.js +15 -0
  31. package/node_modules/yaml/browser/dist/compose/util-map-includes.js +17 -0
  32. package/node_modules/yaml/browser/dist/doc/Document.js +332 -0
  33. package/node_modules/yaml/browser/dist/doc/anchors.js +72 -0
  34. package/node_modules/yaml/browser/dist/doc/applyReviver.js +54 -0
  35. package/node_modules/yaml/browser/dist/doc/createNode.js +85 -0
  36. package/node_modules/yaml/browser/dist/doc/directives.js +169 -0
  37. package/node_modules/yaml/browser/dist/errors.js +57 -0
  38. package/node_modules/yaml/browser/dist/index.js +17 -0
  39. package/node_modules/yaml/browser/dist/log.js +14 -0
  40. package/node_modules/yaml/browser/dist/node_modules/tslib/tslib.es6.js +164 -0
  41. package/node_modules/yaml/browser/dist/nodes/Alias.js +94 -0
  42. package/node_modules/yaml/browser/dist/nodes/Collection.js +147 -0
  43. package/node_modules/yaml/browser/dist/nodes/Node.js +48 -0
  44. package/node_modules/yaml/browser/dist/nodes/Pair.js +36 -0
  45. package/node_modules/yaml/browser/dist/nodes/Scalar.js +23 -0
  46. package/node_modules/yaml/browser/dist/nodes/YAMLMap.js +116 -0
  47. package/node_modules/yaml/browser/dist/nodes/YAMLSeq.js +97 -0
  48. package/node_modules/yaml/browser/dist/nodes/addPairToJSMap.js +104 -0
  49. package/node_modules/yaml/browser/dist/nodes/toJS.js +37 -0
  50. package/node_modules/yaml/browser/dist/parse/cst-scalar.js +214 -0
  51. package/node_modules/yaml/browser/dist/parse/cst-stringify.js +61 -0
  52. package/node_modules/yaml/browser/dist/parse/cst-visit.js +97 -0
  53. package/node_modules/yaml/browser/dist/parse/cst.js +98 -0
  54. package/node_modules/yaml/browser/dist/parse/lexer.js +701 -0
  55. package/node_modules/yaml/browser/dist/parse/line-counter.js +39 -0
  56. package/node_modules/yaml/browser/dist/parse/parser.js +950 -0
  57. package/node_modules/yaml/browser/dist/public-api.js +99 -0
  58. package/node_modules/yaml/browser/dist/schema/Schema.js +38 -0
  59. package/node_modules/yaml/browser/dist/schema/common/map.js +42 -0
  60. package/node_modules/yaml/browser/dist/schema/common/null.js +15 -0
  61. package/node_modules/yaml/browser/dist/schema/common/seq.js +33 -0
  62. package/node_modules/yaml/browser/dist/schema/common/string.js +14 -0
  63. package/node_modules/yaml/browser/dist/schema/core/bool.js +19 -0
  64. package/node_modules/yaml/browser/dist/schema/core/float.js +43 -0
  65. package/node_modules/yaml/browser/dist/schema/core/int.js +38 -0
  66. package/node_modules/yaml/browser/dist/schema/core/schema.js +23 -0
  67. package/node_modules/yaml/browser/dist/schema/json/schema.js +62 -0
  68. package/node_modules/yaml/browser/dist/schema/tags.js +83 -0
  69. package/node_modules/yaml/browser/dist/schema/yaml-1.1/binary.js +66 -0
  70. package/node_modules/yaml/browser/dist/schema/yaml-1.1/bool.js +26 -0
  71. package/node_modules/yaml/browser/dist/schema/yaml-1.1/float.js +46 -0
  72. package/node_modules/yaml/browser/dist/schema/yaml-1.1/int.js +71 -0
  73. package/node_modules/yaml/browser/dist/schema/yaml-1.1/omap.js +73 -0
  74. package/node_modules/yaml/browser/dist/schema/yaml-1.1/pairs.js +77 -0
  75. package/node_modules/yaml/browser/dist/schema/yaml-1.1/schema.js +37 -0
  76. package/node_modules/yaml/browser/dist/schema/yaml-1.1/set.js +92 -0
  77. package/node_modules/yaml/browser/dist/schema/yaml-1.1/timestamp.js +101 -0
  78. package/node_modules/yaml/browser/dist/stringify/foldFlowLines.js +135 -0
  79. package/node_modules/yaml/browser/dist/stringify/stringify.js +124 -0
  80. package/node_modules/yaml/browser/dist/stringify/stringifyCollection.js +151 -0
  81. package/node_modules/yaml/browser/dist/stringify/stringifyComment.js +20 -0
  82. package/node_modules/yaml/browser/dist/stringify/stringifyDocument.js +85 -0
  83. package/node_modules/yaml/browser/dist/stringify/stringifyNumber.js +24 -0
  84. package/node_modules/yaml/browser/dist/stringify/stringifyPair.js +150 -0
  85. package/node_modules/yaml/browser/dist/stringify/stringifyString.js +319 -0
  86. package/node_modules/yaml/browser/dist/util.js +9 -0
  87. package/node_modules/yaml/browser/dist/visit.js +233 -0
  88. package/node_modules/yaml/browser/index.js +5 -0
  89. package/node_modules/yaml/browser/package.json +3 -0
  90. package/node_modules/yaml/dist/compose/compose-collection.d.ts +5 -0
  91. package/node_modules/yaml/dist/compose/compose-collection.js +61 -0
  92. package/node_modules/yaml/dist/compose/compose-doc.d.ts +6 -0
  93. package/node_modules/yaml/dist/compose/compose-doc.js +42 -0
  94. package/node_modules/yaml/dist/compose/compose-node.d.ts +27 -0
  95. package/node_modules/yaml/dist/compose/compose-node.js +95 -0
  96. package/node_modules/yaml/dist/compose/compose-scalar.d.ts +5 -0
  97. package/node_modules/yaml/dist/compose/compose-scalar.js +82 -0
  98. package/node_modules/yaml/dist/compose/composer.d.ts +62 -0
  99. package/node_modules/yaml/dist/compose/composer.js +221 -0
  100. package/node_modules/yaml/dist/compose/resolve-block-map.d.ts +6 -0
  101. package/node_modules/yaml/dist/compose/resolve-block-map.js +112 -0
  102. package/node_modules/yaml/dist/compose/resolve-block-scalar.d.ts +10 -0
  103. package/node_modules/yaml/dist/compose/resolve-block-scalar.js +196 -0
  104. package/node_modules/yaml/dist/compose/resolve-block-seq.d.ts +5 -0
  105. package/node_modules/yaml/dist/compose/resolve-block-seq.js +47 -0
  106. package/node_modules/yaml/dist/compose/resolve-end.d.ts +6 -0
  107. package/node_modules/yaml/dist/compose/resolve-end.js +39 -0
  108. package/node_modules/yaml/dist/compose/resolve-flow-collection.d.ts +6 -0
  109. package/node_modules/yaml/dist/compose/resolve-flow-collection.js +202 -0
  110. package/node_modules/yaml/dist/compose/resolve-flow-scalar.d.ts +10 -0
  111. package/node_modules/yaml/dist/compose/resolve-flow-scalar.js +225 -0
  112. package/node_modules/yaml/dist/compose/resolve-props.d.ts +22 -0
  113. package/node_modules/yaml/dist/compose/resolve-props.js +136 -0
  114. package/node_modules/yaml/dist/compose/util-contains-newline.d.ts +2 -0
  115. package/node_modules/yaml/dist/compose/util-contains-newline.js +36 -0
  116. package/node_modules/yaml/dist/compose/util-empty-scalar-position.d.ts +2 -0
  117. package/node_modules/yaml/dist/compose/util-empty-scalar-position.js +29 -0
  118. package/node_modules/yaml/dist/compose/util-flow-indent-check.d.ts +3 -0
  119. package/node_modules/yaml/dist/compose/util-flow-indent-check.js +17 -0
  120. package/node_modules/yaml/dist/compose/util-map-includes.d.ts +4 -0
  121. package/node_modules/yaml/dist/compose/util-map-includes.js +19 -0
  122. package/node_modules/yaml/dist/doc/Document.d.ts +139 -0
  123. package/node_modules/yaml/dist/doc/Document.js +334 -0
  124. package/node_modules/yaml/dist/doc/anchors.d.ts +24 -0
  125. package/node_modules/yaml/dist/doc/anchors.js +77 -0
  126. package/node_modules/yaml/dist/doc/applyReviver.d.ts +9 -0
  127. package/node_modules/yaml/dist/doc/applyReviver.js +56 -0
  128. package/node_modules/yaml/dist/doc/createNode.d.ts +17 -0
  129. package/node_modules/yaml/dist/doc/createNode.js +87 -0
  130. package/node_modules/yaml/dist/doc/directives.d.ts +49 -0
  131. package/node_modules/yaml/dist/doc/directives.js +171 -0
  132. package/node_modules/yaml/dist/errors.d.ts +21 -0
  133. package/node_modules/yaml/dist/errors.js +62 -0
  134. package/node_modules/yaml/dist/index.d.ts +21 -0
  135. package/node_modules/yaml/dist/index.js +50 -0
  136. package/node_modules/yaml/dist/log.d.ts +3 -0
  137. package/node_modules/yaml/dist/log.js +17 -0
  138. package/node_modules/yaml/dist/nodes/Alias.d.ts +28 -0
  139. package/node_modules/yaml/dist/nodes/Alias.js +96 -0
  140. package/node_modules/yaml/dist/nodes/Collection.d.ts +73 -0
  141. package/node_modules/yaml/dist/nodes/Collection.js +151 -0
  142. package/node_modules/yaml/dist/nodes/Node.d.ts +59 -0
  143. package/node_modules/yaml/dist/nodes/Node.js +66 -0
  144. package/node_modules/yaml/dist/nodes/Pair.d.ts +21 -0
  145. package/node_modules/yaml/dist/nodes/Pair.js +39 -0
  146. package/node_modules/yaml/dist/nodes/Scalar.d.ts +42 -0
  147. package/node_modules/yaml/dist/nodes/Scalar.js +26 -0
  148. package/node_modules/yaml/dist/nodes/YAMLMap.d.ts +47 -0
  149. package/node_modules/yaml/dist/nodes/YAMLMap.js +119 -0
  150. package/node_modules/yaml/dist/nodes/YAMLSeq.d.ts +58 -0
  151. package/node_modules/yaml/dist/nodes/YAMLSeq.js +99 -0
  152. package/node_modules/yaml/dist/nodes/addPairToJSMap.d.ts +4 -0
  153. package/node_modules/yaml/dist/nodes/addPairToJSMap.js +106 -0
  154. package/node_modules/yaml/dist/nodes/toJS.d.ts +30 -0
  155. package/node_modules/yaml/dist/nodes/toJS.js +39 -0
  156. package/node_modules/yaml/dist/options.d.ts +338 -0
  157. package/node_modules/yaml/dist/parse/cst-scalar.d.ts +64 -0
  158. package/node_modules/yaml/dist/parse/cst-scalar.js +218 -0
  159. package/node_modules/yaml/dist/parse/cst-stringify.d.ts +8 -0
  160. package/node_modules/yaml/dist/parse/cst-stringify.js +63 -0
  161. package/node_modules/yaml/dist/parse/cst-visit.d.ts +39 -0
  162. package/node_modules/yaml/dist/parse/cst-visit.js +99 -0
  163. package/node_modules/yaml/dist/parse/cst.d.ts +106 -0
  164. package/node_modules/yaml/dist/parse/cst.js +112 -0
  165. package/node_modules/yaml/dist/parse/lexer.d.ts +87 -0
  166. package/node_modules/yaml/dist/parse/lexer.js +703 -0
  167. package/node_modules/yaml/dist/parse/line-counter.d.ts +22 -0
  168. package/node_modules/yaml/dist/parse/line-counter.js +41 -0
  169. package/node_modules/yaml/dist/parse/parser.d.ts +84 -0
  170. package/node_modules/yaml/dist/parse/parser.js +954 -0
  171. package/node_modules/yaml/dist/public-api.d.ts +43 -0
  172. package/node_modules/yaml/dist/public-api.js +104 -0
  173. package/node_modules/yaml/dist/schema/Schema.d.ts +18 -0
  174. package/node_modules/yaml/dist/schema/Schema.js +40 -0
  175. package/node_modules/yaml/dist/schema/common/map.d.ts +2 -0
  176. package/node_modules/yaml/dist/schema/common/map.js +44 -0
  177. package/node_modules/yaml/dist/schema/common/null.d.ts +4 -0
  178. package/node_modules/yaml/dist/schema/common/null.js +17 -0
  179. package/node_modules/yaml/dist/schema/common/seq.d.ts +2 -0
  180. package/node_modules/yaml/dist/schema/common/seq.js +35 -0
  181. package/node_modules/yaml/dist/schema/common/string.d.ts +2 -0
  182. package/node_modules/yaml/dist/schema/common/string.js +16 -0
  183. package/node_modules/yaml/dist/schema/core/bool.d.ts +4 -0
  184. package/node_modules/yaml/dist/schema/core/bool.js +21 -0
  185. package/node_modules/yaml/dist/schema/core/float.d.ts +4 -0
  186. package/node_modules/yaml/dist/schema/core/float.js +47 -0
  187. package/node_modules/yaml/dist/schema/core/int.d.ts +4 -0
  188. package/node_modules/yaml/dist/schema/core/int.js +42 -0
  189. package/node_modules/yaml/dist/schema/core/schema.d.ts +1 -0
  190. package/node_modules/yaml/dist/schema/core/schema.js +25 -0
  191. package/node_modules/yaml/dist/schema/json/schema.d.ts +2 -0
  192. package/node_modules/yaml/dist/schema/json/schema.js +64 -0
  193. package/node_modules/yaml/dist/schema/json-schema.d.ts +69 -0
  194. package/node_modules/yaml/dist/schema/tags.d.ts +40 -0
  195. package/node_modules/yaml/dist/schema/tags.js +86 -0
  196. package/node_modules/yaml/dist/schema/types.d.ts +82 -0
  197. package/node_modules/yaml/dist/schema/yaml-1.1/binary.d.ts +2 -0
  198. package/node_modules/yaml/dist/schema/yaml-1.1/binary.js +68 -0
  199. package/node_modules/yaml/dist/schema/yaml-1.1/bool.d.ts +7 -0
  200. package/node_modules/yaml/dist/schema/yaml-1.1/bool.js +29 -0
  201. package/node_modules/yaml/dist/schema/yaml-1.1/float.d.ts +4 -0
  202. package/node_modules/yaml/dist/schema/yaml-1.1/float.js +50 -0
  203. package/node_modules/yaml/dist/schema/yaml-1.1/int.d.ts +5 -0
  204. package/node_modules/yaml/dist/schema/yaml-1.1/int.js +76 -0
  205. package/node_modules/yaml/dist/schema/yaml-1.1/omap.d.ts +25 -0
  206. package/node_modules/yaml/dist/schema/yaml-1.1/omap.js +76 -0
  207. package/node_modules/yaml/dist/schema/yaml-1.1/pairs.d.ts +10 -0
  208. package/node_modules/yaml/dist/schema/yaml-1.1/pairs.js +81 -0
  209. package/node_modules/yaml/dist/schema/yaml-1.1/schema.d.ts +1 -0
  210. package/node_modules/yaml/dist/schema/yaml-1.1/schema.js +39 -0
  211. package/node_modules/yaml/dist/schema/yaml-1.1/set.d.ts +26 -0
  212. package/node_modules/yaml/dist/schema/yaml-1.1/set.js +95 -0
  213. package/node_modules/yaml/dist/schema/yaml-1.1/timestamp.d.ts +6 -0
  214. package/node_modules/yaml/dist/schema/yaml-1.1/timestamp.js +105 -0
  215. package/node_modules/yaml/dist/stringify/foldFlowLines.d.ts +34 -0
  216. package/node_modules/yaml/dist/stringify/foldFlowLines.js +140 -0
  217. package/node_modules/yaml/dist/stringify/stringify.d.ts +21 -0
  218. package/node_modules/yaml/dist/stringify/stringify.js +127 -0
  219. package/node_modules/yaml/dist/stringify/stringifyCollection.d.ts +17 -0
  220. package/node_modules/yaml/dist/stringify/stringifyCollection.js +153 -0
  221. package/node_modules/yaml/dist/stringify/stringifyComment.d.ts +10 -0
  222. package/node_modules/yaml/dist/stringify/stringifyComment.js +24 -0
  223. package/node_modules/yaml/dist/stringify/stringifyDocument.d.ts +3 -0
  224. package/node_modules/yaml/dist/stringify/stringifyDocument.js +87 -0
  225. package/node_modules/yaml/dist/stringify/stringifyNumber.d.ts +2 -0
  226. package/node_modules/yaml/dist/stringify/stringifyNumber.js +26 -0
  227. package/node_modules/yaml/dist/stringify/stringifyPair.d.ts +3 -0
  228. package/node_modules/yaml/dist/stringify/stringifyPair.js +152 -0
  229. package/node_modules/yaml/dist/stringify/stringifyString.d.ts +9 -0
  230. package/node_modules/yaml/dist/stringify/stringifyString.js +321 -0
  231. package/node_modules/yaml/dist/test-events.d.ts +4 -0
  232. package/node_modules/yaml/dist/test-events.js +134 -0
  233. package/node_modules/yaml/dist/util.d.ts +9 -0
  234. package/node_modules/yaml/dist/util.js +24 -0
  235. package/node_modules/yaml/dist/visit.d.ts +102 -0
  236. package/node_modules/yaml/dist/visit.js +236 -0
  237. package/node_modules/yaml/package.json +94 -0
  238. package/node_modules/yaml/util.d.ts +3 -0
  239. package/node_modules/yaml/util.js +2 -0
  240. package/package.json +126 -0
@@ -0,0 +1,143 @@
1
+ # YAML <a href="https://www.npmjs.com/package/yaml"><img align="right" src="https://badge.fury.io/js/yaml.svg" title="npm package" /></a>
2
+
3
+ `yaml` is a definitive library for [YAML](https://yaml.org/), the human friendly data serialization standard.
4
+ This library:
5
+
6
+ - Supports both YAML 1.1 and YAML 1.2 and all common data schemas,
7
+ - Passes all of the [yaml-test-suite](https://github.com/yaml/yaml-test-suite) tests,
8
+ - Can accept any string as input without throwing, parsing as much YAML out of it as it can, and
9
+ - Supports parsing, modifying, and writing YAML comments and blank lines.
10
+
11
+ The library is released under the ISC open source license, and the code is [available on GitHub](https://github.com/eemeli/yaml/).
12
+ It has no external dependencies and runs on Node.js as well as modern browsers.
13
+
14
+ For the purposes of versioning, any changes that break any of the documented endpoints or APIs will be considered semver-major breaking changes.
15
+ Undocumented library internals may change between minor versions, and previous APIs may be deprecated (but not removed).
16
+
17
+ For more information, see the project's documentation site: [**eemeli.org/yaml**](https://eemeli.org/yaml/)
18
+
19
+ To install:
20
+
21
+ ```sh
22
+ npm install yaml
23
+ ```
24
+
25
+ **Note:** These docs are for `yaml@2`. For v1, see the [v1.10.0 tag](https://github.com/eemeli/yaml/tree/v1.10.0) for the source and [eemeli.org/yaml/v1](https://eemeli.org/yaml/v1/) for the documentation.
26
+
27
+ ## API Overview
28
+
29
+ The API provided by `yaml` has three layers, depending on how deep you need to go: [Parse & Stringify](https://eemeli.org/yaml/#parse-amp-stringify), [Documents](https://eemeli.org/yaml/#documents), and the underlying [Lexer/Parser/Composer](https://eemeli.org/yaml/#parsing-yaml).
30
+ The first has the simplest API and "just works", the second gets you all the bells and whistles supported by the library along with a decent [AST](https://eemeli.org/yaml/#content-nodes), and the third lets you get progressively closer to YAML source, if that's your thing.
31
+
32
+ ```js
33
+ import { parse, stringify } from 'yaml'
34
+ // or
35
+ import YAML from 'yaml'
36
+ // or
37
+ const YAML = require('yaml')
38
+ ```
39
+
40
+ ### Parse & Stringify
41
+
42
+ - [`parse(str, reviver?, options?): value`](https://eemeli.org/yaml/#yaml-parse)
43
+ - [`stringify(value, replacer?, options?): string`](https://eemeli.org/yaml/#yaml-stringify)
44
+
45
+ ### Documents
46
+
47
+ - [`Document`](https://eemeli.org/yaml/#documents)
48
+ - [`constructor(value, replacer?, options?)`](https://eemeli.org/yaml/#creating-documents)
49
+ - [`#anchors`](https://eemeli.org/yaml/#working-with-anchors)
50
+ - [`#contents`](https://eemeli.org/yaml/#content-nodes)
51
+ - [`#directives`](https://eemeli.org/yaml/#stream-directives)
52
+ - [`#errors`](https://eemeli.org/yaml/#errors)
53
+ - [`#warnings`](https://eemeli.org/yaml/#errors)
54
+ - [`isDocument(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
55
+ - [`parseAllDocuments(str, options?): Document[]`](https://eemeli.org/yaml/#parsing-documents)
56
+ - [`parseDocument(str, options?): Document`](https://eemeli.org/yaml/#parsing-documents)
57
+
58
+ ### Content Nodes
59
+
60
+ - [`isAlias(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
61
+ - [`isCollection(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
62
+ - [`isMap(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
63
+ - [`isNode(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
64
+ - [`isPair(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
65
+ - [`isScalar(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
66
+ - [`isSeq(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
67
+ - [`new Scalar(value)`](https://eemeli.org/yaml/#scalar-values)
68
+ - [`new YAMLMap()`](https://eemeli.org/yaml/#collections)
69
+ - [`new YAMLSeq()`](https://eemeli.org/yaml/#collections)
70
+ - [`doc.createAlias(node, name?): Alias`](https://eemeli.org/yaml/#working-with-anchors)
71
+ - [`doc.createNode(value, options?): Node`](https://eemeli.org/yaml/#creating-nodes)
72
+ - [`doc.createPair(key, value): Pair`](https://eemeli.org/yaml/#creating-nodes)
73
+ - [`visit(node, visitor)`](https://eemeli.org/yaml/#modifying-nodes)
74
+
75
+ ### Parsing YAML
76
+
77
+ - [`new Lexer().lex(src)`](https://eemeli.org/yaml/#lexer)
78
+ - [`new Parser(onNewLine?).parse(src)`](https://eemeli.org/yaml/#parser)
79
+ - [`new Composer(options?).compose(tokens)`](https://eemeli.org/yaml/#composer)
80
+
81
+ ## YAML.parse
82
+
83
+ ```yaml
84
+ # file.yml
85
+ YAML:
86
+ - A human-readable data serialization language
87
+ - https://en.wikipedia.org/wiki/YAML
88
+ yaml:
89
+ - A complete JavaScript implementation
90
+ - https://www.npmjs.com/package/yaml
91
+ ```
92
+
93
+ ```js
94
+ import fs from 'fs'
95
+ import YAML from 'yaml'
96
+
97
+ YAML.parse('3.14159')
98
+ // 3.14159
99
+
100
+ YAML.parse('[ true, false, maybe, null ]\n')
101
+ // [ true, false, 'maybe', null ]
102
+
103
+ const file = fs.readFileSync('./file.yml', 'utf8')
104
+ YAML.parse(file)
105
+ // { YAML:
106
+ // [ 'A human-readable data serialization language',
107
+ // 'https://en.wikipedia.org/wiki/YAML' ],
108
+ // yaml:
109
+ // [ 'A complete JavaScript implementation',
110
+ // 'https://www.npmjs.com/package/yaml' ] }
111
+ ```
112
+
113
+ ## YAML.stringify
114
+
115
+ ```js
116
+ import YAML from 'yaml'
117
+
118
+ YAML.stringify(3.14159)
119
+ // '3.14159\n'
120
+
121
+ YAML.stringify([true, false, 'maybe', null])
122
+ // `- true
123
+ // - false
124
+ // - maybe
125
+ // - null
126
+ // `
127
+
128
+ YAML.stringify({ number: 3, plain: 'string', block: 'two\nlines\n' })
129
+ // `number: 3
130
+ // plain: string
131
+ // block: |
132
+ // two
133
+ // lines
134
+ // `
135
+ ```
136
+
137
+ ---
138
+
139
+ Browser testing provided by:
140
+
141
+ <a href="https://www.browserstack.com/open-source">
142
+ <img width=200 src="https://eemeli.org/yaml/images/browserstack.svg" />
143
+ </a>
@@ -0,0 +1,59 @@
1
+ import { isNode, isMap } from '../nodes/Node.js';
2
+ import { Scalar } from '../nodes/Scalar.js';
3
+ import { resolveBlockMap } from './resolve-block-map.js';
4
+ import { resolveBlockSeq } from './resolve-block-seq.js';
5
+ import { resolveFlowCollection } from './resolve-flow-collection.js';
6
+
7
+ function composeCollection(CN, ctx, token, tagToken, onError) {
8
+ let coll;
9
+ switch (token.type) {
10
+ case 'block-map': {
11
+ coll = resolveBlockMap(CN, ctx, token, onError);
12
+ break;
13
+ }
14
+ case 'block-seq': {
15
+ coll = resolveBlockSeq(CN, ctx, token, onError);
16
+ break;
17
+ }
18
+ case 'flow-collection': {
19
+ coll = resolveFlowCollection(CN, ctx, token, onError);
20
+ break;
21
+ }
22
+ }
23
+ if (!tagToken)
24
+ return coll;
25
+ const tagName = ctx.directives.tagName(tagToken.source, msg => onError(tagToken, 'TAG_RESOLVE_FAILED', msg));
26
+ if (!tagName)
27
+ return coll;
28
+ // Cast needed due to: https://github.com/Microsoft/TypeScript/issues/3841
29
+ const Coll = coll.constructor;
30
+ if (tagName === '!' || tagName === Coll.tagName) {
31
+ coll.tag = Coll.tagName;
32
+ return coll;
33
+ }
34
+ const expType = isMap(coll) ? 'map' : 'seq';
35
+ let tag = ctx.schema.tags.find(t => t.collection === expType && t.tag === tagName);
36
+ if (!tag) {
37
+ const kt = ctx.schema.knownTags[tagName];
38
+ if (kt && kt.collection === expType) {
39
+ ctx.schema.tags.push(Object.assign({}, kt, { default: false }));
40
+ tag = kt;
41
+ }
42
+ else {
43
+ onError(tagToken, 'TAG_RESOLVE_FAILED', `Unresolved tag: ${tagName}`, true);
44
+ coll.tag = tagName;
45
+ return coll;
46
+ }
47
+ }
48
+ const res = tag.resolve(coll, msg => onError(tagToken, 'TAG_RESOLVE_FAILED', msg), ctx.options);
49
+ const node = isNode(res)
50
+ ? res
51
+ : new Scalar(res);
52
+ node.range = coll.range;
53
+ node.tag = tagName;
54
+ if (tag?.format)
55
+ node.format = tag.format;
56
+ return node;
57
+ }
58
+
59
+ export { composeCollection };
@@ -0,0 +1,40 @@
1
+ import { Document } from '../doc/Document.js';
2
+ import { composeNode, composeEmptyNode } from './compose-node.js';
3
+ import { resolveEnd } from './resolve-end.js';
4
+ import { resolveProps } from './resolve-props.js';
5
+
6
+ function composeDoc(options, directives, { offset, start, value, end }, onError) {
7
+ const opts = Object.assign({ _directives: directives }, options);
8
+ const doc = new Document(undefined, opts);
9
+ const ctx = {
10
+ atRoot: true,
11
+ directives: doc.directives,
12
+ options: doc.options,
13
+ schema: doc.schema
14
+ };
15
+ const props = resolveProps(start, {
16
+ indicator: 'doc-start',
17
+ next: value ?? end?.[0],
18
+ offset,
19
+ onError,
20
+ startOnNewline: true
21
+ });
22
+ if (props.found) {
23
+ doc.directives.docStart = true;
24
+ if (value &&
25
+ (value.type === 'block-map' || value.type === 'block-seq') &&
26
+ !props.hasNewline)
27
+ onError(props.end, 'MISSING_CHAR', 'Block collection cannot start on same line with directives-end marker');
28
+ }
29
+ doc.contents = value
30
+ ? composeNode(ctx, value, props, onError)
31
+ : composeEmptyNode(ctx, props.end, start, null, props, onError);
32
+ const contentEnd = doc.contents.range[2];
33
+ const re = resolveEnd(end, contentEnd, false, onError);
34
+ if (re.comment)
35
+ doc.comment = re.comment;
36
+ doc.range = [offset, contentEnd, re.offset];
37
+ return doc;
38
+ }
39
+
40
+ export { composeDoc };
@@ -0,0 +1,92 @@
1
+ import { Alias } from '../nodes/Alias.js';
2
+ import { composeCollection } from './compose-collection.js';
3
+ import { composeScalar } from './compose-scalar.js';
4
+ import { resolveEnd } from './resolve-end.js';
5
+ import { emptyScalarPosition } from './util-empty-scalar-position.js';
6
+
7
+ const CN = { composeNode, composeEmptyNode };
8
+ function composeNode(ctx, token, props, onError) {
9
+ const { spaceBefore, comment, anchor, tag } = props;
10
+ let node;
11
+ let isSrcToken = true;
12
+ switch (token.type) {
13
+ case 'alias':
14
+ node = composeAlias(ctx, token, onError);
15
+ if (anchor || tag)
16
+ onError(token, 'ALIAS_PROPS', 'An alias node must not specify any properties');
17
+ break;
18
+ case 'scalar':
19
+ case 'single-quoted-scalar':
20
+ case 'double-quoted-scalar':
21
+ case 'block-scalar':
22
+ node = composeScalar(ctx, token, tag, onError);
23
+ if (anchor)
24
+ node.anchor = anchor.source.substring(1);
25
+ break;
26
+ case 'block-map':
27
+ case 'block-seq':
28
+ case 'flow-collection':
29
+ node = composeCollection(CN, ctx, token, tag, onError);
30
+ if (anchor)
31
+ node.anchor = anchor.source.substring(1);
32
+ break;
33
+ default: {
34
+ const message = token.type === 'error'
35
+ ? token.message
36
+ : `Unsupported token (type: ${token.type})`;
37
+ onError(token, 'UNEXPECTED_TOKEN', message);
38
+ node = composeEmptyNode(ctx, token.offset, undefined, null, props, onError);
39
+ isSrcToken = false;
40
+ }
41
+ }
42
+ if (anchor && node.anchor === '')
43
+ onError(anchor, 'BAD_ALIAS', 'Anchor cannot be an empty string');
44
+ if (spaceBefore)
45
+ node.spaceBefore = true;
46
+ if (comment) {
47
+ if (token.type === 'scalar' && token.source === '')
48
+ node.comment = comment;
49
+ else
50
+ node.commentBefore = comment;
51
+ }
52
+ // @ts-expect-error Type checking misses meaning of isSrcToken
53
+ if (ctx.options.keepSourceTokens && isSrcToken)
54
+ node.srcToken = token;
55
+ return node;
56
+ }
57
+ function composeEmptyNode(ctx, offset, before, pos, { spaceBefore, comment, anchor, tag, end }, onError) {
58
+ const token = {
59
+ type: 'scalar',
60
+ offset: emptyScalarPosition(offset, before, pos),
61
+ indent: -1,
62
+ source: ''
63
+ };
64
+ const node = composeScalar(ctx, token, tag, onError);
65
+ if (anchor) {
66
+ node.anchor = anchor.source.substring(1);
67
+ if (node.anchor === '')
68
+ onError(anchor, 'BAD_ALIAS', 'Anchor cannot be an empty string');
69
+ }
70
+ if (spaceBefore)
71
+ node.spaceBefore = true;
72
+ if (comment) {
73
+ node.comment = comment;
74
+ node.range[2] = end;
75
+ }
76
+ return node;
77
+ }
78
+ function composeAlias({ options }, { offset, source, end }, onError) {
79
+ const alias = new Alias(source.substring(1));
80
+ if (alias.source === '')
81
+ onError(offset, 'BAD_ALIAS', 'Alias cannot be an empty string');
82
+ if (alias.source.endsWith(':'))
83
+ onError(offset + source.length - 1, 'BAD_ALIAS', 'Alias ending in : is ambiguous', true);
84
+ const valueEnd = offset + source.length;
85
+ const re = resolveEnd(end, valueEnd, options.strict, onError);
86
+ alias.range = [offset, valueEnd, re.offset];
87
+ if (re.comment)
88
+ alias.comment = re.comment;
89
+ return alias;
90
+ }
91
+
92
+ export { composeEmptyNode, composeNode };
@@ -0,0 +1,80 @@
1
+ import { SCALAR, isScalar } from '../nodes/Node.js';
2
+ import { Scalar } from '../nodes/Scalar.js';
3
+ import { resolveBlockScalar } from './resolve-block-scalar.js';
4
+ import { resolveFlowScalar } from './resolve-flow-scalar.js';
5
+
6
+ function composeScalar(ctx, token, tagToken, onError) {
7
+ const { value, type, comment, range } = token.type === 'block-scalar'
8
+ ? resolveBlockScalar(token, ctx.options.strict, onError)
9
+ : resolveFlowScalar(token, ctx.options.strict, onError);
10
+ const tagName = tagToken
11
+ ? ctx.directives.tagName(tagToken.source, msg => onError(tagToken, 'TAG_RESOLVE_FAILED', msg))
12
+ : null;
13
+ const tag = tagToken && tagName
14
+ ? findScalarTagByName(ctx.schema, value, tagName, tagToken, onError)
15
+ : token.type === 'scalar'
16
+ ? findScalarTagByTest(ctx, value, token, onError)
17
+ : ctx.schema[SCALAR];
18
+ let scalar;
19
+ try {
20
+ const res = tag.resolve(value, msg => onError(tagToken ?? token, 'TAG_RESOLVE_FAILED', msg), ctx.options);
21
+ scalar = isScalar(res) ? res : new Scalar(res);
22
+ }
23
+ catch (error) {
24
+ const msg = error instanceof Error ? error.message : String(error);
25
+ onError(tagToken ?? token, 'TAG_RESOLVE_FAILED', msg);
26
+ scalar = new Scalar(value);
27
+ }
28
+ scalar.range = range;
29
+ scalar.source = value;
30
+ if (type)
31
+ scalar.type = type;
32
+ if (tagName)
33
+ scalar.tag = tagName;
34
+ if (tag.format)
35
+ scalar.format = tag.format;
36
+ if (comment)
37
+ scalar.comment = comment;
38
+ return scalar;
39
+ }
40
+ function findScalarTagByName(schema, value, tagName, tagToken, onError) {
41
+ if (tagName === '!')
42
+ return schema[SCALAR]; // non-specific tag
43
+ const matchWithTest = [];
44
+ for (const tag of schema.tags) {
45
+ if (!tag.collection && tag.tag === tagName) {
46
+ if (tag.default && tag.test)
47
+ matchWithTest.push(tag);
48
+ else
49
+ return tag;
50
+ }
51
+ }
52
+ for (const tag of matchWithTest)
53
+ if (tag.test?.test(value))
54
+ return tag;
55
+ const kt = schema.knownTags[tagName];
56
+ if (kt && !kt.collection) {
57
+ // Ensure that the known tag is available for stringifying,
58
+ // but does not get used by default.
59
+ schema.tags.push(Object.assign({}, kt, { default: false, test: undefined }));
60
+ return kt;
61
+ }
62
+ onError(tagToken, 'TAG_RESOLVE_FAILED', `Unresolved tag: ${tagName}`, tagName !== 'tag:yaml.org,2002:str');
63
+ return schema[SCALAR];
64
+ }
65
+ function findScalarTagByTest({ directives, schema }, value, token, onError) {
66
+ const tag = schema.tags.find(tag => tag.default && tag.test?.test(value)) || schema[SCALAR];
67
+ if (schema.compat) {
68
+ const compat = schema.compat.find(tag => tag.default && tag.test?.test(value)) ??
69
+ schema[SCALAR];
70
+ if (tag.tag !== compat.tag) {
71
+ const ts = directives.tagString(tag.tag);
72
+ const cs = directives.tagString(compat.tag);
73
+ const msg = `Value may be parsed as either ${ts} or ${cs}`;
74
+ onError(token, 'TAG_RESOLVE_FAILED', msg, true);
75
+ }
76
+ }
77
+ return tag;
78
+ }
79
+
80
+ export { composeScalar };
@@ -0,0 +1,217 @@
1
+ import { Directives } from '../doc/directives.js';
2
+ import { Document } from '../doc/Document.js';
3
+ import { YAMLWarning, YAMLParseError } from '../errors.js';
4
+ import { isCollection, isPair } from '../nodes/Node.js';
5
+ import { composeDoc } from './compose-doc.js';
6
+ import { resolveEnd } from './resolve-end.js';
7
+
8
+ function getErrorPos(src) {
9
+ if (typeof src === 'number')
10
+ return [src, src + 1];
11
+ if (Array.isArray(src))
12
+ return src.length === 2 ? src : [src[0], src[1]];
13
+ const { offset, source } = src;
14
+ return [offset, offset + (typeof source === 'string' ? source.length : 1)];
15
+ }
16
+ function parsePrelude(prelude) {
17
+ let comment = '';
18
+ let atComment = false;
19
+ let afterEmptyLine = false;
20
+ for (let i = 0; i < prelude.length; ++i) {
21
+ const source = prelude[i];
22
+ switch (source[0]) {
23
+ case '#':
24
+ comment +=
25
+ (comment === '' ? '' : afterEmptyLine ? '\n\n' : '\n') +
26
+ (source.substring(1) || ' ');
27
+ atComment = true;
28
+ afterEmptyLine = false;
29
+ break;
30
+ case '%':
31
+ if (prelude[i + 1]?.[0] !== '#')
32
+ i += 1;
33
+ atComment = false;
34
+ break;
35
+ default:
36
+ // This may be wrong after doc-end, but in that case it doesn't matter
37
+ if (!atComment)
38
+ afterEmptyLine = true;
39
+ atComment = false;
40
+ }
41
+ }
42
+ return { comment, afterEmptyLine };
43
+ }
44
+ /**
45
+ * Compose a stream of CST nodes into a stream of YAML Documents.
46
+ *
47
+ * ```ts
48
+ * import { Composer, Parser } from 'yaml'
49
+ *
50
+ * const src: string = ...
51
+ * const tokens = new Parser().parse(src)
52
+ * const docs = new Composer().compose(tokens)
53
+ * ```
54
+ */
55
+ class Composer {
56
+ constructor(options = {}) {
57
+ this.doc = null;
58
+ this.atDirectives = false;
59
+ this.prelude = [];
60
+ this.errors = [];
61
+ this.warnings = [];
62
+ this.onError = (source, code, message, warning) => {
63
+ const pos = getErrorPos(source);
64
+ if (warning)
65
+ this.warnings.push(new YAMLWarning(pos, code, message));
66
+ else
67
+ this.errors.push(new YAMLParseError(pos, code, message));
68
+ };
69
+ // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
70
+ this.directives = new Directives({ version: options.version || '1.2' });
71
+ this.options = options;
72
+ }
73
+ decorate(doc, afterDoc) {
74
+ const { comment, afterEmptyLine } = parsePrelude(this.prelude);
75
+ //console.log({ dc: doc.comment, prelude, comment })
76
+ if (comment) {
77
+ const dc = doc.contents;
78
+ if (afterDoc) {
79
+ doc.comment = doc.comment ? `${doc.comment}\n${comment}` : comment;
80
+ }
81
+ else if (afterEmptyLine || doc.directives.docStart || !dc) {
82
+ doc.commentBefore = comment;
83
+ }
84
+ else if (isCollection(dc) && !dc.flow && dc.items.length > 0) {
85
+ let it = dc.items[0];
86
+ if (isPair(it))
87
+ it = it.key;
88
+ const cb = it.commentBefore;
89
+ it.commentBefore = cb ? `${comment}\n${cb}` : comment;
90
+ }
91
+ else {
92
+ const cb = dc.commentBefore;
93
+ dc.commentBefore = cb ? `${comment}\n${cb}` : comment;
94
+ }
95
+ }
96
+ if (afterDoc) {
97
+ Array.prototype.push.apply(doc.errors, this.errors);
98
+ Array.prototype.push.apply(doc.warnings, this.warnings);
99
+ }
100
+ else {
101
+ doc.errors = this.errors;
102
+ doc.warnings = this.warnings;
103
+ }
104
+ this.prelude = [];
105
+ this.errors = [];
106
+ this.warnings = [];
107
+ }
108
+ /**
109
+ * Current stream status information.
110
+ *
111
+ * Mostly useful at the end of input for an empty stream.
112
+ */
113
+ streamInfo() {
114
+ return {
115
+ comment: parsePrelude(this.prelude).comment,
116
+ directives: this.directives,
117
+ errors: this.errors,
118
+ warnings: this.warnings
119
+ };
120
+ }
121
+ /**
122
+ * Compose tokens into documents.
123
+ *
124
+ * @param forceDoc - If the stream contains no document, still emit a final document including any comments and directives that would be applied to a subsequent document.
125
+ * @param endOffset - Should be set if `forceDoc` is also set, to set the document range end and to indicate errors correctly.
126
+ */
127
+ *compose(tokens, forceDoc = false, endOffset = -1) {
128
+ for (const token of tokens)
129
+ yield* this.next(token);
130
+ yield* this.end(forceDoc, endOffset);
131
+ }
132
+ /** Advance the composer by one CST token. */
133
+ *next(token) {
134
+ switch (token.type) {
135
+ case 'directive':
136
+ this.directives.add(token.source, (offset, message, warning) => {
137
+ const pos = getErrorPos(token);
138
+ pos[0] += offset;
139
+ this.onError(pos, 'BAD_DIRECTIVE', message, warning);
140
+ });
141
+ this.prelude.push(token.source);
142
+ this.atDirectives = true;
143
+ break;
144
+ case 'document': {
145
+ const doc = composeDoc(this.options, this.directives, token, this.onError);
146
+ if (this.atDirectives && !doc.directives.docStart)
147
+ this.onError(token, 'MISSING_CHAR', 'Missing directives-end/doc-start indicator line');
148
+ this.decorate(doc, false);
149
+ if (this.doc)
150
+ yield this.doc;
151
+ this.doc = doc;
152
+ this.atDirectives = false;
153
+ break;
154
+ }
155
+ case 'byte-order-mark':
156
+ case 'space':
157
+ break;
158
+ case 'comment':
159
+ case 'newline':
160
+ this.prelude.push(token.source);
161
+ break;
162
+ case 'error': {
163
+ const msg = token.source
164
+ ? `${token.message}: ${JSON.stringify(token.source)}`
165
+ : token.message;
166
+ const error = new YAMLParseError(getErrorPos(token), 'UNEXPECTED_TOKEN', msg);
167
+ if (this.atDirectives || !this.doc)
168
+ this.errors.push(error);
169
+ else
170
+ this.doc.errors.push(error);
171
+ break;
172
+ }
173
+ case 'doc-end': {
174
+ if (!this.doc) {
175
+ const msg = 'Unexpected doc-end without preceding document';
176
+ this.errors.push(new YAMLParseError(getErrorPos(token), 'UNEXPECTED_TOKEN', msg));
177
+ break;
178
+ }
179
+ this.doc.directives.docEnd = true;
180
+ const end = resolveEnd(token.end, token.offset + token.source.length, this.doc.options.strict, this.onError);
181
+ this.decorate(this.doc, true);
182
+ if (end.comment) {
183
+ const dc = this.doc.comment;
184
+ this.doc.comment = dc ? `${dc}\n${end.comment}` : end.comment;
185
+ }
186
+ this.doc.range[2] = end.offset;
187
+ break;
188
+ }
189
+ default:
190
+ this.errors.push(new YAMLParseError(getErrorPos(token), 'UNEXPECTED_TOKEN', `Unsupported token ${token.type}`));
191
+ }
192
+ }
193
+ /**
194
+ * Call at end of input to yield any remaining document.
195
+ *
196
+ * @param forceDoc - If the stream contains no document, still emit a final document including any comments and directives that would be applied to a subsequent document.
197
+ * @param endOffset - Should be set if `forceDoc` is also set, to set the document range end and to indicate errors correctly.
198
+ */
199
+ *end(forceDoc = false, endOffset = -1) {
200
+ if (this.doc) {
201
+ this.decorate(this.doc, true);
202
+ yield this.doc;
203
+ this.doc = null;
204
+ }
205
+ else if (forceDoc) {
206
+ const opts = Object.assign({ _directives: this.directives }, this.options);
207
+ const doc = new Document(undefined, opts);
208
+ if (this.atDirectives)
209
+ this.onError(endOffset, 'MISSING_CHAR', 'Missing directives-end indicator line');
210
+ doc.range = [0, endOffset, endOffset];
211
+ this.decorate(doc, false);
212
+ yield doc;
213
+ }
214
+ }
215
+ }
216
+
217
+ export { Composer };