Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/keonik/prisma-erd-generator

Generate an ER Diagram based on your Prisma schema every time you run npx prisma generate
https://github.com/keonik/prisma-erd-generator

entity-relationship-diagram hacktoberfest mermaid prisma typescript

Last synced: about 1 month ago
JSON representation

Generate an ER Diagram based on your Prisma schema every time you run npx prisma generate

Host: GitHub
URL: https://github.com/keonik/prisma-erd-generator
Owner: keonik
License: mit
Created: 2021-06-18T05:10:27.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2023-11-29T02:34:56.000Z (about 1 year ago)
Last Synced: 2024-10-02T02:55:51.819Z (2 months ago)
Topics: entity-relationship-diagram, hacktoberfest, mermaid, prisma, typescript
Language: TypeScript
Homepage: https://www.npmjs.com/package/prisma-erd-generator
Size: 2.71 MB
Stars: 884
Watchers: 5
Forks: 49
Open Issues: 19
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-prisma - Prisma ERD Generator

README

# Prisma Entity Relationship Diagram Generator

[![All Contributors](https://img.shields.io/badge/all_contributors-20-orange.svg?style=flat-square)](#contributors-)

Prisma generator to create an ER Diagram every time you generate your prisma client.

> Like this tool? [@Skn0tt](https://github.com/Skn0tt) started this effort with his [web app ER diagram generator](https://prisma-erd.simonknott.de/)

```bash
npm i -D prisma-erd-generator @mermaid-js/mermaid-cli
# or
yarn add -D prisma-erd-generator @mermaid-js/mermaid-cli
```

Add to your `schema.prisma`

```prisma
generator erd {
provider = "prisma-erd-generator"
}
```

Run the generator

```bash
npx prisma generate
```

![Example ER Diagram](https://raw.githubusercontent.com/keonik/prisma-erd-generator/main/ERD.svg)

## Versions

- Prisma >= 4 use 1.x.x
- Prisma <4 use 0.11.x

## Options

Additional configuration

### Output

Change output type and location

Usage

```prisma
generator erd {
provider = "prisma-erd-generator"
output = "../ERD.svg"
}
```

Extensions

- svg (default: `./prisma/ERD.svg`)
- png
- pdf
- md

### Theme

Theme selection

Usage

```prisma
generator erd {
provider = "prisma-erd-generator"
theme = "forest"
}
```

Options

- default (default)
- forest
- dark
- neutral

This option does not accept environment variables or other dynamic values. If you want to change the theme dynamically, you can use the `theme` option in the `mermaidConfig` option. See [Mermaid Configuration](#mermaid-configuration) for more information.

### mmdcPath

In order for this generator to succeed you must have `mmdc` installed. This is the mermaid cli tool that is used to generate the ERD. By default the generator searches for an existing binary file at `/node_modules/.bin`. If it fails to find that binary it will run `find ../.. -name mmdc` to search through your folder for a `mmdc` binary. If you are using a different package manager or have a different location for your binary files, you can specify the path to the binary file.

```prisma
generator erd {
provider = "prisma-erd-generator"
theme = "forest"
mmdcPath = "node_modules/.bin"
}
```

#### Use with yarn 3+

Yarn 3+ doesn't create a `node_modules/.bin` directory for scripts when using the `pnp` or `pnpm` nodeLinkers ([see yarn documentation here](https://yarnpkg.com/migration/pnp#what-to-look-for)). It instead makes scripts available directly from the package.json file using `yarn `, which means that there won't be an `mmdc` file created at all. This issue can be solved by creating your own shell script named `mmdc` inside your project's files that runs `yarn mmdc` (note: this shell script does not need to be added to your package.json file's scripts section - prisma-erd-generatr will access this script directly).

An example `mmdc` script:

```sh
#!/bin/bash

# $@ passes the parameters that this mmdc script was run with along to the mermaid cli
yarn mmdc $@

```

Make this `mmdc` script executable by using the command `chmod +x mmdc`, then set the `mmdcPath` option to point to the directory where the `mmdc` file you've just created is stored.

### Disabled

You won't always need to generate a new ERD. For instance, when you are building your docker containers you often run `prisma generate` and if this generator is included, odds are you aren't relying on an updated ERD inside your docker container. It also adds additional space to the container because of dependencies such as puppeteer. There are two ways to disable this ERD generator.

1. Via environment variable

```bash
DISABLE_ERD=true
```

2. Via configuration

```prisma
generator erd {
provider = "prisma-erd-generator"
disabled = true
}
```

Another option used is to remove the generator lines from your schema before installing dependencies and running the `prisma generate` command. I have used `sed` to remove the lines the generator is located on in my `schema.prisma` file to do so. Here is an example of the ERD generator being removed on lines 5-9 in a dockerfile.

```dockerfile
# remove and replace unnecessary generators (erd generator)
# Deletes lines 5-9 from prisma/schema.prisma
RUN sed -i '5,9d' prisma/schema.prisma
```

### Debugging

If you have issues with generating or outputting an ERD as expected, you may benefit from seeing output of the steps to making your ERD. Enable debugging by either adding the following environment variable

```bash
ERD_DEBUG=true
```

or adding in the debug configuration key set to `true`

```prisma
generator erd {
provider = "prisma-erd-generator"
erdDebug = true
}
```

and re-running `prisma generate`. You should see a directory and files created labeling the steps to create an ER diagram under `prisma/debug`.

Please use these files as part of opening an issue if you run into problems.

### Table only mode

Table mode only draws your models and skips the attributes and columns associated with your table. This feature is helpful for when you have lots of table columns and they are less helpful than seeing the tables and their relationships

```prisma
generator erd {
provider = "prisma-erd-generator"
tableOnly = true
}
```

### Ignore enums

If you enable this option, enum entities will be hidden.
This is useful if you want to reduce the number of entities and focus on the tables and their columns and relationships.

```prisma
generator erd {
provider = "prisma-erd-generator"
ignoreEnums = true
}
```

### Include relation from field

By default this module skips relation fields in the result diagram. For example fields `userId` and `productId` will not be generated from this prisma schema.

```prisma
model User {
id String @id
email String
favoriteProducts FavoriteProducts[]
}

model Product {
id String @id
title String
inFavorites FavoriteProducts[]
}

model FavoriteProducts {
userId String
user User @relation(fields: [userId], references: [id])
productId String
product Product @relation(fields: [productId], references: [id])

@@id([userId, productId])
}

```

It can be useful to show them when working with RDBMS. To show them use `includeRelationFromFields = true`

```prisma
generator erd {
provider = "prisma-erd-generator"
includeRelationFromFields = true
}
```

### Disable emoji output

The emoji output for primary keys (`🗝️`) and nullable fields (`❓`) can be disabled, restoring the older values of `PK` and `nullable`, respectively.

```prisma
generator erd {
provider = "prisma-erd-generator"
disableEmoji = true
}
```

### Mermaid configuration

Overriding the default mermaid configuration may be necessary to represent your schema in the best way possible. There is an example mermaid config [here](./example-mermaid-config.js) that you can use as a starting point. In the example JavaScript file, types are referenced to view all available options. You can also view them [here](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts). The most common use cases for needing to overwrite mermaid configuration is for theming and default sizing of the ERD.

```prisma
generator erd {
provider = "prisma-erd-generator"
mermaidConfig = "mermaidConfig.json"
}
```

### Puppeteer configuration

If you want to change the configuration of Puppeteer, create a [Puppeteer config file (JSON)](https://pptr.dev/guides/configuration#configuration-files) and pass the file path to the generator.

```prisma
generator erd {
provider = "prisma-erd-generator"
puppeteerConfig = "../puppeteerConfig.json"
}
```

## Issues

Because this package relies on [mermaid js](https://mermaid.js.org/) and [puppeteer](https://pptr.dev/) issues often are opened that relate to those libraries causing issues between different versions of Node.js and your operating system. As a fallback, if you are one of those people not able to generate an ERD using this generator, try running the generator to output a markdown file `.md` first. Trying to generate a markdown file doesn't run into puppeteer to represent the contents of a mermaid drawing in a browser and often will succeed. This will help get you a functioning ERD while troubleshooting why puppeteer is not working for your machine. Please open an issue if you have any problems or suggestions.

### 🔴 **ARM64 Users** 🔴

Puppeteer does not yet come shipped with a version of Chromium for arm64, so you will need to point to a Chromium executable on your system.
More details on this issue can be found [here](https://github.com/puppeteer/puppeteer/issues/7740).

**MacOS Fix:**

Install Chromium using Brew:

```bash
brew install --cask --no-quarantine chromium
```

You should now see the path to your installed Chromium.

```bash
which chromium
```

The generator will use this Chromium instead of the one provided by Puppeteer.

**Other Operating Systems:**

This can be fixed by either:

- Setting the `executablePath` property in your puppeteer config file to the file path of the Chromium executable on your system.
- Setting the following global variables on your system
```
PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
PUPPETEER_EXECUTABLE_PATH=path_to_your_chromium
```

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{John Fay}
🚧 💻 🤔 🐛

_{Jonas Strassel}
🐛 💻

_{Steve Gray}
💻 🤔

_{Jason Abbott}
🐛 💻

_{Manuel Maute}
🐛 💻

_{James Homer}
💻

_{Jan Piotrowski}
🐛 💻 👀

_{Luke Evers}
💻

_rikuyam
💻

_{Francis Manansala}
🐛

_{Vitalii Yarmus}
💻

_{Petri Julkunen}
🐛

_D-PONTARO
💻

_{Stephen Ramthun}
📖

_{Tristan Chin}
💻

_{Brandin Canfield}
💻

_{kota marusue}
📖

_Lucia
🐛

_{Austin Ziegler}
💻

_{Janeene Beeforth}
📖