git:20260924.d2ad8a7 to git:20261028.6945601

23 added, 105 removed. Audit A to A.

What this update changes in the checks

No check changed: every fixed check gives the same answer before and after this update.

A tripped check is a label, not a verdict: read the matched text and the lines below. This week's updates that newly trip a check.

---
name: codebase-design
- description: Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find deepening opportunities, decide where a seam goes, make code more testable or AI-navigable, or when another skill needs the deep-module vocabulary.
+ description: Designs deep modules with narrow public interfaces and explicit test seams tailored to the user's chosen architecture using the Design-It-Twice method. Use when designing module interfaces, choosing where to place test seams, or refactoring shallow modules.
---
- # Codebase Design
-
- Design **deep modules**: a lot of behaviour behind a small interface, placed at a clean seam, testable through that interface. Use this language and these principles wherever code is being designed or restructured. The aim is leverage for callers, locality for maintainers, and testability for everyone.
-
- ## Glossary
-
- Use these terms exactly: don't substitute "component," "service," "API," or "boundary." Consistent language is the whole point.
-
- **Module**: anything with an interface and an implementation. Deliberately scale-agnostic: a function, class, package, or tier-spanning slice. _Avoid_: unit, component, service.
-
- **Interface**: everything a caller must know to use the module correctly: the type signature, but also invariants, ordering constraints, error modes, required configuration, and performance characteristics. _Avoid_: API, signature (too narrow, they refer only to the type-level surface).
-
- **Implementation**: 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 (a test-suite adapter). Reach for "adapter" when the seam is the topic; "implementation" otherwise.
-
- **Depth**: 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, **shallow** when the interface is nearly as complex as the implementation.
-
- **Seam** _(Michael Feathers)_: a place where you can alter behaviour without editing in that place; the *location* at which a module's interface lives. Where to put the seam is its own design decision, distinct from what goes behind it. _Avoid_: boundary (overloaded with DDD's bounded context).
-
- **Adapter**: a concrete thing that satisfies an interface at a seam. Describes *role* (what slot it fills), not substance (what's inside).
-
- **Leverage**: what callers get from depth. More capability per unit of interface they learn. One implementation pays back across N call sites and M tests.
-
- **Locality**: what maintainers get from depth. Change, bugs, knowledge, and verification concentrate in one place rather than spreading across callers. Fix once, fixed everywhere.
-
- ## Deep vs shallow
-
- **Deep module** = small interface + lots of implementation:
-
- ```
- ┌─────────────────────┐
- │ Small Interface │ ← Few methods, simple params
- ├─────────────────────┤
- │ │
- │ Deep Implementation│ ← Complex logic hidden
- │ │
- └─────────────────────┘
- ```
-
- **Shallow module** = large interface + little implementation (avoid):
-
- ```
- ┌─────────────────────────────────┐
- │ Large Interface │ ← Many methods, complex params
- ├─────────────────────────────────┤
- │ Thin Implementation │ ← Just passes through
- └─────────────────────────────────┘
- ```
-
- When designing an interface, ask:
-
- - Can I reduce the number of methods?
- - Can I simplify the parameters?
- - Can I hide more complexity inside?
-
- ## Principles
-
- - **Depth is a property of the interface, not the implementation.** A deep module can be internally composed of small, modular, 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.
- - **The 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.
- - **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.
- - **One adapter means a hypothetical seam. Two adapters means a real one.** Don't introduce a seam unless something actually varies across it.
-
- ## Designing for testability
-
- Good interfaces make testing natural:
-
- 1. **Accept dependencies, don't create them.**
-
- ```typescript
- // Testable
- function processOrder(order, paymentGateway) {}
-
- // Hard to test
- function processOrder(order) {
- const gateway = new StripeGateway();
- }
- ```
-
- 2. **Return results, don't produce side effects.**
-
- ```typescript
- // Testable
- function calculateDiscount(cart): Discount {}
-
- // Hard to test
- function applyDiscount(cart): void {
- cart.total -= discount;
- }
- ```
-
- 3. **Small surface area.** Fewer methods = fewer tests needed. Fewer params = simpler test setup.
-
- ## Relationships
+ # Codebase Design (Deep Modules, Seams & 6 Pillars)
- - A **Module** has exactly one **Interface** (the surface it presents to callers and tests).
- - **Depth** is a property of a **Module**, measured against its **Interface**.
- - A **Seam** is where a **Module**'s **Interface** lives.
- - An **Adapter** sits at a **Seam** and satisfies the **Interface**.
- - **Depth** produces **Leverage** for callers and **Locality** for maintainers.
+ Design module interfaces within the **user's chosen architecture** that maximize **depth** (high internal capability behind a small, stable interface), place **seams** only at genuine boundaries, and uphold the **6 Engineering Pillars** (*Future-Proof, Scalable, Maintainable, Secure, High-Performance, Upgradeable*).
- ## Rejected framings
+ ## Decision tree
- - **Depth as ratio of implementation-lines to interface-lines** (Ousterhout): rewards padding the implementation. We use depth-as-leverage instead.
- - **"Interface" as the TypeScript `interface` keyword or a class's public methods**: too narrow: interface here includes every fact a caller must know.
- - **"Boundary"**: overloaded with DDD's bounded context. Say **seam** or **interface**.
+ 1. **Has the user defined their preferred project architecture and module layout yet?**
+ - **No** → Do not impose a static folder hierarchy! Interview the user first via `ask_question` or `/grill-me` to agree on the project's module topology.
+ - **Yes** → Proceed to step 2.
+ 2. **Can the new capability live inside an existing module without widening its public interface?**
+ - **Yes** → Extend the existing module internally. Do not create a new file, wrapper class, or pass-through layer.
+ - **No** → Proceed to step 3.
+ 3. **Does the module cross an external I/O or third-party boundary (database, external API, queue, filesystem, clock)?**
+ - **Yes** → Define a narrow **seam** at the boundary so callers stay **Upgradeable** (easy to swap providers) and deterministically testable without live infrastructure.
+ - **No (internal logic)** → Expose concrete functions or types directly; do not create 1:1 `IFoo` interfaces for single-implementation internal code.
+ 4. **Is the interface non-trivial?**
+ - **Yes** → Run **Design It Twice** below before writing implementation code.
- ## Going deeper
+ ## Design workflow
- - **Deepening a cluster given its dependencies**, see [DEEPENING.md](DEEPENING.md): dependency categories, seam discipline, and replace-don't-layer testing.
- - **Exploring alternative interfaces**, see [DESIGN-IT-TWICE.md](DESIGN-IT-TWICE.md): spin up parallel sub-agents to design the interface several radically different ways, then compare on depth, locality, and seam placement.
+ 1. **Design It Twice**:
+ - Sketch **Design A** (minimal evolutionary extension) and **Design B** (a deeper module hiding more policy, concurrency safety, and edge cases behind fewer exported functions).
+ - Compare both across the **6 Engineering Pillars**: *Future-Proof, Scalable, Maintainable, Secure, High-Performance, Upgradeable*.
+ 2. **Minimize the interface**:
+ - Ask for every exported function/method: *Can I reduce the number of methods? Can I simplify the parameters? Can I pull configuration defaults or edge-case handling inside the module?*
+ 3. **Verify locality & upgradeability**:
+ - Ensure a single business rule change or dependency upgrade requires editing only this module rather than scattering edits across callers.