@fro.bot/systematic 2.16.0 → 2.18.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fro.bot/systematic",
3
- "version": "2.16.0",
3
+ "version": "2.18.0",
4
4
  "description": "Structured engineering workflows for OpenCode",
5
5
  "type": "module",
6
6
  "homepage": "https://fro.bot/systematic",
@@ -17,7 +17,8 @@
17
17
  "files": [
18
18
  "dist",
19
19
  "skills",
20
- "agents"
20
+ "agents",
21
+ "ATTRIBUTIONS.md"
21
22
  ],
22
23
  "workspaces": [
23
24
  "docs"
@@ -64,8 +65,8 @@
64
65
  },
65
66
  "devDependencies": {
66
67
  "@biomejs/biome": "2.4.15",
67
- "@opencode-ai/plugin": "1.14.49",
68
- "@opencode-ai/sdk": "1.14.49",
68
+ "@opencode-ai/plugin": "1.14.50",
69
+ "@opencode-ai/sdk": "1.14.50",
69
70
  "@types/bun": "latest",
70
71
  "@types/js-yaml": "4.0.9",
71
72
  "@types/node": "24.12.4",
@@ -38,7 +38,7 @@ If the input is present but unclear or underspecified, do not abandon — ask on
38
38
  4. **Right-size the artifact** - Small work gets a compact plan. Large work gets more structure. The philosophy stays the same at every depth.
39
39
  5. **Separate planning from execution discovery** - Resolve planning-time questions here. Explicitly defer execution-time unknowns to implementation.
40
40
  6. **Keep the plan portable** - The plan should work as a living document, review artifact, or issue body without embedding tool-specific executor instructions.
41
- 7. **Carry execution posture lightly when it matters** - If the request, origin document, or repo context clearly implies test-first, characterization-first, or another non-default execution posture, reflect that in the plan as a lightweight signal. Do not turn the plan into step-by-step execution choreography.
41
+ 7. **Carry execution posture lightly when it matters** - If the request, origin document, or repo context clearly implies test-first, characterization-first, or another non-default execution posture, reflect that in the plan as a lightweight signal that points implementers at the canonical discipline skill (e.g., `test-driven-development` for the RED-GREEN-REFACTOR cycle). Do not turn the plan into step-by-step execution choreography.
42
42
 
43
43
  ## Plan Quality Bar
44
44
 
@@ -200,7 +200,7 @@ Determine how to proceed based on what was provided in `<input_document>`.
200
200
  - Evaluate for incremental commit (see below)
201
201
  ```
202
202
 
203
- When a unit carries an `Execution note`, honor it. For test-first units, write the failing test before implementation for that unit. For characterization-first units, capture existing behavior before changing it. For units without an `Execution note`, proceed pragmatically.
203
+ When a unit carries an `Execution note`, honor it. For test-first units, write the failing test before implementation for that unit — invoke the bundled `test-driven-development` skill for the canonical RED-GREEN-REFACTOR discipline. For characterization-first units, capture existing behavior before changing it. For units without an `Execution note`, proceed pragmatically.
204
204
 
205
205
  Guardrails for execution posture:
206
206
  - Do not write the test and implementation in the same step when working test-first
@@ -0,0 +1,372 @@
1
+ ---
2
+ name: test-driven-development
3
+ description: Use when implementing any feature or bugfix, before writing implementation code
4
+ license: MIT
5
+ ---
6
+
7
+ # Test-Driven Development (TDD)
8
+
9
+ ## Overview
10
+
11
+ Write the test first. Watch it fail. Write minimal code to pass.
12
+
13
+ **Core principle:** If you didn't watch the test fail, you don't know if it tests the right thing.
14
+
15
+ **Violating the letter of the rules is violating the spirit of the rules.**
16
+
17
+ ## When to Use
18
+
19
+ **Always:**
20
+ - New features
21
+ - Bug fixes
22
+ - Refactoring
23
+ - Behavior changes
24
+
25
+ **Exceptions (ask your human partner):**
26
+ - Throwaway prototypes
27
+ - Generated code
28
+ - Configuration files
29
+
30
+ Thinking "skip TDD just this once"? Stop. That's rationalization.
31
+
32
+ ## The Iron Law
33
+
34
+ ```
35
+ NO PRODUCTION CODE WITHOUT A FAILING TEST FIRST
36
+ ```
37
+
38
+ Write code before the test? Delete it. Start over.
39
+
40
+ **No exceptions:**
41
+ - Don't keep it as "reference"
42
+ - Don't "adapt" it while writing tests
43
+ - Don't look at it
44
+ - Delete means delete
45
+
46
+ Implement fresh from tests. Period.
47
+
48
+ ## Red-Green-Refactor
49
+
50
+ ```dot
51
+ digraph tdd_cycle {
52
+ rankdir=LR;
53
+ red [label="RED\nWrite failing test", shape=box, style=filled, fillcolor="#ffcccc"];
54
+ verify_red [label="Verify fails\ncorrectly", shape=diamond];
55
+ green [label="GREEN\nMinimal code", shape=box, style=filled, fillcolor="#ccffcc"];
56
+ verify_green [label="Verify passes\nAll green", shape=diamond];
57
+ refactor [label="REFACTOR\nClean up", shape=box, style=filled, fillcolor="#ccccff"];
58
+ next [label="Next", shape=ellipse];
59
+
60
+ red -> verify_red;
61
+ verify_red -> green [label="yes"];
62
+ verify_red -> red [label="wrong\nfailure"];
63
+ green -> verify_green;
64
+ verify_green -> refactor [label="yes"];
65
+ verify_green -> green [label="no"];
66
+ refactor -> verify_green [label="stay\ngreen"];
67
+ verify_green -> next;
68
+ next -> red;
69
+ }
70
+ ```
71
+
72
+ ### RED - Write Failing Test
73
+
74
+ Write one minimal test showing what should happen.
75
+
76
+ <Good>
77
+ ```typescript
78
+ test('retries failed operations 3 times', async () => {
79
+ let attempts = 0;
80
+ const operation = () => {
81
+ attempts++;
82
+ if (attempts < 3) throw new Error('fail');
83
+ return 'success';
84
+ };
85
+
86
+ const result = await retryOperation(operation);
87
+
88
+ expect(result).toBe('success');
89
+ expect(attempts).toBe(3);
90
+ });
91
+ ```
92
+ Clear name, tests real behavior, one thing
93
+ </Good>
94
+
95
+ <Bad>
96
+ ```typescript
97
+ test('retry works', async () => {
98
+ const mock = jest.fn()
99
+ .mockRejectedValueOnce(new Error())
100
+ .mockRejectedValueOnce(new Error())
101
+ .mockResolvedValueOnce('success');
102
+ await retryOperation(mock);
103
+ expect(mock).toHaveBeenCalledTimes(3);
104
+ });
105
+ ```
106
+ Vague name, tests mock not code
107
+ </Bad>
108
+
109
+ **Requirements:**
110
+ - One behavior
111
+ - Clear name
112
+ - Real code (no mocks unless unavoidable)
113
+
114
+ ### Verify RED - Watch It Fail
115
+
116
+ **MANDATORY. Never skip.**
117
+
118
+ ```bash
119
+ npm test path/to/test.test.ts
120
+ ```
121
+
122
+ Confirm:
123
+ - Test fails (not errors)
124
+ - Failure message is expected
125
+ - Fails because feature missing (not typos)
126
+
127
+ **Test passes?** You're testing existing behavior. Fix test.
128
+
129
+ **Test errors?** Fix error, re-run until it fails correctly.
130
+
131
+ ### GREEN - Minimal Code
132
+
133
+ Write simplest code to pass the test.
134
+
135
+ <Good>
136
+ ```typescript
137
+ async function retryOperation<T>(fn: () => Promise<T>): Promise<T> {
138
+ for (let i = 0; i < 3; i++) {
139
+ try {
140
+ return await fn();
141
+ } catch (e) {
142
+ if (i === 2) throw e;
143
+ }
144
+ }
145
+ throw new Error('unreachable');
146
+ }
147
+ ```
148
+ Just enough to pass
149
+ </Good>
150
+
151
+ <Bad>
152
+ ```typescript
153
+ async function retryOperation<T>(
154
+ fn: () => Promise<T>,
155
+ options?: {
156
+ maxRetries?: number;
157
+ backoff?: 'linear' | 'exponential';
158
+ onRetry?: (attempt: number) => void;
159
+ }
160
+ ): Promise<T> {
161
+ // YAGNI
162
+ }
163
+ ```
164
+ Over-engineered
165
+ </Bad>
166
+
167
+ Don't add features, refactor other code, or "improve" beyond the test.
168
+
169
+ ### Verify GREEN - Watch It Pass
170
+
171
+ **MANDATORY.**
172
+
173
+ ```bash
174
+ npm test path/to/test.test.ts
175
+ ```
176
+
177
+ Confirm:
178
+ - Test passes
179
+ - Other tests still pass
180
+ - Output pristine (no errors, warnings)
181
+
182
+ **Test fails?** Fix code, not test.
183
+
184
+ **Other tests fail?** Fix now.
185
+
186
+ ### REFACTOR - Clean Up
187
+
188
+ After green only:
189
+ - Remove duplication
190
+ - Improve names
191
+ - Extract helpers
192
+
193
+ Keep tests green. Don't add behavior.
194
+
195
+ ### Repeat
196
+
197
+ Next failing test for next feature.
198
+
199
+ ## Good Tests
200
+
201
+ | Quality | Good | Bad |
202
+ |---------|------|-----|
203
+ | **Minimal** | One thing. "and" in name? Split it. | `test('validates email and domain and whitespace')` |
204
+ | **Clear** | Name describes behavior | `test('test1')` |
205
+ | **Shows intent** | Demonstrates desired API | Obscures what code should do |
206
+
207
+ ## Why Order Matters
208
+
209
+ **"I'll write tests after to verify it works"**
210
+
211
+ Tests written after code pass immediately. Passing immediately proves nothing:
212
+ - Might test wrong thing
213
+ - Might test implementation, not behavior
214
+ - Might miss edge cases you forgot
215
+ - You never saw it catch the bug
216
+
217
+ Test-first forces you to see the test fail, proving it actually tests something.
218
+
219
+ **"I already manually tested all the edge cases"**
220
+
221
+ Manual testing is ad-hoc. You think you tested everything but:
222
+ - No record of what you tested
223
+ - Can't re-run when code changes
224
+ - Easy to forget cases under pressure
225
+ - "It worked when I tried it" ≠ comprehensive
226
+
227
+ Automated tests are systematic. They run the same way every time.
228
+
229
+ **"Deleting X hours of work is wasteful"**
230
+
231
+ Sunk cost fallacy. The time is already gone. Your choice now:
232
+ - Delete and rewrite with TDD (X more hours, high confidence)
233
+ - Keep it and add tests after (30 min, low confidence, likely bugs)
234
+
235
+ The "waste" is keeping code you can't trust. Working code without real tests is technical debt.
236
+
237
+ **"TDD is dogmatic, being pragmatic means adapting"**
238
+
239
+ TDD IS pragmatic:
240
+ - Finds bugs before commit (faster than debugging after)
241
+ - Prevents regressions (tests catch breaks immediately)
242
+ - Documents behavior (tests show how to use code)
243
+ - Enables refactoring (change freely, tests catch breaks)
244
+
245
+ "Pragmatic" shortcuts = debugging in production = slower.
246
+
247
+ **"Tests after achieve the same goals - it's spirit not ritual"**
248
+
249
+ No. Tests-after answer "What does this do?" Tests-first answer "What should this do?"
250
+
251
+ Tests-after are biased by your implementation. You test what you built, not what's required. You verify remembered edge cases, not discovered ones.
252
+
253
+ Tests-first force edge case discovery before implementing. Tests-after verify you remembered everything (you didn't).
254
+
255
+ 30 minutes of tests after ≠ TDD. You get coverage, lose proof tests work.
256
+
257
+ ## Common Rationalizations
258
+
259
+ | Excuse | Reality |
260
+ |--------|---------|
261
+ | "Too simple to test" | Simple code breaks. Test takes 30 seconds. |
262
+ | "I'll test after" | Tests passing immediately prove nothing. |
263
+ | "Tests after achieve same goals" | Tests-after = "what does this do?" Tests-first = "what should this do?" |
264
+ | "Already manually tested" | Ad-hoc ≠ systematic. No record, can't re-run. |
265
+ | "Deleting X hours is wasteful" | Sunk cost fallacy. Keeping unverified code is technical debt. |
266
+ | "Keep as reference, write tests first" | You'll adapt it. That's testing after. Delete means delete. |
267
+ | "Need to explore first" | Fine. Throw away exploration, start with TDD. |
268
+ | "Test hard = design unclear" | Listen to test. Hard to test = hard to use. |
269
+ | "TDD will slow me down" | TDD faster than debugging. Pragmatic = test-first. |
270
+ | "Manual test faster" | Manual doesn't prove edge cases. You'll re-test every change. |
271
+ | "Existing code has no tests" | You're improving it. Add tests for existing code. |
272
+
273
+ ## Red Flags - STOP and Start Over
274
+
275
+ - Code before test
276
+ - Test after implementation
277
+ - Test passes immediately
278
+ - Can't explain why test failed
279
+ - Tests added "later"
280
+ - Rationalizing "just this once"
281
+ - "I already manually tested it"
282
+ - "Tests after achieve the same purpose"
283
+ - "It's about spirit not ritual"
284
+ - "Keep as reference" or "adapt existing code"
285
+ - "Already spent X hours, deleting is wasteful"
286
+ - "TDD is dogmatic, I'm being pragmatic"
287
+ - "This is different because..."
288
+
289
+ **All of these mean: Delete code. Start over with TDD.**
290
+
291
+ ## Example: Bug Fix
292
+
293
+ **Bug:** Empty email accepted
294
+
295
+ **RED**
296
+ ```typescript
297
+ test('rejects empty email', async () => {
298
+ const result = await submitForm({ email: '' });
299
+ expect(result.error).toBe('Email required');
300
+ });
301
+ ```
302
+
303
+ **Verify RED**
304
+ ```bash
305
+ $ npm test
306
+ FAIL: expected 'Email required', got undefined
307
+ ```
308
+
309
+ **GREEN**
310
+ ```typescript
311
+ function submitForm(data: FormData) {
312
+ if (!data.email?.trim()) {
313
+ return { error: 'Email required' };
314
+ }
315
+ // ...
316
+ }
317
+ ```
318
+
319
+ **Verify GREEN**
320
+ ```bash
321
+ $ npm test
322
+ PASS
323
+ ```
324
+
325
+ **REFACTOR**
326
+ Extract validation for multiple fields if needed.
327
+
328
+ ## Verification Checklist
329
+
330
+ Before marking work complete:
331
+
332
+ - [ ] Every new function/method has a test
333
+ - [ ] Watched each test fail before implementing
334
+ - [ ] Each test failed for expected reason (feature missing, not typo)
335
+ - [ ] Wrote minimal code to pass each test
336
+ - [ ] All tests pass
337
+ - [ ] Output pristine (no errors, warnings)
338
+ - [ ] Tests use real code (mocks only if unavoidable)
339
+ - [ ] Edge cases and errors covered
340
+
341
+ Can't check all boxes? You skipped TDD. Start over.
342
+
343
+ ## When Stuck
344
+
345
+ | Problem | Solution |
346
+ |---------|----------|
347
+ | Don't know how to test | Write wished-for API. Write assertion first. Ask your human partner. |
348
+ | Test too complicated | Design too complicated. Simplify interface. |
349
+ | Must mock everything | Code too coupled. Use dependency injection. |
350
+ | Test setup huge | Extract helpers. Still complex? Simplify design. |
351
+
352
+ ## Debugging Integration
353
+
354
+ Bug found? Write failing test reproducing it. Follow TDD cycle. Test proves fix and prevents regression.
355
+
356
+ Never fix bugs without a test.
357
+
358
+ ## Testing Anti-Patterns
359
+
360
+ When adding mocks or test utilities, read references/testing-anti-patterns.md to avoid common pitfalls:
361
+ - Testing mock behavior instead of real behavior
362
+ - Adding test-only methods to production classes
363
+ - Mocking without understanding dependencies
364
+
365
+ ## Final Rule
366
+
367
+ ```
368
+ Production code → test exists and failed first
369
+ Otherwise → not TDD
370
+ ```
371
+
372
+ No exceptions without your human partner's permission.