feat(nest): update nest generators to support name and directory form…

…at option (#19668) Co-authored-by: FrozenPandaz <[email protected]>
nrwl · Oct 17, 2023 · aa7625b · aa7625b · vercel · Oct 17, 2023
1 parent 81e8d12
commit aa7625b
Show file tree

Hide file tree

Showing 48 changed files with 629 additions and 218 deletions.
diff --git a/docs/generated/packages/nest/generators/class.json b/docs/generated/packages/nest/generators/class.json
@@ -1,6 +1,6 @@
 {
   "name": "class",
-  "factory": "./src/generators/class/class",
+  "factory": "./src/generators/class/class#classGeneratorInternal",
   "schema": {
     "$schema": "http://json-schema.org/schema",
     "$id": "NxNestClassGenerator",
@@ -15,15 +15,20 @@
         "$default": { "$source": "argv", "index": 0 },
         "x-prompt": "What name would you like to use?"
       },
+      "nameAndDirectoryFormat": {
+        "description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
+        "type": "string",
+        "enum": ["as-provided", "derived"]
+      },
       "project": {
         "description": "The Nest project to target.",
         "type": "string",
         "$default": { "$source": "projectName" },
         "alias": "p",
-        "x-prompt": "What Nest project would you like to target?"
+        "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18."
       },
       "directory": {
-        "description": "Directory where the generated files are placed.",
+        "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
         "type": "string",
         "aliases": ["dir", "path"]
       },
@@ -41,6 +46,7 @@
       },
       "flat": {
         "description": "Flag to indicate if a directory is created.",
+        "x-deprecated": "provide the `directory` option instead and use the `as-provided` format. it will be removed in nx v18.",
         "type": "boolean",
         "default": true
       },
@@ -51,11 +57,11 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name", "project"],
+    "required": ["name"],
     "presets": []
   },
   "description": "Run the `class` NestJS generator with Nx project support.",
-  "implementation": "/packages/nest/src/generators/class/class.ts",
+  "implementation": "/packages/nest/src/generators/class/class#classGeneratorInternal.ts",
   "aliases": [],
   "hidden": false,
   "path": "/packages/nest/src/generators/class/schema.json",

diff --git a/docs/generated/packages/nest/generators/controller.json b/docs/generated/packages/nest/generators/controller.json
@@ -1,6 +1,6 @@
 {
   "name": "controller",
-  "factory": "./src/generators/controller/controller",
+  "factory": "./src/generators/controller/controller#controllerGeneratorInternal",
   "schema": {
     "$schema": "http://json-schema.org/schema",
     "$id": "NxNestControllerGenerator",
@@ -20,10 +20,15 @@
         "type": "string",
         "$default": { "$source": "projectName" },
         "alias": "p",
-        "x-prompt": "What Nest project would you like to target?"
+        "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18."
+      },
+      "nameAndDirectoryFormat": {
+        "description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
+        "type": "string",
+        "enum": ["as-provided", "derived"]
       },
       "directory": {
-        "description": "Directory where the generated files are placed.",
+        "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
         "type": "string",
         "aliases": ["dir", "path"]
       },
@@ -41,6 +46,7 @@
       },
       "flat": {
         "description": "Flag to indicate if a directory is created.",
+        "x-deprecated": "provide the `directory` option instead and use the `as-provided` format. it will be removed in nx v18.",
         "type": "boolean",
         "default": false
       },
@@ -60,11 +66,11 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name", "project"],
+    "required": ["name"],
     "presets": []
   },
   "description": "Run the `controller` NestJS generator with Nx project support.",
-  "implementation": "/packages/nest/src/generators/controller/controller.ts",
+  "implementation": "/packages/nest/src/generators/controller/controller#controllerGeneratorInternal.ts",
   "aliases": [],
   "hidden": false,
   "path": "/packages/nest/src/generators/controller/schema.json",

diff --git a/docs/generated/packages/nest/generators/decorator.json b/docs/generated/packages/nest/generators/decorator.json
@@ -1,6 +1,6 @@
 {
   "name": "decorator",
-  "factory": "./src/generators/decorator/decorator",
+  "factory": "./src/generators/decorator/decorator#decoratorGeneratorInternal",
   "schema": {
     "$schema": "http://json-schema.org/schema",
     "$id": "NxNestDecoratorGenerator",
@@ -15,15 +15,20 @@
         "$default": { "$source": "argv", "index": 0 },
         "x-prompt": "What name would you like to use?"
       },
+      "nameAndDirectoryFormat": {
+        "description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
+        "type": "string",
+        "enum": ["as-provided", "derived"]
+      },
       "project": {
         "description": "The Nest project to target.",
         "type": "string",
         "$default": { "$source": "projectName" },
         "alias": "p",
-        "x-prompt": "What Nest project would you like to target?"
+        "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18."
       },
       "directory": {
-        "description": "Directory where the generated files are placed.",
+        "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
         "type": "string",
         "aliases": ["dir", "path"]
       },
@@ -35,6 +40,7 @@
       },
       "flat": {
         "description": "Flag to indicate if a directory is created.",
+        "x-deprecated": "provide the `directory` option instead and use the `as-provided` format. it will be removed in nx v18.",
         "type": "boolean",
         "default": true
       },
@@ -45,11 +51,11 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name", "project"],
+    "required": ["name"],
     "presets": []
   },
   "description": "Run the `decorator` NestJS generator with Nx project support.",
-  "implementation": "/packages/nest/src/generators/decorator/decorator.ts",
+  "implementation": "/packages/nest/src/generators/decorator/decorator#decoratorGeneratorInternal.ts",
   "aliases": [],
   "hidden": false,
   "path": "/packages/nest/src/generators/decorator/schema.json",

diff --git a/docs/generated/packages/nest/generators/filter.json b/docs/generated/packages/nest/generators/filter.json
@@ -1,6 +1,6 @@
 {
   "name": "filter",
-  "factory": "./src/generators/filter/filter",
+  "factory": "./src/generators/filter/filter#filterGeneratorInternal",
   "schema": {
     "$schema": "http://json-schema.org/schema",
     "$id": "NxNestFilterGenerator",
@@ -15,15 +15,20 @@
         "$default": { "$source": "argv", "index": 0 },
         "x-prompt": "What name would you like to use?"
       },
+      "nameAndDirectoryFormat": {
+        "description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
+        "type": "string",
+        "enum": ["as-provided", "derived"]
+      },
       "project": {
         "description": "The Nest project to target.",
         "type": "string",
         "$default": { "$source": "projectName" },
         "alias": "p",
-        "x-prompt": "What Nest project would you like to target?"
+        "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18."
       },
       "directory": {
-        "description": "Directory where the generated files are placed.",
+        "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
         "type": "string",
         "aliases": ["dir", "path"]
       },
@@ -41,6 +46,7 @@
       },
       "flat": {
         "description": "Flag to indicate if a directory is created.",
+        "x-deprecated": "provide the `directory` option instead and use the `as-provided` format. it will be removed in nx v18.",
         "type": "boolean",
         "default": true
       },
@@ -51,11 +57,11 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name", "project"],
+    "required": ["name"],
     "presets": []
   },
   "description": "Run the `filter` NestJS generator with Nx project support.",
-  "implementation": "/packages/nest/src/generators/filter/filter.ts",
+  "implementation": "/packages/nest/src/generators/filter/filter#filterGeneratorInternal.ts",
   "aliases": [],
   "hidden": false,
   "path": "/packages/nest/src/generators/filter/schema.json",

diff --git a/docs/generated/packages/nest/generators/gateway.json b/docs/generated/packages/nest/generators/gateway.json
@@ -1,6 +1,6 @@
 {
   "name": "gateway",
-  "factory": "./src/generators/gateway/gateway",
+  "factory": "./src/generators/gateway/gateway#gatewayGeneratorInternal",
   "schema": {
     "$schema": "http://json-schema.org/schema",
     "$id": "NxNestGatewayGenerator",
@@ -15,15 +15,20 @@
         "$default": { "$source": "argv", "index": 0 },
         "x-prompt": "What name would you like to use?"
       },
+      "nameAndDirectoryFormat": {
+        "description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
+        "type": "string",
+        "enum": ["as-provided", "derived"]
+      },
       "project": {
         "description": "The Nest project to target.",
         "type": "string",
         "$default": { "$source": "projectName" },
         "alias": "p",
-        "x-prompt": "What Nest project would you like to target?"
+        "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18."
       },
       "directory": {
-        "description": "Directory where the generated files are placed.",
+        "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
         "type": "string",
         "aliases": ["dir", "path"]
       },
@@ -41,6 +46,7 @@
       },
       "flat": {
         "description": "Flag to indicate if a directory is created.",
+        "x-deprecated": "provide the `directory` option instead and use the `as-provided` format. it will be removed in nx v18.",
         "type": "boolean",
         "default": true
       },
@@ -51,11 +57,11 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name", "project"],
+    "required": ["name"],
     "presets": []
   },
   "description": "Run the `gateway` NestJS generator with Nx project support.",
-  "implementation": "/packages/nest/src/generators/gateway/gateway.ts",
+  "implementation": "/packages/nest/src/generators/gateway/gateway#gatewayGeneratorInternal.ts",
   "aliases": [],
   "hidden": false,
   "path": "/packages/nest/src/generators/gateway/schema.json",

diff --git a/docs/generated/packages/nest/generators/guard.json b/docs/generated/packages/nest/generators/guard.json
@@ -1,6 +1,6 @@
 {
   "name": "guard",
-  "factory": "./src/generators/guard/guard",
+  "factory": "./src/generators/guard/guard#guardGeneratorInternal",
   "schema": {
     "$schema": "http://json-schema.org/schema",
     "$id": "NxNestGuardGenerator",
@@ -15,15 +15,20 @@
         "$default": { "$source": "argv", "index": 0 },
         "x-prompt": "What name would you like to use?"
       },
+      "nameAndDirectoryFormat": {
+        "description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
+        "type": "string",
+        "enum": ["as-provided", "derived"]
+      },
       "project": {
         "description": "The Nest project to target.",
         "type": "string",
         "$default": { "$source": "projectName" },
         "alias": "p",
-        "x-prompt": "What Nest project would you like to target?"
+        "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18."
       },
       "directory": {
-        "description": "Directory where the generated files are placed.",
+        "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
         "type": "string",
         "aliases": ["dir", "path"]
       },
@@ -41,6 +46,7 @@
       },
       "flat": {
         "description": "Flag to indicate if a directory is created.",
+        "x-deprecated": "provide the `directory` option instead and use the `as-provided` format. it will be removed in nx v18.",
         "type": "boolean",
         "default": true
       },
@@ -51,11 +57,11 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name", "project"],
+    "required": ["name"],
     "presets": []
   },
   "description": "Run the `guard` NestJS generator with Nx project support.",
-  "implementation": "/packages/nest/src/generators/guard/guard.ts",
+  "implementation": "/packages/nest/src/generators/guard/guard#guardGeneratorInternal.ts",
   "aliases": [],
   "hidden": false,
   "path": "/packages/nest/src/generators/guard/schema.json",

diff --git a/docs/generated/packages/nest/generators/interceptor.json b/docs/generated/packages/nest/generators/interceptor.json
@@ -1,6 +1,6 @@
 {
   "name": "interceptor",
-  "factory": "./src/generators/interceptor/interceptor",
+  "factory": "./src/generators/interceptor/interceptor#interceptorGeneratorInternal",
   "schema": {
     "$schema": "http://json-schema.org/schema",
     "$id": "NxNestInterceptorGenerator",
@@ -15,15 +15,20 @@
         "$default": { "$source": "argv", "index": 0 },
         "x-prompt": "What name would you like to use?"
       },
+      "nameAndDirectoryFormat": {
+        "description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
+        "type": "string",
+        "enum": ["as-provided", "derived"]
+      },
       "project": {
         "description": "The Nest project to target.",
         "type": "string",
         "$default": { "$source": "projectName" },
         "alias": "p",
-        "x-prompt": "What Nest project would you like to target?"
+        "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18."
       },
       "directory": {
-        "description": "Directory where the generated files are placed.",
+        "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
         "type": "string",
         "aliases": ["dir", "path"]
       },
@@ -41,6 +46,7 @@
       },
       "flat": {
         "description": "Flag to indicate if a directory is created.",
+        "x-deprecated": "provide the `directory` option instead and use the `as-provided` format. it will be removed in nx v18.",
         "type": "boolean",
         "default": true
       },
@@ -51,11 +57,11 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name", "project"],
+    "required": ["name"],
     "presets": []
   },
   "description": "Run the `interceptor` NestJS generator with Nx project support.",
-  "implementation": "/packages/nest/src/generators/interceptor/interceptor.ts",
+  "implementation": "/packages/nest/src/generators/interceptor/interceptor#interceptorGeneratorInternal.ts",
   "aliases": [],
   "hidden": false,
   "path": "/packages/nest/src/generators/interceptor/schema.json",