bmad-fh 6.0.0-alpha.052779ef

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 (626) hide show
  1. package/.coderabbit.yaml +40 -0
  2. package/.githooks/post-checkout +129 -0
  3. package/.githooks/pre-commit +63 -0
  4. package/.githooks/pre-push +135 -0
  5. package/.github/CODE_OF_CONDUCT.md +128 -0
  6. package/.github/FUNDING.yaml +15 -0
  7. package/.github/ISSUE_TEMPLATE/config.yaml +8 -0
  8. package/.github/ISSUE_TEMPLATE/feature_request.md +22 -0
  9. package/.github/ISSUE_TEMPLATE/issue.md +32 -0
  10. package/.github/scripts/discord-helpers.sh +34 -0
  11. package/.github/workflows/bundle-latest.yaml +330 -0
  12. package/.github/workflows/discord.yaml +90 -0
  13. package/.github/workflows/docs.yaml +63 -0
  14. package/.github/workflows/manual-release.yaml +190 -0
  15. package/.github/workflows/publish-multi-artifact.yaml +54 -0
  16. package/.github/workflows/quality.yaml +115 -0
  17. package/.husky/pre-commit +20 -0
  18. package/.markdownlint-cli2.yaml +41 -0
  19. package/.nvmrc +1 -0
  20. package/.prettierignore +9 -0
  21. package/.vscode/settings.json +97 -0
  22. package/CHANGELOG.md +1394 -0
  23. package/CNAME +1 -0
  24. package/CONTRIBUTING.md +306 -0
  25. package/CONTRIBUTORS.md +32 -0
  26. package/LICENSE +30 -0
  27. package/README.md +126 -0
  28. package/SECURITY.md +85 -0
  29. package/TRADEMARK.md +55 -0
  30. package/Wordmark.png +0 -0
  31. package/banner-bmad-method.png +0 -0
  32. package/docs/404.md +9 -0
  33. package/docs/_README_WORKFLOW_DIAGRAMS.md +40 -0
  34. package/docs/_STYLE_GUIDE.md +367 -0
  35. package/docs/_archive/customize-workflows.md +30 -0
  36. package/docs/_archive/getting-started-bmadv4.md +247 -0
  37. package/docs/_archive/vendor-workflows.md +52 -0
  38. package/docs/downloads.md +72 -0
  39. package/docs/explanation/agents/barry-quick-flow.md +328 -0
  40. package/docs/explanation/agents/index.md +19 -0
  41. package/docs/explanation/architecture/four-phases.md +107 -0
  42. package/docs/explanation/architecture/preventing-agent-conflicts.md +111 -0
  43. package/docs/explanation/architecture/why-solutioning-matters.md +75 -0
  44. package/docs/explanation/bmm/index.md +131 -0
  45. package/docs/explanation/core/index.md +18 -0
  46. package/docs/explanation/core-concepts/agent-roles.md +179 -0
  47. package/docs/explanation/core-concepts/index.md +35 -0
  48. package/docs/explanation/core-concepts/what-are-agents.md +97 -0
  49. package/docs/explanation/core-concepts/what-are-modules.md +85 -0
  50. package/docs/explanation/core-concepts/what-are-workflows.md +204 -0
  51. package/docs/explanation/faq/brownfield-faq.md +73 -0
  52. package/docs/explanation/faq/getting-started-faq.md +67 -0
  53. package/docs/explanation/faq/implementation-faq.md +52 -0
  54. package/docs/explanation/faq/index.md +16 -0
  55. package/docs/explanation/faq/levels-and-tracks-faq.md +52 -0
  56. package/docs/explanation/faq/planning-faq.md +41 -0
  57. package/docs/explanation/faq/tools-faq.md +277 -0
  58. package/docs/explanation/faq/workflows-faq.md +61 -0
  59. package/docs/explanation/features/advanced-elicitation.md +95 -0
  60. package/docs/explanation/features/brainstorming-techniques.md +92 -0
  61. package/docs/explanation/features/party-mode.md +95 -0
  62. package/docs/explanation/features/quick-flow.md +149 -0
  63. package/docs/explanation/features/tea-overview.md +410 -0
  64. package/docs/explanation/features/web-bundles.md +34 -0
  65. package/docs/explanation/philosophy/facilitation-over-generation.md +333 -0
  66. package/docs/explanation/philosophy/testing-as-engineering.md +112 -0
  67. package/docs/explanation/tea/engagement-models.md +710 -0
  68. package/docs/explanation/tea/fixture-architecture.md +457 -0
  69. package/docs/explanation/tea/knowledge-base-system.md +554 -0
  70. package/docs/explanation/tea/network-first-patterns.md +853 -0
  71. package/docs/explanation/tea/risk-based-testing.md +586 -0
  72. package/docs/explanation/tea/test-quality-standards.md +907 -0
  73. package/docs/how-to/brownfield/add-feature-to-existing.md +74 -0
  74. package/docs/how-to/brownfield/document-existing-project.md +66 -0
  75. package/docs/how-to/brownfield/index.md +84 -0
  76. package/docs/how-to/brownfield/quick-fix-in-brownfield.md +77 -0
  77. package/docs/how-to/brownfield/use-tea-for-enterprise.md +526 -0
  78. package/docs/how-to/brownfield/use-tea-with-existing-tests.md +577 -0
  79. package/docs/how-to/customization/customize-agents.md +212 -0
  80. package/docs/how-to/customization/enable-tea-mcp-enhancements.md +424 -0
  81. package/docs/how-to/customization/index.md +23 -0
  82. package/docs/how-to/customization/integrate-playwright-utils.md +813 -0
  83. package/docs/how-to/customization/shard-large-documents.md +101 -0
  84. package/docs/how-to/get-answers-about-bmad.md +102 -0
  85. package/docs/how-to/installation/index.md +12 -0
  86. package/docs/how-to/installation/install-bmad.md +111 -0
  87. package/docs/how-to/installation/install-custom-modules.md +118 -0
  88. package/docs/how-to/installation/upgrade-to-v6.md +131 -0
  89. package/docs/how-to/workflows/bmgd-quick-flow.md +156 -0
  90. package/docs/how-to/workflows/conduct-research.md +97 -0
  91. package/docs/how-to/workflows/create-architecture.md +119 -0
  92. package/docs/how-to/workflows/create-epics-and-stories.md +109 -0
  93. package/docs/how-to/workflows/create-prd.md +91 -0
  94. package/docs/how-to/workflows/create-product-brief.md +94 -0
  95. package/docs/how-to/workflows/create-story.md +102 -0
  96. package/docs/how-to/workflows/create-ux-design.md +100 -0
  97. package/docs/how-to/workflows/implement-story.md +97 -0
  98. package/docs/how-to/workflows/quick-spec.md +122 -0
  99. package/docs/how-to/workflows/run-atdd.md +436 -0
  100. package/docs/how-to/workflows/run-automate.md +653 -0
  101. package/docs/how-to/workflows/run-brainstorming-session.md +73 -0
  102. package/docs/how-to/workflows/run-code-review.md +89 -0
  103. package/docs/how-to/workflows/run-implementation-readiness.md +125 -0
  104. package/docs/how-to/workflows/run-nfr-assess.md +679 -0
  105. package/docs/how-to/workflows/run-sprint-planning.md +94 -0
  106. package/docs/how-to/workflows/run-test-design.md +98 -0
  107. package/docs/how-to/workflows/run-test-review.md +605 -0
  108. package/docs/how-to/workflows/run-trace.md +883 -0
  109. package/docs/how-to/workflows/setup-ci.md +712 -0
  110. package/docs/how-to/workflows/setup-party-mode.md +89 -0
  111. package/docs/how-to/workflows/setup-test-framework.md +98 -0
  112. package/docs/index.md +63 -0
  113. package/docs/migration-guide.md +365 -0
  114. package/docs/multi-scope-guide.md +379 -0
  115. package/docs/plans/multi-scope-parallel-artifacts-plan.md +695 -0
  116. package/docs/reference/agents/index.md +109 -0
  117. package/docs/reference/configuration/core-tasks.md +67 -0
  118. package/docs/reference/configuration/global-config.md +28 -0
  119. package/docs/reference/glossary/index.md +159 -0
  120. package/docs/reference/tea/commands.md +254 -0
  121. package/docs/reference/tea/configuration.md +678 -0
  122. package/docs/reference/tea/knowledge-base.md +340 -0
  123. package/docs/reference/workflows/core-workflows.md +32 -0
  124. package/docs/reference/workflows/document-project.md +73 -0
  125. package/docs/reference/workflows/index.md +12 -0
  126. package/docs/tutorials/getting-started/getting-started-bmadv6.md +246 -0
  127. package/docs/tutorials/getting-started/images/workflow-method-greenfield.excalidraw +5034 -0
  128. package/docs/tutorials/getting-started/images/workflow-method-greenfield.svg +4 -0
  129. package/docs/tutorials/getting-started/images/workflow-overview.jpg +0 -0
  130. package/docs/tutorials/getting-started/tea-lite-quickstart.md +444 -0
  131. package/docs/tutorials/getting-started/workflow-overview.jpg +0 -0
  132. package/eslint.config.mjs +152 -0
  133. package/package.json +117 -0
  134. package/prettier.config.mjs +32 -0
  135. package/src/bmm/_module-installer/installer.js +48 -0
  136. package/src/bmm/_module-installer/platform-specifics/claude-code.js +35 -0
  137. package/src/bmm/_module-installer/platform-specifics/windsurf.js +32 -0
  138. package/src/bmm/agents/analyst.agent.yaml +41 -0
  139. package/src/bmm/agents/architect.agent.yaml +33 -0
  140. package/src/bmm/agents/dev.agent.yaml +38 -0
  141. package/src/bmm/agents/pm.agent.yaml +51 -0
  142. package/src/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -0
  143. package/src/bmm/agents/sm.agent.yaml +47 -0
  144. package/src/bmm/agents/tea.agent.yaml +68 -0
  145. package/src/bmm/agents/tech-writer/tech-writer-sidecar/documentation-standards.md +224 -0
  146. package/src/bmm/agents/tech-writer/tech-writer.agent.yaml +49 -0
  147. package/src/bmm/agents/ux-designer.agent.yaml +30 -0
  148. package/src/bmm/data/README.md +29 -0
  149. package/src/bmm/data/project-context-template.md +40 -0
  150. package/src/bmm/module.yaml +64 -0
  151. package/src/bmm/sub-modules/claude-code/config.yaml +4 -0
  152. package/src/bmm/sub-modules/claude-code/injections.yaml +242 -0
  153. package/src/bmm/sub-modules/claude-code/readme.md +87 -0
  154. package/src/bmm/teams/default-party.csv +21 -0
  155. package/src/bmm/teams/team-fullstack.yaml +12 -0
  156. package/src/bmm/testarch/knowledge/api-request.md +442 -0
  157. package/src/bmm/testarch/knowledge/api-testing-patterns.md +843 -0
  158. package/src/bmm/testarch/knowledge/auth-session.md +552 -0
  159. package/src/bmm/testarch/knowledge/burn-in.md +273 -0
  160. package/src/bmm/testarch/knowledge/ci-burn-in.md +675 -0
  161. package/src/bmm/testarch/knowledge/component-tdd.md +486 -0
  162. package/src/bmm/testarch/knowledge/contract-testing.md +957 -0
  163. package/src/bmm/testarch/knowledge/data-factories.md +500 -0
  164. package/src/bmm/testarch/knowledge/email-auth.md +721 -0
  165. package/src/bmm/testarch/knowledge/error-handling.md +725 -0
  166. package/src/bmm/testarch/knowledge/feature-flags.md +750 -0
  167. package/src/bmm/testarch/knowledge/file-utils.md +463 -0
  168. package/src/bmm/testarch/knowledge/fixture-architecture.md +401 -0
  169. package/src/bmm/testarch/knowledge/fixtures-composition.md +382 -0
  170. package/src/bmm/testarch/knowledge/intercept-network-call.md +430 -0
  171. package/src/bmm/testarch/knowledge/log.md +429 -0
  172. package/src/bmm/testarch/knowledge/network-error-monitor.md +405 -0
  173. package/src/bmm/testarch/knowledge/network-first.md +486 -0
  174. package/src/bmm/testarch/knowledge/network-recorder.md +527 -0
  175. package/src/bmm/testarch/knowledge/nfr-criteria.md +670 -0
  176. package/src/bmm/testarch/knowledge/overview.md +286 -0
  177. package/src/bmm/testarch/knowledge/playwright-config.md +730 -0
  178. package/src/bmm/testarch/knowledge/probability-impact.md +601 -0
  179. package/src/bmm/testarch/knowledge/recurse.md +421 -0
  180. package/src/bmm/testarch/knowledge/risk-governance.md +615 -0
  181. package/src/bmm/testarch/knowledge/selective-testing.md +732 -0
  182. package/src/bmm/testarch/knowledge/selector-resilience.md +527 -0
  183. package/src/bmm/testarch/knowledge/test-healing-patterns.md +644 -0
  184. package/src/bmm/testarch/knowledge/test-levels-framework.md +473 -0
  185. package/src/bmm/testarch/knowledge/test-priorities-matrix.md +373 -0
  186. package/src/bmm/testarch/knowledge/test-quality.md +664 -0
  187. package/src/bmm/testarch/knowledge/timing-debugging.md +372 -0
  188. package/src/bmm/testarch/knowledge/visual-debugging.md +524 -0
  189. package/src/bmm/testarch/tea-index.csv +34 -0
  190. package/src/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -0
  191. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +177 -0
  192. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +161 -0
  193. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +199 -0
  194. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +202 -0
  195. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +205 -0
  196. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +219 -0
  197. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +194 -0
  198. package/src/bmm/workflows/1-analysis/create-product-brief/workflow.md +58 -0
  199. package/src/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -0
  200. package/src/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -0
  201. package/src/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -0
  202. package/src/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -0
  203. package/src/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -0
  204. package/src/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -0
  205. package/src/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -0
  206. package/src/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -0
  207. package/src/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +200 -0
  208. package/src/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -0
  209. package/src/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -0
  210. package/src/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -0
  211. package/src/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -0
  212. package/src/bmm/workflows/1-analysis/research/research.template.md +29 -0
  213. package/src/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -0
  214. package/src/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -0
  215. package/src/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -0
  216. package/src/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -0
  217. package/src/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +239 -0
  218. package/src/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -0
  219. package/src/bmm/workflows/1-analysis/research/workflow.md +173 -0
  220. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -0
  221. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -0
  222. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -0
  223. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -0
  224. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -0
  225. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -0
  226. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -0
  227. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -0
  228. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -0
  229. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -0
  230. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -0
  231. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -0
  232. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -0
  233. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -0
  234. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +228 -0
  235. package/src/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -0
  236. package/src/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +43 -0
  237. package/src/bmm/workflows/2-plan-workflows/prd/data/domain-complexity.csv +13 -0
  238. package/src/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md +197 -0
  239. package/src/bmm/workflows/2-plan-workflows/prd/data/project-types.csv +11 -0
  240. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md +191 -0
  241. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md +153 -0
  242. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md +224 -0
  243. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md +226 -0
  244. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md +213 -0
  245. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md +207 -0
  246. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md +226 -0
  247. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md +237 -0
  248. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md +228 -0
  249. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md +231 -0
  250. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md +242 -0
  251. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md +217 -0
  252. package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md +180 -0
  253. package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md +247 -0
  254. package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md +208 -0
  255. package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md +249 -0
  256. package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md +253 -0
  257. package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md +168 -0
  258. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md +218 -0
  259. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md +191 -0
  260. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md +209 -0
  261. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md +174 -0
  262. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md +214 -0
  263. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md +228 -0
  264. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md +217 -0
  265. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md +205 -0
  266. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md +243 -0
  267. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md +263 -0
  268. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md +209 -0
  269. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md +264 -0
  270. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md +242 -0
  271. package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md +232 -0
  272. package/src/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md +10 -0
  273. package/src/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +433 -0
  274. package/src/bmm/workflows/2-plan-workflows/prd/workflow.md +150 -0
  275. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +190 -0
  276. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +178 -0
  277. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +179 -0
  278. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +139 -0
  279. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +252 -0
  280. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +133 -0
  281. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -0
  282. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +55 -0
  283. package/src/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -0
  284. package/src/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +11 -0
  285. package/src/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +7 -0
  286. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +153 -0
  287. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -0
  288. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -0
  289. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +331 -0
  290. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +318 -0
  291. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +359 -0
  292. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -0
  293. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +359 -0
  294. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +352 -0
  295. package/src/bmm/workflows/3-solutioning/create-architecture/workflow.md +50 -0
  296. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -0
  297. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -0
  298. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -0
  299. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +145 -0
  300. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -0
  301. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +59 -0
  302. package/src/bmm/workflows/4-implementation/code-review/checklist.md +23 -0
  303. package/src/bmm/workflows/4-implementation/code-review/instructions.xml +227 -0
  304. package/src/bmm/workflows/4-implementation/code-review/workflow.yaml +51 -0
  305. package/src/bmm/workflows/4-implementation/correct-course/checklist.md +288 -0
  306. package/src/bmm/workflows/4-implementation/correct-course/instructions.md +206 -0
  307. package/src/bmm/workflows/4-implementation/correct-course/workflow.yaml +60 -0
  308. package/src/bmm/workflows/4-implementation/create-story/checklist.md +358 -0
  309. package/src/bmm/workflows/4-implementation/create-story/instructions.xml +345 -0
  310. package/src/bmm/workflows/4-implementation/create-story/template.md +49 -0
  311. package/src/bmm/workflows/4-implementation/create-story/workflow.yaml +61 -0
  312. package/src/bmm/workflows/4-implementation/dev-story/checklist.md +80 -0
  313. package/src/bmm/workflows/4-implementation/dev-story/instructions.xml +410 -0
  314. package/src/bmm/workflows/4-implementation/dev-story/workflow.yaml +27 -0
  315. package/src/bmm/workflows/4-implementation/retrospective/instructions.md +1443 -0
  316. package/src/bmm/workflows/4-implementation/retrospective/workflow.yaml +58 -0
  317. package/src/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -0
  318. package/src/bmm/workflows/4-implementation/sprint-planning/instructions.md +225 -0
  319. package/src/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -0
  320. package/src/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +54 -0
  321. package/src/bmm/workflows/4-implementation/sprint-status/instructions.md +229 -0
  322. package/src/bmm/workflows/4-implementation/sprint-status/workflow.yaml +36 -0
  323. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +156 -0
  324. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +120 -0
  325. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +113 -0
  326. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +113 -0
  327. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +106 -0
  328. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +140 -0
  329. package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +52 -0
  330. package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +189 -0
  331. package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +144 -0
  332. package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +128 -0
  333. package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +191 -0
  334. package/src/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -0
  335. package/src/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -0
  336. package/src/bmm/workflows/document-project/checklist.md +245 -0
  337. package/src/bmm/workflows/document-project/documentation-requirements.csv +12 -0
  338. package/src/bmm/workflows/document-project/instructions.md +221 -0
  339. package/src/bmm/workflows/document-project/templates/deep-dive-template.md +345 -0
  340. package/src/bmm/workflows/document-project/templates/index-template.md +169 -0
  341. package/src/bmm/workflows/document-project/templates/project-overview-template.md +103 -0
  342. package/src/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -0
  343. package/src/bmm/workflows/document-project/templates/source-tree-template.md +135 -0
  344. package/src/bmm/workflows/document-project/workflow.yaml +30 -0
  345. package/src/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -0
  346. package/src/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -0
  347. package/src/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -0
  348. package/src/bmm/workflows/document-project/workflows/full-scan.yaml +31 -0
  349. package/src/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +90 -0
  350. package/src/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +127 -0
  351. package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +39 -0
  352. package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +130 -0
  353. package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +27 -0
  354. package/src/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +43 -0
  355. package/src/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +141 -0
  356. package/src/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +27 -0
  357. package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +49 -0
  358. package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +241 -0
  359. package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +27 -0
  360. package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +38 -0
  361. package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +133 -0
  362. package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +27 -0
  363. package/src/bmm/workflows/generate-project-context/project-context-template.md +21 -0
  364. package/src/bmm/workflows/generate-project-context/steps/step-01-discover.md +184 -0
  365. package/src/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -0
  366. package/src/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -0
  367. package/src/bmm/workflows/generate-project-context/workflow.md +49 -0
  368. package/src/bmm/workflows/testarch/atdd/atdd-checklist-template.md +364 -0
  369. package/src/bmm/workflows/testarch/atdd/checklist.md +374 -0
  370. package/src/bmm/workflows/testarch/atdd/instructions.md +806 -0
  371. package/src/bmm/workflows/testarch/atdd/workflow.yaml +47 -0
  372. package/src/bmm/workflows/testarch/automate/checklist.md +582 -0
  373. package/src/bmm/workflows/testarch/automate/instructions.md +1324 -0
  374. package/src/bmm/workflows/testarch/automate/workflow.yaml +54 -0
  375. package/src/bmm/workflows/testarch/ci/checklist.md +248 -0
  376. package/src/bmm/workflows/testarch/ci/github-actions-template.yaml +198 -0
  377. package/src/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +149 -0
  378. package/src/bmm/workflows/testarch/ci/instructions.md +536 -0
  379. package/src/bmm/workflows/testarch/ci/workflow.yaml +47 -0
  380. package/src/bmm/workflows/testarch/framework/checklist.md +321 -0
  381. package/src/bmm/workflows/testarch/framework/instructions.md +481 -0
  382. package/src/bmm/workflows/testarch/framework/workflow.yaml +49 -0
  383. package/src/bmm/workflows/testarch/nfr-assess/checklist.md +407 -0
  384. package/src/bmm/workflows/testarch/nfr-assess/instructions.md +722 -0
  385. package/src/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +445 -0
  386. package/src/bmm/workflows/testarch/nfr-assess/workflow.yaml +49 -0
  387. package/src/bmm/workflows/testarch/test-design/checklist.md +235 -0
  388. package/src/bmm/workflows/testarch/test-design/instructions.md +788 -0
  389. package/src/bmm/workflows/testarch/test-design/test-design-template.md +294 -0
  390. package/src/bmm/workflows/testarch/test-design/workflow.yaml +56 -0
  391. package/src/bmm/workflows/testarch/test-review/checklist.md +472 -0
  392. package/src/bmm/workflows/testarch/test-review/instructions.md +628 -0
  393. package/src/bmm/workflows/testarch/test-review/test-review-template.md +390 -0
  394. package/src/bmm/workflows/testarch/test-review/workflow.yaml +48 -0
  395. package/src/bmm/workflows/testarch/trace/checklist.md +655 -0
  396. package/src/bmm/workflows/testarch/trace/instructions.md +1047 -0
  397. package/src/bmm/workflows/testarch/trace/trace-template.md +675 -0
  398. package/src/bmm/workflows/testarch/trace/workflow.yaml +57 -0
  399. package/src/bmm/workflows/workflow-status/init/instructions.md +346 -0
  400. package/src/bmm/workflows/workflow-status/init/workflow.yaml +30 -0
  401. package/src/bmm/workflows/workflow-status/instructions.md +397 -0
  402. package/src/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +103 -0
  403. package/src/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +100 -0
  404. package/src/bmm/workflows/workflow-status/paths/method-brownfield.yaml +103 -0
  405. package/src/bmm/workflows/workflow-status/paths/method-greenfield.yaml +100 -0
  406. package/src/bmm/workflows/workflow-status/project-levels.yaml +59 -0
  407. package/src/bmm/workflows/workflow-status/workflow-status-template.yaml +24 -0
  408. package/src/bmm/workflows/workflow-status/workflow.yaml +32 -0
  409. package/src/core/_module-installer/installer.js +60 -0
  410. package/src/core/agents/bmad-master.agent.yaml +30 -0
  411. package/src/core/lib/scope/artifact-resolver.js +298 -0
  412. package/src/core/lib/scope/event-logger.js +400 -0
  413. package/src/core/lib/scope/index.js +30 -0
  414. package/src/core/lib/scope/scope-context.js +301 -0
  415. package/src/core/lib/scope/scope-initializer.js +456 -0
  416. package/src/core/lib/scope/scope-manager.js +512 -0
  417. package/src/core/lib/scope/scope-migrator.js +434 -0
  418. package/src/core/lib/scope/scope-sync.js +483 -0
  419. package/src/core/lib/scope/scope-validator.js +294 -0
  420. package/src/core/lib/scope/state-lock.js +336 -0
  421. package/src/core/module.yaml +53 -0
  422. package/src/core/resources/excalidraw/README.md +160 -0
  423. package/src/core/resources/excalidraw/excalidraw-helpers.md +127 -0
  424. package/src/core/resources/excalidraw/library-loader.md +50 -0
  425. package/src/core/resources/excalidraw/validate-json-instructions.md +79 -0
  426. package/src/core/tasks/editorial-review-prose.xml +91 -0
  427. package/src/core/tasks/editorial-review-structure.xml +198 -0
  428. package/src/core/tasks/index-docs.xml +65 -0
  429. package/src/core/tasks/review-adversarial-general.xml +46 -0
  430. package/src/core/tasks/shard-doc.xml +109 -0
  431. package/src/core/tasks/workflow.xml +277 -0
  432. package/src/core/workflows/advanced-elicitation/methods.csv +51 -0
  433. package/src/core/workflows/advanced-elicitation/workflow.xml +117 -0
  434. package/src/core/workflows/brainstorming/brain-methods.csv +62 -0
  435. package/src/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -0
  436. package/src/core/workflows/brainstorming/steps/step-01b-continue.md +122 -0
  437. package/src/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -0
  438. package/src/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -0
  439. package/src/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -0
  440. package/src/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -0
  441. package/src/core/workflows/brainstorming/steps/step-03-technique-execution.md +399 -0
  442. package/src/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -0
  443. package/src/core/workflows/brainstorming/template.md +15 -0
  444. package/src/core/workflows/brainstorming/workflow.md +58 -0
  445. package/src/core/workflows/party-mode/steps/step-01-agent-loading.md +138 -0
  446. package/src/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +187 -0
  447. package/src/core/workflows/party-mode/steps/step-03-graceful-exit.md +157 -0
  448. package/src/core/workflows/party-mode/workflow.md +194 -0
  449. package/src/utility/agent-components/activation-rules.txt +6 -0
  450. package/src/utility/agent-components/activation-steps.txt +28 -0
  451. package/src/utility/agent-components/agent-command-header.md +1 -0
  452. package/src/utility/agent-components/agent.customize.template.yaml +41 -0
  453. package/src/utility/agent-components/handler-action.txt +4 -0
  454. package/src/utility/agent-components/handler-data.txt +5 -0
  455. package/src/utility/agent-components/handler-exec.txt +19 -0
  456. package/src/utility/agent-components/handler-multi.txt +14 -0
  457. package/src/utility/agent-components/handler-tmpl.txt +5 -0
  458. package/src/utility/agent-components/handler-validate-workflow.txt +7 -0
  459. package/src/utility/agent-components/handler-workflow.txt +10 -0
  460. package/src/utility/agent-components/menu-handlers.txt +6 -0
  461. package/test/README.md +295 -0
  462. package/test/fixtures/agent-schema/invalid/critical-actions/actions-as-string.agent.yaml +27 -0
  463. package/test/fixtures/agent-schema/invalid/critical-actions/empty-string-in-actions.agent.yaml +30 -0
  464. package/test/fixtures/agent-schema/invalid/menu/empty-menu.agent.yaml +22 -0
  465. package/test/fixtures/agent-schema/invalid/menu/missing-menu.agent.yaml +20 -0
  466. package/test/fixtures/agent-schema/invalid/menu-commands/empty-command-target.agent.yaml +25 -0
  467. package/test/fixtures/agent-schema/invalid/menu-commands/no-command-target.agent.yaml +24 -0
  468. package/test/fixtures/agent-schema/invalid/menu-triggers/camel-case.agent.yaml +25 -0
  469. package/test/fixtures/agent-schema/invalid/menu-triggers/compound-invalid-format.agent.yaml +25 -0
  470. package/test/fixtures/agent-schema/invalid/menu-triggers/compound-mismatched-kebab.agent.yaml +25 -0
  471. package/test/fixtures/agent-schema/invalid/menu-triggers/duplicate-triggers.agent.yaml +31 -0
  472. package/test/fixtures/agent-schema/invalid/menu-triggers/empty-trigger.agent.yaml +25 -0
  473. package/test/fixtures/agent-schema/invalid/menu-triggers/leading-asterisk.agent.yaml +25 -0
  474. package/test/fixtures/agent-schema/invalid/menu-triggers/snake-case.agent.yaml +25 -0
  475. package/test/fixtures/agent-schema/invalid/menu-triggers/trigger-with-spaces.agent.yaml +25 -0
  476. package/test/fixtures/agent-schema/invalid/metadata/empty-module-string.agent.yaml +26 -0
  477. package/test/fixtures/agent-schema/invalid/metadata/empty-name.agent.yaml +24 -0
  478. package/test/fixtures/agent-schema/invalid/metadata/extra-metadata-fields.agent.yaml +27 -0
  479. package/test/fixtures/agent-schema/invalid/metadata/missing-id.agent.yaml +23 -0
  480. package/test/fixtures/agent-schema/invalid/persona/empty-principles-array.agent.yaml +24 -0
  481. package/test/fixtures/agent-schema/invalid/persona/empty-string-in-principles.agent.yaml +27 -0
  482. package/test/fixtures/agent-schema/invalid/persona/extra-persona-fields.agent.yaml +27 -0
  483. package/test/fixtures/agent-schema/invalid/persona/missing-role.agent.yaml +24 -0
  484. package/test/fixtures/agent-schema/invalid/prompts/empty-content.agent.yaml +29 -0
  485. package/test/fixtures/agent-schema/invalid/prompts/extra-prompt-fields.agent.yaml +31 -0
  486. package/test/fixtures/agent-schema/invalid/prompts/missing-content.agent.yaml +28 -0
  487. package/test/fixtures/agent-schema/invalid/prompts/missing-id.agent.yaml +28 -0
  488. package/test/fixtures/agent-schema/invalid/top-level/empty-file.agent.yaml +5 -0
  489. package/test/fixtures/agent-schema/invalid/top-level/extra-top-level-keys.agent.yaml +28 -0
  490. package/test/fixtures/agent-schema/invalid/top-level/missing-agent-key.agent.yaml +11 -0
  491. package/test/fixtures/agent-schema/invalid/yaml-errors/invalid-indentation.agent.yaml +19 -0
  492. package/test/fixtures/agent-schema/invalid/yaml-errors/malformed-yaml.agent.yaml +18 -0
  493. package/test/fixtures/agent-schema/valid/critical-actions/empty-critical-actions.agent.yaml +24 -0
  494. package/test/fixtures/agent-schema/valid/critical-actions/no-critical-actions.agent.yaml +22 -0
  495. package/test/fixtures/agent-schema/valid/critical-actions/valid-critical-actions.agent.yaml +27 -0
  496. package/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml +31 -0
  497. package/test/fixtures/agent-schema/valid/menu/single-menu-item.agent.yaml +22 -0
  498. package/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml +38 -0
  499. package/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml +24 -0
  500. package/test/fixtures/agent-schema/valid/menu-triggers/compound-triggers.agent.yaml +31 -0
  501. package/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml +34 -0
  502. package/test/fixtures/agent-schema/valid/metadata/core-agent-with-module.agent.yaml +24 -0
  503. package/test/fixtures/agent-schema/valid/metadata/empty-module-name-in-path.agent.yaml +24 -0
  504. package/test/fixtures/agent-schema/valid/metadata/malformed-path-treated-as-core.agent.yaml +24 -0
  505. package/test/fixtures/agent-schema/valid/metadata/module-agent-correct.agent.yaml +24 -0
  506. package/test/fixtures/agent-schema/valid/metadata/module-agent-missing-module.agent.yaml +23 -0
  507. package/test/fixtures/agent-schema/valid/metadata/wrong-module-value.agent.yaml +24 -0
  508. package/test/fixtures/agent-schema/valid/persona/complete-persona.agent.yaml +24 -0
  509. package/test/fixtures/agent-schema/valid/prompts/empty-prompts.agent.yaml +24 -0
  510. package/test/fixtures/agent-schema/valid/prompts/no-prompts.agent.yaml +22 -0
  511. package/test/fixtures/agent-schema/valid/prompts/valid-prompts-minimal.agent.yaml +28 -0
  512. package/test/fixtures/agent-schema/valid/prompts/valid-prompts-with-description.agent.yaml +30 -0
  513. package/test/fixtures/agent-schema/valid/top-level/minimal-core-agent.agent.yaml +24 -0
  514. package/test/test-agent-schema.js +387 -0
  515. package/test/test-cli-integration.sh +159 -0
  516. package/test/test-installation-components.js +214 -0
  517. package/test/test-scope-e2e.js +439 -0
  518. package/test/test-scope-system.js +781 -0
  519. package/test/unit-test-schema.js +133 -0
  520. package/tools/bmad-npx-wrapper.js +38 -0
  521. package/tools/build-docs.js +577 -0
  522. package/tools/cli/README.md +7 -0
  523. package/tools/cli/bmad-cli.js +58 -0
  524. package/tools/cli/commands/install.js +87 -0
  525. package/tools/cli/commands/scope.js +474 -0
  526. package/tools/cli/external-official-modules.yaml +41 -0
  527. package/tools/cli/installers/install-messages.yaml +58 -0
  528. package/tools/cli/installers/lib/core/config-collector.js +1079 -0
  529. package/tools/cli/installers/lib/core/custom-module-cache.js +259 -0
  530. package/tools/cli/installers/lib/core/dependency-resolver.js +739 -0
  531. package/tools/cli/installers/lib/core/detector.js +223 -0
  532. package/tools/cli/installers/lib/core/ide-config-manager.js +156 -0
  533. package/tools/cli/installers/lib/core/installer.js +2585 -0
  534. package/tools/cli/installers/lib/core/manifest-generator.js +963 -0
  535. package/tools/cli/installers/lib/core/manifest.js +590 -0
  536. package/tools/cli/installers/lib/custom/handler.js +363 -0
  537. package/tools/cli/installers/lib/ide/_base-ide.js +654 -0
  538. package/tools/cli/installers/lib/ide/antigravity.js +486 -0
  539. package/tools/cli/installers/lib/ide/auggie.js +244 -0
  540. package/tools/cli/installers/lib/ide/claude-code.js +487 -0
  541. package/tools/cli/installers/lib/ide/cline.js +269 -0
  542. package/tools/cli/installers/lib/ide/codex.js +375 -0
  543. package/tools/cli/installers/lib/ide/crush.js +300 -0
  544. package/tools/cli/installers/lib/ide/cursor.js +169 -0
  545. package/tools/cli/installers/lib/ide/gemini.js +301 -0
  546. package/tools/cli/installers/lib/ide/github-copilot.js +383 -0
  547. package/tools/cli/installers/lib/ide/iflow.js +191 -0
  548. package/tools/cli/installers/lib/ide/kilo.js +250 -0
  549. package/tools/cli/installers/lib/ide/kiro-cli.js +326 -0
  550. package/tools/cli/installers/lib/ide/manager.js +244 -0
  551. package/tools/cli/installers/lib/ide/opencode.js +257 -0
  552. package/tools/cli/installers/lib/ide/qwen.js +372 -0
  553. package/tools/cli/installers/lib/ide/roo.js +270 -0
  554. package/tools/cli/installers/lib/ide/rovo-dev.js +290 -0
  555. package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +96 -0
  556. package/tools/cli/installers/lib/ide/shared/bmad-artifacts.js +158 -0
  557. package/tools/cli/installers/lib/ide/shared/module-injections.js +136 -0
  558. package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +119 -0
  559. package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +242 -0
  560. package/tools/cli/installers/lib/ide/templates/agent-command-template.md +29 -0
  561. package/tools/cli/installers/lib/ide/templates/gemini-agent-command.toml +14 -0
  562. package/tools/cli/installers/lib/ide/templates/gemini-task-command.toml +12 -0
  563. package/tools/cli/installers/lib/ide/templates/workflow-command-template.md +30 -0
  564. package/tools/cli/installers/lib/ide/templates/workflow-commander.md +45 -0
  565. package/tools/cli/installers/lib/ide/trae.js +313 -0
  566. package/tools/cli/installers/lib/ide/windsurf.js +258 -0
  567. package/tools/cli/installers/lib/message-loader.js +85 -0
  568. package/tools/cli/installers/lib/modules/external-manager.js +133 -0
  569. package/tools/cli/installers/lib/modules/manager.js +1362 -0
  570. package/tools/cli/lib/activation-builder.js +163 -0
  571. package/tools/cli/lib/agent/compiler.js +522 -0
  572. package/tools/cli/lib/agent/installer.js +716 -0
  573. package/tools/cli/lib/agent/template-engine.js +152 -0
  574. package/tools/cli/lib/agent-analyzer.js +109 -0
  575. package/tools/cli/lib/agent-party-generator.js +194 -0
  576. package/tools/cli/lib/cli-utils.js +227 -0
  577. package/tools/cli/lib/config.js +213 -0
  578. package/tools/cli/lib/file-ops.js +204 -0
  579. package/tools/cli/lib/platform-codes.js +116 -0
  580. package/tools/cli/lib/project-root.js +77 -0
  581. package/tools/cli/lib/prompts.js +433 -0
  582. package/tools/cli/lib/ui.js +1591 -0
  583. package/tools/cli/lib/xml-handler.js +177 -0
  584. package/tools/cli/lib/xml-to-markdown.js +82 -0
  585. package/tools/cli/lib/yaml-format.js +245 -0
  586. package/tools/cli/lib/yaml-xml-builder.js +587 -0
  587. package/tools/cli/scripts/migrate-workflows.js +273 -0
  588. package/tools/docs/BUNDLE_DISTRIBUTION_SETUP.md +95 -0
  589. package/tools/docs/index.md +2 -0
  590. package/tools/fix-doc-links.js +288 -0
  591. package/tools/flattener/aggregate.js +76 -0
  592. package/tools/flattener/binary.js +80 -0
  593. package/tools/flattener/discovery.js +71 -0
  594. package/tools/flattener/files.js +35 -0
  595. package/tools/flattener/ignoreRules.js +172 -0
  596. package/tools/flattener/main.js +483 -0
  597. package/tools/flattener/projectRoot.js +201 -0
  598. package/tools/flattener/prompts.js +44 -0
  599. package/tools/flattener/stats.helpers.js +368 -0
  600. package/tools/flattener/stats.js +75 -0
  601. package/tools/flattener/test-matrix.js +409 -0
  602. package/tools/flattener/xml.js +82 -0
  603. package/tools/format-workflow-md.js +263 -0
  604. package/tools/lib/xml-utils.js +13 -0
  605. package/tools/maintainer/review-pr-README.md +55 -0
  606. package/tools/maintainer/review-pr.md +242 -0
  607. package/tools/migrate-custom-module-paths.js +124 -0
  608. package/tools/platform-codes.yaml +157 -0
  609. package/tools/schema/agent.js +493 -0
  610. package/tools/validate-agent-schema.js +110 -0
  611. package/tools/validate-doc-links.js +363 -0
  612. package/tools/validate-svg-changes.sh +356 -0
  613. package/website/README.md +76 -0
  614. package/website/astro.config.mjs +228 -0
  615. package/website/public/favicon.ico +0 -0
  616. package/website/public/img/bmad-dark.png +0 -0
  617. package/website/public/img/bmad-light.png +0 -0
  618. package/website/public/img/logo.svg +4 -0
  619. package/website/public/robots.txt +37 -0
  620. package/website/src/components/Banner.astro +59 -0
  621. package/website/src/components/Header.astro +121 -0
  622. package/website/src/components/MobileMenuFooter.astro +53 -0
  623. package/website/src/content/config.ts +6 -0
  624. package/website/src/lib/site-url.js +25 -0
  625. package/website/src/rehype-markdown-links.js +102 -0
  626. package/website/src/styles/custom.css +485 -0
@@ -0,0 +1,750 @@
1
+ # Feature Flag Governance
2
+
3
+ ## Principle
4
+
5
+ Feature flags enable controlled rollouts and A/B testing, but require disciplined testing governance. Centralize flag definitions in a frozen enum, test both enabled and disabled states, clean up targeting after each spec, and maintain a comprehensive flag lifecycle checklist. For LaunchDarkly-style systems, script API helpers to seed variations programmatically rather than manual UI mutations.
6
+
7
+ ## Rationale
8
+
9
+ Poorly managed feature flags become technical debt: untested variations ship broken code, forgotten flags clutter the codebase, and shared environments become unstable from leftover targeting rules. Structured governance ensures flags are testable, traceable, temporary, and safe. Testing both states prevents surprises when flags flip in production.
10
+
11
+ ## Pattern Examples
12
+
13
+ ### Example 1: Feature Flag Enum Pattern with Type Safety
14
+
15
+ **Context**: Centralized flag management with TypeScript type safety and runtime validation.
16
+
17
+ **Implementation**:
18
+
19
+ ```typescript
20
+ // src/utils/feature-flags.ts
21
+ /**
22
+ * Centralized feature flag definitions
23
+ * - Object.freeze prevents runtime modifications
24
+ * - TypeScript ensures compile-time type safety
25
+ * - Single source of truth for all flag keys
26
+ */
27
+ export const FLAGS = Object.freeze({
28
+ // User-facing features
29
+ NEW_CHECKOUT_FLOW: 'new-checkout-flow',
30
+ DARK_MODE: 'dark-mode',
31
+ ENHANCED_SEARCH: 'enhanced-search',
32
+
33
+ // Experiments
34
+ PRICING_EXPERIMENT_A: 'pricing-experiment-a',
35
+ HOMEPAGE_VARIANT_B: 'homepage-variant-b',
36
+
37
+ // Infrastructure
38
+ USE_NEW_API_ENDPOINT: 'use-new-api-endpoint',
39
+ ENABLE_ANALYTICS_V2: 'enable-analytics-v2',
40
+
41
+ // Killswitches (emergency disables)
42
+ DISABLE_PAYMENT_PROCESSING: 'disable-payment-processing',
43
+ DISABLE_EMAIL_NOTIFICATIONS: 'disable-email-notifications',
44
+ } as const);
45
+
46
+ /**
47
+ * Type-safe flag keys
48
+ * Prevents typos and ensures autocomplete in IDEs
49
+ */
50
+ export type FlagKey = (typeof FLAGS)[keyof typeof FLAGS];
51
+
52
+ /**
53
+ * Flag metadata for governance
54
+ */
55
+ type FlagMetadata = {
56
+ key: FlagKey;
57
+ name: string;
58
+ owner: string;
59
+ createdDate: string;
60
+ expiryDate?: string;
61
+ defaultState: boolean;
62
+ requiresCleanup: boolean;
63
+ dependencies?: FlagKey[];
64
+ telemetryEvents?: string[];
65
+ };
66
+
67
+ /**
68
+ * Flag registry with governance metadata
69
+ * Used for flag lifecycle tracking and cleanup alerts
70
+ */
71
+ export const FLAG_REGISTRY: Record<FlagKey, FlagMetadata> = {
72
+ [FLAGS.NEW_CHECKOUT_FLOW]: {
73
+ key: FLAGS.NEW_CHECKOUT_FLOW,
74
+ name: 'New Checkout Flow',
75
+ owner: 'payments-team',
76
+ createdDate: '2025-01-15',
77
+ expiryDate: '2025-03-15',
78
+ defaultState: false,
79
+ requiresCleanup: true,
80
+ dependencies: [FLAGS.USE_NEW_API_ENDPOINT],
81
+ telemetryEvents: ['checkout_started', 'checkout_completed'],
82
+ },
83
+ [FLAGS.DARK_MODE]: {
84
+ key: FLAGS.DARK_MODE,
85
+ name: 'Dark Mode UI',
86
+ owner: 'frontend-team',
87
+ createdDate: '2025-01-10',
88
+ defaultState: false,
89
+ requiresCleanup: false, // Permanent feature toggle
90
+ },
91
+ // ... rest of registry
92
+ };
93
+
94
+ /**
95
+ * Validate flag exists in registry
96
+ * Throws at runtime if flag is unregistered
97
+ */
98
+ export function validateFlag(flag: string): asserts flag is FlagKey {
99
+ if (!Object.values(FLAGS).includes(flag as FlagKey)) {
100
+ throw new Error(`Unregistered feature flag: ${flag}`);
101
+ }
102
+ }
103
+
104
+ /**
105
+ * Check if flag is expired (needs removal)
106
+ */
107
+ export function isFlagExpired(flag: FlagKey): boolean {
108
+ const metadata = FLAG_REGISTRY[flag];
109
+ if (!metadata.expiryDate) return false;
110
+
111
+ const expiry = new Date(metadata.expiryDate);
112
+ return Date.now() > expiry.getTime();
113
+ }
114
+
115
+ /**
116
+ * Get all expired flags requiring cleanup
117
+ */
118
+ export function getExpiredFlags(): FlagMetadata[] {
119
+ return Object.values(FLAG_REGISTRY).filter((meta) => isFlagExpired(meta.key));
120
+ }
121
+ ```
122
+
123
+ **Usage in application code**:
124
+
125
+ ```typescript
126
+ // components/Checkout.tsx
127
+ import { FLAGS } from '@/utils/feature-flags';
128
+ import { useFeatureFlag } from '@/hooks/useFeatureFlag';
129
+
130
+ export function Checkout() {
131
+ const isNewFlow = useFeatureFlag(FLAGS.NEW_CHECKOUT_FLOW);
132
+
133
+ return isNewFlow ? <NewCheckoutFlow /> : <LegacyCheckoutFlow />;
134
+ }
135
+ ```
136
+
137
+ **Key Points**:
138
+
139
+ - **Type safety**: TypeScript catches typos at compile time
140
+ - **Runtime validation**: validateFlag ensures only registered flags used
141
+ - **Metadata tracking**: Owner, dates, dependencies documented
142
+ - **Expiry alerts**: Automated detection of stale flags
143
+ - **Single source of truth**: All flags defined in one place
144
+
145
+ ---
146
+
147
+ ### Example 2: Feature Flag Testing Pattern (Both States)
148
+
149
+ **Context**: Comprehensive testing of feature flag variations with proper cleanup.
150
+
151
+ **Implementation**:
152
+
153
+ ```typescript
154
+ // tests/e2e/checkout-feature-flag.spec.ts
155
+ import { test, expect } from '@playwright/test';
156
+ import { FLAGS } from '@/utils/feature-flags';
157
+
158
+ /**
159
+ * Feature Flag Testing Strategy:
160
+ * 1. Test BOTH enabled and disabled states
161
+ * 2. Clean up targeting after each test
162
+ * 3. Use dedicated test users (not production data)
163
+ * 4. Verify telemetry events fire correctly
164
+ */
165
+
166
+ test.describe('Checkout Flow - Feature Flag Variations', () => {
167
+ let testUserId: string;
168
+
169
+ test.beforeEach(async () => {
170
+ // Generate unique test user ID
171
+ testUserId = `test-user-${Date.now()}`;
172
+ });
173
+
174
+ test.afterEach(async ({ request }) => {
175
+ // CRITICAL: Clean up flag targeting to prevent shared env pollution
176
+ await request.post('/api/feature-flags/cleanup', {
177
+ data: {
178
+ flagKey: FLAGS.NEW_CHECKOUT_FLOW,
179
+ userId: testUserId,
180
+ },
181
+ });
182
+ });
183
+
184
+ test('should use NEW checkout flow when flag is ENABLED', async ({ page, request }) => {
185
+ // Arrange: Enable flag for test user
186
+ await request.post('/api/feature-flags/target', {
187
+ data: {
188
+ flagKey: FLAGS.NEW_CHECKOUT_FLOW,
189
+ userId: testUserId,
190
+ variation: true, // ENABLED
191
+ },
192
+ });
193
+
194
+ // Act: Navigate as targeted user
195
+ await page.goto('/checkout', {
196
+ extraHTTPHeaders: {
197
+ 'X-Test-User-ID': testUserId,
198
+ },
199
+ });
200
+
201
+ // Assert: New flow UI elements visible
202
+ await expect(page.getByTestId('checkout-v2-container')).toBeVisible();
203
+ await expect(page.getByTestId('express-payment-options')).toBeVisible();
204
+ await expect(page.getByTestId('saved-addresses-dropdown')).toBeVisible();
205
+
206
+ // Assert: Legacy flow NOT visible
207
+ await expect(page.getByTestId('checkout-v1-container')).not.toBeVisible();
208
+
209
+ // Assert: Telemetry event fired
210
+ const analyticsEvents = await page.evaluate(() => (window as any).__ANALYTICS_EVENTS__ || []);
211
+ expect(analyticsEvents).toContainEqual(
212
+ expect.objectContaining({
213
+ event: 'checkout_started',
214
+ properties: expect.objectContaining({
215
+ variant: 'new_flow',
216
+ }),
217
+ }),
218
+ );
219
+ });
220
+
221
+ test('should use LEGACY checkout flow when flag is DISABLED', async ({ page, request }) => {
222
+ // Arrange: Disable flag for test user (or don't target at all)
223
+ await request.post('/api/feature-flags/target', {
224
+ data: {
225
+ flagKey: FLAGS.NEW_CHECKOUT_FLOW,
226
+ userId: testUserId,
227
+ variation: false, // DISABLED
228
+ },
229
+ });
230
+
231
+ // Act: Navigate as targeted user
232
+ await page.goto('/checkout', {
233
+ extraHTTPHeaders: {
234
+ 'X-Test-User-ID': testUserId,
235
+ },
236
+ });
237
+
238
+ // Assert: Legacy flow UI elements visible
239
+ await expect(page.getByTestId('checkout-v1-container')).toBeVisible();
240
+ await expect(page.getByTestId('legacy-payment-form')).toBeVisible();
241
+
242
+ // Assert: New flow NOT visible
243
+ await expect(page.getByTestId('checkout-v2-container')).not.toBeVisible();
244
+ await expect(page.getByTestId('express-payment-options')).not.toBeVisible();
245
+
246
+ // Assert: Telemetry event fired with correct variant
247
+ const analyticsEvents = await page.evaluate(() => (window as any).__ANALYTICS_EVENTS__ || []);
248
+ expect(analyticsEvents).toContainEqual(
249
+ expect.objectContaining({
250
+ event: 'checkout_started',
251
+ properties: expect.objectContaining({
252
+ variant: 'legacy_flow',
253
+ }),
254
+ }),
255
+ );
256
+ });
257
+
258
+ test('should handle flag evaluation errors gracefully', async ({ page, request }) => {
259
+ // Arrange: Simulate flag service unavailable
260
+ await page.route('**/api/feature-flags/evaluate', (route) => route.fulfill({ status: 500, body: 'Service Unavailable' }));
261
+
262
+ // Act: Navigate (should fallback to default state)
263
+ await page.goto('/checkout', {
264
+ extraHTTPHeaders: {
265
+ 'X-Test-User-ID': testUserId,
266
+ },
267
+ });
268
+
269
+ // Assert: Fallback to safe default (legacy flow)
270
+ await expect(page.getByTestId('checkout-v1-container')).toBeVisible();
271
+
272
+ // Assert: Error logged but no user-facing error
273
+ const consoleErrors = [];
274
+ page.on('console', (msg) => {
275
+ if (msg.type() === 'error') consoleErrors.push(msg.text());
276
+ });
277
+ expect(consoleErrors).toContain(expect.stringContaining('Feature flag evaluation failed'));
278
+ });
279
+ });
280
+ ```
281
+
282
+ **Cypress equivalent**:
283
+
284
+ ```javascript
285
+ // cypress/e2e/checkout-feature-flag.cy.ts
286
+ import { FLAGS } from '@/utils/feature-flags';
287
+
288
+ describe('Checkout Flow - Feature Flag Variations', () => {
289
+ let testUserId;
290
+
291
+ beforeEach(() => {
292
+ testUserId = `test-user-${Date.now()}`;
293
+ });
294
+
295
+ afterEach(() => {
296
+ // Clean up targeting
297
+ cy.task('removeFeatureFlagTarget', {
298
+ flagKey: FLAGS.NEW_CHECKOUT_FLOW,
299
+ userId: testUserId,
300
+ });
301
+ });
302
+
303
+ it('should use NEW checkout flow when flag is ENABLED', () => {
304
+ // Arrange: Enable flag via Cypress task
305
+ cy.task('setFeatureFlagVariation', {
306
+ flagKey: FLAGS.NEW_CHECKOUT_FLOW,
307
+ userId: testUserId,
308
+ variation: true,
309
+ });
310
+
311
+ // Act
312
+ cy.visit('/checkout', {
313
+ headers: { 'X-Test-User-ID': testUserId },
314
+ });
315
+
316
+ // Assert
317
+ cy.get('[data-testid="checkout-v2-container"]').should('be.visible');
318
+ cy.get('[data-testid="checkout-v1-container"]').should('not.exist');
319
+ });
320
+
321
+ it('should use LEGACY checkout flow when flag is DISABLED', () => {
322
+ // Arrange: Disable flag
323
+ cy.task('setFeatureFlagVariation', {
324
+ flagKey: FLAGS.NEW_CHECKOUT_FLOW,
325
+ userId: testUserId,
326
+ variation: false,
327
+ });
328
+
329
+ // Act
330
+ cy.visit('/checkout', {
331
+ headers: { 'X-Test-User-ID': testUserId },
332
+ });
333
+
334
+ // Assert
335
+ cy.get('[data-testid="checkout-v1-container"]').should('be.visible');
336
+ cy.get('[data-testid="checkout-v2-container"]').should('not.exist');
337
+ });
338
+ });
339
+ ```
340
+
341
+ **Key Points**:
342
+
343
+ - **Test both states**: Enabled AND disabled variations
344
+ - **Automatic cleanup**: afterEach removes targeting (prevent pollution)
345
+ - **Unique test users**: Avoid conflicts with real user data
346
+ - **Telemetry validation**: Verify analytics events fire correctly
347
+ - **Graceful degradation**: Test fallback behavior on errors
348
+
349
+ ---
350
+
351
+ ### Example 3: Feature Flag Targeting Helper Pattern
352
+
353
+ **Context**: Reusable helpers for programmatic flag control via LaunchDarkly/Split.io API.
354
+
355
+ **Implementation**:
356
+
357
+ ```typescript
358
+ // tests/support/feature-flag-helpers.ts
359
+ import { request as playwrightRequest } from '@playwright/test';
360
+ import { FLAGS, FlagKey } from '@/utils/feature-flags';
361
+
362
+ /**
363
+ * LaunchDarkly API client configuration
364
+ * Use test project SDK key (NOT production)
365
+ */
366
+ const LD_SDK_KEY = process.env.LD_SDK_KEY_TEST;
367
+ const LD_API_BASE = 'https://app.launchdarkly.com/api/v2';
368
+
369
+ type FlagVariation = boolean | string | number | object;
370
+
371
+ /**
372
+ * Set flag variation for specific user
373
+ * Uses LaunchDarkly API to create user target
374
+ */
375
+ export async function setFlagForUser(flagKey: FlagKey, userId: string, variation: FlagVariation): Promise<void> {
376
+ const response = await playwrightRequest.newContext().then((ctx) =>
377
+ ctx.post(`${LD_API_BASE}/flags/${flagKey}/targeting`, {
378
+ headers: {
379
+ Authorization: LD_SDK_KEY!,
380
+ 'Content-Type': 'application/json',
381
+ },
382
+ data: {
383
+ targets: [
384
+ {
385
+ values: [userId],
386
+ variation: variation ? 1 : 0, // 0 = off, 1 = on
387
+ },
388
+ ],
389
+ },
390
+ }),
391
+ );
392
+
393
+ if (!response.ok()) {
394
+ throw new Error(`Failed to set flag ${flagKey} for user ${userId}: ${response.status()}`);
395
+ }
396
+ }
397
+
398
+ /**
399
+ * Remove user from flag targeting
400
+ * CRITICAL for test cleanup
401
+ */
402
+ export async function removeFlagTarget(flagKey: FlagKey, userId: string): Promise<void> {
403
+ const response = await playwrightRequest.newContext().then((ctx) =>
404
+ ctx.delete(`${LD_API_BASE}/flags/${flagKey}/targeting/users/${userId}`, {
405
+ headers: {
406
+ Authorization: LD_SDK_KEY!,
407
+ },
408
+ }),
409
+ );
410
+
411
+ if (!response.ok() && response.status() !== 404) {
412
+ // 404 is acceptable (user wasn't targeted)
413
+ throw new Error(`Failed to remove flag ${flagKey} target for user ${userId}: ${response.status()}`);
414
+ }
415
+ }
416
+
417
+ /**
418
+ * Percentage rollout helper
419
+ * Enable flag for N% of users
420
+ */
421
+ export async function setFlagRolloutPercentage(flagKey: FlagKey, percentage: number): Promise<void> {
422
+ if (percentage < 0 || percentage > 100) {
423
+ throw new Error('Percentage must be between 0 and 100');
424
+ }
425
+
426
+ const response = await playwrightRequest.newContext().then((ctx) =>
427
+ ctx.patch(`${LD_API_BASE}/flags/${flagKey}`, {
428
+ headers: {
429
+ Authorization: LD_SDK_KEY!,
430
+ 'Content-Type': 'application/json',
431
+ },
432
+ data: {
433
+ rollout: {
434
+ variations: [
435
+ { variation: 0, weight: 100 - percentage }, // off
436
+ { variation: 1, weight: percentage }, // on
437
+ ],
438
+ },
439
+ },
440
+ }),
441
+ );
442
+
443
+ if (!response.ok()) {
444
+ throw new Error(`Failed to set rollout for flag ${flagKey}: ${response.status()}`);
445
+ }
446
+ }
447
+
448
+ /**
449
+ * Enable flag globally (100% rollout)
450
+ */
451
+ export async function enableFlagGlobally(flagKey: FlagKey): Promise<void> {
452
+ await setFlagRolloutPercentage(flagKey, 100);
453
+ }
454
+
455
+ /**
456
+ * Disable flag globally (0% rollout)
457
+ */
458
+ export async function disableFlagGlobally(flagKey: FlagKey): Promise<void> {
459
+ await setFlagRolloutPercentage(flagKey, 0);
460
+ }
461
+
462
+ /**
463
+ * Stub feature flags in local/test environments
464
+ * Bypasses LaunchDarkly entirely
465
+ */
466
+ export function stubFeatureFlags(flags: Record<FlagKey, FlagVariation>): void {
467
+ // Set flags in localStorage or inject into window
468
+ if (typeof window !== 'undefined') {
469
+ (window as any).__STUBBED_FLAGS__ = flags;
470
+ }
471
+ }
472
+ ```
473
+
474
+ **Usage in Playwright fixture**:
475
+
476
+ ```typescript
477
+ // playwright/fixtures/feature-flag-fixture.ts
478
+ import { test as base } from '@playwright/test';
479
+ import { setFlagForUser, removeFlagTarget } from '../support/feature-flag-helpers';
480
+ import { FlagKey } from '@/utils/feature-flags';
481
+
482
+ type FeatureFlagFixture = {
483
+ featureFlags: {
484
+ enable: (flag: FlagKey, userId: string) => Promise<void>;
485
+ disable: (flag: FlagKey, userId: string) => Promise<void>;
486
+ cleanup: (flag: FlagKey, userId: string) => Promise<void>;
487
+ };
488
+ };
489
+
490
+ export const test = base.extend<FeatureFlagFixture>({
491
+ featureFlags: async ({}, use) => {
492
+ const cleanupQueue: Array<{ flag: FlagKey; userId: string }> = [];
493
+
494
+ await use({
495
+ enable: async (flag, userId) => {
496
+ await setFlagForUser(flag, userId, true);
497
+ cleanupQueue.push({ flag, userId });
498
+ },
499
+ disable: async (flag, userId) => {
500
+ await setFlagForUser(flag, userId, false);
501
+ cleanupQueue.push({ flag, userId });
502
+ },
503
+ cleanup: async (flag, userId) => {
504
+ await removeFlagTarget(flag, userId);
505
+ },
506
+ });
507
+
508
+ // Auto-cleanup after test
509
+ for (const { flag, userId } of cleanupQueue) {
510
+ await removeFlagTarget(flag, userId);
511
+ }
512
+ },
513
+ });
514
+ ```
515
+
516
+ **Key Points**:
517
+
518
+ - **API-driven control**: No manual UI clicks required
519
+ - **Auto-cleanup**: Fixture tracks and removes targeting
520
+ - **Percentage rollouts**: Test gradual feature releases
521
+ - **Stubbing option**: Local development without LaunchDarkly
522
+ - **Type-safe**: FlagKey prevents typos
523
+
524
+ ---
525
+
526
+ ### Example 4: Feature Flag Lifecycle Checklist & Cleanup Strategy
527
+
528
+ **Context**: Governance checklist and automated cleanup detection for stale flags.
529
+
530
+ **Implementation**:
531
+
532
+ ```typescript
533
+ // scripts/feature-flag-audit.ts
534
+ /**
535
+ * Feature Flag Lifecycle Audit Script
536
+ * Run weekly to detect stale flags requiring cleanup
537
+ */
538
+
539
+ import { FLAG_REGISTRY, FLAGS, getExpiredFlags, FlagKey } from '../src/utils/feature-flags';
540
+ import * as fs from 'fs';
541
+ import * as path from 'path';
542
+
543
+ type AuditResult = {
544
+ totalFlags: number;
545
+ expiredFlags: FlagKey[];
546
+ missingOwners: FlagKey[];
547
+ missingDates: FlagKey[];
548
+ permanentFlags: FlagKey[];
549
+ flagsNearingExpiry: FlagKey[];
550
+ };
551
+
552
+ /**
553
+ * Audit all feature flags for governance compliance
554
+ */
555
+ function auditFeatureFlags(): AuditResult {
556
+ const allFlags = Object.keys(FLAG_REGISTRY) as FlagKey[];
557
+ const expiredFlags = getExpiredFlags().map((meta) => meta.key);
558
+
559
+ // Flags expiring in next 30 days
560
+ const thirtyDaysFromNow = Date.now() + 30 * 24 * 60 * 60 * 1000;
561
+ const flagsNearingExpiry = allFlags.filter((flag) => {
562
+ const meta = FLAG_REGISTRY[flag];
563
+ if (!meta.expiryDate) return false;
564
+ const expiry = new Date(meta.expiryDate).getTime();
565
+ return expiry > Date.now() && expiry < thirtyDaysFromNow;
566
+ });
567
+
568
+ // Missing metadata
569
+ const missingOwners = allFlags.filter((flag) => !FLAG_REGISTRY[flag].owner);
570
+ const missingDates = allFlags.filter((flag) => !FLAG_REGISTRY[flag].createdDate);
571
+
572
+ // Permanent flags (no expiry, requiresCleanup = false)
573
+ const permanentFlags = allFlags.filter((flag) => {
574
+ const meta = FLAG_REGISTRY[flag];
575
+ return !meta.expiryDate && !meta.requiresCleanup;
576
+ });
577
+
578
+ return {
579
+ totalFlags: allFlags.length,
580
+ expiredFlags,
581
+ missingOwners,
582
+ missingDates,
583
+ permanentFlags,
584
+ flagsNearingExpiry,
585
+ };
586
+ }
587
+
588
+ /**
589
+ * Generate markdown report
590
+ */
591
+ function generateReport(audit: AuditResult): string {
592
+ let report = `# Feature Flag Audit Report\n\n`;
593
+ report += `**Date**: ${new Date().toISOString()}\n`;
594
+ report += `**Total Flags**: ${audit.totalFlags}\n\n`;
595
+
596
+ if (audit.expiredFlags.length > 0) {
597
+ report += `## āš ļø EXPIRED FLAGS - IMMEDIATE CLEANUP REQUIRED\n\n`;
598
+ audit.expiredFlags.forEach((flag) => {
599
+ const meta = FLAG_REGISTRY[flag];
600
+ report += `- **${meta.name}** (\`${flag}\`)\n`;
601
+ report += ` - Owner: ${meta.owner}\n`;
602
+ report += ` - Expired: ${meta.expiryDate}\n`;
603
+ report += ` - Action: Remove flag code, update tests, deploy\n\n`;
604
+ });
605
+ }
606
+
607
+ if (audit.flagsNearingExpiry.length > 0) {
608
+ report += `## ā° FLAGS EXPIRING SOON (Next 30 Days)\n\n`;
609
+ audit.flagsNearingExpiry.forEach((flag) => {
610
+ const meta = FLAG_REGISTRY[flag];
611
+ report += `- **${meta.name}** (\`${flag}\`)\n`;
612
+ report += ` - Owner: ${meta.owner}\n`;
613
+ report += ` - Expires: ${meta.expiryDate}\n`;
614
+ report += ` - Action: Plan cleanup or extend expiry\n\n`;
615
+ });
616
+ }
617
+
618
+ if (audit.permanentFlags.length > 0) {
619
+ report += `## šŸ”„ PERMANENT FLAGS (No Expiry)\n\n`;
620
+ audit.permanentFlags.forEach((flag) => {
621
+ const meta = FLAG_REGISTRY[flag];
622
+ report += `- **${meta.name}** (\`${flag}\`) - Owner: ${meta.owner}\n`;
623
+ });
624
+ report += `\n`;
625
+ }
626
+
627
+ if (audit.missingOwners.length > 0 || audit.missingDates.length > 0) {
628
+ report += `## āŒ GOVERNANCE ISSUES\n\n`;
629
+ if (audit.missingOwners.length > 0) {
630
+ report += `**Missing Owners**: ${audit.missingOwners.join(', ')}\n`;
631
+ }
632
+ if (audit.missingDates.length > 0) {
633
+ report += `**Missing Created Dates**: ${audit.missingDates.join(', ')}\n`;
634
+ }
635
+ report += `\n`;
636
+ }
637
+
638
+ return report;
639
+ }
640
+
641
+ /**
642
+ * Feature Flag Lifecycle Checklist
643
+ */
644
+ const FLAG_LIFECYCLE_CHECKLIST = `
645
+ # Feature Flag Lifecycle Checklist
646
+
647
+ ## Before Creating a New Flag
648
+
649
+ - [ ] **Name**: Follow naming convention (kebab-case, descriptive)
650
+ - [ ] **Owner**: Assign team/individual responsible
651
+ - [ ] **Default State**: Determine safe default (usually false)
652
+ - [ ] **Expiry Date**: Set removal date (30-90 days typical)
653
+ - [ ] **Dependencies**: Document related flags
654
+ - [ ] **Telemetry**: Plan analytics events to track
655
+ - [ ] **Rollback Plan**: Define how to disable quickly
656
+
657
+ ## During Development
658
+
659
+ - [ ] **Code Paths**: Both enabled/disabled states implemented
660
+ - [ ] **Tests**: Both variations tested in CI
661
+ - [ ] **Documentation**: Flag purpose documented in code/PR
662
+ - [ ] **Telemetry**: Analytics events instrumented
663
+ - [ ] **Error Handling**: Graceful degradation on flag service failure
664
+
665
+ ## Before Launch
666
+
667
+ - [ ] **QA**: Both states tested in staging
668
+ - [ ] **Rollout Plan**: Gradual rollout percentage defined
669
+ - [ ] **Monitoring**: Dashboards/alerts for flag-related metrics
670
+ - [ ] **Stakeholder Communication**: Product/design aligned
671
+
672
+ ## After Launch (Monitoring)
673
+
674
+ - [ ] **Metrics**: Success criteria tracked
675
+ - [ ] **Error Rates**: No increase in errors
676
+ - [ ] **Performance**: No degradation
677
+ - [ ] **User Feedback**: Qualitative data collected
678
+
679
+ ## Cleanup (Post-Launch)
680
+
681
+ - [ ] **Remove Flag Code**: Delete if/else branches
682
+ - [ ] **Update Tests**: Remove flag-specific tests
683
+ - [ ] **Remove Targeting**: Clear all user targets
684
+ - [ ] **Delete Flag Config**: Remove from LaunchDarkly/registry
685
+ - [ ] **Update Documentation**: Remove references
686
+ - [ ] **Deploy**: Ship cleanup changes
687
+ `;
688
+
689
+ // Run audit
690
+ const audit = auditFeatureFlags();
691
+ const report = generateReport(audit);
692
+
693
+ // Save report
694
+ const outputPath = path.join(__dirname, '../feature-flag-audit-report.md');
695
+ fs.writeFileSync(outputPath, report);
696
+ fs.writeFileSync(path.join(__dirname, '../FEATURE-FLAG-CHECKLIST.md'), FLAG_LIFECYCLE_CHECKLIST);
697
+
698
+ console.log(`āœ… Audit complete. Report saved to: ${outputPath}`);
699
+ console.log(`Total flags: ${audit.totalFlags}`);
700
+ console.log(`Expired flags: ${audit.expiredFlags.length}`);
701
+ console.log(`Flags expiring soon: ${audit.flagsNearingExpiry.length}`);
702
+
703
+ // Exit with error if expired flags exist
704
+ if (audit.expiredFlags.length > 0) {
705
+ console.error(`\nāŒ EXPIRED FLAGS DETECTED - CLEANUP REQUIRED`);
706
+ process.exit(1);
707
+ }
708
+ ```
709
+
710
+ **package.json scripts**:
711
+
712
+ ```json
713
+ {
714
+ "scripts": {
715
+ "feature-flags:audit": "ts-node scripts/feature-flag-audit.ts",
716
+ "feature-flags:audit:ci": "npm run feature-flags:audit || true"
717
+ }
718
+ }
719
+ ```
720
+
721
+ **Key Points**:
722
+
723
+ - **Automated detection**: Weekly audit catches stale flags
724
+ - **Lifecycle checklist**: Comprehensive governance guide
725
+ - **Expiry tracking**: Flags auto-expire after defined date
726
+ - **CI integration**: Audit runs in pipeline, warns on expiry
727
+ - **Ownership clarity**: Every flag has assigned owner
728
+
729
+ ---
730
+
731
+ ## Feature Flag Testing Checklist
732
+
733
+ Before merging flag-related code, verify:
734
+
735
+ - [ ] **Both states tested**: Enabled AND disabled variations covered
736
+ - [ ] **Cleanup automated**: afterEach removes targeting (no manual cleanup)
737
+ - [ ] **Unique test data**: Test users don't collide with production
738
+ - [ ] **Telemetry validated**: Analytics events fire for both variations
739
+ - [ ] **Error handling**: Graceful fallback when flag service unavailable
740
+ - [ ] **Flag metadata**: Owner, dates, dependencies documented in registry
741
+ - [ ] **Rollback plan**: Clear steps to disable flag in production
742
+ - [ ] **Expiry date set**: Removal date defined (or marked permanent)
743
+
744
+ ## Integration Points
745
+
746
+ - Used in workflows: `*automate` (test generation), `*framework` (flag setup)
747
+ - Related fragments: `test-quality.md`, `selective-testing.md`
748
+ - Flag services: LaunchDarkly, Split.io, Unleash, custom implementations
749
+
750
+ _Source: LaunchDarkly strategy blog, Murat test architecture notes, SEON feature flag governance_