observer-ggboy-bmad-method 6.0.0-alpha.23

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 (604) hide show
  1. package/.coderabbit.yaml +40 -0
  2. package/.github/CODE_OF_CONDUCT.md +128 -0
  3. package/.github/FUNDING.yaml +15 -0
  4. package/.github/ISSUE_TEMPLATE/config.yaml +8 -0
  5. package/.github/ISSUE_TEMPLATE/feature_request.md +22 -0
  6. package/.github/ISSUE_TEMPLATE/issue.md +32 -0
  7. package/.github/scripts/discord-helpers.sh +34 -0
  8. package/.github/workflows/bundle-latest.yaml +330 -0
  9. package/.github/workflows/discord.yaml +90 -0
  10. package/.github/workflows/docs.yaml +63 -0
  11. package/.github/workflows/manual-release.yaml +190 -0
  12. package/.github/workflows/quality.yaml +115 -0
  13. package/.health-status.json +7 -0
  14. package/.husky/pre-commit +20 -0
  15. package/.markdownlint-cli2.yaml +41 -0
  16. package/.nvmrc +1 -0
  17. package/.prettierignore +9 -0
  18. package/.vscode/settings.json +97 -0
  19. package/CHANGELOG.md +1394 -0
  20. package/CNAME +1 -0
  21. package/CONTRIBUTING.md +167 -0
  22. package/CONTRIBUTORS.md +32 -0
  23. package/LICENSE +30 -0
  24. package/README.md +100 -0
  25. package/SECURITY.md +85 -0
  26. package/TRADEMARK.md +55 -0
  27. package/Wordmark.png +0 -0
  28. package/banner-bmad-method.png +0 -0
  29. package/bmad-method-6.0.0-alpha.23.tgz +0 -0
  30. package/docs/404.md +9 -0
  31. package/docs/_README_WORKFLOW_DIAGRAMS.md +40 -0
  32. package/docs/_STYLE_GUIDE.md +367 -0
  33. package/docs/_archive/customize-workflows.md +30 -0
  34. package/docs/_archive/getting-started-bmadv4.md +247 -0
  35. package/docs/_archive/vendor-workflows.md +52 -0
  36. package/docs/downloads.md +72 -0
  37. package/docs/explanation/agents/barry-quick-flow.md +328 -0
  38. package/docs/explanation/agents/index.md +19 -0
  39. package/docs/explanation/architecture/four-phases.md +107 -0
  40. package/docs/explanation/architecture/preventing-agent-conflicts.md +111 -0
  41. package/docs/explanation/architecture/why-solutioning-matters.md +75 -0
  42. package/docs/explanation/bmm/index.md +131 -0
  43. package/docs/explanation/core/index.md +18 -0
  44. package/docs/explanation/core-concepts/agent-roles.md +179 -0
  45. package/docs/explanation/core-concepts/index.md +35 -0
  46. package/docs/explanation/core-concepts/what-are-agents.md +97 -0
  47. package/docs/explanation/core-concepts/what-are-modules.md +85 -0
  48. package/docs/explanation/core-concepts/what-are-workflows.md +204 -0
  49. package/docs/explanation/faq/brownfield-faq.md +73 -0
  50. package/docs/explanation/faq/getting-started-faq.md +67 -0
  51. package/docs/explanation/faq/implementation-faq.md +52 -0
  52. package/docs/explanation/faq/index.md +16 -0
  53. package/docs/explanation/faq/levels-and-tracks-faq.md +52 -0
  54. package/docs/explanation/faq/planning-faq.md +41 -0
  55. package/docs/explanation/faq/tools-faq.md +277 -0
  56. package/docs/explanation/faq/workflows-faq.md +61 -0
  57. package/docs/explanation/features/advanced-elicitation.md +95 -0
  58. package/docs/explanation/features/brainstorming-techniques.md +92 -0
  59. package/docs/explanation/features/party-mode.md +95 -0
  60. package/docs/explanation/features/quick-flow.md +149 -0
  61. package/docs/explanation/features/tea-overview.md +410 -0
  62. package/docs/explanation/features/web-bundles.md +34 -0
  63. package/docs/explanation/philosophy/facilitation-over-generation.md +333 -0
  64. package/docs/explanation/philosophy/testing-as-engineering.md +112 -0
  65. package/docs/explanation/tea/engagement-models.md +710 -0
  66. package/docs/explanation/tea/fixture-architecture.md +457 -0
  67. package/docs/explanation/tea/knowledge-base-system.md +554 -0
  68. package/docs/explanation/tea/network-first-patterns.md +853 -0
  69. package/docs/explanation/tea/risk-based-testing.md +586 -0
  70. package/docs/explanation/tea/test-quality-standards.md +907 -0
  71. package/docs/how-to/brownfield/add-feature-to-existing.md +74 -0
  72. package/docs/how-to/brownfield/document-existing-project.md +66 -0
  73. package/docs/how-to/brownfield/index.md +84 -0
  74. package/docs/how-to/brownfield/quick-fix-in-brownfield.md +77 -0
  75. package/docs/how-to/brownfield/use-tea-for-enterprise.md +525 -0
  76. package/docs/how-to/brownfield/use-tea-with-existing-tests.md +577 -0
  77. package/docs/how-to/customization/customize-agents.md +212 -0
  78. package/docs/how-to/customization/enable-tea-mcp-enhancements.md +424 -0
  79. package/docs/how-to/customization/index.md +23 -0
  80. package/docs/how-to/customization/integrate-playwright-utils.md +813 -0
  81. package/docs/how-to/customization/shard-large-documents.md +101 -0
  82. package/docs/how-to/get-answers-about-bmad.md +102 -0
  83. package/docs/how-to/installation/index.md +12 -0
  84. package/docs/how-to/installation/install-bmad.md +111 -0
  85. package/docs/how-to/installation/install-custom-modules.md +118 -0
  86. package/docs/how-to/installation/upgrade-to-v6.md +131 -0
  87. package/docs/how-to/workflows/bmgd-quick-flow.md +156 -0
  88. package/docs/how-to/workflows/conduct-research.md +97 -0
  89. package/docs/how-to/workflows/create-architecture.md +119 -0
  90. package/docs/how-to/workflows/create-epics-and-stories.md +109 -0
  91. package/docs/how-to/workflows/create-prd.md +91 -0
  92. package/docs/how-to/workflows/create-product-brief.md +94 -0
  93. package/docs/how-to/workflows/create-story.md +102 -0
  94. package/docs/how-to/workflows/create-ux-design.md +100 -0
  95. package/docs/how-to/workflows/implement-story.md +97 -0
  96. package/docs/how-to/workflows/quick-spec.md +122 -0
  97. package/docs/how-to/workflows/run-atdd.md +436 -0
  98. package/docs/how-to/workflows/run-automate.md +653 -0
  99. package/docs/how-to/workflows/run-brainstorming-session.md +73 -0
  100. package/docs/how-to/workflows/run-code-review.md +89 -0
  101. package/docs/how-to/workflows/run-implementation-readiness.md +125 -0
  102. package/docs/how-to/workflows/run-nfr-assess.md +679 -0
  103. package/docs/how-to/workflows/run-sprint-planning.md +94 -0
  104. package/docs/how-to/workflows/run-test-design.md +135 -0
  105. package/docs/how-to/workflows/run-test-review.md +605 -0
  106. package/docs/how-to/workflows/run-trace.md +883 -0
  107. package/docs/how-to/workflows/setup-ci.md +712 -0
  108. package/docs/how-to/workflows/setup-party-mode.md +89 -0
  109. package/docs/how-to/workflows/setup-test-framework.md +98 -0
  110. package/docs/index.md +63 -0
  111. package/docs/reference/agents/index.md +109 -0
  112. package/docs/reference/configuration/core-tasks.md +67 -0
  113. package/docs/reference/configuration/global-config.md +28 -0
  114. package/docs/reference/glossary/index.md +159 -0
  115. package/docs/reference/tea/commands.md +276 -0
  116. package/docs/reference/tea/configuration.md +678 -0
  117. package/docs/reference/tea/knowledge-base.md +340 -0
  118. package/docs/reference/workflows/core-workflows.md +32 -0
  119. package/docs/reference/workflows/document-project.md +73 -0
  120. package/docs/reference/workflows/index.md +12 -0
  121. package/docs/tutorials/getting-started/getting-started-bmadv6.md +246 -0
  122. package/docs/tutorials/getting-started/images/workflow-method-greenfield.excalidraw +5034 -0
  123. package/docs/tutorials/getting-started/images/workflow-method-greenfield.svg +4 -0
  124. package/docs/tutorials/getting-started/images/workflow-overview.jpg +0 -0
  125. package/docs/tutorials/getting-started/tea-lite-quickstart.md +444 -0
  126. package/docs/tutorials/getting-started/workflow-overview.jpg +0 -0
  127. package/eslint.config.mjs +152 -0
  128. package/package.json +117 -0
  129. package/prettier.config.mjs +32 -0
  130. package/src/bmm/_module-installer/installer.js +48 -0
  131. package/src/bmm/_module-installer/platform-specifics/claude-code.js +35 -0
  132. package/src/bmm/_module-installer/platform-specifics/windsurf.js +32 -0
  133. package/src/bmm/agents/analyst.agent.yaml +36 -0
  134. package/src/bmm/agents/architect.agent.yaml +28 -0
  135. package/src/bmm/agents/dev.agent.yaml +38 -0
  136. package/src/bmm/agents/pm.agent.yaml +46 -0
  137. package/src/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -0
  138. package/src/bmm/agents/sm.agent.yaml +36 -0
  139. package/src/bmm/agents/tea.agent.yaml +63 -0
  140. package/src/bmm/agents/tech-writer/tech-writer-sidecar/documentation-standards.md +224 -0
  141. package/src/bmm/agents/tech-writer/tech-writer.agent.yaml +45 -0
  142. package/src/bmm/agents/ux-designer.agent.yaml +26 -0
  143. package/src/bmm/data/project-context-template.md +26 -0
  144. package/src/bmm/module-help.csv +32 -0
  145. package/src/bmm/module.yaml +44 -0
  146. package/src/bmm/sub-modules/claude-code/config.yaml +4 -0
  147. package/src/bmm/sub-modules/claude-code/injections.yaml +242 -0
  148. package/src/bmm/sub-modules/claude-code/readme.md +87 -0
  149. package/src/bmm/teams/default-party.csv +21 -0
  150. package/src/bmm/teams/team-fullstack.yaml +12 -0
  151. package/src/bmm/testarch/knowledge/adr-quality-readiness-checklist.md +350 -0
  152. package/src/bmm/testarch/knowledge/api-request.md +442 -0
  153. package/src/bmm/testarch/knowledge/api-testing-patterns.md +843 -0
  154. package/src/bmm/testarch/knowledge/auth-session.md +552 -0
  155. package/src/bmm/testarch/knowledge/burn-in.md +273 -0
  156. package/src/bmm/testarch/knowledge/ci-burn-in.md +675 -0
  157. package/src/bmm/testarch/knowledge/component-tdd.md +486 -0
  158. package/src/bmm/testarch/knowledge/contract-testing.md +957 -0
  159. package/src/bmm/testarch/knowledge/data-factories.md +500 -0
  160. package/src/bmm/testarch/knowledge/email-auth.md +721 -0
  161. package/src/bmm/testarch/knowledge/error-handling.md +725 -0
  162. package/src/bmm/testarch/knowledge/feature-flags.md +750 -0
  163. package/src/bmm/testarch/knowledge/file-utils.md +463 -0
  164. package/src/bmm/testarch/knowledge/fixture-architecture.md +401 -0
  165. package/src/bmm/testarch/knowledge/fixtures-composition.md +382 -0
  166. package/src/bmm/testarch/knowledge/intercept-network-call.md +430 -0
  167. package/src/bmm/testarch/knowledge/log.md +429 -0
  168. package/src/bmm/testarch/knowledge/network-error-monitor.md +405 -0
  169. package/src/bmm/testarch/knowledge/network-first.md +486 -0
  170. package/src/bmm/testarch/knowledge/network-recorder.md +527 -0
  171. package/src/bmm/testarch/knowledge/nfr-criteria.md +670 -0
  172. package/src/bmm/testarch/knowledge/overview.md +286 -0
  173. package/src/bmm/testarch/knowledge/playwright-config.md +730 -0
  174. package/src/bmm/testarch/knowledge/probability-impact.md +601 -0
  175. package/src/bmm/testarch/knowledge/recurse.md +421 -0
  176. package/src/bmm/testarch/knowledge/risk-governance.md +615 -0
  177. package/src/bmm/testarch/knowledge/selective-testing.md +732 -0
  178. package/src/bmm/testarch/knowledge/selector-resilience.md +527 -0
  179. package/src/bmm/testarch/knowledge/test-healing-patterns.md +644 -0
  180. package/src/bmm/testarch/knowledge/test-levels-framework.md +473 -0
  181. package/src/bmm/testarch/knowledge/test-priorities-matrix.md +373 -0
  182. package/src/bmm/testarch/knowledge/test-quality.md +664 -0
  183. package/src/bmm/testarch/knowledge/timing-debugging.md +372 -0
  184. package/src/bmm/testarch/knowledge/visual-debugging.md +524 -0
  185. package/src/bmm/testarch/tea-index.csv +35 -0
  186. package/src/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -0
  187. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +177 -0
  188. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +161 -0
  189. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +199 -0
  190. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +202 -0
  191. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +205 -0
  192. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +219 -0
  193. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +162 -0
  194. package/src/bmm/workflows/1-analysis/create-product-brief/workflow.md +58 -0
  195. package/src/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -0
  196. package/src/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -0
  197. package/src/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -0
  198. package/src/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -0
  199. package/src/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -0
  200. package/src/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -0
  201. package/src/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -0
  202. package/src/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -0
  203. package/src/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +200 -0
  204. package/src/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -0
  205. package/src/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -0
  206. package/src/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -0
  207. package/src/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -0
  208. package/src/bmm/workflows/1-analysis/research/research.template.md +29 -0
  209. package/src/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -0
  210. package/src/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -0
  211. package/src/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -0
  212. package/src/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -0
  213. package/src/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +239 -0
  214. package/src/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -0
  215. package/src/bmm/workflows/1-analysis/research/workflow.md +173 -0
  216. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -0
  217. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -0
  218. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -0
  219. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -0
  220. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -0
  221. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -0
  222. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -0
  223. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -0
  224. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -0
  225. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -0
  226. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -0
  227. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -0
  228. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -0
  229. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -0
  230. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +171 -0
  231. package/src/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -0
  232. package/src/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +43 -0
  233. package/src/bmm/workflows/2-plan-workflows/prd/data/domain-complexity.csv +13 -0
  234. package/src/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md +197 -0
  235. package/src/bmm/workflows/2-plan-workflows/prd/data/project-types.csv +11 -0
  236. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md +191 -0
  237. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md +153 -0
  238. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md +224 -0
  239. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md +226 -0
  240. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md +213 -0
  241. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md +207 -0
  242. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md +226 -0
  243. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md +237 -0
  244. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md +228 -0
  245. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md +231 -0
  246. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md +242 -0
  247. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md +217 -0
  248. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md +124 -0
  249. package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md +247 -0
  250. package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md +208 -0
  251. package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md +249 -0
  252. package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md +253 -0
  253. package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md +168 -0
  254. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md +218 -0
  255. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md +191 -0
  256. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md +209 -0
  257. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md +174 -0
  258. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md +214 -0
  259. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md +228 -0
  260. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md +217 -0
  261. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md +205 -0
  262. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md +243 -0
  263. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md +263 -0
  264. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md +209 -0
  265. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md +264 -0
  266. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md +242 -0
  267. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md +231 -0
  268. package/src/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md +10 -0
  269. package/src/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +433 -0
  270. package/src/bmm/workflows/2-plan-workflows/prd/workflow.md +150 -0
  271. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +190 -0
  272. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +178 -0
  273. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +179 -0
  274. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +139 -0
  275. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +252 -0
  276. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +135 -0
  277. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -0
  278. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +55 -0
  279. package/src/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -0
  280. package/src/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +11 -0
  281. package/src/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +7 -0
  282. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +153 -0
  283. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -0
  284. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -0
  285. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +331 -0
  286. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +318 -0
  287. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +359 -0
  288. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -0
  289. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +359 -0
  290. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +76 -0
  291. package/src/bmm/workflows/3-solutioning/create-architecture/workflow.md +50 -0
  292. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -0
  293. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -0
  294. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -0
  295. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +149 -0
  296. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -0
  297. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +59 -0
  298. package/src/bmm/workflows/4-implementation/code-review/checklist.md +23 -0
  299. package/src/bmm/workflows/4-implementation/code-review/instructions.xml +227 -0
  300. package/src/bmm/workflows/4-implementation/code-review/workflow.yaml +51 -0
  301. package/src/bmm/workflows/4-implementation/correct-course/checklist.md +288 -0
  302. package/src/bmm/workflows/4-implementation/correct-course/instructions.md +206 -0
  303. package/src/bmm/workflows/4-implementation/correct-course/workflow.yaml +60 -0
  304. package/src/bmm/workflows/4-implementation/create-story/checklist.md +358 -0
  305. package/src/bmm/workflows/4-implementation/create-story/instructions.xml +345 -0
  306. package/src/bmm/workflows/4-implementation/create-story/template.md +49 -0
  307. package/src/bmm/workflows/4-implementation/create-story/workflow.yaml +61 -0
  308. package/src/bmm/workflows/4-implementation/dev-story/checklist.md +80 -0
  309. package/src/bmm/workflows/4-implementation/dev-story/instructions.xml +410 -0
  310. package/src/bmm/workflows/4-implementation/dev-story/workflow.yaml +27 -0
  311. package/src/bmm/workflows/4-implementation/retrospective/instructions.md +1443 -0
  312. package/src/bmm/workflows/4-implementation/retrospective/workflow.yaml +58 -0
  313. package/src/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -0
  314. package/src/bmm/workflows/4-implementation/sprint-planning/instructions.md +225 -0
  315. package/src/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -0
  316. package/src/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +54 -0
  317. package/src/bmm/workflows/4-implementation/sprint-status/instructions.md +229 -0
  318. package/src/bmm/workflows/4-implementation/sprint-status/workflow.yaml +36 -0
  319. package/src/bmm/workflows/bmad-quick-flow/quick-dev/data/project-levels.yaml +59 -0
  320. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +156 -0
  321. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +120 -0
  322. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +113 -0
  323. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +113 -0
  324. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +106 -0
  325. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +140 -0
  326. package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +50 -0
  327. package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +189 -0
  328. package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +144 -0
  329. package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +128 -0
  330. package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +191 -0
  331. package/src/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -0
  332. package/src/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -0
  333. package/src/bmm/workflows/document-project/checklist.md +245 -0
  334. package/src/bmm/workflows/document-project/documentation-requirements.csv +12 -0
  335. package/src/bmm/workflows/document-project/instructions.md +221 -0
  336. package/src/bmm/workflows/document-project/templates/deep-dive-template.md +345 -0
  337. package/src/bmm/workflows/document-project/templates/index-template.md +169 -0
  338. package/src/bmm/workflows/document-project/templates/project-overview-template.md +103 -0
  339. package/src/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -0
  340. package/src/bmm/workflows/document-project/templates/source-tree-template.md +135 -0
  341. package/src/bmm/workflows/document-project/workflow.yaml +30 -0
  342. package/src/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -0
  343. package/src/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -0
  344. package/src/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -0
  345. package/src/bmm/workflows/document-project/workflows/full-scan.yaml +31 -0
  346. package/src/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +90 -0
  347. package/src/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +127 -0
  348. package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +39 -0
  349. package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +130 -0
  350. package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +27 -0
  351. package/src/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +43 -0
  352. package/src/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +141 -0
  353. package/src/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +27 -0
  354. package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +49 -0
  355. package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +241 -0
  356. package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +27 -0
  357. package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +38 -0
  358. package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +133 -0
  359. package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +27 -0
  360. package/src/bmm/workflows/testarch/atdd/atdd-checklist-template.md +363 -0
  361. package/src/bmm/workflows/testarch/atdd/checklist.md +374 -0
  362. package/src/bmm/workflows/testarch/atdd/instructions.md +806 -0
  363. package/src/bmm/workflows/testarch/atdd/workflow.yaml +47 -0
  364. package/src/bmm/workflows/testarch/automate/checklist.md +582 -0
  365. package/src/bmm/workflows/testarch/automate/instructions.md +1324 -0
  366. package/src/bmm/workflows/testarch/automate/workflow.yaml +54 -0
  367. package/src/bmm/workflows/testarch/ci/checklist.md +247 -0
  368. package/src/bmm/workflows/testarch/ci/github-actions-template.yaml +198 -0
  369. package/src/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +149 -0
  370. package/src/bmm/workflows/testarch/ci/instructions.md +536 -0
  371. package/src/bmm/workflows/testarch/ci/workflow.yaml +47 -0
  372. package/src/bmm/workflows/testarch/framework/checklist.md +320 -0
  373. package/src/bmm/workflows/testarch/framework/instructions.md +481 -0
  374. package/src/bmm/workflows/testarch/framework/workflow.yaml +49 -0
  375. package/src/bmm/workflows/testarch/nfr-assess/checklist.md +407 -0
  376. package/src/bmm/workflows/testarch/nfr-assess/instructions.md +726 -0
  377. package/src/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +461 -0
  378. package/src/bmm/workflows/testarch/nfr-assess/workflow.yaml +49 -0
  379. package/src/bmm/workflows/testarch/test-design/checklist.md +407 -0
  380. package/src/bmm/workflows/testarch/test-design/instructions.md +1158 -0
  381. package/src/bmm/workflows/testarch/test-design/test-design-architecture-template.md +213 -0
  382. package/src/bmm/workflows/testarch/test-design/test-design-qa-template.md +286 -0
  383. package/src/bmm/workflows/testarch/test-design/test-design-template.md +294 -0
  384. package/src/bmm/workflows/testarch/test-design/workflow.yaml +71 -0
  385. package/src/bmm/workflows/testarch/test-review/checklist.md +472 -0
  386. package/src/bmm/workflows/testarch/test-review/instructions.md +628 -0
  387. package/src/bmm/workflows/testarch/test-review/test-review-template.md +390 -0
  388. package/src/bmm/workflows/testarch/test-review/workflow.yaml +48 -0
  389. package/src/bmm/workflows/testarch/trace/checklist.md +642 -0
  390. package/src/bmm/workflows/testarch/trace/instructions.md +1030 -0
  391. package/src/bmm/workflows/testarch/trace/trace-template.md +675 -0
  392. package/src/bmm/workflows/testarch/trace/workflow.yaml +57 -0
  393. package/src/core/_module-installer/installer.js +60 -0
  394. package/src/core/agents/bmad-master.agent.yaml +29 -0
  395. package/src/core/module-help.csv +9 -0
  396. package/src/core/module.yaml +25 -0
  397. package/src/core/resources/excalidraw/README.md +160 -0
  398. package/src/core/resources/excalidraw/excalidraw-helpers.md +127 -0
  399. package/src/core/resources/excalidraw/library-loader.md +50 -0
  400. package/src/core/resources/excalidraw/validate-json-instructions.md +79 -0
  401. package/src/core/tasks/editorial-review-prose.xml +100 -0
  402. package/src/core/tasks/editorial-review-structure.xml +209 -0
  403. package/src/core/tasks/help.md +62 -0
  404. package/src/core/tasks/index-docs.xml +65 -0
  405. package/src/core/tasks/review-adversarial-general.xml +48 -0
  406. package/src/core/tasks/shard-doc.xml +109 -0
  407. package/src/core/tasks/workflow.xml +235 -0
  408. package/src/core/workflows/advanced-elicitation/methods.csv +51 -0
  409. package/src/core/workflows/advanced-elicitation/workflow.xml +117 -0
  410. package/src/core/workflows/brainstorming/brain-methods.csv +62 -0
  411. package/src/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -0
  412. package/src/core/workflows/brainstorming/steps/step-01b-continue.md +122 -0
  413. package/src/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -0
  414. package/src/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -0
  415. package/src/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -0
  416. package/src/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -0
  417. package/src/core/workflows/brainstorming/steps/step-03-technique-execution.md +399 -0
  418. package/src/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -0
  419. package/src/core/workflows/brainstorming/template.md +15 -0
  420. package/src/core/workflows/brainstorming/workflow.md +58 -0
  421. package/src/core/workflows/party-mode/steps/step-01-agent-loading.md +138 -0
  422. package/src/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +187 -0
  423. package/src/core/workflows/party-mode/steps/step-03-graceful-exit.md +157 -0
  424. package/src/core/workflows/party-mode/workflow.md +194 -0
  425. package/src/utility/agent-components/activation-rules.txt +6 -0
  426. package/src/utility/agent-components/activation-steps.txt +14 -0
  427. package/src/utility/agent-components/agent-command-header.md +1 -0
  428. package/src/utility/agent-components/agent.customize.template.yaml +41 -0
  429. package/src/utility/agent-components/handler-action.txt +4 -0
  430. package/src/utility/agent-components/handler-data.txt +5 -0
  431. package/src/utility/agent-components/handler-exec.txt +6 -0
  432. package/src/utility/agent-components/handler-multi.txt +14 -0
  433. package/src/utility/agent-components/handler-tmpl.txt +5 -0
  434. package/src/utility/agent-components/handler-validate-workflow.txt +7 -0
  435. package/src/utility/agent-components/handler-workflow.txt +10 -0
  436. package/src/utility/agent-components/menu-handlers.txt +6 -0
  437. package/test/README.md +295 -0
  438. package/test/adversarial-review-tests/README.md +56 -0
  439. package/test/adversarial-review-tests/sample-content.md +46 -0
  440. package/test/adversarial-review-tests/test-cases.yaml +103 -0
  441. package/test/fixtures/agent-schema/invalid/critical-actions/actions-as-string.agent.yaml +27 -0
  442. package/test/fixtures/agent-schema/invalid/critical-actions/empty-string-in-actions.agent.yaml +30 -0
  443. package/test/fixtures/agent-schema/invalid/menu/empty-menu.agent.yaml +22 -0
  444. package/test/fixtures/agent-schema/invalid/menu/missing-menu.agent.yaml +20 -0
  445. package/test/fixtures/agent-schema/invalid/menu-commands/empty-command-target.agent.yaml +25 -0
  446. package/test/fixtures/agent-schema/invalid/menu-commands/no-command-target.agent.yaml +24 -0
  447. package/test/fixtures/agent-schema/invalid/menu-triggers/camel-case.agent.yaml +25 -0
  448. package/test/fixtures/agent-schema/invalid/menu-triggers/compound-invalid-format.agent.yaml +25 -0
  449. package/test/fixtures/agent-schema/invalid/menu-triggers/compound-mismatched-kebab.agent.yaml +25 -0
  450. package/test/fixtures/agent-schema/invalid/menu-triggers/duplicate-triggers.agent.yaml +31 -0
  451. package/test/fixtures/agent-schema/invalid/menu-triggers/empty-trigger.agent.yaml +25 -0
  452. package/test/fixtures/agent-schema/invalid/menu-triggers/leading-asterisk.agent.yaml +25 -0
  453. package/test/fixtures/agent-schema/invalid/menu-triggers/snake-case.agent.yaml +25 -0
  454. package/test/fixtures/agent-schema/invalid/menu-triggers/trigger-with-spaces.agent.yaml +25 -0
  455. package/test/fixtures/agent-schema/invalid/metadata/empty-module-string.agent.yaml +26 -0
  456. package/test/fixtures/agent-schema/invalid/metadata/empty-name.agent.yaml +24 -0
  457. package/test/fixtures/agent-schema/invalid/metadata/extra-metadata-fields.agent.yaml +27 -0
  458. package/test/fixtures/agent-schema/invalid/metadata/missing-id.agent.yaml +23 -0
  459. package/test/fixtures/agent-schema/invalid/persona/empty-principles-array.agent.yaml +24 -0
  460. package/test/fixtures/agent-schema/invalid/persona/empty-string-in-principles.agent.yaml +27 -0
  461. package/test/fixtures/agent-schema/invalid/persona/extra-persona-fields.agent.yaml +27 -0
  462. package/test/fixtures/agent-schema/invalid/persona/missing-role.agent.yaml +24 -0
  463. package/test/fixtures/agent-schema/invalid/prompts/empty-content.agent.yaml +29 -0
  464. package/test/fixtures/agent-schema/invalid/prompts/extra-prompt-fields.agent.yaml +31 -0
  465. package/test/fixtures/agent-schema/invalid/prompts/missing-content.agent.yaml +28 -0
  466. package/test/fixtures/agent-schema/invalid/prompts/missing-id.agent.yaml +28 -0
  467. package/test/fixtures/agent-schema/invalid/top-level/empty-file.agent.yaml +5 -0
  468. package/test/fixtures/agent-schema/invalid/top-level/extra-top-level-keys.agent.yaml +28 -0
  469. package/test/fixtures/agent-schema/invalid/top-level/missing-agent-key.agent.yaml +11 -0
  470. package/test/fixtures/agent-schema/invalid/yaml-errors/invalid-indentation.agent.yaml +19 -0
  471. package/test/fixtures/agent-schema/invalid/yaml-errors/malformed-yaml.agent.yaml +18 -0
  472. package/test/fixtures/agent-schema/valid/critical-actions/empty-critical-actions.agent.yaml +24 -0
  473. package/test/fixtures/agent-schema/valid/critical-actions/no-critical-actions.agent.yaml +22 -0
  474. package/test/fixtures/agent-schema/valid/critical-actions/valid-critical-actions.agent.yaml +27 -0
  475. package/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml +31 -0
  476. package/test/fixtures/agent-schema/valid/menu/single-menu-item.agent.yaml +22 -0
  477. package/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml +38 -0
  478. package/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml +24 -0
  479. package/test/fixtures/agent-schema/valid/menu-triggers/compound-triggers.agent.yaml +31 -0
  480. package/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml +34 -0
  481. package/test/fixtures/agent-schema/valid/metadata/core-agent-with-module.agent.yaml +24 -0
  482. package/test/fixtures/agent-schema/valid/metadata/empty-module-name-in-path.agent.yaml +24 -0
  483. package/test/fixtures/agent-schema/valid/metadata/malformed-path-treated-as-core.agent.yaml +24 -0
  484. package/test/fixtures/agent-schema/valid/metadata/module-agent-correct.agent.yaml +24 -0
  485. package/test/fixtures/agent-schema/valid/metadata/module-agent-missing-module.agent.yaml +23 -0
  486. package/test/fixtures/agent-schema/valid/metadata/wrong-module-value.agent.yaml +24 -0
  487. package/test/fixtures/agent-schema/valid/persona/complete-persona.agent.yaml +24 -0
  488. package/test/fixtures/agent-schema/valid/prompts/empty-prompts.agent.yaml +24 -0
  489. package/test/fixtures/agent-schema/valid/prompts/no-prompts.agent.yaml +22 -0
  490. package/test/fixtures/agent-schema/valid/prompts/valid-prompts-minimal.agent.yaml +28 -0
  491. package/test/fixtures/agent-schema/valid/prompts/valid-prompts-with-description.agent.yaml +30 -0
  492. package/test/fixtures/agent-schema/valid/top-level/minimal-core-agent.agent.yaml +24 -0
  493. package/test/test-agent-schema.js +387 -0
  494. package/test/test-cli-integration.sh +159 -0
  495. package/test/test-installation-components.js +214 -0
  496. package/test/unit-test-schema.js +133 -0
  497. package/tools/bmad-npx-wrapper.js +38 -0
  498. package/tools/build-docs.js +577 -0
  499. package/tools/cli/README.md +7 -0
  500. package/tools/cli/bmad-cli.js +58 -0
  501. package/tools/cli/commands/install.js +87 -0
  502. package/tools/cli/commands/status.js +65 -0
  503. package/tools/cli/external-official-modules.yaml +56 -0
  504. package/tools/cli/installers/install-messages.yaml +58 -0
  505. package/tools/cli/installers/lib/core/config-collector.js +1079 -0
  506. package/tools/cli/installers/lib/core/custom-module-cache.js +259 -0
  507. package/tools/cli/installers/lib/core/dependency-resolver.js +739 -0
  508. package/tools/cli/installers/lib/core/detector.js +223 -0
  509. package/tools/cli/installers/lib/core/ide-config-manager.js +156 -0
  510. package/tools/cli/installers/lib/core/installer.js +2826 -0
  511. package/tools/cli/installers/lib/core/manifest-generator.js +1054 -0
  512. package/tools/cli/installers/lib/core/manifest.js +1036 -0
  513. package/tools/cli/installers/lib/custom/handler.js +363 -0
  514. package/tools/cli/installers/lib/ide/STANDARDIZATION_PLAN.md +208 -0
  515. package/tools/cli/installers/lib/ide/_base-ide.js +655 -0
  516. package/tools/cli/installers/lib/ide/antigravity.js +474 -0
  517. package/tools/cli/installers/lib/ide/auggie.js +244 -0
  518. package/tools/cli/installers/lib/ide/claude-code.js +506 -0
  519. package/tools/cli/installers/lib/ide/cline.js +272 -0
  520. package/tools/cli/installers/lib/ide/codex.js +412 -0
  521. package/tools/cli/installers/lib/ide/crush.js +149 -0
  522. package/tools/cli/installers/lib/ide/cursor.js +160 -0
  523. package/tools/cli/installers/lib/ide/gemini.js +301 -0
  524. package/tools/cli/installers/lib/ide/github-copilot.js +383 -0
  525. package/tools/cli/installers/lib/ide/iflow.js +191 -0
  526. package/tools/cli/installers/lib/ide/kilo.js +250 -0
  527. package/tools/cli/installers/lib/ide/kiro-cli.js +326 -0
  528. package/tools/cli/installers/lib/ide/manager.js +244 -0
  529. package/tools/cli/installers/lib/ide/opencode.js +257 -0
  530. package/tools/cli/installers/lib/ide/qwen.js +372 -0
  531. package/tools/cli/installers/lib/ide/roo.js +273 -0
  532. package/tools/cli/installers/lib/ide/rovo-dev.js +290 -0
  533. package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +165 -0
  534. package/tools/cli/installers/lib/ide/shared/bmad-artifacts.js +158 -0
  535. package/tools/cli/installers/lib/ide/shared/module-injections.js +136 -0
  536. package/tools/cli/installers/lib/ide/shared/path-utils.js +165 -0
  537. package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +268 -0
  538. package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +293 -0
  539. package/tools/cli/installers/lib/ide/templates/agent-command-template.md +14 -0
  540. package/tools/cli/installers/lib/ide/templates/gemini-agent-command.toml +14 -0
  541. package/tools/cli/installers/lib/ide/templates/gemini-task-command.toml +12 -0
  542. package/tools/cli/installers/lib/ide/templates/workflow-command-template.md +13 -0
  543. package/tools/cli/installers/lib/ide/templates/workflow-commander.md +5 -0
  544. package/tools/cli/installers/lib/ide/trae.js +313 -0
  545. package/tools/cli/installers/lib/ide/windsurf.js +258 -0
  546. package/tools/cli/installers/lib/message-loader.js +85 -0
  547. package/tools/cli/installers/lib/modules/external-manager.js +135 -0
  548. package/tools/cli/installers/lib/modules/manager.js +1375 -0
  549. package/tools/cli/lib/activation-builder.js +163 -0
  550. package/tools/cli/lib/agent/compiler.js +522 -0
  551. package/tools/cli/lib/agent/installer.js +716 -0
  552. package/tools/cli/lib/agent/template-engine.js +152 -0
  553. package/tools/cli/lib/agent-analyzer.js +109 -0
  554. package/tools/cli/lib/agent-party-generator.js +194 -0
  555. package/tools/cli/lib/cli-utils.js +227 -0
  556. package/tools/cli/lib/config.js +213 -0
  557. package/tools/cli/lib/file-ops.js +204 -0
  558. package/tools/cli/lib/platform-codes.js +116 -0
  559. package/tools/cli/lib/project-root.js +77 -0
  560. package/tools/cli/lib/prompts.js +433 -0
  561. package/tools/cli/lib/ui.js +1716 -0
  562. package/tools/cli/lib/xml-handler.js +177 -0
  563. package/tools/cli/lib/xml-to-markdown.js +82 -0
  564. package/tools/cli/lib/yaml-format.js +245 -0
  565. package/tools/cli/lib/yaml-xml-builder.js +587 -0
  566. package/tools/docs/BUNDLE_DISTRIBUTION_SETUP.md +95 -0
  567. package/tools/docs/index.md +2 -0
  568. package/tools/fix-doc-links.js +288 -0
  569. package/tools/flattener/aggregate.js +76 -0
  570. package/tools/flattener/binary.js +80 -0
  571. package/tools/flattener/discovery.js +71 -0
  572. package/tools/flattener/files.js +35 -0
  573. package/tools/flattener/ignoreRules.js +172 -0
  574. package/tools/flattener/main.js +483 -0
  575. package/tools/flattener/projectRoot.js +201 -0
  576. package/tools/flattener/prompts.js +44 -0
  577. package/tools/flattener/stats.helpers.js +368 -0
  578. package/tools/flattener/stats.js +75 -0
  579. package/tools/flattener/test-matrix.js +409 -0
  580. package/tools/flattener/xml.js +82 -0
  581. package/tools/format-workflow-md.js +263 -0
  582. package/tools/lib/xml-utils.js +13 -0
  583. package/tools/maintainer/review-pr-README.md +55 -0
  584. package/tools/maintainer/review-pr.md +242 -0
  585. package/tools/migrate-custom-module-paths.js +124 -0
  586. package/tools/platform-codes.yaml +157 -0
  587. package/tools/schema/agent.js +491 -0
  588. package/tools/validate-agent-schema.js +110 -0
  589. package/tools/validate-doc-links.js +363 -0
  590. package/tools/validate-svg-changes.sh +356 -0
  591. package/website/README.md +76 -0
  592. package/website/astro.config.mjs +228 -0
  593. package/website/public/favicon.ico +0 -0
  594. package/website/public/img/bmad-dark.png +0 -0
  595. package/website/public/img/bmad-light.png +0 -0
  596. package/website/public/img/logo.svg +4 -0
  597. package/website/public/robots.txt +37 -0
  598. package/website/src/components/Banner.astro +59 -0
  599. package/website/src/components/Header.astro +121 -0
  600. package/website/src/components/MobileMenuFooter.astro +53 -0
  601. package/website/src/content/config.ts +6 -0
  602. package/website/src/lib/site-url.js +25 -0
  603. package/website/src/rehype-markdown-links.js +102 -0
  604. package/website/src/styles/custom.css +485 -0
@@ -0,0 +1,172 @@
1
+ const fs = require('fs-extra');
2
+ const path = require('node:path');
3
+ const ignore = require('ignore');
4
+
5
+ // Central default ignore patterns for discovery and filtering.
6
+ // These complement .gitignore and are applied regardless of VCS presence.
7
+ const DEFAULT_PATTERNS = [
8
+ // Project/VCS
9
+ '**/_bmad/**',
10
+ '**/.git/**',
11
+ '**/.svn/**',
12
+ '**/.hg/**',
13
+ '**/.bzr/**',
14
+ // Package/build outputs
15
+ '**/node_modules/**',
16
+ '**/bower_components/**',
17
+ '**/vendor/**',
18
+ '**/packages/**',
19
+ '**/build/**',
20
+ '**/dist/**',
21
+ '**/out/**',
22
+ '**/target/**',
23
+ '**/bin/**',
24
+ '**/obj/**',
25
+ '**/release/**',
26
+ '**/debug/**',
27
+ // Environments
28
+ '**/.venv/**',
29
+ '**/venv/**',
30
+ '**/.virtualenv/**',
31
+ '**/virtualenv/**',
32
+ '**/env/**',
33
+ // Logs & coverage
34
+ '**/*.log',
35
+ '**/npm-debug.log*',
36
+ '**/yarn-debug.log*',
37
+ '**/yarn-error.log*',
38
+ '**/lerna-debug.log*',
39
+ '**/coverage/**',
40
+ '**/.nyc_output/**',
41
+ '**/.coverage/**',
42
+ '**/test-results/**',
43
+ // Caches & temp
44
+ '**/.cache/**',
45
+ '**/.tmp/**',
46
+ '**/.temp/**',
47
+ '**/tmp/**',
48
+ '**/temp/**',
49
+ '**/.sass-cache/**',
50
+ // IDE/editor
51
+ '**/.vscode/**',
52
+ '**/.idea/**',
53
+ '**/*.swp',
54
+ '**/*.swo',
55
+ '**/*~',
56
+ '**/.project',
57
+ '**/.classpath',
58
+ '**/.settings/**',
59
+ '**/*.sublime-project',
60
+ '**/*.sublime-workspace',
61
+ // Lockfiles
62
+ '**/package-lock.json',
63
+ '**/yarn.lock',
64
+ '**/pnpm-lock.yaml',
65
+ '**/composer.lock',
66
+ '**/Pipfile.lock',
67
+ // Python/Java/compiled artifacts
68
+ '**/*.pyc',
69
+ '**/*.pyo',
70
+ '**/*.pyd',
71
+ '**/__pycache__/**',
72
+ '**/*.class',
73
+ '**/*.jar',
74
+ '**/*.war',
75
+ '**/*.ear',
76
+ '**/*.o',
77
+ '**/*.so',
78
+ '**/*.dll',
79
+ '**/*.exe',
80
+ // System junk
81
+ '**/lib64/**',
82
+ '**/.venv/lib64/**',
83
+ '**/venv/lib64/**',
84
+ '**/_site/**',
85
+ '**/.jekyll-cache/**',
86
+ '**/.jekyll-metadata',
87
+ '**/.DS_Store',
88
+ '**/.DS_Store?',
89
+ '**/._*',
90
+ '**/.Spotlight-V100/**',
91
+ '**/.Trashes/**',
92
+ '**/ehthumbs.db',
93
+ '**/Thumbs.db',
94
+ '**/desktop.ini',
95
+ // XML outputs
96
+ '**/flattened-codebase.xml',
97
+ '**/repomix-output.xml',
98
+ // Images, media, fonts, archives, docs, dylibs
99
+ '**/*.jpg',
100
+ '**/*.jpeg',
101
+ '**/*.png',
102
+ '**/*.gif',
103
+ '**/*.bmp',
104
+ '**/*.ico',
105
+ '**/*.svg',
106
+ '**/*.pdf',
107
+ '**/*.doc',
108
+ '**/*.docx',
109
+ '**/*.xls',
110
+ '**/*.xlsx',
111
+ '**/*.ppt',
112
+ '**/*.pptx',
113
+ '**/*.zip',
114
+ '**/*.tar',
115
+ '**/*.gz',
116
+ '**/*.rar',
117
+ '**/*.7z',
118
+ '**/*.dylib',
119
+ '**/*.mp3',
120
+ '**/*.mp4',
121
+ '**/*.avi',
122
+ '**/*.mov',
123
+ '**/*.wav',
124
+ '**/*.ttf',
125
+ '**/*.otf',
126
+ '**/*.woff',
127
+ '**/*.woff2',
128
+ // Env files
129
+ '**/.env',
130
+ '**/.env.*',
131
+ '**/*.env',
132
+ // Misc
133
+ '**/junit.xml',
134
+ ];
135
+
136
+ async function readIgnoreFile(filePath) {
137
+ try {
138
+ if (!(await fs.pathExists(filePath))) return [];
139
+ const content = await fs.readFile(filePath, 'utf8');
140
+ return content
141
+ .split('\n')
142
+ .map((l) => l.trim())
143
+ .filter((l) => l && !l.startsWith('#'));
144
+ } catch {
145
+ return [];
146
+ }
147
+ }
148
+
149
+ // Backward compatible export matching previous signature
150
+ async function parseGitignore(gitignorePath) {
151
+ return readIgnoreFile(gitignorePath);
152
+ }
153
+
154
+ async function loadIgnore(rootDir, extraPatterns = []) {
155
+ const ig = ignore();
156
+ const gitignorePath = path.join(rootDir, '.gitignore');
157
+ const patterns = [...(await readIgnoreFile(gitignorePath)), ...DEFAULT_PATTERNS, ...extraPatterns];
158
+ // De-duplicate
159
+ const unique = [...new Set(patterns.map(String))];
160
+ ig.add(unique);
161
+
162
+ // Include-only filter: return true if path should be included
163
+ const filter = (relativePath) => !ig.ignores(relativePath.replaceAll('\\', '/'));
164
+
165
+ return { ig, filter, patterns: unique };
166
+ }
167
+
168
+ module.exports = {
169
+ DEFAULT_PATTERNS,
170
+ parseGitignore,
171
+ loadIgnore,
172
+ };
@@ -0,0 +1,483 @@
1
+ const { Command } = require('commander');
2
+ const fs = require('fs-extra');
3
+ const path = require('node:path');
4
+ const process = require('node:process');
5
+
6
+ // Modularized components
7
+ const { findProjectRoot } = require('./projectRoot.js');
8
+ const { promptYesNo, promptPath } = require('./prompts.js');
9
+ const { discoverFiles, filterFiles, aggregateFileContents } = require('./files.js');
10
+ const { generateXMLOutput } = require('./xml.js');
11
+ const { calculateStatistics } = require('./stats.js');
12
+
13
+ /**
14
+ * Recursively discover all files in a directory
15
+ * @param {string} rootDir - The root directory to scan
16
+ * @returns {Promise<string[]>} Array of file paths
17
+ */
18
+
19
+ /**
20
+ * Parse .gitignore file and return ignore patterns
21
+ * @param {string} gitignorePath - Path to .gitignore file
22
+ * @returns {Promise<string[]>} Array of ignore patterns
23
+ */
24
+
25
+ /**
26
+ * Check if a file is binary using file command and heuristics
27
+ * @param {string} filePath - Path to the file
28
+ * @returns {Promise<boolean>} True if file is binary
29
+ */
30
+
31
+ /**
32
+ * Read and aggregate content from text files
33
+ * @param {string[]} files - Array of file paths
34
+ * @param {string} rootDir - The root directory
35
+ * @param {Object} spinner - Optional spinner instance for progress display
36
+ * @returns {Promise<Object>} Object containing file contents and metadata
37
+ */
38
+
39
+ /**
40
+ * Generate XML output with aggregated file contents using streaming
41
+ * @param {Object} aggregatedContent - The aggregated content object
42
+ * @param {string} outputPath - The output file path
43
+ * @returns {Promise<void>} Promise that resolves when writing is complete
44
+ */
45
+
46
+ /**
47
+ * Calculate statistics for the processed files
48
+ * @param {Object} aggregatedContent - The aggregated content object
49
+ * @param {number} xmlFileSize - The size of the generated XML file in bytes
50
+ * @returns {Object} Statistics object
51
+ */
52
+
53
+ /**
54
+ * Filter files based on .gitignore patterns
55
+ * @param {string[]} files - Array of file paths
56
+ * @param {string} rootDir - The root directory
57
+ * @returns {Promise<string[]>} Filtered array of file paths
58
+ */
59
+
60
+ /**
61
+ * Attempt to find the project root by walking up from startDir
62
+ * Looks for common project markers like .git, package.json, pyproject.toml, etc.
63
+ * @param {string} startDir
64
+ * @returns {Promise<string|null>} project root directory or null if not found
65
+ */
66
+
67
+ const program = new Command();
68
+
69
+ program
70
+ .name('bmad-flatten')
71
+ .description('BMad-Method codebase flattener tool')
72
+ .version('1.0.0')
73
+ .option('-i, --input <path>', 'Input directory to flatten', process.cwd())
74
+ .option('-o, --output <path>', 'Output file path', 'flattened-codebase.xml')
75
+ .action(async (options) => {
76
+ let inputDir = path.resolve(options.input);
77
+ let outputPath = path.resolve(options.output);
78
+
79
+ // Detect if user explicitly provided -i/--input or -o/--output
80
+ const argv = process.argv.slice(2);
81
+ const userSpecifiedInput = argv.some((a) => a === '-i' || a === '--input' || a.startsWith('--input='));
82
+ const userSpecifiedOutput = argv.some((a) => a === '-o' || a === '--output' || a.startsWith('--output='));
83
+ const noPathArguments = !userSpecifiedInput && !userSpecifiedOutput;
84
+
85
+ if (noPathArguments) {
86
+ const detectedRoot = await findProjectRoot(process.cwd());
87
+ const suggestedOutput = detectedRoot ? path.join(detectedRoot, 'flattened-codebase.xml') : path.resolve('flattened-codebase.xml');
88
+
89
+ if (detectedRoot) {
90
+ const useDefaults = await promptYesNo(
91
+ `Detected project root at "${detectedRoot}". Use it as input and write output to "${suggestedOutput}"?`,
92
+ true,
93
+ );
94
+ if (useDefaults) {
95
+ inputDir = detectedRoot;
96
+ outputPath = suggestedOutput;
97
+ } else {
98
+ inputDir = await promptPath('Enter input directory path', process.cwd());
99
+ outputPath = await promptPath('Enter output file path', path.join(inputDir, 'flattened-codebase.xml'));
100
+ }
101
+ } else {
102
+ console.log('Could not auto-detect a project root.');
103
+ inputDir = await promptPath('Enter input directory path', process.cwd());
104
+ outputPath = await promptPath('Enter output file path', path.join(inputDir, 'flattened-codebase.xml'));
105
+ }
106
+ }
107
+
108
+ // Ensure output directory exists
109
+ await fs.ensureDir(path.dirname(outputPath));
110
+
111
+ try {
112
+ // Verify input directory exists
113
+ if (!(await fs.pathExists(inputDir))) {
114
+ console.error(`โŒ Error: Input directory does not exist: ${inputDir}`);
115
+ process.exit(1);
116
+ }
117
+
118
+ // Import ora dynamically
119
+ const { default: ora } = await import('ora');
120
+
121
+ // Start file discovery with spinner
122
+ const discoverySpinner = ora('๐Ÿ” Discovering files...').start();
123
+ const files = await discoverFiles(inputDir);
124
+ const filteredFiles = await filterFiles(files, inputDir);
125
+ discoverySpinner.succeed(`๐Ÿ“ Found ${filteredFiles.length} files to include`);
126
+
127
+ // Process files with progress tracking
128
+ console.log('Reading file contents');
129
+ const processingSpinner = ora('๐Ÿ“„ Processing files...').start();
130
+ const aggregatedContent = await aggregateFileContents(filteredFiles, inputDir, processingSpinner);
131
+ processingSpinner.succeed(`โœ… Processed ${aggregatedContent.processedFiles}/${filteredFiles.length} files`);
132
+ if (aggregatedContent.errors.length > 0) {
133
+ console.log(`Errors: ${aggregatedContent.errors.length}`);
134
+ }
135
+
136
+ // Generate XML output using streaming
137
+ const xmlSpinner = ora('๐Ÿ”ง Generating XML output...').start();
138
+ await generateXMLOutput(aggregatedContent, outputPath);
139
+ xmlSpinner.succeed('๐Ÿ“ XML generation completed');
140
+
141
+ // Calculate and display statistics
142
+ const outputStats = await fs.stat(outputPath);
143
+ const stats = await calculateStatistics(aggregatedContent, outputStats.size, inputDir);
144
+
145
+ // Display completion summary
146
+ console.log('\n๐Ÿ“Š Completion Summary:');
147
+ console.log(`โœ… Successfully processed ${filteredFiles.length} files into ${path.basename(outputPath)}`);
148
+ console.log(`๐Ÿ“ Output file: ${outputPath}`);
149
+ console.log(`๐Ÿ“ Total source size: ${stats.totalSize}`);
150
+ console.log(`๐Ÿ“„ Generated XML size: ${stats.xmlSize}`);
151
+ console.log(`๐Ÿ“ Total lines of code: ${stats.totalLines.toLocaleString()}`);
152
+ console.log(`๐Ÿ”ข Estimated tokens: ${stats.estimatedTokens}`);
153
+ console.log(`๐Ÿ“Š File breakdown: ${stats.textFiles} text, ${stats.binaryFiles} binary, ${stats.errorFiles} errors\n`);
154
+
155
+ // Ask user if they want detailed stats + markdown report
156
+ const generateDetailed = await promptYesNo('Generate detailed stats (console + markdown) now?', true);
157
+
158
+ if (generateDetailed) {
159
+ // Additional detailed stats
160
+ console.log('\n๐Ÿ“ˆ Size Percentiles:');
161
+ console.log(
162
+ ` Avg: ${Math.round(stats.avgFileSize).toLocaleString()} B, Median: ${Math.round(
163
+ stats.medianFileSize,
164
+ ).toLocaleString()} B, p90: ${stats.p90.toLocaleString()} B, p95: ${stats.p95.toLocaleString()} B, p99: ${stats.p99.toLocaleString()} B`,
165
+ );
166
+
167
+ if (Array.isArray(stats.histogram) && stats.histogram.length > 0) {
168
+ console.log('\n๐Ÿงฎ Size Histogram:');
169
+ for (const b of stats.histogram.slice(0, 2)) {
170
+ console.log(` ${b.label}: ${b.count} files, ${b.bytes.toLocaleString()} bytes`);
171
+ }
172
+ if (stats.histogram.length > 2) {
173
+ console.log(` โ€ฆ and ${stats.histogram.length - 2} more buckets`);
174
+ }
175
+ }
176
+
177
+ if (Array.isArray(stats.byExtension) && stats.byExtension.length > 0) {
178
+ const topExt = stats.byExtension.slice(0, 2);
179
+ console.log('\n๐Ÿ“ฆ Top Extensions:');
180
+ for (const e of topExt) {
181
+ const pct = stats.totalBytes ? (e.bytes / stats.totalBytes) * 100 : 0;
182
+ console.log(` ${e.ext}: ${e.count} files, ${e.bytes.toLocaleString()} bytes (${pct.toFixed(2)}%)`);
183
+ }
184
+ if (stats.byExtension.length > 2) {
185
+ console.log(` โ€ฆ and ${stats.byExtension.length - 2} more extensions`);
186
+ }
187
+ }
188
+
189
+ if (Array.isArray(stats.byDirectory) && stats.byDirectory.length > 0) {
190
+ const topDir = stats.byDirectory.slice(0, 2);
191
+ console.log('\n๐Ÿ“‚ Top Directories:');
192
+ for (const d of topDir) {
193
+ const pct = stats.totalBytes ? (d.bytes / stats.totalBytes) * 100 : 0;
194
+ console.log(` ${d.dir}: ${d.count} files, ${d.bytes.toLocaleString()} bytes (${pct.toFixed(2)}%)`);
195
+ }
196
+ if (stats.byDirectory.length > 2) {
197
+ console.log(` โ€ฆ and ${stats.byDirectory.length - 2} more directories`);
198
+ }
199
+ }
200
+
201
+ if (Array.isArray(stats.depthDistribution) && stats.depthDistribution.length > 0) {
202
+ console.log('\n๐ŸŒณ Depth Distribution:');
203
+ const dd = stats.depthDistribution.slice(0, 2);
204
+ let line = ' ' + dd.map((d) => `${d.depth}:${d.count}`).join(' ');
205
+ if (stats.depthDistribution.length > 2) {
206
+ line += ` โ€ฆ +${stats.depthDistribution.length - 2} more`;
207
+ }
208
+ console.log(line);
209
+ }
210
+
211
+ if (Array.isArray(stats.longestPaths) && stats.longestPaths.length > 0) {
212
+ console.log('\n๐Ÿงต Longest Paths:');
213
+ for (const p of stats.longestPaths.slice(0, 2)) {
214
+ console.log(` ${p.path} (${p.length} chars, ${p.size.toLocaleString()} bytes)`);
215
+ }
216
+ if (stats.longestPaths.length > 2) {
217
+ console.log(` โ€ฆ and ${stats.longestPaths.length - 2} more paths`);
218
+ }
219
+ }
220
+
221
+ if (stats.temporal) {
222
+ console.log('\nโฑ๏ธ Temporal:');
223
+ if (stats.temporal.oldest) {
224
+ console.log(` Oldest: ${stats.temporal.oldest.path} (${stats.temporal.oldest.mtime})`);
225
+ }
226
+ if (stats.temporal.newest) {
227
+ console.log(` Newest: ${stats.temporal.newest.path} (${stats.temporal.newest.mtime})`);
228
+ }
229
+ if (Array.isArray(stats.temporal.ageBuckets)) {
230
+ console.log(' Age buckets:');
231
+ for (const b of stats.temporal.ageBuckets.slice(0, 2)) {
232
+ console.log(` ${b.label}: ${b.count} files, ${b.bytes.toLocaleString()} bytes`);
233
+ }
234
+ if (stats.temporal.ageBuckets.length > 2) {
235
+ console.log(` โ€ฆ and ${stats.temporal.ageBuckets.length - 2} more buckets`);
236
+ }
237
+ }
238
+ }
239
+
240
+ if (stats.quality) {
241
+ console.log('\nโœ… Quality Signals:');
242
+ console.log(` Zero-byte files: ${stats.quality.zeroByteFiles}`);
243
+ console.log(` Empty text files: ${stats.quality.emptyTextFiles}`);
244
+ console.log(` Hidden files: ${stats.quality.hiddenFiles}`);
245
+ console.log(` Symlinks: ${stats.quality.symlinks}`);
246
+ console.log(
247
+ ` Large files (>= ${(stats.quality.largeThreshold / (1024 * 1024)).toFixed(0)} MB): ${stats.quality.largeFilesCount}`,
248
+ );
249
+ console.log(` Suspiciously large files (>= 100 MB): ${stats.quality.suspiciousLargeFilesCount}`);
250
+ }
251
+
252
+ if (Array.isArray(stats.duplicateCandidates) && stats.duplicateCandidates.length > 0) {
253
+ console.log('\n๐Ÿงฌ Duplicate Candidates:');
254
+ for (const d of stats.duplicateCandidates.slice(0, 2)) {
255
+ console.log(` ${d.reason}: ${d.count} files @ ${d.size.toLocaleString()} bytes`);
256
+ }
257
+ if (stats.duplicateCandidates.length > 2) {
258
+ console.log(` โ€ฆ and ${stats.duplicateCandidates.length - 2} more groups`);
259
+ }
260
+ }
261
+
262
+ if (typeof stats.compressibilityRatio === 'number') {
263
+ console.log(`\n๐Ÿ—œ๏ธ Compressibility ratio (sampled): ${(stats.compressibilityRatio * 100).toFixed(2)}%`);
264
+ }
265
+
266
+ if (stats.git && stats.git.isRepo) {
267
+ console.log('\n๐Ÿ”ง Git:');
268
+ console.log(` Tracked: ${stats.git.trackedCount} files, ${stats.git.trackedBytes.toLocaleString()} bytes`);
269
+ console.log(` Untracked: ${stats.git.untrackedCount} files, ${stats.git.untrackedBytes.toLocaleString()} bytes`);
270
+ if (Array.isArray(stats.git.lfsCandidates) && stats.git.lfsCandidates.length > 0) {
271
+ console.log(' LFS candidates (top 2):');
272
+ for (const f of stats.git.lfsCandidates.slice(0, 2)) {
273
+ console.log(` ${f.path} (${f.size.toLocaleString()} bytes)`);
274
+ }
275
+ if (stats.git.lfsCandidates.length > 2) {
276
+ console.log(` โ€ฆ and ${stats.git.lfsCandidates.length - 2} more`);
277
+ }
278
+ }
279
+ }
280
+
281
+ if (Array.isArray(stats.largestFiles) && stats.largestFiles.length > 0) {
282
+ console.log('\n๐Ÿ“š Largest Files (top 2):');
283
+ for (const f of stats.largestFiles.slice(0, 2)) {
284
+ // Show LOC for text files when available; omit ext and mtime
285
+ let locStr = '';
286
+ if (!f.isBinary && Array.isArray(aggregatedContent?.textFiles)) {
287
+ const tf = aggregatedContent.textFiles.find((t) => t.path === f.path);
288
+ if (tf && typeof tf.lines === 'number') {
289
+ locStr = `, LOC: ${tf.lines.toLocaleString()}`;
290
+ }
291
+ }
292
+ console.log(` ${f.path} โ€“ ${f.sizeFormatted} (${f.percentOfTotal.toFixed(2)}%)${locStr}`);
293
+ }
294
+ if (stats.largestFiles.length > 2) {
295
+ console.log(` โ€ฆ and ${stats.largestFiles.length - 2} more files`);
296
+ }
297
+ }
298
+
299
+ // Write a comprehensive markdown report next to the XML
300
+ {
301
+ const mdPath = outputPath.endsWith('.xml') ? outputPath.replace(/\.xml$/i, '.stats.md') : outputPath + '.stats.md';
302
+ try {
303
+ const pct = (num, den) => (den ? (num / den) * 100 : 0);
304
+ const md = [];
305
+ md.push(
306
+ `# ๐Ÿงพ Flatten Stats for ${path.basename(outputPath)}`,
307
+ '',
308
+ '## ๐Ÿ“Š Summary',
309
+ `- Total source size: ${stats.totalSize}`,
310
+ `- Generated XML size: ${stats.xmlSize}`,
311
+ `- Total lines of code: ${stats.totalLines.toLocaleString()}`,
312
+ `- Estimated tokens: ${stats.estimatedTokens}`,
313
+ `- File breakdown: ${stats.textFiles} text, ${stats.binaryFiles} binary, ${stats.errorFiles} errors`,
314
+ '',
315
+ '## ๐Ÿ“ˆ Size Percentiles',
316
+ `Avg: ${Math.round(stats.avgFileSize).toLocaleString()} B, Median: ${Math.round(
317
+ stats.medianFileSize,
318
+ ).toLocaleString()} B, p90: ${stats.p90.toLocaleString()} B, p95: ${stats.p95.toLocaleString()} B, p99: ${stats.p99.toLocaleString()} B`,
319
+ '',
320
+ );
321
+
322
+ // Histogram
323
+ if (Array.isArray(stats.histogram) && stats.histogram.length > 0) {
324
+ md.push('## ๐Ÿงฎ Size Histogram', '| Bucket | Files | Bytes |', '| --- | ---: | ---: |');
325
+ for (const b of stats.histogram) {
326
+ md.push(`| ${b.label} | ${b.count} | ${b.bytes.toLocaleString()} |`);
327
+ }
328
+ md.push('');
329
+ }
330
+
331
+ // Top Extensions
332
+ if (Array.isArray(stats.byExtension) && stats.byExtension.length > 0) {
333
+ md.push('## ๐Ÿ“ฆ Top Extensions by Bytes (Top 20)', '| Ext | Files | Bytes | % of total |', '| --- | ---: | ---: | ---: |');
334
+ for (const e of stats.byExtension.slice(0, 20)) {
335
+ const p = pct(e.bytes, stats.totalBytes);
336
+ md.push(`| ${e.ext} | ${e.count} | ${e.bytes.toLocaleString()} | ${p.toFixed(2)}% |`);
337
+ }
338
+ md.push('');
339
+ }
340
+
341
+ // Top Directories
342
+ if (Array.isArray(stats.byDirectory) && stats.byDirectory.length > 0) {
343
+ md.push(
344
+ '## ๐Ÿ“‚ Top Directories by Bytes (Top 20)',
345
+ '| Directory | Files | Bytes | % of total |',
346
+ '| --- | ---: | ---: | ---: |',
347
+ );
348
+ for (const d of stats.byDirectory.slice(0, 20)) {
349
+ const p = pct(d.bytes, stats.totalBytes);
350
+ md.push(`| ${d.dir} | ${d.count} | ${d.bytes.toLocaleString()} | ${p.toFixed(2)}% |`);
351
+ }
352
+ md.push('');
353
+ }
354
+
355
+ // Depth distribution
356
+ if (Array.isArray(stats.depthDistribution) && stats.depthDistribution.length > 0) {
357
+ md.push('## ๐ŸŒณ Depth Distribution', '| Depth | Count |', '| ---: | ---: |');
358
+ for (const d of stats.depthDistribution) {
359
+ md.push(`| ${d.depth} | ${d.count} |`);
360
+ }
361
+ md.push('');
362
+ }
363
+
364
+ // Longest paths
365
+ if (Array.isArray(stats.longestPaths) && stats.longestPaths.length > 0) {
366
+ md.push('## ๐Ÿงต Longest Paths (Top 25)', '| Path | Length | Bytes |', '| --- | ---: | ---: |');
367
+ for (const pth of stats.longestPaths) {
368
+ md.push(`| ${pth.path} | ${pth.length} | ${pth.size.toLocaleString()} |`);
369
+ }
370
+ md.push('');
371
+ }
372
+
373
+ // Temporal
374
+ if (stats.temporal) {
375
+ md.push('## โฑ๏ธ Temporal');
376
+ if (stats.temporal.oldest) {
377
+ md.push(`- Oldest: ${stats.temporal.oldest.path} (${stats.temporal.oldest.mtime})`);
378
+ }
379
+ if (stats.temporal.newest) {
380
+ md.push(`- Newest: ${stats.temporal.newest.path} (${stats.temporal.newest.mtime})`);
381
+ }
382
+ if (Array.isArray(stats.temporal.ageBuckets)) {
383
+ md.push('', '| Age | Files | Bytes |', '| --- | ---: | ---: |');
384
+ for (const b of stats.temporal.ageBuckets) {
385
+ md.push(`| ${b.label} | ${b.count} | ${b.bytes.toLocaleString()} |`);
386
+ }
387
+ }
388
+ md.push('');
389
+ }
390
+
391
+ // Quality signals
392
+ if (stats.quality) {
393
+ md.push(
394
+ '## โœ… Quality Signals',
395
+ `- Zero-byte files: ${stats.quality.zeroByteFiles}`,
396
+ `- Empty text files: ${stats.quality.emptyTextFiles}`,
397
+ `- Hidden files: ${stats.quality.hiddenFiles}`,
398
+ `- Symlinks: ${stats.quality.symlinks}`,
399
+ `- Large files (>= ${(stats.quality.largeThreshold / (1024 * 1024)).toFixed(0)} MB): ${stats.quality.largeFilesCount}`,
400
+ `- Suspiciously large files (>= 100 MB): ${stats.quality.suspiciousLargeFilesCount}`,
401
+ '',
402
+ );
403
+ }
404
+
405
+ // Duplicates
406
+ if (Array.isArray(stats.duplicateCandidates) && stats.duplicateCandidates.length > 0) {
407
+ md.push('## ๐Ÿงฌ Duplicate Candidates', '| Reason | Files | Size (bytes) |', '| --- | ---: | ---: |');
408
+ for (const d of stats.duplicateCandidates) {
409
+ md.push(`| ${d.reason} | ${d.count} | ${d.size.toLocaleString()} |`);
410
+ }
411
+ md.push('', '### ๐Ÿงฌ Duplicate Groups Details');
412
+ let dupIndex = 1;
413
+ for (const d of stats.duplicateCandidates) {
414
+ md.push(`#### Group ${dupIndex}: ${d.count} files @ ${d.size.toLocaleString()} bytes (${d.reason})`);
415
+ if (Array.isArray(d.files) && d.files.length > 0) {
416
+ for (const fp of d.files) {
417
+ md.push(`- ${fp}`);
418
+ }
419
+ } else {
420
+ md.push('- (file list unavailable)');
421
+ }
422
+ md.push('');
423
+ dupIndex++;
424
+ }
425
+ md.push('');
426
+ }
427
+
428
+ // Compressibility
429
+ if (typeof stats.compressibilityRatio === 'number') {
430
+ md.push('## ๐Ÿ—œ๏ธ Compressibility', `Sampled compressibility ratio: ${(stats.compressibilityRatio * 100).toFixed(2)}%`, '');
431
+ }
432
+
433
+ // Git
434
+ if (stats.git && stats.git.isRepo) {
435
+ md.push(
436
+ '## ๐Ÿ”ง Git',
437
+ `- Tracked: ${stats.git.trackedCount} files, ${stats.git.trackedBytes.toLocaleString()} bytes`,
438
+ `- Untracked: ${stats.git.untrackedCount} files, ${stats.git.untrackedBytes.toLocaleString()} bytes`,
439
+ );
440
+ if (Array.isArray(stats.git.lfsCandidates) && stats.git.lfsCandidates.length > 0) {
441
+ md.push('', '### ๐Ÿ“ฆ LFS Candidates (Top 20)', '| Path | Bytes |', '| --- | ---: |');
442
+ for (const f of stats.git.lfsCandidates.slice(0, 20)) {
443
+ md.push(`| ${f.path} | ${f.size.toLocaleString()} |`);
444
+ }
445
+ }
446
+ md.push('');
447
+ }
448
+
449
+ // Largest Files
450
+ if (Array.isArray(stats.largestFiles) && stats.largestFiles.length > 0) {
451
+ md.push('## ๐Ÿ“š Largest Files (Top 50)', '| Path | Size | % of total | LOC |', '| --- | ---: | ---: | ---: |');
452
+ for (const f of stats.largestFiles) {
453
+ let loc = '';
454
+ if (!f.isBinary && Array.isArray(aggregatedContent?.textFiles)) {
455
+ const tf = aggregatedContent.textFiles.find((t) => t.path === f.path);
456
+ if (tf && typeof tf.lines === 'number') {
457
+ loc = tf.lines.toLocaleString();
458
+ }
459
+ }
460
+ md.push(`| ${f.path} | ${f.sizeFormatted} | ${f.percentOfTotal.toFixed(2)}% | ${loc} |`);
461
+ }
462
+ md.push('');
463
+ }
464
+
465
+ await fs.writeFile(mdPath, md.join('\n'));
466
+ console.log(`\n๐Ÿงพ Detailed stats report written to: ${mdPath}`);
467
+ } catch (error) {
468
+ console.warn(`โš ๏ธ Failed to write stats markdown: ${error.message}`);
469
+ }
470
+ }
471
+ }
472
+ } catch (error) {
473
+ console.error('โŒ Critical error:', error.message);
474
+ console.error('An unexpected error occurred.');
475
+ process.exit(1);
476
+ }
477
+ });
478
+
479
+ if (require.main === module) {
480
+ program.parse();
481
+ }
482
+
483
+ module.exports = program;