@zhongqian97-code/ecode 0.0.8 → 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.
Files changed (34) hide show
  1. package/dist/index.js +317 -88
  2. package/package.json +2 -1
  3. package/skills/caveman/SKILL.md +49 -0
  4. package/skills/diagnose/SKILL.md +117 -0
  5. package/skills/grill-me/SKILL.md +10 -0
  6. package/skills/grill-with-docs/ADR-FORMAT.md +47 -0
  7. package/skills/grill-with-docs/CONTEXT-FORMAT.md +77 -0
  8. package/skills/grill-with-docs/SKILL.md +88 -0
  9. package/skills/improve-codebase-architecture/DEEPENING.md +37 -0
  10. package/skills/improve-codebase-architecture/INTERFACE-DESIGN.md +44 -0
  11. package/skills/improve-codebase-architecture/LANGUAGE.md +53 -0
  12. package/skills/improve-codebase-architecture/SKILL.md +71 -0
  13. package/skills/plan/SKILL.md +16 -0
  14. package/skills/search-first/SKILL.md +20 -0
  15. package/skills/security-review/SKILL.md +26 -0
  16. package/skills/setup-matt-pocock-skills/SKILL.md +121 -0
  17. package/skills/setup-matt-pocock-skills/domain.md +51 -0
  18. package/skills/setup-matt-pocock-skills/issue-tracker-github.md +22 -0
  19. package/skills/setup-matt-pocock-skills/issue-tracker-gitlab.md +23 -0
  20. package/skills/setup-matt-pocock-skills/issue-tracker-local.md +19 -0
  21. package/skills/setup-matt-pocock-skills/triage-labels.md +15 -0
  22. package/skills/tdd/SKILL.md +109 -0
  23. package/skills/tdd/deep-modules.md +33 -0
  24. package/skills/tdd/interface-design.md +31 -0
  25. package/skills/tdd/mocking.md +59 -0
  26. package/skills/tdd/refactoring.md +10 -0
  27. package/skills/tdd/tests.md +61 -0
  28. package/skills/to-issues/SKILL.md +83 -0
  29. package/skills/to-prd/SKILL.md +76 -0
  30. package/skills/triage/AGENT-BRIEF.md +168 -0
  31. package/skills/triage/OUT-OF-SCOPE.md +101 -0
  32. package/skills/triage/SKILL.md +103 -0
  33. package/skills/write-a-skill/SKILL.md +117 -0
  34. package/skills/zoom-out/SKILL.md +7 -0
@@ -0,0 +1,49 @@
1
+ ---
2
+ name: caveman
3
+ description: >
4
+ Ultra-compressed communication mode. Cuts token usage ~75% by dropping
5
+ filler, articles, and pleasantries while keeping full technical accuracy.
6
+ Use when user says "caveman mode", "talk like caveman", "use caveman",
7
+ "less tokens", "be brief", or invokes /caveman.
8
+ ---
9
+
10
+ Respond terse like smart caveman. All technical substance stay. Only fluff die.
11
+
12
+ ## Persistence
13
+
14
+ ACTIVE EVERY RESPONSE once triggered. No revert after many turns. No filler drift. Still active if unsure. Off only when user says "stop caveman" or "normal mode".
15
+
16
+ ## Rules
17
+
18
+ Drop: articles (a/an/the), filler (just/really/basically/actually/simply), pleasantries (sure/certainly/of course/happy to), hedging. Fragments OK. Short synonyms (big not extensive, fix not "implement a solution for"). Abbreviate common terms (DB/auth/config/req/res/fn/impl). Strip conjunctions. Use arrows for causality (X -> Y). One word when one word enough.
19
+
20
+ Technical terms stay exact. Code blocks unchanged. Errors quoted exact.
21
+
22
+ Pattern: `[thing] [action] [reason]. [next step].`
23
+
24
+ Not: "Sure! I'd be happy to help you with that. The issue you're experiencing is likely caused by..."
25
+ Yes: "Bug in auth middleware. Token expiry check use `<` not `<=`. Fix:"
26
+
27
+ ### Examples
28
+
29
+ **"Why React component re-render?"**
30
+
31
+ > Inline obj prop -> new ref -> re-render. `useMemo`.
32
+
33
+ **"Explain database connection pooling."**
34
+
35
+ > Pool = reuse DB conn. Skip handshake -> fast under load.
36
+
37
+ ## Auto-Clarity Exception
38
+
39
+ Drop caveman temporarily for: security warnings, irreversible action confirmations, multi-step sequences where fragment order risks misread, user asks to clarify or repeats question. Resume caveman after clear part done.
40
+
41
+ Example -- destructive op:
42
+
43
+ > **Warning:** This will permanently delete all rows in the `users` table and cannot be undone.
44
+ >
45
+ > ```sql
46
+ > DROP TABLE users;
47
+ > ```
48
+ >
49
+ > Caveman resume. Verify backup exist first.
@@ -0,0 +1,117 @@
1
+ ---
2
+ name: diagnose
3
+ description: Disciplined diagnosis loop for hard bugs and performance regressions. Reproduce → minimise → hypothesise → instrument → fix → regression-test. Use when user says "diagnose this" / "debug this", reports a bug, says something is broken/throwing/failing, or describes a performance regression.
4
+ ---
5
+
6
+ # Diagnose
7
+
8
+ A discipline for hard bugs. Skip phases only when explicitly justified.
9
+
10
+ When exploring the codebase, use the project's domain glossary to get a clear mental model of the relevant modules, and check ADRs in the area you're touching.
11
+
12
+ ## Phase 1 — Build a feedback loop
13
+
14
+ **This is the skill.** Everything else is mechanical. If you have a fast, deterministic, agent-runnable pass/fail signal for the bug, you will find the cause — bisection, hypothesis-testing, and instrumentation all just consume that signal. If you don't have one, no amount of staring at code will save you.
15
+
16
+ Spend disproportionate effort here. **Be aggressive. Be creative. Refuse to give up.**
17
+
18
+ ### Ways to construct one — try them in roughly this order
19
+
20
+ 1. **Failing test** at whatever seam reaches the bug — unit, integration, e2e.
21
+ 2. **Curl / HTTP script** against a running dev server.
22
+ 3. **CLI invocation** with a fixture input, diffing stdout against a known-good snapshot.
23
+ 4. **Headless browser script** (Playwright / Puppeteer) — drives the UI, asserts on DOM/console/network.
24
+ 5. **Replay a captured trace.** Save a real network request / payload / event log to disk; replay it through the code path in isolation.
25
+ 6. **Throwaway harness.** Spin up a minimal subset of the system (one service, mocked deps) that exercises the bug code path with a single function call.
26
+ 7. **Property / fuzz loop.** If the bug is "sometimes wrong output", run 1000 random inputs and look for the failure mode.
27
+ 8. **Bisection harness.** If the bug appeared between two known states (commit, dataset, version), automate "boot at state X, check, repeat" so you can `git bisect run` it.
28
+ 9. **Differential loop.** Run the same input through old-version vs new-version (or two configs) and diff outputs.
29
+ 10. **HITL bash script.** Last resort. If a human must click, drive _them_ with `scripts/hitl-loop.template.sh` so the loop is still structured. Captured output feeds back to you.
30
+
31
+ Build the right feedback loop, and the bug is 90% fixed.
32
+
33
+ ### Iterate on the loop itself
34
+
35
+ Treat the loop as a product. Once you have _a_ loop, ask:
36
+
37
+ - Can I make it faster? (Cache setup, skip unrelated init, narrow the test scope.)
38
+ - Can I make the signal sharper? (Assert on the specific symptom, not "didn't crash".)
39
+ - Can I make it more deterministic? (Pin time, seed RNG, isolate filesystem, freeze network.)
40
+
41
+ A 30-second flaky loop is barely better than no loop. A 2-second deterministic loop is a debugging superpower.
42
+
43
+ ### Non-deterministic bugs
44
+
45
+ The goal is not a clean repro but a **higher reproduction rate**. Loop the trigger 100×, parallelise, add stress, narrow timing windows, inject sleeps. A 50%-flake bug is debuggable; 1% is not — keep raising the rate until it's debuggable.
46
+
47
+ ### When you genuinely cannot build a loop
48
+
49
+ Stop and say so explicitly. List what you tried. Ask the user for: (a) access to whatever environment reproduces it, (b) a captured artifact (HAR file, log dump, core dump, screen recording with timestamps), or (c) permission to add temporary production instrumentation. Do **not** proceed to hypothesise without a loop.
50
+
51
+ Do not proceed to Phase 2 until you have a loop you believe in.
52
+
53
+ ## Phase 2 — Reproduce
54
+
55
+ Run the loop. Watch the bug appear.
56
+
57
+ Confirm:
58
+
59
+ - [ ] The loop produces the failure mode the **user** described — not a different failure that happens to be nearby. Wrong bug = wrong fix.
60
+ - [ ] The failure is reproducible across multiple runs (or, for non-deterministic bugs, reproducible at a high enough rate to debug against).
61
+ - [ ] You have captured the exact symptom (error message, wrong output, slow timing) so later phases can verify the fix actually addresses it.
62
+
63
+ Do not proceed until you reproduce the bug.
64
+
65
+ ## Phase 3 — Hypothesise
66
+
67
+ Generate **3–5 ranked hypotheses** before testing any of them. Single-hypothesis generation anchors on the first plausible idea.
68
+
69
+ Each hypothesis must be **falsifiable**: state the prediction it makes.
70
+
71
+ > Format: "If <X> is the cause, then <changing Y> will make the bug disappear / <changing Z> will make it worse."
72
+
73
+ If you cannot state the prediction, the hypothesis is a vibe — discard or sharpen it.
74
+
75
+ **Show the ranked list to the user before testing.** They often have domain knowledge that re-ranks instantly ("we just deployed a change to #3"), or know hypotheses they've already ruled out. Cheap checkpoint, big time saver. Don't block on it — proceed with your ranking if the user is AFK.
76
+
77
+ ## Phase 4 — Instrument
78
+
79
+ Each probe must map to a specific prediction from Phase 3. **Change one variable at a time.**
80
+
81
+ Tool preference:
82
+
83
+ 1. **Debugger / REPL inspection** if the env supports it. One breakpoint beats ten logs.
84
+ 2. **Targeted logs** at the boundaries that distinguish hypotheses.
85
+ 3. Never "log everything and grep".
86
+
87
+ **Tag every debug log** with a unique prefix, e.g. `[DEBUG-a4f2]`. Cleanup at the end becomes a single grep. Untagged logs survive; tagged logs die.
88
+
89
+ **Perf branch.** For performance regressions, logs are usually wrong. Instead: establish a baseline measurement (timing harness, `performance.now()`, profiler, query plan), then bisect. Measure first, fix second.
90
+
91
+ ## Phase 5 — Fix + regression test
92
+
93
+ Write the regression test **before the fix** — but only if there is a **correct seam** for it.
94
+
95
+ A correct seam is one where the test exercises the **real bug pattern** as it occurs at the call site. If the only available seam is too shallow (single-caller test when the bug needs multiple callers, unit test that can't replicate the chain that triggered the bug), a regression test there gives false confidence.
96
+
97
+ **If no correct seam exists, that itself is the finding.** Note it. The codebase architecture is preventing the bug from being locked down. Flag this for the next phase.
98
+
99
+ If a correct seam exists:
100
+
101
+ 1. Turn the minimised repro into a failing test at that seam.
102
+ 2. Watch it fail.
103
+ 3. Apply the fix.
104
+ 4. Watch it pass.
105
+ 5. Re-run the Phase 1 feedback loop against the original (un-minimised) scenario.
106
+
107
+ ## Phase 6 — Cleanup + post-mortem
108
+
109
+ Required before declaring done:
110
+
111
+ - [ ] Original repro no longer reproduces (re-run the Phase 1 loop)
112
+ - [ ] Regression test passes (or absence of seam is documented)
113
+ - [ ] All `[DEBUG-...]` instrumentation removed (`grep` the prefix)
114
+ - [ ] Throwaway prototypes deleted (or moved to a clearly-marked debug location)
115
+ - [ ] The hypothesis that turned out correct is stated in the commit / PR message — so the next debugger learns
116
+
117
+ **Then ask: what would have prevented this bug?** If the answer involves architectural change (no good test seam, tangled callers, hidden coupling) hand off to the `/improve-codebase-architecture` skill with the specifics. Make the recommendation **after** the fix is in, not before — you have more information now than when you started.
@@ -0,0 +1,10 @@
1
+ ---
2
+ name: grill-me
3
+ description: Interview the user relentlessly about a plan or design until reaching shared understanding, resolving each branch of the decision tree. Use when user wants to stress-test a plan, get grilled on their design, or mentions "grill me".
4
+ ---
5
+
6
+ Interview me relentlessly about every aspect of this plan until we reach a shared understanding. Walk down each branch of the design tree, resolving dependencies between decisions one-by-one. For each question, provide your recommended answer.
7
+
8
+ Ask the questions one at a time.
9
+
10
+ If a question can be answered by exploring the codebase, explore the codebase instead.
@@ -0,0 +1,47 @@
1
+ # ADR Format
2
+
3
+ ADRs live in `docs/adr/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc.
4
+
5
+ Create the `docs/adr/` directory lazily — only when the first ADR is needed.
6
+
7
+ ## Template
8
+
9
+ ```md
10
+ # {Short title of the decision}
11
+
12
+ {1-3 sentences: what's the context, what did we decide, and why.}
13
+ ```
14
+
15
+ That's it. An ADR can be a single paragraph. The value is in recording *that* a decision was made and *why* — not in filling out sections.
16
+
17
+ ## Optional sections
18
+
19
+ Only include these when they add genuine value. Most ADRs won't need them.
20
+
21
+ - **Status** frontmatter (`proposed | accepted | deprecated | superseded by ADR-NNNN`) — useful when decisions are revisited
22
+ - **Considered Options** — only when the rejected alternatives are worth remembering
23
+ - **Consequences** — only when non-obvious downstream effects need to be called out
24
+
25
+ ## Numbering
26
+
27
+ Scan `docs/adr/` for the highest existing number and increment by one.
28
+
29
+ ## When to offer an ADR
30
+
31
+ All three of these must be true:
32
+
33
+ 1. **Hard to reverse** — the cost of changing your mind later is meaningful
34
+ 2. **Surprising without context** — a future reader will look at the code and wonder "why on earth did they do it this way?"
35
+ 3. **The result of a real trade-off** — there were genuine alternatives and you picked one for specific reasons
36
+
37
+ If a decision is easy to reverse, skip it — you'll just reverse it. If it's not surprising, nobody will wonder why. If there was no real alternative, there's nothing to record beyond "we did the obvious thing."
38
+
39
+ ### What qualifies
40
+
41
+ - **Architectural shape.** "We're using a monorepo." "The write model is event-sourced, the read model is projected into Postgres."
42
+ - **Integration patterns between contexts.** "Ordering and Billing communicate via domain events, not synchronous HTTP."
43
+ - **Technology choices that carry lock-in.** Database, message bus, auth provider, deployment target. Not every library — just the ones that would take a quarter to swap out.
44
+ - **Boundary and scope decisions.** "Customer data is owned by the Customer context; other contexts reference it by ID only." The explicit no-s are as valuable as the yes-s.
45
+ - **Deliberate deviations from the obvious path.** "We're using manual SQL instead of an ORM because X." Anything where a reasonable reader would assume the opposite. These stop the next engineer from "fixing" something that was deliberate.
46
+ - **Constraints not visible in the code.** "We can't use AWS because of compliance requirements." "Response times must be under 200ms because of the partner API contract."
47
+ - **Rejected alternatives when the rejection is non-obvious.** If you considered GraphQL and picked REST for subtle reasons, record it — otherwise someone will suggest GraphQL again in six months.
@@ -0,0 +1,77 @@
1
+ # CONTEXT.md Format
2
+
3
+ ## Structure
4
+
5
+ ```md
6
+ # {Context Name}
7
+
8
+ {One or two sentence description of what this context is and why it exists.}
9
+
10
+ ## Language
11
+
12
+ **Order**:
13
+ {A concise description of the term}
14
+ _Avoid_: Purchase, transaction
15
+
16
+ **Invoice**:
17
+ A request for payment sent to a customer after delivery.
18
+ _Avoid_: Bill, payment request
19
+
20
+ **Customer**:
21
+ A person or organization that places orders.
22
+ _Avoid_: Client, buyer, account
23
+
24
+ ## Relationships
25
+
26
+ - An **Order** produces one or more **Invoices**
27
+ - An **Invoice** belongs to exactly one **Customer**
28
+
29
+ ## Example dialogue
30
+
31
+ > **Dev:** "When a **Customer** places an **Order**, do we create the **Invoice** immediately?"
32
+ > **Domain expert:** "No — an **Invoice** is only generated once a **Fulfillment** is confirmed."
33
+
34
+ ## Flagged ambiguities
35
+
36
+ - "account" was used to mean both **Customer** and **User** — resolved: these are distinct concepts.
37
+ ```
38
+
39
+ ## Rules
40
+
41
+ - **Be opinionated.** When multiple words exist for the same concept, pick the best one and list the others as aliases to avoid.
42
+ - **Flag conflicts explicitly.** If a term is used ambiguously, call it out in "Flagged ambiguities" with a clear resolution.
43
+ - **Keep definitions tight.** One sentence max. Define what it IS, not what it does.
44
+ - **Show relationships.** Use bold term names and express cardinality where obvious.
45
+ - **Only include terms specific to this project's context.** General programming concepts (timeouts, error types, utility patterns) don't belong even if the project uses them extensively. Before adding a term, ask: is this a concept unique to this context, or a general programming concept? Only the former belongs.
46
+ - **Group terms under subheadings** when natural clusters emerge. If all terms belong to a single cohesive area, a flat list is fine.
47
+ - **Write an example dialogue.** A conversation between a dev and a domain expert that demonstrates how the terms interact naturally and clarifies boundaries between related concepts.
48
+
49
+ ## Single vs multi-context repos
50
+
51
+ **Single context (most repos):** One `CONTEXT.md` at the repo root.
52
+
53
+ **Multiple contexts:** A `CONTEXT-MAP.md` at the repo root lists the contexts, where they live, and how they relate to each other:
54
+
55
+ ```md
56
+ # Context Map
57
+
58
+ ## Contexts
59
+
60
+ - [Ordering](./src/ordering/CONTEXT.md) — receives and tracks customer orders
61
+ - [Billing](./src/billing/CONTEXT.md) — generates invoices and processes payments
62
+ - [Fulfillment](./src/fulfillment/CONTEXT.md) — manages warehouse picking and shipping
63
+
64
+ ## Relationships
65
+
66
+ - **Ordering → Fulfillment**: Ordering emits `OrderPlaced` events; Fulfillment consumes them to start picking
67
+ - **Fulfillment → Billing**: Fulfillment emits `ShipmentDispatched` events; Billing consumes them to generate invoices
68
+ - **Ordering ↔ Billing**: Shared types for `CustomerId` and `Money`
69
+ ```
70
+
71
+ The skill infers which structure applies:
72
+
73
+ - If `CONTEXT-MAP.md` exists, read it to find contexts
74
+ - If only a root `CONTEXT.md` exists, single context
75
+ - If neither exists, create a root `CONTEXT.md` lazily when the first term is resolved
76
+
77
+ When multiple contexts exist, infer which one the current topic relates to. If unclear, ask.
@@ -0,0 +1,88 @@
1
+ ---
2
+ name: grill-with-docs
3
+ description: Grilling session that challenges your plan against the existing domain model, sharpens terminology, and updates documentation (CONTEXT.md, ADRs) inline as decisions crystallise. Use when user wants to stress-test a plan against their project's language and documented decisions.
4
+ ---
5
+
6
+ <what-to-do>
7
+
8
+ Interview me relentlessly about every aspect of this plan until we reach a shared understanding. Walk down each branch of the design tree, resolving dependencies between decisions one-by-one. For each question, provide your recommended answer.
9
+
10
+ Ask the questions one at a time, waiting for feedback on each question before continuing.
11
+
12
+ If a question can be answered by exploring the codebase, explore the codebase instead.
13
+
14
+ </what-to-do>
15
+
16
+ <supporting-info>
17
+
18
+ ## Domain awareness
19
+
20
+ During codebase exploration, also look for existing documentation:
21
+
22
+ ### File structure
23
+
24
+ Most repos have a single context:
25
+
26
+ ```
27
+ /
28
+ ├── CONTEXT.md
29
+ ├── docs/
30
+ │ └── adr/
31
+ │ ├── 0001-event-sourced-orders.md
32
+ │ └── 0002-postgres-for-write-model.md
33
+ └── src/
34
+ ```
35
+
36
+ If a `CONTEXT-MAP.md` exists at the root, the repo has multiple contexts. The map points to where each one lives:
37
+
38
+ ```
39
+ /
40
+ ├── CONTEXT-MAP.md
41
+ ├── docs/
42
+ │ └── adr/ ← system-wide decisions
43
+ ├── src/
44
+ │ ├── ordering/
45
+ │ │ ├── CONTEXT.md
46
+ │ │ └── docs/adr/ ← context-specific decisions
47
+ │ └── billing/
48
+ │ ├── CONTEXT.md
49
+ │ └── docs/adr/
50
+ ```
51
+
52
+ Create files lazily — only when you have something to write. If no `CONTEXT.md` exists, create one when the first term is resolved. If no `docs/adr/` exists, create it when the first ADR is needed.
53
+
54
+ ## During the session
55
+
56
+ ### Challenge against the glossary
57
+
58
+ When the user uses a term that conflicts with the existing language in `CONTEXT.md`, call it out immediately. "Your glossary defines 'cancellation' as X, but you seem to mean Y — which is it?"
59
+
60
+ ### Sharpen fuzzy language
61
+
62
+ When the user uses vague or overloaded terms, propose a precise canonical term. "You're saying 'account' — do you mean the Customer or the User? Those are different things."
63
+
64
+ ### Discuss concrete scenarios
65
+
66
+ When domain relationships are being discussed, stress-test them with specific scenarios. Invent scenarios that probe edge cases and force the user to be precise about the boundaries between concepts.
67
+
68
+ ### Cross-reference with code
69
+
70
+ When the user states how something works, check whether the code agrees. If you find a contradiction, surface it: "Your code cancels entire Orders, but you just said partial cancellation is possible — which is right?"
71
+
72
+ ### Update CONTEXT.md inline
73
+
74
+ When a term is resolved, update `CONTEXT.md` right there. Don't batch these up — capture them as they happen. Use the format in [CONTEXT-FORMAT.md](./CONTEXT-FORMAT.md).
75
+
76
+ Don't couple `CONTEXT.md` to implementation details. Only include terms that are meaningful to domain experts.
77
+
78
+ ### Offer ADRs sparingly
79
+
80
+ Only offer to create an ADR when all three are true:
81
+
82
+ 1. **Hard to reverse** — the cost of changing your mind later is meaningful
83
+ 2. **Surprising without context** — a future reader will wonder "why did they do it this way?"
84
+ 3. **The result of a real trade-off** — there were genuine alternatives and you picked one for specific reasons
85
+
86
+ If any of the three is missing, skip the ADR. Use the format in [ADR-FORMAT.md](./ADR-FORMAT.md).
87
+
88
+ </supporting-info>
@@ -0,0 +1,37 @@
1
+ # Deepening
2
+
3
+ How to deepen a cluster of shallow modules safely, given its dependencies. Assumes the vocabulary in [LANGUAGE.md](LANGUAGE.md) — **module**, **interface**, **seam**, **adapter**.
4
+
5
+ ## Dependency categories
6
+
7
+ When assessing a candidate for deepening, classify its dependencies. The category determines how the deepened module is tested across its seam.
8
+
9
+ ### 1. In-process
10
+
11
+ Pure computation, in-memory state, no I/O. Always deepenable — merge the modules and test through the new interface directly. No adapter needed.
12
+
13
+ ### 2. Local-substitutable
14
+
15
+ Dependencies that have local test stand-ins (PGLite for Postgres, in-memory filesystem). Deepenable if the stand-in exists. The deepened module is tested with the stand-in running in the test suite. The seam is internal; no port at the module's external interface.
16
+
17
+ ### 3. Remote but owned (Ports & Adapters)
18
+
19
+ Your own services across a network boundary (microservices, internal APIs). Define a **port** (interface) at the seam. The deep module owns the logic; the transport is injected as an **adapter**. Tests use an in-memory adapter. Production uses an HTTP/gRPC/queue adapter.
20
+
21
+ Recommendation shape: *"Define a port at the seam, implement an HTTP adapter for production and an in-memory adapter for testing, so the logic sits in one deep module even though it's deployed across a network."*
22
+
23
+ ### 4. True external (Mock)
24
+
25
+ Third-party services (Stripe, Twilio, etc.) you don't control. The deepened module takes the external dependency as an injected port; tests provide a mock adapter.
26
+
27
+ ## Seam discipline
28
+
29
+ - **One adapter means a hypothetical seam. Two adapters means a real one.** Don't introduce a port unless at least two adapters are justified (typically production + test). A single-adapter seam is just indirection.
30
+ - **Internal seams vs external seams.** A deep module can have internal seams (private to its implementation, used by its own tests) as well as the external seam at its interface. Don't expose internal seams through the interface just because tests use them.
31
+
32
+ ## Testing strategy: replace, don't layer
33
+
34
+ - Old unit tests on shallow modules become waste once tests at the deepened module's interface exist — delete them.
35
+ - Write new tests at the deepened module's interface. The **interface is the test surface**.
36
+ - Tests assert on observable outcomes through the interface, not internal state.
37
+ - Tests should survive internal refactors — they describe behaviour, not implementation. If a test has to change when the implementation changes, it's testing past the interface.
@@ -0,0 +1,44 @@
1
+ # Interface Design
2
+
3
+ When the user wants to explore alternative interfaces for a chosen deepening candidate, use this parallel sub-agent pattern. Based on "Design It Twice" (Ousterhout) — your first idea is unlikely to be the best.
4
+
5
+ Uses the vocabulary in [LANGUAGE.md](LANGUAGE.md) — **module**, **interface**, **seam**, **adapter**, **leverage**.
6
+
7
+ ## Process
8
+
9
+ ### 1. Frame the problem space
10
+
11
+ Before spawning sub-agents, write a user-facing explanation of the problem space for the chosen candidate:
12
+
13
+ - The constraints any new interface would need to satisfy
14
+ - The dependencies it would rely on, and which category they fall into (see [DEEPENING.md](DEEPENING.md))
15
+ - A rough illustrative code sketch to ground the constraints — not a proposal, just a way to make the constraints concrete
16
+
17
+ Show this to the user, then immediately proceed to Step 2. The user reads and thinks while the sub-agents work in parallel.
18
+
19
+ ### 2. Spawn sub-agents
20
+
21
+ Spawn 3+ sub-agents in parallel using the Agent tool. Each must produce a **radically different** interface for the deepened module.
22
+
23
+ Prompt each sub-agent with a separate technical brief (file paths, coupling details, dependency category from [DEEPENING.md](DEEPENING.md), what sits behind the seam). The brief is independent of the user-facing problem-space explanation in Step 1. Give each agent a different design constraint:
24
+
25
+ - Agent 1: "Minimize the interface — aim for 1–3 entry points max. Maximise leverage per entry point."
26
+ - Agent 2: "Maximise flexibility — support many use cases and extension."
27
+ - Agent 3: "Optimise for the most common caller — make the default case trivial."
28
+ - Agent 4 (if applicable): "Design around ports & adapters for cross-seam dependencies."
29
+
30
+ Include both [LANGUAGE.md](LANGUAGE.md) vocabulary and CONTEXT.md vocabulary in the brief so each sub-agent names things consistently with the architecture language and the project's domain language.
31
+
32
+ Each sub-agent outputs:
33
+
34
+ 1. Interface (types, methods, params — plus invariants, ordering, error modes)
35
+ 2. Usage example showing how callers use it
36
+ 3. What the implementation hides behind the seam
37
+ 4. Dependency strategy and adapters (see [DEEPENING.md](DEEPENING.md))
38
+ 5. Trade-offs — where leverage is high, where it's thin
39
+
40
+ ### 3. Present and compare
41
+
42
+ Present designs sequentially so the user can absorb each one, then compare them in prose. Contrast by **depth** (leverage at the interface), **locality** (where change concentrates), and **seam placement**.
43
+
44
+ After comparing, give your own recommendation: which design you think is strongest and why. If elements from different designs would combine well, propose a hybrid. Be opinionated — the user wants a strong read, not a menu.
@@ -0,0 +1,53 @@
1
+ # Language
2
+
3
+ Shared vocabulary for every suggestion this skill makes. Use these terms exactly — don't substitute "component," "service," "API," or "boundary." Consistent language is the whole point.
4
+
5
+ ## Terms
6
+
7
+ **Module**
8
+ Anything with an interface and an implementation. Deliberately scale-agnostic — applies equally to a function, class, package, or tier-spanning slice.
9
+ _Avoid_: unit, component, service.
10
+
11
+ **Interface**
12
+ Everything a caller must know to use the module correctly. Includes the type signature, but also invariants, ordering constraints, error modes, required configuration, and performance characteristics.
13
+ _Avoid_: API, signature (too narrow — those refer only to the type-level surface).
14
+
15
+ **Implementation**
16
+ What's inside a module — its body of code. Distinct from **Adapter**: a thing can be a small adapter with a large implementation (a Postgres repo) or a large adapter with a small implementation (an in-memory fake). Reach for "adapter" when the seam is the topic; "implementation" otherwise.
17
+
18
+ **Depth**
19
+ Leverage at the interface — the amount of behaviour a caller (or test) can exercise per unit of interface they have to learn. A module is **deep** when a large amount of behaviour sits behind a small interface. A module is **shallow** when the interface is nearly as complex as the implementation.
20
+
21
+ **Seam** _(from Michael Feathers)_
22
+ A place where you can alter behaviour without editing in that place. The *location* at which a module's interface lives. Choosing where to put the seam is its own design decision, distinct from what goes behind it.
23
+ _Avoid_: boundary (overloaded with DDD's bounded context).
24
+
25
+ **Adapter**
26
+ A concrete thing that satisfies an interface at a seam. Describes *role* (what slot it fills), not substance (what's inside).
27
+
28
+ **Leverage**
29
+ What callers get from depth. More capability per unit of interface they have to learn. One implementation pays back across N call sites and M tests.
30
+
31
+ **Locality**
32
+ What maintainers get from depth. Change, bugs, knowledge, and verification concentrate at one place rather than spreading across callers. Fix once, fixed everywhere.
33
+
34
+ ## Principles
35
+
36
+ - **Depth is a property of the interface, not the implementation.** A deep module can be internally composed of small, mockable, swappable parts — they just aren't part of the interface. A module can have **internal seams** (private to its implementation, used by its own tests) as well as the **external seam** at its interface.
37
+ - **The deletion test.** Imagine deleting the module. If complexity vanishes, the module wasn't hiding anything (it was a pass-through). If complexity reappears across N callers, the module was earning its keep.
38
+ - **The interface is the test surface.** Callers and tests cross the same seam. If you want to test *past* the interface, the module is probably the wrong shape.
39
+ - **One adapter means a hypothetical seam. Two adapters means a real one.** Don't introduce a seam unless something actually varies across it.
40
+
41
+ ## Relationships
42
+
43
+ - A **Module** has exactly one **Interface** (the surface it presents to callers and tests).
44
+ - **Depth** is a property of a **Module**, measured against its **Interface**.
45
+ - A **Seam** is where a **Module**'s **Interface** lives.
46
+ - An **Adapter** sits at a **Seam** and satisfies the **Interface**.
47
+ - **Depth** produces **Leverage** for callers and **Locality** for maintainers.
48
+
49
+ ## Rejected framings
50
+
51
+ - **Depth as ratio of implementation-lines to interface-lines** (Ousterhout): rewards padding the implementation. We use depth-as-leverage instead.
52
+ - **"Interface" as the TypeScript `interface` keyword or a class's public methods**: too narrow — interface here includes every fact a caller must know.
53
+ - **"Boundary"**: overloaded with DDD's bounded context. Say **seam** or **interface**.
@@ -0,0 +1,71 @@
1
+ ---
2
+ name: improve-codebase-architecture
3
+ description: Find deepening opportunities in a codebase, informed by the domain language in CONTEXT.md and the decisions in docs/adr/. Use when the user wants to improve architecture, find refactoring opportunities, consolidate tightly-coupled modules, or make a codebase more testable and AI-navigable.
4
+ ---
5
+
6
+ # Improve Codebase Architecture
7
+
8
+ Surface architectural friction and propose **deepening opportunities** — refactors that turn shallow modules into deep ones. The aim is testability and AI-navigability.
9
+
10
+ ## Glossary
11
+
12
+ Use these terms exactly in every suggestion. Consistent language is the point — don't drift into "component," "service," "API," or "boundary." Full definitions in [LANGUAGE.md](LANGUAGE.md).
13
+
14
+ - **Module** — anything with an interface and an implementation (function, class, package, slice).
15
+ - **Interface** — everything a caller must know to use the module: types, invariants, error modes, ordering, config. Not just the type signature.
16
+ - **Implementation** — the code inside.
17
+ - **Depth** — leverage at the interface: a lot of behaviour behind a small interface. **Deep** = high leverage. **Shallow** = interface nearly as complex as the implementation.
18
+ - **Seam** — where an interface lives; a place behaviour can be altered without editing in place. (Use this, not "boundary.")
19
+ - **Adapter** — a concrete thing satisfying an interface at a seam.
20
+ - **Leverage** — what callers get from depth.
21
+ - **Locality** — what maintainers get from depth: change, bugs, knowledge concentrated in one place.
22
+
23
+ Key principles (see [LANGUAGE.md](LANGUAGE.md) for the full list):
24
+
25
+ - **Deletion test**: imagine deleting the module. If complexity vanishes, it was a pass-through. If complexity reappears across N callers, it was earning its keep.
26
+ - **The interface is the test surface.**
27
+ - **One adapter = hypothetical seam. Two adapters = real seam.**
28
+
29
+ This skill is _informed_ by the project's domain model. The domain language gives names to good seams; ADRs record decisions the skill should not re-litigate.
30
+
31
+ ## Process
32
+
33
+ ### 1. Explore
34
+
35
+ Read the project's domain glossary and any ADRs in the area you're touching first.
36
+
37
+ Then use the Agent tool with `subagent_type=Explore` to walk the codebase. Don't follow rigid heuristics — explore organically and note where you experience friction:
38
+
39
+ - Where does understanding one concept require bouncing between many small modules?
40
+ - Where are modules **shallow** — interface nearly as complex as the implementation?
41
+ - Where have pure functions been extracted just for testability, but the real bugs hide in how they're called (no **locality**)?
42
+ - Where do tightly-coupled modules leak across their seams?
43
+ - Which parts of the codebase are untested, or hard to test through their current interface?
44
+
45
+ Apply the **deletion test** to anything you suspect is shallow: would deleting it concentrate complexity, or just move it? A "yes, concentrates" is the signal you want.
46
+
47
+ ### 2. Present candidates
48
+
49
+ Present a numbered list of deepening opportunities. For each candidate:
50
+
51
+ - **Files** — which files/modules are involved
52
+ - **Problem** — why the current architecture is causing friction
53
+ - **Solution** — plain English description of what would change
54
+ - **Benefits** — explained in terms of locality and leverage, and also in how tests would improve
55
+
56
+ **Use CONTEXT.md vocabulary for the domain, and [LANGUAGE.md](LANGUAGE.md) vocabulary for the architecture.** If `CONTEXT.md` defines "Order," talk about "the Order intake module" — not "the FooBarHandler," and not "the Order service."
57
+
58
+ **ADR conflicts**: if a candidate contradicts an existing ADR, only surface it when the friction is real enough to warrant revisiting the ADR. Mark it clearly (e.g. _"contradicts ADR-0007 — but worth reopening because…"_). Don't list every theoretical refactor an ADR forbids.
59
+
60
+ Do NOT propose interfaces yet. Ask the user: "Which of these would you like to explore?"
61
+
62
+ ### 3. Grilling loop
63
+
64
+ Once the user picks a candidate, drop into a grilling conversation. Walk the design tree with them — constraints, dependencies, the shape of the deepened module, what sits behind the seam, what tests survive.
65
+
66
+ Side effects happen inline as decisions crystallize:
67
+
68
+ - **Naming a deepened module after a concept not in `CONTEXT.md`?** Add the term to `CONTEXT.md` — same discipline as `/grill-with-docs` (see [CONTEXT-FORMAT.md](../grill-with-docs/CONTEXT-FORMAT.md)). Create the file lazily if it doesn't exist.
69
+ - **Sharpening a fuzzy term during the conversation?** Update `CONTEXT.md` right there.
70
+ - **User rejects the candidate with a load-bearing reason?** Offer an ADR, framed as: _"Want me to record this as an ADR so future architecture reviews don't re-suggest it?"_ Only offer when the reason would actually be needed by a future explorer to avoid re-suggesting the same thing — skip ephemeral reasons ("not worth it right now") and self-evident ones. See [ADR-FORMAT.md](../grill-with-docs/ADR-FORMAT.md).
71
+ - **Want to explore alternative interfaces for the deepened module?** See [INTERFACE-DESIGN.md](INTERFACE-DESIGN.md).
@@ -0,0 +1,16 @@
1
+ ---
2
+ name: plan
3
+ description: Restate requirements, identify risks, and create a step-by-step implementation plan. Use when user wants to plan a feature or refactor before writing code.
4
+ origin: https://github.com/affaan-m/everything-claude-code
5
+ ---
6
+
7
+ Restate what the user wants to accomplish in your own words — include any constraints, dependencies, and success criteria you can infer.
8
+
9
+ Identify the top risks or unknowns that could derail the implementation.
10
+
11
+ Then produce a numbered, step-by-step implementation plan. For each step:
12
+ - What changes (files, functions, types)
13
+ - Why it must happen before or after adjacent steps
14
+ - Any tests that should be written first
15
+
16
+ STOP after presenting the plan. Do NOT write any code. Wait for the user to review and confirm before proceeding.
@@ -0,0 +1,20 @@
1
+ ---
2
+ name: search-first
3
+ description: Research-before-coding workflow. Search for existing tools, libraries, and patterns before writing custom code. Use when about to implement something that might already exist.
4
+ origin: https://github.com/affaan-m/everything-claude-code
5
+ ---
6
+
7
+ Before writing any code, search for existing solutions:
8
+
9
+ 1. **Check the existing codebase** — grep for similar patterns, utilities, or abstractions that could be reused or extended.
10
+
11
+ 2. **Check npm/package registries** — is there a battle-tested library that solves 80%+ of the problem? Prefer adopting proven code over hand-rolling.
12
+
13
+ 3. **Check GitHub** — search for open-source implementations or reference code (use `gh search code` or `gh search repos`).
14
+
15
+ 4. Present your findings:
16
+ - What you found and why it does/doesn't fit
17
+ - Recommended approach: reuse, adapt, or build new
18
+ - If building new, sketch the interface before writing implementation
19
+
20
+ Only proceed to implementation after confirming the approach with the user.