nilportugues / prisma-trpc-generator

Prisma 2+ generator to emit fully implemented tRPC routers

Prisma tRPC Generator

A Prisma generator that automates creating your tRPC routers from your Prisma schema.
Explore the options »

Report Bug · Request Feature

Table of Contents

• About The Project
• Installation
• Usage
• Additional Options
• Community

About The Project

Automatically generate fully implemented tRPC routers from your Prisma Schema. This includes routers, app router and of course all input schemas using Zod. Updates every time npx prisma generate runs.

Installation

Using npm:

 npm install prisma-trpc-generator

Using yarn:

 yarn add prisma-trpc-generator

Usage

1- Star this repo 😉

2- Add the generator to your Prisma schema

generator trpc {
  provider       = "prisma-trpc-generator"
  withMiddleware = false
  withShield     = false
}

3- Enable strict mode in tsconfig as it is required by Zod, and considered a Typescript best practice

{
  "compilerOptions": {
    "strict": true
  }
}

4- Running npx prisma generate for the following schema.prisma

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
  posts Post[]
}

model Post {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  title     String
  content   String?
  published Boolean  @default(false)
  viewCount Int      @default(0)
  author    User?    @relation(fields: [authorId], references: [id])
  authorId  Int?
}

will generate

5- Don't forget to supply your Context type inside ./routers/helpers/createRouter.ts. You should check the official tRPC docs for reference.

Additional Options

Option	Description	Type	Default
output	Output directory for the generated routers and zod schemas	string	./generated
withMiddleware	Attaches a global middleware that runs before all procedures	boolean	true
withShield	Generates a tRPC Shield to use as a permissions layer	boolean	true

Use additional options in the schema.prisma

generator trpc {
  provider       = "prisma-trpc-generator"
  output         = "./trpc"
  withMiddleware = false
  withShield     = false
}

Community