prisma-generator-plantuml-erd 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [1.0.2](https://github.com/dbgso/prisma-generator-plantuml-erd/compare/v1.0.1...v1.0.2) (2022-11-08)
+
+
+### Bug Fixes
+
+* 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))
+
+## [1.0.1](https://github.com/dbgso/prisma-generator-plantuml-erd/compare/v1.0.0...v1.0.1) (2022-11-08)
+
+
+### Bug Fixes
+
+* delete unnecessary code ([457fff9](https://github.com/dbgso/prisma-generator-plantuml-erd/commit/457fff95aff5ef058f36fc5ca32149931e5e9c42))
+* output default value ([62641c3](https://github.com/dbgso/prisma-generator-plantuml-erd/commit/62641c3bcfaea875fea6f47e51a7bdd37536a0d7))
+
 # 1.0.0 (2022-11-08)
 
 

package/README.md

@@ -0,0 +1,70 @@
+# prisma-generator-plantuml-erd
+
+Prisma generator to create an ER Diagram for plantuml.
+
+
+# usage
+
+
+```
+npm i -D prisma-generator-plantuml-erd
+# or
+yarn add -D prisma-generator-plantuml-erd
+```
+
+Add to your schema.prisma
+
+```
+generator erd_plantuml {
+  provider   = "prisma-generator-plantuml-erd"
+  output = "erd.puml"
+}
+```
+
+# Versions
+
+This generator only support prisma3.
+If you use the version greater than 4, this plugin is not work.
+
+# Options
+
+## output
+
+The path of generated plantuml file path.
+The default value is './erd.puml'
+
+## usePhysicalTableName
+
+If this flag is true, physical table name is used for name of table on er diagram.
+The default value is false;
+
+
+```
+model User {
+  id            String         @id
+
+  @map("users")
+}
+```
+
+If this flag is set to true, then "users" will be displayed on the diagram, otherwise "user" is displayed on the diagram.
+ 
+
+## exportPerTables
+
+If this flag is true, generate some tables 
+If this flag is true, it also generate some diargrams that based on each table.
+The diagrams is rendered with only the tables that related with base table.
+
+
+## Example
+
+The example config is here.
+
+```
+  output: "path/to/output.puml",
+  usePhysicalTableName: true,
+  lineLength: "---"
+  exportPerTables: true
+```
+

package/dist/generator.js

@@ -13,12 +13,20 @@ const { version } = require('../package.json');
         };
     },
     onGenerate: async (options) => {
-        var _a;
+        const output = getOutput(options);
         const generator = new plantuml_erd_1.PlantUmlErdGenerator({
-            output: (_a = options.generator.output) === null || _a === void 0 ? void 0 : _a.value,
+            output: output,
             ...options.generator.config,
         });
         await generator.generate(options.dmmf);
     },
 });
+function getOutput(options) {
+    if (options.generator.output) {
+        if (options.generator.output.fromEnvVar === null) {
+            return options.generator.output.value;
+        }
+    }
+    return undefined;
+}
 //# sourceMappingURL=generator.js.map

package/dist/generator.js.map

@@ -1 +1 @@
-{"version":3,"file":"generator.js","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":";;AAAA,+DAA8E;AAC9E,2CAA6C;AAC7C,iDAAsD;AAEtD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAE/C,IAAA,mCAAgB,EAAC;IACf,UAAU;QACR,OAAO;YACL,OAAO;YACP,aAAa,EAAE,cAAc;YAC7B,UAAU,EAAE,0BAAc;SAC3B,CAAC;IACJ,CAAC;IACD,UAAU,EAAE,KAAK,EAAE,OAAyB,EAAE,EAAE;;QAC9C,MAAM,SAAS,GAAG,IAAI,mCAAoB,CAAC;YACzC,MAAM,EAAE,MAAA,OAAO,CAAC,SAAS,CAAC,MAAM,0CAAE,KAAK;YACvC,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM;SAC5B,CAAC,CAAC;QACH,MAAM,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;CACF,CAAC,CAAC"}
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":";;AAAA,+DAA8E;AAC9E,2CAA6C;AAC7C,iDAAsD;AAEtD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAE/C,IAAA,mCAAgB,EAAC;IACf,UAAU;QACR,OAAO;YACL,OAAO;YACP,aAAa,EAAE,cAAc;YAC7B,UAAU,EAAE,0BAAc;SAC3B,CAAC;IACJ,CAAC;IACD,UAAU,EAAE,KAAK,EAAE,OAAyB,EAAE,EAAE;QAC9C,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;QAElC,MAAM,SAAS,GAAG,IAAI,mCAAoB,CAAC;YACzC,MAAM,EAAE,MAAM;YACd,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM;SAC5B,CAAC,CAAC;QACH,MAAM,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;CACF,CAAC,CAAC;AACH,SAAS,SAAS,CAAC,OAAyB;IAC1C,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE;QAC5B,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,KAAK,IAAI,EAAE;YAChD,OAAO,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC;SACvC;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "prisma-generator-plantuml-erd",
   "description": "Provide a description about your generator",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "main": "dist/generator.js",
   "license": "MIT",
   "bin": {
@@ -41,7 +41,7 @@
     "ts-jest": "^29.0.3",
     "typescript": "4.6.2"
   },
-  "homepage": "Link to homepage or github readme here",
+  "homepage": "https://github.com/dbgso/prisma-generator-plantuml-erd.git",
   "repository": {
     "type": "git",
     "url": "https://github.com/dbgso/prisma-generator-plantuml-erd.git"