qualia-framework 2.5.1 → 3.1.0

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 (327) hide show
  1. package/CLAUDE.md +63 -0
  2. package/README.md +108 -30
  3. package/agents/builder.md +110 -0
  4. package/agents/planner.md +186 -0
  5. package/agents/qa-browser.md +186 -0
  6. package/agents/verifier.md +369 -0
  7. package/bin/cli.js +706 -417
  8. package/bin/install.js +622 -0
  9. package/bin/qualia-ui.js +284 -0
  10. package/bin/state.js +824 -0
  11. package/bin/statusline.js +252 -0
  12. package/docs/erp-contract.md +161 -0
  13. package/guide.md +63 -0
  14. package/hooks/auto-update.js +117 -0
  15. package/hooks/block-env-edit.js +52 -0
  16. package/hooks/branch-guard.js +68 -0
  17. package/hooks/migration-guard.js +83 -0
  18. package/hooks/pre-compact.js +52 -0
  19. package/hooks/pre-deploy-gate.js +149 -0
  20. package/hooks/pre-push.js +53 -0
  21. package/hooks/session-start.js +126 -0
  22. package/package.json +31 -17
  23. package/rules/design-reference.md +179 -0
  24. package/rules/frontend.md +126 -0
  25. package/rules/infrastructure.md +87 -0
  26. package/skills/qualia/SKILL.md +88 -0
  27. package/skills/qualia-build/SKILL.md +115 -0
  28. package/skills/qualia-debug/SKILL.md +87 -0
  29. package/skills/qualia-design/SKILL.md +99 -0
  30. package/skills/qualia-handoff/SKILL.md +66 -0
  31. package/skills/qualia-help/SKILL.md +60 -0
  32. package/skills/qualia-idk/SKILL.md +8 -0
  33. package/skills/qualia-learn/SKILL.md +111 -0
  34. package/skills/qualia-new/SKILL.md +323 -0
  35. package/skills/qualia-pause/SKILL.md +63 -0
  36. package/skills/qualia-plan/SKILL.md +101 -0
  37. package/skills/qualia-polish/SKILL.md +207 -0
  38. package/skills/qualia-quick/SKILL.md +37 -0
  39. package/skills/qualia-report/SKILL.md +114 -0
  40. package/skills/qualia-resume/SKILL.md +49 -0
  41. package/skills/qualia-review/SKILL.md +161 -0
  42. package/skills/qualia-ship/SKILL.md +90 -0
  43. package/skills/qualia-skill-new/SKILL.md +167 -0
  44. package/skills/qualia-task/SKILL.md +91 -0
  45. package/skills/qualia-test/SKILL.md +134 -0
  46. package/skills/qualia-verify/SKILL.md +113 -0
  47. package/templates/DESIGN.md +475 -0
  48. package/templates/help.html +476 -0
  49. package/templates/plan.md +42 -0
  50. package/templates/project.md +22 -0
  51. package/templates/state.md +27 -0
  52. package/templates/tracking.json +20 -0
  53. package/tests/bin.test.sh +687 -0
  54. package/tests/hooks.test.sh +384 -0
  55. package/tests/runner.js +1956 -0
  56. package/tests/state.test.sh +713 -0
  57. package/tests/statusline.test.sh +243 -0
  58. package/bin/collect-metrics.sh +0 -62
  59. package/framework/.claudeignore +0 -51
  60. package/framework/CLAUDE.md +0 -51
  61. package/framework/MCP_SETUP.md +0 -229
  62. package/framework/agents/architecture-strategist.md +0 -53
  63. package/framework/agents/backend-agent.md +0 -150
  64. package/framework/agents/code-simplicity-reviewer.md +0 -86
  65. package/framework/agents/frontend-agent.md +0 -111
  66. package/framework/agents/kieran-typescript-reviewer.md +0 -96
  67. package/framework/agents/performance-oracle.md +0 -111
  68. package/framework/agents/qualia-codebase-mapper.md +0 -761
  69. package/framework/agents/qualia-debugger.md +0 -1204
  70. package/framework/agents/qualia-executor.md +0 -882
  71. package/framework/agents/qualia-integration-checker.md +0 -424
  72. package/framework/agents/qualia-phase-researcher.md +0 -457
  73. package/framework/agents/qualia-plan-checker.md +0 -700
  74. package/framework/agents/qualia-planner.md +0 -1245
  75. package/framework/agents/qualia-project-researcher.md +0 -603
  76. package/framework/agents/qualia-research-synthesizer.md +0 -200
  77. package/framework/agents/qualia-roadmapper.md +0 -606
  78. package/framework/agents/qualia-verifier.md +0 -686
  79. package/framework/agents/red-team-qa.md +0 -130
  80. package/framework/agents/security-auditor.md +0 -72
  81. package/framework/agents/team-orchestrator.md +0 -229
  82. package/framework/agents/teams/framework-audit-team.md +0 -66
  83. package/framework/agents/teams/full-stack-team.md +0 -48
  84. package/framework/agents/teams/optimize-team.md +0 -53
  85. package/framework/agents/teams/review-team.md +0 -70
  86. package/framework/agents/teams/ship-team.md +0 -86
  87. package/framework/agents/test-agent.md +0 -182
  88. package/framework/hooks/auto-format.sh +0 -54
  89. package/framework/hooks/block-env-edit.sh +0 -42
  90. package/framework/hooks/branch-guard.sh +0 -43
  91. package/framework/hooks/confirm-delete.sh +0 -59
  92. package/framework/hooks/migration-validate.sh +0 -77
  93. package/framework/hooks/notification-speak.sh +0 -16
  94. package/framework/hooks/pre-commit.sh +0 -100
  95. package/framework/hooks/pre-compact.sh +0 -56
  96. package/framework/hooks/pre-deploy-gate.sh +0 -160
  97. package/framework/hooks/qualia-colors.sh +0 -32
  98. package/framework/hooks/retention-cleanup.sh +0 -62
  99. package/framework/hooks/save-session-state.sh +0 -185
  100. package/framework/hooks/session-context-loader.sh +0 -96
  101. package/framework/hooks/session-learn.sh +0 -32
  102. package/framework/hooks/skill-announce.sh +0 -123
  103. package/framework/hooks/tool-error-announce.sh +0 -27
  104. package/framework/install.ps1 +0 -323
  105. package/framework/install.sh +0 -313
  106. package/framework/qualia-framework/VERSION +0 -1
  107. package/framework/qualia-framework/assets/qualia-logo.png +0 -0
  108. package/framework/qualia-framework/bin/collect-metrics.sh +0 -67
  109. package/framework/qualia-framework/bin/generate-report-docx.py +0 -429
  110. package/framework/qualia-framework/bin/qualia-tools.js +0 -2201
  111. package/framework/qualia-framework/bin/qualia-tools.test.js +0 -1054
  112. package/framework/qualia-framework/references/checkpoints.md +0 -775
  113. package/framework/qualia-framework/references/completion-checklists.md +0 -359
  114. package/framework/qualia-framework/references/continuation-format.md +0 -249
  115. package/framework/qualia-framework/references/continuation-prompt.md +0 -97
  116. package/framework/qualia-framework/references/decimal-phase-calculation.md +0 -65
  117. package/framework/qualia-framework/references/design-quality.md +0 -56
  118. package/framework/qualia-framework/references/employee-guide.md +0 -167
  119. package/framework/qualia-framework/references/git-integration.md +0 -254
  120. package/framework/qualia-framework/references/git-planning-commit.md +0 -50
  121. package/framework/qualia-framework/references/model-profile-resolution.md +0 -32
  122. package/framework/qualia-framework/references/model-profiles.md +0 -73
  123. package/framework/qualia-framework/references/phase-argument-parsing.md +0 -61
  124. package/framework/qualia-framework/references/planning-config.md +0 -195
  125. package/framework/qualia-framework/references/questioning.md +0 -141
  126. package/framework/qualia-framework/references/tdd.md +0 -263
  127. package/framework/qualia-framework/references/ui-brand.md +0 -160
  128. package/framework/qualia-framework/references/verification-patterns.md +0 -612
  129. package/framework/qualia-framework/templates/DEBUG.md +0 -159
  130. package/framework/qualia-framework/templates/DESIGN.md +0 -81
  131. package/framework/qualia-framework/templates/UAT.md +0 -247
  132. package/framework/qualia-framework/templates/codebase/architecture.md +0 -255
  133. package/framework/qualia-framework/templates/codebase/concerns.md +0 -310
  134. package/framework/qualia-framework/templates/codebase/conventions.md +0 -307
  135. package/framework/qualia-framework/templates/codebase/integrations.md +0 -280
  136. package/framework/qualia-framework/templates/codebase/stack.md +0 -186
  137. package/framework/qualia-framework/templates/codebase/structure.md +0 -285
  138. package/framework/qualia-framework/templates/codebase/testing.md +0 -480
  139. package/framework/qualia-framework/templates/config.json +0 -35
  140. package/framework/qualia-framework/templates/context.md +0 -283
  141. package/framework/qualia-framework/templates/continue-here.md +0 -78
  142. package/framework/qualia-framework/templates/debug-subagent-prompt.md +0 -91
  143. package/framework/qualia-framework/templates/discovery.md +0 -146
  144. package/framework/qualia-framework/templates/lab-notes.md +0 -16
  145. package/framework/qualia-framework/templates/milestone-archive.md +0 -123
  146. package/framework/qualia-framework/templates/milestone.md +0 -115
  147. package/framework/qualia-framework/templates/phase-prompt.md +0 -567
  148. package/framework/qualia-framework/templates/planner-subagent-prompt.md +0 -117
  149. package/framework/qualia-framework/templates/project.md +0 -184
  150. package/framework/qualia-framework/templates/projects/ai-agent.md +0 -156
  151. package/framework/qualia-framework/templates/projects/mobile-app.md +0 -181
  152. package/framework/qualia-framework/templates/projects/voice-agent.md +0 -134
  153. package/framework/qualia-framework/templates/projects/website.md +0 -137
  154. package/framework/qualia-framework/templates/requirements.md +0 -231
  155. package/framework/qualia-framework/templates/research-project/ARCHITECTURE.md +0 -204
  156. package/framework/qualia-framework/templates/research-project/FEATURES.md +0 -147
  157. package/framework/qualia-framework/templates/research-project/PITFALLS.md +0 -200
  158. package/framework/qualia-framework/templates/research-project/STACK.md +0 -120
  159. package/framework/qualia-framework/templates/research-project/SUMMARY.md +0 -170
  160. package/framework/qualia-framework/templates/research.md +0 -552
  161. package/framework/qualia-framework/templates/roadmap.md +0 -206
  162. package/framework/qualia-framework/templates/state.md +0 -179
  163. package/framework/qualia-framework/templates/summary-complex.md +0 -59
  164. package/framework/qualia-framework/templates/summary-minimal.md +0 -41
  165. package/framework/qualia-framework/templates/summary-standard.md +0 -48
  166. package/framework/qualia-framework/templates/summary.md +0 -246
  167. package/framework/qualia-framework/templates/user-setup.md +0 -311
  168. package/framework/qualia-framework/templates/verification-report.md +0 -322
  169. package/framework/qualia-framework/workflows/add-phase.md +0 -179
  170. package/framework/qualia-framework/workflows/add-todo.md +0 -157
  171. package/framework/qualia-framework/workflows/audit-milestone.md +0 -241
  172. package/framework/qualia-framework/workflows/check-todos.md +0 -176
  173. package/framework/qualia-framework/workflows/complete-milestone.md +0 -858
  174. package/framework/qualia-framework/workflows/diagnose-issues.md +0 -219
  175. package/framework/qualia-framework/workflows/discovery-phase.md +0 -289
  176. package/framework/qualia-framework/workflows/discuss-phase.md +0 -534
  177. package/framework/qualia-framework/workflows/execute-phase.md +0 -559
  178. package/framework/qualia-framework/workflows/execute-plan.md +0 -438
  179. package/framework/qualia-framework/workflows/help.md +0 -470
  180. package/framework/qualia-framework/workflows/insert-phase.md +0 -220
  181. package/framework/qualia-framework/workflows/list-phase-assumptions.md +0 -178
  182. package/framework/qualia-framework/workflows/map-codebase.md +0 -327
  183. package/framework/qualia-framework/workflows/new-milestone.md +0 -363
  184. package/framework/qualia-framework/workflows/new-project.md +0 -982
  185. package/framework/qualia-framework/workflows/pause-work.md +0 -122
  186. package/framework/qualia-framework/workflows/plan-milestone-gaps.md +0 -256
  187. package/framework/qualia-framework/workflows/plan-phase.md +0 -422
  188. package/framework/qualia-framework/workflows/progress.md +0 -389
  189. package/framework/qualia-framework/workflows/quick.md +0 -252
  190. package/framework/qualia-framework/workflows/remove-phase.md +0 -326
  191. package/framework/qualia-framework/workflows/research-phase.md +0 -74
  192. package/framework/qualia-framework/workflows/resume-project.md +0 -306
  193. package/framework/qualia-framework/workflows/set-profile.md +0 -80
  194. package/framework/qualia-framework/workflows/settings.md +0 -145
  195. package/framework/qualia-framework/workflows/transition.md +0 -556
  196. package/framework/qualia-framework/workflows/update.md +0 -197
  197. package/framework/qualia-framework/workflows/verify-phase.md +0 -195
  198. package/framework/qualia-framework/workflows/verify-work.md +0 -625
  199. package/framework/rules/context7.md +0 -14
  200. package/framework/rules/frontend.md +0 -33
  201. package/framework/rules/speed.md +0 -23
  202. package/framework/scripts/__pycache__/say.cpython-314.pyc +0 -0
  203. package/framework/scripts/apply-retention.sh +0 -120
  204. package/framework/scripts/bootstrap-pop-os.sh +0 -354
  205. package/framework/scripts/claude-voice +0 -13
  206. package/framework/scripts/cleanup.sh +0 -131
  207. package/framework/scripts/cowork-mode.sh +0 -141
  208. package/framework/scripts/generate-project-claude-md.sh +0 -153
  209. package/framework/scripts/load-test-webhook.js +0 -172
  210. package/framework/scripts/say.py +0 -236
  211. package/framework/scripts/showcase-video-recorder/ffmpeg-builder.js +0 -167
  212. package/framework/scripts/showcase-video-recorder/playwright-helpers.js +0 -216
  213. package/framework/scripts/speak.py +0 -55
  214. package/framework/scripts/speak.sh +0 -18
  215. package/framework/scripts/status.sh +0 -138
  216. package/framework/scripts/sync-to-framework.sh +0 -65
  217. package/framework/scripts/voice-hotkey.py +0 -227
  218. package/framework/scripts/voice-input.sh +0 -51
  219. package/framework/skills/animate/SKILL.md +0 -202
  220. package/framework/skills/bolder/SKILL.md +0 -144
  221. package/framework/skills/browser-qa/SKILL.md +0 -536
  222. package/framework/skills/clarify/SKILL.md +0 -179
  223. package/framework/skills/client-handoff/SKILL.md +0 -135
  224. package/framework/skills/collab-onboard/SKILL.md +0 -111
  225. package/framework/skills/colorize/SKILL.md +0 -170
  226. package/framework/skills/critique/SKILL.md +0 -126
  227. package/framework/skills/deep-research/SKILL.md +0 -240
  228. package/framework/skills/delight/SKILL.md +0 -329
  229. package/framework/skills/deploy/SKILL.md +0 -261
  230. package/framework/skills/deploy-verify/SKILL.md +0 -377
  231. package/framework/skills/deploy-verify/scripts/canary-check.sh +0 -206
  232. package/framework/skills/deploy-verify/scripts/check-console-errors.js +0 -147
  233. package/framework/skills/deploy-verify/scripts/check-cwv.js +0 -139
  234. package/framework/skills/deploy-verify/scripts/project-detect.sh +0 -84
  235. package/framework/skills/deploy-verify/scripts/verify.sh +0 -548
  236. package/framework/skills/design-quieter/SKILL.md +0 -130
  237. package/framework/skills/distill/SKILL.md +0 -149
  238. package/framework/skills/docs-lookup/SKILL.md +0 -79
  239. package/framework/skills/fcm-notifications/SKILL.md +0 -125
  240. package/framework/skills/financial-ledger/SKILL.md +0 -1039
  241. package/framework/skills/frontend-master/NOTICE.md +0 -4
  242. package/framework/skills/frontend-master/SKILL.md +0 -127
  243. package/framework/skills/frontend-master/reference/color-and-contrast.md +0 -132
  244. package/framework/skills/frontend-master/reference/interaction-design.md +0 -123
  245. package/framework/skills/frontend-master/reference/motion-design.md +0 -99
  246. package/framework/skills/frontend-master/reference/responsive-design.md +0 -114
  247. package/framework/skills/frontend-master/reference/spatial-design.md +0 -100
  248. package/framework/skills/frontend-master/reference/typography.md +0 -131
  249. package/framework/skills/frontend-master/reference/ux-writing.md +0 -107
  250. package/framework/skills/harden/SKILL.md +0 -357
  251. package/framework/skills/i18n-rtl/SKILL.md +0 -752
  252. package/framework/skills/learn/SKILL.md +0 -95
  253. package/framework/skills/memory/SKILL.md +0 -50
  254. package/framework/skills/mobile-expo/SKILL.md +0 -977
  255. package/framework/skills/mobile-expo/references/store-checklist.md +0 -550
  256. package/framework/skills/nestjs-backend/README.md +0 -73
  257. package/framework/skills/nestjs-backend/SKILL.md +0 -446
  258. package/framework/skills/nestjs-backend/references/templates.md +0 -1173
  259. package/framework/skills/normalize/SKILL.md +0 -79
  260. package/framework/skills/onboard/SKILL.md +0 -242
  261. package/framework/skills/openrouter-agent/SKILL.md +0 -922
  262. package/framework/skills/polish/SKILL.md +0 -209
  263. package/framework/skills/pr/SKILL.md +0 -66
  264. package/framework/skills/qualia/SKILL.md +0 -199
  265. package/framework/skills/qualia-add-todo/SKILL.md +0 -68
  266. package/framework/skills/qualia-audit-milestone/SKILL.md +0 -95
  267. package/framework/skills/qualia-check-todos/SKILL.md +0 -55
  268. package/framework/skills/qualia-complete-milestone/SKILL.md +0 -134
  269. package/framework/skills/qualia-debug/SKILL.md +0 -149
  270. package/framework/skills/qualia-design/SKILL.md +0 -203
  271. package/framework/skills/qualia-discuss-phase/SKILL.md +0 -72
  272. package/framework/skills/qualia-evolve/SKILL.md +0 -200
  273. package/framework/skills/qualia-execute-phase/SKILL.md +0 -89
  274. package/framework/skills/qualia-framework-audit/SKILL.md +0 -604
  275. package/framework/skills/qualia-guide/SKILL.md +0 -32
  276. package/framework/skills/qualia-help/SKILL.md +0 -114
  277. package/framework/skills/qualia-idk/SKILL.md +0 -352
  278. package/framework/skills/qualia-list-phase-assumptions/SKILL.md +0 -67
  279. package/framework/skills/qualia-new-milestone/SKILL.md +0 -72
  280. package/framework/skills/qualia-new-project/SKILL.md +0 -232
  281. package/framework/skills/qualia-optimize/SKILL.md +0 -417
  282. package/framework/skills/qualia-pause-work/SKILL.md +0 -96
  283. package/framework/skills/qualia-plan-milestone-gaps/SKILL.md +0 -57
  284. package/framework/skills/qualia-plan-phase/SKILL.md +0 -104
  285. package/framework/skills/qualia-production-check/SKILL.md +0 -0
  286. package/framework/skills/qualia-progress/SKILL.md +0 -53
  287. package/framework/skills/qualia-quick/SKILL.md +0 -89
  288. package/framework/skills/qualia-report/SKILL.md +0 -166
  289. package/framework/skills/qualia-research-phase/SKILL.md +0 -88
  290. package/framework/skills/qualia-resume-work/SKILL.md +0 -62
  291. package/framework/skills/qualia-review/SKILL.md +0 -263
  292. package/framework/skills/qualia-start/SKILL.md +0 -161
  293. package/framework/skills/qualia-verify-work/SKILL.md +0 -132
  294. package/framework/skills/rag/SKILL.md +0 -750
  295. package/framework/skills/responsive/SKILL.md +0 -231
  296. package/framework/skills/retro/SKILL.md +0 -284
  297. package/framework/skills/sakani-conventions/SKILL.md +0 -136
  298. package/framework/skills/sakani-conventions/evals/evals.json +0 -23
  299. package/framework/skills/sakani-conventions/references/entities.md +0 -365
  300. package/framework/skills/sakani-conventions/references/error-codes.md +0 -95
  301. package/framework/skills/seo-master/SKILL.md +0 -490
  302. package/framework/skills/seo-master/references/checklist.md +0 -199
  303. package/framework/skills/seo-master/references/structured-data.md +0 -609
  304. package/framework/skills/ship/SKILL.md +0 -239
  305. package/framework/skills/stack-researcher/SKILL.md +0 -215
  306. package/framework/skills/status/SKILL.md +0 -154
  307. package/framework/skills/status/scripts/health-check.sh +0 -562
  308. package/framework/skills/subscription-payments/SKILL.md +0 -250
  309. package/framework/skills/supabase/SKILL.md +0 -973
  310. package/framework/skills/supabase/references/templates.md +0 -159
  311. package/framework/skills/team/SKILL.md +0 -67
  312. package/framework/skills/test-runner/SKILL.md +0 -202
  313. package/framework/skills/voice-agent/SKILL.md +0 -1312
  314. package/framework/skills/zoho-workflow/SKILL.md +0 -51
  315. package/framework/statusline-command.sh +0 -117
  316. package/framework/teams/default/inboxes/plan-04.json +0 -9
  317. package/framework/teams/review-team.md +0 -75
  318. package/framework/teams/ship-team.md +0 -86
  319. package/profiles/fawzi.json +0 -16
  320. package/profiles/hasan.json +0 -16
  321. package/profiles/moayad.json +0 -16
  322. package/templates/CLAUDE-owner.md +0 -52
  323. package/templates/CLAUDE.md.hbs +0 -58
  324. package/templates/env.claude.template +0 -12
  325. package/templates/settings.json +0 -172
  326. /package/{framework/rules → rules}/deployment.md +0 -0
  327. /package/{framework/rules → rules}/security.md +0 -0
@@ -1,536 +0,0 @@
1
- ---
2
- name: browser-qa
3
- description: "Browser QA using Playwright. Navigates routes affected by git diff, captures console errors, broken links, and HTTP failures with screenshots. Web projects only."
4
- user-invocable: true
5
- tags: [qa, testing, playwright, browser, screenshots]
6
- ---
7
-
8
- # Browser QA
9
-
10
- Automated browser testing with Playwright. Detects changed routes from git diff, navigates them, and reports runtime issues with screenshot evidence.
11
-
12
- ## Usage
13
-
14
- - `/qa` -- Run QA on affected routes (from git diff against current branch's base)
15
- - `/qa --all` -- Run QA on all known routes (full scan)
16
- - `/qa --url <url>` -- Run QA on a specific URL
17
-
18
- ## Step 1: Project Type Check
19
-
20
- Before anything else, determine if this is a web project. Run:
21
-
22
- ```bash
23
- # Check for web project indicators
24
- HAS_WEB=false
25
- [ -f "package.json" ] && grep -qE '"next"|"react"|"vue"|"nuxt"|"astro"|"vite"|"gatsby"' package.json && HAS_WEB=true
26
- [ -f "index.html" ] && HAS_WEB=true
27
- [ -d "src/app" ] || [ -d "pages" ] || [ -d "src/pages" ] && HAS_WEB=true
28
-
29
- echo "HAS_WEB=$HAS_WEB"
30
- ```
31
-
32
- **If HAS_WEB=false:** Stop immediately and output:
33
-
34
- > Browser QA skipped: This project is not a web application. /qa is designed for projects with a browser-rendered frontend (Next.js, React, Vue, etc.). Voice agents, Python agents, and CLI tools do not have browser routes to test.
35
-
36
- **If HAS_WEB=true:** Continue to Step 2.
37
-
38
- ### Known Non-Web Projects (skip without checking)
39
-
40
- These projects are known to not be web apps:
41
- - **sigatalachana** -- Python agent (invoice OCR + POS)
42
- - **armenius** -- Cloudflare Workers webhook (no frontend routes)
43
- - Any project in `~/Projects/aiagents/` with no `package.json` containing a web framework
44
- - Any project with only `.py` files and no web framework (Flask/Django with templates are web)
45
-
46
- If the current directory name matches a known non-web project, skip immediately.
47
-
48
- ## Step 2: Detect Affected Routes
49
-
50
- Determine which routes to test based on git changes.
51
-
52
- ### Automatic Route Detection
53
-
54
- ```bash
55
- # Get changed files relative to the merge base
56
- BRANCH=$(git rev-parse --abbrev-ref HEAD)
57
- BASE=$(git merge-base HEAD main 2>/dev/null || git merge-base HEAD master 2>/dev/null || echo "HEAD~5")
58
- CHANGED_FILES=$(git diff --name-only "$BASE"...HEAD 2>/dev/null || git diff --name-only HEAD~5)
59
-
60
- echo "Changed files:"
61
- echo "$CHANGED_FILES"
62
- ```
63
-
64
- ### Route Mapping Rules
65
-
66
- Map changed files to browser routes:
67
-
68
- | File Pattern | Route |
69
- |-------------|-------|
70
- | `src/app/<path>/page.tsx` | `/<path>` |
71
- | `src/app/page.tsx` | `/` |
72
- | `pages/<path>.tsx` | `/<path>` |
73
- | `pages/index.tsx` | `/` |
74
- | `src/app/api/**` | Skip (API routes, not pages) |
75
- | `src/components/**` | Find which pages import this component |
76
- | `src/lib/**`, `src/utils/**` | Test `/` (shared code, test homepage) |
77
- | `public/**` | Test `/` (static assets) |
78
- | `styles/**`, `*.css` | Test all layout-level pages (`/`, plus any page using the stylesheet) |
79
- | `src/app/layout.tsx` | Test `/` and one subpage |
80
-
81
- ### Component-to-Page Resolution
82
-
83
- When a component file changes, find which pages use it:
84
-
85
- ```bash
86
- # For a changed component, find importing pages
87
- COMPONENT_NAME=$(basename "$CHANGED_FILE" .tsx)
88
- grep -rl "$COMPONENT_NAME" src/app/*/page.tsx pages/*.tsx 2>/dev/null
89
- ```
90
-
91
- ### Fallback
92
-
93
- If no routes can be derived (e.g., only config files changed), test the homepage (`/`).
94
-
95
- If `--all` flag is used, discover all routes:
96
-
97
- ```bash
98
- # Next.js App Router
99
- find src/app -name "page.tsx" -o -name "page.jsx" | sed 's|src/app||;s|/page\.[tj]sx||;s|^$|/|'
100
-
101
- # Next.js Pages Router
102
- find pages -name "*.tsx" -o -name "*.jsx" | grep -v "_app\|_document\|api/" | sed 's|pages||;s|\.[tj]sx||;s|/index$|/|'
103
- ```
104
-
105
- ## Step 3: Run Playwright QA
106
-
107
- ### Prerequisites
108
-
109
- Verify Playwright is available:
110
-
111
- ```bash
112
- npx playwright --version
113
- ```
114
-
115
- If not installed or browsers not downloaded:
116
-
117
- ```bash
118
- npm init -y 2>/dev/null # Only if no package.json
119
- npx playwright install chromium
120
- ```
121
-
122
- ### Dev Server Detection
123
-
124
- Check if a dev server is already running:
125
-
126
- ```bash
127
- # Check common ports
128
- curl -s -o /dev/null -w "%{http_code}" http://localhost:3000 2>/dev/null
129
- curl -s -o /dev/null -w "%{http_code}" http://localhost:5173 2>/dev/null
130
- curl -s -o /dev/null -w "%{http_code}" http://localhost:4321 2>/dev/null
131
- ```
132
-
133
- If no server is running, start one:
134
-
135
- ```bash
136
- # Detect and start the dev server
137
- if grep -q '"dev"' package.json; then
138
- npm run dev &
139
- DEV_PID=$!
140
- sleep 5 # Wait for server startup
141
- fi
142
- ```
143
-
144
- Record the base URL (e.g., `http://localhost:3000`).
145
-
146
- ### QA Script
147
-
148
- For each route, run this Playwright script:
149
-
150
- ```bash
151
- npx playwright test --config=- <<'PLAYWRIGHT_CONFIG'
152
- import { test, expect } from '@playwright/test';
153
-
154
- const BASE_URL = process.env.QA_BASE_URL || 'http://localhost:3000';
155
- const ROUTES = process.env.QA_ROUTES?.split(',') || ['/'];
156
- const SCREENSHOT_DIR = '.qa-screenshots';
157
-
158
- test.describe('Browser QA', () => {
159
- for (const route of ROUTES) {
160
- test(`QA: ${route}`, async ({ page }) => {
161
- const errors: string[] = [];
162
- const failedRequests: { url: string; status: number }[] = [];
163
-
164
- // Capture console errors
165
- page.on('console', msg => {
166
- if (msg.type() === 'error') {
167
- errors.push(`Console error: ${msg.text()}`);
168
- }
169
- });
170
-
171
- // Capture failed HTTP requests
172
- page.on('response', response => {
173
- if (response.status() >= 400) {
174
- failedRequests.push({ url: response.url(), status: response.status() });
175
- }
176
- });
177
-
178
- // Navigate
179
- await page.goto(`${BASE_URL}${route}`, { waitUntil: 'networkidle', timeout: 30000 });
180
-
181
- // Screenshot
182
- await page.screenshot({ path: `${SCREENSHOT_DIR}${route === '/' ? '/index' : route}.png`, fullPage: true });
183
-
184
- // Check for broken links
185
- const links = await page.$$eval('a[href]', anchors =>
186
- anchors.map(a => a.getAttribute('href')).filter(href => href && !href.startsWith('#') && !href.startsWith('mailto:') && !href.startsWith('tel:'))
187
- );
188
-
189
- for (const link of links.slice(0, 20)) { // Cap at 20 links per page
190
- if (link.startsWith('/') || link.startsWith(BASE_URL)) {
191
- const fullUrl = link.startsWith('/') ? `${BASE_URL}${link}` : link;
192
- const resp = await page.request.get(fullUrl);
193
- if (resp.status() >= 400) {
194
- failedRequests.push({ url: fullUrl, status: resp.status() });
195
- }
196
- }
197
- }
198
-
199
- // Report findings (test passes but logs findings)
200
- if (errors.length > 0 || failedRequests.length > 0) {
201
- console.log(JSON.stringify({ route, errors, failedRequests }));
202
- }
203
- });
204
- }
205
- });
206
- PLAYWRIGHT_CONFIG
207
- ```
208
-
209
- **Alternative approach (simpler, no config file needed):**
210
-
211
- Instead of the Playwright test runner, use a Node.js script with Playwright library directly:
212
-
213
- ```bash
214
- QA_BASE_URL="http://localhost:3000" QA_ROUTES="/" node -e "
215
- const { chromium } = require('playwright');
216
- (async () => {
217
- const browser = await chromium.launch();
218
- const baseUrl = process.env.QA_BASE_URL;
219
- const routes = process.env.QA_ROUTES.split(',');
220
- const findings = [];
221
-
222
- for (const route of routes) {
223
- const context = await browser.newContext();
224
- const page = await context.newPage();
225
- const errors = [];
226
- const failedRequests = [];
227
-
228
- page.on('console', msg => { if (msg.type() === 'error') errors.push(msg.text()); });
229
- page.on('response', resp => { if (resp.status() >= 400) failedRequests.push({ url: resp.url(), status: resp.status() }); });
230
-
231
- await page.goto(baseUrl + route, { waitUntil: 'networkidle', timeout: 30000 });
232
- await page.screenshot({ path: '.qa-screenshots' + (route === '/' ? '/index' : route) + '.png', fullPage: true });
233
-
234
- // Check internal links
235
- const links = await page.$$eval('a[href]', as => as.map(a => a.href).filter(h => h.startsWith(baseUrl) || h.startsWith('/')));
236
- for (const link of links.slice(0, 20)) {
237
- const url = link.startsWith('/') ? baseUrl + link : link;
238
- try { const r = await page.request.get(url); if (r.status() >= 400) failedRequests.push({ url, status: r.status() }); } catch(e) { failedRequests.push({ url, status: 0 }); }
239
- }
240
-
241
- if (errors.length || failedRequests.length) findings.push({ route, errors, failedRequests });
242
- await context.close();
243
- }
244
-
245
- console.log(JSON.stringify(findings, null, 2));
246
- await browser.close();
247
- })();
248
- "
249
- ```
250
-
251
- ### Screenshot Capture
252
-
253
- Every page navigated gets a full-page screenshot saved to `.qa-screenshots/`:
254
-
255
- - Route `/` -> `.qa-screenshots/index.png`
256
- - Route `/about` -> `.qa-screenshots/about.png`
257
- - Route `/dashboard/settings` -> `.qa-screenshots/dashboard/settings.png`
258
-
259
- Create the directory before running:
260
-
261
- ```bash
262
- mkdir -p .qa-screenshots
263
- ```
264
-
265
- When a finding is reported, reference the screenshot path in the report:
266
-
267
- > Finding: Console error "TypeError: Cannot read property 'map' of undefined" on /dashboard
268
- > Screenshot: `.qa-screenshots/dashboard.png`
269
-
270
- ## Step 4: Generate QA Report
271
-
272
- After all routes are tested, produce a structured report.
273
-
274
- ### Report Format
275
-
276
- ```markdown
277
- # QA Report -- {project-name}
278
- **Date:** {ISO timestamp}
279
- **Routes tested:** {N}
280
- **Findings:** {N} ({errors} console errors, {broken_links} broken links, {http_failures} HTTP failures)
281
- **Screenshots:** .qa-screenshots/
282
-
283
- ## Findings
284
-
285
- ### Finding 1: {type} on {route}
286
- - **Type:** console-error | broken-link | http-failure
287
- - **Route:** {route}
288
- - **Detail:** {error message or URL + status code}
289
- - **Screenshot:** .qa-screenshots/{route}.png
290
- - **False positive:** no (set to yes if confirmed false positive)
291
- - **Severity:** critical | warning | info
292
-
293
- ### Finding 2: ...
294
-
295
- ## Summary
296
-
297
- | Route | Status | Console Errors | Broken Links | HTTP Failures |
298
- |-------|--------|----------------|--------------|---------------|
299
- | / | PASS/FAIL | 0 | 0 | 0 |
300
-
301
- ## Routes Tested
302
- {list of routes with pass/fail status}
303
- ```
304
-
305
- ### Severity Classification
306
-
307
- - **critical:** Page fails to load, unhandled exceptions, 500 errors
308
- - **warning:** 404 broken links, non-critical console errors, slow responses (>3s)
309
- - **info:** Console warnings (not errors), deprecation notices
310
-
311
- ### Clean Run
312
-
313
- If zero findings:
314
-
315
- > QA PASSED: {N} routes tested, zero findings. Screenshots saved to .qa-screenshots/
316
-
317
- ## Step 5: Cleanup
318
-
319
- ```bash
320
- # Kill dev server if we started one
321
- [ -n "$DEV_PID" ] && kill $DEV_PID 2>/dev/null
322
-
323
- # Keep screenshots for evidence (don't delete)
324
- echo "Screenshots saved to .qa-screenshots/"
325
- ```
326
-
327
- Add `.qa-screenshots/` to `.gitignore` if not already present:
328
-
329
- ```bash
330
- grep -q ".qa-screenshots" .gitignore 2>/dev/null || echo ".qa-screenshots/" >> .gitignore
331
- ```
332
-
333
- ## Step 6: Bug Fix Workflow (BQA-03)
334
-
335
- When QA findings reveal real bugs, fix each one with an atomic commit and a regression test.
336
-
337
- ### Process Per Finding
338
-
339
- For each confirmed finding (not a false positive):
340
-
341
- #### 1. Create a regression test FIRST (Red)
342
-
343
- Write a test that reproduces the exact issue found:
344
-
345
- ```bash
346
- # Example: Console error on /dashboard
347
- cat > __tests__/qa-regression/dashboard-console-error.test.ts << 'EOF'
348
- import { test, expect } from '@playwright/test';
349
-
350
- test('dashboard should not have console errors', async ({ page }) => {
351
- const errors: string[] = [];
352
- page.on('console', msg => {
353
- if (msg.type() === 'error') errors.push(msg.text());
354
- });
355
-
356
- await page.goto('http://localhost:3000/dashboard');
357
- await page.waitForLoadState('networkidle');
358
-
359
- expect(errors).toHaveLength(0);
360
- });
361
- EOF
362
- ```
363
-
364
- ```bash
365
- # Example: Broken link on /about
366
- cat > __tests__/qa-regression/about-broken-links.test.ts << 'EOF'
367
- import { test, expect } from '@playwright/test';
368
-
369
- test('about page should have no broken internal links', async ({ page }) => {
370
- await page.goto('http://localhost:3000/about');
371
- const links = await page.$$eval('a[href^="/"]', as => as.map(a => a.getAttribute('href')));
372
-
373
- for (const link of links) {
374
- const response = await page.request.get(`http://localhost:3000${link}`);
375
- expect(response.status()).toBeLessThan(400);
376
- }
377
- });
378
- EOF
379
- ```
380
-
381
- #### 2. Fix the bug
382
-
383
- Apply the minimal fix. The fix should be scoped to the exact issue -- no drive-by refactoring.
384
-
385
- #### 3. Verify the test passes (Green)
386
-
387
- ```bash
388
- npx playwright test __tests__/qa-regression/ --reporter=list
389
- ```
390
-
391
- #### 4. Atomic commit
392
-
393
- Each bug fix gets its own commit:
394
-
395
- ```bash
396
- git add <fixed-files> __tests__/qa-regression/<test-file>
397
- git commit -m "fix(qa): resolve {finding-type} on {route}
398
-
399
- QA finding: {brief description}
400
- Regression test: __tests__/qa-regression/{test-file}
401
- "
402
- ```
403
-
404
- ### Naming Convention for Regression Tests
405
-
406
- ```
407
- __tests__/qa-regression/{route}-{finding-type}.test.ts
408
- ```
409
-
410
- Examples:
411
- - `__tests__/qa-regression/dashboard-console-error.test.ts`
412
- - `__tests__/qa-regression/about-broken-links.test.ts`
413
- - `__tests__/qa-regression/index-http-failure.test.ts`
414
-
415
- ### When NOT to Create Regression Tests
416
-
417
- - **False positives** -- skip entirely
418
- - **Third-party script errors** (e.g., analytics, chat widgets) -- suppress instead of fix
419
- - **Environment-only issues** (e.g., dev-only CORS) -- note in report, don't test
420
-
421
- ## Step 7: False Positive Tracking (BQA-06)
422
-
423
- Track the false positive rate across QA runs. If the cumulative rate exceeds 20%, surface a tuning warning.
424
-
425
- ### Recording Results
426
-
427
- After each QA run, append results to `.qa-history.json` in the project root:
428
-
429
- ```bash
430
- # Read existing history or create empty
431
- HISTORY_FILE=".qa-history.json"
432
- [ -f "$HISTORY_FILE" ] || echo '{"runs":[]}' > "$HISTORY_FILE"
433
-
434
- # Append this run's results
435
- node -e "
436
- const fs = require('fs');
437
- const history = JSON.parse(fs.readFileSync('$HISTORY_FILE', 'utf8'));
438
- history.runs.push({
439
- date: new Date().toISOString(),
440
- routes_tested: ${ROUTES_TESTED},
441
- total_findings: ${TOTAL_FINDINGS},
442
- false_positives: ${FALSE_POSITIVES},
443
- true_positives: ${TRUE_POSITIVES}
444
- });
445
- fs.writeFileSync('$HISTORY_FILE', JSON.stringify(history, null, 2));
446
- "
447
- ```
448
-
449
- ### Calculating the Rate
450
-
451
- After recording, calculate the cumulative false positive rate:
452
-
453
- ```bash
454
- node -e "
455
- const fs = require('fs');
456
- const history = JSON.parse(fs.readFileSync('.qa-history.json', 'utf8'));
457
- const totals = history.runs.reduce((acc, run) => ({
458
- findings: acc.findings + run.total_findings,
459
- fp: acc.fp + run.false_positives
460
- }), { findings: 0, fp: 0 });
461
-
462
- const rate = totals.findings > 0 ? (totals.fp / totals.findings * 100).toFixed(1) : 0;
463
- console.log('False positive rate: ' + rate + '% (' + totals.fp + '/' + totals.findings + ')');
464
-
465
- if (parseFloat(rate) > 20) {
466
- console.log('');
467
- console.log('WARNING: False positive rate exceeds 20%. QA detection rules need tuning.');
468
- console.log('Review common false positives:');
469
- console.log(' - Third-party script errors (add to suppression list)');
470
- console.log(' - Dev-only warnings (filter by environment)');
471
- console.log(' - Known flaky routes (add to .qa-suppress.json)');
472
- }
473
- "
474
- ```
475
-
476
- ### Tuning Warning Output
477
-
478
- When rate > 20%, append this to the QA report:
479
-
480
- ```markdown
481
- ## Tuning Warning
482
-
483
- False positive rate is {rate}% ({fp}/{total} findings across {N} runs).
484
- This exceeds the 20% threshold. Consider:
485
-
486
- 1. **Add suppressions** to `.qa-suppress.json` for known non-issues
487
- 2. **Filter third-party errors** -- console errors from external scripts (analytics, chat widgets) are not your bugs
488
- 3. **Exclude flaky routes** -- routes requiring auth or dynamic data may produce false 4xx errors
489
- 4. **Review detection rules** -- some console warnings are not actionable errors
490
- ```
491
-
492
- ### Suppression File
493
-
494
- Create `.qa-suppress.json` to exclude known false positives from future runs:
495
-
496
- ```json
497
- {
498
- "suppress_console_patterns": [
499
- ".*third-party-analytics.*",
500
- ".*Failed to load resource.*favicon\\.ico.*",
501
- ".*DevTools.*"
502
- ],
503
- "suppress_urls": [
504
- "/api/auth/callback"
505
- ],
506
- "suppress_routes": []
507
- }
508
- ```
509
-
510
- When running QA (Step 3), check suppressions before recording a finding:
511
-
512
- ```javascript
513
- // In the Playwright script, before recording a console error:
514
- const suppressions = JSON.parse(fs.readFileSync('.qa-suppress.json', 'utf8'));
515
- const isSuppressed = suppressions.suppress_console_patterns.some(p => new RegExp(p).test(errorText));
516
- if (!isSuppressed) {
517
- // Record finding
518
- }
519
- ```
520
-
521
- ### Marking False Positives
522
-
523
- In the QA report, each finding has a `False positive: no` field. After review:
524
-
525
- 1. Change to `False positive: yes` for confirmed false positives
526
- 2. Add the pattern to `.qa-suppress.json` to prevent recurrence
527
- 3. Update `.qa-history.json` with corrected counts
528
-
529
- ### History File in .gitignore
530
-
531
- ```bash
532
- grep -q ".qa-history.json" .gitignore 2>/dev/null || echo ".qa-history.json" >> .gitignore
533
- grep -q ".qa-suppress.json" .gitignore 2>/dev/null || echo "# Keep .qa-suppress.json IN git -- it's project config, not output" >> /dev/null
534
- ```
535
-
536
- Note: `.qa-suppress.json` SHOULD be committed (it's configuration). `.qa-history.json` should NOT be committed (it's local state).