generate_factory
Creates reusable test factories for BackGen resources, generating valid instances with sensible defaults and faker-based data to simplify test setup.
Instructions
Creates a test factory file for a resource — a reusable builder that generates valid resource instances with sensible defaults for writing tests. Factories let you create test data in one line (e.g. createProduct({ name: 'Widget' })) instead of manually constructing full objects with required fields, timestamps, and relations every time. The generated factory is ORM-aware: it uses the same schema as your generated resource. Factories are written to src/factories/.factory.ts and use the faker library for realistic default values. Run generate_resource for a resource first — the factory matches its fields. Only PascalCase resource names are valid (e.g. 'Product', not 'product').
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| resource | Yes | Resource name in PascalCase — must start with an uppercase letter. Examples: 'Product', 'User', 'Appointment'. Must match an existing resource generated by generate_resource. | |
| dir | No | Absolute or relative path to the BackGen-generated project directory. Defaults to the current working directory. Example: '/home/user/projects/my-api'. |