add generateFileTypes flag to output only dto or entity files #42

Brakebein · Jul 31, 2024 · f00410c · f00410c
1 parent b80eea1
commit f00410c
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -57,6 +57,7 @@ generator nestjsDto {
   requiredResponseApiProperty     = "true"
   prettier                        = "false"
   outputApiPropertyType           = "true"
+  generateFileTypes               = "all"
 }
 ```
 
@@ -83,7 +84,8 @@ All parameters are optional.
 | `definiteAssignmentAssertion = "false"`                          | Add a definite assignment assertion operator `!` to required fields, which is required if `strict` and/or `strictPropertyInitialization` is set `true` in your tsconfig.json's `compilerOptions`.                    |
 | `requiredResponseApiProperty = "true"`                           | If `false`, add `@ApiRequired({ required: false })` to response DTO properties. Otherwise, use `required` defaults always to `true` unless field is optional.                                                        |
 | `prettier = "false"`                                             | Stylize output files with prettier.                                                                                                                                                                                  |
-| `outputApiPropertyType = "true"`                                 | Disable the type property inside @ApiProperty() |
+| `outputApiPropertyType = "true"`                                 | Disable the type property inside @ApiProperty()                                                                                                                                                                      |
+| `generateFileTypes = "all"`                                      | `all`: generate both DTO and Entity files, `dto`: generate only DTO files, `entity`: generate only Entity files (not possible in combination with complex types)                                                     |
 
 ## Annotations
 

diff --git a/package.json b/package.json
@@ -36,7 +36,7 @@
     "cleanup:generated": "rimraf src/@generated",
     "pregenerate": "npm run cleanup:generated",
     "generate": "npx prisma generate",
-    "generate:mongo": "npx prisma generate --schema ./prisma/mongodb.prisma && npm run format -- --loglevel error",
+    "generate:mongo": "npx prisma generate --schema ./prisma/mongodb.prisma",
     "prepare": "npm run build"
   },
   "repository": {

diff --git a/prisma/mongodb.prisma b/prisma/mongodb.prisma
@@ -19,7 +19,9 @@ generator nestjsDto {
   classValidation                 = "true"
   noDependencies                  = "false"
   outputType                      = "class"
+  prettier                        = "true"
   requiredResponseApiProperty     = "false"
+  generateFileTypes               = "dto"
 }
 
 model Product {

diff --git a/prisma/schema.prisma b/prisma/schema.prisma
@@ -26,6 +26,7 @@ generator nestjsDto {
   definiteAssignmentAssertion     = "true"
   prettier                        = "true"
   outputApiPropertyType           = "true"
+  generateFileTypes               = "all"
 }
 
 model Product {

diff --git a/src/generator/index.ts b/src/generator/index.ts
@@ -34,6 +34,7 @@ interface RunParam {
   requiredResponseApiProperty: boolean;
   prismaClientImportPath: string;
   outputApiPropertyType: boolean;
+  generateFileTypes: string;
 }
 
 export const run = ({
@@ -53,6 +54,7 @@ export const run = ({
     requiredResponseApiProperty,
     prismaClientImportPath,
     outputApiPropertyType,
+    generateFileTypes,
     ...preAndSuffixes
   } = options;
 
@@ -93,6 +95,12 @@ export const run = ({
       },
     }));
 
+  if (generateFileTypes === 'entity' && filteredTypes.length) {
+    throw new Error(
+      `Generating only Entity files while having complex types is not possible. Set 'generateFileTypes' to 'all' or 'dto'.`,
+    );
+  }
+
   const filteredModels: Model[] = allModels
     .filter((model) => !isAnnotatedWith(model, DTO_IGNORE_MODEL))
     // adds `output` information for each model, so we can compute relative import paths
@@ -239,7 +247,16 @@ export const run = ({
       }),
     };
 
-    return [connectDto, createDto, updateDto, entity, plainDto];
+    switch (generateFileTypes) {
+      case 'all':
+        return [connectDto, createDto, updateDto, entity, plainDto];
+      case 'dto':
+        return [connectDto, createDto, updateDto, plainDto];
+      case 'entity':
+        return [entity];
+      default:
+        throw new Error(`Unknown 'generateFileTypes' value.`);
+    }
   });
 
   return [...typeFiles, ...modelFiles].flat();

diff --git a/src/index.ts b/src/index.ts
@@ -37,6 +37,7 @@ export const generate = async (options: GeneratorOptions) => {
     entitySuffix = '',
     fileNamingStyle = 'camel',
     outputType = 'class',
+    generateFileTypes = 'all',
   } = options.generator.config;
 
   const exportRelationModifierClasses = stringToBoolean(
@@ -169,6 +170,7 @@ export const generate = async (options: GeneratorOptions) => {
     requiredResponseApiProperty,
     prismaClientImportPath,
     outputApiPropertyType,
+    generateFileTypes,
   });
 
   const indexCollections: Record<string, WriteableFileSpecs> = {};