3.0 KiB
3.0 KiB
id, epic, title, type, status, feature, depends-on, blocks
| id | epic | title | type | status | feature | depends-on | blocks | |
|---|---|---|---|---|---|---|---|---|
| 07-generator-pre-shipped-traces | 2026-05-14-library-evaluation-policy | Generator templates — pre-shipped traces for optional core packages | technical-story | done | tooling |
|
Goal
Update the five optional-core generator templates (events, realtime, audit, trpc, ui) so that when pnpm turbo gen core-package <name> runs, it copies pre-written decision: approved library traces into docs/library-decisions/ for every direct runtime dependency of that core package. Update the corresponding __snapshots__ files so the snapshot tests cover the new trace files.
Why
A developer who scaffolds an optional core via the generator should not immediately face a pre-commit failure for its bundled deps — the generator is the policy-compliant path, so the traces should land by construction. Without pre-shipped traces, the very act of using the generator would trigger the enforcement gate it's supposed to clear.
Done when
- Each of the five generator templates (
turbo/generators/templates/core-package/{events,realtime,audit,trpc,ui}/) contains adocs/library-decisions/subtree with one.mdtrace file per direct runtime dependency of that core, dated at generation time (use the template variable for date, or freeze to the scaffold date with a comment),decision: approved, and citing the relevant ADR (events→ ADR-015,realtime→ ADR-016,audit→ ADR-018;trpcanduicite their closest ADR ornullif none). - The generator copies these files into the workspace when run.
- The
turbo/generators/__snapshots__/core-package/<name>.snapshot.jsonfiles are updated to include the new trace files;pnpm turbo gen core-package events(or any other optional core) passes the existing snapshot test. pnpm lint && pnpm fallow:auditpass.
In scope
turbo/generators/templates/core-package/events/— pre-shipped trace(s).turbo/generators/templates/core-package/realtime/— pre-shipped trace(s).turbo/generators/templates/core-package/audit/— pre-shipped trace(s).turbo/generators/templates/core-package/trpc/— pre-shipped trace(s).turbo/generators/templates/core-package/ui/— pre-shipped trace(s).- Snapshot JSON updates for all five cores.
- Generator copy logic (if not already handled by the template mechanism).
Out of scope
- Backfill traces for already-installed optional cores in the live workspace — Story 08.
- Generator templates for non-core-package generators (feature, event, job, realtime, component) — no runtime deps are emitted by those generators.
Tasks
- Inventory the direct runtime deps of each of the five optional core generator templates (read each template's
package.json); write one approved trace file per dep in the correct generator template subtree with ADR citation; update the five snapshot JSON files to include the new trace file entries; verifypnpm turbo gen core-package events(or equivalent dry-run) matches the updated snapshot; all gates pass on this single commit.