npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

prisma-uml

v1.1.18

Published

A CLI to transform a Prisma schema to a PlantUML Entity RelationShip Diagram

Downloads

5,851

Readme

A CLI to transform a Prisma schema to a PlantUML Entity RelationShip Diagram

npm npm CircleCI (all branches)

Installation

Using npx

If you don't want to install the CLI but just execute it, you can use it through npx this way

npx prisma-uml --help

Install with npm

You can also install the CLI globally

npm i -g prisma-uml
prisma-uml --help

Commands

prisma-uml <path> [options]

Generate a plantUML from a Prisma schema

prisma-uml <path> [--output] [--server] [--file]

Argument

| Name | Description | |----------|------------------------| | path | Path to Prisma schema. |

Options

| Name | Alias | Description | Type / Choices | Default | |--------------|-------|--------------------------------------|--------------------------------------|-----------------------------------| | --output | -o | Output of the diagram | string / [text | svg | png | jpg] | text | | --server | -s | PlantUML Server URL | string | https://www.plantuml.com/plantuml | | --file | -f | Filename or File full path to output | string | |

# Output a plantUML Entity Relation Diagram as text
prisma-uml ./schema.prisma

# Save the diagram into a .plantuml file
prisma-uml ./schema.prisma > my-erd.plantuml

# Output a diagram as SVG
prisma-uml ./schema.prisma --output svg --file my-erd.svg

# Output a diagram as PNG
prisma-uml ./schema.prisma -o png -f my-erd.png

#  Use a plantUML custom server to render the image
prisma-uml ./schema.prisma --server http://localhost:8080

Image Rendering

Using the official PlantUML server online

PlantUML usually requires to have Java installed or a server to render the images. By default the official online server (https://www.plantuml.com/plantuml) is used to render the images. The plantUML diagram is first compressed then encoded (plantUML encoding) and finally sent to the server to execute the rendering.

Using a local server with Docker

You might want to avoid sending your diagram over the wire for some reason, prisma-uml allows you to specify a custom/local server. You could easily run your own local server using Docker:

docker run -d -p 8080:8080 plantuml/plantuml-server:jetty

You server is now available (depending of you Docker installation) at http://localhost:8080. You can then use prisma-uml as follow:

prisma-uml ./schema.prisma --server http://localhost:8080

Demo

asciicast

Incoming changes

  • [ ] Feat: Split attributes by entity (scalar, enum, navigation fields / external type).
  • [ ] Feat: Group relations by entities.
  • [ ] Feat: NextJs Preview that run the CLI on server to render a prisma schema to a plantUML ERD ?
  • [ ] Feat: Display Version Number
  • [ ] Feat: Handle -o text -f my-erd.puml|.wsd|.plantuml...
  • [ ] Remove --output in favor of extension handling (.svg, .png, .jpg, .puml...) (?)
  • [ ] Fix: Multiple cardinalities when should be online one (see simple example)
  • [ ] Feat: Add logging to stdout to describe what the CLI is doing

Authors

👤 Brendan Stromberger

👤 Yann Renaudin

Show your support

Give a ⭐️ if this project helped you!