Merge pull request #2 from onozaty/1-includeenuminfeildcomment-is-mispelled

#1 includeEnumInFeildComment is mispelled

Author: onozaty

README.md

@@ -182,19 +182,19 @@ generator comments {
 }
 ```
 
-### includeEnumInFeildComment
+### includeEnumInFieldComment
 
-If `includeEnumInFeildComment` is set to true, information about the enum is appended to the column comment.  
+If `includeEnumInFieldComment` is set to true, information about the enum is appended to the column comment.  
 Default is `false`.
 
 ```prisma
 generator comments {
   provider                  = "prisma-db-comments-generator"
-  includeEnumInFeildComment = true
+  includeEnumInFieldComment = true
 }
 ```
 
-If `includeEnumInFeildComment` is set to `true` with the following definition,
+If `includeEnumInFieldComment` is set to `true` with the following definition,
 
 ```prisma
 enum ProductType {

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@onozaty/prisma-db-comments-generator",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Generate database comments from Prisma schema",
   "bin": {
     "prisma-db-comments-generator": "./dist/generator.js"

package.json

@@ -6,7 +6,7 @@ generator client {
 generator comments {
   provider                  = "node ./dist/generator.js"
   ignorePattern             = "_view$"
-  includeEnumInFeildComment = true
+  includeEnumInFieldComment = true
 }
 
 datasource db {

prisma/schema.prisma

@@ -27,7 +27,7 @@ export const createComments = (
   models: readonly Model[],
   targets: readonly Target[],
   ignorePattern: RegExp | undefined,
-  includeEnumInFeildComment: boolean,
+  includeEnumInFieldComment: boolean,
 ): Comments => {
   const comments: Comments = {};
 
@@ -50,7 +50,7 @@ export const createComments = (
               columnName: field.dbName,
               comment: createFieldCommentString(
                 field,
-                includeEnumInFeildComment,
+                includeEnumInFieldComment,
               ),
             };
           })
@@ -63,11 +63,11 @@ export const createComments = (
 
 const createFieldCommentString = (
   field: Field,
-  includeEnumInFeildComment: boolean,
+  includeEnumInFieldComment: boolean,
 ) => {
   let comment = field.documentation ?? "";
 
-  if (includeEnumInFeildComment && field.typeEnum) {
+  if (includeEnumInFieldComment && field.typeEnum) {
     comment += `\nenum: ${field.typeEnum.dbName}(${field.typeEnum.values.join(", ")})`;
   }
 

src/comment.ts

@@ -42,21 +42,21 @@ const generate = async ({ generator, dmmf, schemaPath }: GeneratorOptions) => {
     ignorePattern = new RegExp(generator.config.ignorePattern);
   }
 
-  let includeEnumInFeildComment = false;
+  let includeEnumInFieldComment = false;
   if (
-    generator.config.includeEnumInFeildComment &&
-    typeof generator.config.includeEnumInFeildComment === "string"
+    generator.config.includeEnumInFieldComment &&
+    typeof generator.config.includeEnumInFieldComment === "string"
   ) {
-    includeEnumInFeildComment =
-      generator.config.includeEnumInFeildComment === "true";
+    includeEnumInFieldComment =
+      generator.config.includeEnumInFieldComment === "true";
   }
 
   const models = parse(dmmf.datamodel);
   const currentComments = createComments(
     models,
     targets,
     ignorePattern,
-    includeEnumInFeildComment,
+    includeEnumInFieldComment,
   );
 
   // load latest