@howlil/ez-agents 3.4.1 → 3.5.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 (162) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +84 -20
  3. package/agents/ez-observer-agent.md +260 -0
  4. package/agents/ez-release-agent.md +333 -0
  5. package/agents/ez-requirements-agent.md +377 -0
  6. package/agents/ez-scrum-master-agent.md +242 -0
  7. package/agents/ez-tech-lead-agent.md +267 -0
  8. package/bin/install.js +3221 -3230
  9. package/commands/ez/arch-review.md +102 -0
  10. package/commands/ez/execute-phase.md +11 -0
  11. package/commands/ez/export-session.md +79 -0
  12. package/commands/ez/gather-requirements.md +117 -0
  13. package/commands/ez/git-workflow.md +72 -0
  14. package/commands/ez/hotfix.md +120 -0
  15. package/commands/ez/import-session.md +82 -0
  16. package/commands/ez/join-discord.md +18 -18
  17. package/commands/ez/list-sessions.md +96 -0
  18. package/commands/ez/package-manager.md +316 -0
  19. package/commands/ez/plan-phase.md +9 -1
  20. package/commands/ez/preflight.md +79 -0
  21. package/commands/ez/progress.md +13 -1
  22. package/commands/ez/release.md +153 -0
  23. package/commands/ez/resume.md +107 -0
  24. package/commands/ez/standup.md +85 -0
  25. package/ez-agents/bin/ez-tools.cjs +1095 -716
  26. package/ez-agents/bin/lib/assistant-adapter.cjs +264 -264
  27. package/ez-agents/bin/lib/audit-exec.cjs +7 -2
  28. package/ez-agents/bin/lib/bdd-validator.cjs +622 -0
  29. package/ez-agents/bin/lib/circuit-breaker.cjs +118 -118
  30. package/ez-agents/bin/lib/config.cjs +190 -190
  31. package/ez-agents/bin/lib/content-scanner.cjs +238 -0
  32. package/ez-agents/bin/lib/context-cache.cjs +154 -0
  33. package/ez-agents/bin/lib/context-errors.cjs +71 -0
  34. package/ez-agents/bin/lib/context-manager.cjs +220 -0
  35. package/ez-agents/bin/lib/discussion-synthesizer.cjs +458 -0
  36. package/ez-agents/bin/lib/file-access.cjs +207 -0
  37. package/ez-agents/bin/lib/file-lock.cjs +236 -236
  38. package/ez-agents/bin/lib/frontmatter.cjs +299 -299
  39. package/ez-agents/bin/lib/fs-utils.cjs +153 -153
  40. package/ez-agents/bin/lib/git-errors.cjs +83 -0
  41. package/ez-agents/bin/lib/git-utils.cjs +118 -0
  42. package/ez-agents/bin/lib/git-workflow-engine.cjs +1157 -0
  43. package/ez-agents/bin/lib/index.cjs +157 -113
  44. package/ez-agents/bin/lib/init.cjs +757 -757
  45. package/ez-agents/bin/lib/lockfile-validator.cjs +227 -0
  46. package/ez-agents/bin/lib/logger.cjs +124 -124
  47. package/ez-agents/bin/lib/memory-compression.cjs +256 -0
  48. package/ez-agents/bin/lib/metrics-tracker.cjs +406 -0
  49. package/ez-agents/bin/lib/milestone.cjs +241 -241
  50. package/ez-agents/bin/lib/model-provider.cjs +241 -241
  51. package/ez-agents/bin/lib/package-manager-detector.cjs +203 -0
  52. package/ez-agents/bin/lib/package-manager-executor.cjs +385 -0
  53. package/ez-agents/bin/lib/package-manager-service.cjs +216 -0
  54. package/ez-agents/bin/lib/phase.cjs +925 -925
  55. package/ez-agents/bin/lib/planning-write.cjs +107 -107
  56. package/ez-agents/bin/lib/release-validator.cjs +614 -0
  57. package/ez-agents/bin/lib/retry.cjs +119 -119
  58. package/ez-agents/bin/lib/roadmap.cjs +306 -306
  59. package/ez-agents/bin/lib/safe-exec.cjs +128 -128
  60. package/ez-agents/bin/lib/safe-path.cjs +130 -130
  61. package/ez-agents/bin/lib/session-chain.cjs +304 -0
  62. package/ez-agents/bin/lib/session-errors.cjs +81 -0
  63. package/ez-agents/bin/lib/session-export.cjs +251 -0
  64. package/ez-agents/bin/lib/session-import.cjs +262 -0
  65. package/ez-agents/bin/lib/session-manager.cjs +280 -0
  66. package/ez-agents/bin/lib/state.cjs +736 -736
  67. package/ez-agents/bin/lib/temp-file.cjs +239 -239
  68. package/ez-agents/bin/lib/template.cjs +223 -223
  69. package/ez-agents/bin/lib/test-file-lock.cjs +112 -112
  70. package/ez-agents/bin/lib/test-graceful.cjs +93 -93
  71. package/ez-agents/bin/lib/test-logger.cjs +60 -60
  72. package/ez-agents/bin/lib/test-safe-exec.cjs +38 -38
  73. package/ez-agents/bin/lib/test-safe-path.cjs +33 -33
  74. package/ez-agents/bin/lib/test-temp-file.cjs +125 -125
  75. package/ez-agents/bin/lib/tier-manager.cjs +428 -0
  76. package/ez-agents/bin/lib/timeout-exec.cjs +63 -63
  77. package/ez-agents/bin/lib/url-fetch.cjs +170 -0
  78. package/ez-agents/bin/lib/verify.cjs +15 -1
  79. package/ez-agents/references/checkpoints.md +776 -776
  80. package/ez-agents/references/continuation-format.md +249 -249
  81. package/ez-agents/references/metrics-schema.md +118 -0
  82. package/ez-agents/references/planning-config.md +140 -0
  83. package/ez-agents/references/questioning.md +162 -162
  84. package/ez-agents/references/tdd.md +263 -263
  85. package/ez-agents/references/tier-strategy.md +103 -0
  86. package/ez-agents/templates/bdd-feature.md +173 -0
  87. package/ez-agents/templates/codebase/concerns.md +310 -310
  88. package/ez-agents/templates/codebase/conventions.md +307 -307
  89. package/ez-agents/templates/codebase/integrations.md +280 -280
  90. package/ez-agents/templates/codebase/stack.md +186 -186
  91. package/ez-agents/templates/codebase/testing.md +480 -480
  92. package/ez-agents/templates/config.json +37 -37
  93. package/ez-agents/templates/continue-here.md +78 -78
  94. package/ez-agents/templates/discussion.md +68 -0
  95. package/ez-agents/templates/incident-runbook.md +205 -0
  96. package/ez-agents/templates/milestone-archive.md +123 -123
  97. package/ez-agents/templates/milestone.md +115 -115
  98. package/ez-agents/templates/release-checklist.md +133 -0
  99. package/ez-agents/templates/requirements.md +231 -231
  100. package/ez-agents/templates/research-project/ARCHITECTURE.md +204 -204
  101. package/ez-agents/templates/research-project/FEATURES.md +147 -147
  102. package/ez-agents/templates/research-project/PITFALLS.md +200 -200
  103. package/ez-agents/templates/research-project/STACK.md +120 -120
  104. package/ez-agents/templates/research-project/SUMMARY.md +170 -170
  105. package/ez-agents/templates/retrospective.md +54 -54
  106. package/ez-agents/templates/roadmap.md +202 -202
  107. package/ez-agents/templates/rollback-plan.md +201 -0
  108. package/ez-agents/templates/summary-minimal.md +41 -41
  109. package/ez-agents/templates/summary-standard.md +48 -48
  110. package/ez-agents/templates/summary.md +248 -248
  111. package/ez-agents/templates/user-setup.md +311 -311
  112. package/ez-agents/templates/verification-report.md +322 -322
  113. package/ez-agents/workflows/add-phase.md +112 -112
  114. package/ez-agents/workflows/add-tests.md +351 -351
  115. package/ez-agents/workflows/add-todo.md +158 -158
  116. package/ez-agents/workflows/arch-review.md +54 -0
  117. package/ez-agents/workflows/audit-milestone.md +332 -332
  118. package/ez-agents/workflows/autonomous.md +131 -30
  119. package/ez-agents/workflows/check-todos.md +177 -177
  120. package/ez-agents/workflows/cleanup.md +152 -152
  121. package/ez-agents/workflows/complete-milestone.md +766 -766
  122. package/ez-agents/workflows/diagnose-issues.md +219 -219
  123. package/ez-agents/workflows/discovery-phase.md +289 -289
  124. package/ez-agents/workflows/discuss-phase.md +762 -762
  125. package/ez-agents/workflows/execute-phase.md +513 -468
  126. package/ez-agents/workflows/execute-plan.md +483 -483
  127. package/ez-agents/workflows/export-session.md +255 -0
  128. package/ez-agents/workflows/gather-requirements.md +206 -0
  129. package/ez-agents/workflows/health.md +159 -159
  130. package/ez-agents/workflows/help.md +584 -492
  131. package/ez-agents/workflows/hotfix.md +291 -0
  132. package/ez-agents/workflows/import-session.md +303 -0
  133. package/ez-agents/workflows/insert-phase.md +130 -130
  134. package/ez-agents/workflows/list-phase-assumptions.md +178 -178
  135. package/ez-agents/workflows/map-codebase.md +316 -316
  136. package/ez-agents/workflows/new-milestone.md +339 -10
  137. package/ez-agents/workflows/new-project.md +293 -299
  138. package/ez-agents/workflows/node-repair.md +92 -92
  139. package/ez-agents/workflows/pause-work.md +122 -122
  140. package/ez-agents/workflows/plan-milestone-gaps.md +274 -274
  141. package/ez-agents/workflows/plan-phase.md +673 -651
  142. package/ez-agents/workflows/progress.md +372 -382
  143. package/ez-agents/workflows/quick.md +610 -610
  144. package/ez-agents/workflows/release.md +253 -0
  145. package/ez-agents/workflows/remove-phase.md +155 -155
  146. package/ez-agents/workflows/research-phase.md +74 -74
  147. package/ez-agents/workflows/resume-project.md +307 -307
  148. package/ez-agents/workflows/resume-session.md +215 -0
  149. package/ez-agents/workflows/set-profile.md +81 -81
  150. package/ez-agents/workflows/settings.md +242 -242
  151. package/ez-agents/workflows/standup.md +64 -0
  152. package/ez-agents/workflows/stats.md +57 -57
  153. package/ez-agents/workflows/transition.md +544 -544
  154. package/ez-agents/workflows/ui-phase.md +290 -290
  155. package/ez-agents/workflows/ui-review.md +157 -157
  156. package/ez-agents/workflows/update.md +320 -320
  157. package/ez-agents/workflows/validate-phase.md +167 -167
  158. package/ez-agents/workflows/verify-phase.md +243 -243
  159. package/ez-agents/workflows/verify-work.md +584 -584
  160. package/package.json +10 -4
  161. package/scripts/build-hooks.js +43 -43
  162. package/scripts/run-tests.cjs +29 -29
@@ -1,48 +1,48 @@
1
- ---
2
- phase: XX-name
3
- plan: YY
4
- subsystem: [primary category]
5
- tags: [searchable tech]
6
- provides:
7
- - [bullet list of what was built/delivered]
8
- affects: [list of phase names or keywords]
9
- tech-stack:
10
- added: [libraries/tools]
11
- patterns: [architectural/code patterns]
12
- key-files:
13
- created: [important files created]
14
- modified: [important files modified]
15
- key-decisions:
16
- - "Decision 1"
17
- duration: Xmin
18
- completed: YYYY-MM-DD
19
- ---
20
-
21
- # Phase [X]: [Name] Summary
22
-
23
- **[Substantive one-liner describing outcome]**
24
-
25
- ## Performance
26
- - **Duration:** [time]
27
- - **Tasks:** [count completed]
28
- - **Files modified:** [count]
29
-
30
- ## Accomplishments
31
- - [Key outcome 1]
32
- - [Key outcome 2]
33
-
34
- ## Task Commits
35
- 1. **Task 1: [task name]** - `hash`
36
- 2. **Task 2: [task name]** - `hash`
37
- 3. **Task 3: [task name]** - `hash`
38
-
39
- ## Files Created/Modified
40
- - `path/to/file.ts` - What it does
41
- - `path/to/another.ts` - What it does
42
-
43
- ## Decisions & Deviations
44
- [Key decisions or "None - followed plan as specified"]
45
- [Minor deviations if any, or "None"]
46
-
47
- ## Next Phase Readiness
48
- [What's ready for next phase]
1
+ ---
2
+ phase: XX-name
3
+ plan: YY
4
+ subsystem: [primary category]
5
+ tags: [searchable tech]
6
+ provides:
7
+ - [bullet list of what was built/delivered]
8
+ affects: [list of phase names or keywords]
9
+ tech-stack:
10
+ added: [libraries/tools]
11
+ patterns: [architectural/code patterns]
12
+ key-files:
13
+ created: [important files created]
14
+ modified: [important files modified]
15
+ key-decisions:
16
+ - "Decision 1"
17
+ duration: Xmin
18
+ completed: YYYY-MM-DD
19
+ ---
20
+
21
+ # Phase [X]: [Name] Summary
22
+
23
+ **[Substantive one-liner describing outcome]**
24
+
25
+ ## Performance
26
+ - **Duration:** [time]
27
+ - **Tasks:** [count completed]
28
+ - **Files modified:** [count]
29
+
30
+ ## Accomplishments
31
+ - [Key outcome 1]
32
+ - [Key outcome 2]
33
+
34
+ ## Task Commits
35
+ 1. **Task 1: [task name]** - `hash`
36
+ 2. **Task 2: [task name]** - `hash`
37
+ 3. **Task 3: [task name]** - `hash`
38
+
39
+ ## Files Created/Modified
40
+ - `path/to/file.ts` - What it does
41
+ - `path/to/another.ts` - What it does
42
+
43
+ ## Decisions & Deviations
44
+ [Key decisions or "None - followed plan as specified"]
45
+ [Minor deviations if any, or "None"]
46
+
47
+ ## Next Phase Readiness
48
+ [What's ready for next phase]
@@ -1,248 +1,248 @@
1
- # Summary Template
2
-
3
- Template for `.planning/phases/XX-name/{phase}-{plan}-SUMMARY.md` - phase completion documentation.
4
-
5
- ---
6
-
7
- ## File Template
8
-
9
- ```markdown
10
- ---
11
- phase: XX-name
12
- plan: YY
13
- subsystem: [primary category: auth, payments, ui, api, database, infra, testing, etc.]
14
- tags: [searchable tech: jwt, stripe, react, postgres, prisma]
15
-
16
- # Dependency graph
17
- requires:
18
- - phase: [prior phase this depends on]
19
- provides: [what that phase built that this uses]
20
- provides:
21
- - [bullet list of what this phase built/delivered]
22
- affects: [list of phase names or keywords that will need this context]
23
-
24
- # Tech tracking
25
- tech-stack:
26
- added: [libraries/tools added in this phase]
27
- patterns: [architectural/code patterns established]
28
-
29
- key-files:
30
- created: [important files created]
31
- modified: [important files modified]
32
-
33
- key-decisions:
34
- - "Decision 1"
35
- - "Decision 2"
36
-
37
- patterns-established:
38
- - "Pattern 1: description"
39
- - "Pattern 2: description"
40
-
41
- requirements-completed: [] # REQUIRED — Copy ALL requirement IDs from this plan's `requirements` frontmatter field.
42
-
43
- # Metrics
44
- duration: Xmin
45
- completed: YYYY-MM-DD
46
- ---
47
-
48
- # Phase [X]: [Name] Summary
49
-
50
- **[Substantive one-liner describing outcome - NOT "phase complete" or "implementation finished"]**
51
-
52
- ## Performance
53
-
54
- - **Duration:** [time] (e.g., 23 min, 1h 15m)
55
- - **Started:** [ISO timestamp]
56
- - **Completed:** [ISO timestamp]
57
- - **Tasks:** [count completed]
58
- - **Files modified:** [count]
59
-
60
- ## Accomplishments
61
- - [Most important outcome]
62
- - [Second key accomplishment]
63
- - [Third if applicable]
64
-
65
- ## Task Commits
66
-
67
- Each task was committed atomically:
68
-
69
- 1. **Task 1: [task name]** - `abc123f` (feat/fix/test/refactor)
70
- 2. **Task 2: [task name]** - `def456g` (feat/fix/test/refactor)
71
- 3. **Task 3: [task name]** - `hij789k` (feat/fix/test/refactor)
72
-
73
- **Plan metadata:** `lmn012o` (docs: complete plan)
74
-
75
- _Note: TDD tasks may have multiple commits (test → feat → refactor)_
76
-
77
- ## Files Created/Modified
78
- - `path/to/file.ts` - What it does
79
- - `path/to/another.ts` - What it does
80
-
81
- ## Decisions Made
82
- [Key decisions with brief rationale, or "None - followed plan as specified"]
83
-
84
- ## Deviations from Plan
85
-
86
- [If no deviations: "None - plan executed exactly as written"]
87
-
88
- [If deviations occurred:]
89
-
90
- ### Auto-fixed Issues
91
-
92
- **1. [Rule X - Category] Brief description**
93
- - **Found during:** Task [N] ([task name])
94
- - **Issue:** [What was wrong]
95
- - **Fix:** [What was done]
96
- - **Files modified:** [file paths]
97
- - **Verification:** [How it was verified]
98
- - **Committed in:** [hash] (part of task commit)
99
-
100
- [... repeat for each auto-fix ...]
101
-
102
- ---
103
-
104
- **Total deviations:** [N] auto-fixed ([breakdown by rule])
105
- **Impact on plan:** [Brief assessment - e.g., "All auto-fixes necessary for correctness/security. No scope creep."]
106
-
107
- ## Issues Encountered
108
- [Problems and how they were resolved, or "None"]
109
-
110
- [Note: "Deviations from Plan" documents unplanned work that was handled automatically via deviation rules. "Issues Encountered" documents problems during planned work that required problem-solving.]
111
-
112
- ## User Setup Required
113
-
114
- [If USER-SETUP.md was generated:]
115
- **External services require manual configuration.** See [{phase}-USER-SETUP.md](./{phase}-USER-SETUP.md) for:
116
- - Environment variables to add
117
- - Dashboard configuration steps
118
- - Verification commands
119
-
120
- [If no USER-SETUP.md:]
121
- None - no external service configuration required.
122
-
123
- ## Next Phase Readiness
124
- [What's ready for next phase]
125
- [Any blockers or concerns]
126
-
127
- ---
128
- *Phase: XX-name*
129
- *Completed: [date]*
130
- ```
131
-
132
- <frontmatter_guidance>
133
- **Purpose:** Enable automatic context assembly via dependency graph. Frontmatter makes summary metadata machine-readable so plan-phase can scan all summaries quickly and select relevant ones based on dependencies.
134
-
135
- **Fast scanning:** Frontmatter is first ~25 lines, cheap to scan across all summaries without reading full content.
136
-
137
- **Dependency graph:** `requires`/`provides`/`affects` create explicit links between phases, enabling transitive closure for context selection.
138
-
139
- **Subsystem:** Primary categorization (auth, payments, ui, api, database, infra, testing) for detecting related phases.
140
-
141
- **Tags:** Searchable technical keywords (libraries, frameworks, tools) for tech stack awareness.
142
-
143
- **Key-files:** Important files for @context references in PLAN.md.
144
-
145
- **Patterns:** Established conventions future phases should maintain.
146
-
147
- **Population:** Frontmatter is populated during summary creation in execute-plan.md. See `<step name="create_summary">` for field-by-field guidance.
148
- </frontmatter_guidance>
149
-
150
- <one_liner_rules>
151
- The one-liner MUST be substantive:
152
-
153
- **Good:**
154
- - "JWT auth with refresh rotation using jose library"
155
- - "Prisma schema with User, Session, and Product models"
156
- - "Dashboard with real-time metrics via Server-Sent Events"
157
-
158
- **Bad:**
159
- - "Phase complete"
160
- - "Authentication implemented"
161
- - "Foundation finished"
162
- - "All tasks done"
163
-
164
- The one-liner should tell someone what actually shipped.
165
- </one_liner_rules>
166
-
167
- <example>
168
- ```markdown
169
- # Phase 1: Foundation Summary
170
-
171
- **JWT auth with refresh rotation using jose library, Prisma User model, and protected API middleware**
172
-
173
- ## Performance
174
-
175
- - **Duration:** 28 min
176
- - **Started:** 2025-01-15T14:22:10Z
177
- - **Completed:** 2025-01-15T14:50:33Z
178
- - **Tasks:** 5
179
- - **Files modified:** 8
180
-
181
- ## Accomplishments
182
- - User model with email/password auth
183
- - Login/logout endpoints with httpOnly JWT cookies
184
- - Protected route middleware checking token validity
185
- - Refresh token rotation on each request
186
-
187
- ## Files Created/Modified
188
- - `prisma/schema.prisma` - User and Session models
189
- - `src/app/api/auth/login/route.ts` - Login endpoint
190
- - `src/app/api/auth/logout/route.ts` - Logout endpoint
191
- - `src/middleware.ts` - Protected route checks
192
- - `src/lib/auth.ts` - JWT helpers using jose
193
-
194
- ## Decisions Made
195
- - Used jose instead of jsonwebtoken (ESM-native, Edge-compatible)
196
- - 15-min access tokens with 7-day refresh tokens
197
- - Storing refresh tokens in database for revocation capability
198
-
199
- ## Deviations from Plan
200
-
201
- ### Auto-fixed Issues
202
-
203
- **1. [Rule 2 - Missing Critical] Added password hashing with bcrypt**
204
- - **Found during:** Task 2 (Login endpoint implementation)
205
- - **Issue:** Plan didn't specify password hashing - storing plaintext would be critical security flaw
206
- - **Fix:** Added bcrypt hashing on registration, comparison on login with salt rounds 10
207
- - **Files modified:** src/app/api/auth/login/route.ts, src/lib/auth.ts
208
- - **Verification:** Password hash test passes, plaintext never stored
209
- - **Committed in:** abc123f (Task 2 commit)
210
-
211
- **2. [Rule 3 - Blocking] Installed missing jose dependency**
212
- - **Found during:** Task 4 (JWT token generation)
213
- - **Issue:** jose package not in package.json, import failing
214
- - **Fix:** Ran `npm install jose`
215
- - **Files modified:** package.json, package-lock.json
216
- - **Verification:** Import succeeds, build passes
217
- - **Committed in:** def456g (Task 4 commit)
218
-
219
- ---
220
-
221
- **Total deviations:** 2 auto-fixed (1 missing critical, 1 blocking)
222
- **Impact on plan:** Both auto-fixes essential for security and functionality. No scope creep.
223
-
224
- ## Issues Encountered
225
- - jsonwebtoken CommonJS import failed in Edge runtime - switched to jose (planned library change, worked as expected)
226
-
227
- ## Next Phase Readiness
228
- - Auth foundation complete, ready for feature development
229
- - User registration endpoint needed before public launch
230
-
231
- ---
232
- *Phase: 01-foundation*
233
- *Completed: 2025-01-15*
234
- ```
235
- </example>
236
-
237
- <guidelines>
238
- **Frontmatter:** MANDATORY - complete all fields. Enables automatic context assembly for future planning.
239
-
240
- **One-liner:** Must be substantive. "JWT auth with refresh rotation using jose library" not "Authentication implemented".
241
-
242
- **Decisions section:**
243
- - Key decisions made during execution with rationale
244
- - Extracted to STATE.md accumulated context
245
- - Use "None - followed plan as specified" if no deviations
246
-
247
- **After creation:** STATE.md updated with position, decisions, issues.
248
- </guidelines>
1
+ # Summary Template
2
+
3
+ Template for `.planning/phases/XX-name/{phase}-{plan}-SUMMARY.md` - phase completion documentation.
4
+
5
+ ---
6
+
7
+ ## File Template
8
+
9
+ ```markdown
10
+ ---
11
+ phase: XX-name
12
+ plan: YY
13
+ subsystem: [primary category: auth, payments, ui, api, database, infra, testing, etc.]
14
+ tags: [searchable tech: jwt, stripe, react, postgres, prisma]
15
+
16
+ # Dependency graph
17
+ requires:
18
+ - phase: [prior phase this depends on]
19
+ provides: [what that phase built that this uses]
20
+ provides:
21
+ - [bullet list of what this phase built/delivered]
22
+ affects: [list of phase names or keywords that will need this context]
23
+
24
+ # Tech tracking
25
+ tech-stack:
26
+ added: [libraries/tools added in this phase]
27
+ patterns: [architectural/code patterns established]
28
+
29
+ key-files:
30
+ created: [important files created]
31
+ modified: [important files modified]
32
+
33
+ key-decisions:
34
+ - "Decision 1"
35
+ - "Decision 2"
36
+
37
+ patterns-established:
38
+ - "Pattern 1: description"
39
+ - "Pattern 2: description"
40
+
41
+ requirements-completed: [] # REQUIRED — Copy ALL requirement IDs from this plan's `requirements` frontmatter field.
42
+
43
+ # Metrics
44
+ duration: Xmin
45
+ completed: YYYY-MM-DD
46
+ ---
47
+
48
+ # Phase [X]: [Name] Summary
49
+
50
+ **[Substantive one-liner describing outcome - NOT "phase complete" or "implementation finished"]**
51
+
52
+ ## Performance
53
+
54
+ - **Duration:** [time] (e.g., 23 min, 1h 15m)
55
+ - **Started:** [ISO timestamp]
56
+ - **Completed:** [ISO timestamp]
57
+ - **Tasks:** [count completed]
58
+ - **Files modified:** [count]
59
+
60
+ ## Accomplishments
61
+ - [Most important outcome]
62
+ - [Second key accomplishment]
63
+ - [Third if applicable]
64
+
65
+ ## Task Commits
66
+
67
+ Each task was committed atomically:
68
+
69
+ 1. **Task 1: [task name]** - `abc123f` (feat/fix/test/refactor)
70
+ 2. **Task 2: [task name]** - `def456g` (feat/fix/test/refactor)
71
+ 3. **Task 3: [task name]** - `hij789k` (feat/fix/test/refactor)
72
+
73
+ **Plan metadata:** `lmn012o` (docs: complete plan)
74
+
75
+ _Note: TDD tasks may have multiple commits (test → feat → refactor)_
76
+
77
+ ## Files Created/Modified
78
+ - `path/to/file.ts` - What it does
79
+ - `path/to/another.ts` - What it does
80
+
81
+ ## Decisions Made
82
+ [Key decisions with brief rationale, or "None - followed plan as specified"]
83
+
84
+ ## Deviations from Plan
85
+
86
+ [If no deviations: "None - plan executed exactly as written"]
87
+
88
+ [If deviations occurred:]
89
+
90
+ ### Auto-fixed Issues
91
+
92
+ **1. [Rule X - Category] Brief description**
93
+ - **Found during:** Task [N] ([task name])
94
+ - **Issue:** [What was wrong]
95
+ - **Fix:** [What was done]
96
+ - **Files modified:** [file paths]
97
+ - **Verification:** [How it was verified]
98
+ - **Committed in:** [hash] (part of task commit)
99
+
100
+ [... repeat for each auto-fix ...]
101
+
102
+ ---
103
+
104
+ **Total deviations:** [N] auto-fixed ([breakdown by rule])
105
+ **Impact on plan:** [Brief assessment - e.g., "All auto-fixes necessary for correctness/security. No scope creep."]
106
+
107
+ ## Issues Encountered
108
+ [Problems and how they were resolved, or "None"]
109
+
110
+ [Note: "Deviations from Plan" documents unplanned work that was handled automatically via deviation rules. "Issues Encountered" documents problems during planned work that required problem-solving.]
111
+
112
+ ## User Setup Required
113
+
114
+ [If USER-SETUP.md was generated:]
115
+ **External services require manual configuration.** See [{phase}-USER-SETUP.md](./{phase}-USER-SETUP.md) for:
116
+ - Environment variables to add
117
+ - Dashboard configuration steps
118
+ - Verification commands
119
+
120
+ [If no USER-SETUP.md:]
121
+ None - no external service configuration required.
122
+
123
+ ## Next Phase Readiness
124
+ [What's ready for next phase]
125
+ [Any blockers or concerns]
126
+
127
+ ---
128
+ *Phase: XX-name*
129
+ *Completed: [date]*
130
+ ```
131
+
132
+ <frontmatter_guidance>
133
+ **Purpose:** Enable automatic context assembly via dependency graph. Frontmatter makes summary metadata machine-readable so plan-phase can scan all summaries quickly and select relevant ones based on dependencies.
134
+
135
+ **Fast scanning:** Frontmatter is first ~25 lines, cheap to scan across all summaries without reading full content.
136
+
137
+ **Dependency graph:** `requires`/`provides`/`affects` create explicit links between phases, enabling transitive closure for context selection.
138
+
139
+ **Subsystem:** Primary categorization (auth, payments, ui, api, database, infra, testing) for detecting related phases.
140
+
141
+ **Tags:** Searchable technical keywords (libraries, frameworks, tools) for tech stack awareness.
142
+
143
+ **Key-files:** Important files for @context references in PLAN.md.
144
+
145
+ **Patterns:** Established conventions future phases should maintain.
146
+
147
+ **Population:** Frontmatter is populated during summary creation in execute-plan.md. See `<step name="create_summary">` for field-by-field guidance.
148
+ </frontmatter_guidance>
149
+
150
+ <one_liner_rules>
151
+ The one-liner MUST be substantive:
152
+
153
+ **Good:**
154
+ - "JWT auth with refresh rotation using jose library"
155
+ - "Prisma schema with User, Session, and Product models"
156
+ - "Dashboard with real-time metrics via Server-Sent Events"
157
+
158
+ **Bad:**
159
+ - "Phase complete"
160
+ - "Authentication implemented"
161
+ - "Foundation finished"
162
+ - "All tasks done"
163
+
164
+ The one-liner should tell someone what actually shipped.
165
+ </one_liner_rules>
166
+
167
+ <example>
168
+ ```markdown
169
+ # Phase 1: Foundation Summary
170
+
171
+ **JWT auth with refresh rotation using jose library, Prisma User model, and protected API middleware**
172
+
173
+ ## Performance
174
+
175
+ - **Duration:** 28 min
176
+ - **Started:** 2025-01-15T14:22:10Z
177
+ - **Completed:** 2025-01-15T14:50:33Z
178
+ - **Tasks:** 5
179
+ - **Files modified:** 8
180
+
181
+ ## Accomplishments
182
+ - User model with email/password auth
183
+ - Login/logout endpoints with httpOnly JWT cookies
184
+ - Protected route middleware checking token validity
185
+ - Refresh token rotation on each request
186
+
187
+ ## Files Created/Modified
188
+ - `prisma/schema.prisma` - User and Session models
189
+ - `src/app/api/auth/login/route.ts` - Login endpoint
190
+ - `src/app/api/auth/logout/route.ts` - Logout endpoint
191
+ - `src/middleware.ts` - Protected route checks
192
+ - `src/lib/auth.ts` - JWT helpers using jose
193
+
194
+ ## Decisions Made
195
+ - Used jose instead of jsonwebtoken (ESM-native, Edge-compatible)
196
+ - 15-min access tokens with 7-day refresh tokens
197
+ - Storing refresh tokens in database for revocation capability
198
+
199
+ ## Deviations from Plan
200
+
201
+ ### Auto-fixed Issues
202
+
203
+ **1. [Rule 2 - Missing Critical] Added password hashing with bcrypt**
204
+ - **Found during:** Task 2 (Login endpoint implementation)
205
+ - **Issue:** Plan didn't specify password hashing - storing plaintext would be critical security flaw
206
+ - **Fix:** Added bcrypt hashing on registration, comparison on login with salt rounds 10
207
+ - **Files modified:** src/app/api/auth/login/route.ts, src/lib/auth.ts
208
+ - **Verification:** Password hash test passes, plaintext never stored
209
+ - **Committed in:** abc123f (Task 2 commit)
210
+
211
+ **2. [Rule 3 - Blocking] Installed missing jose dependency**
212
+ - **Found during:** Task 4 (JWT token generation)
213
+ - **Issue:** jose package not in package.json, import failing
214
+ - **Fix:** Ran `npm install jose`
215
+ - **Files modified:** package.json, package-lock.json
216
+ - **Verification:** Import succeeds, build passes
217
+ - **Committed in:** def456g (Task 4 commit)
218
+
219
+ ---
220
+
221
+ **Total deviations:** 2 auto-fixed (1 missing critical, 1 blocking)
222
+ **Impact on plan:** Both auto-fixes essential for security and functionality. No scope creep.
223
+
224
+ ## Issues Encountered
225
+ - jsonwebtoken CommonJS import failed in Edge runtime - switched to jose (planned library change, worked as expected)
226
+
227
+ ## Next Phase Readiness
228
+ - Auth foundation complete, ready for feature development
229
+ - User registration endpoint needed before public launch
230
+
231
+ ---
232
+ *Phase: 01-foundation*
233
+ *Completed: 2025-01-15*
234
+ ```
235
+ </example>
236
+
237
+ <guidelines>
238
+ **Frontmatter:** MANDATORY - complete all fields. Enables automatic context assembly for future planning.
239
+
240
+ **One-liner:** Must be substantive. "JWT auth with refresh rotation using jose library" not "Authentication implemented".
241
+
242
+ **Decisions section:**
243
+ - Key decisions made during execution with rationale
244
+ - Extracted to STATE.md accumulated context
245
+ - Use "None - followed plan as specified" if no deviations
246
+
247
+ **After creation:** STATE.md updated with position, decisions, issues.
248
+ </guidelines>