AI Assistant Skill
The npm package ships a machine-oriented instruction file — AI_SKILL.md — written for AI coding assistants (and any tooling that consumes agent instructions). It condenses everything an assistant needs to use Forger correctly: transformer wiring, the API, verified type-to-result behavior, generation rules, and a troubleshooting table.
Location
Inside an installed dependency:
The file is part of the published package (listed in files in package.json), so it is available in every project that installs @artstesh/forger — no extra step needed.
Using it with an assistant
Point your AI tooling at the file path above, or paste it into the assistant's context when working on tests in the project.
In agent-driven workflows (Claude Code, Cursor rules, custom prompts), reference it as the source of truth for Forger usage; it stays in sync with the library behavior since it ships from the same repository and release.
The file is plain Markdown with a skill header — consumable by any prompt pipeline.
What it covers
Section | Content |
|---|---|
When to use | Scenarios where Forger fits (and where it does not) |
Hard requirement | Transformer wiring snippets for tsconfig and jest |
API |
|
SpoofSettings | Full option table with defaults |
Type behavior | Verified matrix of what every type kind produces |
Generation rules | How to write stable assertions over random data |
Troubleshooting | Symptom → cause → fix table |
Human-oriented documentation for the same areas lives in How it works, Supported types, and Caveats.