Skip to content

Provide workflow instructions for how to develop / test your custom generator #292

@JoeRoddy

Description

@JoeRoddy

Hi! Awesome project btw!

Is your feature request related to a problem? Please describe.

Spent about an hour digging through the source code to get a feel for how everything is working. Would be convenient to have explicit directions on how to make changes to the generator and test the updates. I'm now able to make changes and test them in the /usage directory, but tbh I'm still not sure if I'm technically using it correctly.

I feel like the documentation of the usage of the generated codebase is somewhat lacking.

Describe the solution you'd like

Documentation on the correct workflow for making changes to your generator and testing them. Right now my workflow is:

  1. Make changes to /packages/generator/src/generator.ts
  2. cd /packages/generator && npm run prepack
  3. cd /packages/usage && npx prisma migrate

Not sure if there's an easier way, but that's what I arrived at via trial and error.

Could also provide a QOL script in the base directory's package.json:
"generate": "cd packages/generator && npm run prepack && cd ../usage && npx prisma generate"

Thanks again for your time making this great project!

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions