bmad-method 6.0.0-alpha.6 → 6.0.0-alpha.7

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 (367) hide show
  1. package/.claude/settings.local.json +13 -6
  2. package/.github/workflows/{lint.yaml → quality.yaml} +19 -2
  3. package/.husky/pre-commit +4 -0
  4. package/README.md +59 -1
  5. package/bmad/_cfg/agent-manifest.csv +2 -8
  6. package/bmad/_cfg/files-manifest.csv +8 -202
  7. package/bmad/_cfg/ides/claude-code.yaml +3 -4
  8. package/bmad/_cfg/manifest.yaml +5 -4
  9. package/bmad/_cfg/task-manifest.csv +8 -1
  10. package/bmad/_cfg/tool-manifest.csv +2 -0
  11. package/bmad/_cfg/workflow-manifest.csv +4 -31
  12. package/bmad/bmb/config.yaml +2 -2
  13. package/bmad/bmb/workflows/create-agent/instructions.md +25 -9
  14. package/bmad/bmb/workflows/create-module/module-structure.md +34 -0
  15. package/bmad/core/config.yaml +2 -2
  16. package/docs/installers-bundlers/installers-modules-platforms-reference.md +61 -0
  17. package/package.json +5 -3
  18. package/src/core/tasks/adv-elicit.xml +1 -1
  19. package/src/modules/bmb/workflows/create-agent/instructions.md +25 -9
  20. package/src/modules/bmb/workflows/create-module/module-structure.md +34 -0
  21. package/src/modules/bmgd/README.md +208 -0
  22. package/src/modules/bmgd/_module-installer/install-config.yaml +66 -0
  23. package/src/modules/{bmm → bmgd}/agents/game-architect.agent.yaml +5 -12
  24. package/src/modules/{bmm → bmgd}/agents/game-designer.agent.yaml +10 -22
  25. package/src/modules/{bmm → bmgd}/agents/game-dev.agent.yaml +9 -10
  26. package/src/modules/bmgd/agents/game-scrum-master.agent.yaml +70 -0
  27. package/{bmad/bmm → src/modules/bmgd}/teams/team-gamedev.yaml +3 -1
  28. package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/brainstorm-game/workflow.yaml +7 -7
  29. package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/game-brief/workflow.yaml +9 -9
  30. package/src/modules/bmgd/workflows/2-design/gdd/workflow.yaml +81 -0
  31. package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/narrative/workflow.yaml +6 -6
  32. package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/workflow.yaml +16 -16
  33. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/code-review/workflow.yaml +3 -1
  34. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/correct-course/workflow.yaml +3 -1
  35. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/create-story/workflow.yaml +3 -1
  36. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/dev-story/workflow.yaml +3 -1
  37. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/epic-tech-context/workflow.yaml +3 -1
  38. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/retrospective/workflow.yaml +3 -1
  39. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/sprint-planning/workflow.yaml +3 -1
  40. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-context/workflow.yaml +3 -1
  41. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-done/workflow.yaml +3 -1
  42. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-ready/workflow.yaml +3 -1
  43. package/src/modules/bmm/docs/README.md +8 -9
  44. package/src/modules/bmm/docs/agents-guide.md +0 -1
  45. package/src/modules/bmm/docs/brownfield-guide.md +5 -9
  46. package/src/modules/bmm/docs/faq.md +4 -6
  47. package/src/modules/bmm/docs/glossary.md +0 -1
  48. package/src/modules/bmm/docs/quick-spec-flow.md +4 -4
  49. package/src/modules/bmm/docs/quick-start.md +4 -4
  50. package/src/modules/bmm/docs/scale-adaptive-system.md +5 -5
  51. package/src/modules/bmm/docs/test-architecture.md +183 -118
  52. package/src/modules/bmm/docs/workflows-analysis.md +203 -539
  53. package/src/modules/bmm/docs/workflows-planning.md +326 -850
  54. package/src/modules/bmm/docs/workflows-solutioning.md +250 -505
  55. package/src/modules/bmm/workflows/1-analysis/domain-research/workflow.yaml +65 -32
  56. package/src/modules/bmm/workflows/1-analysis/product-brief/workflow.yaml +4 -0
  57. package/src/modules/bmm/workflows/1-analysis/research/instructions-market.md +1 -1
  58. package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml +34 -5
  59. package/src/modules/bmm/workflows/2-plan-workflows/prd/instructions.md +1 -1
  60. package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.yaml +8 -0
  61. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +6 -0
  62. package/src/modules/bmm/workflows/3-solutioning/architecture/workflow.yaml +47 -0
  63. package/src/modules/bmm/workflows/workflow-status/init/instructions.md +50 -0
  64. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +18 -11
  65. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +18 -11
  66. package/src/modules/bmm/workflows/workflow-status/paths/game-design.yaml +42 -65
  67. package/test/test-installation-components.js +214 -0
  68. package/tools/cli/bundlers/web-bundler.js +127 -8
  69. package/tools/cli/installers/lib/ide/auggie.js +9 -20
  70. package/tools/cli/installers/lib/ide/claude-code.js +33 -3
  71. package/tools/cli/installers/lib/ide/cursor.js +17 -0
  72. package/tools/cli/installers/lib/modules/manager.js +128 -0
  73. package/tools/cli/lib/yaml-xml-builder.js +9 -1
  74. package/tools/schema/agent.js +1 -0
  75. package/v6-open-items.md +3 -9
  76. package/web-bundles/bmm/agents/analyst.xml +5028 -0
  77. package/web-bundles/bmm/agents/architect.xml +2047 -0
  78. package/web-bundles/bmm/agents/dev.xml +68 -0
  79. package/web-bundles/bmm/agents/pm.xml +3808 -0
  80. package/web-bundles/bmm/agents/sm.xml +77 -0
  81. package/web-bundles/bmm/agents/tea.xml +66 -0
  82. package/web-bundles/bmm/agents/tech-writer.xml +84 -0
  83. package/web-bundles/bmm/agents/ux-designer.xml +2018 -0
  84. package/web-bundles/bmm/teams/team-fullstack.xml +12039 -0
  85. package/.claude/agents/bmad-analysis/api-documenter.md +0 -102
  86. package/.claude/agents/bmad-analysis/codebase-analyzer.md +0 -82
  87. package/.claude/agents/bmad-analysis/data-analyst.md +0 -101
  88. package/.claude/agents/bmad-analysis/pattern-detector.md +0 -84
  89. package/.claude/agents/bmad-planning/dependency-mapper.md +0 -83
  90. package/.claude/agents/bmad-planning/epic-optimizer.md +0 -81
  91. package/.claude/agents/bmad-planning/requirements-analyst.md +0 -61
  92. package/.claude/agents/bmad-planning/technical-decisions-curator.md +0 -168
  93. package/.claude/agents/bmad-planning/trend-spotter.md +0 -115
  94. package/.claude/agents/bmad-planning/user-journey-mapper.md +0 -123
  95. package/.claude/agents/bmad-planning/user-researcher.md +0 -72
  96. package/.claude/agents/bmad-research/market-researcher.md +0 -51
  97. package/.claude/agents/bmad-research/tech-debt-auditor.md +0 -106
  98. package/.claude/agents/bmad-review/document-reviewer.md +0 -102
  99. package/.claude/agents/bmad-review/technical-evaluator.md +0 -68
  100. package/.claude/agents/bmad-review/test-coverage-analyzer.md +0 -108
  101. package/.claude/commands/bmad/bmb/workflows/README.md +0 -67
  102. package/.claude/commands/bmad/bmm/agents/analyst.md +0 -67
  103. package/.claude/commands/bmad/bmm/agents/architect.md +0 -72
  104. package/.claude/commands/bmad/bmm/agents/dev.md +0 -69
  105. package/.claude/commands/bmad/bmm/agents/pm.md +0 -76
  106. package/.claude/commands/bmad/bmm/agents/sm.md +0 -85
  107. package/.claude/commands/bmad/bmm/agents/tea.md +0 -72
  108. package/.claude/commands/bmad/bmm/agents/tech-writer.md +0 -82
  109. package/.claude/commands/bmad/bmm/agents/ux-designer.md +0 -71
  110. package/.claude/commands/bmad/bmm/workflows/README.md +0 -132
  111. package/.claude/commands/bmad/bmm/workflows/architecture.md +0 -15
  112. package/.claude/commands/bmad/bmm/workflows/brainstorm-project.md +0 -15
  113. package/.claude/commands/bmad/bmm/workflows/code-review.md +0 -15
  114. package/.claude/commands/bmad/bmm/workflows/correct-course.md +0 -15
  115. package/.claude/commands/bmad/bmm/workflows/create-epics-and-stories.md +0 -15
  116. package/.claude/commands/bmad/bmm/workflows/create-story.md +0 -15
  117. package/.claude/commands/bmad/bmm/workflows/create-ux-design.md +0 -15
  118. package/.claude/commands/bmad/bmm/workflows/dev-story.md +0 -15
  119. package/.claude/commands/bmad/bmm/workflows/document-project.md +0 -15
  120. package/.claude/commands/bmad/bmm/workflows/epic-tech-context.md +0 -15
  121. package/.claude/commands/bmad/bmm/workflows/narrative.md +0 -15
  122. package/.claude/commands/bmad/bmm/workflows/prd.md +0 -15
  123. package/.claude/commands/bmad/bmm/workflows/product-brief.md +0 -15
  124. package/.claude/commands/bmad/bmm/workflows/research.md +0 -15
  125. package/.claude/commands/bmad/bmm/workflows/retrospective.md +0 -15
  126. package/.claude/commands/bmad/bmm/workflows/solutioning-gate-check.md +0 -15
  127. package/.claude/commands/bmad/bmm/workflows/sprint-planning.md +0 -15
  128. package/.claude/commands/bmad/bmm/workflows/story-context.md +0 -15
  129. package/.claude/commands/bmad/bmm/workflows/story-done.md +0 -15
  130. package/.claude/commands/bmad/bmm/workflows/story-ready.md +0 -15
  131. package/.claude/commands/bmad/bmm/workflows/tech-spec.md +0 -15
  132. package/.claude/commands/bmad/bmm/workflows/workflow-init.md +0 -15
  133. package/.claude/commands/bmad/bmm/workflows/workflow-status.md +0 -15
  134. package/.claude/commands/bmad/cis/agents/README.md +0 -104
  135. package/.claude/commands/bmad/cis/agents/brainstorming-coach.md +0 -62
  136. package/.claude/commands/bmad/cis/agents/creative-problem-solver.md +0 -62
  137. package/.claude/commands/bmad/cis/agents/design-thinking-coach.md +0 -62
  138. package/.claude/commands/bmad/cis/agents/innovation-strategist.md +0 -62
  139. package/.claude/commands/bmad/cis/agents/storyteller.md +0 -59
  140. package/.claude/commands/bmad/cis/workflows/README.md +0 -37
  141. package/.claude/commands/bmad/cis/workflows/design-thinking.md +0 -15
  142. package/.claude/commands/bmad/cis/workflows/innovation-strategy.md +0 -15
  143. package/.claude/commands/bmad/cis/workflows/problem-solving.md +0 -15
  144. package/.claude/commands/bmad/cis/workflows/storytelling.md +0 -15
  145. package/.claude/commands/bmad/core/workflows/README.md +0 -27
  146. package/bmad/_cfg/agents/bmm-analyst.customize.yaml +0 -42
  147. package/bmad/_cfg/agents/bmm-architect.customize.yaml +0 -42
  148. package/bmad/_cfg/agents/bmm-dev.customize.yaml +0 -42
  149. package/bmad/_cfg/agents/bmm-pm.customize.yaml +0 -42
  150. package/bmad/_cfg/agents/bmm-sm.customize.yaml +0 -42
  151. package/bmad/_cfg/agents/bmm-tea.customize.yaml +0 -42
  152. package/bmad/_cfg/agents/bmm-tech-writer.customize.yaml +0 -42
  153. package/bmad/_cfg/agents/bmm-ux-designer.customize.yaml +0 -42
  154. package/bmad/bmm/README.md +0 -128
  155. package/bmad/bmm/agents/analyst.md +0 -67
  156. package/bmad/bmm/agents/architect.md +0 -72
  157. package/bmad/bmm/agents/dev.md +0 -69
  158. package/bmad/bmm/agents/pm.md +0 -76
  159. package/bmad/bmm/agents/sm.md +0 -85
  160. package/bmad/bmm/agents/tea.md +0 -72
  161. package/bmad/bmm/agents/tech-writer.md +0 -82
  162. package/bmad/bmm/agents/ux-designer.md +0 -71
  163. package/bmad/bmm/config.yaml +0 -18
  164. package/bmad/bmm/tasks/daily-standup.xml +0 -85
  165. package/bmad/bmm/teams/team-fullstack.yaml +0 -11
  166. package/bmad/bmm/testarch/knowledge/ci-burn-in.md +0 -675
  167. package/bmad/bmm/testarch/knowledge/component-tdd.md +0 -486
  168. package/bmad/bmm/testarch/knowledge/contract-testing.md +0 -957
  169. package/bmad/bmm/testarch/knowledge/data-factories.md +0 -500
  170. package/bmad/bmm/testarch/knowledge/email-auth.md +0 -721
  171. package/bmad/bmm/testarch/knowledge/error-handling.md +0 -725
  172. package/bmad/bmm/testarch/knowledge/feature-flags.md +0 -750
  173. package/bmad/bmm/testarch/knowledge/fixture-architecture.md +0 -401
  174. package/bmad/bmm/testarch/knowledge/network-first.md +0 -486
  175. package/bmad/bmm/testarch/knowledge/nfr-criteria.md +0 -670
  176. package/bmad/bmm/testarch/knowledge/playwright-config.md +0 -730
  177. package/bmad/bmm/testarch/knowledge/probability-impact.md +0 -601
  178. package/bmad/bmm/testarch/knowledge/risk-governance.md +0 -615
  179. package/bmad/bmm/testarch/knowledge/selective-testing.md +0 -732
  180. package/bmad/bmm/testarch/knowledge/selector-resilience.md +0 -527
  181. package/bmad/bmm/testarch/knowledge/test-healing-patterns.md +0 -644
  182. package/bmad/bmm/testarch/knowledge/test-levels-framework.md +0 -473
  183. package/bmad/bmm/testarch/knowledge/test-priorities-matrix.md +0 -373
  184. package/bmad/bmm/testarch/knowledge/test-quality.md +0 -664
  185. package/bmad/bmm/testarch/knowledge/timing-debugging.md +0 -372
  186. package/bmad/bmm/testarch/knowledge/visual-debugging.md +0 -524
  187. package/bmad/bmm/testarch/tea-index.csv +0 -22
  188. package/bmad/bmm/workflows/1-analysis/brainstorm-project/instructions.md +0 -110
  189. package/bmad/bmm/workflows/1-analysis/brainstorm-project/project-context.md +0 -25
  190. package/bmad/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml +0 -26
  191. package/bmad/bmm/workflows/1-analysis/domain-research/instructions.md +0 -423
  192. package/bmad/bmm/workflows/1-analysis/domain-research/template.md +0 -180
  193. package/bmad/bmm/workflows/1-analysis/domain-research/workflow.yaml +0 -36
  194. package/bmad/bmm/workflows/1-analysis/product-brief/checklist.md +0 -115
  195. package/bmad/bmm/workflows/1-analysis/product-brief/instructions.md +0 -524
  196. package/bmad/bmm/workflows/1-analysis/product-brief/template.md +0 -181
  197. package/bmad/bmm/workflows/1-analysis/product-brief/workflow.yaml +0 -45
  198. package/bmad/bmm/workflows/1-analysis/research/checklist-deep-prompt.md +0 -144
  199. package/bmad/bmm/workflows/1-analysis/research/checklist-technical.md +0 -249
  200. package/bmad/bmm/workflows/1-analysis/research/checklist.md +0 -299
  201. package/bmad/bmm/workflows/1-analysis/research/claude-code/injections.yaml +0 -114
  202. package/bmad/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +0 -439
  203. package/bmad/bmm/workflows/1-analysis/research/instructions-market.md +0 -679
  204. package/bmad/bmm/workflows/1-analysis/research/instructions-router.md +0 -133
  205. package/bmad/bmm/workflows/1-analysis/research/instructions-technical.md +0 -538
  206. package/bmad/bmm/workflows/1-analysis/research/template-deep-prompt.md +0 -94
  207. package/bmad/bmm/workflows/1-analysis/research/template-market.md +0 -347
  208. package/bmad/bmm/workflows/1-analysis/research/template-technical.md +0 -245
  209. package/bmad/bmm/workflows/1-analysis/research/workflow.yaml +0 -44
  210. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/checklist.md +0 -310
  211. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +0 -1301
  212. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +0 -145
  213. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml +0 -64
  214. package/bmad/bmm/workflows/2-plan-workflows/narrative/workflow.yaml +0 -29
  215. package/bmad/bmm/workflows/2-plan-workflows/prd/checklist.md +0 -350
  216. package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/epics-template.md +0 -52
  217. package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md +0 -169
  218. package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml +0 -45
  219. package/bmad/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv +0 -13
  220. package/bmad/bmm/workflows/2-plan-workflows/prd/instructions.md +0 -408
  221. package/bmad/bmm/workflows/2-plan-workflows/prd/prd-template.md +0 -237
  222. package/bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv +0 -11
  223. package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml +0 -46
  224. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/checklist.md +0 -214
  225. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +0 -80
  226. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions-level0-story.md +0 -200
  227. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions-level1-stories.md +0 -451
  228. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +0 -1115
  229. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/tech-spec-template.md +0 -181
  230. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +0 -90
  231. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +0 -60
  232. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/checklist.md +0 -175
  233. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +0 -305
  234. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/template.md +0 -146
  235. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/validation-criteria.yaml +0 -189
  236. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml +0 -64
  237. package/bmad/bmm/workflows/document-project/checklist.md +0 -245
  238. package/bmad/bmm/workflows/document-project/documentation-requirements.csv +0 -12
  239. package/bmad/bmm/workflows/document-project/instructions.md +0 -222
  240. package/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +0 -345
  241. package/bmad/bmm/workflows/document-project/templates/index-template.md +0 -169
  242. package/bmad/bmm/workflows/document-project/templates/project-overview-template.md +0 -103
  243. package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +0 -160
  244. package/bmad/bmm/workflows/document-project/templates/source-tree-template.md +0 -135
  245. package/bmad/bmm/workflows/document-project/workflow.yaml +0 -34
  246. package/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +0 -298
  247. package/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +0 -31
  248. package/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +0 -1106
  249. package/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +0 -31
  250. package/bmad/bmm/workflows/techdoc/documentation-standards.md +0 -262
  251. package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +0 -363
  252. package/bmad/bmm/workflows/testarch/atdd/checklist.md +0 -373
  253. package/bmad/bmm/workflows/testarch/atdd/instructions.md +0 -785
  254. package/bmad/bmm/workflows/testarch/atdd/workflow.yaml +0 -52
  255. package/bmad/bmm/workflows/testarch/automate/checklist.md +0 -580
  256. package/bmad/bmm/workflows/testarch/automate/instructions.md +0 -1303
  257. package/bmad/bmm/workflows/testarch/automate/workflow.yaml +0 -61
  258. package/bmad/bmm/workflows/testarch/ci/checklist.md +0 -246
  259. package/bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +0 -165
  260. package/bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +0 -128
  261. package/bmad/bmm/workflows/testarch/ci/instructions.md +0 -517
  262. package/bmad/bmm/workflows/testarch/ci/workflow.yaml +0 -53
  263. package/bmad/bmm/workflows/testarch/framework/checklist.md +0 -321
  264. package/bmad/bmm/workflows/testarch/framework/instructions.md +0 -455
  265. package/bmad/bmm/workflows/testarch/framework/workflow.yaml +0 -53
  266. package/bmad/bmm/workflows/testarch/nfr-assess/checklist.md +0 -405
  267. package/bmad/bmm/workflows/testarch/nfr-assess/instructions.md +0 -722
  268. package/bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +0 -443
  269. package/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +0 -56
  270. package/bmad/bmm/workflows/testarch/test-design/checklist.md +0 -234
  271. package/bmad/bmm/workflows/testarch/test-design/instructions.md +0 -621
  272. package/bmad/bmm/workflows/testarch/test-design/test-design-template.md +0 -285
  273. package/bmad/bmm/workflows/testarch/test-design/workflow.yaml +0 -52
  274. package/bmad/bmm/workflows/testarch/test-review/checklist.md +0 -470
  275. package/bmad/bmm/workflows/testarch/test-review/instructions.md +0 -608
  276. package/bmad/bmm/workflows/testarch/test-review/test-review-template.md +0 -388
  277. package/bmad/bmm/workflows/testarch/test-review/workflow.yaml +0 -53
  278. package/bmad/bmm/workflows/testarch/trace/checklist.md +0 -654
  279. package/bmad/bmm/workflows/testarch/trace/instructions.md +0 -1045
  280. package/bmad/bmm/workflows/testarch/trace/trace-template.md +0 -673
  281. package/bmad/bmm/workflows/testarch/trace/workflow.yaml +0 -66
  282. package/bmad/bmm/workflows/workflow-status/init/instructions.md +0 -771
  283. package/bmad/bmm/workflows/workflow-status/init/workflow.yaml +0 -27
  284. package/bmad/bmm/workflows/workflow-status/instructions.md +0 -386
  285. package/bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +0 -120
  286. package/bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +0 -108
  287. package/bmad/bmm/workflows/workflow-status/paths/game-design.yaml +0 -75
  288. package/bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml +0 -97
  289. package/bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml +0 -88
  290. package/bmad/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml +0 -58
  291. package/bmad/bmm/workflows/workflow-status/paths/quick-flow-greenfield.yaml +0 -47
  292. package/bmad/bmm/workflows/workflow-status/project-levels.yaml +0 -59
  293. package/bmad/bmm/workflows/workflow-status/sample-level-3-workflow.yaml +0 -49
  294. package/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +0 -31
  295. package/bmad/bmm/workflows/workflow-status/workflow.yaml +0 -28
  296. package/src/modules/bmm/docs/troubleshooting.md +0 -680
  297. package/src/modules/bmm/teams/team-gamedev.yaml +0 -14
  298. package/src/modules/bmm/workflows/2-plan-workflows/gdd/workflow.yaml +0 -81
  299. package/src/modules/bmm/workflows/2-plan-workflows/narrative/checklist.md +0 -139
  300. package/src/modules/bmm/workflows/2-plan-workflows/narrative/instructions-narrative.md +0 -608
  301. package/src/modules/bmm/workflows/2-plan-workflows/narrative/narrative-template.md +0 -195
  302. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/brainstorm-game/game-brain-methods.csv +0 -0
  303. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/brainstorm-game/game-context.md +0 -0
  304. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/brainstorm-game/instructions.md +0 -0
  305. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/game-brief/checklist.md +0 -0
  306. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/game-brief/instructions.md +0 -0
  307. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/game-brief/template.md +0 -0
  308. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/checklist.md +0 -0
  309. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/action-platformer.md +0 -0
  310. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/adventure.md +0 -0
  311. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/card-game.md +0 -0
  312. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/fighting.md +0 -0
  313. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/horror.md +0 -0
  314. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/idle-incremental.md +0 -0
  315. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/metroidvania.md +0 -0
  316. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/moba.md +0 -0
  317. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/party-game.md +0 -0
  318. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/puzzle.md +0 -0
  319. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/racing.md +0 -0
  320. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/rhythm.md +0 -0
  321. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/roguelike.md +0 -0
  322. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/rpg.md +0 -0
  323. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/sandbox.md +0 -0
  324. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/shooter.md +0 -0
  325. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/simulation.md +0 -0
  326. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/sports.md +0 -0
  327. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/strategy.md +0 -0
  328. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/survival.md +0 -0
  329. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/text-based.md +0 -0
  330. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/tower-defense.md +0 -0
  331. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/turn-based-tactics.md +0 -0
  332. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/visual-novel.md +0 -0
  333. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types.csv +0 -0
  334. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/gdd-template.md +0 -0
  335. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/instructions-gdd.md +0 -0
  336. /package/{bmad/bmm/workflows/2-plan-workflows → src/modules/bmgd/workflows/2-design}/narrative/checklist.md +0 -0
  337. /package/{bmad/bmm/workflows/2-plan-workflows → src/modules/bmgd/workflows/2-design}/narrative/instructions-narrative.md +0 -0
  338. /package/{bmad/bmm/workflows/2-plan-workflows → src/modules/bmgd/workflows/2-design}/narrative/narrative-template.md +0 -0
  339. /package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/architecture-patterns.yaml +0 -0
  340. /package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/architecture-template.md +0 -0
  341. /package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/checklist.md +0 -0
  342. /package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/decision-catalog.yaml +0 -0
  343. /package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/instructions.md +0 -0
  344. /package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/pattern-categories.csv +0 -0
  345. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/code-review/backlog_template.md +0 -0
  346. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/code-review/checklist.md +0 -0
  347. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/code-review/instructions.md +0 -0
  348. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/correct-course/checklist.md +0 -0
  349. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/correct-course/instructions.md +0 -0
  350. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/create-story/checklist.md +0 -0
  351. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/create-story/instructions.md +0 -0
  352. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/create-story/template.md +0 -0
  353. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/dev-story/AUDIT-REPORT.md +0 -0
  354. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/dev-story/checklist.md +0 -0
  355. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/dev-story/instructions.md +0 -0
  356. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/epic-tech-context/checklist.md +0 -0
  357. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/epic-tech-context/instructions.md +0 -0
  358. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/epic-tech-context/template.md +0 -0
  359. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/retrospective/instructions.md +0 -0
  360. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/sprint-planning/checklist.md +0 -0
  361. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/sprint-planning/instructions.md +0 -0
  362. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/sprint-planning/sprint-status-template.yaml +0 -0
  363. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-context/checklist.md +0 -0
  364. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-context/context-template.xml +0 -0
  365. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-context/instructions.md +0 -0
  366. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-done/instructions.md +0 -0
  367. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-ready/instructions.md +0 -0
@@ -1,664 +0,0 @@
1
- # Test Quality Definition of Done
2
-
3
- ## Principle
4
-
5
- Tests must be deterministic, isolated, explicit, focused, and fast. Every test should execute in under 1.5 minutes, contain fewer than 300 lines, avoid hard waits and conditionals, keep assertions visible in test bodies, and clean up after itself for parallel execution.
6
-
7
- ## Rationale
8
-
9
- Quality tests provide reliable signal about application health. Flaky tests erode confidence and waste engineering time. Tests that use hard waits (`waitForTimeout(3000)`) are non-deterministic and slow. Tests with hidden assertions or conditional logic become unmaintainable. Large tests (>300 lines) are hard to understand and debug. Slow tests (>1.5 min) block CI pipelines. Self-cleaning tests prevent state pollution in parallel runs.
10
-
11
- ## Pattern Examples
12
-
13
- ### Example 1: Deterministic Test Pattern
14
-
15
- **Context**: When writing tests, eliminate all sources of non-determinism: hard waits, conditionals controlling flow, try-catch for flow control, and random data without seeds.
16
-
17
- **Implementation**:
18
-
19
- ```typescript
20
- // ❌ BAD: Non-deterministic test with conditionals and hard waits
21
- test('user can view dashboard - FLAKY', async ({ page }) => {
22
- await page.goto('/dashboard');
23
- await page.waitForTimeout(3000); // NEVER - arbitrary wait
24
-
25
- // Conditional flow control - test behavior varies
26
- if (await page.locator('[data-testid="welcome-banner"]').isVisible()) {
27
- await page.click('[data-testid="dismiss-banner"]');
28
- await page.waitForTimeout(500);
29
- }
30
-
31
- // Try-catch for flow control - hides real issues
32
- try {
33
- await page.click('[data-testid="load-more"]');
34
- } catch (e) {
35
- // Silently continue - test passes even if button missing
36
- }
37
-
38
- // Random data without control
39
- const randomEmail = `user${Math.random()}@example.com`;
40
- await expect(page.getByText(randomEmail)).toBeVisible(); // Will fail randomly
41
- });
42
-
43
- // ✅ GOOD: Deterministic test with explicit waits
44
- test('user can view dashboard', async ({ page, apiRequest }) => {
45
- const user = createUser({ email: 'test@example.com', hasSeenWelcome: true });
46
-
47
- // Setup via API (fast, controlled)
48
- await apiRequest.post('/api/users', { data: user });
49
-
50
- // Network-first: Intercept BEFORE navigate
51
- const dashboardPromise = page.waitForResponse((resp) => resp.url().includes('/api/dashboard') && resp.status() === 200);
52
-
53
- await page.goto('/dashboard');
54
-
55
- // Wait for actual response, not arbitrary time
56
- const dashboardResponse = await dashboardPromise;
57
- const dashboard = await dashboardResponse.json();
58
-
59
- // Explicit assertions with controlled data
60
- await expect(page.getByText(`Welcome, ${user.name}`)).toBeVisible();
61
- await expect(page.getByTestId('dashboard-items')).toHaveCount(dashboard.items.length);
62
-
63
- // No conditionals - test always executes same path
64
- // No try-catch - failures bubble up clearly
65
- });
66
-
67
- // Cypress equivalent
68
- describe('Dashboard', () => {
69
- it('should display user dashboard', () => {
70
- const user = createUser({ email: 'test@example.com', hasSeenWelcome: true });
71
-
72
- // Setup via task (fast, controlled)
73
- cy.task('db:seed', { users: [user] });
74
-
75
- // Network-first interception
76
- cy.intercept('GET', '**/api/dashboard').as('getDashboard');
77
-
78
- cy.visit('/dashboard');
79
-
80
- // Deterministic wait for response
81
- cy.wait('@getDashboard').then((interception) => {
82
- const dashboard = interception.response.body;
83
-
84
- // Explicit assertions
85
- cy.contains(`Welcome, ${user.name}`).should('be.visible');
86
- cy.get('[data-cy="dashboard-items"]').should('have.length', dashboard.items.length);
87
- });
88
- });
89
- });
90
- ```
91
-
92
- **Key Points**:
93
-
94
- - Replace `waitForTimeout()` with `waitForResponse()` or element state checks
95
- - Never use if/else to control test flow - tests should be deterministic
96
- - Avoid try-catch for flow control - let failures bubble up clearly
97
- - Use factory functions with controlled data, not `Math.random()`
98
- - Network-first pattern prevents race conditions
99
-
100
- ### Example 2: Isolated Test with Cleanup
101
-
102
- **Context**: When tests create data, they must clean up after themselves to prevent state pollution in parallel runs. Use fixture auto-cleanup or explicit teardown.
103
-
104
- **Implementation**:
105
-
106
- ```typescript
107
- // ❌ BAD: Test leaves data behind, pollutes other tests
108
- test('admin can create user - POLLUTES STATE', async ({ page, apiRequest }) => {
109
- await page.goto('/admin/users');
110
-
111
- // Hardcoded email - collides in parallel runs
112
- await page.fill('[data-testid="email"]', 'newuser@example.com');
113
- await page.fill('[data-testid="name"]', 'New User');
114
- await page.click('[data-testid="create-user"]');
115
-
116
- await expect(page.getByText('User created')).toBeVisible();
117
-
118
- // NO CLEANUP - user remains in database
119
- // Next test run fails: "Email already exists"
120
- });
121
-
122
- // ✅ GOOD: Test cleans up with fixture auto-cleanup
123
- // playwright/support/fixtures/database-fixture.ts
124
- import { test as base } from '@playwright/test';
125
- import { deleteRecord, seedDatabase } from '../helpers/db-helpers';
126
-
127
- type DatabaseFixture = {
128
- seedUser: (userData: Partial<User>) => Promise<User>;
129
- };
130
-
131
- export const test = base.extend<DatabaseFixture>({
132
- seedUser: async ({}, use) => {
133
- const createdUsers: string[] = [];
134
-
135
- const seedUser = async (userData: Partial<User>) => {
136
- const user = await seedDatabase('users', userData);
137
- createdUsers.push(user.id); // Track for cleanup
138
- return user;
139
- };
140
-
141
- await use(seedUser);
142
-
143
- // Auto-cleanup: Delete all users created during test
144
- for (const userId of createdUsers) {
145
- await deleteRecord('users', userId);
146
- }
147
- createdUsers.length = 0;
148
- },
149
- });
150
-
151
- // Use the fixture
152
- test('admin can create user', async ({ page, seedUser }) => {
153
- // Create admin with unique data
154
- const admin = await seedUser({
155
- email: faker.internet.email(), // Unique each run
156
- role: 'admin',
157
- });
158
-
159
- await page.goto('/admin/users');
160
-
161
- const newUserEmail = faker.internet.email(); // Unique
162
- await page.fill('[data-testid="email"]', newUserEmail);
163
- await page.fill('[data-testid="name"]', 'New User');
164
- await page.click('[data-testid="create-user"]');
165
-
166
- await expect(page.getByText('User created')).toBeVisible();
167
-
168
- // Verify in database
169
- const createdUser = await seedUser({ email: newUserEmail });
170
- expect(createdUser.email).toBe(newUserEmail);
171
-
172
- // Auto-cleanup happens via fixture teardown
173
- });
174
-
175
- // Cypress equivalent with explicit cleanup
176
- describe('Admin User Management', () => {
177
- const createdUserIds: string[] = [];
178
-
179
- afterEach(() => {
180
- // Cleanup: Delete all users created during test
181
- createdUserIds.forEach((userId) => {
182
- cy.task('db:delete', { table: 'users', id: userId });
183
- });
184
- createdUserIds.length = 0;
185
- });
186
-
187
- it('should create user', () => {
188
- const admin = createUser({ role: 'admin' });
189
- const newUser = createUser(); // Unique data via faker
190
-
191
- cy.task('db:seed', { users: [admin] }).then((result: any) => {
192
- createdUserIds.push(result.users[0].id);
193
- });
194
-
195
- cy.visit('/admin/users');
196
- cy.get('[data-cy="email"]').type(newUser.email);
197
- cy.get('[data-cy="name"]').type(newUser.name);
198
- cy.get('[data-cy="create-user"]').click();
199
-
200
- cy.contains('User created').should('be.visible');
201
-
202
- // Track for cleanup
203
- cy.task('db:findByEmail', newUser.email).then((user: any) => {
204
- createdUserIds.push(user.id);
205
- });
206
- });
207
- });
208
- ```
209
-
210
- **Key Points**:
211
-
212
- - Use fixtures with auto-cleanup via teardown (after `use()`)
213
- - Track all created resources in array during test execution
214
- - Use `faker` for unique data - prevents parallel collisions
215
- - Cypress: Use `afterEach()` with explicit cleanup
216
- - Never hardcode IDs or emails - always generate unique values
217
-
218
- ### Example 3: Explicit Assertions in Tests
219
-
220
- **Context**: When validating test results, keep assertions visible in test bodies. Never hide assertions in helper functions - this obscures test intent and makes failures harder to diagnose.
221
-
222
- **Implementation**:
223
-
224
- ```typescript
225
- // ❌ BAD: Assertions hidden in helper functions
226
- // helpers/api-validators.ts
227
- export async function validateUserCreation(response: Response, expectedEmail: string) {
228
- const user = await response.json();
229
- expect(response.status()).toBe(201);
230
- expect(user.email).toBe(expectedEmail);
231
- expect(user.id).toBeTruthy();
232
- expect(user.createdAt).toBeTruthy();
233
- // Hidden assertions - not visible in test
234
- }
235
-
236
- test('create user via API - OPAQUE', async ({ request }) => {
237
- const userData = createUser({ email: 'test@example.com' });
238
-
239
- const response = await request.post('/api/users', { data: userData });
240
-
241
- // What assertions are running? Have to check helper.
242
- await validateUserCreation(response, userData.email);
243
- // When this fails, error is: "validateUserCreation failed" - NOT helpful
244
- });
245
-
246
- // ✅ GOOD: Assertions explicit in test
247
- test('create user via API', async ({ request }) => {
248
- const userData = createUser({ email: 'test@example.com' });
249
-
250
- const response = await request.post('/api/users', { data: userData });
251
-
252
- // All assertions visible - clear test intent
253
- expect(response.status()).toBe(201);
254
-
255
- const createdUser = await response.json();
256
- expect(createdUser.id).toBeTruthy();
257
- expect(createdUser.email).toBe(userData.email);
258
- expect(createdUser.name).toBe(userData.name);
259
- expect(createdUser.role).toBe('user');
260
- expect(createdUser.createdAt).toBeTruthy();
261
- expect(createdUser.isActive).toBe(true);
262
-
263
- // When this fails, error is: "Expected role to be 'user', got 'admin'" - HELPFUL
264
- });
265
-
266
- // ✅ ACCEPTABLE: Helper for data extraction, NOT assertions
267
- // helpers/api-extractors.ts
268
- export async function extractUserFromResponse(response: Response): Promise<User> {
269
- const user = await response.json();
270
- return user; // Just extracts, no assertions
271
- }
272
-
273
- test('create user with extraction helper', async ({ request }) => {
274
- const userData = createUser({ email: 'test@example.com' });
275
-
276
- const response = await request.post('/api/users', { data: userData });
277
-
278
- // Extract data with helper (OK)
279
- const createdUser = await extractUserFromResponse(response);
280
-
281
- // But keep assertions in test (REQUIRED)
282
- expect(response.status()).toBe(201);
283
- expect(createdUser.email).toBe(userData.email);
284
- expect(createdUser.role).toBe('user');
285
- });
286
-
287
- // Cypress equivalent
288
- describe('User API', () => {
289
- it('should create user with explicit assertions', () => {
290
- const userData = createUser({ email: 'test@example.com' });
291
-
292
- cy.request('POST', '/api/users', userData).then((response) => {
293
- // All assertions visible in test
294
- expect(response.status).to.equal(201);
295
- expect(response.body.id).to.exist;
296
- expect(response.body.email).to.equal(userData.email);
297
- expect(response.body.name).to.equal(userData.name);
298
- expect(response.body.role).to.equal('user');
299
- expect(response.body.createdAt).to.exist;
300
- expect(response.body.isActive).to.be.true;
301
- });
302
- });
303
- });
304
-
305
- // ✅ GOOD: Parametrized tests for soft assertions (bulk validation)
306
- test.describe('User creation validation', () => {
307
- const testCases = [
308
- { field: 'email', value: 'test@example.com', expected: 'test@example.com' },
309
- { field: 'name', value: 'Test User', expected: 'Test User' },
310
- { field: 'role', value: 'admin', expected: 'admin' },
311
- { field: 'isActive', value: true, expected: true },
312
- ];
313
-
314
- for (const { field, value, expected } of testCases) {
315
- test(`should set ${field} correctly`, async ({ request }) => {
316
- const userData = createUser({ [field]: value });
317
-
318
- const response = await request.post('/api/users', { data: userData });
319
- const user = await response.json();
320
-
321
- // Parametrized assertion - still explicit
322
- expect(user[field]).toBe(expected);
323
- });
324
- }
325
- });
326
- ```
327
-
328
- **Key Points**:
329
-
330
- - Never hide `expect()` calls in helper functions
331
- - Helpers can extract/transform data, but assertions stay in tests
332
- - Parametrized tests are acceptable for bulk validation (still explicit)
333
- - Explicit assertions make failures actionable: "Expected X, got Y"
334
- - Hidden assertions produce vague failures: "Helper function failed"
335
-
336
- ### Example 4: Test Length Limits
337
-
338
- **Context**: When tests grow beyond 300 lines, they become hard to understand, debug, and maintain. Refactor long tests by extracting setup helpers, splitting scenarios, or using fixtures.
339
-
340
- **Implementation**:
341
-
342
- ```typescript
343
- // ❌ BAD: 400-line monolithic test (truncated for example)
344
- test('complete user journey - TOO LONG', async ({ page, request }) => {
345
- // 50 lines of setup
346
- const admin = createUser({ role: 'admin' });
347
- await request.post('/api/users', { data: admin });
348
- await page.goto('/login');
349
- await page.fill('[data-testid="email"]', admin.email);
350
- await page.fill('[data-testid="password"]', 'password123');
351
- await page.click('[data-testid="login"]');
352
- await expect(page).toHaveURL('/dashboard');
353
-
354
- // 100 lines of user creation
355
- await page.goto('/admin/users');
356
- const newUser = createUser();
357
- await page.fill('[data-testid="email"]', newUser.email);
358
- // ... 95 more lines of form filling, validation, etc.
359
-
360
- // 100 lines of permissions assignment
361
- await page.click('[data-testid="assign-permissions"]');
362
- // ... 95 more lines
363
-
364
- // 100 lines of notification preferences
365
- await page.click('[data-testid="notification-settings"]');
366
- // ... 95 more lines
367
-
368
- // 50 lines of cleanup
369
- await request.delete(`/api/users/${newUser.id}`);
370
- // ... 45 more lines
371
-
372
- // TOTAL: 400 lines - impossible to understand or debug
373
- });
374
-
375
- // ✅ GOOD: Split into focused tests with shared fixture
376
- // playwright/support/fixtures/admin-fixture.ts
377
- export const test = base.extend({
378
- adminPage: async ({ page, request }, use) => {
379
- // Shared setup: Login as admin
380
- const admin = createUser({ role: 'admin' });
381
- await request.post('/api/users', { data: admin });
382
-
383
- await page.goto('/login');
384
- await page.fill('[data-testid="email"]', admin.email);
385
- await page.fill('[data-testid="password"]', 'password123');
386
- await page.click('[data-testid="login"]');
387
- await expect(page).toHaveURL('/dashboard');
388
-
389
- await use(page); // Provide logged-in page
390
-
391
- // Cleanup handled by fixture
392
- },
393
- });
394
-
395
- // Test 1: User creation (50 lines)
396
- test('admin can create user', async ({ adminPage, seedUser }) => {
397
- await adminPage.goto('/admin/users');
398
-
399
- const newUser = createUser();
400
- await adminPage.fill('[data-testid="email"]', newUser.email);
401
- await adminPage.fill('[data-testid="name"]', newUser.name);
402
- await adminPage.click('[data-testid="role-dropdown"]');
403
- await adminPage.click('[data-testid="role-user"]');
404
- await adminPage.click('[data-testid="create-user"]');
405
-
406
- await expect(adminPage.getByText('User created')).toBeVisible();
407
- await expect(adminPage.getByText(newUser.email)).toBeVisible();
408
-
409
- // Verify in database
410
- const created = await seedUser({ email: newUser.email });
411
- expect(created.role).toBe('user');
412
- });
413
-
414
- // Test 2: Permission assignment (60 lines)
415
- test('admin can assign permissions', async ({ adminPage, seedUser }) => {
416
- const user = await seedUser({ email: faker.internet.email() });
417
-
418
- await adminPage.goto(`/admin/users/${user.id}`);
419
- await adminPage.click('[data-testid="assign-permissions"]');
420
- await adminPage.check('[data-testid="permission-read"]');
421
- await adminPage.check('[data-testid="permission-write"]');
422
- await adminPage.click('[data-testid="save-permissions"]');
423
-
424
- await expect(adminPage.getByText('Permissions updated')).toBeVisible();
425
-
426
- // Verify permissions assigned
427
- const response = await adminPage.request.get(`/api/users/${user.id}`);
428
- const updated = await response.json();
429
- expect(updated.permissions).toContain('read');
430
- expect(updated.permissions).toContain('write');
431
- });
432
-
433
- // Test 3: Notification preferences (70 lines)
434
- test('admin can update notification preferences', async ({ adminPage, seedUser }) => {
435
- const user = await seedUser({ email: faker.internet.email() });
436
-
437
- await adminPage.goto(`/admin/users/${user.id}/notifications`);
438
- await adminPage.check('[data-testid="email-notifications"]');
439
- await adminPage.uncheck('[data-testid="sms-notifications"]');
440
- await adminPage.selectOption('[data-testid="frequency"]', 'daily');
441
- await adminPage.click('[data-testid="save-preferences"]');
442
-
443
- await expect(adminPage.getByText('Preferences saved')).toBeVisible();
444
-
445
- // Verify preferences
446
- const response = await adminPage.request.get(`/api/users/${user.id}/preferences`);
447
- const prefs = await response.json();
448
- expect(prefs.emailEnabled).toBe(true);
449
- expect(prefs.smsEnabled).toBe(false);
450
- expect(prefs.frequency).toBe('daily');
451
- });
452
-
453
- // TOTAL: 3 tests × 60 lines avg = 180 lines
454
- // Each test is focused, debuggable, and under 300 lines
455
- ```
456
-
457
- **Key Points**:
458
-
459
- - Split monolithic tests into focused scenarios (<300 lines each)
460
- - Extract common setup into fixtures (auto-runs for each test)
461
- - Each test validates one concern (user creation, permissions, preferences)
462
- - Failures are easier to diagnose: "Permission assignment failed" vs "Complete journey failed"
463
- - Tests can run in parallel (isolated concerns)
464
-
465
- ### Example 5: Execution Time Optimization
466
-
467
- **Context**: When tests take longer than 1.5 minutes, they slow CI pipelines and feedback loops. Optimize by using API setup instead of UI navigation, parallelizing independent operations, and avoiding unnecessary waits.
468
-
469
- **Implementation**:
470
-
471
- ```typescript
472
- // ❌ BAD: 4-minute test (slow setup, sequential operations)
473
- test('user completes order - SLOW (4 min)', async ({ page }) => {
474
- // Step 1: Manual signup via UI (90 seconds)
475
- await page.goto('/signup');
476
- await page.fill('[data-testid="email"]', 'buyer@example.com');
477
- await page.fill('[data-testid="password"]', 'password123');
478
- await page.fill('[data-testid="confirm-password"]', 'password123');
479
- await page.fill('[data-testid="name"]', 'Buyer User');
480
- await page.click('[data-testid="signup"]');
481
- await page.waitForURL('/verify-email'); // Wait for email verification
482
- // ... manual email verification flow
483
-
484
- // Step 2: Manual product creation via UI (60 seconds)
485
- await page.goto('/admin/products');
486
- await page.fill('[data-testid="product-name"]', 'Widget');
487
- // ... 20 more fields
488
- await page.click('[data-testid="create-product"]');
489
-
490
- // Step 3: Navigate to checkout (30 seconds)
491
- await page.goto('/products');
492
- await page.waitForTimeout(5000); // Unnecessary hard wait
493
- await page.click('[data-testid="product-widget"]');
494
- await page.waitForTimeout(3000); // Unnecessary
495
- await page.click('[data-testid="add-to-cart"]');
496
- await page.waitForTimeout(2000); // Unnecessary
497
-
498
- // Step 4: Complete checkout (40 seconds)
499
- await page.goto('/checkout');
500
- await page.waitForTimeout(5000); // Unnecessary
501
- await page.fill('[data-testid="credit-card"]', '4111111111111111');
502
- // ... more form filling
503
- await page.click('[data-testid="submit-order"]');
504
- await page.waitForTimeout(10000); // Unnecessary
505
-
506
- await expect(page.getByText('Order Confirmed')).toBeVisible();
507
-
508
- // TOTAL: ~240 seconds (4 minutes)
509
- });
510
-
511
- // ✅ GOOD: 45-second test (API setup, parallel ops, deterministic waits)
512
- test('user completes order', async ({ page, apiRequest }) => {
513
- // Step 1: API setup (parallel, 5 seconds total)
514
- const [user, product] = await Promise.all([
515
- // Create user via API (fast)
516
- apiRequest
517
- .post('/api/users', {
518
- data: createUser({
519
- email: 'buyer@example.com',
520
- emailVerified: true, // Skip verification
521
- }),
522
- })
523
- .then((r) => r.json()),
524
-
525
- // Create product via API (fast)
526
- apiRequest
527
- .post('/api/products', {
528
- data: createProduct({
529
- name: 'Widget',
530
- price: 29.99,
531
- stock: 10,
532
- }),
533
- })
534
- .then((r) => r.json()),
535
- ]);
536
-
537
- // Step 2: Auth setup via storage state (instant, 0 seconds)
538
- await page.context().addCookies([
539
- {
540
- name: 'auth_token',
541
- value: user.token,
542
- domain: 'localhost',
543
- path: '/',
544
- },
545
- ]);
546
-
547
- // Step 3: Network-first interception BEFORE navigation (10 seconds)
548
- const cartPromise = page.waitForResponse('**/api/cart');
549
- const orderPromise = page.waitForResponse('**/api/orders');
550
-
551
- await page.goto(`/products/${product.id}`);
552
- await page.click('[data-testid="add-to-cart"]');
553
- await cartPromise; // Deterministic wait (no hard wait)
554
-
555
- // Step 4: Checkout with network waits (30 seconds)
556
- await page.goto('/checkout');
557
- await page.fill('[data-testid="credit-card"]', '4111111111111111');
558
- await page.fill('[data-testid="cvv"]', '123');
559
- await page.fill('[data-testid="expiry"]', '12/25');
560
- await page.click('[data-testid="submit-order"]');
561
- await orderPromise; // Deterministic wait (no hard wait)
562
-
563
- await expect(page.getByText('Order Confirmed')).toBeVisible();
564
- await expect(page.getByText(`Order #${product.id}`)).toBeVisible();
565
-
566
- // TOTAL: ~45 seconds (6x faster)
567
- });
568
-
569
- // Cypress equivalent
570
- describe('Order Flow', () => {
571
- it('should complete purchase quickly', () => {
572
- // Step 1: API setup (parallel, fast)
573
- const user = createUser({ emailVerified: true });
574
- const product = createProduct({ name: 'Widget', price: 29.99 });
575
-
576
- cy.task('db:seed', { users: [user], products: [product] });
577
-
578
- // Step 2: Auth setup via session (instant)
579
- cy.setCookie('auth_token', user.token);
580
-
581
- // Step 3: Network-first interception
582
- cy.intercept('POST', '**/api/cart').as('addToCart');
583
- cy.intercept('POST', '**/api/orders').as('createOrder');
584
-
585
- cy.visit(`/products/${product.id}`);
586
- cy.get('[data-cy="add-to-cart"]').click();
587
- cy.wait('@addToCart'); // Deterministic wait
588
-
589
- // Step 4: Checkout
590
- cy.visit('/checkout');
591
- cy.get('[data-cy="credit-card"]').type('4111111111111111');
592
- cy.get('[data-cy="cvv"]').type('123');
593
- cy.get('[data-cy="expiry"]').type('12/25');
594
- cy.get('[data-cy="submit-order"]').click();
595
- cy.wait('@createOrder'); // Deterministic wait
596
-
597
- cy.contains('Order Confirmed').should('be.visible');
598
- cy.contains(`Order #${product.id}`).should('be.visible');
599
- });
600
- });
601
-
602
- // Additional optimization: Shared auth state (0 seconds per test)
603
- // playwright/support/global-setup.ts
604
- export default async function globalSetup() {
605
- const browser = await chromium.launch();
606
- const page = await browser.newPage();
607
-
608
- // Create admin user once for all tests
609
- const admin = createUser({ role: 'admin', emailVerified: true });
610
- await page.request.post('/api/users', { data: admin });
611
-
612
- // Login once, save session
613
- await page.goto('/login');
614
- await page.fill('[data-testid="email"]', admin.email);
615
- await page.fill('[data-testid="password"]', 'password123');
616
- await page.click('[data-testid="login"]');
617
-
618
- // Save auth state for reuse
619
- await page.context().storageState({ path: 'playwright/.auth/admin.json' });
620
-
621
- await browser.close();
622
- }
623
-
624
- // Use shared auth in tests (instant)
625
- test.use({ storageState: 'playwright/.auth/admin.json' });
626
-
627
- test('admin action', async ({ page }) => {
628
- // Already logged in - no auth overhead (0 seconds)
629
- await page.goto('/admin');
630
- // ... test logic
631
- });
632
- ```
633
-
634
- **Key Points**:
635
-
636
- - Use API for data setup (10-50x faster than UI)
637
- - Run independent operations in parallel (`Promise.all`)
638
- - Replace hard waits with deterministic waits (`waitForResponse`)
639
- - Reuse auth sessions via `storageState` (Playwright) or `setCookie` (Cypress)
640
- - Skip unnecessary flows (email verification, multi-step signups)
641
-
642
- ## Integration Points
643
-
644
- - **Used in workflows**: `*atdd` (test generation quality), `*automate` (test expansion quality), `*test-review` (quality validation)
645
- - **Related fragments**:
646
- - `network-first.md` - Deterministic waiting strategies
647
- - `data-factories.md` - Isolated, parallel-safe data patterns
648
- - `fixture-architecture.md` - Setup extraction and cleanup
649
- - `test-levels-framework.md` - Choosing appropriate test granularity for speed
650
-
651
- ## Core Quality Checklist
652
-
653
- Every test must pass these criteria:
654
-
655
- - [ ] **No Hard Waits** - Use `waitForResponse`, `waitForLoadState`, or element state (not `waitForTimeout`)
656
- - [ ] **No Conditionals** - Tests execute the same path every time (no if/else, try/catch for flow control)
657
- - [ ] **< 300 Lines** - Keep tests focused; split large tests or extract setup to fixtures
658
- - [ ] **< 1.5 Minutes** - Optimize with API setup, parallel operations, and shared auth
659
- - [ ] **Self-Cleaning** - Use fixtures with auto-cleanup or explicit `afterEach()` teardown
660
- - [ ] **Explicit Assertions** - Keep `expect()` calls in test bodies, not hidden in helpers
661
- - [ ] **Unique Data** - Use `faker` for dynamic data; never hardcode IDs or emails
662
- - [ ] **Parallel-Safe** - Tests don't share state; run successfully with `--workers=4`
663
-
664
- _Source: Murat quality checklist, Definition of Done requirements (lines 370-381, 406-422)._