| version | 1.0.0 |
| name | testdata-builders |
| description | Maintain deterministic builders for schema entities. Activate when authoring tests, extending testkit, or adding schema fields that affect fixtures.
|
| category | quality |
| allowed-tools | Read Write Edit Grep Glob |
| license | MIT |
Skill: testdata-builders
Purpose: provide consistent factories/builders for schema entities (books, grants, sessions, annotations) to keep tests concise and deterministic.
When to run
- Authoring or refactoring tests in Vitest/Playwright.
- Extending
packages/testkit or seeding data for Worker integration tests.
- Adding new schema fields that affect fixtures.
Inputs
packages/testkit/src/*packages/schema/migrations/*packages/shared/src/dtos.ts
Workflow
- Catalog entities – list required builders (book, grant, session, progress, bookmark, highlight, comment).
- Define defaults – choose realistic base values (locale, capability flags, timestamps) aligned with ADRs.
- Implement builder – pure function returning object +
withOverrides pattern for customization; ensure types exported.
- Helpers – add
makeGrantWithCapabilities, makeSessionToken, makeAnnotationLocator utilities.
- Docs – update README within
packages/testkit to explain builder usage.
- Usage – refactor tests to import builders instead of ad-hoc inline objects.
Checklist
