Cursor rule

1---
2alwaysApply: false
3---
4 
5# Code Generation - Detailed Steps
6 
7## Overview
8This stage generates code for each unit of work through two integrated parts:
9- **Part 1 - Planning**: Create detailed code generation plan with explicit steps
10- **Part 2 - Generation**: Execute approved plan to generate code, tests, and artifacts
11 
12**Note**: For brownfield projects, "generate" means modify existing files when appropriate, not create duplicates.
13 
14## Prerequisites
15- Unit Design Generation must be complete for the unit
16- NFR Implementation (if executed) must be complete for the unit
17- All unit design artifacts must be available
18- Unit is ready for code generation
19 
20---
21 
22# PART 1: PLANNING
23 
24## Step 1: Analyze Unit Context
25- [ ] Read unit design artifacts from Unit Design Generation
26- [ ] Read unit story map to understand assigned stories
27- [ ] Identify unit dependencies and interfaces
28- [ ] Validate unit is ready for code generation
29 
30## Step 2: Create Detailed Unit Code Generation Plan
31- [ ] Read workspace root and project type from `aidlc-docs/aidlc-state.md`
32- [ ] Determine code location (see Critical Rules for structure patterns)
33- [ ] **Brownfield only**: Review reverse engineering code-structure.md for existing files to modify
34- [ ] Document exact paths (never aidlc-docs/)
35- [ ] Create explicit steps for unit generation:
36  - Project Structure Setup (greenfield only)
37  - Business Logic Generation
38  - Business Logic Unit Testing
39  - Business Logic Summary
40  - API Layer Generation
41  - API Layer Unit Testing
42  - API Layer Summary
43  - Repository Layer Generation
44  - Repository Layer Unit Testing
45  - Repository Layer Summary
46  - Frontend Components Generation (if applicable)
47  - Frontend Components Unit Testing (if applicable)
48  - Frontend Components Summary (if applicable)
49  - Database Migration Scripts (if data models exist)
50  - Documentation Generation (API docs, README updates)
51  - Deployment Artifacts Generation
52- [ ] Number each step sequentially
53- [ ] Include story mapping references
54- [ ] Add checkboxes [ ] for each step
55 
56## Step 3: Include Unit Generation Context
57- [ ] For this unit, include:
58  - Stories implemented by this unit
59  - Dependencies on other units/services
60  - Expected interfaces and contracts
61  - Database entities owned by this unit
62  - Service boundaries and responsibilities
63 
64## Step 4: Create Unit Plan Document
65- [ ] Save complete plan as `aidlc-docs/construction/plans/{unit-name}-code-generation-plan.md`
66- [ ] Include step numbering (Step 1, Step 2, etc.)
67- [ ] Include unit context and dependencies
68- [ ] Include story traceability
69- [ ] Ensure plan is executable step-by-step
70- [ ] Emphasize that this plan is the single source of truth for Code Generation
71 
72## Step 5: Summarize Unit Plan
73- [ ] Provide summary of the unit code generation plan to the user
74- [ ] Highlight unit generation approach
75- [ ] Explain step sequence and story coverage
76- [ ] Note total number of steps and estimated scope
77 
78## Step 6: Log Approval Prompt
79- [ ] Before asking for approval, log the prompt with timestamp in `aidlc-docs/audit.md`
80- [ ] Include reference to the complete unit code generation plan
81- [ ] Use ISO 8601 timestamp format
82 
83## Step 7: Wait for Explicit Approval
84- [ ] Do not proceed until the user explicitly approves the unit code generation plan
85- [ ] Approval must cover the entire plan and generation sequence
86- [ ] If user requests changes, update the plan and repeat approval process
87 
88## Step 8: Record Approval Response
89- [ ] Log the user's approval response with timestamp in `aidlc-docs/audit.md`
90- [ ] Include the exact user response text
91- [ ] Mark the approval status clearly
92 
93## Step 9: Update Progress
94- [ ] Mark Code Generation Part 1 (Planning) complete in `aidlc-state.md`
95- [ ] Update the "Current Status" section
96- [ ] Prepare for transition to Code Generation
97 
98---
99 
100# PART 2: GENERATION
101 
102## Step 10: Load Unit Code Generation Plan
103- [ ] Read the complete plan from `aidlc-docs/construction/plans/{unit-name}-code-generation-plan.md`
104- [ ] Identify the next uncompleted step (first [ ] checkbox)
105- [ ] Load the context for that step (unit, dependencies, stories)
106 
107## Step 11: Execute Current Step
108- [ ] Verify target directory from plan (never aidlc-docs/)
109- [ ] **Brownfield only**: Check if target file exists
110- [ ] Generate exactly what the current step describes:
111  - **If file exists**: Modify it in-place (never create `ClassName_modified.java`, `ClassName_new.java`, etc.)
112  - **If file doesn't exist**: Create new file
113- [ ] Write to correct locations:
114  - **Application Code**: Workspace root per project structure
115  - **Documentation**: `aidlc-docs/construction/{unit-name}/code/` (markdown only)
116  - **Build/Config Files**: Workspace root
117- [ ] Follow unit story requirements
118- [ ] Respect dependencies and interfaces
119 
120## Step 12: Update Progress
121- [ ] Mark the completed step as [x] in the unit code generation plan
122- [ ] Mark associated unit stories as [x] when their generation is finished
123- [ ] Update `aidlc-docs/aidlc-state.md` current status
124- [ ] **Brownfield only**: Verify no duplicate files created (e.g., no `ClassName_modified.java` alongside `ClassName.java`)
125- [ ] Save all generated artifacts
126 
127## Step 13: Continue or Complete Generation
128- [ ] If more steps remain, return to Step 10
129- [ ] If all steps complete, proceed to present completion message
130 
131## Step 14: Present Completion Message
132- Present completion message in this structure:
133     1. **Completion Announcement** (mandatory): Always start with this:
134 
135```markdown
136# 💻 Code Generation Complete - [unit-name]
137```
138 
139     2. **AI Summary** (optional): Provide structured bullet-point summary
140        - **Brownfield**: Distinguish modified vs created files (e.g., "• Modified: `src/services/user-service.ts`", "• Created: `src/services/auth-service.ts`")
141        - **Greenfield**: List created files with paths (e.g., "• Created: `src/services/user-service.ts`")
142        - List tests, documentation, deployment artifacts with paths
143        - Keep factual, no workflow instructions
144     3. **Formatted Workflow Message** (mandatory): Always end with this exact format:
145 
146```markdown
147> **📋 <u>**REVIEW REQUIRED:**</u>**  
148> Please examine the generated code at:
149> - **Application Code**: `[actual-workspace-path]`
150> - **Documentation**: `aidlc-docs/construction/[unit-name]/code/`
151 
152 
153 
154> **🚀 <u>**WHAT'S NEXT?**</u>**
155>
156> **You may:**
157>
158> 🔧 **Request Changes** - Ask for modifications to the generated code based on your review  
159> ✅ **Continue to Next Stage** - Approve code generation and proceed to **[next-unit/Build & Test]**
160 
161---
162```
163 
164## Step 15: Wait for Explicit Approval
165- Do not proceed until the user explicitly approves the generated code
166- Approval must be clear and unambiguous
167- If user requests changes, update the code and repeat the approval process
168 
169## Step 16: Record Approval and Update Progress
170- Log approval in audit.md with timestamp
171- Record the user's approval response with timestamp
172- Mark Code Generation stage as complete for this unit in aidlc-state.md
173 
174---
175 
176## Critical Rules
177 
178### Code Location Rules
179- **Application code**: Workspace root only (NEVER aidlc-docs/)
180- **Documentation**: aidlc-docs/ only (markdown summaries)
181- **Read workspace root** from aidlc-state.md before generating code
182 
183**Structure patterns by project type**:
184- **Brownfield**: Use existing structure (e.g., `src/main/java/`, `lib/`, `pkg/`)
185- **Greenfield single unit**: `src/`, `tests/`, `config/` in workspace root
186- **Greenfield multi-unit (microservices)**: `{unit-name}/src/`, `{unit-name}/tests/`
187- **Greenfield multi-unit (monolith)**: `src/{unit-name}/`, `tests/{unit-name}/`
188 
189### Brownfield File Modification Rules
190- Check if file exists before generating
191- If exists: Modify in-place (never create copies like `ClassName_modified.java`)
192- If doesn't exist: Create new file
193- Verify no duplicate files after generation (Step 12)
194 
195### Planning Phase Rules
196- Create explicit, numbered steps for all generation activities
197- Include story traceability in the plan
198- Document unit context and dependencies
199- Get explicit user approval before generation
200 
201### Generation Phase Rules
202- **NO HARDCODED LOGIC**: Only execute what's written in the unit plan
203- **FOLLOW PLAN EXACTLY**: Do not deviate from the step sequence
204- **UPDATE CHECKBOXES**: Mark [x] immediately after completing each step
205- **STORY TRACEABILITY**: Mark unit stories [x] when functionality is implemented
206- **RESPECT DEPENDENCIES**: Only implement when unit dependencies are satisfied
207 
208### Automation Friendly Code Rules
209When generating UI code (web, mobile, desktop), ensure elements are automation-friendly:
210- Add `data-testid` attributes to interactive elements (buttons, inputs, links, forms)
211- Use consistent naming: `{component}-{element-role}` (e.g., `login-form-submit-button`, `user-list-search-input`)
212- Avoid dynamic or auto-generated IDs that change between renders
213- Keep `data-testid` values stable across code changes (only change when element purpose changes)
214 
215## Completion Criteria
216- Complete unit code generation plan created and approved
217- All steps in unit code generation plan marked [x]
218- All unit stories implemented according to plan
219- All code and tests generated (tests will be executed in Build & Test phase)
220- Deployment artifacts generated
221- Complete unit ready for build and verification
222