bmalph 1.0.0 → 2.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (455) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +398 -217
  3. package/bmad/bmm/agents/analyst.agent.yaml +43 -36
  4. package/bmad/bmm/agents/architect.agent.yaml +29 -28
  5. package/bmad/bmm/agents/dev.agent.yaml +38 -38
  6. package/bmad/bmm/agents/pm.agent.yaml +44 -46
  7. package/bmad/bmm/agents/qa.agent.yaml +58 -0
  8. package/bmad/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -32
  9. package/bmad/bmm/agents/sm.agent.yaml +37 -36
  10. package/bmad/bmm/agents/tech-writer/tech-writer-sidecar/documentation-standards.md +223 -223
  11. package/bmad/bmm/agents/tech-writer/tech-writer.agent.yaml +46 -45
  12. package/bmad/bmm/agents/ux-designer.agent.yaml +27 -26
  13. package/bmad/bmm/data/project-context-template.md +26 -26
  14. package/bmad/bmm/module-help.csv +31 -31
  15. package/bmad/bmm/module.yaml +50 -44
  16. package/bmad/bmm/teams/default-party.csv +20 -21
  17. package/bmad/bmm/teams/team-fullstack.yaml +12 -12
  18. package/bmad/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -10
  19. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +177 -177
  20. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +161 -161
  21. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +199 -199
  22. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +202 -202
  23. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +205 -205
  24. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +219 -219
  25. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +162 -162
  26. package/bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md +57 -58
  27. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -137
  28. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -229
  29. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -238
  30. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -206
  31. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -234
  32. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -443
  33. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -182
  34. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -237
  35. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -249
  36. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -259
  37. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -177
  38. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -475
  39. package/bmad/bmm/workflows/1-analysis/research/research.template.md +29 -29
  40. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -137
  41. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -239
  42. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -248
  43. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -202
  44. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +233 -239
  45. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -486
  46. package/bmad/bmm/workflows/1-analysis/research/workflow-domain-research.md +54 -0
  47. package/bmad/bmm/workflows/1-analysis/research/workflow-market-research.md +54 -0
  48. package/bmad/bmm/workflows/1-analysis/research/workflow-technical-research.md +54 -0
  49. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/domain-complexity.csv +14 -12
  50. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/prd-purpose.md +197 -197
  51. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/project-types.csv +10 -10
  52. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-01-init.md +191 -191
  53. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-01b-continue.md +153 -153
  54. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-02-discovery.md +224 -224
  55. package/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02b-vision.md +154 -0
  56. package/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02c-executive-summary.md +170 -0
  57. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-03-success.md +226 -226
  58. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-04-journeys.md +213 -213
  59. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-05-domain.md +207 -207
  60. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-06-innovation.md +226 -226
  61. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-07-project-type.md +237 -237
  62. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-08-scoping.md +228 -228
  63. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-09-functional.md +231 -231
  64. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-10-nonfunctional.md +242 -242
  65. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-11-polish.md +217 -217
  66. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-12-complete.md +124 -124
  67. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-01-discovery.md +247 -247
  68. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-01b-legacy-conversion.md +208 -208
  69. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-02-review.md +249 -249
  70. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-03-edit.md +253 -253
  71. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-04-complete.md +168 -168
  72. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-01-discovery.md +226 -218
  73. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-02-format-detection.md +191 -191
  74. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-02b-parity-check.md +209 -209
  75. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-03-density-validation.md +174 -174
  76. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-04-brief-coverage-validation.md +214 -214
  77. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-05-measurability-validation.md +228 -228
  78. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-06-traceability-validation.md +217 -217
  79. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-07-implementation-leakage-validation.md +205 -205
  80. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-08-domain-compliance-validation.md +243 -243
  81. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-09-project-type-validation.md +263 -263
  82. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-10-smart-validation.md +209 -209
  83. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-11-holistic-quality-validation.md +264 -264
  84. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-12-completeness-validation.md +242 -242
  85. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-13-report-complete.md +231 -231
  86. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/templates/prd-template.md +10 -10
  87. package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md +63 -0
  88. package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md +65 -0
  89. package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md +63 -0
  90. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -135
  91. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -127
  92. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -190
  93. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -216
  94. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -219
  95. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -234
  96. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -252
  97. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -254
  98. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -224
  99. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -224
  100. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -241
  101. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -248
  102. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -237
  103. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -264
  104. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +171 -171
  105. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -13
  106. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +42 -43
  107. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +184 -190
  108. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +172 -178
  109. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +173 -179
  110. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +133 -139
  111. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +245 -252
  112. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +129 -135
  113. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -4
  114. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +54 -55
  115. package/bmad/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -12
  116. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +12 -10
  117. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +6 -6
  118. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +153 -153
  119. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -164
  120. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -224
  121. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +331 -331
  122. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +318 -318
  123. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +359 -359
  124. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -379
  125. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +359 -359
  126. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +76 -76
  127. package/bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md +49 -50
  128. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -259
  129. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -233
  130. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -272
  131. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +149 -149
  132. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -57
  133. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +58 -59
  134. package/bmad/bmm/workflows/4-implementation/code-review/checklist.md +23 -23
  135. package/bmad/bmm/workflows/4-implementation/code-review/instructions.xml +226 -226
  136. package/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +44 -51
  137. package/bmad/bmm/workflows/4-implementation/correct-course/checklist.md +288 -288
  138. package/bmad/bmm/workflows/4-implementation/correct-course/instructions.md +207 -206
  139. package/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +54 -60
  140. package/bmad/bmm/workflows/4-implementation/create-story/checklist.md +358 -358
  141. package/bmad/bmm/workflows/4-implementation/create-story/instructions.xml +346 -345
  142. package/bmad/bmm/workflows/4-implementation/create-story/template.md +49 -49
  143. package/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml +53 -61
  144. package/bmad/bmm/workflows/4-implementation/dev-story/checklist.md +80 -80
  145. package/bmad/bmm/workflows/4-implementation/dev-story/instructions.xml +410 -410
  146. package/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +21 -27
  147. package/bmad/bmm/workflows/4-implementation/retrospective/instructions.md +1444 -1443
  148. package/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +53 -58
  149. package/bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -33
  150. package/bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +226 -225
  151. package/bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -55
  152. package/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +47 -54
  153. package/bmad/bmm/workflows/4-implementation/sprint-status/instructions.md +230 -229
  154. package/bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml +25 -36
  155. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +174 -156
  156. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +118 -120
  157. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +111 -113
  158. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +111 -113
  159. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +104 -106
  160. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +146 -140
  161. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +50 -50
  162. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +191 -189
  163. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +144 -144
  164. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +127 -128
  165. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +200 -191
  166. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -74
  167. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -79
  168. package/bmad/bmm/workflows/document-project/checklist.md +245 -245
  169. package/bmad/bmm/workflows/document-project/documentation-requirements.csv +12 -12
  170. package/bmad/bmm/workflows/document-project/instructions.md +130 -221
  171. package/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +345 -345
  172. package/bmad/bmm/workflows/document-project/templates/index-template.md +169 -169
  173. package/bmad/bmm/workflows/document-project/templates/project-overview-template.md +103 -103
  174. package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -160
  175. package/bmad/bmm/workflows/document-project/templates/source-tree-template.md +135 -135
  176. package/bmad/bmm/workflows/document-project/workflow.yaml +22 -30
  177. package/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -298
  178. package/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -31
  179. package/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -1106
  180. package/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +31 -31
  181. package/bmad/bmm/workflows/generate-project-context/project-context-template.md +21 -0
  182. package/bmad/bmm/workflows/generate-project-context/steps/step-01-discover.md +184 -0
  183. package/bmad/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -0
  184. package/bmad/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -0
  185. package/bmad/bmm/workflows/generate-project-context/workflow.md +49 -0
  186. package/bmad/bmm/workflows/qa/automate/checklist.md +33 -0
  187. package/bmad/bmm/workflows/qa/automate/instructions.md +110 -0
  188. package/bmad/bmm/workflows/qa/automate/workflow.yaml +44 -0
  189. package/bmad/core/agents/bmad-master.agent.yaml +30 -30
  190. package/bmad/core/module-help.csv +9 -11
  191. package/bmad/core/module.yaml +25 -25
  192. package/bmad/core/tasks/editorial-review-prose.xml +102 -91
  193. package/bmad/core/tasks/editorial-review-structure.xml +209 -198
  194. package/bmad/core/tasks/help.md +85 -0
  195. package/bmad/core/tasks/index-docs.xml +64 -64
  196. package/bmad/core/tasks/review-adversarial-general.xml +48 -48
  197. package/bmad/core/tasks/shard-doc.xml +107 -108
  198. package/bmad/core/tasks/workflow.xml +234 -234
  199. package/bmad/core/workflows/advanced-elicitation/methods.csv +51 -51
  200. package/bmad/core/workflows/advanced-elicitation/workflow.xml +116 -116
  201. package/bmad/core/workflows/brainstorming/brain-methods.csv +61 -61
  202. package/bmad/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -197
  203. package/bmad/core/workflows/brainstorming/steps/step-01b-continue.md +122 -122
  204. package/bmad/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -225
  205. package/bmad/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -237
  206. package/bmad/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -209
  207. package/bmad/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -264
  208. package/bmad/core/workflows/brainstorming/steps/step-03-technique-execution.md +399 -399
  209. package/bmad/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -303
  210. package/bmad/core/workflows/brainstorming/template.md +15 -15
  211. package/bmad/core/workflows/brainstorming/workflow.md +58 -58
  212. package/bmad/core/workflows/party-mode/steps/step-01-agent-loading.md +138 -138
  213. package/bmad/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +187 -187
  214. package/bmad/core/workflows/party-mode/steps/step-03-graceful-exit.md +168 -157
  215. package/bmad/core/workflows/party-mode/workflow.md +194 -194
  216. package/bundled-versions.json +3 -0
  217. package/dist/cli.js +61 -6
  218. package/dist/commands/check-updates.d.ts +5 -0
  219. package/dist/commands/check-updates.js +63 -0
  220. package/dist/commands/doctor.d.ts +39 -1
  221. package/dist/commands/doctor.js +348 -79
  222. package/dist/commands/init.d.ts +2 -0
  223. package/dist/commands/init.js +41 -15
  224. package/dist/commands/status.d.ts +7 -1
  225. package/dist/commands/status.js +111 -42
  226. package/dist/commands/upgrade.d.ts +7 -1
  227. package/dist/commands/upgrade.js +43 -12
  228. package/dist/installer.d.ts +19 -2
  229. package/dist/installer.js +305 -66
  230. package/dist/transition/artifacts.d.ts +2 -0
  231. package/dist/transition/artifacts.js +46 -0
  232. package/dist/transition/context.d.ts +19 -0
  233. package/dist/transition/context.js +261 -0
  234. package/dist/transition/fix-plan.d.ts +15 -0
  235. package/dist/transition/fix-plan.js +94 -0
  236. package/dist/transition/index.d.ts +9 -0
  237. package/dist/transition/index.js +16 -0
  238. package/dist/transition/orchestration.d.ts +2 -0
  239. package/dist/transition/orchestration.js +243 -0
  240. package/dist/transition/specs-changelog.d.ts +3 -0
  241. package/dist/transition/specs-changelog.js +75 -0
  242. package/dist/transition/specs-index.d.ts +22 -0
  243. package/dist/transition/specs-index.js +157 -0
  244. package/dist/transition/story-parsing.d.ts +7 -0
  245. package/dist/transition/story-parsing.js +124 -0
  246. package/dist/transition/tech-stack.d.ts +3 -0
  247. package/dist/transition/tech-stack.js +79 -0
  248. package/dist/transition/types.d.ts +60 -0
  249. package/dist/transition/types.js +1 -0
  250. package/dist/utils/config.d.ts +4 -0
  251. package/dist/utils/config.js +14 -4
  252. package/dist/utils/constants.d.ts +70 -0
  253. package/dist/utils/constants.js +97 -0
  254. package/dist/utils/dryrun.d.ts +7 -0
  255. package/dist/utils/dryrun.js +48 -0
  256. package/dist/utils/errors.d.ts +63 -0
  257. package/dist/utils/errors.js +86 -0
  258. package/dist/utils/file-system.d.ts +24 -0
  259. package/dist/utils/file-system.js +99 -0
  260. package/dist/utils/github.d.ts +83 -0
  261. package/dist/utils/github.js +230 -0
  262. package/dist/utils/json.js +3 -3
  263. package/dist/utils/logger.d.ts +6 -0
  264. package/dist/utils/logger.js +27 -0
  265. package/dist/utils/state.d.ts +4 -7
  266. package/dist/utils/state.js +147 -26
  267. package/dist/utils/validate.d.ts +40 -0
  268. package/dist/utils/validate.js +175 -1
  269. package/package.json +75 -59
  270. package/ralph/RALPH-REFERENCE.md +412 -0
  271. package/ralph/lib/circuit_breaker.sh +463 -330
  272. package/ralph/lib/date_utils.sh +104 -53
  273. package/ralph/lib/enable_core.sh +815 -0
  274. package/ralph/lib/response_analyzer.sh +884 -768
  275. package/ralph/lib/task_sources.sh +577 -0
  276. package/ralph/lib/timeout_utils.sh +145 -145
  277. package/ralph/lib/wizard_utils.sh +547 -0
  278. package/ralph/ralph_import.sh +636 -0
  279. package/ralph/ralph_loop.sh +1793 -1391
  280. package/ralph/ralph_monitor.sh +125 -0
  281. package/ralph/templates/AGENT.md +158 -158
  282. package/ralph/templates/PROMPT.md +285 -292
  283. package/ralph/templates/fix_plan.md +27 -27
  284. package/ralph/templates/ralphrc.template +102 -0
  285. package/ralph/templates/specs/.gitkeep +1 -1
  286. package/slash-commands/advanced-elicitation.md +1 -1
  287. package/slash-commands/adversarial-review.md +1 -1
  288. package/slash-commands/analyst.md +1 -1
  289. package/slash-commands/architect.md +1 -1
  290. package/slash-commands/bmad-help.md +1 -1
  291. package/slash-commands/bmalph-implement.md +152 -152
  292. package/slash-commands/brainstorm-project.md +1 -1
  293. package/slash-commands/brainstorming.md +1 -1
  294. package/slash-commands/correct-course.md +1 -1
  295. package/slash-commands/create-architecture.md +1 -1
  296. package/slash-commands/create-brief.md +1 -1
  297. package/slash-commands/create-epics-stories.md +1 -1
  298. package/slash-commands/create-prd.md +1 -1
  299. package/slash-commands/create-story.md +1 -1
  300. package/slash-commands/create-ux.md +1 -1
  301. package/slash-commands/dev.md +1 -1
  302. package/slash-commands/document-project.md +1 -1
  303. package/slash-commands/domain-research.md +1 -1
  304. package/slash-commands/editorial-prose.md +1 -1
  305. package/slash-commands/editorial-structure.md +1 -1
  306. package/slash-commands/execute-workflow.md +1 -1
  307. package/slash-commands/generate-project-context.md +1 -0
  308. package/slash-commands/implementation-readiness.md +1 -1
  309. package/slash-commands/index-docs.md +1 -1
  310. package/slash-commands/market-research.md +1 -1
  311. package/slash-commands/party-mode.md +1 -1
  312. package/slash-commands/pm.md +1 -1
  313. package/slash-commands/qa-automate.md +1 -0
  314. package/slash-commands/qa.md +1 -0
  315. package/slash-commands/quick-dev.md +1 -1
  316. package/slash-commands/quick-flow-solo-dev.md +1 -1
  317. package/slash-commands/retrospective.md +1 -1
  318. package/slash-commands/shard-doc.md +1 -1
  319. package/slash-commands/sm.md +1 -1
  320. package/slash-commands/sprint-planning.md +1 -1
  321. package/slash-commands/sprint-status.md +1 -1
  322. package/slash-commands/tech-spec.md +1 -1
  323. package/slash-commands/tech-writer.md +1 -0
  324. package/slash-commands/technical-research.md +1 -1
  325. package/slash-commands/ux-designer.md +1 -1
  326. package/slash-commands/validate-architecture.md +1 -1
  327. package/slash-commands/validate-brief.md +1 -1
  328. package/slash-commands/validate-epics-stories.md +1 -1
  329. package/slash-commands/validate-prd.md +1 -1
  330. package/slash-commands/validate-story.md +1 -1
  331. package/slash-commands/validate-ux.md +1 -1
  332. package/bmad/bmm/agents/tea.agent.yaml +0 -63
  333. package/bmad/bmm/sub-modules/claude-code/config.yaml +0 -4
  334. package/bmad/bmm/sub-modules/claude-code/injections.yaml +0 -242
  335. package/bmad/bmm/sub-modules/claude-code/readme.md +0 -87
  336. package/bmad/bmm/testarch/knowledge/adr-quality-readiness-checklist.md +0 -350
  337. package/bmad/bmm/testarch/knowledge/api-request.md +0 -442
  338. package/bmad/bmm/testarch/knowledge/api-testing-patterns.md +0 -843
  339. package/bmad/bmm/testarch/knowledge/auth-session.md +0 -552
  340. package/bmad/bmm/testarch/knowledge/burn-in.md +0 -273
  341. package/bmad/bmm/testarch/knowledge/ci-burn-in.md +0 -675
  342. package/bmad/bmm/testarch/knowledge/component-tdd.md +0 -486
  343. package/bmad/bmm/testarch/knowledge/contract-testing.md +0 -957
  344. package/bmad/bmm/testarch/knowledge/data-factories.md +0 -500
  345. package/bmad/bmm/testarch/knowledge/email-auth.md +0 -721
  346. package/bmad/bmm/testarch/knowledge/error-handling.md +0 -725
  347. package/bmad/bmm/testarch/knowledge/feature-flags.md +0 -750
  348. package/bmad/bmm/testarch/knowledge/file-utils.md +0 -463
  349. package/bmad/bmm/testarch/knowledge/fixture-architecture.md +0 -401
  350. package/bmad/bmm/testarch/knowledge/fixtures-composition.md +0 -382
  351. package/bmad/bmm/testarch/knowledge/intercept-network-call.md +0 -430
  352. package/bmad/bmm/testarch/knowledge/log.md +0 -429
  353. package/bmad/bmm/testarch/knowledge/network-error-monitor.md +0 -405
  354. package/bmad/bmm/testarch/knowledge/network-first.md +0 -486
  355. package/bmad/bmm/testarch/knowledge/network-recorder.md +0 -527
  356. package/bmad/bmm/testarch/knowledge/nfr-criteria.md +0 -670
  357. package/bmad/bmm/testarch/knowledge/overview.md +0 -286
  358. package/bmad/bmm/testarch/knowledge/playwright-config.md +0 -730
  359. package/bmad/bmm/testarch/knowledge/probability-impact.md +0 -601
  360. package/bmad/bmm/testarch/knowledge/recurse.md +0 -421
  361. package/bmad/bmm/testarch/knowledge/risk-governance.md +0 -615
  362. package/bmad/bmm/testarch/knowledge/selective-testing.md +0 -732
  363. package/bmad/bmm/testarch/knowledge/selector-resilience.md +0 -527
  364. package/bmad/bmm/testarch/knowledge/test-healing-patterns.md +0 -644
  365. package/bmad/bmm/testarch/knowledge/test-levels-framework.md +0 -473
  366. package/bmad/bmm/testarch/knowledge/test-priorities-matrix.md +0 -373
  367. package/bmad/bmm/testarch/knowledge/test-quality.md +0 -664
  368. package/bmad/bmm/testarch/knowledge/timing-debugging.md +0 -372
  369. package/bmad/bmm/testarch/knowledge/visual-debugging.md +0 -524
  370. package/bmad/bmm/testarch/tea-index.csv +0 -35
  371. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +0 -200
  372. package/bmad/bmm/workflows/1-analysis/research/workflow.md +0 -173
  373. package/bmad/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +0 -433
  374. package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.md +0 -150
  375. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/data/project-levels.yaml +0 -59
  376. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +0 -90
  377. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +0 -127
  378. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +0 -39
  379. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +0 -130
  380. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +0 -27
  381. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +0 -43
  382. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +0 -141
  383. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +0 -27
  384. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +0 -49
  385. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +0 -241
  386. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +0 -27
  387. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +0 -38
  388. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +0 -133
  389. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +0 -27
  390. package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +0 -363
  391. package/bmad/bmm/workflows/testarch/atdd/checklist.md +0 -374
  392. package/bmad/bmm/workflows/testarch/atdd/instructions.md +0 -806
  393. package/bmad/bmm/workflows/testarch/atdd/workflow.yaml +0 -47
  394. package/bmad/bmm/workflows/testarch/automate/checklist.md +0 -582
  395. package/bmad/bmm/workflows/testarch/automate/instructions.md +0 -1324
  396. package/bmad/bmm/workflows/testarch/automate/workflow.yaml +0 -54
  397. package/bmad/bmm/workflows/testarch/ci/checklist.md +0 -247
  398. package/bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +0 -198
  399. package/bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +0 -149
  400. package/bmad/bmm/workflows/testarch/ci/instructions.md +0 -536
  401. package/bmad/bmm/workflows/testarch/ci/workflow.yaml +0 -47
  402. package/bmad/bmm/workflows/testarch/framework/checklist.md +0 -320
  403. package/bmad/bmm/workflows/testarch/framework/instructions.md +0 -481
  404. package/bmad/bmm/workflows/testarch/framework/workflow.yaml +0 -49
  405. package/bmad/bmm/workflows/testarch/nfr-assess/checklist.md +0 -407
  406. package/bmad/bmm/workflows/testarch/nfr-assess/instructions.md +0 -726
  407. package/bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +0 -461
  408. package/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +0 -49
  409. package/bmad/bmm/workflows/testarch/test-design/checklist.md +0 -407
  410. package/bmad/bmm/workflows/testarch/test-design/instructions.md +0 -1158
  411. package/bmad/bmm/workflows/testarch/test-design/test-design-architecture-template.md +0 -213
  412. package/bmad/bmm/workflows/testarch/test-design/test-design-qa-template.md +0 -286
  413. package/bmad/bmm/workflows/testarch/test-design/test-design-template.md +0 -294
  414. package/bmad/bmm/workflows/testarch/test-design/workflow.yaml +0 -71
  415. package/bmad/bmm/workflows/testarch/test-review/checklist.md +0 -472
  416. package/bmad/bmm/workflows/testarch/test-review/instructions.md +0 -628
  417. package/bmad/bmm/workflows/testarch/test-review/test-review-template.md +0 -390
  418. package/bmad/bmm/workflows/testarch/test-review/workflow.yaml +0 -48
  419. package/bmad/bmm/workflows/testarch/trace/checklist.md +0 -642
  420. package/bmad/bmm/workflows/testarch/trace/instructions.md +0 -1030
  421. package/bmad/bmm/workflows/testarch/trace/trace-template.md +0 -675
  422. package/bmad/bmm/workflows/testarch/trace/workflow.yaml +0 -57
  423. package/bmad/core/resources/excalidraw/README.md +0 -160
  424. package/bmad/core/resources/excalidraw/excalidraw-helpers.md +0 -127
  425. package/bmad/core/resources/excalidraw/library-loader.md +0 -50
  426. package/bmad/core/resources/excalidraw/validate-json-instructions.md +0 -79
  427. package/bmad/core/tasks/bmad-help.md +0 -62
  428. package/dist/commands/guide.d.ts +0 -1
  429. package/dist/commands/guide.js +0 -19
  430. package/dist/commands/implement.d.ts +0 -1
  431. package/dist/commands/implement.js +0 -83
  432. package/dist/commands/plan.d.ts +0 -5
  433. package/dist/commands/plan.js +0 -44
  434. package/dist/commands/reset.d.ts +0 -5
  435. package/dist/commands/reset.js +0 -35
  436. package/dist/commands/resume.d.ts +0 -1
  437. package/dist/commands/resume.js +0 -44
  438. package/dist/commands/start.d.ts +0 -5
  439. package/dist/commands/start.js +0 -54
  440. package/dist/transition.d.ts +0 -52
  441. package/dist/transition.js +0 -656
  442. package/slash-commands/atdd.md +0 -1
  443. package/slash-commands/continuous-integration.md +0 -1
  444. package/slash-commands/create-dataflow.md +0 -1
  445. package/slash-commands/create-diagram.md +0 -1
  446. package/slash-commands/create-flowchart.md +0 -1
  447. package/slash-commands/create-wireframe.md +0 -1
  448. package/slash-commands/nfr-assess.md +0 -1
  449. package/slash-commands/tea.md +0 -1
  450. package/slash-commands/test-automate.md +0 -1
  451. package/slash-commands/test-design.md +0 -1
  452. package/slash-commands/test-framework.md +0 -1
  453. package/slash-commands/test-review.md +0 -1
  454. package/slash-commands/test-trace.md +0 -1
  455. package/slash-commands/validate-test-design.md +0 -1
@@ -1,750 +0,0 @@
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_