Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samchon/prisma-markdown
Markdown generator of Prisma, including ERD and descriptions
https://github.com/samchon/prisma-markdown
Last synced: 3 days ago
JSON representation
Markdown generator of Prisma, including ERD and descriptions
- Host: GitHub
- URL: https://github.com/samchon/prisma-markdown
- Owner: samchon
- License: mit
- Created: 2023-09-13T02:00:08.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-05T04:55:12.000Z (7 months ago)
- Last Synced: 2025-01-03T12:19:43.906Z (12 days ago)
- Language: TypeScript
- Size: 441 KB
- Stars: 467
- Watchers: 8
- Forks: 24
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-prisma - `prisma-markdown` - Markdown generator, including ERD and descriptions
README
# Prisma Markdown
## Outline
[](https://github.com/samchon/prisma-markdown/blob/master/LICENSE)
[](https://www.npmjs.com/package/prisma-markdown)
[](https://www.npmjs.com/package/prisma-markdown)
[](https://github.com/samchon/prisma-markdown/actions?query=workflow%3Abuild)
Prisma markdown documents generator.
- Mermaid ERD diagrams
- Descriptions by `///` comments
- Separations by `@namespace` comments
If you want to see how markdown document being generated, visit below examples:
- Markdown Content: [samchon/prisma-markdown/ERD.md](https://github.com/samchon/prisma-markdown/blob/master/ERD.md)
- Prisma Schema: [samchon/prisma-markdown/schema.prisma](https://github.com/samchon/prisma-markdown/blob/master/schema.prisma)
[](https://github.com/samchon/prisma-markdown/blob/master/ERD.md)
## Setup
At first, install NPM package.
```bash
npm i -D prisma-markdown
```
At next, add the generator to the schema file.
```prisma
generator markdown {
provider = "prisma-markdown"
output = "./ERD.md"
title = "Shopping Mall"
}
```
At last, run below command, than [ERD.md](https://github.com/samchon/prisma-markdown/blob/master/ERD.md) file would be generated.
```bash
npx prisma generate
```
## Comment Tags
If your database has over hundreds of models, none of automatic ERD generators can express them perfect. In that case, `prisma-markdown` recommends you to separate hundreds of models to multiple paginated diagrams by using `/// @namespace ` comments.
When you write `/// @namespace ` comment on models, they would be separated to proper sections of markdown document. For reference, you can assign multiple `@namespace`s to a model, and if you do not assign any `@namespace` to a model, it would be assigned to `default` tag.
Also, if you use `@erd ` instead of `@namespace `, target model would be expressed only at ERD. It would not be appeared to the markdown content section. Otherwise, `@describe ` tag will show the model only at markdown content section, not at ERD.
- `@namespace `: Both ERD and markdown content
- `@erd `: Only ERD
- `@describe `: Only markdown content
- `@hidden`: Neither ERD nor markdown content
- `@minItems 1`: Mandatory relationship when 1: **N** (`||---|{`)
```prisma
/// Both description and ERD on Actors chatper.
///
/// Also, only ERD on Articles and Orders chapters.
///
/// @namespace Actors
/// @erd Articles
/// @erd Orders
model shopping_customers {
/// The tag "minItems 1" means mandatory relationship `||---|{`.
///
/// Otherwise, no tag means optional relationship `||---o{`.
///
/// @minItems 1
login_histories shopping_customer_login_histories[]
}
/// Only description on Actors chapter.
///
/// @describe Actors
model shopping_customer_login_histories {}
/// Only ERD on Articles chapter.
///
/// @erd Articles
model shopping_sale_reviews {}
/// Never be shown.
///
/// @hidden
model shopping_sale_hits {}
```
Additionally, when defining 1: N relationship, you can specify the N position to be whether optional or mandatory. If you want to configure the N position to be mandatory, just write the `@minItems 1` comment tag. Otherwise the N position is optional, you don't need to do anything.
```prisma
model shopping_sale_units {
/// @minItems 1
stocks shopping_sale_snapshot_unit_stocks[];
options shopping_sale_snapshot_unit_options[]; // optional
}
model shopping_sale_snapshot_unit_stocks {}
model shopping_sale_snapshot_unit_options {}
```