gcf-aif-ext 0.2.0

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 (294) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +41 -0
  3. package/commands/gcf.js +173 -0
  4. package/extension.json +24 -0
  5. package/hooks/pre-commit.js +91 -0
  6. package/injections/commit-status.md +6 -0
  7. package/injections/plan-context.md +8 -0
  8. package/injections/review-pillars.md +7 -0
  9. package/lib/anchors.js +109 -0
  10. package/lib/audit-core.js +102 -0
  11. package/lib/context.js +77 -0
  12. package/lib/frontmatter.js +26 -0
  13. package/lib/gcf-paths.js +60 -0
  14. package/lib/git.js +19 -0
  15. package/lib/id.js +42 -0
  16. package/lib/index-gen.js +51 -0
  17. package/lib/linter.js +61 -0
  18. package/lib/playtest-list.js +13 -0
  19. package/lib/safe-path.js +71 -0
  20. package/lib/transitions.js +30 -0
  21. package/lib/validate-card.js +48 -0
  22. package/lib/verdict-fs.js +126 -0
  23. package/node_modules/cnlp-kit/CHANGELOG.md +625 -0
  24. package/node_modules/cnlp-kit/LICENSE +21 -0
  25. package/node_modules/cnlp-kit/README.md +242 -0
  26. package/node_modules/cnlp-kit/bin/cnlp.js +334 -0
  27. package/node_modules/cnlp-kit/cnlp-format.md +470 -0
  28. package/node_modules/cnlp-kit/package.json +40 -0
  29. package/node_modules/cnlp-kit/profiles/adr.md +129 -0
  30. package/node_modules/cnlp-kit/profiles/api.md +87 -0
  31. package/node_modules/cnlp-kit/profiles/concept.md +70 -0
  32. package/node_modules/cnlp-kit/profiles/docset.md +103 -0
  33. package/node_modules/cnlp-kit/profiles/guide.md +51 -0
  34. package/node_modules/cnlp-kit/profiles/profile.md +69 -0
  35. package/node_modules/cnlp-kit/profiles/reference.md +61 -0
  36. package/node_modules/cnlp-kit/profiles/skill.md +75 -0
  37. package/node_modules/cnlp-kit/profiles/task.md +65 -0
  38. package/node_modules/cnlp-kit/quality-rules.md +69 -0
  39. package/node_modules/cnlp-kit/skills/cnlp-docset/SKILL.md +73 -0
  40. package/node_modules/cnlp-kit/skills/cnlp-migrate/SKILL.md +64 -0
  41. package/node_modules/cnlp-kit/src/cnlp.js +534 -0
  42. package/node_modules/cnlp-kit/src/config.js +352 -0
  43. package/node_modules/yaml/LICENSE +13 -0
  44. package/node_modules/yaml/README.md +172 -0
  45. package/node_modules/yaml/bin.mjs +11 -0
  46. package/node_modules/yaml/browser/dist/compose/compose-collection.js +88 -0
  47. package/node_modules/yaml/browser/dist/compose/compose-doc.js +43 -0
  48. package/node_modules/yaml/browser/dist/compose/compose-node.js +109 -0
  49. package/node_modules/yaml/browser/dist/compose/compose-scalar.js +86 -0
  50. package/node_modules/yaml/browser/dist/compose/composer.js +219 -0
  51. package/node_modules/yaml/browser/dist/compose/resolve-block-map.js +115 -0
  52. package/node_modules/yaml/browser/dist/compose/resolve-block-scalar.js +198 -0
  53. package/node_modules/yaml/browser/dist/compose/resolve-block-seq.js +49 -0
  54. package/node_modules/yaml/browser/dist/compose/resolve-end.js +37 -0
  55. package/node_modules/yaml/browser/dist/compose/resolve-flow-collection.js +207 -0
  56. package/node_modules/yaml/browser/dist/compose/resolve-flow-scalar.js +226 -0
  57. package/node_modules/yaml/browser/dist/compose/resolve-props.js +146 -0
  58. package/node_modules/yaml/browser/dist/compose/util-contains-newline.js +34 -0
  59. package/node_modules/yaml/browser/dist/compose/util-empty-scalar-position.js +26 -0
  60. package/node_modules/yaml/browser/dist/compose/util-flow-indent-check.js +15 -0
  61. package/node_modules/yaml/browser/dist/compose/util-map-includes.js +13 -0
  62. package/node_modules/yaml/browser/dist/doc/Document.js +335 -0
  63. package/node_modules/yaml/browser/dist/doc/anchors.js +71 -0
  64. package/node_modules/yaml/browser/dist/doc/applyReviver.js +55 -0
  65. package/node_modules/yaml/browser/dist/doc/createNode.js +88 -0
  66. package/node_modules/yaml/browser/dist/doc/directives.js +176 -0
  67. package/node_modules/yaml/browser/dist/errors.js +57 -0
  68. package/node_modules/yaml/browser/dist/index.js +17 -0
  69. package/node_modules/yaml/browser/dist/log.js +11 -0
  70. package/node_modules/yaml/browser/dist/nodes/Alias.js +118 -0
  71. package/node_modules/yaml/browser/dist/nodes/Collection.js +147 -0
  72. package/node_modules/yaml/browser/dist/nodes/Node.js +38 -0
  73. package/node_modules/yaml/browser/dist/nodes/Pair.js +36 -0
  74. package/node_modules/yaml/browser/dist/nodes/Scalar.js +24 -0
  75. package/node_modules/yaml/browser/dist/nodes/YAMLMap.js +144 -0
  76. package/node_modules/yaml/browser/dist/nodes/YAMLSeq.js +113 -0
  77. package/node_modules/yaml/browser/dist/nodes/addPairToJSMap.js +63 -0
  78. package/node_modules/yaml/browser/dist/nodes/identity.js +36 -0
  79. package/node_modules/yaml/browser/dist/nodes/toJS.js +37 -0
  80. package/node_modules/yaml/browser/dist/parse/cst-scalar.js +214 -0
  81. package/node_modules/yaml/browser/dist/parse/cst-stringify.js +61 -0
  82. package/node_modules/yaml/browser/dist/parse/cst-visit.js +97 -0
  83. package/node_modules/yaml/browser/dist/parse/cst.js +98 -0
  84. package/node_modules/yaml/browser/dist/parse/lexer.js +721 -0
  85. package/node_modules/yaml/browser/dist/parse/line-counter.js +39 -0
  86. package/node_modules/yaml/browser/dist/parse/parser.js +975 -0
  87. package/node_modules/yaml/browser/dist/public-api.js +102 -0
  88. package/node_modules/yaml/browser/dist/schema/Schema.js +37 -0
  89. package/node_modules/yaml/browser/dist/schema/common/map.js +17 -0
  90. package/node_modules/yaml/browser/dist/schema/common/null.js +15 -0
  91. package/node_modules/yaml/browser/dist/schema/common/seq.js +17 -0
  92. package/node_modules/yaml/browser/dist/schema/common/string.js +14 -0
  93. package/node_modules/yaml/browser/dist/schema/core/bool.js +19 -0
  94. package/node_modules/yaml/browser/dist/schema/core/float.js +43 -0
  95. package/node_modules/yaml/browser/dist/schema/core/int.js +38 -0
  96. package/node_modules/yaml/browser/dist/schema/core/schema.js +23 -0
  97. package/node_modules/yaml/browser/dist/schema/json/schema.js +62 -0
  98. package/node_modules/yaml/browser/dist/schema/tags.js +96 -0
  99. package/node_modules/yaml/browser/dist/schema/yaml-1.1/binary.js +58 -0
  100. package/node_modules/yaml/browser/dist/schema/yaml-1.1/bool.js +26 -0
  101. package/node_modules/yaml/browser/dist/schema/yaml-1.1/float.js +46 -0
  102. package/node_modules/yaml/browser/dist/schema/yaml-1.1/int.js +71 -0
  103. package/node_modules/yaml/browser/dist/schema/yaml-1.1/merge.js +67 -0
  104. package/node_modules/yaml/browser/dist/schema/yaml-1.1/omap.js +74 -0
  105. package/node_modules/yaml/browser/dist/schema/yaml-1.1/pairs.js +78 -0
  106. package/node_modules/yaml/browser/dist/schema/yaml-1.1/schema.js +39 -0
  107. package/node_modules/yaml/browser/dist/schema/yaml-1.1/set.js +93 -0
  108. package/node_modules/yaml/browser/dist/schema/yaml-1.1/timestamp.js +101 -0
  109. package/node_modules/yaml/browser/dist/stringify/foldFlowLines.js +146 -0
  110. package/node_modules/yaml/browser/dist/stringify/stringify.js +129 -0
  111. package/node_modules/yaml/browser/dist/stringify/stringifyCollection.js +153 -0
  112. package/node_modules/yaml/browser/dist/stringify/stringifyComment.js +20 -0
  113. package/node_modules/yaml/browser/dist/stringify/stringifyDocument.js +85 -0
  114. package/node_modules/yaml/browser/dist/stringify/stringifyNumber.js +25 -0
  115. package/node_modules/yaml/browser/dist/stringify/stringifyPair.js +150 -0
  116. package/node_modules/yaml/browser/dist/stringify/stringifyString.js +336 -0
  117. package/node_modules/yaml/browser/dist/util.js +11 -0
  118. package/node_modules/yaml/browser/dist/visit.js +233 -0
  119. package/node_modules/yaml/browser/index.js +5 -0
  120. package/node_modules/yaml/browser/package.json +3 -0
  121. package/node_modules/yaml/dist/cli.d.ts +8 -0
  122. package/node_modules/yaml/dist/cli.mjs +201 -0
  123. package/node_modules/yaml/dist/compose/compose-collection.d.ts +11 -0
  124. package/node_modules/yaml/dist/compose/compose-collection.js +90 -0
  125. package/node_modules/yaml/dist/compose/compose-doc.d.ts +7 -0
  126. package/node_modules/yaml/dist/compose/compose-doc.js +45 -0
  127. package/node_modules/yaml/dist/compose/compose-node.d.ts +29 -0
  128. package/node_modules/yaml/dist/compose/compose-node.js +112 -0
  129. package/node_modules/yaml/dist/compose/compose-scalar.d.ts +5 -0
  130. package/node_modules/yaml/dist/compose/compose-scalar.js +88 -0
  131. package/node_modules/yaml/dist/compose/composer.d.ts +63 -0
  132. package/node_modules/yaml/dist/compose/composer.js +224 -0
  133. package/node_modules/yaml/dist/compose/resolve-block-map.d.ts +6 -0
  134. package/node_modules/yaml/dist/compose/resolve-block-map.js +117 -0
  135. package/node_modules/yaml/dist/compose/resolve-block-scalar.d.ts +11 -0
  136. package/node_modules/yaml/dist/compose/resolve-block-scalar.js +200 -0
  137. package/node_modules/yaml/dist/compose/resolve-block-seq.d.ts +6 -0
  138. package/node_modules/yaml/dist/compose/resolve-block-seq.js +51 -0
  139. package/node_modules/yaml/dist/compose/resolve-end.d.ts +6 -0
  140. package/node_modules/yaml/dist/compose/resolve-end.js +39 -0
  141. package/node_modules/yaml/dist/compose/resolve-flow-collection.d.ts +7 -0
  142. package/node_modules/yaml/dist/compose/resolve-flow-collection.js +209 -0
  143. package/node_modules/yaml/dist/compose/resolve-flow-scalar.d.ts +10 -0
  144. package/node_modules/yaml/dist/compose/resolve-flow-scalar.js +228 -0
  145. package/node_modules/yaml/dist/compose/resolve-props.d.ts +23 -0
  146. package/node_modules/yaml/dist/compose/resolve-props.js +148 -0
  147. package/node_modules/yaml/dist/compose/util-contains-newline.d.ts +2 -0
  148. package/node_modules/yaml/dist/compose/util-contains-newline.js +36 -0
  149. package/node_modules/yaml/dist/compose/util-empty-scalar-position.d.ts +2 -0
  150. package/node_modules/yaml/dist/compose/util-empty-scalar-position.js +28 -0
  151. package/node_modules/yaml/dist/compose/util-flow-indent-check.d.ts +3 -0
  152. package/node_modules/yaml/dist/compose/util-flow-indent-check.js +17 -0
  153. package/node_modules/yaml/dist/compose/util-map-includes.d.ts +4 -0
  154. package/node_modules/yaml/dist/compose/util-map-includes.js +15 -0
  155. package/node_modules/yaml/dist/doc/Document.d.ts +141 -0
  156. package/node_modules/yaml/dist/doc/Document.js +337 -0
  157. package/node_modules/yaml/dist/doc/anchors.d.ts +24 -0
  158. package/node_modules/yaml/dist/doc/anchors.js +76 -0
  159. package/node_modules/yaml/dist/doc/applyReviver.d.ts +9 -0
  160. package/node_modules/yaml/dist/doc/applyReviver.js +57 -0
  161. package/node_modules/yaml/dist/doc/createNode.d.ts +17 -0
  162. package/node_modules/yaml/dist/doc/createNode.js +90 -0
  163. package/node_modules/yaml/dist/doc/directives.d.ts +49 -0
  164. package/node_modules/yaml/dist/doc/directives.js +178 -0
  165. package/node_modules/yaml/dist/errors.d.ts +21 -0
  166. package/node_modules/yaml/dist/errors.js +62 -0
  167. package/node_modules/yaml/dist/index.d.ts +25 -0
  168. package/node_modules/yaml/dist/index.js +50 -0
  169. package/node_modules/yaml/dist/log.d.ts +3 -0
  170. package/node_modules/yaml/dist/log.js +19 -0
  171. package/node_modules/yaml/dist/nodes/Alias.d.ts +29 -0
  172. package/node_modules/yaml/dist/nodes/Alias.js +120 -0
  173. package/node_modules/yaml/dist/nodes/Collection.d.ts +73 -0
  174. package/node_modules/yaml/dist/nodes/Collection.js +151 -0
  175. package/node_modules/yaml/dist/nodes/Node.d.ts +53 -0
  176. package/node_modules/yaml/dist/nodes/Node.js +40 -0
  177. package/node_modules/yaml/dist/nodes/Pair.d.ts +22 -0
  178. package/node_modules/yaml/dist/nodes/Pair.js +39 -0
  179. package/node_modules/yaml/dist/nodes/Scalar.d.ts +47 -0
  180. package/node_modules/yaml/dist/nodes/Scalar.js +27 -0
  181. package/node_modules/yaml/dist/nodes/YAMLMap.d.ts +53 -0
  182. package/node_modules/yaml/dist/nodes/YAMLMap.js +147 -0
  183. package/node_modules/yaml/dist/nodes/YAMLSeq.d.ts +60 -0
  184. package/node_modules/yaml/dist/nodes/YAMLSeq.js +115 -0
  185. package/node_modules/yaml/dist/nodes/addPairToJSMap.d.ts +4 -0
  186. package/node_modules/yaml/dist/nodes/addPairToJSMap.js +65 -0
  187. package/node_modules/yaml/dist/nodes/identity.d.ts +23 -0
  188. package/node_modules/yaml/dist/nodes/identity.js +53 -0
  189. package/node_modules/yaml/dist/nodes/toJS.d.ts +29 -0
  190. package/node_modules/yaml/dist/nodes/toJS.js +39 -0
  191. package/node_modules/yaml/dist/options.d.ts +350 -0
  192. package/node_modules/yaml/dist/parse/cst-scalar.d.ts +64 -0
  193. package/node_modules/yaml/dist/parse/cst-scalar.js +218 -0
  194. package/node_modules/yaml/dist/parse/cst-stringify.d.ts +8 -0
  195. package/node_modules/yaml/dist/parse/cst-stringify.js +63 -0
  196. package/node_modules/yaml/dist/parse/cst-visit.d.ts +39 -0
  197. package/node_modules/yaml/dist/parse/cst-visit.js +99 -0
  198. package/node_modules/yaml/dist/parse/cst.d.ts +109 -0
  199. package/node_modules/yaml/dist/parse/cst.js +112 -0
  200. package/node_modules/yaml/dist/parse/lexer.d.ts +87 -0
  201. package/node_modules/yaml/dist/parse/lexer.js +723 -0
  202. package/node_modules/yaml/dist/parse/line-counter.d.ts +22 -0
  203. package/node_modules/yaml/dist/parse/line-counter.js +41 -0
  204. package/node_modules/yaml/dist/parse/parser.d.ts +84 -0
  205. package/node_modules/yaml/dist/parse/parser.js +980 -0
  206. package/node_modules/yaml/dist/public-api.d.ts +44 -0
  207. package/node_modules/yaml/dist/public-api.js +107 -0
  208. package/node_modules/yaml/dist/schema/Schema.d.ts +17 -0
  209. package/node_modules/yaml/dist/schema/Schema.js +39 -0
  210. package/node_modules/yaml/dist/schema/common/map.d.ts +2 -0
  211. package/node_modules/yaml/dist/schema/common/map.js +19 -0
  212. package/node_modules/yaml/dist/schema/common/null.d.ts +4 -0
  213. package/node_modules/yaml/dist/schema/common/null.js +17 -0
  214. package/node_modules/yaml/dist/schema/common/seq.d.ts +2 -0
  215. package/node_modules/yaml/dist/schema/common/seq.js +19 -0
  216. package/node_modules/yaml/dist/schema/common/string.d.ts +2 -0
  217. package/node_modules/yaml/dist/schema/common/string.js +16 -0
  218. package/node_modules/yaml/dist/schema/core/bool.d.ts +4 -0
  219. package/node_modules/yaml/dist/schema/core/bool.js +21 -0
  220. package/node_modules/yaml/dist/schema/core/float.d.ts +4 -0
  221. package/node_modules/yaml/dist/schema/core/float.js +47 -0
  222. package/node_modules/yaml/dist/schema/core/int.d.ts +4 -0
  223. package/node_modules/yaml/dist/schema/core/int.js +42 -0
  224. package/node_modules/yaml/dist/schema/core/schema.d.ts +1 -0
  225. package/node_modules/yaml/dist/schema/core/schema.js +25 -0
  226. package/node_modules/yaml/dist/schema/json/schema.d.ts +2 -0
  227. package/node_modules/yaml/dist/schema/json/schema.js +64 -0
  228. package/node_modules/yaml/dist/schema/json-schema.d.ts +69 -0
  229. package/node_modules/yaml/dist/schema/tags.d.ts +48 -0
  230. package/node_modules/yaml/dist/schema/tags.js +99 -0
  231. package/node_modules/yaml/dist/schema/types.d.ts +92 -0
  232. package/node_modules/yaml/dist/schema/yaml-1.1/binary.d.ts +2 -0
  233. package/node_modules/yaml/dist/schema/yaml-1.1/binary.js +70 -0
  234. package/node_modules/yaml/dist/schema/yaml-1.1/bool.d.ts +7 -0
  235. package/node_modules/yaml/dist/schema/yaml-1.1/bool.js +29 -0
  236. package/node_modules/yaml/dist/schema/yaml-1.1/float.d.ts +4 -0
  237. package/node_modules/yaml/dist/schema/yaml-1.1/float.js +50 -0
  238. package/node_modules/yaml/dist/schema/yaml-1.1/int.d.ts +5 -0
  239. package/node_modules/yaml/dist/schema/yaml-1.1/int.js +76 -0
  240. package/node_modules/yaml/dist/schema/yaml-1.1/merge.d.ts +9 -0
  241. package/node_modules/yaml/dist/schema/yaml-1.1/merge.js +71 -0
  242. package/node_modules/yaml/dist/schema/yaml-1.1/omap.d.ts +22 -0
  243. package/node_modules/yaml/dist/schema/yaml-1.1/omap.js +77 -0
  244. package/node_modules/yaml/dist/schema/yaml-1.1/pairs.d.ts +10 -0
  245. package/node_modules/yaml/dist/schema/yaml-1.1/pairs.js +82 -0
  246. package/node_modules/yaml/dist/schema/yaml-1.1/schema.d.ts +1 -0
  247. package/node_modules/yaml/dist/schema/yaml-1.1/schema.js +41 -0
  248. package/node_modules/yaml/dist/schema/yaml-1.1/set.d.ts +28 -0
  249. package/node_modules/yaml/dist/schema/yaml-1.1/set.js +96 -0
  250. package/node_modules/yaml/dist/schema/yaml-1.1/timestamp.d.ts +6 -0
  251. package/node_modules/yaml/dist/schema/yaml-1.1/timestamp.js +105 -0
  252. package/node_modules/yaml/dist/stringify/foldFlowLines.d.ts +34 -0
  253. package/node_modules/yaml/dist/stringify/foldFlowLines.js +151 -0
  254. package/node_modules/yaml/dist/stringify/stringify.d.ts +21 -0
  255. package/node_modules/yaml/dist/stringify/stringify.js +132 -0
  256. package/node_modules/yaml/dist/stringify/stringifyCollection.d.ts +17 -0
  257. package/node_modules/yaml/dist/stringify/stringifyCollection.js +155 -0
  258. package/node_modules/yaml/dist/stringify/stringifyComment.d.ts +10 -0
  259. package/node_modules/yaml/dist/stringify/stringifyComment.js +24 -0
  260. package/node_modules/yaml/dist/stringify/stringifyDocument.d.ts +4 -0
  261. package/node_modules/yaml/dist/stringify/stringifyDocument.js +87 -0
  262. package/node_modules/yaml/dist/stringify/stringifyNumber.d.ts +2 -0
  263. package/node_modules/yaml/dist/stringify/stringifyNumber.js +27 -0
  264. package/node_modules/yaml/dist/stringify/stringifyPair.d.ts +3 -0
  265. package/node_modules/yaml/dist/stringify/stringifyPair.js +152 -0
  266. package/node_modules/yaml/dist/stringify/stringifyString.d.ts +9 -0
  267. package/node_modules/yaml/dist/stringify/stringifyString.js +338 -0
  268. package/node_modules/yaml/dist/test-events.d.ts +4 -0
  269. package/node_modules/yaml/dist/test-events.js +134 -0
  270. package/node_modules/yaml/dist/util.d.ts +16 -0
  271. package/node_modules/yaml/dist/util.js +28 -0
  272. package/node_modules/yaml/dist/visit.d.ts +102 -0
  273. package/node_modules/yaml/dist/visit.js +236 -0
  274. package/node_modules/yaml/package.json +97 -0
  275. package/node_modules/yaml/util.js +2 -0
  276. package/package.json +54 -0
  277. package/profiles/card.md +65 -0
  278. package/profiles/pillars.md +31 -0
  279. package/profiles/system.md +56 -0
  280. package/schemas/card.schema.json +30 -0
  281. package/skills/gcf-adopt/SKILL.md +41 -0
  282. package/skills/gcf-audit/SKILL.md +27 -0
  283. package/skills/gcf-card/SKILL.md +35 -0
  284. package/skills/gcf-debate/SKILL.md +33 -0
  285. package/skills/gcf-ingest/SKILL.md +38 -0
  286. package/skills/gcf-init/SKILL.md +32 -0
  287. package/skills/gcf-verdict/SKILL.md +32 -0
  288. package/skills/gcf-vision/SKILL.md +33 -0
  289. package/templates/PILLARS.md +8 -0
  290. package/templates/backlog.md +4 -0
  291. package/templates/card.md +34 -0
  292. package/templates/cnlp.config.json +8 -0
  293. package/templates/config.yml +8 -0
  294. package/templates/system.md +22 -0
@@ -0,0 +1,352 @@
1
+ // `cnlp.config.json` — the one file a project owns to say which profile applies to which
2
+ // files. It exists so that adopting the format never means editing a file the package ships:
3
+ // the corpus used to be constants at the top of a test, which put every project's own values
4
+ // inside a file the next upgrade overwrote.
5
+
6
+ import { existsSync } from 'node:fs';
7
+ import { glob, readdir, readFile } from 'node:fs/promises';
8
+ import path from 'node:path';
9
+ import { bodyIssues, loadProfileAt, pageRefs, resolveDoc } from './cnlp.js';
10
+
11
+ export const CONFIG_NAME = 'cnlp.config.json';
12
+
13
+ /** Nearest `cnlp.config.json` at or above a directory, or null. */
14
+ export function findConfig(from = process.cwd()) {
15
+ let dir = path.resolve(from);
16
+ for (;;) {
17
+ const at = path.join(dir, CONFIG_NAME);
18
+ if (existsSync(at)) return at;
19
+ const up = path.dirname(dir);
20
+ if (up === dir) return null;
21
+ dir = up;
22
+ }
23
+ }
24
+
25
+ /**
26
+ * Read and validate a config. Every failure names the fix: a config that is silently empty
27
+ * reports a clean run over nothing, which is worse than no check at all.
28
+ */
29
+ export async function readConfig(configPath) {
30
+ const abs = path.resolve(configPath);
31
+ let cfg;
32
+ try {
33
+ cfg = JSON.parse(await readFile(abs, 'utf8'));
34
+ } catch (e) {
35
+ throw new Error(`${abs}: ${e.message}`);
36
+ }
37
+ if (!Array.isArray(cfg.corpus) || cfg.corpus.length === 0) {
38
+ throw new Error(`${abs}: "corpus" is empty — name at least 1 entry of { "profile": …, "glob": … }`);
39
+ }
40
+ for (const entry of cfg.corpus) {
41
+ if (!entry?.profile || !entry?.glob) {
42
+ throw new Error(`${abs}: every corpus entry carries "profile" and "glob", found ${JSON.stringify(entry)}`);
43
+ }
44
+ }
45
+ const root = path.dirname(abs);
46
+ const profilesDir = cfg.profiles ? path.resolve(root, cfg.profiles) : null;
47
+ if (profilesDir && !existsSync(profilesDir)) {
48
+ throw new Error(`${abs}: "profiles" names ${JSON.stringify(cfg.profiles)}, which does not exist under ${root}`);
49
+ }
50
+ // §9: a project with no "docsets" key has no document set, and the reference rules do not apply
51
+ // to it. A key naming nothing would instead report a clean run over a corpus it never read.
52
+ const docsets = cfg.docsets ? String(cfg.docsets).replace(/\/+$/, '') : null;
53
+ if (docsets && !existsSync(path.resolve(root, docsets))) {
54
+ throw new Error(`${abs}: "docsets" names ${JSON.stringify(cfg.docsets)}, which does not exist under ${root}`);
55
+ }
56
+ // `agents` records what `cnlp init` last installed for, so a run with no terminal to ask in
57
+ // repeats that choice instead of guessing. A project that never ran `init` carries none.
58
+ if (cfg.agents !== undefined && !Array.isArray(cfg.agents)) {
59
+ throw new Error(`${abs}: "agents" is a list of agent names, found ${JSON.stringify(cfg.agents)}`);
60
+ }
61
+ return { path: abs, root, profilesDir, docsets, corpus: cfg.corpus, agents: cfg.agents ?? [] };
62
+ }
63
+
64
+ /**
65
+ * §9 page id of a project-relative path, or null when the path sits outside the docsets root.
66
+ * `examples/dragonecs/api/query.md` under a root of `examples` is `dragonecs:api/query`; a file
67
+ * directly under the root belongs to no set, so it has no id.
68
+ */
69
+ export function pageIdOf(rel, docsets) {
70
+ const prefix = `${docsets}/`;
71
+ const at = rel.split(path.sep).join('/');
72
+ if (!at.startsWith(prefix) || !at.endsWith('.md')) return null;
73
+ const rest = at.slice(prefix.length, -3);
74
+ const cut = rest.indexOf('/');
75
+ if (cut < 0) return null;
76
+ return { docset: rest.slice(0, cut), page: rest.slice(cut + 1) };
77
+ }
78
+
79
+ /**
80
+ * Every document set under the docsets root, each with its index path and the sets its index names
81
+ * in `companions:`. A set is active because it is present: a project vendors the sets it uses, so
82
+ * presence is the declaration and no second config key can disagree with the files on disk.
83
+ */
84
+ export async function docsetsOf(config) {
85
+ if (!config.docsets) {
86
+ throw new Error(`${config.path}: no "docsets" key — add one naming the directory whose subdirectories are 1 document set each`);
87
+ }
88
+ const found = new Map();
89
+ for await (const rel of glob(`${config.docsets}/*/index.md`, { cwd: config.root })) {
90
+ const id = pageIdOf(rel.split(path.sep).join('/'), config.docsets);
91
+ if (id) found.set(id.docset, { name: id.docset, index: rel });
92
+ }
93
+ for (const set of found.values()) {
94
+ const raw = await readFile(path.join(config.root, set.index), 'utf8');
95
+ set.raw = raw;
96
+ // `companions:` runs both ways — 2 packages name each other — so it fixes no order. `overrides:`
97
+ // does: a set correcting a page of another is read after the set it corrects, or the correction
98
+ // arrives for a page the reader has not seen yet.
99
+ set.overrides = [...new Set(pageRefs(raw)
100
+ .filter((r) => r.block === 'overrides' && r.key === 'page' && r.target.includes(':'))
101
+ .map((r) => r.target.slice(0, r.target.indexOf(':'))))];
102
+ }
103
+ return found;
104
+ }
105
+
106
+ /**
107
+ * The reading order for `cnlp docs`: every set a given set overrides comes before it. A cycle would
108
+ * mean 2 sets correcting each other, which has no reading order to give, so a set already on the
109
+ * path is left where it is rather than followed again.
110
+ */
111
+ export function readingOrder(sets) {
112
+ const out = [];
113
+ const seen = new Set();
114
+ const visit = (name, guard) => {
115
+ if (seen.has(name) || guard.has(name)) return;
116
+ guard.add(name);
117
+ const set = sets.get(name);
118
+ if (!set) return;
119
+ for (const next of set.overrides) visit(next, guard);
120
+ seen.add(name);
121
+ out.push(set);
122
+ };
123
+ for (const name of [...sets.keys()].sort()) visit(name, new Set());
124
+ return out;
125
+ }
126
+
127
+ /**
128
+ * §9 reference conformance across a corpus, which is the 1 check no single document can make.
129
+ * `docs` is every file already read, so this adds no read of its own.
130
+ */
131
+ export function linkIssues(docs, docsets) {
132
+ const pages = new Map();
133
+ const sets = new Set();
134
+ for (const { rel } of docs) {
135
+ const id = pageIdOf(rel, docsets);
136
+ if (!id) continue;
137
+ pages.set(`${id.docset}:${id.page}`, rel);
138
+ sets.add(id.docset);
139
+ }
140
+
141
+ const issues = [];
142
+ const reached = new Set();
143
+ for (const { rel, raw } of docs) {
144
+ const from = pageIdOf(rel, docsets);
145
+ if (!from) continue;
146
+ const self = `${from.docset}:${from.page}`;
147
+ for (const ref of pageRefs(raw)) {
148
+ if (ref.key === 'docset') {
149
+ if (!sets.has(ref.target)) {
150
+ issues.push({ file: rel, line: ref.line, message: `"${ref.target}" names no document set under ${docsets}/` });
151
+ }
152
+ continue;
153
+ }
154
+ const qualified = ref.target.includes(':') ? ref.target : `${from.docset}:${ref.target}`;
155
+ // §9: a "by:" value is local, so it carries no prefix at all — its own set's name there is a
156
+ // copy of what the file path already says, and another set's name is the defect this caught.
157
+ if (ref.key === 'by' && ref.target.includes(':')) {
158
+ issues.push({ file: rel, line: ref.line, message: `"by: ${ref.target}" carries a document set prefix — a "by:" value names a page of this set` });
159
+ }
160
+ if (!pages.has(qualified)) {
161
+ issues.push({ file: rel, line: ref.line, message: `page "${qualified}" does not resolve to a file under ${docsets}/` });
162
+ } else if (qualified !== self) {
163
+ reached.add(qualified);
164
+ }
165
+ }
166
+ }
167
+
168
+ // A page nothing reaches is a page nobody reads, so it goes stale with nobody watching. An
169
+ // index is the entry point of its set and is reached from outside the corpus, so it is exempt.
170
+ for (const [id, rel] of pages) {
171
+ if (!id.endsWith(':index') && !reached.has(id)) {
172
+ issues.push({ file: rel, line: 0, message: `no page references "${id}" — a page nothing reaches is a page nobody reads` });
173
+ }
174
+ }
175
+ return issues.sort((a, b) => (a.file === b.file ? a.line - b.line : a.file.localeCompare(b.file)));
176
+ }
177
+
178
+ // The agent runtimes a skill can be installed for, each with the directory it reads skills from.
179
+ // A runtime is 1 record here and no branch anywhere else.
180
+ export const AGENTS = [
181
+ { value: 'claude-code', label: 'Claude Code', base: '.claude' },
182
+ // Codex reads ".codex" implicitly, and ".agents" is the documented project-local location.
183
+ { value: 'codex', label: 'Codex', base: '.agents' },
184
+ ];
185
+
186
+ /** Where an agent reads its skills from, under a project root. */
187
+ export function skillsDirFor(root, agent) {
188
+ const known = AGENTS.find((a) => a.value === agent);
189
+ if (!known) throw new Error(`unknown agent ${JSON.stringify(agent)} — this kit knows ${AGENTS.map((a) => a.value).join(', ')}`);
190
+ return path.join(root, known.base, 'skills');
191
+ }
192
+
193
+ // The version of the skills an agent holds. A sidecar file and never frontmatter: `profiles/skill.md`
194
+ // declares the 2 fields a SKILL.md carries, so a version added there fails the check of any project
195
+ // whose corpus globs its own skills.
196
+ export const STAMP_NAME = '.cnlp-version';
197
+
198
+ /**
199
+ * The agents whose installed skills came from another version of this package, each with the
200
+ * version its stamp holds. A missing stamp reads as an install predating stamps, which wants the
201
+ * same answer — 1 `cnlp init` — so it reports as unknown rather than staying silent.
202
+ */
203
+ export async function skillDrift(root, agents, version) {
204
+ const out = [];
205
+ for (const agent of agents ?? []) {
206
+ let dir;
207
+ try {
208
+ dir = skillsDirFor(root, agent);
209
+ } catch {
210
+ continue; // an agent this version does not know: the config outlived a rename
211
+ }
212
+ if (!existsSync(dir)) continue;
213
+ const stamp = path.join(dir, STAMP_NAME);
214
+ const held = existsSync(stamp) ? (await readFile(stamp, 'utf8')).trim() : null;
215
+ if (held !== version) out.push({ agent, dir, held });
216
+ }
217
+ return out;
218
+ }
219
+
220
+ // The layouts a corpus entry is usually written for. `cnlp init` keeps the ones that match a file,
221
+ // so a project adopting the format starts from its own layout rather than from an example of one.
222
+ // ponytail: path convention only, never content — a decision record filed under docs/references
223
+ // reads as a reference here, and only a human opening it can say otherwise.
224
+ /**
225
+ * The 4 entries of 1 document set, against the path its pages sit under. `base` carries whatever
226
+ * wildcard the caller wants — `docs/docsets/*` for every set of a project, `out/nanoid` for the 1
227
+ * set a path names — so the shape of a set is written here and nowhere else.
228
+ */
229
+ export const docsetCorpus = (base) => [
230
+ { profile: 'docset', glob: `${base}/index.md` },
231
+ { profile: 'concept', glob: `${base}/concepts/*.md` },
232
+ { profile: 'api', glob: `${base}/api/*.md` },
233
+ { profile: 'task', glob: `${base}/tasks/*.md` },
234
+ ];
235
+
236
+ const CANDIDATES = [
237
+ { profile: 'guide', glob: 'AGENTS.md' },
238
+ { profile: 'guide', glob: 'CLAUDE.md' },
239
+ // No agent's skills directory here: `cnlp init` writes this kit's own skills into those, and a
240
+ // corpus entry over them makes a project check files it does not own against its own profile.
241
+ { profile: 'skill', glob: 'skills/*/SKILL.md' },
242
+ { profile: 'adr', glob: 'docs/adr/*.md' },
243
+ { profile: 'adr', glob: 'docs/decisions/*.md' },
244
+ { profile: 'reference', glob: 'docs/references/*.md' },
245
+ ...docsetCorpus('docs/docsets/*'),
246
+ ];
247
+
248
+ /**
249
+ * The corpus entries a directory's own layout supports, each with the count of files it matches.
250
+ * An entry matching nothing is left out: `checkProject` refuses a glob that matches no file, so a
251
+ * proposed entry no file answers would hand the project a config that fails on its first run.
252
+ */
253
+ export async function proposeCorpus(root) {
254
+ const out = [];
255
+ for (const entry of CANDIDATES) {
256
+ const files = await filesFor(entry, root);
257
+ if (files.length) out.push({ ...entry, files: files.length });
258
+ }
259
+ return out;
260
+ }
261
+
262
+ /**
263
+ * A config for a directory, synthesized rather than read, so a document set that belongs to nobody
264
+ * can still be checked. A produced set is a folder of markdown handed to whoever asked for it: it
265
+ * carries no `cnlp.config.json`, and `readConfig` takes the root from the directory a config sits
266
+ * in, so a config kept outside the tree it describes cannot name it.
267
+ *
268
+ * `<dir>/index.md` present makes `<dir>` 1 set; otherwise a subdirectory holding an `index.md`
269
+ * makes `<dir>` the root of several. §9 resolves a page id against `<root>/<set>/<page>`, so the
270
+ * root sits 1 level above the directory the sets are in, and `pageIdOf` is unchanged.
271
+ *
272
+ * An entry matching no file is dropped here, which a written config is right to refuse: a glob a
273
+ * project typed and no file answers is a mistake, and a glob this function guessed is a folder the
274
+ * set does not have yet.
275
+ */
276
+ export async function configForPath(dir) {
277
+ const abs = path.resolve(dir);
278
+ if (!existsSync(abs)) throw new Error(`no such directory: ${dir}`);
279
+ let root;
280
+ let docsets = null;
281
+ let corpus;
282
+ if (existsSync(path.join(abs, 'index.md'))) {
283
+ root = path.dirname(path.dirname(abs));
284
+ docsets = path.basename(path.dirname(abs));
285
+ corpus = docsetCorpus(`${docsets}/${path.basename(abs)}`);
286
+ } else if (await holdsASet(abs)) {
287
+ root = path.dirname(abs);
288
+ docsets = path.basename(abs);
289
+ corpus = docsetCorpus(`${docsets}/*`);
290
+ } else {
291
+ // Neither shape: fall back to the layouts `cnlp init` already knows, so pointing at a project
292
+ // reads the same as pointing at a set.
293
+ root = abs;
294
+ docsets = existsSync(path.join(abs, 'docs', 'docsets')) ? 'docs/docsets' : null;
295
+ corpus = (await proposeCorpus(abs)).map(({ profile, glob: g }) => ({ profile, glob: g }));
296
+ }
297
+ const kept = [];
298
+ for (const entry of corpus) {
299
+ if ((await filesFor(entry, root)).length) kept.push(entry);
300
+ }
301
+ if (kept.length === 0) {
302
+ throw new Error(`${abs} holds no document this kit knows the layout of — a document set is an index.md beside concepts, api and tasks`);
303
+ }
304
+ return { path: null, root, profilesDir: null, docsets, corpus: kept, agents: [] };
305
+ }
306
+
307
+ /** Whether an immediate subdirectory carries an index.md, which is what makes a directory a root. */
308
+ async function holdsASet(abs) {
309
+ for (const entry of await readdir(abs, { withFileTypes: true })) {
310
+ if (entry.isDirectory() && existsSync(path.join(abs, entry.name, 'index.md'))) return true;
311
+ }
312
+ return false;
313
+ }
314
+
315
+ /** A project's own profile of that name, or the packaged one. */
316
+ export async function profileFor(name, profilesDir) {
317
+ const local = profilesDir ? path.join(profilesDir, `${name}.md`) : null;
318
+ return loadProfileAt(local && existsSync(local) ? local : resolveDoc(name));
319
+ }
320
+
321
+ /** Paths a corpus entry matches, relative to the project root, sorted. */
322
+ export async function filesFor(entry, root) {
323
+ const out = [];
324
+ for await (const f of glob(entry.glob, { cwd: root })) out.push(f);
325
+ return out.sort();
326
+ }
327
+
328
+ /**
329
+ * Run every corpus entry. Returns the files checked and the issues found, each carrying the
330
+ * project-relative path it came from. Severity is the caller's: an issue is an issue here.
331
+ */
332
+ export async function checkProject(config) {
333
+ const issues = [];
334
+ const checked = [];
335
+ const docs = [];
336
+ for (const entry of config.corpus) {
337
+ const files = await filesFor(entry, config.root);
338
+ if (files.length === 0) {
339
+ throw new Error(`corpus entry ${JSON.stringify(entry.glob)} matches no file under ${config.root}`);
340
+ }
341
+ const profile = await profileFor(entry.profile, config.profilesDir);
342
+ for (const rel of files) {
343
+ const raw = await readFile(path.join(config.root, rel), 'utf8');
344
+ checked.push(rel);
345
+ docs.push({ rel, raw });
346
+ for (const issue of bodyIssues(raw, profile)) issues.push({ file: rel, ...issue });
347
+ }
348
+ }
349
+ // §9 is the 1 rule that needs the whole corpus, so it runs once over the files already read.
350
+ if (config.docsets) issues.push(...linkIssues(docs, config.docsets));
351
+ return { checked, issues };
352
+ }
@@ -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 };