feat(dbml): add autogenerated comment

Author: marcjulian

README.md

@@ -1,6 +1,6 @@
 # Prisma DBML Generator
 
-Automatically generate a [DBML](https://www.dbml.org/home) schema from your Prisma Schema. Updates every time `npx prisma generate` runs. Use [dbdiagram.io](https://dbdiagram.io/home) to visualize your `dbml` files:
+Automatically generate a [DBML](https://www.dbml.org/home) schema from your Prisma Schema. Updates every time `npx prisma generate` runs. Use [dbdiagram.io](https://dbdiagram.io/home) to visualize your `dbml` files as Entity-Relationship Diagram:
 
 ![DB Diagram](./dbdiagram.png)
 

__tests__/dbml.test.ts

@@ -5,13 +5,18 @@ import {
   datamodelDbmlRelations,
 } from './fixtures/dbml.datamodel';
 import { generateDMMF } from './utils/generateDMMF';
-import { generateDBMLSchema } from '../src/generator/dbml';
+import {
+  autoGeneratedComment,
+  generateDBMLSchema,
+} from '../src/generator/dbml';
 
 describe('DBML', () => {
   test('generating simple dbml schema', async () => {
     const dmmf = await generateDMMF(datamodelDbml);
 
-    const expectedDbml = `Table User {
+    const expectedDbml = `${autoGeneratedComment}
+
+Table User {
   id Int [pk, increment]
   name String [not null]
   profile Profile
@@ -40,7 +45,9 @@ Ref: Profile.userId - User.id`;
   test('generating dbml schema with comments', async () => {
     const dmmf = await generateDMMF(datamodelDbmlComments);
 
-    const expectedDbml = `Table User {
+    const expectedDbml = `${autoGeneratedComment}
+
+Table User {
   id Int [pk, increment]
   name String [not null]
   profile Profile
@@ -71,7 +78,9 @@ Ref: Profile.userId - User.id`;
   test('generating dbml schema with defaults', async () => {
     const dmmf = await generateDMMF(datamodelDbmlDefaults);
 
-    const expectedDbml = `Table User {
+    const expectedDbml = `${autoGeneratedComment}
+
+Table User {
   id String [pk]
   createdAt DateTime [default: \`now()\`, not null]
   name String
@@ -105,7 +114,9 @@ Ref: Post.authorId > User.id`;
   test('generating dbml schema with relationships', async () => {
     const dmmf = await generateDMMF(datamodelDbmlRelations);
 
-    const expectedDbml = `Table User {
+    const expectedDbml = `${autoGeneratedComment}
+
+Table User {
   id Int [pk, increment]
   posts Post
   profile Profile

prisma/dbml/schema.dbml

@@ -1,3 +1,7 @@
+//// ------------------------------------------------------
+//// THIS FILE WAS AUTOMATICALLY GENERATED (DO NOT MODIFY)
+//// ------------------------------------------------------
+
 Table User {
   id Int [pk, increment]
   createdAt DateTime [default: `now()`, not null]

src/generator/dbml.ts

@@ -3,10 +3,14 @@ import { generateTables } from './table';
 import { generateEnums } from './enums';
 import { generateRelations } from './relations';
 
+export const autoGeneratedComment = `//// ------------------------------------------------------
+//// THIS FILE WAS AUTOMATICALLY GENERATED (DO NOT MODIFY)
+//// ------------------------------------------------------`;
+
 export function generateDBMLSchema(dmmf: DMMF.Document): string {
   const tables = generateTables(dmmf.datamodel.models);
   const enums = generateEnums(dmmf.datamodel.enums);
   const refs = generateRelations(dmmf.datamodel.models);
 
-  return [...tables, ...enums, ...refs].join('\n\n');
+  return [autoGeneratedComment, ...tables, ...enums, ...refs].join('\n\n');
 }