prisma-generator-plantuml-erd 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/README.md +70 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
## [1.0.2](https://github.com/dbgso/prisma-generator-plantuml-erd/compare/v1.0.1...v1.0.2) (2022-11-08)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* package-lock.json ([#13](https://github.com/dbgso/prisma-generator-plantuml-erd/issues/13)) ([492c425](https://github.com/dbgso/prisma-generator-plantuml-erd/commit/492c42537594c54e5e704b8cf9463cb562ee7bb2))
|
|
7
|
+
|
|
1
8
|
## [1.0.1](https://github.com/dbgso/prisma-generator-plantuml-erd/compare/v1.0.0...v1.0.1) (2022-11-08)
|
|
2
9
|
|
|
3
10
|
|
package/README.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# prisma-generator-plantuml-erd
|
|
2
|
+
|
|
3
|
+
Prisma generator to create an ER Diagram for plantuml.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
# usage
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
npm i -D prisma-generator-plantuml-erd
|
|
11
|
+
# or
|
|
12
|
+
yarn add -D prisma-generator-plantuml-erd
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Add to your schema.prisma
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
generator erd_plantuml {
|
|
19
|
+
provider = "prisma-generator-plantuml-erd"
|
|
20
|
+
output = "erd.puml"
|
|
21
|
+
}
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
# Versions
|
|
25
|
+
|
|
26
|
+
This generator only support prisma3.
|
|
27
|
+
If you use the version greater than 4, this plugin is not work.
|
|
28
|
+
|
|
29
|
+
# Options
|
|
30
|
+
|
|
31
|
+
## output
|
|
32
|
+
|
|
33
|
+
The path of generated plantuml file path.
|
|
34
|
+
The default value is './erd.puml'
|
|
35
|
+
|
|
36
|
+
## usePhysicalTableName
|
|
37
|
+
|
|
38
|
+
If this flag is true, physical table name is used for name of table on er diagram.
|
|
39
|
+
The default value is false;
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
model User {
|
|
44
|
+
id String @id
|
|
45
|
+
|
|
46
|
+
@map("users")
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
If this flag is set to true, then "users" will be displayed on the diagram, otherwise "user" is displayed on the diagram.
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
## exportPerTables
|
|
54
|
+
|
|
55
|
+
If this flag is true, generate some tables
|
|
56
|
+
If this flag is true, it also generate some diargrams that based on each table.
|
|
57
|
+
The diagrams is rendered with only the tables that related with base table.
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
## Example
|
|
61
|
+
|
|
62
|
+
The example config is here.
|
|
63
|
+
|
|
64
|
+
```
|
|
65
|
+
output: "path/to/output.puml",
|
|
66
|
+
usePhysicalTableName: true,
|
|
67
|
+
lineLength: "---"
|
|
68
|
+
exportPerTables: true
|
|
69
|
+
```
|
|
70
|
+
|