Allow overriding faker method using prisma comment

luisrudge · Jan 2, 2024 · 629fed0 · 629fed0
1 parent 9de7b5b
commit 629fed0
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -56,6 +56,9 @@ model User {
   id       String        @id @default(cuid())
   email    String        @unique
   name     String
+  /// Use comments to specify the faker method. For example:
+  ///FAKE:faker.location.streetAddress({ useFullAddress: true })
+  address  String
   ///FAKE:{notificationsEnabled: faker.datatype.boolean(), preferredColor: faker.color.rgb()}
   settings Json
   status   UserStatus

diff --git a/src/__tests__/__snapshots__/createMethods.test.ts.snap b/src/__tests__/__snapshots__/createMethods.test.ts.snap
@@ -10,6 +10,7 @@ export function fakeUser() {
   return {
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),
@@ -42,6 +43,7 @@ export function fakeUserComplete() {
     id: faker.string.uuid(),
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),
@@ -110,6 +112,7 @@ export function fakeUser() {
   return {
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),
@@ -142,6 +145,7 @@ export function fakeUserComplete() {
     id: faker.string.uuid(),
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),
@@ -210,6 +214,7 @@ export function fakeUser() {
   return {
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),
@@ -242,6 +247,7 @@ export function fakeUserComplete() {
     id: faker.string.uuid(),
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),
@@ -310,6 +316,7 @@ export function fakeUser() {
   return {
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),
@@ -342,6 +349,7 @@ export function fakeUserComplete() {
     id: faker.string.uuid(),
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),
@@ -410,6 +418,7 @@ export function fakeUser() {
   return {
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),
@@ -442,6 +451,7 @@ export function fakeUserComplete() {
     id: faker.string.uuid(),
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),
@@ -510,6 +520,7 @@ export function fakeUser() {
   return {
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),
@@ -542,6 +553,7 @@ export function fakeUserComplete() {
     id: faker.string.uuid(),
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),
@@ -610,6 +622,7 @@ export function fakeUser() {
   return {
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),
@@ -642,6 +655,7 @@ export function fakeUserComplete() {
     id: faker.string.uuid(),
     email: faker.internet.email(),
     name: faker.person.fullName(),
+    companyName: faker.company.name(),
     age: faker.number.int({min: 0, max: 99}),
     firstName: faker.person.firstName(),
     lastName: faker.person.lastName(),

diff --git a/src/__tests__/sample.prisma b/src/__tests__/sample.prisma
@@ -7,6 +7,8 @@ model User {
   id                     String        @id @default(cuid())
   email                  String
   name                   String
+  ///FAKE:faker.company.name()
+  companyName            String
   age                    Int
   firstName              String
   lastName               String

diff --git a/src/helpers/createMethods.ts b/src/helpers/createMethods.ts
@@ -12,6 +12,10 @@ function getFieldDefinition(
   const fakeLine = docLines.find((line) => line.startsWith('FAKE:'));
   const fakeValue = fakeLine?.replace('FAKE:', '');
 
+  if (fakeValue) {
+    return `${field.name}: ${fakeValue}`;
+  }
+
   if (field.isId) {
     return `${field.name}: ${
       field.type === 'String'