@izkac/forgekit 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/forge.mjs +100 -0
- package/bin/forgekit.mjs +84 -0
- package/bin/review.mjs +82 -0
- package/package.json +46 -0
- package/scripts/prepack.mjs +78 -0
- package/scripts/run-tests.mjs +43 -0
- package/src/adr.mjs +236 -0
- package/src/adr.test.mjs +170 -0
- package/src/change.mjs +234 -0
- package/src/change.test.mjs +83 -0
- package/src/cleanup-sessions.mjs +70 -0
- package/src/config.mjs +103 -0
- package/src/defer.mjs +75 -0
- package/src/doctor.mjs +341 -0
- package/src/doctor.test.mjs +114 -0
- package/src/init.mjs +575 -0
- package/src/install.mjs +777 -0
- package/src/install.test.mjs +104 -0
- package/src/integrity-check.mjs +58 -0
- package/src/integrity.mjs +317 -0
- package/src/integrity.test.mjs +296 -0
- package/src/lib/workspaces.mjs +55 -0
- package/src/lib.mjs +138 -0
- package/src/models.defaults.json +41 -0
- package/src/new-session.mjs +82 -0
- package/src/openspec-overlays/README.md +19 -0
- package/src/openspec-overlays/openspec-apply-change-footer.md +14 -0
- package/src/openspec-overlays/opsx-apply-completion-step.md +1 -0
- package/src/openspec-overlays/opsx-apply-implement-step.md +11 -0
- package/src/paths.mjs +92 -0
- package/src/plan-engine.mjs +260 -0
- package/src/plan-engine.test.mjs +245 -0
- package/src/preferences.defaults.json +78 -0
- package/src/preferences.mjs +438 -0
- package/src/preferences.test.mjs +174 -0
- package/src/record-evidence.mjs +204 -0
- package/src/record-evidence.test.mjs +260 -0
- package/src/resolve-model.mjs +312 -0
- package/src/resolve-model.test.mjs +194 -0
- package/src/review/carryforward.mjs +413 -0
- package/src/review/carryforward.test.mjs +587 -0
- package/src/review/cli.test.mjs +117 -0
- package/src/review/export.mjs +172 -0
- package/src/review/export.test.mjs +197 -0
- package/src/review/fixtures/valid-review.json +42 -0
- package/src/review/lib.mjs +894 -0
- package/src/review/lib.test.mjs +266 -0
- package/src/review/merge-tentative.mjs +292 -0
- package/src/review/merge-tentative.test.mjs +363 -0
- package/src/review/new-review.mjs +200 -0
- package/src/review/render.mjs +108 -0
- package/src/review/schema-consistency.test.mjs +83 -0
- package/src/review/schema.json +196 -0
- package/src/review/signals.mjs +144 -0
- package/src/review/signals.test.mjs +62 -0
- package/src/score-cli.mjs +68 -0
- package/src/score.mjs +489 -0
- package/src/score.test.mjs +253 -0
- package/src/session-reminder.mjs +168 -0
- package/src/session-status.mjs +70 -0
- package/src/set-models.mjs +186 -0
- package/src/set-phase.mjs +177 -0
- package/src/set-phase.test.mjs +317 -0
- package/src/set-prefs.mjs +294 -0
- package/src/spine.mjs +91 -0
- package/src/triage-prompt.mjs +175 -0
- package/src/triage-prompt.test.mjs +50 -0
- package/src/vendor-openspec-overlays.mjs +176 -0
- package/src/vendor-openspec-overlays.test.mjs +62 -0
- package/vendor/skills/archive-to-adr/SKILL.md +149 -0
- package/vendor/skills/forge/SKILL.md +136 -0
- package/vendor/skills/forge/phases/brainstorm.md +23 -0
- package/vendor/skills/forge/phases/finish.md +87 -0
- package/vendor/skills/forge/phases/implement.md +76 -0
- package/vendor/skills/forge/phases/plan-openspec.md +40 -0
- package/vendor/skills/forge/phases/plan-specs.md +97 -0
- package/vendor/skills/forge/phases/review.md +25 -0
- package/vendor/skills/forge/phases/verify.md +120 -0
- package/vendor/skills/forge/references/forge-layout.md +85 -0
- package/vendor/skills/forge/references/pace.md +115 -0
- package/vendor/skills/forge/references/plan-routing.md +51 -0
- package/vendor/skills/forge/references/runtime-integrity.md +157 -0
- package/vendor/skills/forge/references/substantial-work.md +37 -0
- package/vendor/skills/forge/references/tdd-core.md +29 -0
- package/vendor/skills/forge/references/test-evidence.md +30 -0
- package/vendor/skills/forge/references/test-strategy.md +68 -0
- package/vendor/skills/forge/skills/NOTICE.md +17 -0
- package/vendor/skills/forge/skills/brainstorming/SKILL.md +120 -0
- package/vendor/skills/forge/skills/requesting-code-review/SKILL.md +67 -0
- package/vendor/skills/forge/skills/requesting-code-review/code-reviewer.md +146 -0
- package/vendor/skills/forge/skills/subagent-driven-development/SKILL.md +87 -0
- package/vendor/skills/forge/skills/systematic-debugging/SKILL.md +234 -0
- package/vendor/skills/forge/skills/systematic-debugging/condition-based-waiting.md +115 -0
- package/vendor/skills/forge/skills/systematic-debugging/defense-in-depth.md +122 -0
- package/vendor/skills/forge/skills/systematic-debugging/find-polluter.sh +63 -0
- package/vendor/skills/forge/skills/systematic-debugging/root-cause-tracing.md +169 -0
- package/vendor/skills/forge/skills/test-driven-development/SKILL.md +290 -0
- package/vendor/skills/forge/skills/test-driven-development/testing-anti-patterns.md +299 -0
- package/vendor/skills/forge/skills/verification-before-completion/SKILL.md +59 -0
- package/vendor/skills/forge/subagents/final-reviewer-prompt.md +53 -0
- package/vendor/skills/forge/subagents/implementer-prompt.md +38 -0
- package/vendor/skills/forge/subagents/task-reviewer-prompt.md +61 -0
- package/vendor/skills/git-resolve-adr-conflict/SKILL.md +132 -0
- package/vendor/skills/thorough-code-review/SKILL.md +290 -0
- package/vendor/skills/thorough-code-review/examples/accepted-risks-janus.md +32 -0
- package/vendor/skills/thorough-code-review/examples.md +133 -0
- package/vendor/skills/thorough-code-review/reference/accepted-risks.md +26 -0
- package/vendor/skills/thorough-code-review/reference/lenses.md +96 -0
- package/vendor/skills/thorough-code-review/reference/phase1-scout.md +62 -0
- package/vendor/skills/thorough-code-review/reference/phase1c-coverage.md +44 -0
- package/vendor/skills/thorough-code-review/reference/phase2-skeptic.md +105 -0
- package/vendor/skills/thorough-code-review/reference/report-schema.json +222 -0
- package/vendor/skills/thorough-code-review/reference/report-template.md +115 -0
- package/vendor/skills/thorough-code-review/reference/severity-rubric.md +49 -0
- package/vendor/skills/thorough-code-review/reference/signals-preflight.md +55 -0
- package/vendor/templates/adr/README.md +7 -0
- package/vendor/templates/adr/decisions.md +141 -0
- package/vendor/templates/adr/hooks/check-pending-adrs.mjs +74 -0
- package/vendor/templates/adr/hooks/check-pending-adrs.sh +3 -0
- package/vendor/templates/adr/hooks/openspec-archive-agent-message.mjs +52 -0
- package/vendor/templates/adr/hooks/openspec-archive-agent-message.sh +3 -0
- package/vendor/templates/project/claude/commands/forge-apply.md +75 -0
- package/vendor/templates/project/claude/commands/forge-brainstorm.md +7 -0
- package/vendor/templates/project/claude/commands/forge-build.md +17 -0
- package/vendor/templates/project/claude/commands/forge-plan.md +12 -0
- package/vendor/templates/project/claude/commands/forge-skip.md +14 -0
- package/vendor/templates/project/claude/commands/forge-status.md +16 -0
- package/vendor/templates/project/claude/commands/forge.md +16 -0
- package/vendor/templates/project/claude/hooks/forge-prompt-hook.mjs +73 -0
- package/vendor/templates/project/claude/hooks/forge-session-start.mjs +19 -0
- package/vendor/templates/project/claude/hooks/forge-triage-hook.mjs +77 -0
- package/vendor/templates/project/claude/rules/forge.md +16 -0
- package/vendor/templates/project/codex/rules/forge.md +10 -0
- package/vendor/templates/project/cursor/commands/forge-apply.md +75 -0
- package/vendor/templates/project/cursor/commands/forge-brainstorm.md +10 -0
- package/vendor/templates/project/cursor/commands/forge-build.md +17 -0
- package/vendor/templates/project/cursor/commands/forge-plan.md +15 -0
- package/vendor/templates/project/cursor/commands/forge-skip.md +14 -0
- package/vendor/templates/project/cursor/commands/forge-status.md +16 -0
- package/vendor/templates/project/cursor/commands/forge.md +16 -0
- package/vendor/templates/project/cursor/hooks/forge-session-start.mjs +30 -0
- package/vendor/templates/project/cursor/hooks/forge-session-start.sh +3 -0
- package/vendor/templates/project/cursor/rules/forge.mdc +21 -0
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# Root Cause Tracing
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Bugs often manifest deep in the call stack (git init in wrong directory, file created in wrong location, database opened with wrong path). Your instinct is to fix where the error appears, but that's treating a symptom.
|
|
6
|
+
|
|
7
|
+
**Core principle:** Trace backward through the call chain until you find the original trigger, then fix at the source.
|
|
8
|
+
|
|
9
|
+
## When to Use
|
|
10
|
+
|
|
11
|
+
```dot
|
|
12
|
+
digraph when_to_use {
|
|
13
|
+
"Bug appears deep in stack?" [shape=diamond];
|
|
14
|
+
"Can trace backwards?" [shape=diamond];
|
|
15
|
+
"Fix at symptom point" [shape=box];
|
|
16
|
+
"Trace to original trigger" [shape=box];
|
|
17
|
+
"BETTER: Also add defense-in-depth" [shape=box];
|
|
18
|
+
|
|
19
|
+
"Bug appears deep in stack?" -> "Can trace backwards?" [label="yes"];
|
|
20
|
+
"Can trace backwards?" -> "Trace to original trigger" [label="yes"];
|
|
21
|
+
"Can trace backwards?" -> "Fix at symptom point" [label="no - dead end"];
|
|
22
|
+
"Trace to original trigger" -> "BETTER: Also add defense-in-depth";
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
**Use when:**
|
|
27
|
+
- Error happens deep in execution (not at entry point)
|
|
28
|
+
- Stack trace shows long call chain
|
|
29
|
+
- Unclear where invalid data originated
|
|
30
|
+
- Need to find which test/code triggers the problem
|
|
31
|
+
|
|
32
|
+
## The Tracing Process
|
|
33
|
+
|
|
34
|
+
### 1. Observe the Symptom
|
|
35
|
+
```
|
|
36
|
+
Error: git init failed in /Users/jesse/project/packages/core
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### 2. Find Immediate Cause
|
|
40
|
+
**What code directly causes this?**
|
|
41
|
+
```typescript
|
|
42
|
+
await execFileAsync('git', ['init'], { cwd: projectDir });
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### 3. Ask: What Called This?
|
|
46
|
+
```typescript
|
|
47
|
+
WorktreeManager.createSessionWorktree(projectDir, sessionId)
|
|
48
|
+
→ called by Session.initializeWorkspace()
|
|
49
|
+
→ called by Session.create()
|
|
50
|
+
→ called by test at Project.create()
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### 4. Keep Tracing Up
|
|
54
|
+
**What value was passed?**
|
|
55
|
+
- `projectDir = ''` (empty string!)
|
|
56
|
+
- Empty string as `cwd` resolves to `process.cwd()`
|
|
57
|
+
- That's the source code directory!
|
|
58
|
+
|
|
59
|
+
### 5. Find Original Trigger
|
|
60
|
+
**Where did empty string come from?**
|
|
61
|
+
```typescript
|
|
62
|
+
const context = setupCoreTest(); // Returns { tempDir: '' }
|
|
63
|
+
Project.create('name', context.tempDir); // Accessed before beforeEach!
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Adding Stack Traces
|
|
67
|
+
|
|
68
|
+
When you can't trace manually, add instrumentation:
|
|
69
|
+
|
|
70
|
+
```typescript
|
|
71
|
+
// Before the problematic operation
|
|
72
|
+
async function gitInit(directory: string) {
|
|
73
|
+
const stack = new Error().stack;
|
|
74
|
+
console.error('DEBUG git init:', {
|
|
75
|
+
directory,
|
|
76
|
+
cwd: process.cwd(),
|
|
77
|
+
nodeEnv: process.env.NODE_ENV,
|
|
78
|
+
stack,
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
await execFileAsync('git', ['init'], { cwd: directory });
|
|
82
|
+
}
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
**Critical:** Use `console.error()` in tests (not logger - may not show)
|
|
86
|
+
|
|
87
|
+
**Run and capture:**
|
|
88
|
+
```bash
|
|
89
|
+
npm test 2>&1 | grep 'DEBUG git init'
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
**Analyze stack traces:**
|
|
93
|
+
- Look for test file names
|
|
94
|
+
- Find the line number triggering the call
|
|
95
|
+
- Identify the pattern (same test? same parameter?)
|
|
96
|
+
|
|
97
|
+
## Finding Which Test Causes Pollution
|
|
98
|
+
|
|
99
|
+
If something appears during tests but you don't know which test:
|
|
100
|
+
|
|
101
|
+
Use the bisection script `find-polluter.sh` in this directory:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
./find-polluter.sh '.git' 'src/**/*.test.ts'
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
Runs tests one-by-one, stops at first polluter. See script for usage.
|
|
108
|
+
|
|
109
|
+
## Real Example: Empty projectDir
|
|
110
|
+
|
|
111
|
+
**Symptom:** `.git` created in `packages/core/` (source code)
|
|
112
|
+
|
|
113
|
+
**Trace chain:**
|
|
114
|
+
1. `git init` runs in `process.cwd()` ← empty cwd parameter
|
|
115
|
+
2. WorktreeManager called with empty projectDir
|
|
116
|
+
3. Session.create() passed empty string
|
|
117
|
+
4. Test accessed `context.tempDir` before beforeEach
|
|
118
|
+
5. setupCoreTest() returns `{ tempDir: '' }` initially
|
|
119
|
+
|
|
120
|
+
**Root cause:** Top-level variable initialization accessing empty value
|
|
121
|
+
|
|
122
|
+
**Fix:** Made tempDir a getter that throws if accessed before beforeEach
|
|
123
|
+
|
|
124
|
+
**Also added defense-in-depth:**
|
|
125
|
+
- Layer 1: Project.create() validates directory
|
|
126
|
+
- Layer 2: WorkspaceManager validates not empty
|
|
127
|
+
- Layer 3: NODE_ENV guard refuses git init outside tmpdir
|
|
128
|
+
- Layer 4: Stack trace logging before git init
|
|
129
|
+
|
|
130
|
+
## Key Principle
|
|
131
|
+
|
|
132
|
+
```dot
|
|
133
|
+
digraph principle {
|
|
134
|
+
"Found immediate cause" [shape=ellipse];
|
|
135
|
+
"Can trace one level up?" [shape=diamond];
|
|
136
|
+
"Trace backwards" [shape=box];
|
|
137
|
+
"Is this the source?" [shape=diamond];
|
|
138
|
+
"Fix at source" [shape=box];
|
|
139
|
+
"Add validation at each layer" [shape=box];
|
|
140
|
+
"Bug impossible" [shape=doublecircle];
|
|
141
|
+
"NEVER fix just the symptom" [shape=octagon, style=filled, fillcolor=red, fontcolor=white];
|
|
142
|
+
|
|
143
|
+
"Found immediate cause" -> "Can trace one level up?";
|
|
144
|
+
"Can trace one level up?" -> "Trace backwards" [label="yes"];
|
|
145
|
+
"Can trace one level up?" -> "NEVER fix just the symptom" [label="no"];
|
|
146
|
+
"Trace backwards" -> "Is this the source?";
|
|
147
|
+
"Is this the source?" -> "Trace backwards" [label="no - keeps going"];
|
|
148
|
+
"Is this the source?" -> "Fix at source" [label="yes"];
|
|
149
|
+
"Fix at source" -> "Add validation at each layer";
|
|
150
|
+
"Add validation at each layer" -> "Bug impossible";
|
|
151
|
+
}
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
**NEVER fix just where the error appears.** Trace back to find the original trigger.
|
|
155
|
+
|
|
156
|
+
## Stack Trace Tips
|
|
157
|
+
|
|
158
|
+
**In tests:** Use `console.error()` not logger - logger may be suppressed
|
|
159
|
+
**Before operation:** Log before the dangerous operation, not after it fails
|
|
160
|
+
**Include context:** Directory, cwd, environment variables, timestamps
|
|
161
|
+
**Capture stack:** `new Error().stack` shows complete call chain
|
|
162
|
+
|
|
163
|
+
## Real-World Impact
|
|
164
|
+
|
|
165
|
+
From debugging session (2025-10-03):
|
|
166
|
+
- Found root cause through 5-level trace
|
|
167
|
+
- Fixed at source (getter validation)
|
|
168
|
+
- Added 4 layers of defense
|
|
169
|
+
- 1847 tests passed, zero pollution
|
|
@@ -0,0 +1,290 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: test-driven-development
|
|
3
|
+
description: Forge — TDD during implement phase. Internal skill; read via forge orchestrator.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Test-Driven Development (TDD)
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
Write the test first. Watch it fail. Write minimal code to pass.
|
|
11
|
+
|
|
12
|
+
**Core principle:** If you didn't watch the test fail, you don't know if it tests the right thing.
|
|
13
|
+
|
|
14
|
+
**Violating the letter of the rules is violating the spirit of the rules.**
|
|
15
|
+
|
|
16
|
+
## Forge — tiered testing
|
|
17
|
+
|
|
18
|
+
Canonical tier model: [references/test-strategy.md](../../references/test-strategy.md). In short: tier 1 (scoped pattern) in the TDD loop, tier 2 (narrowest proof) at task done, tier 3 (full workspace) **once at verify** — never per task "to be safe."
|
|
19
|
+
|
|
20
|
+
## When to Use
|
|
21
|
+
|
|
22
|
+
**Always:**
|
|
23
|
+
- New features
|
|
24
|
+
- Bug fixes
|
|
25
|
+
- Refactoring
|
|
26
|
+
- Behavior changes
|
|
27
|
+
|
|
28
|
+
**Exceptions (ask your human partner):**
|
|
29
|
+
- Throwaway prototypes
|
|
30
|
+
- Generated code
|
|
31
|
+
- Configuration files
|
|
32
|
+
|
|
33
|
+
Thinking "skip TDD just this once"? Stop. That's rationalization.
|
|
34
|
+
|
|
35
|
+
## The Iron Law
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
NO PRODUCTION CODE WITHOUT A FAILING TEST FIRST
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Write code before the test? Delete it. Start over.
|
|
42
|
+
|
|
43
|
+
**No exceptions:**
|
|
44
|
+
- Don't keep it as "reference"
|
|
45
|
+
- Don't "adapt" it while writing tests
|
|
46
|
+
- Don't look at it
|
|
47
|
+
- Delete means delete
|
|
48
|
+
|
|
49
|
+
Implement fresh from tests. Period.
|
|
50
|
+
|
|
51
|
+
## Red-Green-Refactor
|
|
52
|
+
|
|
53
|
+
```dot
|
|
54
|
+
digraph tdd_cycle {
|
|
55
|
+
rankdir=LR;
|
|
56
|
+
red [label="RED\nWrite failing test", shape=box, style=filled, fillcolor="#ffcccc"];
|
|
57
|
+
verify_red [label="Verify fails\ncorrectly", shape=diamond];
|
|
58
|
+
green [label="GREEN\nMinimal code", shape=box, style=filled, fillcolor="#ccffcc"];
|
|
59
|
+
verify_green [label="Verify passes\nAll green", shape=diamond];
|
|
60
|
+
refactor [label="REFACTOR\nClean up", shape=box, style=filled, fillcolor="#ccccff"];
|
|
61
|
+
next [label="Next", shape=ellipse];
|
|
62
|
+
|
|
63
|
+
red -> verify_red;
|
|
64
|
+
verify_red -> green [label="yes"];
|
|
65
|
+
verify_red -> red [label="wrong\nfailure"];
|
|
66
|
+
green -> verify_green;
|
|
67
|
+
verify_green -> refactor [label="yes"];
|
|
68
|
+
verify_green -> green [label="no"];
|
|
69
|
+
refactor -> verify_green [label="stay\ngreen"];
|
|
70
|
+
verify_green -> next;
|
|
71
|
+
next -> red;
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### RED - Write Failing Test
|
|
76
|
+
|
|
77
|
+
Write one minimal test showing what should happen.
|
|
78
|
+
|
|
79
|
+
<Good>
|
|
80
|
+
```typescript
|
|
81
|
+
test('retries failed operations 3 times', async () => {
|
|
82
|
+
let attempts = 0;
|
|
83
|
+
const operation = () => {
|
|
84
|
+
attempts++;
|
|
85
|
+
if (attempts < 3) throw new Error('fail');
|
|
86
|
+
return 'success';
|
|
87
|
+
};
|
|
88
|
+
|
|
89
|
+
const result = await retryOperation(operation);
|
|
90
|
+
|
|
91
|
+
expect(result).toBe('success');
|
|
92
|
+
expect(attempts).toBe(3);
|
|
93
|
+
});
|
|
94
|
+
```
|
|
95
|
+
Clear name, tests real behavior, one thing
|
|
96
|
+
</Good>
|
|
97
|
+
|
|
98
|
+
<Bad>
|
|
99
|
+
```typescript
|
|
100
|
+
test('retry works', async () => {
|
|
101
|
+
const mock = jest.fn()
|
|
102
|
+
.mockRejectedValueOnce(new Error())
|
|
103
|
+
.mockRejectedValueOnce(new Error())
|
|
104
|
+
.mockResolvedValueOnce('success');
|
|
105
|
+
await retryOperation(mock);
|
|
106
|
+
expect(mock).toHaveBeenCalledTimes(3);
|
|
107
|
+
});
|
|
108
|
+
```
|
|
109
|
+
Vague name, tests mock not code
|
|
110
|
+
</Bad>
|
|
111
|
+
|
|
112
|
+
**Requirements:**
|
|
113
|
+
- One behavior
|
|
114
|
+
- Clear name
|
|
115
|
+
- Real code (no mocks unless unavoidable)
|
|
116
|
+
|
|
117
|
+
### Verify RED - Watch It Fail
|
|
118
|
+
|
|
119
|
+
**MANDATORY. Never skip.**
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
npm test path/to/test.test.ts
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Confirm:
|
|
126
|
+
- Test fails (not errors)
|
|
127
|
+
- Failure message is expected
|
|
128
|
+
- Fails because feature missing (not typos)
|
|
129
|
+
|
|
130
|
+
**Test passes?** You're testing existing behavior. Fix test.
|
|
131
|
+
|
|
132
|
+
**Test errors?** Fix error, re-run until it fails correctly.
|
|
133
|
+
|
|
134
|
+
### GREEN - Minimal Code
|
|
135
|
+
|
|
136
|
+
Write simplest code to pass the test.
|
|
137
|
+
|
|
138
|
+
<Good>
|
|
139
|
+
```typescript
|
|
140
|
+
async function retryOperation<T>(fn: () => Promise<T>): Promise<T> {
|
|
141
|
+
for (let i = 0; i < 3; i++) {
|
|
142
|
+
try {
|
|
143
|
+
return await fn();
|
|
144
|
+
} catch (e) {
|
|
145
|
+
if (i === 2) throw e;
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
throw new Error('unreachable');
|
|
149
|
+
}
|
|
150
|
+
```
|
|
151
|
+
Just enough to pass
|
|
152
|
+
</Good>
|
|
153
|
+
|
|
154
|
+
<Bad>
|
|
155
|
+
```typescript
|
|
156
|
+
async function retryOperation<T>(
|
|
157
|
+
fn: () => Promise<T>,
|
|
158
|
+
options?: {
|
|
159
|
+
maxRetries?: number;
|
|
160
|
+
backoff?: 'linear' | 'exponential';
|
|
161
|
+
onRetry?: (attempt: number) => void;
|
|
162
|
+
}
|
|
163
|
+
): Promise<T> {
|
|
164
|
+
// YAGNI
|
|
165
|
+
}
|
|
166
|
+
```
|
|
167
|
+
Over-engineered
|
|
168
|
+
</Bad>
|
|
169
|
+
|
|
170
|
+
Don't add features, refactor other code, or "improve" beyond the test.
|
|
171
|
+
|
|
172
|
+
### Verify GREEN - Watch It Pass
|
|
173
|
+
|
|
174
|
+
**MANDATORY.**
|
|
175
|
+
|
|
176
|
+
```bash
|
|
177
|
+
npm test path/to/test.test.ts
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
Confirm:
|
|
181
|
+
- Test passes
|
|
182
|
+
- Output pristine (no errors, warnings)
|
|
183
|
+
|
|
184
|
+
**Forge tier 1:** re-run the **same scoped file/pattern** — not the full workspace suite. If a directly related test in the same module fails, fix it now.
|
|
185
|
+
|
|
186
|
+
**Test fails?** Fix code, not test.
|
|
187
|
+
|
|
188
|
+
**Other tests fail?** Fix regressions you caused; stay scoped unless the failure is outside the changed module (then widen to that directory only — still not full workspace unless tier 2 requires it).
|
|
189
|
+
|
|
190
|
+
### REFACTOR - Clean Up
|
|
191
|
+
|
|
192
|
+
After green only:
|
|
193
|
+
- Remove duplication
|
|
194
|
+
- Improve names
|
|
195
|
+
- Extract helpers
|
|
196
|
+
|
|
197
|
+
Keep tests green. Don't add behavior.
|
|
198
|
+
|
|
199
|
+
### Repeat
|
|
200
|
+
|
|
201
|
+
Next failing test for next feature.
|
|
202
|
+
|
|
203
|
+
## Good Tests
|
|
204
|
+
|
|
205
|
+
| Quality | Good | Bad |
|
|
206
|
+
|---------|------|-----|
|
|
207
|
+
| **Minimal** | One thing. "and" in name? Split it. | `test('validates email and domain and whitespace')` |
|
|
208
|
+
| **Clear** | Name describes behavior | `test('test1')` |
|
|
209
|
+
| **Shows intent** | Demonstrates desired API | Obscures what code should do |
|
|
210
|
+
|
|
211
|
+
## Common Rationalizations
|
|
212
|
+
|
|
213
|
+
| Excuse | Reality |
|
|
214
|
+
|--------|---------|
|
|
215
|
+
| "Too simple to test" | Simple code breaks. Test takes 30 seconds. |
|
|
216
|
+
| "I'll test after" | Tests passing immediately prove nothing. |
|
|
217
|
+
| "Tests after achieve same goals" | Tests-after = "what does this do?" Tests-first = "what should this do?" |
|
|
218
|
+
| "Already manually tested" | Ad-hoc ≠ systematic. No record, can't re-run. |
|
|
219
|
+
| "Deleting X hours is wasteful" | Sunk cost fallacy. Keeping unverified code is technical debt. |
|
|
220
|
+
| "Keep as reference, write tests first" | You'll adapt it. That's testing after. Delete means delete. |
|
|
221
|
+
| "Need to explore first" | Fine. Throw away exploration, start with TDD. |
|
|
222
|
+
| "Test hard = design unclear" | Listen to test. Hard to test = hard to use. |
|
|
223
|
+
| "TDD will slow me down" | TDD faster than debugging. Pragmatic = test-first. |
|
|
224
|
+
| "Manual test faster" | Manual doesn't prove edge cases. You'll re-test every change. |
|
|
225
|
+
| "Existing code has no tests" | You're improving it. Add tests for existing code. |
|
|
226
|
+
| "Run full workspace every task to be safe" | Full workspace runs once at verify (tier 3). Per-task = scoped + narrow evidence. |
|
|
227
|
+
|
|
228
|
+
## Red Flags - STOP and Start Over
|
|
229
|
+
|
|
230
|
+
- Code before test
|
|
231
|
+
- Test after implementation
|
|
232
|
+
- Test passes immediately
|
|
233
|
+
- Can't explain why test failed
|
|
234
|
+
- Tests added "later"
|
|
235
|
+
- Rationalizing "just this once"
|
|
236
|
+
- "I already manually tested it"
|
|
237
|
+
- "Tests after achieve the same purpose"
|
|
238
|
+
- "It's about spirit not ritual"
|
|
239
|
+
- "Keep as reference" or "adapt existing code"
|
|
240
|
+
- "Already spent X hours, deleting is wasteful"
|
|
241
|
+
- "TDD is dogmatic, I'm being pragmatic"
|
|
242
|
+
- "This is different because..."
|
|
243
|
+
|
|
244
|
+
**All of these mean: Delete code. Start over with TDD.**
|
|
245
|
+
|
|
246
|
+
## Verification Checklist
|
|
247
|
+
|
|
248
|
+
Before marking work complete:
|
|
249
|
+
|
|
250
|
+
- [ ] Every new function/method has a test
|
|
251
|
+
- [ ] Watched each test fail before implementing
|
|
252
|
+
- [ ] Each test failed for expected reason (feature missing, not typo)
|
|
253
|
+
- [ ] Wrote minimal code to pass each test
|
|
254
|
+
- [ ] All tests pass
|
|
255
|
+
- [ ] Output pristine (no errors, warnings)
|
|
256
|
+
- [ ] Tests use real code (mocks only if unavoidable)
|
|
257
|
+
- [ ] Edge cases and errors covered
|
|
258
|
+
|
|
259
|
+
Can't check all boxes? You skipped TDD. Start over.
|
|
260
|
+
|
|
261
|
+
## When Stuck
|
|
262
|
+
|
|
263
|
+
| Problem | Solution |
|
|
264
|
+
|---------|----------|
|
|
265
|
+
| Don't know how to test | Write wished-for API. Write assertion first. Ask your human partner. |
|
|
266
|
+
| Test too complicated | Design too complicated. Simplify interface. |
|
|
267
|
+
| Must mock everything | Code too coupled. Use dependency injection. |
|
|
268
|
+
| Test setup huge | Extract helpers. Still complex? Simplify design. |
|
|
269
|
+
|
|
270
|
+
## Debugging Integration
|
|
271
|
+
|
|
272
|
+
Bug found? Write failing test reproducing it. Follow TDD cycle. Test proves fix and prevents regression.
|
|
273
|
+
|
|
274
|
+
Never fix bugs without a test.
|
|
275
|
+
|
|
276
|
+
## Testing Anti-Patterns
|
|
277
|
+
|
|
278
|
+
When adding mocks or test utilities, read ./testing-anti-patterns.md to avoid common pitfalls:
|
|
279
|
+
- Testing mock behavior instead of real behavior
|
|
280
|
+
- Adding test-only methods to production classes
|
|
281
|
+
- Mocking without understanding dependencies
|
|
282
|
+
|
|
283
|
+
## Final Rule
|
|
284
|
+
|
|
285
|
+
```
|
|
286
|
+
Production code → test exists and failed first
|
|
287
|
+
Otherwise → not TDD
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
No exceptions without your human partner's permission.
|