@matserdam/prisma-neighborhood 0.1.0 → 0.3.0

package/README.md

@@ -1,6 +1,6 @@
 # prisma-neighbourhood
 
-Generate focused ERD diagrams from a Prisma schema by starting from one model and traversing relationships up to a configurable depth.
+Generate focused ERD diagrams from a Prisma schema by starting from any entity (model, view, or enum) and traversing relationships up to a configurable depth.
 
 The npm package is **`@matserdam/prisma-neighborhood`** and it exposes two CLI commands:
 
@@ -20,6 +20,12 @@ bunx @matserdam/prisma-neighborhood -s ./prisma/schema.prisma -m User
 # Limit to direct relationships only (depth 1)
 bunx @matserdam/prisma-neighborhood -s ./prisma/schema.prisma -m User -d 1
 
+# Start from a view (shows view + related enums/models)
+bunx @matserdam/prisma-neighborhood -s ./prisma/schema.prisma -m UserSummary -d 2
+
+# Start from an enum (shows enum + all models/views using it)
+bunx @matserdam/prisma-neighborhood -s ./prisma/schema.prisma -m UserRole -d 2
+
 # Write Mermaid to a file (use .mmd or .md)
 bunx @matserdam/prisma-neighborhood -s ./prisma/schema.prisma -m User -o erd.mmd
 
@@ -50,7 +56,7 @@ prisma-hood -s ./prisma/schema.prisma -m User
 | Option | Alias | Description | Default |
 |--------|-------|-------------|---------|
 | `--schema <path>` | `-s` | Path to the Prisma schema file | required |
-| `--model <name>` | `-m` | Model to start traversal from | required |
+| `--model <name>` | `-m` | Entity to start traversal from (model, view, or enum) | required |
 | `--depth <n>` | `-d` | Relationship levels to traverse | `3` |
 | `--renderer <name>` | `-r` | Renderer to use | `vector` |
 | `--output <file>` | `-o` | Write to a file instead of stdout | stdout |
@@ -69,6 +75,32 @@ The output format is determined by the file extension:
 | `.png` | PNG image |
 | `.pdf` | PDF |
 
-## No Puppeteer / Chromium
+## Entity types
+
+### Models
+Standard Prisma models are rendered as plain ERD entities.
+
+### Views
+Views (requires `previewFeatures = ["views"]`) are rendered with a `[view]` prefix:
+```
+"[view] UserSummary" {
+  Int id UK
+  String email
+}
+```
+
+### Enums
+Enums are rendered with an `[enum]` prefix, with the enum name as the type for each value:
+```
+"[enum] UserRole" {
+  UserRole ADMIN
+  UserRole USER
+  UserRole GUEST
+}
+```
+
+## Traversal behavior
 
-SVG/PNG/PDF export is implemented without headless Chromium, so you no longer need to install OS-level Chromium dependencies.
+- **From a model**: Traverses relations to other models/views, and enum fields to enums
+- **From a view**: Traverses relations to models/views, and enum fields to enums
+- **From an enum**: Finds all models/views using this enum, then traverses their relations

package/dist/_tests_/traverser.test.d.ts

@@ -1,6 +1,6 @@
 /**
- * @fileoverview Tests for the model traverser.
- * Tests cover BFS traversal, depth limiting, and cycle detection.
+ * @fileoverview Tests for the entity traverser.
+ * Tests cover BFS traversal of models, views, and enums with depth limiting.
  */
 export {};
 //# sourceMappingURL=traverser.test.d.ts.map

package/dist/cli/commands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/cli/commands.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAmCpC;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,OAAO,CA2BvC;AAqID;;;;GAIG;AACH,wBAAsB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAG1D"}
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/cli/commands.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAmCpC;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,OAAO,CA8BvC;AAqID;;;;GAIG;AACH,wBAAsB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAG1D"}