@nonsoo/prisma-mermaid 0.1.0 → 0.1.2

package/README.md

@@ -1,6 +1,6 @@
 # Prisma to Mermaid Generator
 
-Generate Mermaid class diagrams and Mermaid ERD diagrams directly from your Prisma schema. This package exposes a Prisma generator that runs during `prisma generate` as well as two programmatic helpers -- generateMermaidClass and generateMermaidERD.
+Generate Mermaid class diagrams and Mermaid ERD diagrams directly from your Prisma schema. This package exposes a Prisma generator that runs during `prisma generate` as well as two helpers functions -- generateMermaidClass and generateMermaidERD.
 
 ## Installation
 
@@ -10,7 +10,7 @@ npm i --save-dev @nonsoo/prisma-mermaid @mermaid-js/mermaid-cli
 
 ## Usage (Prisma Generator)
 
-Add the following generator to your prisma schema
+Add the following generator to your prisma schema and run `npx prisma generate` in your terminal.
 
 ```prisma
 generator diagram {
@@ -20,9 +20,17 @@ generator diagram {
 }
 ```
 
-`format` Options
+Once Mermaid files `.mmd` are generated you can use the mermaid cli to render the file as an SVG, PNG, embed it in Markdown, etc.
 
-| Value         | Description                       |
+Run the the following command to generate SVG
+
+```bash
+npx mmdc -i <path/input-file>.mmd -o <path/output-file>.svg
+```
+
+### Format options
+
+| Format Value  | Description                       |
 | ------------- | --------------------------------- |
 | mermaid-erd   | Generates a Mermaid ERD diagram   |
 | mermaid-class | Generates a Mermaid class diagram |
@@ -56,10 +64,10 @@ await generateMermaidERD({
 });
 ```
 
-## Philosophy
+## Purpose
 
 Documentation should evolve alongside the code it describes. Diagrams-as-code tools such as Mermaid make it easier for teams to maintain clear, accurate diagrams as their systems grow and change. However, creating these diagrams manually — especially for database schemas — still introduces friction and the risk of diagrams falling out of sync with the system.
 
-Prisma already provides a single source of truth for your data model through the Prisma schema. Therefore, by generating diagrams directly from this schema, we can ensure documentation stays automatically aligned with the current state of the database models.
+Prisma already provides a single source of truth for your data model through the Prisma schema. Therefore, by generating diagrams directly from the schema, we can ensure documentation stays automatically aligned with the current state of the database models.
 
-This library bridges that gap. It transforms your Prisma schema into Mermaid-powered ERD or class diagrams, combining code generation with diagrams-as-code. Once generated, these diagrams can be used to create Markdown files, SVGs, PDFs, or any other Mermaid-supported output — always consistent, always up to date.
+This library bridges that gap. It transforms your Prisma schema into a Mermaid ERD or class diagrams, combining code generation with diagrams-as-code. Once generated, these diagrams can be used to create Markdown files, SVGs, PDFs, or any other Mermaid-supported output — always consistent, always up to date.

package/build/lib/PrismaMermaidGenerators/bin.cjs

@@ -1727,7 +1727,7 @@ var prismaGenerators = /* @__PURE__ */ new Map([
 // package.json
 var package_default = {
   name: "@nonsoo/prisma-mermaid",
-  version: "0.1.0",
+  version: "0.1.2",
   description: "A Prisma generator that generates Mermaid Class or ER diagrams from your Prisma schema.",
   main: "build/index.js",
   bin: {
@@ -1737,9 +1737,6 @@ var package_default = {
   files: [
     "build"
   ],
-  publishConfig: {
-    access: "public"
-  },
   scripts: {
     build: "tsup",
     lint: "eslint .",
@@ -1792,7 +1789,6 @@ var package_default = {
     vitest: "^4.0.10"
   },
   peerDependencies: {
-    prisma: "^6.10.0 || ^7.0.0",
     "@prisma/client": "^6.0.0 || ^7.0.0"
   },
   dependencies: {

package/build/lib/PrismaMermaidGenerators/bin.js

@@ -1732,7 +1732,7 @@ var prismaGenerators = /* @__PURE__ */ new Map([
 // package.json
 var package_default = {
   name: "@nonsoo/prisma-mermaid",
-  version: "0.1.0",
+  version: "0.1.2",
   description: "A Prisma generator that generates Mermaid Class or ER diagrams from your Prisma schema.",
   main: "build/index.js",
   bin: {
@@ -1742,9 +1742,6 @@ var package_default = {
   files: [
     "build"
   ],
-  publishConfig: {
-    access: "public"
-  },
   scripts: {
     build: "tsup",
     lint: "eslint .",
@@ -1797,7 +1794,6 @@ var package_default = {
     vitest: "^4.0.10"
   },
   peerDependencies: {
-    prisma: "^6.10.0 || ^7.0.0",
     "@prisma/client": "^6.0.0 || ^7.0.0"
   },
   dependencies: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nonsoo/prisma-mermaid",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "A Prisma generator that generates Mermaid Class or ER diagrams from your Prisma schema.",
   "main": "build/index.js",
   "bin": {
@@ -10,9 +10,6 @@
   "files": [
     "build"
   ],
-  "publishConfig": {
-    "access": "public"
-  },
   "scripts": {
     "build": "tsup",
     "lint": "eslint .",
@@ -65,7 +62,6 @@
     "vitest": "^4.0.10"
   },
   "peerDependencies": {
-    "prisma": "^6.10.0 || ^7.0.0",
     "@prisma/client": "^6.0.0 || ^7.0.0"
   },
   "dependencies": {