Merge pull request #64 from meetsmore/fmy/includeRelationFields-option

pantharshit00 · Feb 15, 2023 · e8481a3 · e8481a3
2 parents 667030b + a3ceed3
commit e8481a3
Show file tree

Hide file tree

Showing 6 changed files with 150 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,18 @@ generator docs {
 }
 ```
 
+### includeRelationFields
+
+You can specify whether relation fields are shown or not.
+Default value is `true`.
+
+```prisma
+generator docs {
+  provider = "node node_modules/prisma-docs-generator"
+  includeRelationFields = false
+}
+```
+
 ## CLI
 
 This package also ships with a CLI which is used to serve the docs right now. It has the following subcommands:

diff --git a/src/generator/transformDMMF.ts b/src/generator/transformDMMF.ts
@@ -21,9 +21,23 @@ export type DMMFDocument = Omit<ExternalDMMF.Document, 'mappings'> & {
   mappings: DMMFMapping[];
 };
 
+type OptionsForTransformDMMF = {
+  includeRelationFields: boolean
+}
+
 export default function transformDMMF(
-  dmmf: ExternalDMMF.Document
+  dmmf: ExternalDMMF.Document,
+  { includeRelationFields }: OptionsForTransformDMMF
 ): DMMFDocument {
+  if (!includeRelationFields) {
+    dmmf.datamodel.models = dmmf.datamodel.models.map(model => {
+      model.fields = model.fields.filter(
+        field => !field.relationName
+      );
+      return model;
+    });
+  }
+
   return {
     ...dmmf,
     mappings: getMappings(dmmf.mappings, dmmf.datamodel),

diff --git a/src/index.ts b/src/index.ts
@@ -12,7 +12,12 @@ generatorHandler({
     };
   },
   async onGenerate(options) {
-    const dmmf = transformDMMF(options.dmmf);
+    const { config } = options.generator;
+    const includeRelationFields = config.includeRelationFields === 'false' ? false : true;
+
+    const dmmf = transformDMMF(options.dmmf, {
+      includeRelationFields,
+    });
     const html = new HTMLPrinter(dmmf);
 
     const output = options.generator.output?.value;

diff --git a/src/tests/model.test.ts b/src/tests/model.test.ts
@@ -16,7 +16,9 @@ describe('model generator', () => {
     `;
 
     const dmmf = await getDMMF({ datamodel: datamodelString });
-    const transformedDmmf = transformDMMF(dmmf);
+    const transformedDmmf = transformDMMF(dmmf, {
+      includeRelationFields: true,
+    });
 
     const modelGen = new ModelGenerator(transformedDmmf);
     const spy = jest.spyOn(modelGen, 'getModelDiretiveHTML');
@@ -61,7 +63,9 @@ describe('model generator', () => {
     `;
 
     const dmmf = await getDMMF({ datamodel: datamodelString });
-    const transformedDmmf = transformDMMF(dmmf);
+    const transformedDmmf = transformDMMF(dmmf, {
+      includeRelationFields: true,
+    });
 
     const modelGen = new ModelGenerator(transformedDmmf);
     const spy = jest.spyOn(modelGen, 'getModelFieldTableRow');
@@ -150,7 +154,9 @@ describe('model generator', () => {
     `;
 
     const dmmf = await getDMMF({ datamodel: datamodelString });
-    const transformedDmmf = transformDMMF(dmmf);
+    const transformedDmmf = transformDMMF(dmmf, {
+      includeRelationFields: true,
+    });
 
     const modelGen = new ModelGenerator(transformedDmmf);
     const spy = jest.spyOn(modelGen, 'getModelOperationMarkup');

diff --git a/src/tests/toc.test.ts b/src/tests/toc.test.ts
@@ -18,7 +18,9 @@ const datamodel = /* Prisma */ `
 describe('TOC', () => {
   it('renders TOC Subheader correctly', async () => {
     const dmmf = await getDMMF({ datamodel });
-    const toc = new TOCGenerator(transformDMMF(dmmf));
+    const toc = new TOCGenerator(transformDMMF(dmmf, {
+      includeRelationFields: true,
+    }));
     const spy = jest.spyOn(toc, 'getTOCSubHeaderHTML');
     // trigger the function
     toc.toHTML();
@@ -30,7 +32,9 @@ describe('TOC', () => {
 
   it('renders TOC subfield correctly', async () => {
     const dmmf = await getDMMF({ datamodel });
-    const toc = new TOCGenerator(transformDMMF(dmmf));
+    const toc = new TOCGenerator(transformDMMF(dmmf, {
+      includeRelationFields: true,
+    }));
 
     const spy = jest.spyOn(toc, 'getSubFieldHTML');
     toc.toHTML();
@@ -50,7 +54,9 @@ describe('TOC', () => {
 
   it('renders on toHTML', async () => {
     const dmmf = await getDMMF({ datamodel });
-    const toc = new TOCGenerator(transformDMMF(dmmf));
+    const toc = new TOCGenerator(transformDMMF(dmmf, {
+      includeRelationFields: true,
+    }));
 
     const subheaderSpy = jest.spyOn(toc, 'getTOCSubHeaderHTML');
     const subfieldSpy = jest.spyOn(toc, 'getSubFieldHTML');

diff --git a/src/tests/transformDMMF.test.ts b/src/tests/transformDMMF.test.ts
@@ -0,0 +1,99 @@
+import transformDMMF from '../generator/transformDMMF';
+//@ts-ignore
+import { getDMMF } from '@prisma/sdk';
+
+describe('transformDMMF', () => {
+  it('show relation fields when includeRelationFields = true', async () => {
+    const datamodelString = /* Prisma */ `
+      model User {
+        id String @default(cuid()) @id
+        name String
+        otherField Int
+        posts Post[]
+      }
+
+      model Post {
+        id String @id @default(cuid())
+        title String?
+        userId String
+        user User @relation(fields:[userId], references:[id])
+      }
+    `;
+
+    const dmmf = await getDMMF({ datamodel: datamodelString });
+    const transformedDmmf = transformDMMF(dmmf, {
+      includeRelationFields: true,
+    });
+
+    expect(transformedDmmf).toMatchObject({
+      datamodel: {
+        models: [
+          {
+            name: 'User',
+            fields: [
+              { name: 'id' },
+              { name: 'name' },
+              { name: 'otherField' },
+              { name: 'posts' },
+            ],
+          },
+          {
+            name: 'Post',
+            fields: [
+              { name: 'id' },
+              { name: 'title' },
+              { name: 'userId' },
+              { name: 'user' },
+            ],
+          },
+        ],
+      },
+    });
+  });
+
+  it('hide relation fields when includeRelationFields = false', async () => {
+    const datamodelString = /* Prisma */ `
+      model User {
+        id String @default(cuid()) @id
+        name String
+        otherField Int
+        posts Post[]
+      }
+
+      model Post {
+        id String @id @default(cuid())
+        title String?
+        userId String
+        user User @relation(fields:[userId], references:[id])
+      }
+    `;
+
+    const dmmf = await getDMMF({ datamodel: datamodelString });
+    const transformedDmmf = transformDMMF(dmmf, {
+      includeRelationFields: false,
+    });
+
+    expect(transformedDmmf).toMatchObject({
+      datamodel: {
+        models: [
+          {
+            name: 'User',
+            fields: [
+              { name: 'id' },
+              { name: 'name' },
+              { name: 'otherField' },
+            ],
+          },
+          {
+            name: 'Post',
+            fields: [
+              { name: 'id' },
+              { name: 'title' },
+              { name: 'userId' },
+            ],
+          },
+        ],
+      },
+    });
+  });
+});