@nx/nest 20.1.3 → 20.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/nest",
-  "version": "20.1.3",
+  "version": "20.1.4",
   "private": false,
   "description": "The Nx Plugin for Nest contains executors and generators for allowing your workspace to create powerful Nest best in class APIs.",
   "repository": {
@@ -32,10 +32,10 @@
   },
   "dependencies": {
     "@nestjs/schematics": "^9.1.0",
-    "@nx/devkit": "20.1.3",
-    "@nx/js": "20.1.3",
-    "@nx/eslint": "20.1.3",
-    "@nx/node": "20.1.3",
+    "@nx/devkit": "20.1.4",
+    "@nx/js": "20.1.4",
+    "@nx/eslint": "20.1.4",
+    "@nx/node": "20.1.4",
     "tslib": "^2.3.0"
   },
   "publishConfig": {

package/src/generators/class/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Class Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the class `Foo` at `myapp/src/app/foo.ts`",
+      "command": "nx g @nx/nest:class myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the class will be generated.",
+      "description": "The file path to the class without the file extension. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the class be generated?"
-    },
-    "name": {
-      "description": "The name of the class.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the class file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",
@@ -32,12 +33,6 @@
       "enum": ["jest", "none"],
       "default": "jest"
     },
-    "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 v20.",
-      "type": "boolean",
-      "default": true
-    },
     "language": {
       "description": "Nest class language.",
       "type": "string",

package/src/generators/controller/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Controller Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the controller `FooController` at `myapp/src/app/foo.controller.ts`",
+      "command": "nx g @nx/nest:controller myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the controller will be generated.",
+      "description": "The file path to the controller without the file extension and suffix. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the controller be generated?"
-    },
-    "name": {
-      "description": "The name of the controller.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the controller file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",

package/src/generators/decorator/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Decorator Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the decorator `Foo` at `myapp/src/app/foo.decorator.ts`",
+      "command": "nx g @nx/nest:decorator myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the decorator will be generated.",
+      "description": "The file path to the decorator without the file extension and suffix. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the decorator be generated?"
-    },
-    "name": {
-      "description": "The name of the decorator.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the decorator file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",

package/src/generators/filter/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Filter Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the filter `FooFilter` at `myapp/src/app/foo.filter.ts`",
+      "command": "nx g @nx/nest:filter myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the filter will be generated.",
+      "description": "The file path to the filter without the file extension and suffix. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the filter be generated?"
-    },
-    "name": {
-      "description": "The name of the filter.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the filter file path?"
     },
     "skipFormat": {
       "type": "boolean",

package/src/generators/gateway/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Gateway Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the gateway `FooGateway` at `myapp/src/app/foo.gateway.ts`",
+      "command": "nx g @nx/nest:gateway myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the gateway will be generated.",
+      "description": "The file path to the gateway without the file extension and suffix. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the gateway be generated?"
-    },
-    "name": {
-      "description": "The name of the gateway.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the gateway file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",

package/src/generators/guard/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Guard Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the guard `FooGuard` at `myapp/src/app/foo.guard.ts`",
+      "command": "nx g @nx/nest:guard myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the guard will be generated.",
+      "description": "The file path to the guard without the file extension and suffix. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the guard be generated?"
-    },
-    "name": {
-      "description": "The name of the guard.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the guard file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",
@@ -39,5 +40,5 @@
     }
   },
   "additionalProperties": false,
-  "required": ["name"]
+  "required": ["path"]
 }

package/src/generators/interceptor/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Interceptor Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the interceptor `FooInterceptor` at `myapp/src/app/foo.interceptor.ts`",
+      "command": "nx g @nx/nest:interceptor myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the interceptor will be generated.",
+      "description": "The file path to the interceptor without the file extension and suffix. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the interceptor be generated?"
-    },
-    "name": {
-      "description": "The name of the interceptor.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the interceptor file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",
@@ -39,5 +40,5 @@
     }
   },
   "additionalProperties": false,
-  "required": ["name"]
+  "required": ["path"]
 }

package/src/generators/interface/schema.json

@@ -5,32 +5,27 @@
   "description": "Nest Interface Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the interface `Foo` at `myapp/src/app/foo.interface.ts`",
+      "command": "nx g @nx/nest:interface myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the interface will be generated.",
+      "description": "The file path to the interface without the file extension and suffix. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the interface be generated?"
-    },
-    "name": {
-      "description": "The name of the interface.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the interface file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",
       "type": "boolean",
       "default": false,
       "x-priority": "internal"
-    },
-    "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 v20.",
-      "type": "boolean",
-      "default": true
     }
   },
   "additionalProperties": false,

package/src/generators/middleware/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Middleware Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the middleware `FooMiddleware` at `myapp/src/app/foo.middleware.ts`",
+      "command": "nx g @nx/nest:middleware myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the middleware will be generated.",
+      "description": "The file path to the middleware without the file extension and suffix. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the middleware be generated?"
-    },
-    "name": {
-      "description": "The name of the middleware.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the middleware file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",

package/src/generators/module/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Module Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the module `FooModule` at `myapp/src/app/foo.module.ts`",
+      "command": "nx g @nx/nest:module myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the module will be generated.",
+      "description": "The file path to the module without the file extension and suffix. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the module be generated?"
-    },
-    "name": {
-      "description": "The name of the module.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the module file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",

package/src/generators/pipe/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Pipe Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the pipe `FooPipe` at `myapp/src/app/foo.pipe.ts`",
+      "command": "nx g @nx/nest:pipe myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the pipe will be generated.",
+      "description": "The file path to the pipe without the file extension and suffix. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the pipe be generated?"
-    },
-    "name": {
-      "description": "The name of the pipe.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the pipe file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",

package/src/generators/provider/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Provider Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the provider `Foo` at `myapp/src/app/foo.ts`",
+      "command": "nx g @nx/nest:provider myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the provider will be generated.",
+      "description": "The file path to the provider without the file extension and suffix. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the provider be generated?"
-    },
-    "name": {
-      "description": "The name of the provider.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the provider file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",

package/src/generators/resolver/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Resolver Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the resolver `FooResolver` at `myapp/src/app/foo.resolver.ts`",
+      "command": "nx g @nx/nest:resolver myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the resolver will be generated.",
+      "description": "The file path to the resolver without the file extension and suffix. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the resolver be generated?"
-    },
-    "name": {
-      "description": "The name of the resolver.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the resolver file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",

package/src/generators/resource/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Resource Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate `myapp/src/app/entities/foo.entity.ts`, `myapp/src/app/dto/create-foo.dto.ts`, `myapp/src/app/dto/update-foo.dto.ts`, `myapp/src/app/foo.service.ts`, `myapp/src/app/foo.controller.ts`, and `myapp/src/app/foo.module.ts`",
+      "command": "nx g @nx/nest:resource myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
       "type": "string",
-      "description": "Path where the resource will be generated.",
+      "description": "The file path to the resource without the file extension and suffix. Relative to the current working directory.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the resource be generated?"
-    },
-    "name": {
-      "type": "string",
-      "description": "The name of the resource.",
-      "x-prompt": "What name would you like to use for this resource (plural, e.g., `users`)?"
+      "x-prompt": "What is the resource file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",

package/src/generators/service/schema.json

@@ -5,20 +5,21 @@
   "description": "Nest Service Options Schema.",
   "cli": "nx",
   "type": "object",
+  "examples": [
+    {
+      "description": "Generate the service `FooService` at `myapp/src/app/foo.service.ts`",
+      "command": "nx g @nx/nest:service myapp/src/app/foo"
+    }
+  ],
   "properties": {
     "path": {
-      "description": "Path where the service will be generated.",
+      "description": "The file path to the service without the file extension and suffix. Relative to the current working directory.",
       "type": "string",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the service be generated?"
-    },
-    "name": {
-      "description": "The name of the service.",
-      "type": "string",
-      "x-prompt": "What name would you like to use?"
+      "x-prompt": "What is the service file path?"
     },
     "skipFormat": {
       "description": "Skip formatting files.",

package/src/generators/utils/normalize-options.js

@@ -4,14 +4,14 @@ exports.normalizeOptions = normalizeOptions;
 exports.unitTestRunnerToSpec = unitTestRunnerToSpec;
 const artifact_name_and_directory_utils_1 = require("@nx/devkit/src/generators/artifact-name-and-directory-utils");
 async function normalizeOptions(tree, options) {
-    const { directory, fileName } = await (0, artifact_name_and_directory_utils_1.determineArtifactNameAndDirectoryOptions)(tree, {
-        name: options.name,
+    const { directory, artifactName } = await (0, artifact_name_and_directory_utils_1.determineArtifactNameAndDirectoryOptions)(tree, {
         path: options.path,
     });
+    options.path = undefined; // Now that we have `directory` we don't need `path`
     return {
         ...options,
         flat: true,
-        name: fileName,
+        name: artifactName,
         skipFormat: options.skipFormat,
         sourceRoot: directory,
     };

package/src/generators/utils/types.d.ts

@@ -4,7 +4,6 @@ export type NestSchematic = 'class' | 'controller' | 'decorator' | 'filter' | 'g
 export type TransportLayer = 'rest' | 'graphql-code-first' | 'graphql-schema-first' | 'microservice' | 'ws';
 export type NestGeneratorOptions = {
     path: string;
-    name?: string;
     skipFormat?: boolean;
 };
 export type NestGeneratorWithLanguageOption = NestGeneratorOptions & {