cc-devflow 4.2.0 → 4.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (559) hide show
  1. package/.claude/skills/cc-act/CHANGELOG.md +64 -0
  2. package/.claude/skills/cc-act/PLAYBOOK.md +212 -0
  3. package/.claude/skills/cc-act/SKILL.md +322 -0
  4. package/.claude/skills/cc-act/assets/PR_BRIEF_TEMPLATE.md +64 -0
  5. package/.claude/skills/cc-act/assets/RELEASE_NOTE_TEMPLATE.md +25 -0
  6. package/.claude/skills/cc-act/references/closure-contract.md +49 -0
  7. package/.claude/skills/cc-act/references/git-commit-guidelines.md +83 -0
  8. package/.claude/skills/cc-act/scripts/archive-requirement.sh +49 -0
  9. package/.claude/skills/cc-act/scripts/cc-act-common.sh +240 -0
  10. package/.claude/skills/cc-act/scripts/detect-ship-target.sh +82 -0
  11. package/.claude/skills/cc-act/scripts/generate-status-report.sh +83 -0
  12. package/.claude/skills/cc-act/scripts/render-pr-brief.sh +195 -0
  13. package/.claude/skills/cc-act/scripts/sync-act-docs.sh +315 -0
  14. package/.claude/skills/cc-act/scripts/verify-act-gate.sh +63 -0
  15. package/.claude/skills/cc-check/CHANGELOG.md +73 -0
  16. package/.claude/skills/cc-check/PLAYBOOK.md +153 -0
  17. package/.claude/skills/cc-check/SKILL.md +345 -0
  18. package/.claude/skills/cc-check/assets/REPORT_CARD_TEMPLATE.json +50 -0
  19. package/.claude/skills/cc-check/references/gate-contract.md +29 -0
  20. package/.claude/skills/cc-check/references/review-contract.md +45 -0
  21. package/.claude/skills/cc-check/scripts/render-report-card.js +229 -0
  22. package/.claude/skills/cc-check/scripts/run-quality-gates.sh +86 -0
  23. package/.claude/skills/cc-check/scripts/verify-gate.sh +57 -0
  24. package/.claude/skills/cc-do/CHANGELOG.md +49 -0
  25. package/.claude/skills/cc-do/PLAYBOOK.md +119 -0
  26. package/.claude/skills/cc-do/SKILL.md +216 -0
  27. package/.claude/skills/cc-do/references/execution-recovery.md +86 -0
  28. package/.claude/skills/cc-do/references/parallel-dispatch.md +80 -0
  29. package/.claude/skills/cc-do/scripts/build-task-context.sh +184 -0
  30. package/.claude/skills/cc-do/scripts/cc-do-common.sh +79 -0
  31. package/.claude/skills/cc-do/scripts/check-task-status.sh +92 -0
  32. package/.claude/skills/cc-do/scripts/detect-file-conflicts.sh +87 -0
  33. package/.claude/skills/cc-do/scripts/mark-task-complete.sh +119 -0
  34. package/.claude/skills/cc-do/scripts/record-review-decision.sh +89 -0
  35. package/.claude/skills/cc-do/scripts/recover-workflow.sh +84 -0
  36. package/.claude/skills/cc-do/scripts/run-problem-analysis.sh +70 -0
  37. package/.claude/skills/cc-do/scripts/select-ready-tasks.sh +135 -0
  38. package/.claude/skills/cc-do/scripts/verify-task-gates.sh +94 -0
  39. package/.claude/skills/cc-do/scripts/write-task-checkpoint.sh +102 -0
  40. package/.claude/skills/cc-investigate/CHANGELOG.md +26 -0
  41. package/.claude/skills/cc-investigate/PLAYBOOK.md +49 -0
  42. package/.claude/skills/cc-investigate/SKILL.md +221 -0
  43. package/.claude/skills/cc-investigate/assets/ANALYSIS_TEMPLATE.md +55 -0
  44. package/.claude/skills/cc-investigate/assets/TASKS_TEMPLATE.md +52 -0
  45. package/.claude/skills/cc-investigate/assets/TASK_MANIFEST_TEMPLATE.json +103 -0
  46. package/.claude/skills/cc-investigate/references/investigation-contract.md +28 -0
  47. package/.claude/skills/cc-investigate/scripts/bootstrap-analysis.sh +38 -0
  48. package/.claude/skills/cc-plan/CHANGELOG.md +99 -0
  49. package/.claude/skills/cc-plan/PLAYBOOK.md +106 -0
  50. package/.claude/skills/cc-plan/SKILL.md +325 -0
  51. package/.claude/skills/cc-plan/assets/DESIGN_TEMPLATE.md +155 -0
  52. package/.claude/skills/cc-plan/assets/TASKS_TEMPLATE.md +98 -0
  53. package/.claude/skills/cc-plan/assets/TASK_MANIFEST_TEMPLATE.json +108 -0
  54. package/.claude/skills/cc-plan/assets/TINY_DESIGN_TEMPLATE.md +79 -0
  55. package/.claude/skills/cc-plan/references/planning-contract.md +82 -0
  56. package/.claude/skills/cc-plan/scripts/bump-skill-version.sh +103 -0
  57. package/.claude/skills/cc-plan/scripts/parse-task-dependencies.js +75 -0
  58. package/.claude/skills/cc-plan/scripts/validate-scope.sh +78 -0
  59. package/.claude/skills/cc-roadmap/CHANGELOG.md +114 -0
  60. package/.claude/skills/cc-roadmap/PLAYBOOK.md +136 -0
  61. package/.claude/skills/cc-roadmap/SKILL.md +259 -0
  62. package/.claude/skills/cc-roadmap/assets/BACKLOG_TEMPLATE.md +45 -0
  63. package/.claude/skills/cc-roadmap/assets/ROADMAP_TEMPLATE.md +153 -0
  64. package/.claude/skills/cc-roadmap/assets/TRACKING_TEMPLATE.json +48 -0
  65. package/.claude/skills/cc-roadmap/references/roadmap-dialogue.md +37 -0
  66. package/.claude/skills/cc-roadmap/scripts/bump-skill-version.sh +103 -0
  67. package/.claude/skills/cc-roadmap/scripts/lib/roadmap-tracking/markdown.js +604 -0
  68. package/.claude/skills/cc-roadmap/scripts/lib/roadmap-tracking/query.js +63 -0
  69. package/.claude/skills/cc-roadmap/scripts/lib/roadmap-tracking/schema.js +245 -0
  70. package/.claude/skills/cc-roadmap/scripts/lib/roadmap-tracking/store.js +139 -0
  71. package/.claude/skills/cc-roadmap/scripts/locate-roadmap-item.sh +109 -0
  72. package/.claude/skills/cc-roadmap/scripts/roadmap-tracking.js +153 -0
  73. package/.claude/skills/cc-roadmap/scripts/sync-roadmap-progress.sh +100 -0
  74. package/.claude/skills/cc-simplify/CHANGELOG.md +10 -0
  75. package/.claude/skills/cc-simplify/SKILL.md +55 -0
  76. package/.claude/skills/cc-spec-init/CHANGELOG.md +7 -0
  77. package/.claude/skills/cc-spec-init/PLAYBOOK.md +55 -0
  78. package/.claude/skills/cc-spec-init/SKILL.md +127 -0
  79. package/.claude/skills/cc-spec-init/assets/CAPABILITY_TEMPLATE.md +63 -0
  80. package/.claude/skills/cc-spec-init/assets/CHANGE_META_TEMPLATE.json +25 -0
  81. package/.claude/skills/cc-spec-init/assets/INDEX_TEMPLATE.md +34 -0
  82. package/.claude/skills/cc-spec-init/references/spec-contract.md +22 -0
  83. package/.claude/skills/cc-spec-init/scripts/bootstrap-specs.sh +31 -0
  84. package/.claude/skills/cc-spec-init/scripts/validate-spec-links.sh +45 -0
  85. package/CHANGELOG.md +101 -4
  86. package/README.md +120 -755
  87. package/README.zh-CN.md +119 -755
  88. package/bin/adapt.js +2 -6
  89. package/bin/cc-devflow-cli.js +72 -177
  90. package/config/distributable-skills.json +24 -0
  91. package/docs/CLAUDE.md +10 -6
  92. package/docs/commands/README.md +19 -46
  93. package/docs/commands/README.zh-CN.md +25 -48
  94. package/docs/examples/BY-ARTIFACT.md +7 -0
  95. package/docs/examples/README.md +38 -0
  96. package/docs/examples/START-HERE.md +149 -0
  97. package/docs/examples/example-bindings.json +38 -0
  98. package/docs/examples/full-design-blocked/BACKLOG.md +45 -0
  99. package/docs/examples/full-design-blocked/README.md +55 -0
  100. package/docs/examples/full-design-blocked/ROADMAP.md +53 -0
  101. package/docs/examples/full-design-blocked/changes/REQ-002-bulk-invite-import/planning/design.md +154 -0
  102. package/docs/examples/full-design-blocked/changes/REQ-002-bulk-invite-import/planning/task-manifest.json +146 -0
  103. package/docs/examples/full-design-blocked/changes/REQ-002-bulk-invite-import/planning/tasks.md +78 -0
  104. package/docs/examples/full-design-blocked/changes/REQ-002-bulk-invite-import/review/report-card.json +52 -0
  105. package/docs/examples/full-design-blocked/roadmap-tracking.json +50 -0
  106. package/docs/examples/local-handoff/BACKLOG.md +45 -0
  107. package/docs/examples/local-handoff/README.md +56 -0
  108. package/docs/examples/local-handoff/ROADMAP.md +45 -0
  109. package/docs/examples/local-handoff/changes/REQ-003-audit-log-export/handoff/resume-index.md +39 -0
  110. package/docs/examples/local-handoff/changes/REQ-003-audit-log-export/handoff/status.md +29 -0
  111. package/docs/examples/local-handoff/changes/REQ-003-audit-log-export/planning/design.md +71 -0
  112. package/docs/examples/local-handoff/changes/REQ-003-audit-log-export/planning/task-manifest.json +98 -0
  113. package/docs/examples/local-handoff/changes/REQ-003-audit-log-export/planning/tasks.md +59 -0
  114. package/docs/examples/local-handoff/changes/REQ-003-audit-log-export/review/report-card.json +44 -0
  115. package/docs/examples/local-handoff/roadmap-tracking.json +48 -0
  116. package/docs/examples/pdca-loop/BACKLOG.md +46 -0
  117. package/docs/examples/pdca-loop/README.md +58 -0
  118. package/docs/examples/pdca-loop/ROADMAP.md +133 -0
  119. package/docs/examples/pdca-loop/changes/REQ-001-copy-invite-link/handoff/pr-brief.md +72 -0
  120. package/docs/examples/pdca-loop/changes/REQ-001-copy-invite-link/handoff/status.md +29 -0
  121. package/docs/examples/pdca-loop/changes/REQ-001-copy-invite-link/planning/design.md +72 -0
  122. package/docs/examples/pdca-loop/changes/REQ-001-copy-invite-link/planning/task-manifest.json +201 -0
  123. package/docs/examples/pdca-loop/changes/REQ-001-copy-invite-link/planning/tasks.md +73 -0
  124. package/docs/examples/pdca-loop/changes/REQ-001-copy-invite-link/review/report-card.json +44 -0
  125. package/docs/examples/pdca-loop/roadmap-tracking.json +114 -0
  126. package/docs/examples/scripts/check-example-bindings.sh +116 -0
  127. package/docs/guides/getting-started.md +94 -129
  128. package/docs/guides/getting-started.zh-CN.md +103 -84
  129. package/docs/skill-runtime-migration.md +46 -0
  130. package/docs/v4.3.0-migration-guide.md +111 -0
  131. package/lib/compiler/CLAUDE.md +55 -84
  132. package/lib/compiler/__tests__/drift.test.js +1 -1
  133. package/lib/compiler/__tests__/errors.test.js +0 -1
  134. package/lib/compiler/__tests__/integration.test.js +49 -3
  135. package/lib/compiler/__tests__/manifest.test.js +0 -156
  136. package/lib/compiler/__tests__/parser.test.js +33 -104
  137. package/lib/compiler/__tests__/schemas.test.js +30 -34
  138. package/lib/compiler/__tests__/skills-registry.test.js +114 -0
  139. package/lib/compiler/__tests__/transformer.test.js +5 -9
  140. package/lib/compiler/emitters/antigravity-emitter.js +5 -213
  141. package/lib/compiler/emitters/base-emitter.js +3 -298
  142. package/lib/compiler/emitters/codex-emitter.js +4 -202
  143. package/lib/compiler/emitters/cursor-emitter.js +3 -287
  144. package/lib/compiler/emitters/qwen-emitter.js +4 -176
  145. package/lib/compiler/index.js +65 -345
  146. package/lib/compiler/manifest.js +6 -68
  147. package/lib/compiler/parser.js +31 -63
  148. package/lib/compiler/platforms.js +32 -277
  149. package/lib/compiler/resource-copier.js +176 -6
  150. package/lib/compiler/rules-emitters/__tests__/antigravity-rules-emitter.test.js +3 -3
  151. package/lib/compiler/rules-emitters/__tests__/cursor-rules-emitter.test.js +14 -4
  152. package/lib/compiler/rules-emitters/__tests__/qwen-rules-emitter.test.js +16 -7
  153. package/lib/compiler/rules-emitters/antigravity-rules-emitter.js +10 -15
  154. package/lib/compiler/rules-emitters/base-rules-emitter.js +5 -5
  155. package/lib/compiler/rules-emitters/cursor-rules-emitter.js +7 -12
  156. package/lib/compiler/rules-emitters/index.js +6 -3
  157. package/lib/compiler/rules-emitters/qwen-rules-emitter.js +7 -7
  158. package/lib/compiler/schemas.js +8 -4
  159. package/lib/compiler/skills-registry.js +213 -15
  160. package/lib/compiler/transformer.js +1 -1
  161. package/lib/skill-runtime/CLAUDE.md +19 -0
  162. package/lib/skill-runtime/__tests__/autopilot.test.js +210 -0
  163. package/lib/skill-runtime/__tests__/cli-bootstrap.integration.test.js +181 -0
  164. package/lib/skill-runtime/__tests__/delegation.test.js +97 -0
  165. package/lib/skill-runtime/__tests__/dispatch.test.js +267 -0
  166. package/lib/skill-runtime/__tests__/intent.test.js +219 -0
  167. package/lib/skill-runtime/__tests__/lifecycle.test.js +169 -0
  168. package/lib/skill-runtime/__tests__/paths.test.js +42 -0
  169. package/lib/skill-runtime/__tests__/planner.tdd.test.js +250 -0
  170. package/lib/skill-runtime/__tests__/prepare-pr.test.js +139 -0
  171. package/lib/skill-runtime/__tests__/query.test.js +284 -0
  172. package/lib/skill-runtime/__tests__/runtime.integration.test.js +279 -0
  173. package/lib/skill-runtime/__tests__/schemas.test.js +207 -0
  174. package/lib/skill-runtime/__tests__/team-state.test.js +51 -0
  175. package/lib/skill-runtime/__tests__/worker-run.test.js +253 -0
  176. package/lib/skill-runtime/__tests__/worker.test.js +56 -0
  177. package/lib/skill-runtime/artifacts.js +93 -0
  178. package/lib/skill-runtime/delegation.js +533 -0
  179. package/lib/skill-runtime/index.js +34 -0
  180. package/lib/skill-runtime/intent.js +333 -0
  181. package/lib/skill-runtime/lifecycle.js +294 -0
  182. package/lib/skill-runtime/operations/CLAUDE.md +19 -0
  183. package/lib/skill-runtime/operations/approve.js +66 -0
  184. package/lib/skill-runtime/operations/autopilot-core.js +337 -0
  185. package/lib/skill-runtime/operations/autopilot-execution.js +307 -0
  186. package/lib/skill-runtime/operations/autopilot-shared.js +48 -0
  187. package/lib/skill-runtime/operations/autopilot.js +163 -0
  188. package/lib/skill-runtime/operations/dispatch.js +454 -0
  189. package/lib/skill-runtime/operations/init.js +64 -0
  190. package/lib/{harness → skill-runtime}/operations/janitor.js +9 -6
  191. package/lib/skill-runtime/operations/plan.js +59 -0
  192. package/lib/skill-runtime/operations/prepare-pr.js +25 -0
  193. package/lib/{harness → skill-runtime}/operations/release.js +18 -5
  194. package/lib/skill-runtime/operations/resume.js +143 -0
  195. package/lib/skill-runtime/operations/snapshot.js +45 -0
  196. package/lib/skill-runtime/operations/verify.js +170 -0
  197. package/lib/skill-runtime/operations/worker-run.js +529 -0
  198. package/lib/skill-runtime/operations/worker.js +33 -0
  199. package/lib/skill-runtime/paths.js +213 -0
  200. package/lib/skill-runtime/planner.js +519 -0
  201. package/lib/skill-runtime/query.js +157 -0
  202. package/lib/skill-runtime/review.js +557 -0
  203. package/lib/skill-runtime/schemas.js +400 -0
  204. package/lib/{harness → skill-runtime}/store.js +45 -30
  205. package/lib/skill-runtime/team-state.js +122 -0
  206. package/package.json +13 -11
  207. package/.claude/CLAUDE.md +0 -125
  208. package/.claude/agents/architecture-designer.md +0 -443
  209. package/.claude/agents/bug-analyzer.md +0 -381
  210. package/.claude/agents/checklist-agent.md +0 -175
  211. package/.claude/agents/clarify-analyst.md +0 -50
  212. package/.claude/agents/code-quality-reviewer.md +0 -205
  213. package/.claude/agents/code-reviewer.md +0 -71
  214. package/.claude/agents/codex-analyzer.md +0 -39
  215. package/.claude/agents/compatibility-checker.md +0 -579
  216. package/.claude/agents/consistency-checker.md +0 -532
  217. package/.claude/agents/dev-implementer.md +0 -195
  218. package/.claude/agents/flow-researcher.md +0 -132
  219. package/.claude/agents/impact-analyzer.md +0 -440
  220. package/.claude/agents/planner.md +0 -230
  221. package/.claude/agents/prd-writer.md +0 -320
  222. package/.claude/agents/project-guidelines-generator.md +0 -1329
  223. package/.claude/agents/qa-tester.md +0 -313
  224. package/.claude/agents/release-manager.md +0 -295
  225. package/.claude/agents/security-reviewer.md +0 -314
  226. package/.claude/agents/spec-reviewer.md +0 -221
  227. package/.claude/agents/style-guide-generator.md +0 -458
  228. package/.claude/agents/tech-architect.md +0 -516
  229. package/.claude/agents/ui-designer.md +0 -485
  230. package/.claude/commands/core/architecture.md +0 -459
  231. package/.claude/commands/core/guidelines.md +0 -511
  232. package/.claude/commands/core/roadmap.md +0 -468
  233. package/.claude/commands/core/style.md +0 -83
  234. package/.claude/commands/flow/CLAUDE.md +0 -28
  235. package/.claude/commands/flow/archive.md +0 -280
  236. package/.claude/commands/flow/checklist.md +0 -18
  237. package/.claude/commands/flow/clarify.md +0 -18
  238. package/.claude/commands/flow/constitution.md +0 -82
  239. package/.claude/commands/flow/context.md +0 -150
  240. package/.claude/commands/flow/delta.md +0 -245
  241. package/.claude/commands/flow/dev.md +0 -40
  242. package/.claude/commands/flow/fix.md +0 -217
  243. package/.claude/commands/flow/ideate.md +0 -214
  244. package/.claude/commands/flow/init.md +0 -38
  245. package/.claude/commands/flow/new.md +0 -23
  246. package/.claude/commands/flow/quality.md +0 -21
  247. package/.claude/commands/flow/release.md +0 -36
  248. package/.claude/commands/flow/restart.md +0 -97
  249. package/.claude/commands/flow/spec.md +0 -36
  250. package/.claude/commands/flow/status.md +0 -64
  251. package/.claude/commands/flow/update.md +0 -111
  252. package/.claude/commands/flow/upgrade.md +0 -115
  253. package/.claude/commands/flow/verify.md +0 -37
  254. package/.claude/commands/flow/workspace.md +0 -155
  255. package/.claude/commands/util/cancel-ralph.md +0 -60
  256. package/.claude/commands/util/code-review.md +0 -58
  257. package/.claude/commands/util/git-commit.md +0 -422
  258. package/.claude/commands/util/problem-analyzer.md +0 -60
  259. package/.claude/config/quality-gates.yml +0 -305
  260. package/.claude/config/quality-rules.yml +0 -161
  261. package/.claude/docs/SPEC_KIT_CONSTITUTION_ANALYSIS.md +0 -426
  262. package/.claude/docs/design/consistency-conflict-detection-algorithms.md +0 -658
  263. package/.claude/docs/design/intent-driven-input-design.md +0 -380
  264. package/.claude/docs/design/prd-version-management-design.md +0 -437
  265. package/.claude/docs/guides/INIT_TROUBLESHOOTING.md +0 -117
  266. package/.claude/docs/guides/NEW_TROUBLESHOOTING.md +0 -99
  267. package/.claude/docs/guides/ROADMAP_TROUBLESHOOTING.md +0 -188
  268. package/.claude/docs/guides/TASK_COMPLETION_MARKING.md +0 -338
  269. package/.claude/docs/guides/TEAM_MODE_GUIDE.md +0 -312
  270. package/.claude/docs/templates/ARCHITECTURE_TEMPLATE.md +0 -633
  271. package/.claude/docs/templates/ATTEMPT_TEMPLATE.md +0 -156
  272. package/.claude/docs/templates/BACKLOG_TEMPLATE.md +0 -261
  273. package/.claude/docs/templates/BRAINSTORM_TEMPLATE.md +0 -148
  274. package/.claude/docs/templates/CHECKLIST_TEMPLATE.md +0 -52
  275. package/.claude/docs/templates/CLARIFICATION_REPORT_TEMPLATE.md +0 -206
  276. package/.claude/docs/templates/CODE_REVIEW_TEMPLATE.md +0 -71
  277. package/.claude/docs/templates/DELTA_SPEC_TEMPLATE.md +0 -91
  278. package/.claude/docs/templates/DESIGN_DECISIONS_TEMPLATE.md +0 -151
  279. package/.claude/docs/templates/EPIC_TEMPLATE.md +0 -805
  280. package/.claude/docs/templates/ERROR_LOG_TEMPLATE.md +0 -80
  281. package/.claude/docs/templates/INIT_FLOW_TEMPLATE.md +0 -198
  282. package/.claude/docs/templates/INTENT_CLARIFICATION_TEMPLATE.md +0 -57
  283. package/.claude/docs/templates/JOURNAL_TEMPLATE.md +0 -75
  284. package/.claude/docs/templates/NEW_ORCHESTRATION_TEMPLATE.md +0 -76
  285. package/.claude/docs/templates/PRD_TEMPLATE.md +0 -562
  286. package/.claude/docs/templates/RESEARCH_TEMPLATE.md +0 -276
  287. package/.claude/docs/templates/REVIEW-HIGH.md +0 -57
  288. package/.claude/docs/templates/ROADMAP_DIALOGUE_TEMPLATE.md +0 -198
  289. package/.claude/docs/templates/ROADMAP_TEMPLATE.md +0 -310
  290. package/.claude/docs/templates/STYLE_TEMPLATE.md +0 -1266
  291. package/.claude/docs/templates/TASKS_TEMPLATE.md +0 -523
  292. package/.claude/docs/templates/TECH_DESIGN_TEMPLATE.md +0 -1019
  293. package/.claude/docs/templates/UI_PROTOTYPE_TEMPLATE.md +0 -1435
  294. package/.claude/docs/templates/_shared/CLAUDE.md +0 -36
  295. package/.claude/docs/templates/_shared/CONSTITUTION_CHECK.md +0 -125
  296. package/.claude/docs/templates/_shared/VALIDATION_CHECKLIST.md +0 -187
  297. package/.claude/docs/templates/_shared/YAML_FRONTMATTER.md +0 -164
  298. package/.claude/docs/templates/context/dev.jsonl.template +0 -6
  299. package/.claude/docs/templates/context/epic.jsonl.template +0 -5
  300. package/.claude/docs/templates/context/prd.jsonl.template +0 -4
  301. package/.claude/docs/templates/context/research.jsonl.template +0 -4
  302. package/.claude/docs/templates/context/review.jsonl.template +0 -5
  303. package/.claude/docs/templates/context/tech.jsonl.template +0 -5
  304. package/.claude/guides/agent-guides/agent-coordination-guide.md +0 -459
  305. package/.claude/guides/project-guidelines-system.md +0 -463
  306. package/.claude/guides/technical-guides/datetime-handling-guide.md +0 -563
  307. package/.claude/guides/technical-guides/git-github-guide.md +0 -642
  308. package/.claude/guides/technical-guides/test-execution-guide.md +0 -618
  309. package/.claude/guides/workflow-guides/bug-fix-orchestrator.md +0 -217
  310. package/.claude/guides/workflow-guides/flow-orchestrator.md +0 -48
  311. package/.claude/hooks/CLAUDE.md +0 -342
  312. package/.claude/hooks/checklist-gate.js +0 -397
  313. package/.claude/hooks/error-handling-reminder.sh +0 -12
  314. package/.claude/hooks/error-handling-reminder.ts +0 -459
  315. package/.claude/hooks/hooks.json +0 -15
  316. package/.claude/hooks/inject-agent-context.ts +0 -480
  317. package/.claude/hooks/inject-skill-context.ts +0 -359
  318. package/.claude/hooks/post-tool-use-tracker.sh +0 -280
  319. package/.claude/hooks/pre-tool-use-guardrail.sh +0 -36
  320. package/.claude/hooks/pre-tool-use-guardrail.ts +0 -342
  321. package/.claude/hooks/ralph-loop.ts +0 -931
  322. package/.claude/hooks/ralph-stop-hook.sh +0 -190
  323. package/.claude/hooks/skill-activation-prompt.sh +0 -36
  324. package/.claude/hooks/skill-activation-prompt.ts +0 -214
  325. package/.claude/hooks/state/skills-used-test-guard.json +0 -3
  326. package/.claude/hooks/task-completed-hook.ts +0 -593
  327. package/.claude/hooks/teammate-idle-hook.ts +0 -690
  328. package/.claude/hooks/types/team-types.d.ts +0 -238
  329. package/.claude/rules/devflow-conventions.md +0 -286
  330. package/.claude/rules/project-constitution.md +0 -1002
  331. package/.claude/rules/rationalization-library.md +0 -282
  332. package/.claude/schemas/constitution.schema.json +0 -43
  333. package/.claude/scripts/CLAUDE.md +0 -76
  334. package/.claude/scripts/analyze-upgrade-impact.sh +0 -200
  335. package/.claude/scripts/archive-requirement.sh +0 -394
  336. package/.claude/scripts/calculate-checklist-completion.sh +0 -243
  337. package/.claude/scripts/calculate-quarter.sh +0 -206
  338. package/.claude/scripts/check-dependencies.sh +0 -409
  339. package/.claude/scripts/check-prerequisites.sh +0 -232
  340. package/.claude/scripts/check-task-status.sh +0 -288
  341. package/.claude/scripts/checklist-errors.sh +0 -131
  342. package/.claude/scripts/common.sh +0 -1102
  343. package/.claude/scripts/consolidate-research.sh +0 -182
  344. package/.claude/scripts/create-requirement.sh +0 -451
  345. package/.claude/scripts/delta-parser.ts +0 -527
  346. package/.claude/scripts/detect-file-conflicts.sh +0 -151
  347. package/.claude/scripts/export-contracts.sh +0 -117
  348. package/.claude/scripts/extract-data-model.sh +0 -78
  349. package/.claude/scripts/flow-context-add.sh +0 -134
  350. package/.claude/scripts/flow-context-init.sh +0 -133
  351. package/.claude/scripts/flow-context-validate.sh +0 -144
  352. package/.claude/scripts/flow-delta-apply.sh +0 -297
  353. package/.claude/scripts/flow-delta-archive.sh +0 -71
  354. package/.claude/scripts/flow-delta-create.sh +0 -202
  355. package/.claude/scripts/flow-delta-list.sh +0 -142
  356. package/.claude/scripts/flow-delta-status.sh +0 -235
  357. package/.claude/scripts/flow-quality-full.sh +0 -215
  358. package/.claude/scripts/flow-quality-quick.sh +0 -119
  359. package/.claude/scripts/flow-workspace-init.sh +0 -117
  360. package/.claude/scripts/flow-workspace-record.sh +0 -164
  361. package/.claude/scripts/generate-clarification-questions.sh +0 -377
  362. package/.claude/scripts/generate-clarification-report.sh +0 -463
  363. package/.claude/scripts/generate-quickstart.sh +0 -146
  364. package/.claude/scripts/generate-research-tasks.sh +0 -157
  365. package/.claude/scripts/generate-status-report.sh +0 -523
  366. package/.claude/scripts/generate-tech-analysis.sh +0 -46
  367. package/.claude/scripts/get-workflow-status.sh +0 -415
  368. package/.claude/scripts/locate-requirement-in-roadmap.sh +0 -233
  369. package/.claude/scripts/manage-constitution.sh +0 -602
  370. package/.claude/scripts/mark-task-complete.sh +0 -198
  371. package/.claude/scripts/parse-task-dependencies.js +0 -334
  372. package/.claude/scripts/populate-research-tasks.sh +0 -284
  373. package/.claude/scripts/record-quality-error.sh +0 -165
  374. package/.claude/scripts/recover-workflow.sh +0 -463
  375. package/.claude/scripts/run-clarify-scan.sh +0 -601
  376. package/.claude/scripts/run-high-review.sh +0 -62
  377. package/.claude/scripts/run-problem-analysis.sh +0 -68
  378. package/.claude/scripts/run-quality-gates.sh +0 -242
  379. package/.claude/scripts/setup-epic.sh +0 -173
  380. package/.claude/scripts/setup-ralph-loop.sh +0 -155
  381. package/.claude/scripts/sync-roadmap-progress.sh +0 -300
  382. package/.claude/scripts/sync-task-marks.sh +0 -199
  383. package/.claude/scripts/team-dev-init.sh +0 -319
  384. package/.claude/scripts/team-state-recovery.sh +0 -229
  385. package/.claude/scripts/test-clarify-scan.sh +0 -515
  386. package/.claude/scripts/update-agent-context.sh +0 -806
  387. package/.claude/scripts/validate-constitution.sh +0 -567
  388. package/.claude/scripts/validate-hooks.sh +0 -487
  389. package/.claude/scripts/validate-research.sh +0 -332
  390. package/.claude/scripts/validate-scope-boundary.sh +0 -493
  391. package/.claude/scripts/verify-gate.sh +0 -269
  392. package/.claude/scripts/verify-setup.sh +0 -37
  393. package/.claude/scripts/workflow-status.ts +0 -433
  394. package/.claude/settings.json +0 -95
  395. package/.claude/skills/_reference-implementations/README.md +0 -96
  396. package/.claude/skills/_reference-implementations/backend-express-prisma/SKILL.md +0 -302
  397. package/.claude/skills/_reference-implementations/backend-express-prisma/resources/architecture-overview.md +0 -451
  398. package/.claude/skills/_reference-implementations/backend-express-prisma/resources/async-and-errors.md +0 -307
  399. package/.claude/skills/_reference-implementations/backend-express-prisma/resources/complete-examples.md +0 -638
  400. package/.claude/skills/_reference-implementations/backend-express-prisma/resources/configuration.md +0 -275
  401. package/.claude/skills/_reference-implementations/backend-express-prisma/resources/database-patterns.md +0 -224
  402. package/.claude/skills/_reference-implementations/backend-express-prisma/resources/middleware-guide.md +0 -213
  403. package/.claude/skills/_reference-implementations/backend-express-prisma/resources/routing-and-controllers.md +0 -756
  404. package/.claude/skills/_reference-implementations/backend-express-prisma/resources/sentry-and-monitoring.md +0 -336
  405. package/.claude/skills/_reference-implementations/backend-express-prisma/resources/services-and-repositories.md +0 -789
  406. package/.claude/skills/_reference-implementations/backend-express-prisma/resources/testing-guide.md +0 -235
  407. package/.claude/skills/_reference-implementations/backend-express-prisma/resources/validation-patterns.md +0 -754
  408. package/.claude/skills/_reference-implementations/frontend-react-mui/SKILL.md +0 -399
  409. package/.claude/skills/_reference-implementations/frontend-react-mui/resources/common-patterns.md +0 -331
  410. package/.claude/skills/_reference-implementations/frontend-react-mui/resources/complete-examples.md +0 -872
  411. package/.claude/skills/_reference-implementations/frontend-react-mui/resources/component-patterns.md +0 -502
  412. package/.claude/skills/_reference-implementations/frontend-react-mui/resources/data-fetching.md +0 -767
  413. package/.claude/skills/_reference-implementations/frontend-react-mui/resources/file-organization.md +0 -502
  414. package/.claude/skills/_reference-implementations/frontend-react-mui/resources/loading-and-error-states.md +0 -501
  415. package/.claude/skills/_reference-implementations/frontend-react-mui/resources/performance.md +0 -406
  416. package/.claude/skills/_reference-implementations/frontend-react-mui/resources/routing-guide.md +0 -364
  417. package/.claude/skills/_reference-implementations/frontend-react-mui/resources/styling-guide.md +0 -428
  418. package/.claude/skills/_reference-implementations/frontend-react-mui/resources/typescript-standards.md +0 -418
  419. package/.claude/skills/cc-devflow-orchestrator/SKILL.md +0 -169
  420. package/.claude/skills/domain/attention-refresh/SKILL.md +0 -170
  421. package/.claude/skills/domain/brainstorming/SKILL.md +0 -161
  422. package/.claude/skills/domain/debugging/SKILL.md +0 -221
  423. package/.claude/skills/domain/finishing-branch/SKILL.md +0 -189
  424. package/.claude/skills/domain/receiving-review/SKILL.md +0 -153
  425. package/.claude/skills/domain/tdd/SKILL.md +0 -218
  426. package/.claude/skills/domain/verification/SKILL.md +0 -158
  427. package/.claude/skills/guardrail/constitution-guardian/SKILL.md +0 -306
  428. package/.claude/skills/guardrail/tdd-enforcer/SKILL.md +0 -192
  429. package/.claude/skills/skill-rules.json +0 -359
  430. package/.claude/skills/utility/constitution-quick-ref/SKILL.md +0 -374
  431. package/.claude/skills/utility/file-standards/SKILL.md +0 -353
  432. package/.claude/skills/utility/fractal-docs/SKILL.md +0 -45
  433. package/.claude/skills/utility/journey-checker/SKILL.md +0 -199
  434. package/.claude/skills/utility/journey-checker/pressure-scenarios.md +0 -164
  435. package/.claude/skills/utility/npm-release/SKILL.md +0 -314
  436. package/.claude/skills/utility/skill-creator/LICENSE.txt +0 -202
  437. package/.claude/skills/utility/skill-creator/SKILL.md +0 -356
  438. package/.claude/skills/utility/skill-creator/references/output-patterns.md +0 -82
  439. package/.claude/skills/utility/skill-creator/references/workflows.md +0 -28
  440. package/.claude/skills/utility/skill-creator/scripts/init_skill.py +0 -303
  441. package/.claude/skills/utility/skill-creator/scripts/package_skill.py +0 -110
  442. package/.claude/skills/utility/skill-creator/scripts/quick_validate.py +0 -95
  443. package/.claude/skills/workflow/CLAUDE.md +0 -24
  444. package/.claude/skills/workflow/flow-dev/CLAUDE.md +0 -16
  445. package/.claude/skills/workflow/flow-dev/SKILL.md +0 -94
  446. package/.claude/skills/workflow/flow-dev/assets/IMPLEMENTATION_PLAN_TEMPLATE.md +0 -71
  447. package/.claude/skills/workflow/flow-dev/context.jsonl +0 -4
  448. package/.claude/skills/workflow/flow-dev/dev-implementer.jsonl +0 -8
  449. package/.claude/skills/workflow/flow-dev/scripts/entry-gate.sh +0 -116
  450. package/.claude/skills/workflow/flow-dev/scripts/exit-gate.sh +0 -101
  451. package/.claude/skills/workflow/flow-dev/scripts/task-orchestrator.sh +0 -106
  452. package/.claude/skills/workflow/flow-fix/SKILL.md +0 -105
  453. package/.claude/skills/workflow/flow-fix/context.jsonl +0 -6
  454. package/.claude/skills/workflow/flow-fix/references/bug-analyzer.md +0 -381
  455. package/.claude/skills/workflow/flow-init/SKILL.md +0 -84
  456. package/.claude/skills/workflow/flow-init/assets/BRAINSTORM_TEMPLATE.md +0 -148
  457. package/.claude/skills/workflow/flow-init/assets/INIT_FLOW_TEMPLATE.md +0 -198
  458. package/.claude/skills/workflow/flow-init/assets/RESEARCH_TEMPLATE.md +0 -276
  459. package/.claude/skills/workflow/flow-init/context.jsonl +0 -5
  460. package/.claude/skills/workflow/flow-init/references/flow-researcher.md +0 -132
  461. package/.claude/skills/workflow/flow-init/scripts/check-prerequisites.sh +0 -240
  462. package/.claude/skills/workflow/flow-init/scripts/consolidate-research.sh +0 -182
  463. package/.claude/skills/workflow/flow-init/scripts/create-requirement.sh +0 -404
  464. package/.claude/skills/workflow/flow-init/scripts/generate-research-tasks.sh +0 -157
  465. package/.claude/skills/workflow/flow-init/scripts/populate-research-tasks.sh +0 -284
  466. package/.claude/skills/workflow/flow-init/scripts/validate-research.sh +0 -340
  467. package/.claude/skills/workflow/flow-quality/SKILL.md +0 -98
  468. package/.claude/skills/workflow/flow-quality/context.jsonl +0 -6
  469. package/.claude/skills/workflow/flow-quality/references/code-quality-reviewer.md +0 -205
  470. package/.claude/skills/workflow/flow-quality/references/qa-tester.md +0 -313
  471. package/.claude/skills/workflow/flow-quality/references/security-reviewer.md +0 -314
  472. package/.claude/skills/workflow/flow-quality/references/spec-reviewer.md +0 -221
  473. package/.claude/skills/workflow/flow-release/SKILL.md +0 -49
  474. package/.claude/skills/workflow/flow-release/context.jsonl +0 -5
  475. package/.claude/skills/workflow/flow-release/references/release-manager.md +0 -295
  476. package/.claude/skills/workflow/flow-spec/CLAUDE.md +0 -17
  477. package/.claude/skills/workflow/flow-spec/SKILL.md +0 -74
  478. package/.claude/skills/workflow/flow-spec/context.jsonl +0 -5
  479. package/.claude/skills/workflow/flow-spec/scripts/entry-gate.sh +0 -194
  480. package/.claude/skills/workflow/flow-spec/scripts/exit-gate.sh +0 -244
  481. package/.claude/skills/workflow/flow-spec/scripts/parallel-orchestrator.sh +0 -205
  482. package/.claude/skills/workflow/flow-spec/scripts/team-communication.sh +0 -353
  483. package/.claude/skills/workflow/flow-spec/scripts/team-init.sh +0 -195
  484. package/.claude/skills/workflow/flow-spec/scripts/test-team-mode.sh +0 -496
  485. package/.claude/skills/workflow/flow-spec/team-config.json +0 -165
  486. package/.claude/skills/workflow/flow-verify/CLAUDE.md +0 -10
  487. package/.claude/skills/workflow/flow-verify/SKILL.md +0 -53
  488. package/.claude/skills/workflow/flow-verify/context.jsonl +0 -5
  489. package/.claude/skills/workflow.yaml +0 -219
  490. package/.claude/tests/README.md +0 -300
  491. package/.claude/tests/TODO.md +0 -69
  492. package/.claude/tests/__pycache__/test_analyze_upgrade_impact.cpython-311-pytest-7.2.2.pyc +0 -0
  493. package/.claude/tests/__pycache__/test_consolidate_research.cpython-311-pytest-7.2.2.pyc +0 -0
  494. package/.claude/tests/__pycache__/test_export_contracts.cpython-311-pytest-7.2.2.pyc +0 -0
  495. package/.claude/tests/__pycache__/test_extract_data_model.cpython-311-pytest-7.2.2.pyc +0 -0
  496. package/.claude/tests/__pycache__/test_generate_quickstart.cpython-311-pytest-7.2.2.pyc +0 -0
  497. package/.claude/tests/__pycache__/test_generate_research_tasks.cpython-311-pytest-7.2.2.pyc +0 -0
  498. package/.claude/tests/constitution/run_all_constitution_tests.sh +0 -111
  499. package/.claude/tests/constitution/test_agent_assignment.sh +0 -207
  500. package/.claude/tests/constitution/test_article_coverage.sh +0 -201
  501. package/.claude/tests/constitution/test_template_completeness.sh +0 -150
  502. package/.claude/tests/constitution/test_version_consistency.sh +0 -120
  503. package/.claude/tests/fixtures/spec_delta_full.md +0 -16
  504. package/.claude/tests/fixtures/tasks_progress_sample.md +0 -5
  505. package/.claude/tests/run-all-tests.sh +0 -229
  506. package/.claude/tests/scripts/run.sh +0 -30
  507. package/.claude/tests/scripts/test-framework.sh +0 -128
  508. package/.claude/tests/scripts/test_check_prerequisites.sh +0 -511
  509. package/.claude/tests/scripts/test_check_prerequisites.sh.bak +0 -504
  510. package/.claude/tests/scripts/test_check_prerequisites.sh.bak2 +0 -505
  511. package/.claude/tests/scripts/test_check_prerequisites.sh.bak3 +0 -506
  512. package/.claude/tests/scripts/test_check_prerequisites.sh.bak4 +0 -507
  513. package/.claude/tests/scripts/test_check_prerequisites.sh.bak5 +0 -508
  514. package/.claude/tests/scripts/test_check_task_status.sh +0 -499
  515. package/.claude/tests/scripts/test_common.sh +0 -244
  516. package/.claude/tests/scripts/test_generate_status_report.sh +0 -71
  517. package/.claude/tests/scripts/test_mark_task_complete.sh +0 -441
  518. package/.claude/tests/scripts/test_mark_task_complete.sh.backup +0 -410
  519. package/.claude/tests/scripts/test_recover_workflow.sh +0 -304
  520. package/.claude/tests/scripts/test_setup_epic.sh +0 -437
  521. package/.claude/tests/scripts/test_sync_task_marks.sh +0 -196
  522. package/.claude/tests/scripts/test_validate_constitution.sh +0 -74
  523. package/.claude/tests/scripts/test_validate_research.sh +0 -462
  524. package/.claude/tests/slugify.bats +0 -82
  525. package/.claude/tests/test-framework.sh +0 -732
  526. package/.claude/tests/test_analyze_upgrade_impact.py +0 -34
  527. package/.claude/tests/test_consolidate_research.py +0 -48
  528. package/.claude/tests/test_export_contracts.py +0 -43
  529. package/.claude/tests/test_extract_data_model.py +0 -33
  530. package/.claude/tests/test_generate_quickstart.py +0 -50
  531. package/.claude/tests/test_generate_research_tasks.py +0 -52
  532. package/bin/harness.js +0 -22
  533. package/docs/commands/core-roadmap.md +0 -106
  534. package/docs/commands/core-roadmap.zh-CN.md +0 -102
  535. package/docs/commands/core-style.md +0 -53
  536. package/docs/commands/core-style.zh-CN.md +0 -53
  537. package/docs/commands/flow-init.md +0 -140
  538. package/docs/commands/flow-init.zh-CN.md +0 -169
  539. package/docs/commands/flow-new.md +0 -39
  540. package/docs/commands/flow-new.zh-CN.md +0 -39
  541. package/lib/compiler/__tests__/compile-regression.test.js +0 -103
  542. package/lib/compiler/__tests__/multi-module-emitters.test.js +0 -534
  543. package/lib/compiler/__tests__/resource-copier.test.js +0 -26
  544. package/lib/compiler/__tests__/skill-discovery.test.js +0 -72
  545. package/lib/compiler/context-expander.js +0 -179
  546. package/lib/compiler/rules-emitters/__tests__/codex-rules-emitter.test.js +0 -109
  547. package/lib/compiler/rules-emitters/codex-rules-emitter.js +0 -116
  548. package/lib/compiler/skill-discovery.js +0 -68
  549. package/lib/harness/CLAUDE.md +0 -21
  550. package/lib/harness/cli.js +0 -208
  551. package/lib/harness/index.js +0 -16
  552. package/lib/harness/operations/dispatch.js +0 -285
  553. package/lib/harness/operations/init.js +0 -48
  554. package/lib/harness/operations/pack.js +0 -100
  555. package/lib/harness/operations/plan.js +0 -29
  556. package/lib/harness/operations/resume.js +0 -44
  557. package/lib/harness/operations/verify.js +0 -163
  558. package/lib/harness/planner.js +0 -141
  559. package/lib/harness/schemas.js +0 -108
@@ -1,872 +0,0 @@
1
- # Complete Examples
2
-
3
- Full working examples combining all modern patterns: React.FC, lazy loading, Suspense, useSuspenseQuery, styling, routing, and error handling.
4
-
5
- ---
6
-
7
- ## Example 1: Complete Modern Component
8
-
9
- Combines: React.FC, useSuspenseQuery, cache-first, useCallback, styling, error handling
10
-
11
- ```typescript
12
- /**
13
- * User profile display component
14
- * Demonstrates modern patterns with Suspense and TanStack Query
15
- */
16
- import React, { useState, useCallback, useMemo } from 'react';
17
- import { Box, Paper, Typography, Button, Avatar } from '@mui/material';
18
- import type { SxProps, Theme } from '@mui/material';
19
- import { useSuspenseQuery, useMutation, useQueryClient } from '@tanstack/react-query';
20
- import { userApi } from '../api/userApi';
21
- import { useMuiSnackbar } from '@/hooks/useMuiSnackbar';
22
- import type { User } from '~types/user';
23
-
24
- // Styles object
25
- const componentStyles: Record<string, SxProps<Theme>> = {
26
- container: {
27
- p: 3,
28
- maxWidth: 600,
29
- margin: '0 auto',
30
- },
31
- header: {
32
- display: 'flex',
33
- alignItems: 'center',
34
- gap: 2,
35
- mb: 3,
36
- },
37
- content: {
38
- display: 'flex',
39
- flexDirection: 'column',
40
- gap: 2,
41
- },
42
- actions: {
43
- display: 'flex',
44
- gap: 1,
45
- mt: 2,
46
- },
47
- };
48
-
49
- interface UserProfileProps {
50
- userId: string;
51
- onUpdate?: () => void;
52
- }
53
-
54
- export const UserProfile: React.FC<UserProfileProps> = ({ userId, onUpdate }) => {
55
- const queryClient = useQueryClient();
56
- const { showSuccess, showError } = useMuiSnackbar();
57
- const [isEditing, setIsEditing] = useState(false);
58
-
59
- // Suspense query - no isLoading needed!
60
- const { data: user } = useSuspenseQuery({
61
- queryKey: ['user', userId],
62
- queryFn: () => userApi.getUser(userId),
63
- staleTime: 5 * 60 * 1000,
64
- });
65
-
66
- // Update mutation
67
- const updateMutation = useMutation({
68
- mutationFn: (updates: Partial<User>) =>
69
- userApi.updateUser(userId, updates),
70
-
71
- onSuccess: () => {
72
- queryClient.invalidateQueries({ queryKey: ['user', userId] });
73
- showSuccess('Profile updated');
74
- setIsEditing(false);
75
- onUpdate?.();
76
- },
77
-
78
- onError: () => {
79
- showError('Failed to update profile');
80
- },
81
- });
82
-
83
- // Memoized computed value
84
- const fullName = useMemo(() => {
85
- return `${user.firstName} ${user.lastName}`;
86
- }, [user.firstName, user.lastName]);
87
-
88
- // Event handlers with useCallback
89
- const handleEdit = useCallback(() => {
90
- setIsEditing(true);
91
- }, []);
92
-
93
- const handleSave = useCallback(() => {
94
- updateMutation.mutate({
95
- firstName: user.firstName,
96
- lastName: user.lastName,
97
- });
98
- }, [user, updateMutation]);
99
-
100
- const handleCancel = useCallback(() => {
101
- setIsEditing(false);
102
- }, []);
103
-
104
- return (
105
- <Paper sx={componentStyles.container}>
106
- <Box sx={componentStyles.header}>
107
- <Avatar sx={{ width: 64, height: 64 }}>
108
- {user.firstName[0]}{user.lastName[0]}
109
- </Avatar>
110
- <Box>
111
- <Typography variant='h5'>{fullName}</Typography>
112
- <Typography color='text.secondary'>{user.email}</Typography>
113
- </Box>
114
- </Box>
115
-
116
- <Box sx={componentStyles.content}>
117
- <Typography>Username: {user.username}</Typography>
118
- <Typography>Roles: {user.roles.join(', ')}</Typography>
119
- </Box>
120
-
121
- <Box sx={componentStyles.actions}>
122
- {!isEditing ? (
123
- <Button variant='contained' onClick={handleEdit}>
124
- Edit Profile
125
- </Button>
126
- ) : (
127
- <>
128
- <Button
129
- variant='contained'
130
- onClick={handleSave}
131
- disabled={updateMutation.isPending}
132
- >
133
- {updateMutation.isPending ? 'Saving...' : 'Save'}
134
- </Button>
135
- <Button onClick={handleCancel}>
136
- Cancel
137
- </Button>
138
- </>
139
- )}
140
- </Box>
141
- </Paper>
142
- );
143
- };
144
-
145
- export default UserProfile;
146
- ```
147
-
148
- **Usage:**
149
- ```typescript
150
- <SuspenseLoader>
151
- <UserProfile userId='123' onUpdate={() => console.log('Updated')} />
152
- </SuspenseLoader>
153
- ```
154
-
155
- ---
156
-
157
- ## Example 2: Complete Feature Structure
158
-
159
- Real example based on `features/posts/`:
160
-
161
- ```
162
- features/
163
- users/
164
- api/
165
- userApi.ts # API service layer
166
- components/
167
- UserProfile.tsx # Main component (from Example 1)
168
- UserList.tsx # List component
169
- UserBlog.tsx # Blog component
170
- modals/
171
- DeleteUserModal.tsx # Modal component
172
- hooks/
173
- useSuspenseUser.ts # Suspense query hook
174
- useUserMutations.ts # Mutation hooks
175
- useUserPermissions.ts # Feature-specific hook
176
- helpers/
177
- userHelpers.ts # Utility functions
178
- validation.ts # Validation logic
179
- types/
180
- index.ts # TypeScript interfaces
181
- index.ts # Public API exports
182
- ```
183
-
184
- ### API Service (userApi.ts)
185
-
186
- ```typescript
187
- import apiClient from '@/lib/apiClient';
188
- import type { User, CreateUserPayload, UpdateUserPayload } from '../types';
189
-
190
- export const userApi = {
191
- getUser: async (userId: string): Promise<User> => {
192
- const { data } = await apiClient.get(`/users/${userId}`);
193
- return data;
194
- },
195
-
196
- getUsers: async (): Promise<User[]> => {
197
- const { data } = await apiClient.get('/users');
198
- return data;
199
- },
200
-
201
- createUser: async (payload: CreateUserPayload): Promise<User> => {
202
- const { data } = await apiClient.post('/users', payload);
203
- return data;
204
- },
205
-
206
- updateUser: async (userId: string, payload: UpdateUserPayload): Promise<User> => {
207
- const { data } = await apiClient.put(`/users/${userId}`, payload);
208
- return data;
209
- },
210
-
211
- deleteUser: async (userId: string): Promise<void> => {
212
- await apiClient.delete(`/users/${userId}`);
213
- },
214
- };
215
- ```
216
-
217
- ### Suspense Hook (useSuspenseUser.ts)
218
-
219
- ```typescript
220
- import { useSuspenseQuery } from '@tanstack/react-query';
221
- import { userApi } from '../api/userApi';
222
- import type { User } from '../types';
223
-
224
- export function useSuspenseUser(userId: string) {
225
- return useSuspenseQuery<User, Error>({
226
- queryKey: ['user', userId],
227
- queryFn: () => userApi.getUser(userId),
228
- staleTime: 5 * 60 * 1000,
229
- gcTime: 10 * 60 * 1000,
230
- });
231
- }
232
-
233
- export function useSuspenseUsers() {
234
- return useSuspenseQuery<User[], Error>({
235
- queryKey: ['users'],
236
- queryFn: () => userApi.getUsers(),
237
- staleTime: 1 * 60 * 1000, // Shorter for list
238
- });
239
- }
240
- ```
241
-
242
- ### Types (types/index.ts)
243
-
244
- ```typescript
245
- export interface User {
246
- id: string;
247
- username: string;
248
- email: string;
249
- firstName: string;
250
- lastName: string;
251
- roles: string[];
252
- createdAt: string;
253
- updatedAt: string;
254
- }
255
-
256
- export interface CreateUserPayload {
257
- username: string;
258
- email: string;
259
- firstName: string;
260
- lastName: string;
261
- password: string;
262
- }
263
-
264
- export type UpdateUserPayload = Partial<Omit<User, 'id' | 'createdAt' | 'updatedAt'>>;
265
- ```
266
-
267
- ### Public Exports (index.ts)
268
-
269
- ```typescript
270
- // Export components
271
- export { UserProfile } from './components/UserProfile';
272
- export { UserList } from './components/UserList';
273
-
274
- // Export hooks
275
- export { useSuspenseUser, useSuspenseUsers } from './hooks/useSuspenseUser';
276
- export { useUserMutations } from './hooks/useUserMutations';
277
-
278
- // Export API
279
- export { userApi } from './api/userApi';
280
-
281
- // Export types
282
- export type { User, CreateUserPayload, UpdateUserPayload } from './types';
283
- ```
284
-
285
- ---
286
-
287
- ## Example 3: Complete Route with Lazy Loading
288
-
289
- ```typescript
290
- /**
291
- * User profile route
292
- * Path: /users/:userId
293
- */
294
-
295
- import { createFileRoute } from '@tanstack/react-router';
296
- import { lazy } from 'react';
297
- import { SuspenseLoader } from '~components/SuspenseLoader';
298
-
299
- // Lazy load the UserProfile component
300
- const UserProfile = lazy(() =>
301
- import('@/features/users/components/UserProfile').then(
302
- (module) => ({ default: module.UserProfile })
303
- )
304
- );
305
-
306
- export const Route = createFileRoute('/users/$userId')({
307
- component: UserProfilePage,
308
- loader: ({ params }) => ({
309
- crumb: `User ${params.userId}`,
310
- }),
311
- });
312
-
313
- function UserProfilePage() {
314
- const { userId } = Route.useParams();
315
-
316
- return (
317
- <SuspenseLoader>
318
- <UserProfile
319
- userId={userId}
320
- onUpdate={() => console.log('Profile updated')}
321
- />
322
- </SuspenseLoader>
323
- );
324
- }
325
-
326
- export default UserProfilePage;
327
- ```
328
-
329
- ---
330
-
331
- ## Example 4: List with Search and Filtering
332
-
333
- ```typescript
334
- import React, { useState, useMemo } from 'react';
335
- import { Box, TextField, List, ListItem } from '@mui/material';
336
- import { useDebounce } from 'use-debounce';
337
- import { useSuspenseQuery } from '@tanstack/react-query';
338
- import { userApi } from '../api/userApi';
339
-
340
- export const UserList: React.FC = () => {
341
- const [searchTerm, setSearchTerm] = useState('');
342
- const [debouncedSearch] = useDebounce(searchTerm, 300);
343
-
344
- const { data: users } = useSuspenseQuery({
345
- queryKey: ['users'],
346
- queryFn: () => userApi.getUsers(),
347
- });
348
-
349
- // Memoized filtering
350
- const filteredUsers = useMemo(() => {
351
- if (!debouncedSearch) return users;
352
-
353
- return users.filter(user =>
354
- user.name.toLowerCase().includes(debouncedSearch.toLowerCase()) ||
355
- user.email.toLowerCase().includes(debouncedSearch.toLowerCase())
356
- );
357
- }, [users, debouncedSearch]);
358
-
359
- return (
360
- <Box>
361
- <TextField
362
- value={searchTerm}
363
- onChange={(e) => setSearchTerm(e.target.value)}
364
- placeholder='Search users...'
365
- fullWidth
366
- sx={{ mb: 2 }}
367
- />
368
-
369
- <List>
370
- {filteredUsers.map(user => (
371
- <ListItem key={user.id}>
372
- {user.name} - {user.email}
373
- </ListItem>
374
- ))}
375
- </List>
376
- </Box>
377
- );
378
- };
379
- ```
380
-
381
- ---
382
-
383
- ## Example 5: Blog with Validation
384
-
385
- ```typescript
386
- import React from 'react';
387
- import { Box, TextField, Button, Paper } from '@mui/material';
388
- import { useBlog } from 'react-hook-blog';
389
- import { zodResolver } from '@hookblog/resolvers/zod';
390
- import { z } from 'zod';
391
- import { useMutation, useQueryClient } from '@tanstack/react-query';
392
- import { userApi } from '../api/userApi';
393
- import { useMuiSnackbar } from '@/hooks/useMuiSnackbar';
394
-
395
- const userSchema = z.object({
396
- username: z.string().min(3).max(50),
397
- email: z.string().email(),
398
- firstName: z.string().min(1),
399
- lastName: z.string().min(1),
400
- });
401
-
402
- type UserBlogData = z.infer<typeof userSchema>;
403
-
404
- interface CreateUserBlogProps {
405
- onSuccess?: () => void;
406
- }
407
-
408
- export const CreateUserBlog: React.FC<CreateUserBlogProps> = ({ onSuccess }) => {
409
- const queryClient = useQueryClient();
410
- const { showSuccess, showError } = useMuiSnackbar();
411
-
412
- const { register, handleSubmit, blogState: { errors }, reset } = useBlog<UserBlogData>({
413
- resolver: zodResolver(userSchema),
414
- defaultValues: {
415
- username: '',
416
- email: '',
417
- firstName: '',
418
- lastName: '',
419
- },
420
- });
421
-
422
- const createMutation = useMutation({
423
- mutationFn: (data: UserBlogData) => userApi.createUser(data),
424
-
425
- onSuccess: () => {
426
- queryClient.invalidateQueries({ queryKey: ['users'] });
427
- showSuccess('User created successfully');
428
- reset();
429
- onSuccess?.();
430
- },
431
-
432
- onError: () => {
433
- showError('Failed to create user');
434
- },
435
- });
436
-
437
- const onSubmit = (data: UserBlogData) => {
438
- createMutation.mutate(data);
439
- };
440
-
441
- return (
442
- <Paper sx={{ p: 3, maxWidth: 500 }}>
443
- <blog onSubmit={handleSubmit(onSubmit)}>
444
- <Box sx={{ display: 'flex', flexDirection: 'column', gap: 2 }}>
445
- <TextField
446
- {...register('username')}
447
- label='Username'
448
- error={!!errors.username}
449
- helperText={errors.username?.message}
450
- fullWidth
451
- />
452
-
453
- <TextField
454
- {...register('email')}
455
- label='Email'
456
- type='email'
457
- error={!!errors.email}
458
- helperText={errors.email?.message}
459
- fullWidth
460
- />
461
-
462
- <TextField
463
- {...register('firstName')}
464
- label='First Name'
465
- error={!!errors.firstName}
466
- helperText={errors.firstName?.message}
467
- fullWidth
468
- />
469
-
470
- <TextField
471
- {...register('lastName')}
472
- label='Last Name'
473
- error={!!errors.lastName}
474
- helperText={errors.lastName?.message}
475
- fullWidth
476
- />
477
-
478
- <Button
479
- type='submit'
480
- variant='contained'
481
- disabled={createMutation.isPending}
482
- >
483
- {createMutation.isPending ? 'Creating...' : 'Create User'}
484
- </Button>
485
- </Box>
486
- </blog>
487
- </Paper>
488
- );
489
- };
490
-
491
- export default CreateUserBlog;
492
- ```
493
-
494
- ---
495
-
496
- ## Example 2: Parent Container with Lazy Loading
497
-
498
- ```typescript
499
- import React from 'react';
500
- import { Box } from '@mui/material';
501
- import { SuspenseLoader } from '~components/SuspenseLoader';
502
-
503
- // Lazy load heavy components
504
- const UserList = React.lazy(() => import('./UserList'));
505
- const UserStats = React.lazy(() => import('./UserStats'));
506
- const ActivityFeed = React.lazy(() => import('./ActivityFeed'));
507
-
508
- export const UserDashboard: React.FC = () => {
509
- return (
510
- <Box sx={{ p: 2 }}>
511
- <SuspenseLoader>
512
- <UserStats />
513
- </SuspenseLoader>
514
-
515
- <Box sx={{ display: 'flex', gap: 2, mt: 2 }}>
516
- <Box sx={{ flex: 2 }}>
517
- <SuspenseLoader>
518
- <UserList />
519
- </SuspenseLoader>
520
- </Box>
521
-
522
- <Box sx={{ flex: 1 }}>
523
- <SuspenseLoader>
524
- <ActivityFeed />
525
- </SuspenseLoader>
526
- </Box>
527
- </Box>
528
- </Box>
529
- );
530
- };
531
-
532
- export default UserDashboard;
533
- ```
534
-
535
- **Benefits:**
536
- - Each section loads independently
537
- - User sees partial content sooner
538
- - Better perceived perblogance
539
-
540
- ---
541
-
542
- ## Example 3: Cache-First Strategy Implementation
543
-
544
- Complete example based on useSuspensePost.ts:
545
-
546
- ```typescript
547
- import { useSuspenseQuery, useQueryClient } from '@tanstack/react-query';
548
- import { postApi } from '../api/postApi';
549
- import type { Post } from '../types';
550
-
551
- /**
552
- * Smart post hook with cache-first strategy
553
- * Reuses data from grid cache when available
554
- */
555
- export function useSuspensePost(blogId: number, postId: number) {
556
- const queryClient = useQueryClient();
557
-
558
- return useSuspenseQuery<Post, Error>({
559
- queryKey: ['post', blogId, postId],
560
- queryFn: async () => {
561
- // Strategy 1: Check grid cache first (avoids API call)
562
- const gridCache = queryClient.getQueryData<{ rows: Post[] }>([
563
- 'posts-v2',
564
- blogId,
565
- 'summary'
566
- ]) || queryClient.getQueryData<{ rows: Post[] }>([
567
- 'posts-v2',
568
- blogId,
569
- 'flat'
570
- ]);
571
-
572
- if (gridCache?.rows) {
573
- const cached = gridCache.rows.find(
574
- (row) => row.S_ID === postId
575
- );
576
-
577
- if (cached) {
578
- return cached; // Return from cache - no API call!
579
- }
580
- }
581
-
582
- // Strategy 2: Not in cache, fetch from API
583
- return postApi.getPost(blogId, postId);
584
- },
585
- staleTime: 5 * 60 * 1000, // Fresh for 5 minutes
586
- gcTime: 10 * 60 * 1000, // Cache for 10 minutes
587
- refetchOnWindowFocus: false, // Don't refetch on focus
588
- });
589
- }
590
- ```
591
-
592
- **Why this pattern:**
593
- - Checks grid cache before API
594
- - Instant data if user came from grid
595
- - Falls back to API if not cached
596
- - Configurable cache times
597
-
598
- ---
599
-
600
- ## Example 4: Complete Route File
601
-
602
- ```typescript
603
- /**
604
- * Project catalog route
605
- * Path: /project-catalog
606
- */
607
-
608
- import { createFileRoute } from '@tanstack/react-router';
609
- import { lazy } from 'react';
610
-
611
- // Lazy load the PostTable component
612
- const PostTable = lazy(() =>
613
- import('@/features/posts/components/PostTable').then(
614
- (module) => ({ default: module.PostTable })
615
- )
616
- );
617
-
618
- // Route constants
619
- const PROJECT_CATALOG_FORM_ID = 744;
620
- const PROJECT_CATALOG_PROJECT_ID = 225;
621
-
622
- export const Route = createFileRoute('/project-catalog/')({
623
- component: ProjectCatalogPage,
624
- loader: () => ({
625
- crumb: 'Projects', // Breadcrumb title
626
- }),
627
- });
628
-
629
- function ProjectCatalogPage() {
630
- return (
631
- <PostTable
632
- blogId={PROJECT_CATALOG_FORM_ID}
633
- projectId={PROJECT_CATALOG_PROJECT_ID}
634
- tableType='active_projects'
635
- title='Blog Dashboard'
636
- />
637
- );
638
- }
639
-
640
- export default ProjectCatalogPage;
641
- ```
642
-
643
- ---
644
-
645
- ## Example 5: Dialog with Blog
646
-
647
- ```typescript
648
- import React from 'react';
649
- import {
650
- Dialog,
651
- DialogTitle,
652
- DialogContent,
653
- DialogActions,
654
- Button,
655
- TextField,
656
- Box,
657
- IconButton,
658
- } from '@mui/material';
659
- import { Close, PersonAdd } from '@mui/icons-material';
660
- import { useBlog } from 'react-hook-blog';
661
- import { zodResolver } from '@hookblog/resolvers/zod';
662
- import { z } from 'zod';
663
-
664
- const blogSchema = z.object({
665
- name: z.string().min(1),
666
- email: z.string().email(),
667
- });
668
-
669
- type BlogData = z.infer<typeof blogSchema>;
670
-
671
- interface AddUserDialogProps {
672
- open: boolean;
673
- onClose: () => void;
674
- onSubmit: (data: BlogData) => Promise<void>;
675
- }
676
-
677
- export const AddUserDialog: React.FC<AddUserDialogProps> = ({
678
- open,
679
- onClose,
680
- onSubmit,
681
- }) => {
682
- const { register, handleSubmit, blogState: { errors }, reset } = useBlog<BlogData>({
683
- resolver: zodResolver(blogSchema),
684
- });
685
-
686
- const handleClose = () => {
687
- reset();
688
- onClose();
689
- };
690
-
691
- const handleBlogSubmit = async (data: BlogData) => {
692
- await onSubmit(data);
693
- handleClose();
694
- };
695
-
696
- return (
697
- <Dialog open={open} onClose={handleClose} maxWidth='sm' fullWidth>
698
- <DialogTitle>
699
- <Box sx={{ display: 'flex', alignItems: 'center', justifyContent: 'space-between' }}>
700
- <Box sx={{ display: 'flex', alignItems: 'center', gap: 1 }}>
701
- <PersonAdd color='primary' />
702
- Add User
703
- </Box>
704
- <IconButton onClick={handleClose} size='small'>
705
- <Close />
706
- </IconButton>
707
- </Box>
708
- </DialogTitle>
709
-
710
- <blog onSubmit={handleSubmit(handleBlogSubmit)}>
711
- <DialogContent>
712
- <Box sx={{ display: 'flex', flexDirection: 'column', gap: 2 }}>
713
- <TextField
714
- {...register('name')}
715
- label='Name'
716
- error={!!errors.name}
717
- helperText={errors.name?.message}
718
- fullWidth
719
- autoFocus
720
- />
721
-
722
- <TextField
723
- {...register('email')}
724
- label='Email'
725
- type='email'
726
- error={!!errors.email}
727
- helperText={errors.email?.message}
728
- fullWidth
729
- />
730
- </Box>
731
- </DialogContent>
732
-
733
- <DialogActions>
734
- <Button onClick={handleClose}>Cancel</Button>
735
- <Button type='submit' variant='contained'>
736
- Add User
737
- </Button>
738
- </DialogActions>
739
- </blog>
740
- </Dialog>
741
- );
742
- };
743
- ```
744
-
745
- ---
746
-
747
- ## Example 6: Parallel Data Fetching
748
-
749
- ```typescript
750
- import React from 'react';
751
- import { Box, Grid, Paper } from '@mui/material';
752
- import { useSuspenseQueries } from '@tanstack/react-query';
753
- import { userApi } from '../api/userApi';
754
- import { statsApi } from '../api/statsApi';
755
- import { activityApi } from '../api/activityApi';
756
-
757
- export const Dashboard: React.FC = () => {
758
- // Fetch all data in parallel with Suspense
759
- const [statsQuery, usersQuery, activityQuery] = useSuspenseQueries({
760
- queries: [
761
- {
762
- queryKey: ['stats'],
763
- queryFn: () => statsApi.getStats(),
764
- },
765
- {
766
- queryKey: ['users', 'active'],
767
- queryFn: () => userApi.getActiveUsers(),
768
- },
769
- {
770
- queryKey: ['activity', 'recent'],
771
- queryFn: () => activityApi.getRecent(),
772
- },
773
- ],
774
- });
775
-
776
- return (
777
- <Box sx={{ p: 2 }}>
778
- <Grid container spacing={2}>
779
- <Grid size={{ xs: 12, md: 4 }}>
780
- <Paper sx={{ p: 2 }}>
781
- <h3>Stats</h3>
782
- <p>Total: {statsQuery.data.total}</p>
783
- </Paper>
784
- </Grid>
785
-
786
- <Grid size={{ xs: 12, md: 4 }}>
787
- <Paper sx={{ p: 2 }}>
788
- <h3>Active Users</h3>
789
- <p>Count: {usersQuery.data.length}</p>
790
- </Paper>
791
- </Grid>
792
-
793
- <Grid size={{ xs: 12, md: 4 }}>
794
- <Paper sx={{ p: 2 }}>
795
- <h3>Recent Activity</h3>
796
- <p>Events: {activityQuery.data.length}</p>
797
- </Paper>
798
- </Grid>
799
- </Grid>
800
- </Box>
801
- );
802
- };
803
-
804
- // Usage with Suspense
805
- <SuspenseLoader>
806
- <Dashboard />
807
- </SuspenseLoader>
808
- ```
809
-
810
- ---
811
-
812
- ## Example 7: Optimistic Update
813
-
814
- ```typescript
815
- import { useMutation, useQueryClient } from '@tanstack/react-query';
816
- import type { User } from '../types';
817
-
818
- export const useToggleUserStatus = () => {
819
- const queryClient = useQueryClient();
820
-
821
- return useMutation({
822
- mutationFn: (userId: string) => userApi.toggleStatus(userId),
823
-
824
- // Optimistic update
825
- onMutate: async (userId) => {
826
- // Cancel outgoing refetches
827
- await queryClient.cancelQueries({ queryKey: ['users'] });
828
-
829
- // Snapshot previous value
830
- const previousUsers = queryClient.getQueryData<User[]>(['users']);
831
-
832
- // Optimistically update UI
833
- queryClient.setQueryData<User[]>(['users'], (old) => {
834
- return old?.map(user =>
835
- user.id === userId
836
- ? { ...user, active: !user.active }
837
- : user
838
- ) || [];
839
- });
840
-
841
- return { previousUsers };
842
- },
843
-
844
- // Rollback on error
845
- onError: (err, userId, context) => {
846
- queryClient.setQueryData(['users'], context?.previousUsers);
847
- },
848
-
849
- // Refetch after mutation
850
- onSettled: () => {
851
- queryClient.invalidateQueries({ queryKey: ['users'] });
852
- },
853
- });
854
- };
855
- ```
856
-
857
- ---
858
-
859
- ## Summary
860
-
861
- **Key Takeaways:**
862
-
863
- 1. **Component Pattern**: React.FC + lazy + Suspense + useSuspenseQuery
864
- 2. **Feature Structure**: Organized subdirectories (api/, components/, hooks/, etc.)
865
- 3. **Routing**: Folder-based with lazy loading
866
- 4. **Data Fetching**: useSuspenseQuery with cache-first strategy
867
- 5. **Blogs**: React Hook Blog + Zod validation
868
- 6. **Error Handling**: useMuiSnackbar + onError callbacks
869
- 7. **Perblogance**: useMemo, useCallback, React.memo, debouncing
870
- 8. **Styling**: Inline <100 lines, sx prop, MUI v7 syntax
871
-
872
- **See other resources for detailed explanations of each pattern.**