feat: Add disable flag to prisma config options (#233)

close issue #202 by adding an environment variable friendly approach to disabling the generator

README.md

@@ -97,12 +97,23 @@ generator erd {
 
 ### Disabled
 
-You won't always need to generate a new ERD. For instance, when you are building your docker containers you often run `prisma generate` and if this generator is included, odds are you aren't relying on an updated ERD inside your docker container. It also adds additional space to the container because of dependencies such as puppeteer. To disabled running this generator just add an environment variable to the environment running `prisma generate`.
+You won't always need to generate a new ERD. For instance, when you are building your docker containers you often run `prisma generate` and if this generator is included, odds are you aren't relying on an updated ERD inside your docker container. It also adds additional space to the container because of dependencies such as puppeteer. There are two ways to disable this ERD generator.
+
+1. Via environment variable
 
 ```bash
 DISABLE_ERD=true
 ```
 
+2. Via configuration
+
+```prisma
+generator erd {
+  provider = "prisma-erd-generator"
+  disabled = true
+}
+```
+
 Another option used is to remove the generator lines from your schema before installing dependencies and running the `prisma generate` command. I have used `sed` to remove the lines the generator is located on in my `schema.prisma` file to do so. Here is an example of the ERD generator being removed on lines 5-9 in a dockerfile.
 
 ```dockerfile

__tests__/disabled-config.test.ts

@@ -0,0 +1,13 @@
+import * as child_process from 'child_process';
+import fs from 'fs';
+
+test('disabled-config.prisma', async () => {
+    const fileName = 'disabled-config.svg';
+    const folderName = '__tests__';
+    child_process.execSync(`rm -f ${folderName}/${fileName}`);
+    child_process.execSync(
+        `npx cross-env prisma generate --schema ./prisma/disabled-config.prisma`
+    );
+    const exists = fs.existsSync(`${folderName}/${fileName}`);
+    expect(exists).toBe(false);
+});

__tests__/disabled-env.test.ts

@@ -0,0 +1,13 @@
+import * as child_process from 'child_process';
+import fs from 'fs';
+
+test('disabled-env.prisma', async () => {
+    const fileName = 'disabled.svg';
+    const folderName = '__tests__';
+    child_process.execSync(`rm -f ${folderName}/${fileName}`);
+    child_process.execSync(
+        `npx cross-env DISABLE_ERD=true prisma generate --schema ./prisma/disabled-env.prisma`
+    );
+    const exists = fs.existsSync(`${folderName}/${fileName}`);
+    expect(exists).toBe(false);
+});

prisma/disabled-config.prisma

@@ -0,0 +1,29 @@
+// This is your Prisma schema file,
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
+
+datasource db {
+    provider = "postgresql"
+    url      = env("DATABASE_URL")
+}
+
+generator erd {
+    provider = "node ./dist/index.js"
+    output   = "../__tests__/disabled-config.svg"
+    disabled = true
+    // debug    = true
+}
+
+model Booking {
+    id           Int      @id @default(autoincrement())
+    inviteeEmail String
+    startDateUTC DateTime
+    cancelCode   String
+    events       Event[]
+}
+
+model Event {
+    id        Int       @id @default(autoincrement())
+    name      String
+    startDate DateTime
+    bookings  Booking[]
+}

prisma/schema.prisma

@@ -9,6 +9,7 @@ generator erd {
   theme         = "default"
   mmdcPath      = "node_modules/.bin"
   mermaidConfig = "example-mermaid-config.js"
+  disabled      = false
 }
 
 model User {

src/generate.ts

@@ -319,7 +319,8 @@ export default async (options: GeneratorOptions) => {
         const ignoreEnums = config.ignoreEnums === 'true';
         const includeRelationFromFields =
             config.includeRelationFromFields === 'true';
-        const disabled = process.env.DISABLE_ERD === 'true';
+        const disabled =
+            process.env.DISABLE_ERD === 'true' || config.disabled === 'true';
         const debug =
             config.erdDebug === 'true' || Boolean(process.env.ERD_DEBUG);
 

src/types/generator.ts

@@ -8,4 +8,5 @@ export interface PrismaERDConfig {
     erdDebug?: string;
     puppeteerConfig?: string;
     mermaidConfig?: string;
+    disabled?: string;
 }