phantom-pr 0.2.2 → 0.2.4

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 (242) hide show
  1. package/dist/cli.js +7 -0
  2. package/dist/cli.js.map +1 -1
  3. package/node_modules/ignore/LICENSE-MIT +21 -0
  4. package/node_modules/ignore/README.md +452 -0
  5. package/node_modules/ignore/index.d.ts +81 -0
  6. package/node_modules/ignore/index.js +784 -0
  7. package/node_modules/ignore/legacy.js +681 -0
  8. package/node_modules/ignore/package.json +87 -0
  9. package/node_modules/yaml/LICENSE +13 -0
  10. package/node_modules/yaml/README.md +172 -0
  11. package/node_modules/yaml/bin.mjs +11 -0
  12. package/node_modules/yaml/browser/dist/compose/compose-collection.js +88 -0
  13. package/node_modules/yaml/browser/dist/compose/compose-doc.js +43 -0
  14. package/node_modules/yaml/browser/dist/compose/compose-node.js +102 -0
  15. package/node_modules/yaml/browser/dist/compose/compose-scalar.js +86 -0
  16. package/node_modules/yaml/browser/dist/compose/composer.js +217 -0
  17. package/node_modules/yaml/browser/dist/compose/resolve-block-map.js +115 -0
  18. package/node_modules/yaml/browser/dist/compose/resolve-block-scalar.js +198 -0
  19. package/node_modules/yaml/browser/dist/compose/resolve-block-seq.js +49 -0
  20. package/node_modules/yaml/browser/dist/compose/resolve-end.js +37 -0
  21. package/node_modules/yaml/browser/dist/compose/resolve-flow-collection.js +207 -0
  22. package/node_modules/yaml/browser/dist/compose/resolve-flow-scalar.js +223 -0
  23. package/node_modules/yaml/browser/dist/compose/resolve-props.js +146 -0
  24. package/node_modules/yaml/browser/dist/compose/util-contains-newline.js +34 -0
  25. package/node_modules/yaml/browser/dist/compose/util-empty-scalar-position.js +26 -0
  26. package/node_modules/yaml/browser/dist/compose/util-flow-indent-check.js +15 -0
  27. package/node_modules/yaml/browser/dist/compose/util-map-includes.js +13 -0
  28. package/node_modules/yaml/browser/dist/doc/Document.js +335 -0
  29. package/node_modules/yaml/browser/dist/doc/anchors.js +71 -0
  30. package/node_modules/yaml/browser/dist/doc/applyReviver.js +55 -0
  31. package/node_modules/yaml/browser/dist/doc/createNode.js +88 -0
  32. package/node_modules/yaml/browser/dist/doc/directives.js +176 -0
  33. package/node_modules/yaml/browser/dist/errors.js +57 -0
  34. package/node_modules/yaml/browser/dist/index.js +17 -0
  35. package/node_modules/yaml/browser/dist/log.js +11 -0
  36. package/node_modules/yaml/browser/dist/nodes/Alias.js +114 -0
  37. package/node_modules/yaml/browser/dist/nodes/Collection.js +147 -0
  38. package/node_modules/yaml/browser/dist/nodes/Node.js +38 -0
  39. package/node_modules/yaml/browser/dist/nodes/Pair.js +36 -0
  40. package/node_modules/yaml/browser/dist/nodes/Scalar.js +24 -0
  41. package/node_modules/yaml/browser/dist/nodes/YAMLMap.js +144 -0
  42. package/node_modules/yaml/browser/dist/nodes/YAMLSeq.js +113 -0
  43. package/node_modules/yaml/browser/dist/nodes/addPairToJSMap.js +63 -0
  44. package/node_modules/yaml/browser/dist/nodes/identity.js +36 -0
  45. package/node_modules/yaml/browser/dist/nodes/toJS.js +37 -0
  46. package/node_modules/yaml/browser/dist/parse/cst-scalar.js +214 -0
  47. package/node_modules/yaml/browser/dist/parse/cst-stringify.js +61 -0
  48. package/node_modules/yaml/browser/dist/parse/cst-visit.js +97 -0
  49. package/node_modules/yaml/browser/dist/parse/cst.js +98 -0
  50. package/node_modules/yaml/browser/dist/parse/lexer.js +717 -0
  51. package/node_modules/yaml/browser/dist/parse/line-counter.js +39 -0
  52. package/node_modules/yaml/browser/dist/parse/parser.js +967 -0
  53. package/node_modules/yaml/browser/dist/public-api.js +102 -0
  54. package/node_modules/yaml/browser/dist/schema/Schema.js +37 -0
  55. package/node_modules/yaml/browser/dist/schema/common/map.js +17 -0
  56. package/node_modules/yaml/browser/dist/schema/common/null.js +15 -0
  57. package/node_modules/yaml/browser/dist/schema/common/seq.js +17 -0
  58. package/node_modules/yaml/browser/dist/schema/common/string.js +14 -0
  59. package/node_modules/yaml/browser/dist/schema/core/bool.js +19 -0
  60. package/node_modules/yaml/browser/dist/schema/core/float.js +43 -0
  61. package/node_modules/yaml/browser/dist/schema/core/int.js +38 -0
  62. package/node_modules/yaml/browser/dist/schema/core/schema.js +23 -0
  63. package/node_modules/yaml/browser/dist/schema/json/schema.js +62 -0
  64. package/node_modules/yaml/browser/dist/schema/tags.js +96 -0
  65. package/node_modules/yaml/browser/dist/schema/yaml-1.1/binary.js +58 -0
  66. package/node_modules/yaml/browser/dist/schema/yaml-1.1/bool.js +26 -0
  67. package/node_modules/yaml/browser/dist/schema/yaml-1.1/float.js +46 -0
  68. package/node_modules/yaml/browser/dist/schema/yaml-1.1/int.js +71 -0
  69. package/node_modules/yaml/browser/dist/schema/yaml-1.1/merge.js +64 -0
  70. package/node_modules/yaml/browser/dist/schema/yaml-1.1/omap.js +74 -0
  71. package/node_modules/yaml/browser/dist/schema/yaml-1.1/pairs.js +78 -0
  72. package/node_modules/yaml/browser/dist/schema/yaml-1.1/schema.js +39 -0
  73. package/node_modules/yaml/browser/dist/schema/yaml-1.1/set.js +93 -0
  74. package/node_modules/yaml/browser/dist/schema/yaml-1.1/timestamp.js +101 -0
  75. package/node_modules/yaml/browser/dist/stringify/foldFlowLines.js +146 -0
  76. package/node_modules/yaml/browser/dist/stringify/stringify.js +128 -0
  77. package/node_modules/yaml/browser/dist/stringify/stringifyCollection.js +143 -0
  78. package/node_modules/yaml/browser/dist/stringify/stringifyComment.js +20 -0
  79. package/node_modules/yaml/browser/dist/stringify/stringifyDocument.js +85 -0
  80. package/node_modules/yaml/browser/dist/stringify/stringifyNumber.js +24 -0
  81. package/node_modules/yaml/browser/dist/stringify/stringifyPair.js +150 -0
  82. package/node_modules/yaml/browser/dist/stringify/stringifyString.js +336 -0
  83. package/node_modules/yaml/browser/dist/util.js +11 -0
  84. package/node_modules/yaml/browser/dist/visit.js +233 -0
  85. package/node_modules/yaml/browser/index.js +5 -0
  86. package/node_modules/yaml/browser/package.json +3 -0
  87. package/node_modules/yaml/dist/cli.d.ts +8 -0
  88. package/node_modules/yaml/dist/cli.mjs +201 -0
  89. package/node_modules/yaml/dist/compose/compose-collection.d.ts +11 -0
  90. package/node_modules/yaml/dist/compose/compose-collection.js +90 -0
  91. package/node_modules/yaml/dist/compose/compose-doc.d.ts +7 -0
  92. package/node_modules/yaml/dist/compose/compose-doc.js +45 -0
  93. package/node_modules/yaml/dist/compose/compose-node.d.ts +29 -0
  94. package/node_modules/yaml/dist/compose/compose-node.js +105 -0
  95. package/node_modules/yaml/dist/compose/compose-scalar.d.ts +5 -0
  96. package/node_modules/yaml/dist/compose/compose-scalar.js +88 -0
  97. package/node_modules/yaml/dist/compose/composer.d.ts +63 -0
  98. package/node_modules/yaml/dist/compose/composer.js +222 -0
  99. package/node_modules/yaml/dist/compose/resolve-block-map.d.ts +6 -0
  100. package/node_modules/yaml/dist/compose/resolve-block-map.js +117 -0
  101. package/node_modules/yaml/dist/compose/resolve-block-scalar.d.ts +11 -0
  102. package/node_modules/yaml/dist/compose/resolve-block-scalar.js +200 -0
  103. package/node_modules/yaml/dist/compose/resolve-block-seq.d.ts +6 -0
  104. package/node_modules/yaml/dist/compose/resolve-block-seq.js +51 -0
  105. package/node_modules/yaml/dist/compose/resolve-end.d.ts +6 -0
  106. package/node_modules/yaml/dist/compose/resolve-end.js +39 -0
  107. package/node_modules/yaml/dist/compose/resolve-flow-collection.d.ts +7 -0
  108. package/node_modules/yaml/dist/compose/resolve-flow-collection.js +209 -0
  109. package/node_modules/yaml/dist/compose/resolve-flow-scalar.d.ts +10 -0
  110. package/node_modules/yaml/dist/compose/resolve-flow-scalar.js +225 -0
  111. package/node_modules/yaml/dist/compose/resolve-props.d.ts +23 -0
  112. package/node_modules/yaml/dist/compose/resolve-props.js +148 -0
  113. package/node_modules/yaml/dist/compose/util-contains-newline.d.ts +2 -0
  114. package/node_modules/yaml/dist/compose/util-contains-newline.js +36 -0
  115. package/node_modules/yaml/dist/compose/util-empty-scalar-position.d.ts +2 -0
  116. package/node_modules/yaml/dist/compose/util-empty-scalar-position.js +28 -0
  117. package/node_modules/yaml/dist/compose/util-flow-indent-check.d.ts +3 -0
  118. package/node_modules/yaml/dist/compose/util-flow-indent-check.js +17 -0
  119. package/node_modules/yaml/dist/compose/util-map-includes.d.ts +4 -0
  120. package/node_modules/yaml/dist/compose/util-map-includes.js +15 -0
  121. package/node_modules/yaml/dist/doc/Document.d.ts +141 -0
  122. package/node_modules/yaml/dist/doc/Document.js +337 -0
  123. package/node_modules/yaml/dist/doc/anchors.d.ts +24 -0
  124. package/node_modules/yaml/dist/doc/anchors.js +76 -0
  125. package/node_modules/yaml/dist/doc/applyReviver.d.ts +9 -0
  126. package/node_modules/yaml/dist/doc/applyReviver.js +57 -0
  127. package/node_modules/yaml/dist/doc/createNode.d.ts +17 -0
  128. package/node_modules/yaml/dist/doc/createNode.js +90 -0
  129. package/node_modules/yaml/dist/doc/directives.d.ts +49 -0
  130. package/node_modules/yaml/dist/doc/directives.js +178 -0
  131. package/node_modules/yaml/dist/errors.d.ts +21 -0
  132. package/node_modules/yaml/dist/errors.js +62 -0
  133. package/node_modules/yaml/dist/index.d.ts +25 -0
  134. package/node_modules/yaml/dist/index.js +50 -0
  135. package/node_modules/yaml/dist/log.d.ts +3 -0
  136. package/node_modules/yaml/dist/log.js +19 -0
  137. package/node_modules/yaml/dist/nodes/Alias.d.ts +29 -0
  138. package/node_modules/yaml/dist/nodes/Alias.js +116 -0
  139. package/node_modules/yaml/dist/nodes/Collection.d.ts +73 -0
  140. package/node_modules/yaml/dist/nodes/Collection.js +151 -0
  141. package/node_modules/yaml/dist/nodes/Node.d.ts +53 -0
  142. package/node_modules/yaml/dist/nodes/Node.js +40 -0
  143. package/node_modules/yaml/dist/nodes/Pair.d.ts +22 -0
  144. package/node_modules/yaml/dist/nodes/Pair.js +39 -0
  145. package/node_modules/yaml/dist/nodes/Scalar.d.ts +43 -0
  146. package/node_modules/yaml/dist/nodes/Scalar.js +27 -0
  147. package/node_modules/yaml/dist/nodes/YAMLMap.d.ts +53 -0
  148. package/node_modules/yaml/dist/nodes/YAMLMap.js +147 -0
  149. package/node_modules/yaml/dist/nodes/YAMLSeq.d.ts +60 -0
  150. package/node_modules/yaml/dist/nodes/YAMLSeq.js +115 -0
  151. package/node_modules/yaml/dist/nodes/addPairToJSMap.d.ts +4 -0
  152. package/node_modules/yaml/dist/nodes/addPairToJSMap.js +65 -0
  153. package/node_modules/yaml/dist/nodes/identity.d.ts +23 -0
  154. package/node_modules/yaml/dist/nodes/identity.js +53 -0
  155. package/node_modules/yaml/dist/nodes/toJS.d.ts +29 -0
  156. package/node_modules/yaml/dist/nodes/toJS.js +39 -0
  157. package/node_modules/yaml/dist/options.d.ts +344 -0
  158. package/node_modules/yaml/dist/parse/cst-scalar.d.ts +64 -0
  159. package/node_modules/yaml/dist/parse/cst-scalar.js +218 -0
  160. package/node_modules/yaml/dist/parse/cst-stringify.d.ts +8 -0
  161. package/node_modules/yaml/dist/parse/cst-stringify.js +63 -0
  162. package/node_modules/yaml/dist/parse/cst-visit.d.ts +39 -0
  163. package/node_modules/yaml/dist/parse/cst-visit.js +99 -0
  164. package/node_modules/yaml/dist/parse/cst.d.ts +109 -0
  165. package/node_modules/yaml/dist/parse/cst.js +112 -0
  166. package/node_modules/yaml/dist/parse/lexer.d.ts +87 -0
  167. package/node_modules/yaml/dist/parse/lexer.js +719 -0
  168. package/node_modules/yaml/dist/parse/line-counter.d.ts +22 -0
  169. package/node_modules/yaml/dist/parse/line-counter.js +41 -0
  170. package/node_modules/yaml/dist/parse/parser.d.ts +84 -0
  171. package/node_modules/yaml/dist/parse/parser.js +972 -0
  172. package/node_modules/yaml/dist/public-api.d.ts +44 -0
  173. package/node_modules/yaml/dist/public-api.js +107 -0
  174. package/node_modules/yaml/dist/schema/Schema.d.ts +17 -0
  175. package/node_modules/yaml/dist/schema/Schema.js +39 -0
  176. package/node_modules/yaml/dist/schema/common/map.d.ts +2 -0
  177. package/node_modules/yaml/dist/schema/common/map.js +19 -0
  178. package/node_modules/yaml/dist/schema/common/null.d.ts +4 -0
  179. package/node_modules/yaml/dist/schema/common/null.js +17 -0
  180. package/node_modules/yaml/dist/schema/common/seq.d.ts +2 -0
  181. package/node_modules/yaml/dist/schema/common/seq.js +19 -0
  182. package/node_modules/yaml/dist/schema/common/string.d.ts +2 -0
  183. package/node_modules/yaml/dist/schema/common/string.js +16 -0
  184. package/node_modules/yaml/dist/schema/core/bool.d.ts +4 -0
  185. package/node_modules/yaml/dist/schema/core/bool.js +21 -0
  186. package/node_modules/yaml/dist/schema/core/float.d.ts +4 -0
  187. package/node_modules/yaml/dist/schema/core/float.js +47 -0
  188. package/node_modules/yaml/dist/schema/core/int.d.ts +4 -0
  189. package/node_modules/yaml/dist/schema/core/int.js +42 -0
  190. package/node_modules/yaml/dist/schema/core/schema.d.ts +1 -0
  191. package/node_modules/yaml/dist/schema/core/schema.js +25 -0
  192. package/node_modules/yaml/dist/schema/json/schema.d.ts +2 -0
  193. package/node_modules/yaml/dist/schema/json/schema.js +64 -0
  194. package/node_modules/yaml/dist/schema/json-schema.d.ts +69 -0
  195. package/node_modules/yaml/dist/schema/tags.d.ts +48 -0
  196. package/node_modules/yaml/dist/schema/tags.js +99 -0
  197. package/node_modules/yaml/dist/schema/types.d.ts +92 -0
  198. package/node_modules/yaml/dist/schema/yaml-1.1/binary.d.ts +2 -0
  199. package/node_modules/yaml/dist/schema/yaml-1.1/binary.js +70 -0
  200. package/node_modules/yaml/dist/schema/yaml-1.1/bool.d.ts +7 -0
  201. package/node_modules/yaml/dist/schema/yaml-1.1/bool.js +29 -0
  202. package/node_modules/yaml/dist/schema/yaml-1.1/float.d.ts +4 -0
  203. package/node_modules/yaml/dist/schema/yaml-1.1/float.js +50 -0
  204. package/node_modules/yaml/dist/schema/yaml-1.1/int.d.ts +5 -0
  205. package/node_modules/yaml/dist/schema/yaml-1.1/int.js +76 -0
  206. package/node_modules/yaml/dist/schema/yaml-1.1/merge.d.ts +9 -0
  207. package/node_modules/yaml/dist/schema/yaml-1.1/merge.js +68 -0
  208. package/node_modules/yaml/dist/schema/yaml-1.1/omap.d.ts +22 -0
  209. package/node_modules/yaml/dist/schema/yaml-1.1/omap.js +77 -0
  210. package/node_modules/yaml/dist/schema/yaml-1.1/pairs.d.ts +10 -0
  211. package/node_modules/yaml/dist/schema/yaml-1.1/pairs.js +82 -0
  212. package/node_modules/yaml/dist/schema/yaml-1.1/schema.d.ts +1 -0
  213. package/node_modules/yaml/dist/schema/yaml-1.1/schema.js +41 -0
  214. package/node_modules/yaml/dist/schema/yaml-1.1/set.d.ts +28 -0
  215. package/node_modules/yaml/dist/schema/yaml-1.1/set.js +96 -0
  216. package/node_modules/yaml/dist/schema/yaml-1.1/timestamp.d.ts +6 -0
  217. package/node_modules/yaml/dist/schema/yaml-1.1/timestamp.js +105 -0
  218. package/node_modules/yaml/dist/stringify/foldFlowLines.d.ts +34 -0
  219. package/node_modules/yaml/dist/stringify/foldFlowLines.js +151 -0
  220. package/node_modules/yaml/dist/stringify/stringify.d.ts +21 -0
  221. package/node_modules/yaml/dist/stringify/stringify.js +131 -0
  222. package/node_modules/yaml/dist/stringify/stringifyCollection.d.ts +17 -0
  223. package/node_modules/yaml/dist/stringify/stringifyCollection.js +145 -0
  224. package/node_modules/yaml/dist/stringify/stringifyComment.d.ts +10 -0
  225. package/node_modules/yaml/dist/stringify/stringifyComment.js +24 -0
  226. package/node_modules/yaml/dist/stringify/stringifyDocument.d.ts +4 -0
  227. package/node_modules/yaml/dist/stringify/stringifyDocument.js +87 -0
  228. package/node_modules/yaml/dist/stringify/stringifyNumber.d.ts +2 -0
  229. package/node_modules/yaml/dist/stringify/stringifyNumber.js +26 -0
  230. package/node_modules/yaml/dist/stringify/stringifyPair.d.ts +3 -0
  231. package/node_modules/yaml/dist/stringify/stringifyPair.js +152 -0
  232. package/node_modules/yaml/dist/stringify/stringifyString.d.ts +9 -0
  233. package/node_modules/yaml/dist/stringify/stringifyString.js +338 -0
  234. package/node_modules/yaml/dist/test-events.d.ts +4 -0
  235. package/node_modules/yaml/dist/test-events.js +134 -0
  236. package/node_modules/yaml/dist/util.d.ts +16 -0
  237. package/node_modules/yaml/dist/util.js +28 -0
  238. package/node_modules/yaml/dist/visit.d.ts +102 -0
  239. package/node_modules/yaml/dist/visit.js +236 -0
  240. package/node_modules/yaml/package.json +97 -0
  241. package/node_modules/yaml/util.js +2 -0
  242. package/package.json +5 -1
@@ -0,0 +1,87 @@
1
+ {
2
+ "name": "ignore",
3
+ "version": "7.0.5",
4
+ "description": "Ignore is a manager and filter for .gitignore rules, the one used by eslint, gitbook and many others.",
5
+ "types": "index.d.ts",
6
+ "files": [
7
+ "legacy.js",
8
+ "index.js",
9
+ "index.d.ts",
10
+ "LICENSE-MIT"
11
+ ],
12
+ "scripts": {
13
+ "prepublishOnly": "npm run build",
14
+ "build": "babel -o legacy.js index.js",
15
+
16
+ "==================== linting ======================": "",
17
+ "lint": "eslint .",
18
+
19
+ "===================== import ======================": "",
20
+ "ts": "npm run test:ts && npm run test:16",
21
+ "test:ts": "ts-node ./test/import/simple.ts",
22
+ "test:16": "npm run test:ts:16 && npm run test:cjs:16 && npm run test:mjs:16",
23
+ "test:ts:16": "ts-node --compilerOptions '{\"moduleResolution\": \"Node16\", \"module\": \"Node16\"}' ./test/import/simple.ts && tsc ./test/import/simple.ts --lib ES6 --moduleResolution Node16 --module Node16 && node ./test/import/simple.js",
24
+ "test:cjs:16": "ts-node --compilerOptions '{\"moduleResolution\": \"Node16\", \"module\": \"Node16\"}' ./test/import/simple.cjs",
25
+ "test:mjs:16": "ts-node --compilerOptions '{\"moduleResolution\": \"Node16\", \"module\": \"Node16\"}' ./test/import/simple.mjs && babel -o ./test/import/simple-mjs.js ./test/import/simple.mjs && node ./test/import/simple-mjs.js",
26
+
27
+ "===================== cases =======================": "",
28
+ "test:cases": "npm run tap test/*.test.js -- --coverage",
29
+ "tap": "tap --reporter classic",
30
+
31
+ "===================== debug =======================": "",
32
+ "test:git": "npm run tap test/git-check-ignore.test.js",
33
+ "test:ignore": "npm run tap test/ignore.test.js",
34
+ "test:ignore:only": "IGNORE_ONLY_IGNORES=1 npm run tap test/ignore.test.js",
35
+ "test:others": "npm run tap test/others.test.js",
36
+ "test:no-coverage": "npm run tap test/*.test.js -- --no-check-coverage",
37
+
38
+ "test": "npm run lint && npm run ts && npm run build && npm run test:cases",
39
+ "test:win32": "IGNORE_TEST_WIN32=1 npm run test",
40
+ "report": "tap --coverage-report=html"
41
+ },
42
+ "repository": {
43
+ "type": "git",
44
+ "url": "git@github.com:kaelzhang/node-ignore.git"
45
+ },
46
+ "keywords": [
47
+ "ignore",
48
+ ".gitignore",
49
+ "gitignore",
50
+ "npmignore",
51
+ "rules",
52
+ "manager",
53
+ "filter",
54
+ "regexp",
55
+ "regex",
56
+ "fnmatch",
57
+ "glob",
58
+ "asterisks",
59
+ "regular-expression"
60
+ ],
61
+ "author": "kael",
62
+ "license": "MIT",
63
+ "bugs": {
64
+ "url": "https://github.com/kaelzhang/node-ignore/issues"
65
+ },
66
+ "devDependencies": {
67
+ "@babel/cli": "^7.22.9",
68
+ "@babel/core": "^7.22.9",
69
+ "@babel/preset-env": "^7.22.9",
70
+ "@typescript-eslint/eslint-plugin": "^8.19.1",
71
+ "debug": "^4.3.4",
72
+ "eslint": "^8.46.0",
73
+ "eslint-config-ostai": "^3.0.0",
74
+ "eslint-plugin-import": "^2.28.0",
75
+ "mkdirp": "^3.0.1",
76
+ "pre-suf": "^1.1.1",
77
+ "rimraf": "^6.0.1",
78
+ "spawn-sync": "^2.0.0",
79
+ "tap": "^16.3.9",
80
+ "tmp": "0.2.3",
81
+ "ts-node": "^10.9.2",
82
+ "typescript": "^5.6.2"
83
+ },
84
+ "engines": {
85
+ "node": ">= 4"
86
+ }
87
+ }
@@ -0,0 +1,13 @@
1
+ Copyright Eemeli Aro <eemeli@gmail.com>
2
+
3
+ Permission to use, copy, modify, and/or distribute this software for any purpose
4
+ with or without fee is hereby granted, provided that the above copyright notice
5
+ and this permission notice appear in all copies.
6
+
7
+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
8
+ REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
9
+ FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
10
+ INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
11
+ OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
12
+ TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
13
+ THIS SOFTWARE.
@@ -0,0 +1,172 @@
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
+ The minimum supported TypeScript version of the included typings is 3.9;
18
+ for use in earlier versions you may need to set `skipLibCheck: true` in your config.
19
+ This requirement may be updated between minor versions of the library.
20
+
21
+ For more information, see the project's documentation site: [**eemeli.org/yaml**](https://eemeli.org/yaml/)
22
+
23
+ For build instructions and contribution guidelines, see [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md).
24
+
25
+ To install:
26
+
27
+ ```sh
28
+ npm install yaml
29
+ # or
30
+ deno add jsr:@eemeli/yaml
31
+ ```
32
+
33
+ **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.
34
+
35
+ ## API Overview
36
+
37
+ 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).
38
+ 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.
39
+
40
+ A [command-line tool](https://eemeli.org/yaml/#command-line-tool) is also included.
41
+
42
+ ### Parse & Stringify
43
+
44
+ ```js
45
+ import { parse, stringify } from 'yaml'
46
+ ```
47
+
48
+ - [`parse(str, reviver?, options?): value`](https://eemeli.org/yaml/#yaml-parse)
49
+ - [`stringify(value, replacer?, options?): string`](https://eemeli.org/yaml/#yaml-stringify)
50
+
51
+ ### Documents
52
+
53
+ <!-- prettier-ignore -->
54
+ ```js
55
+ import {
56
+ Document,
57
+ isDocument,
58
+ parseAllDocuments,
59
+ parseDocument
60
+ } from 'yaml'
61
+ ```
62
+
63
+ - [`Document`](https://eemeli.org/yaml/#documents)
64
+ - [`constructor(value, replacer?, options?)`](https://eemeli.org/yaml/#creating-documents)
65
+ - [`#contents`](https://eemeli.org/yaml/#content-nodes)
66
+ - [`#directives`](https://eemeli.org/yaml/#stream-directives)
67
+ - [`#errors`](https://eemeli.org/yaml/#errors)
68
+ - [`#warnings`](https://eemeli.org/yaml/#errors)
69
+ - [`isDocument(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
70
+ - [`parseAllDocuments(str, options?): Document[]`](https://eemeli.org/yaml/#parsing-documents)
71
+ - [`parseDocument(str, options?): Document`](https://eemeli.org/yaml/#parsing-documents)
72
+
73
+ ### Content Nodes
74
+
75
+ <!-- prettier-ignore -->
76
+ ```js
77
+ import {
78
+ isAlias, isCollection, isMap, isNode,
79
+ isPair, isScalar, isSeq, Scalar,
80
+ visit, visitAsync, YAMLMap, YAMLSeq
81
+ } from 'yaml'
82
+ ```
83
+
84
+ - [`isAlias(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
85
+ - [`isCollection(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
86
+ - [`isMap(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
87
+ - [`isNode(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
88
+ - [`isPair(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
89
+ - [`isScalar(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
90
+ - [`isSeq(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
91
+ - [`new Scalar(value)`](https://eemeli.org/yaml/#scalar-values)
92
+ - [`new YAMLMap()`](https://eemeli.org/yaml/#collections)
93
+ - [`new YAMLSeq()`](https://eemeli.org/yaml/#collections)
94
+ - [`doc.createAlias(node, name?): Alias`](https://eemeli.org/yaml/#creating-nodes)
95
+ - [`doc.createNode(value, options?): Node`](https://eemeli.org/yaml/#creating-nodes)
96
+ - [`doc.createPair(key, value): Pair`](https://eemeli.org/yaml/#creating-nodes)
97
+ - [`visit(node, visitor)`](https://eemeli.org/yaml/#finding-and-modifying-nodes)
98
+ - [`visitAsync(node, visitor)`](https://eemeli.org/yaml/#finding-and-modifying-nodes)
99
+
100
+ ### Parsing YAML
101
+
102
+ ```js
103
+ import { Composer, Lexer, Parser } from 'yaml'
104
+ ```
105
+
106
+ - [`new Lexer().lex(src)`](https://eemeli.org/yaml/#lexer)
107
+ - [`new Parser(onNewLine?).parse(src)`](https://eemeli.org/yaml/#parser)
108
+ - [`new Composer(options?).compose(tokens)`](https://eemeli.org/yaml/#composer)
109
+
110
+ ## YAML.parse
111
+
112
+ ```yaml
113
+ # file.yml
114
+ YAML:
115
+ - A human-readable data serialization language
116
+ - https://en.wikipedia.org/wiki/YAML
117
+ yaml:
118
+ - A complete JavaScript implementation
119
+ - https://www.npmjs.com/package/yaml
120
+ ```
121
+
122
+ ```js
123
+ import fs from 'fs'
124
+ import YAML from 'yaml'
125
+
126
+ YAML.parse('3.14159')
127
+ // 3.14159
128
+
129
+ YAML.parse('[ true, false, maybe, null ]\n')
130
+ // [ true, false, 'maybe', null ]
131
+
132
+ const file = fs.readFileSync('./file.yml', 'utf8')
133
+ YAML.parse(file)
134
+ // { YAML:
135
+ // [ 'A human-readable data serialization language',
136
+ // 'https://en.wikipedia.org/wiki/YAML' ],
137
+ // yaml:
138
+ // [ 'A complete JavaScript implementation',
139
+ // 'https://www.npmjs.com/package/yaml' ] }
140
+ ```
141
+
142
+ ## YAML.stringify
143
+
144
+ ```js
145
+ import YAML from 'yaml'
146
+
147
+ YAML.stringify(3.14159)
148
+ // '3.14159\n'
149
+
150
+ YAML.stringify([true, false, 'maybe', null])
151
+ // `- true
152
+ // - false
153
+ // - maybe
154
+ // - null
155
+ // `
156
+
157
+ YAML.stringify({ number: 3, plain: 'string', block: 'two\nlines\n' })
158
+ // `number: 3
159
+ // plain: string
160
+ // block: |
161
+ // two
162
+ // lines
163
+ // `
164
+ ```
165
+
166
+ ---
167
+
168
+ Browser testing provided by:
169
+
170
+ <a href="https://www.browserstack.com/open-source">
171
+ <img width=200 src="https://eemeli.org/yaml/images/browserstack.svg" alt="BrowserStack" />
172
+ </a>
@@ -0,0 +1,11 @@
1
+ #!/usr/bin/env node
2
+
3
+ import { UserError, cli, help } from './dist/cli.mjs'
4
+
5
+ cli(process.stdin, error => {
6
+ if (error instanceof UserError) {
7
+ if (error.code === UserError.ARGS) console.error(`${help}\n`)
8
+ console.error(error.message)
9
+ process.exitCode = error.code
10
+ } else if (error) throw error
11
+ })
@@ -0,0 +1,88 @@
1
+ import { isNode } from '../nodes/identity.js';
2
+ import { Scalar } from '../nodes/Scalar.js';
3
+ import { YAMLMap } from '../nodes/YAMLMap.js';
4
+ import { YAMLSeq } from '../nodes/YAMLSeq.js';
5
+ import { resolveBlockMap } from './resolve-block-map.js';
6
+ import { resolveBlockSeq } from './resolve-block-seq.js';
7
+ import { resolveFlowCollection } from './resolve-flow-collection.js';
8
+
9
+ function resolveCollection(CN, ctx, token, onError, tagName, tag) {
10
+ const coll = token.type === 'block-map'
11
+ ? resolveBlockMap(CN, ctx, token, onError, tag)
12
+ : token.type === 'block-seq'
13
+ ? resolveBlockSeq(CN, ctx, token, onError, tag)
14
+ : resolveFlowCollection(CN, ctx, token, onError, tag);
15
+ const Coll = coll.constructor;
16
+ // If we got a tagName matching the class, or the tag name is '!',
17
+ // then use the tagName from the node class used to create it.
18
+ if (tagName === '!' || tagName === Coll.tagName) {
19
+ coll.tag = Coll.tagName;
20
+ return coll;
21
+ }
22
+ if (tagName)
23
+ coll.tag = tagName;
24
+ return coll;
25
+ }
26
+ function composeCollection(CN, ctx, token, props, onError) {
27
+ const tagToken = props.tag;
28
+ const tagName = !tagToken
29
+ ? null
30
+ : ctx.directives.tagName(tagToken.source, msg => onError(tagToken, 'TAG_RESOLVE_FAILED', msg));
31
+ if (token.type === 'block-seq') {
32
+ const { anchor, newlineAfterProp: nl } = props;
33
+ const lastProp = anchor && tagToken
34
+ ? anchor.offset > tagToken.offset
35
+ ? anchor
36
+ : tagToken
37
+ : (anchor ?? tagToken);
38
+ if (lastProp && (!nl || nl.offset < lastProp.offset)) {
39
+ const message = 'Missing newline after block sequence props';
40
+ onError(lastProp, 'MISSING_CHAR', message);
41
+ }
42
+ }
43
+ const expType = token.type === 'block-map'
44
+ ? 'map'
45
+ : token.type === 'block-seq'
46
+ ? 'seq'
47
+ : token.start.source === '{'
48
+ ? 'map'
49
+ : 'seq';
50
+ // shortcut: check if it's a generic YAMLMap or YAMLSeq
51
+ // before jumping into the custom tag logic.
52
+ if (!tagToken ||
53
+ !tagName ||
54
+ tagName === '!' ||
55
+ (tagName === YAMLMap.tagName && expType === 'map') ||
56
+ (tagName === YAMLSeq.tagName && expType === 'seq')) {
57
+ return resolveCollection(CN, ctx, token, onError, tagName);
58
+ }
59
+ let tag = ctx.schema.tags.find(t => t.tag === tagName && t.collection === expType);
60
+ if (!tag) {
61
+ const kt = ctx.schema.knownTags[tagName];
62
+ if (kt?.collection === expType) {
63
+ ctx.schema.tags.push(Object.assign({}, kt, { default: false }));
64
+ tag = kt;
65
+ }
66
+ else {
67
+ if (kt) {
68
+ onError(tagToken, 'BAD_COLLECTION_TYPE', `${kt.tag} used for ${expType} collection, but expects ${kt.collection ?? 'scalar'}`, true);
69
+ }
70
+ else {
71
+ onError(tagToken, 'TAG_RESOLVE_FAILED', `Unresolved tag: ${tagName}`, true);
72
+ }
73
+ return resolveCollection(CN, ctx, token, onError, tagName);
74
+ }
75
+ }
76
+ const coll = resolveCollection(CN, ctx, token, onError, tagName, tag);
77
+ const res = tag.resolve?.(coll, msg => onError(tagToken, 'TAG_RESOLVE_FAILED', msg), ctx.options) ?? coll;
78
+ const node = isNode(res)
79
+ ? res
80
+ : new Scalar(res);
81
+ node.range = coll.range;
82
+ node.tag = tagName;
83
+ if (tag?.format)
84
+ node.format = tag.format;
85
+ return node;
86
+ }
87
+
88
+ export { composeCollection };
@@ -0,0 +1,43 @@
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
+ atKey: false,
11
+ atRoot: true,
12
+ directives: doc.directives,
13
+ options: doc.options,
14
+ schema: doc.schema
15
+ };
16
+ const props = resolveProps(start, {
17
+ indicator: 'doc-start',
18
+ next: value ?? end?.[0],
19
+ offset,
20
+ onError,
21
+ parentIndent: 0,
22
+ startOnNewline: true
23
+ });
24
+ if (props.found) {
25
+ doc.directives.docStart = true;
26
+ if (value &&
27
+ (value.type === 'block-map' || value.type === 'block-seq') &&
28
+ !props.hasNewline)
29
+ onError(props.end, 'MISSING_CHAR', 'Block collection cannot start on same line with directives-end marker');
30
+ }
31
+ // @ts-expect-error If Contents is set, let's trust the user
32
+ doc.contents = value
33
+ ? composeNode(ctx, value, props, onError)
34
+ : composeEmptyNode(ctx, props.end, start, null, props, onError);
35
+ const contentEnd = doc.contents.range[2];
36
+ const re = resolveEnd(end, contentEnd, false, onError);
37
+ if (re.comment)
38
+ doc.comment = re.comment;
39
+ doc.range = [offset, contentEnd, re.offset];
40
+ return doc;
41
+ }
42
+
43
+ export { composeDoc };
@@ -0,0 +1,102 @@
1
+ import { Alias } from '../nodes/Alias.js';
2
+ import { isScalar } from '../nodes/identity.js';
3
+ import { composeCollection } from './compose-collection.js';
4
+ import { composeScalar } from './compose-scalar.js';
5
+ import { resolveEnd } from './resolve-end.js';
6
+ import { emptyScalarPosition } from './util-empty-scalar-position.js';
7
+
8
+ const CN = { composeNode, composeEmptyNode };
9
+ function composeNode(ctx, token, props, onError) {
10
+ const atKey = ctx.atKey;
11
+ const { spaceBefore, comment, anchor, tag } = props;
12
+ let node;
13
+ let isSrcToken = true;
14
+ switch (token.type) {
15
+ case 'alias':
16
+ node = composeAlias(ctx, token, onError);
17
+ if (anchor || tag)
18
+ onError(token, 'ALIAS_PROPS', 'An alias node must not specify any properties');
19
+ break;
20
+ case 'scalar':
21
+ case 'single-quoted-scalar':
22
+ case 'double-quoted-scalar':
23
+ case 'block-scalar':
24
+ node = composeScalar(ctx, token, tag, onError);
25
+ if (anchor)
26
+ node.anchor = anchor.source.substring(1);
27
+ break;
28
+ case 'block-map':
29
+ case 'block-seq':
30
+ case 'flow-collection':
31
+ node = composeCollection(CN, ctx, token, props, onError);
32
+ if (anchor)
33
+ node.anchor = anchor.source.substring(1);
34
+ break;
35
+ default: {
36
+ const message = token.type === 'error'
37
+ ? token.message
38
+ : `Unsupported token (type: ${token.type})`;
39
+ onError(token, 'UNEXPECTED_TOKEN', message);
40
+ node = composeEmptyNode(ctx, token.offset, undefined, null, props, onError);
41
+ isSrcToken = false;
42
+ }
43
+ }
44
+ if (anchor && node.anchor === '')
45
+ onError(anchor, 'BAD_ALIAS', 'Anchor cannot be an empty string');
46
+ if (atKey &&
47
+ ctx.options.stringKeys &&
48
+ (!isScalar(node) ||
49
+ typeof node.value !== 'string' ||
50
+ (node.tag && node.tag !== 'tag:yaml.org,2002:str'))) {
51
+ const msg = 'With stringKeys, all keys must be strings';
52
+ onError(tag ?? token, 'NON_STRING_KEY', msg);
53
+ }
54
+ if (spaceBefore)
55
+ node.spaceBefore = true;
56
+ if (comment) {
57
+ if (token.type === 'scalar' && token.source === '')
58
+ node.comment = comment;
59
+ else
60
+ node.commentBefore = comment;
61
+ }
62
+ // @ts-expect-error Type checking misses meaning of isSrcToken
63
+ if (ctx.options.keepSourceTokens && isSrcToken)
64
+ node.srcToken = token;
65
+ return node;
66
+ }
67
+ function composeEmptyNode(ctx, offset, before, pos, { spaceBefore, comment, anchor, tag, end }, onError) {
68
+ const token = {
69
+ type: 'scalar',
70
+ offset: emptyScalarPosition(offset, before, pos),
71
+ indent: -1,
72
+ source: ''
73
+ };
74
+ const node = composeScalar(ctx, token, tag, onError);
75
+ if (anchor) {
76
+ node.anchor = anchor.source.substring(1);
77
+ if (node.anchor === '')
78
+ onError(anchor, 'BAD_ALIAS', 'Anchor cannot be an empty string');
79
+ }
80
+ if (spaceBefore)
81
+ node.spaceBefore = true;
82
+ if (comment) {
83
+ node.comment = comment;
84
+ node.range[2] = end;
85
+ }
86
+ return node;
87
+ }
88
+ function composeAlias({ options }, { offset, source, end }, onError) {
89
+ const alias = new Alias(source.substring(1));
90
+ if (alias.source === '')
91
+ onError(offset, 'BAD_ALIAS', 'Alias cannot be an empty string');
92
+ if (alias.source.endsWith(':'))
93
+ onError(offset + source.length - 1, 'BAD_ALIAS', 'Alias ending in : is ambiguous', true);
94
+ const valueEnd = offset + source.length;
95
+ const re = resolveEnd(end, valueEnd, options.strict, onError);
96
+ alias.range = [offset, valueEnd, re.offset];
97
+ if (re.comment)
98
+ alias.comment = re.comment;
99
+ return alias;
100
+ }
101
+
102
+ export { composeEmptyNode, composeNode };
@@ -0,0 +1,86 @@
1
+ import { isScalar, SCALAR } from '../nodes/identity.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(ctx, token, 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
+ let tag;
14
+ if (ctx.options.stringKeys && ctx.atKey) {
15
+ tag = ctx.schema[SCALAR];
16
+ }
17
+ else if (tagName)
18
+ tag = findScalarTagByName(ctx.schema, value, tagName, tagToken, onError);
19
+ else if (token.type === 'scalar')
20
+ tag = findScalarTagByTest(ctx, value, token, onError);
21
+ else
22
+ tag = ctx.schema[SCALAR];
23
+ let scalar;
24
+ try {
25
+ const res = tag.resolve(value, msg => onError(tagToken ?? token, 'TAG_RESOLVE_FAILED', msg), ctx.options);
26
+ scalar = isScalar(res) ? res : new Scalar(res);
27
+ }
28
+ catch (error) {
29
+ const msg = error instanceof Error ? error.message : String(error);
30
+ onError(tagToken ?? token, 'TAG_RESOLVE_FAILED', msg);
31
+ scalar = new Scalar(value);
32
+ }
33
+ scalar.range = range;
34
+ scalar.source = value;
35
+ if (type)
36
+ scalar.type = type;
37
+ if (tagName)
38
+ scalar.tag = tagName;
39
+ if (tag.format)
40
+ scalar.format = tag.format;
41
+ if (comment)
42
+ scalar.comment = comment;
43
+ return scalar;
44
+ }
45
+ function findScalarTagByName(schema, value, tagName, tagToken, onError) {
46
+ if (tagName === '!')
47
+ return schema[SCALAR]; // non-specific tag
48
+ const matchWithTest = [];
49
+ for (const tag of schema.tags) {
50
+ if (!tag.collection && tag.tag === tagName) {
51
+ if (tag.default && tag.test)
52
+ matchWithTest.push(tag);
53
+ else
54
+ return tag;
55
+ }
56
+ }
57
+ for (const tag of matchWithTest)
58
+ if (tag.test?.test(value))
59
+ return tag;
60
+ const kt = schema.knownTags[tagName];
61
+ if (kt && !kt.collection) {
62
+ // Ensure that the known tag is available for stringifying,
63
+ // but does not get used by default.
64
+ schema.tags.push(Object.assign({}, kt, { default: false, test: undefined }));
65
+ return kt;
66
+ }
67
+ onError(tagToken, 'TAG_RESOLVE_FAILED', `Unresolved tag: ${tagName}`, tagName !== 'tag:yaml.org,2002:str');
68
+ return schema[SCALAR];
69
+ }
70
+ function findScalarTagByTest({ atKey, directives, schema }, value, token, onError) {
71
+ const tag = schema.tags.find(tag => (tag.default === true || (atKey && tag.default === 'key')) &&
72
+ tag.test?.test(value)) || schema[SCALAR];
73
+ if (schema.compat) {
74
+ const compat = schema.compat.find(tag => tag.default && tag.test?.test(value)) ??
75
+ schema[SCALAR];
76
+ if (tag.tag !== compat.tag) {
77
+ const ts = directives.tagString(tag.tag);
78
+ const cs = directives.tagString(compat.tag);
79
+ const msg = `Value may be parsed as either ${ts} or ${cs}`;
80
+ onError(token, 'TAG_RESOLVE_FAILED', msg, true);
81
+ }
82
+ }
83
+ return tag;
84
+ }
85
+
86
+ export { composeScalar };