@ai-coders/context 0.4.0 → 0.5.1

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 (435) hide show
  1. package/README.md +117 -146
  2. package/dist/fragments/compose.d.ts +30 -0
  3. package/dist/fragments/compose.d.ts.map +1 -0
  4. package/dist/fragments/compose.js +274 -0
  5. package/dist/fragments/compose.js.map +1 -0
  6. package/dist/fragments/extractors/index.d.ts +26 -0
  7. package/dist/fragments/extractors/index.d.ts.map +1 -0
  8. package/dist/fragments/extractors/index.js +58 -0
  9. package/dist/fragments/extractors/index.js.map +1 -0
  10. package/dist/fragments/extractors/module.d.ts +12 -0
  11. package/dist/fragments/extractors/module.d.ts.map +1 -0
  12. package/dist/fragments/extractors/module.js +302 -0
  13. package/dist/fragments/extractors/module.js.map +1 -0
  14. package/dist/fragments/extractors/project.d.ts +12 -0
  15. package/dist/fragments/extractors/project.d.ts.map +1 -0
  16. package/dist/fragments/extractors/project.js +274 -0
  17. package/dist/fragments/extractors/project.js.map +1 -0
  18. package/dist/fragments/extractors/semantic.d.ts +12 -0
  19. package/dist/fragments/extractors/semantic.d.ts.map +1 -0
  20. package/dist/fragments/extractors/semantic.js +329 -0
  21. package/dist/fragments/extractors/semantic.js.map +1 -0
  22. package/dist/fragments/index.d.ts +47 -0
  23. package/dist/fragments/index.d.ts.map +1 -0
  24. package/dist/fragments/index.js +75 -0
  25. package/dist/fragments/index.js.map +1 -0
  26. package/dist/fragments/query.d.ts +101 -0
  27. package/dist/fragments/query.d.ts.map +1 -0
  28. package/dist/fragments/query.js +200 -0
  29. package/dist/fragments/query.js.map +1 -0
  30. package/dist/fragments/render/compact.d.ts +15 -0
  31. package/dist/fragments/render/compact.d.ts.map +1 -0
  32. package/dist/fragments/render/compact.js +209 -0
  33. package/dist/fragments/render/compact.js.map +1 -0
  34. package/dist/fragments/render/index.d.ts +17 -0
  35. package/dist/fragments/render/index.d.ts.map +1 -0
  36. package/dist/fragments/render/index.js +40 -0
  37. package/dist/fragments/render/index.js.map +1 -0
  38. package/dist/fragments/render/json.d.ts +9 -0
  39. package/dist/fragments/render/json.d.ts.map +1 -0
  40. package/dist/fragments/render/json.js +44 -0
  41. package/dist/fragments/render/json.js.map +1 -0
  42. package/dist/fragments/render/markdown.d.ts +9 -0
  43. package/dist/fragments/render/markdown.d.ts.map +1 -0
  44. package/dist/fragments/render/markdown.js +291 -0
  45. package/dist/fragments/render/markdown.js.map +1 -0
  46. package/dist/fragments/store.d.ts +49 -0
  47. package/dist/fragments/store.d.ts.map +1 -0
  48. package/dist/fragments/store.js +161 -0
  49. package/dist/fragments/store.js.map +1 -0
  50. package/dist/fragments/types.d.ts +241 -0
  51. package/dist/fragments/types.d.ts.map +1 -0
  52. package/dist/fragments/types.js +8 -0
  53. package/dist/fragments/types.js.map +1 -0
  54. package/dist/generators/agents/agentGenerator.d.ts +8 -1
  55. package/dist/generators/agents/agentGenerator.d.ts.map +1 -1
  56. package/dist/generators/agents/agentGenerator.js +108 -10
  57. package/dist/generators/agents/agentGenerator.js.map +1 -1
  58. package/dist/generators/agents/templates/playbookTemplate.d.ts +3 -2
  59. package/dist/generators/agents/templates/playbookTemplate.d.ts.map +1 -1
  60. package/dist/generators/agents/templates/playbookTemplate.js +147 -45
  61. package/dist/generators/agents/templates/playbookTemplate.js.map +1 -1
  62. package/dist/generators/agents/templates/types.d.ts +9 -1
  63. package/dist/generators/agents/templates/types.d.ts.map +1 -1
  64. package/dist/generators/documentation/documentationGenerator.d.ts +2 -0
  65. package/dist/generators/documentation/documentationGenerator.d.ts.map +1 -1
  66. package/dist/generators/documentation/documentationGenerator.js +18 -3
  67. package/dist/generators/documentation/documentationGenerator.js.map +1 -1
  68. package/dist/generators/documentation/guideRegistry.d.ts.map +1 -1
  69. package/dist/generators/documentation/guideRegistry.js +0 -8
  70. package/dist/generators/documentation/guideRegistry.js.map +1 -1
  71. package/dist/generators/documentation/templates/apiReferenceTemplate.d.ts.map +1 -1
  72. package/dist/generators/documentation/templates/apiReferenceTemplate.js +3 -22
  73. package/dist/generators/documentation/templates/apiReferenceTemplate.js.map +1 -1
  74. package/dist/generators/documentation/templates/architectureTemplate.d.ts.map +1 -1
  75. package/dist/generators/documentation/templates/architectureTemplate.js +174 -36
  76. package/dist/generators/documentation/templates/architectureTemplate.js.map +1 -1
  77. package/dist/generators/documentation/templates/common.d.ts +33 -1
  78. package/dist/generators/documentation/templates/common.d.ts.map +1 -1
  79. package/dist/generators/documentation/templates/common.js +144 -10
  80. package/dist/generators/documentation/templates/common.js.map +1 -1
  81. package/dist/generators/documentation/templates/dataFlowTemplate.d.ts.map +1 -1
  82. package/dist/generators/documentation/templates/dataFlowTemplate.js +106 -22
  83. package/dist/generators/documentation/templates/dataFlowTemplate.js.map +1 -1
  84. package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts.map +1 -1
  85. package/dist/generators/documentation/templates/developmentWorkflowTemplate.js +4 -19
  86. package/dist/generators/documentation/templates/developmentWorkflowTemplate.js.map +1 -1
  87. package/dist/generators/documentation/templates/glossaryTemplate.d.ts +1 -1
  88. package/dist/generators/documentation/templates/glossaryTemplate.d.ts.map +1 -1
  89. package/dist/generators/documentation/templates/glossaryTemplate.js +57 -25
  90. package/dist/generators/documentation/templates/glossaryTemplate.js.map +1 -1
  91. package/dist/generators/documentation/templates/indexTemplate.d.ts.map +1 -1
  92. package/dist/generators/documentation/templates/indexTemplate.js +1 -18
  93. package/dist/generators/documentation/templates/indexTemplate.js.map +1 -1
  94. package/dist/generators/documentation/templates/migrationTemplate.d.ts.map +1 -1
  95. package/dist/generators/documentation/templates/migrationTemplate.js +3 -23
  96. package/dist/generators/documentation/templates/migrationTemplate.js.map +1 -1
  97. package/dist/generators/documentation/templates/onboardingTemplate.d.ts.map +1 -1
  98. package/dist/generators/documentation/templates/onboardingTemplate.js +3 -23
  99. package/dist/generators/documentation/templates/onboardingTemplate.js.map +1 -1
  100. package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts.map +1 -1
  101. package/dist/generators/documentation/templates/projectOverviewTemplate.js +94 -28
  102. package/dist/generators/documentation/templates/projectOverviewTemplate.js.map +1 -1
  103. package/dist/generators/documentation/templates/securityTemplate.d.ts.map +1 -1
  104. package/dist/generators/documentation/templates/securityTemplate.js +11 -22
  105. package/dist/generators/documentation/templates/securityTemplate.js.map +1 -1
  106. package/dist/generators/documentation/templates/testingTemplate.d.ts.map +1 -1
  107. package/dist/generators/documentation/templates/testingTemplate.js +4 -19
  108. package/dist/generators/documentation/templates/testingTemplate.js.map +1 -1
  109. package/dist/generators/documentation/templates/toolingTemplate.d.ts.map +1 -1
  110. package/dist/generators/documentation/templates/toolingTemplate.js +11 -25
  111. package/dist/generators/documentation/templates/toolingTemplate.js.map +1 -1
  112. package/dist/generators/documentation/templates/troubleshootingTemplate.d.ts.map +1 -1
  113. package/dist/generators/documentation/templates/troubleshootingTemplate.js +3 -23
  114. package/dist/generators/documentation/templates/troubleshootingTemplate.js.map +1 -1
  115. package/dist/generators/documentation/templates/types.d.ts +2 -1
  116. package/dist/generators/documentation/templates/types.d.ts.map +1 -1
  117. package/dist/generators/plans/planGenerator.d.ts +4 -0
  118. package/dist/generators/plans/planGenerator.d.ts.map +1 -1
  119. package/dist/generators/plans/planGenerator.js +30 -2
  120. package/dist/generators/plans/planGenerator.js.map +1 -1
  121. package/dist/generators/plans/templates/indexTemplate.d.ts.map +1 -1
  122. package/dist/generators/plans/templates/indexTemplate.js +3 -12
  123. package/dist/generators/plans/templates/indexTemplate.js.map +1 -1
  124. package/dist/generators/plans/templates/planTemplate.d.ts.map +1 -1
  125. package/dist/generators/plans/templates/planTemplate.js +57 -33
  126. package/dist/generators/plans/templates/planTemplate.js.map +1 -1
  127. package/dist/generators/plans/templates/types.d.ts +10 -0
  128. package/dist/generators/plans/templates/types.d.ts.map +1 -1
  129. package/dist/generators/shared/generatorUtils.d.ts.map +1 -1
  130. package/dist/generators/shared/generatorUtils.js +6 -9
  131. package/dist/generators/shared/generatorUtils.js.map +1 -1
  132. package/dist/index.d.ts.map +1 -1
  133. package/dist/index.js +646 -114
  134. package/dist/index.js.map +1 -1
  135. package/dist/prompts/defaults.d.ts +2 -2
  136. package/dist/prompts/defaults.d.ts.map +1 -1
  137. package/dist/prompts/defaults.js +26 -56
  138. package/dist/prompts/defaults.js.map +1 -1
  139. package/dist/services/ai/agentEvents.d.ts +45 -0
  140. package/dist/services/ai/agentEvents.d.ts.map +1 -0
  141. package/dist/services/ai/agentEvents.js +61 -0
  142. package/dist/services/ai/agentEvents.js.map +1 -0
  143. package/dist/services/ai/agents/documentationAgent.d.ts +53 -0
  144. package/dist/services/ai/agents/documentationAgent.d.ts.map +1 -0
  145. package/dist/services/ai/agents/documentationAgent.js +217 -0
  146. package/dist/services/ai/agents/documentationAgent.js.map +1 -0
  147. package/dist/services/ai/agents/index.d.ts +7 -0
  148. package/dist/services/ai/agents/index.d.ts.map +1 -0
  149. package/dist/services/ai/agents/index.js +10 -0
  150. package/dist/services/ai/agents/index.js.map +1 -0
  151. package/dist/services/ai/agents/planAgent.d.ts +68 -0
  152. package/dist/services/ai/agents/planAgent.d.ts.map +1 -0
  153. package/dist/services/ai/agents/planAgent.js +342 -0
  154. package/dist/services/ai/agents/planAgent.js.map +1 -0
  155. package/dist/services/ai/agents/playbookAgent.d.ts +54 -0
  156. package/dist/services/ai/agents/playbookAgent.d.ts.map +1 -0
  157. package/dist/services/ai/agents/playbookAgent.js +244 -0
  158. package/dist/services/ai/agents/playbookAgent.js.map +1 -0
  159. package/dist/services/ai/aiSdkClient.d.ts +67 -0
  160. package/dist/services/ai/aiSdkClient.d.ts.map +1 -0
  161. package/dist/services/ai/aiSdkClient.js +143 -0
  162. package/dist/services/ai/aiSdkClient.js.map +1 -0
  163. package/dist/services/ai/index.d.ts +7 -0
  164. package/dist/services/ai/index.d.ts.map +1 -0
  165. package/dist/services/ai/index.js +49 -0
  166. package/dist/services/ai/index.js.map +1 -0
  167. package/dist/services/ai/prompts/index.d.ts +2 -0
  168. package/dist/services/ai/prompts/index.d.ts.map +1 -0
  169. package/dist/services/ai/prompts/index.js +12 -0
  170. package/dist/services/ai/prompts/index.js.map +1 -0
  171. package/dist/services/ai/prompts/sharedPrompts.d.ts +33 -0
  172. package/dist/services/ai/prompts/sharedPrompts.d.ts.map +1 -0
  173. package/dist/services/ai/prompts/sharedPrompts.js +136 -0
  174. package/dist/services/ai/prompts/sharedPrompts.js.map +1 -0
  175. package/dist/services/ai/providerFactory.d.ts +35 -0
  176. package/dist/services/ai/providerFactory.d.ts.map +1 -0
  177. package/dist/services/ai/providerFactory.js +107 -0
  178. package/dist/services/ai/providerFactory.js.map +1 -0
  179. package/dist/services/ai/schemas.d.ts +331 -0
  180. package/dist/services/ai/schemas.d.ts.map +1 -0
  181. package/dist/services/ai/schemas.js +236 -0
  182. package/dist/services/ai/schemas.js.map +1 -0
  183. package/dist/services/ai/toolRegistry.d.ts +27 -0
  184. package/dist/services/ai/toolRegistry.d.ts.map +1 -0
  185. package/dist/services/ai/toolRegistry.js +126 -0
  186. package/dist/services/ai/toolRegistry.js.map +1 -0
  187. package/dist/services/ai/tools/analyzeSymbolsTool.d.ts +33 -0
  188. package/dist/services/ai/tools/analyzeSymbolsTool.d.ts.map +1 -0
  189. package/dist/services/ai/tools/analyzeSymbolsTool.js +57 -0
  190. package/dist/services/ai/tools/analyzeSymbolsTool.js.map +1 -0
  191. package/dist/services/ai/tools/checkScaffoldingTool.d.ts +18 -0
  192. package/dist/services/ai/tools/checkScaffoldingTool.d.ts.map +1 -0
  193. package/dist/services/ai/tools/checkScaffoldingTool.js +86 -0
  194. package/dist/services/ai/tools/checkScaffoldingTool.js.map +1 -0
  195. package/dist/services/ai/tools/fillScaffoldingTool.d.ts +108 -0
  196. package/dist/services/ai/tools/fillScaffoldingTool.d.ts.map +1 -0
  197. package/dist/services/ai/tools/fillScaffoldingTool.js +463 -0
  198. package/dist/services/ai/tools/fillScaffoldingTool.js.map +1 -0
  199. package/dist/services/ai/tools/getFileStructureTool.d.ts +29 -0
  200. package/dist/services/ai/tools/getFileStructureTool.d.ts.map +1 -0
  201. package/dist/services/ai/tools/getFileStructureTool.js +48 -0
  202. package/dist/services/ai/tools/getFileStructureTool.js.map +1 -0
  203. package/dist/services/ai/tools/index.d.ts +20 -0
  204. package/dist/services/ai/tools/index.d.ts.map +1 -0
  205. package/dist/services/ai/tools/index.js +68 -0
  206. package/dist/services/ai/tools/index.js.map +1 -0
  207. package/dist/services/ai/tools/initializeContextTool.d.ts +25 -0
  208. package/dist/services/ai/tools/initializeContextTool.d.ts.map +1 -0
  209. package/dist/services/ai/tools/initializeContextTool.js +121 -0
  210. package/dist/services/ai/tools/initializeContextTool.js.map +1 -0
  211. package/dist/services/ai/tools/listFilesTool.d.ts +18 -0
  212. package/dist/services/ai/tools/listFilesTool.d.ts.map +1 -0
  213. package/dist/services/ai/tools/listFilesTool.js +34 -0
  214. package/dist/services/ai/tools/listFilesTool.js.map +1 -0
  215. package/dist/services/ai/tools/readFileTool.d.ts +17 -0
  216. package/dist/services/ai/tools/readFileTool.d.ts.map +1 -0
  217. package/dist/services/ai/tools/readFileTool.js +63 -0
  218. package/dist/services/ai/tools/readFileTool.js.map +1 -0
  219. package/dist/services/ai/tools/scaffoldPlanTool.d.ts +19 -0
  220. package/dist/services/ai/tools/scaffoldPlanTool.d.ts.map +1 -0
  221. package/dist/services/ai/tools/scaffoldPlanTool.js +81 -0
  222. package/dist/services/ai/tools/scaffoldPlanTool.js.map +1 -0
  223. package/dist/services/ai/tools/searchCodeTool.d.ts +25 -0
  224. package/dist/services/ai/tools/searchCodeTool.d.ts.map +1 -0
  225. package/dist/services/ai/tools/searchCodeTool.js +96 -0
  226. package/dist/services/ai/tools/searchCodeTool.js.map +1 -0
  227. package/dist/services/fill/fillService.d.ts +11 -1
  228. package/dist/services/fill/fillService.d.ts.map +1 -1
  229. package/dist/services/fill/fillService.js +157 -40
  230. package/dist/services/fill/fillService.js.map +1 -1
  231. package/dist/services/init/initService.d.ts +1 -0
  232. package/dist/services/init/initService.d.ts.map +1 -1
  233. package/dist/services/init/initService.js +12 -7
  234. package/dist/services/init/initService.js.map +1 -1
  235. package/dist/services/llmClientFactory.d.ts +36 -2
  236. package/dist/services/llmClientFactory.d.ts.map +1 -1
  237. package/dist/services/llmClientFactory.js +57 -11
  238. package/dist/services/llmClientFactory.js.map +1 -1
  239. package/dist/services/mcp/index.d.ts +2 -0
  240. package/dist/services/mcp/index.d.ts.map +1 -0
  241. package/dist/services/mcp/index.js +7 -0
  242. package/dist/services/mcp/index.js.map +1 -0
  243. package/dist/services/mcp/mcpServer.d.ts +45 -0
  244. package/dist/services/mcp/mcpServer.d.ts.map +1 -0
  245. package/dist/services/mcp/mcpServer.js +411 -0
  246. package/dist/services/mcp/mcpServer.js.map +1 -0
  247. package/dist/services/openRouterClient.js +1 -1
  248. package/dist/services/openRouterClient.js.map +1 -1
  249. package/dist/services/passthrough/commandRouter.d.ts +53 -0
  250. package/dist/services/passthrough/commandRouter.d.ts.map +1 -0
  251. package/dist/services/passthrough/commandRouter.js +349 -0
  252. package/dist/services/passthrough/commandRouter.js.map +1 -0
  253. package/dist/services/passthrough/index.d.ts +7 -0
  254. package/dist/services/passthrough/index.d.ts.map +1 -0
  255. package/dist/services/passthrough/index.js +23 -0
  256. package/dist/services/passthrough/index.js.map +1 -0
  257. package/dist/services/passthrough/protocol.d.ts +269 -0
  258. package/dist/services/passthrough/protocol.d.ts.map +1 -0
  259. package/dist/services/passthrough/protocol.js +151 -0
  260. package/dist/services/passthrough/protocol.js.map +1 -0
  261. package/dist/services/passthrough/stdinReader.d.ts +42 -0
  262. package/dist/services/passthrough/stdinReader.d.ts.map +1 -0
  263. package/dist/services/passthrough/stdinReader.js +111 -0
  264. package/dist/services/passthrough/stdinReader.js.map +1 -0
  265. package/dist/services/plan/planService.d.ts +3 -1
  266. package/dist/services/plan/planService.d.ts.map +1 -1
  267. package/dist/services/plan/planService.js +49 -41
  268. package/dist/services/plan/planService.js.map +1 -1
  269. package/dist/services/semantic/codebaseAnalyzer.d.ts +40 -0
  270. package/dist/services/semantic/codebaseAnalyzer.d.ts.map +1 -0
  271. package/dist/services/semantic/codebaseAnalyzer.js +540 -0
  272. package/dist/services/semantic/codebaseAnalyzer.js.map +1 -0
  273. package/dist/services/semantic/contextBuilder.d.ts +79 -0
  274. package/dist/services/semantic/contextBuilder.d.ts.map +1 -0
  275. package/dist/services/semantic/contextBuilder.js +538 -0
  276. package/dist/services/semantic/contextBuilder.js.map +1 -0
  277. package/dist/services/semantic/index.d.ts +12 -0
  278. package/dist/services/semantic/index.d.ts.map +1 -0
  279. package/dist/services/semantic/index.js +33 -0
  280. package/dist/services/semantic/index.js.map +1 -0
  281. package/dist/services/semantic/lsp/index.d.ts +2 -0
  282. package/dist/services/semantic/lsp/index.d.ts.map +1 -0
  283. package/dist/services/semantic/lsp/index.js +6 -0
  284. package/dist/services/semantic/lsp/index.js.map +1 -0
  285. package/dist/services/semantic/lsp/lspLayer.d.ts +32 -0
  286. package/dist/services/semantic/lsp/lspLayer.d.ts.map +1 -0
  287. package/dist/services/semantic/lsp/lspLayer.js +378 -0
  288. package/dist/services/semantic/lsp/lspLayer.js.map +1 -0
  289. package/dist/services/semantic/treeSitter/index.d.ts +2 -0
  290. package/dist/services/semantic/treeSitter/index.d.ts.map +1 -0
  291. package/dist/services/semantic/treeSitter/index.js +6 -0
  292. package/dist/services/semantic/treeSitter/index.js.map +1 -0
  293. package/dist/services/semantic/treeSitter/treeSitterLayer.d.ts +37 -0
  294. package/dist/services/semantic/treeSitter/treeSitterLayer.d.ts.map +1 -0
  295. package/dist/services/semantic/treeSitter/treeSitterLayer.js +518 -0
  296. package/dist/services/semantic/treeSitter/treeSitterLayer.js.map +1 -0
  297. package/dist/services/semantic/types.d.ts +122 -0
  298. package/dist/services/semantic/types.d.ts.map +1 -0
  299. package/dist/services/semantic/types.js +31 -0
  300. package/dist/services/semantic/types.js.map +1 -0
  301. package/dist/services/serve/index.d.ts +2 -0
  302. package/dist/services/serve/index.d.ts.map +1 -0
  303. package/dist/services/serve/index.js +6 -0
  304. package/dist/services/serve/index.js.map +1 -0
  305. package/dist/services/serve/serveService.d.ts +38 -0
  306. package/dist/services/serve/serveService.d.ts.map +1 -0
  307. package/dist/services/serve/serveService.js +99 -0
  308. package/dist/services/serve/serveService.js.map +1 -0
  309. package/dist/services/shared/llmConfig.d.ts +19 -3
  310. package/dist/services/shared/llmConfig.d.ts.map +1 -1
  311. package/dist/services/shared/llmConfig.js +39 -10
  312. package/dist/services/shared/llmConfig.js.map +1 -1
  313. package/dist/services/state/index.d.ts +2 -0
  314. package/dist/services/state/index.d.ts.map +1 -0
  315. package/dist/services/state/index.js +6 -0
  316. package/dist/services/state/index.js.map +1 -0
  317. package/dist/services/state/stateDetector.d.ts +53 -0
  318. package/dist/services/state/stateDetector.d.ts.map +1 -0
  319. package/dist/services/state/stateDetector.js +189 -0
  320. package/dist/services/state/stateDetector.js.map +1 -0
  321. package/dist/services/sync/index.d.ts +6 -0
  322. package/dist/services/sync/index.d.ts.map +1 -0
  323. package/dist/services/sync/index.js +16 -0
  324. package/dist/services/sync/index.js.map +1 -0
  325. package/dist/services/sync/markdownReferenceHandler.d.ts +3 -0
  326. package/dist/services/sync/markdownReferenceHandler.d.ts.map +1 -0
  327. package/dist/services/sync/markdownReferenceHandler.js +133 -0
  328. package/dist/services/sync/markdownReferenceHandler.js.map +1 -0
  329. package/dist/services/sync/presets.d.ts +6 -0
  330. package/dist/services/sync/presets.d.ts.map +1 -0
  331. package/dist/services/sync/presets.js +49 -0
  332. package/dist/services/sync/presets.js.map +1 -0
  333. package/dist/services/sync/symlinkHandler.d.ts +7 -0
  334. package/dist/services/sync/symlinkHandler.d.ts.map +1 -0
  335. package/dist/services/sync/symlinkHandler.js +129 -0
  336. package/dist/services/sync/symlinkHandler.js.map +1 -0
  337. package/dist/services/sync/syncService.d.ts +15 -0
  338. package/dist/services/sync/syncService.d.ts.map +1 -0
  339. package/dist/services/sync/syncService.js +222 -0
  340. package/dist/services/sync/syncService.js.map +1 -0
  341. package/dist/services/sync/types.d.ts +62 -0
  342. package/dist/services/sync/types.d.ts.map +1 -0
  343. package/dist/services/sync/types.js +3 -0
  344. package/dist/services/sync/types.js.map +1 -0
  345. package/dist/services/update/index.d.ts +2 -0
  346. package/dist/services/update/index.d.ts.map +1 -0
  347. package/dist/services/update/index.js +6 -0
  348. package/dist/services/update/index.js.map +1 -0
  349. package/dist/services/update/updateService.d.ts +64 -0
  350. package/dist/services/update/updateService.d.ts.map +1 -0
  351. package/dist/services/update/updateService.js +295 -0
  352. package/dist/services/update/updateService.js.map +1 -0
  353. package/dist/types.d.ts +2 -6
  354. package/dist/types.d.ts.map +1 -1
  355. package/dist/utils/cliUI.d.ts +33 -0
  356. package/dist/utils/cliUI.d.ts.map +1 -1
  357. package/dist/utils/cliUI.js +157 -107
  358. package/dist/utils/cliUI.js.map +1 -1
  359. package/dist/utils/contentSanitizer.d.ts +42 -0
  360. package/dist/utils/contentSanitizer.d.ts.map +1 -0
  361. package/dist/utils/contentSanitizer.js +238 -0
  362. package/dist/utils/contentSanitizer.js.map +1 -0
  363. package/dist/utils/frontMatter.d.ts +55 -0
  364. package/dist/utils/frontMatter.d.ts.map +1 -0
  365. package/dist/utils/frontMatter.js +173 -0
  366. package/dist/utils/frontMatter.js.map +1 -0
  367. package/dist/utils/gitService.d.ts.map +1 -1
  368. package/dist/utils/gitService.js +12 -14
  369. package/dist/utils/gitService.js.map +1 -1
  370. package/dist/utils/i18n.d.ts +101 -13
  371. package/dist/utils/i18n.d.ts.map +1 -1
  372. package/dist/utils/i18n.js +204 -28
  373. package/dist/utils/i18n.js.map +1 -1
  374. package/dist/utils/prompts/configSummary.d.ts +7 -0
  375. package/dist/utils/prompts/configSummary.d.ts.map +1 -0
  376. package/dist/utils/prompts/configSummary.js +63 -0
  377. package/dist/utils/prompts/configSummary.js.map +1 -0
  378. package/dist/utils/prompts/index.d.ts +22 -0
  379. package/dist/utils/prompts/index.d.ts.map +1 -0
  380. package/dist/utils/prompts/index.js +122 -0
  381. package/dist/utils/prompts/index.js.map +1 -0
  382. package/dist/utils/prompts/llmPrompts.d.ts +11 -0
  383. package/dist/utils/prompts/llmPrompts.d.ts.map +1 -0
  384. package/dist/utils/prompts/llmPrompts.js +96 -0
  385. package/dist/utils/prompts/llmPrompts.js.map +1 -0
  386. package/dist/utils/prompts/smartDefaults.d.ts +15 -0
  387. package/dist/utils/prompts/smartDefaults.d.ts.map +1 -0
  388. package/dist/utils/prompts/smartDefaults.js +105 -0
  389. package/dist/utils/prompts/smartDefaults.js.map +1 -0
  390. package/dist/utils/prompts/types.d.ts +38 -0
  391. package/dist/utils/prompts/types.d.ts.map +1 -0
  392. package/dist/utils/prompts/types.js +3 -0
  393. package/dist/utils/prompts/types.js.map +1 -0
  394. package/dist/utils/theme.d.ts +66 -0
  395. package/dist/utils/theme.d.ts.map +1 -0
  396. package/dist/utils/theme.js +93 -0
  397. package/dist/utils/theme.js.map +1 -0
  398. package/dist/version.d.ts +8 -0
  399. package/dist/version.d.ts.map +1 -0
  400. package/dist/version.js +15 -0
  401. package/dist/version.js.map +1 -0
  402. package/package.json +12 -2
  403. package/prompts/update_scaffold_prompt.md +14 -34
  404. package/dist/commands/shared/agents.d.ts +0 -2
  405. package/dist/commands/shared/agents.d.ts.map +0 -1
  406. package/dist/commands/shared/agents.js +0 -15
  407. package/dist/commands/shared/agents.js.map +0 -1
  408. package/dist/commands/shared/selection.d.ts +0 -12
  409. package/dist/commands/shared/selection.d.ts.map +0 -1
  410. package/dist/commands/shared/selection.js +0 -95
  411. package/dist/commands/shared/selection.js.map +0 -1
  412. package/dist/generators/documentation/templates/frontMatter.d.ts +0 -11
  413. package/dist/generators/documentation/templates/frontMatter.d.ts.map +0 -1
  414. package/dist/generators/documentation/templates/frontMatter.js +0 -29
  415. package/dist/generators/documentation/templates/frontMatter.js.map +0 -1
  416. package/dist/services/anthropicClient.d.ts +0 -12
  417. package/dist/services/anthropicClient.d.ts.map +0 -1
  418. package/dist/services/anthropicClient.js +0 -98
  419. package/dist/services/anthropicClient.js.map +0 -1
  420. package/dist/services/geminiClient.d.ts +0 -12
  421. package/dist/services/geminiClient.d.ts.map +0 -1
  422. package/dist/services/geminiClient.js +0 -96
  423. package/dist/services/geminiClient.js.map +0 -1
  424. package/dist/services/grokClient.d.ts +0 -12
  425. package/dist/services/grokClient.d.ts.map +0 -1
  426. package/dist/services/grokClient.js +0 -101
  427. package/dist/services/grokClient.js.map +0 -1
  428. package/dist/services/openaiClient.d.ts +0 -12
  429. package/dist/services/openaiClient.d.ts.map +0 -1
  430. package/dist/services/openaiClient.js +0 -98
  431. package/dist/services/openaiClient.js.map +0 -1
  432. package/dist/utils/pricing.d.ts +0 -14
  433. package/dist/utils/pricing.d.ts.map +0 -1
  434. package/dist/utils/pricing.js +0 -115
  435. package/dist/utils/pricing.js.map +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"dataFlowTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/dataFlowTemplate.ts"],"names":[],"mappings":";;AAGA,wCAkCC;AApCD,qCAAqD;AAErD,SAAgB,cAAc,CAAC,OAAqC;IAClE,OAAO;;;;;;;;;gCASuB,IAAA,kCAAyB,EAAC,OAAO,CAAC,mBAAmB,CAAC;;;;;;;;;;;;;;;;;;;;;;;CAuBrF,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"dataFlowTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/dataFlowTemplate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyEA,wCAgCC;AAzGD,2CAA6B;AAE7B,qCAA0E;AAE1E,SAAS,wBAAwB,CAAC,OAAqC;IACrE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAC7C,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,KAAK,EAAE,CAAC;QACjD,OAAO,sCAAsC,CAAC;IAChD,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;IACxC,MAAM,KAAK,GAAG,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC;IAE3C,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,sCAAsC,CAAC;IAChD,CAAC;IAED,4CAA4C;IAC5C,MAAM,YAAY,GAAG,IAAI,GAAG,EAAuB,CAAC;IAEpD,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC;QACtC,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAClD,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC;QAEvD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC;YAEvD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,MAAM,GAAG,GAAG,SAAS,CAAC;gBACtB,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC;gBAChD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACpB,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,YAAY,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,4CAA4C,CAAC;IACtD,CAAC;IAED,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,YAAY,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxE,KAAK,CAAC,IAAI,CAAC,OAAO,MAAM,SAAS,OAAO,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAqC;IAC/D,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAC7C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,kCAAkC,CAAC;IAC5C,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;IAExC,mDAAmD;IACnD,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO;SACvC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC;IAEzD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,kCAAkC,CAAC;IAC5C,CAAC;IAED,OAAO,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC3D,MAAM,GAAG,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,OAAO,QAAQ,GAAG,CAAC,IAAI,OAAO,OAAO,KAAK,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC;IACvE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,SAAgB,cAAc,CAAC,OAAqC;IAClE,MAAM,kBAAkB,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAC7D,MAAM,YAAY,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAEjD,MAAM,OAAO,GAAG;;;;;EAKhB,kBAAkB;;;EAGlB,YAAY;;;;;;;;8BAQgB,IAAA,kCAAyB,EAAC,OAAO,CAAC,mBAAmB,CAAC;;;;;;;;;CASnF,CAAC;IAEA,OAAO,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;AACtC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"developmentWorkflowTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/developmentWorkflowTemplate.ts"],"names":[],"mappings":"AAAA,wBAAgB,yBAAyB,IAAI,MAAM,CAuClD"}
1
+ {"version":3,"file":"developmentWorkflowTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/developmentWorkflowTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,yBAAyB,IAAI,MAAM,CAwBlD"}
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderDevelopmentWorkflow = renderDevelopmentWorkflow;
4
+ const common_1 = require("./common");
4
5
  function renderDevelopmentWorkflow() {
5
- return `<!-- agent-update:start:development-workflow -->
6
- # Development Workflow
6
+ const content = `# Development Workflow
7
7
 
8
8
  Outline the day-to-day engineering process for this repository.
9
9
 
@@ -21,24 +21,9 @@ Outline the day-to-day engineering process for this repository.
21
21
  - Reference [AGENTS.md](../../AGENTS.md) for agent collaboration tips.
22
22
 
23
23
  ## Onboarding Tasks
24
- - Point newcomers to first issues or starter tickets.
25
- - Link to internal runbooks or dashboards.
26
24
 
27
- <!-- agent-readonly:guidance -->
28
- ## AI Update Checklist
29
- 1. Confirm branching/release steps with CI configuration and recent tags.
30
- 2. Verify local commands against \`package.json\`; ensure flags and scripts still exist.
31
- 3. Capture review requirements (approvers, checks) from contributing docs or repository settings.
32
- 4. Refresh onboarding links (boards, dashboards) to their latest URLs.
33
- 5. Highlight any manual steps that should become automation follow-ups.
34
-
35
- <!-- agent-readonly:sources -->
36
- ## Acceptable Sources
37
- - CONTRIBUTING guidelines and \`AGENTS.md\`.
38
- - Build pipelines, branch protection rules, or release scripts.
39
- - Issue tracker boards used for onboarding or triage.
40
-
41
- <!-- agent-update:end -->
25
+ Point newcomers to first issues or starter tickets. Link to internal runbooks or dashboards.
42
26
  `;
27
+ return (0, common_1.wrapWithFrontMatter)(content);
43
28
  }
44
29
  //# sourceMappingURL=developmentWorkflowTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"developmentWorkflowTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/developmentWorkflowTemplate.ts"],"names":[],"mappings":";;AAAA,8DAuCC;AAvCD,SAAgB,yBAAyB;IACvC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqCR,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"developmentWorkflowTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/developmentWorkflowTemplate.ts"],"names":[],"mappings":";;AAEA,8DAwBC;AA1BD,qCAA+C;AAE/C,SAAgB,yBAAyB;IACvC,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;CAoBjB,CAAC;IAEA,OAAO,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;AACtC,CAAC"}
@@ -1,3 +1,3 @@
1
1
  import { DocumentationTemplateContext } from './types';
2
- export declare function renderGlossary(_context: DocumentationTemplateContext): string;
2
+ export declare function renderGlossary(context: DocumentationTemplateContext): string;
3
3
  //# sourceMappingURL=glossaryTemplate.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"glossaryTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/glossaryTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAEvD,wBAAgB,cAAc,CAAC,QAAQ,EAAE,4BAA4B,GAAG,MAAM,CAqC7E"}
1
+ {"version":3,"file":"glossaryTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/glossaryTemplate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAgDvD,wBAAgB,cAAc,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CAgC5E"}
@@ -1,41 +1,73 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderGlossary = renderGlossary;
4
- function renderGlossary(_context) {
5
- return `
6
- <!-- agent-update:start:glossary -->
7
- # Glossary & Domain Concepts
4
+ const common_1 = require("./common");
5
+ function renderTypeDefinitions(context) {
6
+ const { semantics, repoStructure } = context;
7
+ if (!semantics) {
8
+ return '- *No exported type definitions found.*';
9
+ }
10
+ const repoRoot = repoStructure.rootPath;
11
+ // Combine types and interfaces, sort by name
12
+ const typeSymbols = [
13
+ ...semantics.symbols.types,
14
+ ...semantics.symbols.interfaces,
15
+ ]
16
+ .filter(s => s.exported)
17
+ .sort((a, b) => a.name.localeCompare(b.name));
18
+ if (typeSymbols.length === 0) {
19
+ return '- *No exported type definitions found.*';
20
+ }
21
+ return typeSymbols.map(sym => {
22
+ const ref = (0, common_1.formatSymbolRef)(sym, repoRoot);
23
+ const doc = sym.documentation ? ` — ${sym.documentation}` : '';
24
+ return `- **${sym.name}** (${sym.kind}) — ${ref}${doc}`;
25
+ }).join('\n');
26
+ }
27
+ function renderEnumDefinitions(context) {
28
+ const { semantics, repoStructure } = context;
29
+ if (!semantics || semantics.symbols.enums.length === 0) {
30
+ return '- *No enums detected.*';
31
+ }
32
+ const repoRoot = repoStructure.rootPath;
33
+ return semantics.symbols.enums
34
+ .filter(s => s.exported)
35
+ .sort((a, b) => a.name.localeCompare(b.name))
36
+ .map(sym => {
37
+ const ref = (0, common_1.formatSymbolRef)(sym, repoRoot);
38
+ const doc = sym.documentation ? ` — ${sym.documentation}` : '';
39
+ return `- **${sym.name}** — ${ref}${doc}`;
40
+ }).join('\n') || '- *No exported enums found.*';
41
+ }
42
+ function renderGlossary(context) {
43
+ const typeDefinitions = renderTypeDefinitions(context);
44
+ const enumDefinitions = renderEnumDefinitions(context);
45
+ const content = `# Glossary & Domain Concepts
8
46
 
9
47
  List project-specific terminology, acronyms, domain entities, and user personas.
10
48
 
49
+ ## Type Definitions
50
+ ${typeDefinitions}
51
+
52
+ ## Enumerations
53
+ ${enumDefinitions}
54
+
11
55
  ## Core Terms
12
- - <!-- agent-fill:term-one -->**Term** — Definition, relevance, and where it surfaces in the codebase.<!-- /agent-fill -->
13
- - <!-- agent-fill:term-two -->**Term** — Definition, domain context, related modules.<!-- /agent-fill -->
56
+
57
+ Define key terms, their relevance, and where they surface in the codebase.
14
58
 
15
59
  ## Acronyms & Abbreviations
16
- - <!-- agent-fill:acronym -->**ABC** — Expanded form; why we use it; associated services or APIs.<!-- /agent-fill -->
60
+
61
+ Expand abbreviations and note associated services or APIs.
17
62
 
18
63
  ## Personas / Actors
19
- - <!-- agent-fill:persona -->**Persona Name** — Goals, key workflows, pain points addressed by the system.<!-- /agent-fill -->
64
+
65
+ Describe user goals, key workflows, and pain points addressed by the system.
20
66
 
21
67
  ## Domain Rules & Invariants
22
- - Capture business rules, validation constraints, or compliance requirements that the code enforces.
23
- - Note any region, localization, or regulatory nuances.
24
-
25
- <!-- agent-readonly:guidance -->
26
- ## AI Update Checklist
27
- 1. Harvest terminology from recent PRs, issues, and discussions.
28
- 2. Confirm definitions with product or domain experts when uncertain.
29
- 3. Link terms to relevant docs or modules for deeper context.
30
- 4. Remove or archive outdated concepts; flag unknown terms for follow-up.
31
-
32
- <!-- agent-readonly:sources -->
33
- ## Acceptable Sources
34
- - Product requirement docs, RFCs, user research, or support tickets.
35
- - Service contracts, API schemas, data dictionaries.
36
- - Conversations with domain experts (summarize outcomes if applicable).
37
-
38
- <!-- agent-update:end -->
68
+
69
+ Capture business rules, validation constraints, or compliance requirements. Note any region, localization, or regulatory nuances.
39
70
  `;
71
+ return (0, common_1.wrapWithFrontMatter)(content);
40
72
  }
41
73
  //# sourceMappingURL=glossaryTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"glossaryTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/glossaryTemplate.ts"],"names":[],"mappings":";;AAEA,wCAqCC;AArCD,SAAgB,cAAc,CAAC,QAAsC;IAEnE,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkCR,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"glossaryTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/glossaryTemplate.ts"],"names":[],"mappings":";;AAiDA,wCAgCC;AA/ED,qCAAgE;AAEhE,SAAS,qBAAqB,CAAC,OAAqC;IAClE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAC7C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,yCAAyC,CAAC;IACnD,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;IAExC,6CAA6C;IAC7C,MAAM,WAAW,GAAG;QAClB,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK;QAC1B,GAAG,SAAS,CAAC,OAAO,CAAC,UAAU;KAChC;SACE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;SACvB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAEhD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,yCAAyC,CAAC;IACnD,CAAC;IAED,OAAO,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QAC3B,MAAM,GAAG,GAAG,IAAA,wBAAe,EAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,OAAO,OAAO,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,OAAO,GAAG,GAAG,GAAG,EAAE,CAAC;IAC1D,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAqC;IAClE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAC7C,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvD,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;IAExC,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK;SAC3B,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;SACvB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SAC5C,GAAG,CAAC,GAAG,CAAC,EAAE;QACT,MAAM,GAAG,GAAG,IAAA,wBAAe,EAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,OAAO,OAAO,GAAG,CAAC,IAAI,QAAQ,GAAG,GAAG,GAAG,EAAE,CAAC;IAC5C,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,8BAA8B,CAAC;AACpD,CAAC;AAED,SAAgB,cAAc,CAAC,OAAqC;IAClE,MAAM,eAAe,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACvD,MAAM,eAAe,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAEvD,MAAM,OAAO,GAAG;;;;;EAKhB,eAAe;;;EAGf,eAAe;;;;;;;;;;;;;;;;;CAiBhB,CAAC;IAEA,OAAO,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;AACtC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"indexTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/indexTemplate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAEvD,wBAAgB,WAAW,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CAsCzE"}
1
+ {"version":3,"file":"indexTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/indexTemplate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAEvD,wBAAgB,WAAW,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CAqBzE"}
@@ -8,9 +8,7 @@ function renderIndex(context) {
8
8
  const navigationList = context.guides
9
9
  .map(guide => `- [${guide.title}](./${guide.file})`)
10
10
  .join('\n') || '- *No guides selected.*';
11
- return `
12
- <!-- agent-update:start:docs-index -->
13
- # Documentation Index
11
+ return `# Documentation Index
14
12
 
15
13
  Welcome to the repository knowledge base. Start with the project overview, then dive into specific guides as needed.
16
14
 
@@ -22,21 +20,6 @@ ${directoryList || '*Top-level directories will appear here once the repository
22
20
 
23
21
  ## Document Map
24
22
  ${documentMap}
25
-
26
- <!-- agent-readonly:guidance -->
27
- ## AI Update Checklist
28
- 1. Gather context with \`git status -sb\` plus the latest commits touching \`docs/\` or \`agents/\`.
29
- 2. Compare the current directory tree against the table above; add or retire rows accordingly.
30
- 3. Update cross-links if guides moved or were renamed; keep anchor text concise.
31
- 4. Record sources consulted inside the commit or PR description for traceability.
32
-
33
- <!-- agent-readonly:sources -->
34
- ## Acceptable Sources
35
- - Repository tree and \`package.json\` scripts for canonical command names.
36
- - Maintainer-approved issues, RFCs, or product briefs referenced in the repo.
37
- - Release notes or changelog entries that announce documentation changes.
38
-
39
- <!-- agent-update:end -->
40
23
  `;
41
24
  }
42
25
  //# sourceMappingURL=indexTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"indexTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/indexTemplate.ts"],"names":[],"mappings":";;AAGA,kCAsCC;AAzCD,qCAAsE;AAGtE,SAAgB,WAAW,CAAC,OAAqC;IAE/D,MAAM,aAAa,GAAG,IAAA,4BAAmB,EAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC1D,MAAM,WAAW,GAAG,IAAA,8BAAqB,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1D,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM;SAClC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC,IAAI,GAAG,CAAC;SACnD,IAAI,CAAC,IAAI,CAAC,IAAI,yBAAyB,CAAC;IAE3C,OAAO;;;;;;;EAOP,cAAc;;;EAGd,aAAa,IAAI,mFAAmF;;;EAGpG,WAAW;;;;;;;;;;;;;;;;CAgBZ,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"indexTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/indexTemplate.ts"],"names":[],"mappings":";;AAGA,kCAqBC;AAxBD,qCAAsE;AAGtE,SAAgB,WAAW,CAAC,OAAqC;IAE/D,MAAM,aAAa,GAAG,IAAA,4BAAmB,EAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC1D,MAAM,WAAW,GAAG,IAAA,8BAAqB,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1D,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM;SAClC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC,IAAI,GAAG,CAAC;SACnD,IAAI,CAAC,IAAI,CAAC,IAAI,yBAAyB,CAAC;IAE3C,OAAO;;;;;EAKP,cAAc;;;EAGd,aAAa,IAAI,mFAAmF;;;EAGpG,WAAW;CACZ,CAAC;AACF,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"migrationTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/migrationTemplate.ts"],"names":[],"mappings":"AACA,wBAAgB,eAAe,IAAI,MAAM,CAkaxC"}
1
+ {"version":3,"file":"migrationTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/migrationTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,eAAe,IAAI,MAAM,CA6YxC"}
@@ -1,10 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderMigration = renderMigration;
4
+ const common_1 = require("./common");
4
5
  function renderMigration() {
5
- return `
6
- <!-- agent-update:start:migration-guide -->
7
- # Migration Guide
6
+ const content = `# Migration Guide
8
7
 
9
8
  Complete guide for upgrading between versions, handling breaking changes, and migrating data.
10
9
 
@@ -397,26 +396,7 @@ When reporting migration problems, include:
397
396
  3. Migration log output
398
397
  4. Database type and version
399
398
  5. Steps to reproduce
400
-
401
- <!-- agent-readonly:guidance -->
402
- ## AI Update Checklist
403
- 1. Update version numbers and release dates when new versions are published
404
- 2. Document new breaking changes with clear before/after examples
405
- 3. Add migration paths for each new major version
406
- 4. Update deprecation timeline as features are removed
407
- 5. Include actual migration scripts and examples from the codebase
408
- 6. Verify rollback procedures are tested and accurate
409
- 7. Update system requirements for new versions
410
-
411
- <!-- agent-readonly:sources -->
412
- ## Acceptable Sources
413
- - CHANGELOG.md and release notes
414
- - Migration scripts in migrations/ or db/migrate/ directory
415
- - Upgrade guides from official documentation
416
- - Post-mortem reports from previous migrations
417
- - Breaking changes documented in commit messages or PRs
418
-
419
- <!-- agent-update:end -->
420
399
  `;
400
+ return (0, common_1.wrapWithFrontMatter)(content);
421
401
  }
422
402
  //# sourceMappingURL=migrationTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"migrationTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/migrationTemplate.ts"],"names":[],"mappings":";;AACA,0CAkaC;AAlaD,SAAgB,eAAe;IAE7B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+ZR,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"migrationTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/migrationTemplate.ts"],"names":[],"mappings":";;AAEA,0CA6YC;AA/YD,qCAA+C;AAE/C,SAAgB,eAAe;IAC7B,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyYjB,CAAC;IAEA,OAAO,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;AACtC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"onboardingTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/onboardingTemplate.ts"],"names":[],"mappings":"AACA,wBAAgB,gBAAgB,IAAI,MAAM,CA2azC"}
1
+ {"version":3,"file":"onboardingTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/onboardingTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,gBAAgB,IAAI,MAAM,CAsZzC"}
@@ -1,10 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderOnboarding = renderOnboarding;
4
+ const common_1 = require("./common");
4
5
  function renderOnboarding() {
5
- return `
6
- <!-- agent-update:start:onboarding-guide -->
7
- # Onboarding Guide
6
+ const content = `# Onboarding Guide
8
7
 
9
8
  Welcome to the team! This guide will help you get set up and productive quickly.
10
9
 
@@ -406,26 +405,7 @@ We're always improving! Please provide feedback on:
406
405
  - Update this guide as you find gaps
407
406
  - Ask in #engineering if something is unclear
408
407
  - Your feedback helps future team members!
409
-
410
- <!-- agent-readonly:guidance -->
411
- ## AI Update Checklist
412
- 1. Verify all tool versions and installation instructions are current
413
- 2. Update access request contacts with current team members
414
- 3. Ensure all documentation links are valid
415
- 4. Add new accounts or tools that team members need
416
- 5. Update team communication channels and meeting schedules
417
- 6. Refresh learning resources with current recommendations
418
- 7. Verify suggested first issues are still appropriate
419
-
420
- <!-- agent-readonly:sources -->
421
- ## Acceptable Sources
422
- - Development environment setup scripts and documentation
423
- - Team wiki or handbook
424
- - IT/DevOps onboarding documentation
425
- - Feedback from recent new hires
426
- - Repository README and CONTRIBUTING files
427
-
428
- <!-- agent-update:end -->
429
408
  `;
409
+ return (0, common_1.wrapWithFrontMatter)(content);
430
410
  }
431
411
  //# sourceMappingURL=onboardingTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"onboardingTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/onboardingTemplate.ts"],"names":[],"mappings":";;AACA,4CA2aC;AA3aD,SAAgB,gBAAgB;IAE9B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwaR,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"onboardingTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/onboardingTemplate.ts"],"names":[],"mappings":";;AAEA,4CAsZC;AAxZD,qCAA+C;AAE/C,SAAgB,gBAAgB;IAC9B,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkZjB,CAAC;IAEA,OAAO,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;AACtC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"projectOverviewTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/projectOverviewTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAGvD,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CA6DnF"}
1
+ {"version":3,"file":"projectOverviewTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/projectOverviewTemplate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAmDvD,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CAyDnF"}
@@ -1,65 +1,131 @@
1
1
  "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
2
35
  Object.defineProperty(exports, "__esModule", { value: true });
3
36
  exports.renderProjectOverview = renderProjectOverview;
37
+ const path = __importStar(require("path"));
4
38
  const common_1 = require("./common");
39
+ function renderEntryPointsSection(context) {
40
+ const { semantics, repoStructure } = context;
41
+ if (!semantics || !semantics.architecture.entryPoints.length) {
42
+ return '- *No entry points detected.*';
43
+ }
44
+ const repoRoot = repoStructure.rootPath;
45
+ return semantics.architecture.entryPoints.map(ep => {
46
+ const relPath = path.relative(repoRoot, ep);
47
+ return `- [\`${relPath}\`](${relPath})`;
48
+ }).join('\n');
49
+ }
50
+ function renderKeyExportsSection(context) {
51
+ const { semantics, repoStructure } = context;
52
+ if (!semantics) {
53
+ return '- *No key exports detected.*';
54
+ }
55
+ const repoRoot = repoStructure.rootPath;
56
+ // Get exported classes and interfaces
57
+ const classes = semantics.symbols.classes
58
+ .filter(s => s.exported);
59
+ const interfaces = semantics.symbols.interfaces
60
+ .filter(s => s.exported);
61
+ const lines = [];
62
+ if (classes.length > 0) {
63
+ lines.push('**Classes:**');
64
+ lines.push((0, common_1.buildSymbolList)(classes, repoRoot, false));
65
+ }
66
+ if (interfaces.length > 0) {
67
+ if (lines.length > 0)
68
+ lines.push('');
69
+ lines.push('**Interfaces:**');
70
+ lines.push((0, common_1.buildSymbolList)(interfaces, repoRoot, false));
71
+ }
72
+ if (lines.length === 0) {
73
+ return '- *No major exports detected.*';
74
+ }
75
+ return lines.join('\n');
76
+ }
5
77
  function renderProjectOverview(context) {
6
78
  const directoryList = (0, common_1.formatDirectoryList)(context, true);
7
79
  const languageSummary = context.primaryLanguages.length > 0
8
80
  ? context.primaryLanguages.map(lang => `- ${lang.extension} (${lang.count} files)`).join('\n')
9
81
  : '- Language mix pending analysis.';
10
- return `
11
- <!-- agent-update:start:project-overview -->
12
- # Project Overview
82
+ const entryPointsSection = renderEntryPointsSection(context);
83
+ const keyExportsSection = renderKeyExportsSection(context);
84
+ const content = `# Project Overview
13
85
 
14
- > TODO: Summarize the problem this project solves and who benefits from it.
86
+ Summarize the problem this project solves and who benefits from it.
15
87
 
16
88
  ## Quick Facts
89
+
17
90
  - Root path: \`${context.repoStructure.rootPath}\`
18
91
  - Primary languages detected:
19
92
  ${languageSummary}
20
93
 
94
+ ## Entry Points
95
+ ${entryPointsSection}
96
+
97
+ ## Key Exports
98
+ ${keyExportsSection}
99
+
21
100
  ## File Structure & Code Organization
22
101
  ${directoryList || '*Add a short description for each relevant directory.*'}
23
102
 
24
103
  ## Technology Stack Summary
25
- - Outline primary runtimes, languages, and platforms in use.
26
- - Note build tooling, linting, and formatting infrastructure the team relies on.
104
+
105
+ Outline primary runtimes, languages, and platforms in use. Note build tooling, linting, and formatting infrastructure the team relies on.
27
106
 
28
107
  ## Core Framework Stack
29
- - Document core frameworks per layer (backend, frontend, data, messaging).
30
- - Mention architectural patterns enforced by these frameworks.
108
+
109
+ Document core frameworks per layer (backend, frontend, data, messaging). Mention architectural patterns enforced by these frameworks.
31
110
 
32
111
  ## UI & Interaction Libraries
33
- - List UI kits, CLI interaction helpers, or design system dependencies.
34
- - Note theming, accessibility, or localization considerations contributors must follow.
112
+
113
+ List UI kits, CLI interaction helpers, or design system dependencies. Note theming, accessibility, or localization considerations contributors must follow.
35
114
 
36
115
  ## Development Tools Overview
37
- - Highlight essential CLIs, scripts, or developer environments.
38
- - Link to [Tooling & Productivity Guide](./tooling.md) for deeper setup instructions.
116
+
117
+ Highlight essential CLIs, scripts, or developer environments. Link to [Tooling & Productivity Guide](./tooling.md) for deeper setup instructions.
39
118
 
40
119
  ## Getting Started Checklist
120
+
41
121
  1. Install dependencies with \`npm install\`.
42
122
  2. Explore the CLI by running \`npm run dev\`.
43
123
  3. Review [Development Workflow](./development-workflow.md) for day-to-day tasks.
44
124
 
45
125
  ## Next Steps
46
- Capture product positioning, key stakeholders, and links to external documentation or product specs here.
47
126
 
48
- <!-- agent-readonly:guidance -->
49
- ## AI Update Checklist
50
- 1. Review roadmap items or issues labelled “release” to confirm current goals.
51
- 2. Cross-check Quick Facts against \`package.json\` and environment docs.
52
- 3. Refresh the File Structure & Code Organization section to reflect new or retired modules; keep guidance actionable.
53
- 4. Link critical dashboards, specs, or runbooks used by the team.
54
- 5. Flag any details that require human confirmation (e.g., stakeholder ownership).
55
-
56
- <!-- agent-readonly:sources -->
57
- ## Acceptable Sources
58
- - Recent commits, release notes, or ADRs describing high-level changes.
59
- - Product requirement documents linked from this repository.
60
- - Confirmed statements from maintainers or product leads.
61
-
62
- <!-- agent-update:end -->
127
+ Capture product positioning, key stakeholders, and links to external documentation or product specs here.
63
128
  `;
129
+ return (0, common_1.wrapWithFrontMatter)(content);
64
130
  }
65
131
  //# sourceMappingURL=projectOverviewTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"projectOverviewTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/projectOverviewTemplate.ts"],"names":[],"mappings":";;AAGA,sDA6DC;AA/DD,qCAA+C;AAE/C,SAAgB,qBAAqB,CAAC,OAAqC;IAEzE,MAAM,aAAa,GAAG,IAAA,4BAAmB,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACzD,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC;QACzD,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAC9F,CAAC,CAAC,kCAAkC,CAAC;IAEvC,OAAO;;;;;;;iBAOQ,OAAO,CAAC,aAAa,CAAC,QAAQ;;EAE7C,eAAe;;;EAGf,aAAa,IAAI,wDAAwD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyC1E,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"projectOverviewTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/projectOverviewTemplate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoDA,sDAyDC;AA7GD,2CAA6B;AAE7B,qCAAsG;AAEtG,SAAS,wBAAwB,CAAC,OAAqC;IACrE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAC7C,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAC7D,OAAO,+BAA+B,CAAC;IACzC,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;IACxC,OAAO,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;QACjD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC5C,OAAO,QAAQ,OAAO,OAAO,OAAO,GAAG,CAAC;IAC1C,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,SAAS,uBAAuB,CAAC,OAAqC;IACpE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAC7C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,8BAA8B,CAAC;IACxC,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;IAExC,sCAAsC;IACtC,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO;SACtC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAE3B,MAAM,UAAU,GAAG,SAAS,CAAC,OAAO,CAAC,UAAU;SAC5C,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAE3B,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,IAAA,wBAAe,EAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrC,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,IAAA,wBAAe,EAAC,UAAU,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,gCAAgC,CAAC;IAC1C,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAgB,qBAAqB,CAAC,OAAqC;IAEzE,MAAM,aAAa,GAAG,IAAA,4BAAmB,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACzD,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC;QACzD,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAC9F,CAAC,CAAC,kCAAkC,CAAC;IAEvC,MAAM,kBAAkB,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAC7D,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAE3D,MAAM,OAAO,GAAG;;;;;;iBAMD,OAAO,CAAC,aAAa,CAAC,QAAQ;;EAE7C,eAAe;;;EAGf,kBAAkB;;;EAGlB,iBAAiB;;;EAGjB,aAAa,IAAI,wDAAwD;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2B1E,CAAC;IAEA,OAAO,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;AACtC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"securityTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/securityTemplate.ts"],"names":[],"mappings":"AACA,wBAAgB,cAAc,IAAI,MAAM,CAmCvC"}
1
+ {"version":3,"file":"securityTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/securityTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,cAAc,IAAI,MAAM,CAuBvC"}
@@ -1,39 +1,28 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderSecurity = renderSecurity;
4
+ const common_1 = require("./common");
4
5
  function renderSecurity() {
5
- return `
6
- <!-- agent-update:start:security -->
7
- # Security & Compliance Notes
6
+ const content = `# Security & Compliance Notes
8
7
 
9
8
  Capture the policies and guardrails that keep this project secure and compliant.
10
9
 
11
10
  ## Authentication & Authorization
12
- - Describe identity providers, token formats, session strategies, and role/permission models.
11
+
12
+ Describe identity providers, token formats, session strategies, and role/permission models.
13
13
 
14
14
  ## Secrets & Sensitive Data
15
- - Storage locations (vaults, parameter stores), rotation cadence, encryption practices, and data classifications.
15
+
16
+ Document storage locations (vaults, parameter stores), rotation cadence, encryption practices, and data classifications.
16
17
 
17
18
  ## Compliance & Policies
18
- - Applicable standards (GDPR, SOC2, HIPAA, internal policies) and evidence requirements.
19
+
20
+ List applicable standards (GDPR, SOC2, HIPAA, internal policies) and evidence requirements.
19
21
 
20
22
  ## Incident Response
21
- - On-call contacts, escalation steps, and tooling for detection, triage, and post-incident analysis.
22
-
23
- <!-- agent-readonly:guidance -->
24
- ## AI Update Checklist
25
- 1. Confirm security libraries and infrastructure match current deployments.
26
- 2. Update secrets management details when storage or naming changes.
27
- 3. Reflect new compliance obligations or audit findings.
28
- 4. Ensure incident response procedures include current contacts and tooling.
29
-
30
- <!-- agent-readonly:sources -->
31
- ## Acceptable Sources
32
- - Security architecture docs, runbooks, policy handbooks.
33
- - IAM/authorization configuration (code or infrastructure).
34
- - Compliance updates from security or legal teams.
35
-
36
- <!-- agent-update:end -->
23
+
24
+ Note on-call contacts, escalation steps, and tooling for detection, triage, and post-incident analysis.
37
25
  `;
26
+ return (0, common_1.wrapWithFrontMatter)(content);
38
27
  }
39
28
  //# sourceMappingURL=securityTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"securityTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/securityTemplate.ts"],"names":[],"mappings":";;AACA,wCAmCC;AAnCD,SAAgB,cAAc;IAE5B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgCR,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"securityTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/securityTemplate.ts"],"names":[],"mappings":";;AAEA,wCAuBC;AAzBD,qCAA+C;AAE/C,SAAgB,cAAc;IAC5B,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;CAmBjB,CAAC;IAEA,OAAO,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;AACtC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"testingTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/testingTemplate.ts"],"names":[],"mappings":"AACA,wBAAgB,qBAAqB,IAAI,MAAM,CAyC9C"}
1
+ {"version":3,"file":"testingTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/testingTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,qBAAqB,IAAI,MAAM,CAyB9C"}
@@ -1,10 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderTestingStrategy = renderTestingStrategy;
4
+ const common_1 = require("./common");
4
5
  function renderTestingStrategy() {
5
- return `
6
- <!-- agent-update:start:testing-strategy -->
7
- # Testing Strategy
6
+ const content = `# Testing Strategy
8
7
 
9
8
  Document how quality is maintained across the codebase.
10
9
 
@@ -23,23 +22,9 @@ Document how quality is maintained across the codebase.
23
22
  - Capture linting or formatting requirements before merging.
24
23
 
25
24
  ## Troubleshooting
26
- - Document flaky suites, long-running tests, or environment quirks.
27
25
 
28
- <!-- agent-readonly:guidance -->
29
- ## AI Update Checklist
30
- 1. Review test scripts and CI workflows to confirm command accuracy.
31
- 2. Update Quality Gates with current thresholds (coverage %, lint rules, required checks).
32
- 3. Document new test categories or suites introduced since the last update.
33
- 4. Record known flaky areas and link to open issues for visibility.
34
- 5. Confirm troubleshooting steps remain valid with current tooling.
35
-
36
- <!-- agent-readonly:sources -->
37
- ## Acceptable Sources
38
- - \`package.json\` scripts and testing configuration files.
39
- - CI job definitions (GitHub Actions, CircleCI, etc.).
40
- - Issue tracker items labelled “testing” or “flaky” with maintainer confirmation.
41
-
42
- <!-- agent-update:end -->
26
+ Document flaky suites, long-running tests, or environment quirks.
43
27
  `;
28
+ return (0, common_1.wrapWithFrontMatter)(content);
44
29
  }
45
30
  //# sourceMappingURL=testingTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"testingTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/testingTemplate.ts"],"names":[],"mappings":";;AACA,sDAyCC;AAzCD,SAAgB,qBAAqB;IAEnC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsCR,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"testingTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/testingTemplate.ts"],"names":[],"mappings":";;AAEA,sDAyBC;AA3BD,qCAA+C;AAE/C,SAAgB,qBAAqB;IACnC,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;CAqBjB,CAAC;IAEA,OAAO,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;AACtC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"toolingTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/toolingTemplate.ts"],"names":[],"mappings":"AACA,wBAAgB,kBAAkB,IAAI,MAAM,CAsC3C"}
1
+ {"version":3,"file":"toolingTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/toolingTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,kBAAkB,IAAI,MAAM,CAuB3C"}