@tianhai/pi-workflow-kit 0.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 (54) hide show
  1. package/LICENSE +22 -0
  2. package/README.md +509 -0
  3. package/ROADMAP.md +16 -0
  4. package/agents/code-reviewer.md +18 -0
  5. package/agents/config.ts +5 -0
  6. package/agents/implementer.md +26 -0
  7. package/agents/spec-reviewer.md +13 -0
  8. package/agents/worker.md +17 -0
  9. package/banner.jpg +0 -0
  10. package/docs/developer-usage-guide.md +463 -0
  11. package/docs/oversight-model.md +49 -0
  12. package/docs/workflow-phases.md +71 -0
  13. package/extensions/constants.ts +9 -0
  14. package/extensions/lib/logging.ts +138 -0
  15. package/extensions/plan-tracker.ts +496 -0
  16. package/extensions/subagent/agents.ts +144 -0
  17. package/extensions/subagent/concurrency.ts +52 -0
  18. package/extensions/subagent/env.ts +47 -0
  19. package/extensions/subagent/index.ts +1116 -0
  20. package/extensions/subagent/lifecycle.ts +25 -0
  21. package/extensions/subagent/timeout.ts +13 -0
  22. package/extensions/workflow-monitor/debug-monitor.ts +98 -0
  23. package/extensions/workflow-monitor/git.ts +31 -0
  24. package/extensions/workflow-monitor/heuristics.ts +58 -0
  25. package/extensions/workflow-monitor/investigation.ts +52 -0
  26. package/extensions/workflow-monitor/reference-tool.ts +42 -0
  27. package/extensions/workflow-monitor/skip-confirmation.ts +19 -0
  28. package/extensions/workflow-monitor/tdd-monitor.ts +137 -0
  29. package/extensions/workflow-monitor/test-runner.ts +37 -0
  30. package/extensions/workflow-monitor/verification-monitor.ts +61 -0
  31. package/extensions/workflow-monitor/warnings.ts +81 -0
  32. package/extensions/workflow-monitor/workflow-handler.ts +358 -0
  33. package/extensions/workflow-monitor/workflow-tracker.ts +231 -0
  34. package/extensions/workflow-monitor/workflow-transitions.ts +55 -0
  35. package/extensions/workflow-monitor.ts +885 -0
  36. package/package.json +49 -0
  37. package/skills/brainstorming/SKILL.md +70 -0
  38. package/skills/dispatching-parallel-agents/SKILL.md +194 -0
  39. package/skills/executing-tasks/SKILL.md +247 -0
  40. package/skills/receiving-code-review/SKILL.md +196 -0
  41. package/skills/systematic-debugging/SKILL.md +170 -0
  42. package/skills/systematic-debugging/condition-based-waiting-example.ts +158 -0
  43. package/skills/systematic-debugging/condition-based-waiting.md +115 -0
  44. package/skills/systematic-debugging/defense-in-depth.md +122 -0
  45. package/skills/systematic-debugging/find-polluter.sh +63 -0
  46. package/skills/systematic-debugging/reference/rationalizations.md +61 -0
  47. package/skills/systematic-debugging/root-cause-tracing.md +169 -0
  48. package/skills/test-driven-development/SKILL.md +266 -0
  49. package/skills/test-driven-development/reference/examples.md +101 -0
  50. package/skills/test-driven-development/reference/rationalizations.md +67 -0
  51. package/skills/test-driven-development/reference/when-stuck.md +33 -0
  52. package/skills/test-driven-development/testing-anti-patterns.md +299 -0
  53. package/skills/using-git-worktrees/SKILL.md +231 -0
  54. package/skills/writing-plans/SKILL.md +149 -0
@@ -0,0 +1,101 @@
1
+ # TDD Examples Reference
2
+
3
+ **Load via:** `workflow_reference({ topic: "tdd-examples" })`
4
+
5
+ ## Good vs Bad Tests
6
+
7
+ ### RED — Write Failing Test
8
+
9
+ <Good>
10
+ ```typescript
11
+ test('retries failed operations 3 times', async () => {
12
+ let attempts = 0;
13
+ const operation = () => {
14
+ attempts++;
15
+ if (attempts < 3) throw new Error('fail');
16
+ return 'success';
17
+ };
18
+ const result = await retryOperation(operation);
19
+ expect(result).toBe('success');
20
+ expect(attempts).toBe(3);
21
+ });
22
+ ```
23
+ Clear name, tests real behavior, one thing
24
+ </Good>
25
+
26
+ <Bad>
27
+ ```typescript
28
+ test('retry works', async () => {
29
+ const mock = jest.fn()
30
+ .mockRejectedValueOnce(new Error())
31
+ .mockRejectedValueOnce(new Error())
32
+ .mockResolvedValueOnce('success');
33
+ await retryOperation(mock);
34
+ expect(mock).toHaveBeenCalledTimes(3);
35
+ });
36
+ ```
37
+ Vague name, tests mock not code
38
+ </Bad>
39
+
40
+ ### GREEN — Minimal Code
41
+
42
+ <Good>
43
+ ```typescript
44
+ async function retryOperation<T>(fn: () => Promise<T>): Promise<T> {
45
+ for (let i = 0; i < 3; i++) {
46
+ try { return await fn(); }
47
+ catch (e) { if (i === 2) throw e; }
48
+ }
49
+ throw new Error('unreachable');
50
+ }
51
+ ```
52
+ Just enough to pass
53
+ </Good>
54
+
55
+ <Bad>
56
+ ```typescript
57
+ async function retryOperation<T>(
58
+ fn: () => Promise<T>,
59
+ options?: { maxRetries?: number; backoff?: 'linear' | 'exponential'; onRetry?: (attempt: number) => void }
60
+ ): Promise<T> { /* YAGNI */ }
61
+ ```
62
+ Over-engineered
63
+ </Bad>
64
+
65
+ ## Good Tests Table
66
+
67
+ | Quality | Good | Bad |
68
+ |---------|------|-----|
69
+ | **Minimal** | One thing. "and" in name? Split it. | `test('validates email and domain and whitespace')` |
70
+ | **Clear** | Name describes behavior | `test('test1')` |
71
+ | **Shows intent** | Demonstrates desired API | Obscures what code should do |
72
+
73
+ ## Bug Fix Example
74
+
75
+ **Bug:** Empty email accepted
76
+
77
+ **RED**
78
+ ```typescript
79
+ test('rejects empty email', async () => {
80
+ const result = await submitForm({ email: '' });
81
+ expect(result.error).toBe('Email required');
82
+ });
83
+ ```
84
+
85
+ **Verify RED**
86
+ ```bash
87
+ $ npm test
88
+ FAIL: expected 'Email required', got undefined
89
+ ```
90
+
91
+ **GREEN**
92
+ ```typescript
93
+ function submitForm(data: FormData) {
94
+ if (!data.email?.trim()) return { error: 'Email required' };
95
+ // ...
96
+ }
97
+ ```
98
+
99
+ **Verify GREEN** → PASS
100
+
101
+ **REFACTOR** — Extract validation for multiple fields if needed.
@@ -0,0 +1,67 @@
1
+ # TDD Rationalizations Reference
2
+
3
+ **Load via:** `workflow_reference({ topic: "tdd-rationalizations" })`
4
+
5
+ ## Why Order Matters
6
+
7
+ **"I'll write tests after to verify it works"**
8
+ Tests written after code pass immediately. Passing immediately proves nothing:
9
+ - Might test wrong thing
10
+ - Might test implementation, not behavior
11
+ - Might miss edge cases you forgot
12
+ - You never saw it catch the bug
13
+
14
+ Test-first forces you to see the test fail, proving it actually tests something.
15
+
16
+ **"I already manually tested all the edge cases"**
17
+ Manual testing is ad-hoc. You think you tested everything but:
18
+ - No record of what you tested
19
+ - Can't re-run when code changes
20
+ - Easy to forget cases under pressure
21
+ - "It worked when I tried it" ≠ comprehensive
22
+
23
+ **"Deleting X hours of work is wasteful"**
24
+ Sunk cost fallacy. The time is already gone. Your choice:
25
+ - Delete and rewrite with TDD (X more hours, high confidence)
26
+ - Keep it and add tests after (30 min, low confidence, likely bugs)
27
+
28
+ **"TDD is dogmatic, being pragmatic means adapting"**
29
+ TDD IS pragmatic. "Pragmatic" shortcuts = debugging in production = slower.
30
+
31
+ **"Tests after achieve the same goals - it's spirit not ritual"**
32
+ Tests-after answer "What does this do?" Tests-first answer "What should this do?"
33
+ Tests-after are biased by your implementation. 30 minutes of tests after ≠ TDD.
34
+
35
+ ## Common Rationalizations Table
36
+
37
+ | Excuse | Reality |
38
+ |--------|---------|
39
+ | "Too simple to test" | Simple code breaks. Test takes 30 seconds. |
40
+ | "I'll test after" | Tests passing immediately prove nothing. |
41
+ | "Tests after achieve same goals" | Tests-after = "what does this do?" Tests-first = "what should this do?" |
42
+ | "Already manually tested" | Ad-hoc ≠ systematic. No record, can't re-run. |
43
+ | "Deleting X hours is wasteful" | Sunk cost fallacy. Keeping unverified code is technical debt. |
44
+ | "Keep as reference, write tests first" | You'll adapt it. That's testing after. Delete means delete. |
45
+ | "Need to explore first" | Fine. Throw away exploration, start with TDD. |
46
+ | "Test hard = design unclear" | Listen to test. Hard to test = hard to use. |
47
+ | "TDD will slow me down" | TDD faster than debugging. Pragmatic = test-first. |
48
+ | "Manual test faster" | Manual doesn't prove edge cases. You'll re-test every change. |
49
+ | "Existing code has no tests" | You're improving it. Add tests for existing code. |
50
+
51
+ ## Red Flags — STOP and Start Over
52
+
53
+ - Code before test
54
+ - Test after implementation
55
+ - Test passes immediately
56
+ - Can't explain why test failed
57
+ - Tests added "later"
58
+ - Rationalizing "just this once"
59
+ - "I already manually tested it"
60
+ - "Tests after achieve the same purpose"
61
+ - "It's about spirit not ritual"
62
+ - "Keep as reference" or "adapt existing code"
63
+ - "Already spent X hours, deleting is wasteful"
64
+ - "TDD is dogmatic, I'm being pragmatic"
65
+ - "This is different because..."
66
+
67
+ **All of these mean: Delete code. Start over with TDD.**
@@ -0,0 +1,33 @@
1
+ # TDD When Stuck Reference
2
+
3
+ **Load via:** `workflow_reference({ topic: "tdd-when-stuck" })`
4
+
5
+ ## When Stuck
6
+
7
+ | Problem | Solution |
8
+ |---------|----------|
9
+ | Don't know how to test | Write wished-for API. Write assertion first. Ask your human partner. |
10
+ | Test too complicated | Design too complicated. Simplify interface. |
11
+ | Must mock everything | Code too coupled. Use dependency injection. |
12
+ | Test setup huge | Extract helpers. Still complex? Simplify design. |
13
+
14
+ ## Verification Checklist
15
+
16
+ Before marking work complete:
17
+
18
+ - [ ] Every new function/method has a test
19
+ - [ ] Watched each test fail before implementing
20
+ - [ ] Each test failed for expected reason (feature missing, not typo)
21
+ - [ ] Wrote minimal code to pass each test
22
+ - [ ] All tests pass
23
+ - [ ] Output pristine (no errors, warnings)
24
+ - [ ] Tests use real code (mocks only if unavoidable)
25
+ - [ ] Edge cases and errors covered
26
+
27
+ Can't check all boxes? You skipped TDD. Start over.
28
+
29
+ ## Debugging Integration
30
+
31
+ Bug found? Write failing test reproducing it. Follow TDD cycle. Test proves fix and prevents regression.
32
+
33
+ Never fix bugs without a test.
@@ -0,0 +1,299 @@
1
+ # Testing Anti-Patterns
2
+
3
+ **Load this reference when:** writing or changing tests, adding mocks, or tempted to add test-only methods to production code.
4
+
5
+ ## Overview
6
+
7
+ Tests must verify real behavior, not mock behavior. Mocks are a means to isolate, not the thing being tested.
8
+
9
+ **Core principle:** Test what the code does, not what the mocks do.
10
+
11
+ **Following strict TDD prevents these anti-patterns.**
12
+
13
+ ## The Iron Laws
14
+
15
+ ```
16
+ 1. NEVER test mock behavior
17
+ 2. NEVER add test-only methods to production classes
18
+ 3. NEVER mock without understanding dependencies
19
+ ```
20
+
21
+ ## Anti-Pattern 1: Testing Mock Behavior
22
+
23
+ **The violation:**
24
+ ```typescript
25
+ // ❌ BAD: Testing that the mock exists
26
+ test('renders sidebar', () => {
27
+ render(<Page />);
28
+ expect(screen.getByTestId('sidebar-mock')).toBeInTheDocument();
29
+ });
30
+ ```
31
+
32
+ **Why this is wrong:**
33
+ - You're verifying the mock works, not that the component works
34
+ - Test passes when mock is present, fails when it's not
35
+ - Tells you nothing about real behavior
36
+
37
+ **your human partner's correction:** "Are we testing the behavior of a mock?"
38
+
39
+ **The fix:**
40
+ ```typescript
41
+ // ✅ GOOD: Test real component or don't mock it
42
+ test('renders sidebar', () => {
43
+ render(<Page />); // Don't mock sidebar
44
+ expect(screen.getByRole('navigation')).toBeInTheDocument();
45
+ });
46
+
47
+ // OR if sidebar must be mocked for isolation:
48
+ // Don't assert on the mock - test Page's behavior with sidebar present
49
+ ```
50
+
51
+ ### Gate Function
52
+
53
+ ```
54
+ BEFORE asserting on any mock element:
55
+ Ask: "Am I testing real component behavior or just mock existence?"
56
+
57
+ IF testing mock existence:
58
+ STOP - Delete the assertion or unmock the component
59
+
60
+ Test real behavior instead
61
+ ```
62
+
63
+ ## Anti-Pattern 2: Test-Only Methods in Production
64
+
65
+ **The violation:**
66
+ ```typescript
67
+ // ❌ BAD: destroy() only used in tests
68
+ class Session {
69
+ async destroy() { // Looks like production API!
70
+ await this._workspaceManager?.destroyWorkspace(this.id);
71
+ // ... cleanup
72
+ }
73
+ }
74
+
75
+ // In tests
76
+ afterEach(() => session.destroy());
77
+ ```
78
+
79
+ **Why this is wrong:**
80
+ - Production class polluted with test-only code
81
+ - Dangerous if accidentally called in production
82
+ - Violates YAGNI and separation of concerns
83
+ - Confuses object lifecycle with entity lifecycle
84
+
85
+ **The fix:**
86
+ ```typescript
87
+ // ✅ GOOD: Test utilities handle test cleanup
88
+ // Session has no destroy() - it's stateless in production
89
+
90
+ // In test-utils/
91
+ export async function cleanupSession(session: Session) {
92
+ const workspace = session.getWorkspaceInfo();
93
+ if (workspace) {
94
+ await workspaceManager.destroyWorkspace(workspace.id);
95
+ }
96
+ }
97
+
98
+ // In tests
99
+ afterEach(() => cleanupSession(session));
100
+ ```
101
+
102
+ ### Gate Function
103
+
104
+ ```
105
+ BEFORE adding any method to production class:
106
+ Ask: "Is this only used by tests?"
107
+
108
+ IF yes:
109
+ STOP - Don't add it
110
+ Put it in test utilities instead
111
+
112
+ Ask: "Does this class own this resource's lifecycle?"
113
+
114
+ IF no:
115
+ STOP - Wrong class for this method
116
+ ```
117
+
118
+ ## Anti-Pattern 3: Mocking Without Understanding
119
+
120
+ **The violation:**
121
+ ```typescript
122
+ // ❌ BAD: Mock breaks test logic
123
+ test('detects duplicate server', () => {
124
+ // Mock prevents config write that test depends on!
125
+ vi.mock('ToolCatalog', () => ({
126
+ discoverAndCacheTools: vi.fn().mockResolvedValue(undefined)
127
+ }));
128
+
129
+ await addServer(config);
130
+ await addServer(config); // Should throw - but won't!
131
+ });
132
+ ```
133
+
134
+ **Why this is wrong:**
135
+ - Mocked method had side effect test depended on (writing config)
136
+ - Over-mocking to "be safe" breaks actual behavior
137
+ - Test passes for wrong reason or fails mysteriously
138
+
139
+ **The fix:**
140
+ ```typescript
141
+ // ✅ GOOD: Mock at correct level
142
+ test('detects duplicate server', () => {
143
+ // Mock the slow part, preserve behavior test needs
144
+ vi.mock('MCPServerManager'); // Just mock slow server startup
145
+
146
+ await addServer(config); // Config written
147
+ await addServer(config); // Duplicate detected ✓
148
+ });
149
+ ```
150
+
151
+ ### Gate Function
152
+
153
+ ```
154
+ BEFORE mocking any method:
155
+ STOP - Don't mock yet
156
+
157
+ 1. Ask: "What side effects does the real method have?"
158
+ 2. Ask: "Does this test depend on any of those side effects?"
159
+ 3. Ask: "Do I fully understand what this test needs?"
160
+
161
+ IF depends on side effects:
162
+ Mock at lower level (the actual slow/external operation)
163
+ OR use test doubles that preserve necessary behavior
164
+ NOT the high-level method the test depends on
165
+
166
+ IF unsure what test depends on:
167
+ Run test with real implementation FIRST
168
+ Observe what actually needs to happen
169
+ THEN add minimal mocking at the right level
170
+
171
+ Red flags:
172
+ - "I'll mock this to be safe"
173
+ - "This might be slow, better mock it"
174
+ - Mocking without understanding the dependency chain
175
+ ```
176
+
177
+ ## Anti-Pattern 4: Incomplete Mocks
178
+
179
+ **The violation:**
180
+ ```typescript
181
+ // ❌ BAD: Partial mock - only fields you think you need
182
+ const mockResponse = {
183
+ status: 'success',
184
+ data: { userId: '123', name: 'Alice' }
185
+ // Missing: metadata that downstream code uses
186
+ };
187
+
188
+ // Later: breaks when code accesses response.metadata.requestId
189
+ ```
190
+
191
+ **Why this is wrong:**
192
+ - **Partial mocks hide structural assumptions** - You only mocked fields you know about
193
+ - **Downstream code may depend on fields you didn't include** - Silent failures
194
+ - **Tests pass but integration fails** - Mock incomplete, real API complete
195
+ - **False confidence** - Test proves nothing about real behavior
196
+
197
+ **The Iron Rule:** Mock the COMPLETE data structure as it exists in reality, not just fields your immediate test uses.
198
+
199
+ **The fix:**
200
+ ```typescript
201
+ // ✅ GOOD: Mirror real API completeness
202
+ const mockResponse = {
203
+ status: 'success',
204
+ data: { userId: '123', name: 'Alice' },
205
+ metadata: { requestId: 'req-789', timestamp: 1234567890 }
206
+ // All fields real API returns
207
+ };
208
+ ```
209
+
210
+ ### Gate Function
211
+
212
+ ```
213
+ BEFORE creating mock responses:
214
+ Check: "What fields does the real API response contain?"
215
+
216
+ Actions:
217
+ 1. Examine actual API response from docs/examples
218
+ 2. Include ALL fields system might consume downstream
219
+ 3. Verify mock matches real response schema completely
220
+
221
+ Critical:
222
+ If you're creating a mock, you must understand the ENTIRE structure
223
+ Partial mocks fail silently when code depends on omitted fields
224
+
225
+ If uncertain: Include all documented fields
226
+ ```
227
+
228
+ ## Anti-Pattern 5: Integration Tests as Afterthought
229
+
230
+ **The violation:**
231
+ ```
232
+ ✅ Implementation complete
233
+ ❌ No tests written
234
+ "Ready for testing"
235
+ ```
236
+
237
+ **Why this is wrong:**
238
+ - Testing is part of implementation, not optional follow-up
239
+ - TDD would have caught this
240
+ - Can't claim complete without tests
241
+
242
+ **The fix:**
243
+ ```
244
+ TDD cycle:
245
+ 1. Write failing test
246
+ 2. Implement to pass
247
+ 3. Refactor
248
+ 4. THEN claim complete
249
+ ```
250
+
251
+ ## When Mocks Become Too Complex
252
+
253
+ **Warning signs:**
254
+ - Mock setup longer than test logic
255
+ - Mocking everything to make test pass
256
+ - Mocks missing methods real components have
257
+ - Test breaks when mock changes
258
+
259
+ **your human partner's question:** "Do we need to be using a mock here?"
260
+
261
+ **Consider:** Integration tests with real components often simpler than complex mocks
262
+
263
+ ## TDD Prevents These Anti-Patterns
264
+
265
+ **Why TDD helps:**
266
+ 1. **Write test first** → Forces you to think about what you're actually testing
267
+ 2. **Watch it fail** → Confirms test tests real behavior, not mocks
268
+ 3. **Minimal implementation** → No test-only methods creep in
269
+ 4. **Real dependencies** → You see what the test actually needs before mocking
270
+
271
+ **If you're testing mock behavior, you violated TDD** - you added mocks without watching test fail against real code first.
272
+
273
+ ## Quick Reference
274
+
275
+ | Anti-Pattern | Fix |
276
+ |--------------|-----|
277
+ | Assert on mock elements | Test real component or unmock it |
278
+ | Test-only methods in production | Move to test utilities |
279
+ | Mock without understanding | Understand dependencies first, mock minimally |
280
+ | Incomplete mocks | Mirror real API completely |
281
+ | Tests as afterthought | TDD - tests first |
282
+ | Over-complex mocks | Consider integration tests |
283
+
284
+ ## Red Flags
285
+
286
+ - Assertion checks for `*-mock` test IDs
287
+ - Methods only called in test files
288
+ - Mock setup is >50% of test
289
+ - Test fails when you remove mock
290
+ - Can't explain why mock is needed
291
+ - Mocking "just to be safe"
292
+
293
+ ## The Bottom Line
294
+
295
+ **Mocks are tools to isolate, not things to test.**
296
+
297
+ If TDD reveals you're testing mock behavior, you've gone wrong.
298
+
299
+ Fix: Test real behavior or question why you're mocking at all.