fix(core): remove nameAndDirectoryFormat & directory from generators

nrwl · Sep 25, 2024 · 6d55a44 · 6d55a44
1 parent 04cf92a
commit 6d55a44
Show file tree

Hide file tree

Showing 114 changed files with 603 additions and 933 deletions.
diff --git a/docs/generated/packages/expo/generators/component.json b/docs/generated/packages/expo/generators/component.json
@@ -9,19 +9,25 @@
     "type": "object",
     "examples": [
       {
-        "command": "g @nx/expo:component my-component --directory=mylib/my-component",
+        "command": "g @nx/expo:component mylib/my-component --name my-component",
         "description": "Generate a component in the mylib library"
       },
       {
-        "command": "g @nx/expo:component my-component --directory=mylib/my-component --classComponent",
+        "command": "g @nx/expo:component mylib/my-component --name my-component --classComponent",
         "description": "Generate a class component in the mylib library"
       }
     ],
     "properties": {
+      "path": {
+        "type": "string",
+        "description": "Path where the component will be generated.",
+        "$default": { "$source": "argv", "index": 0 },
+        "x-prompt": "Where should the component be generated?",
+        "x-priority": "important"
+      },
       "name": {
         "type": "string",
         "description": "The name of the component.",
-        "$default": { "$source": "argv", "index": 0 },
         "x-prompt": "What name would you like to use for the component?"
       },
       "js": {
@@ -40,16 +46,6 @@
         "description": "When true, does not create \"spec.ts\" test files for the new component.",
         "default": false
       },
-      "directory": {
-        "type": "string",
-        "description": "The directory at which to create the component file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the project root.",
-        "x-priority": "important"
-      },
-      "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"]
-      },
       "export": {
         "type": "boolean",
         "description": "When true, the component is exported from the project index.ts (if it exists).",
@@ -64,7 +60,7 @@
         "default": false
       }
     },
-    "required": ["name"],
+    "required": ["path"],
     "presets": []
   },
   "description": "Create a component",

diff --git a/docs/generated/packages/nest/generators/class.json b/docs/generated/packages/nest/generators/class.json
@@ -9,28 +9,16 @@
     "cli": "nx",
     "type": "object",
     "properties": {
-      "name": {
-        "description": "The name of the class.",
+      "path": {
+        "description": "Path where the class will be generated.",
         "type": "string",
         "$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"]
+        "x-prompt": "Where should the class be generated?"
       },
-      "project": {
-        "description": "The Nest project to target.",
-        "type": "string",
-        "$default": { "$source": "projectName" },
-        "alias": "p",
-        "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 v20."
-      },
-      "directory": {
-        "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.",
+      "name": {
+        "description": "The name of the class.",
         "type": "string",
-        "aliases": ["dir", "path"]
+        "x-prompt": "What name would you like to use?"
       },
       "skipFormat": {
         "description": "Skip formatting files.",
@@ -57,7 +45,7 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name"],
+    "required": ["path"],
     "presets": []
   },
   "description": "Run the `class` NestJS generator with Nx project support.",

diff --git a/docs/generated/packages/nest/generators/controller.json b/docs/generated/packages/nest/generators/controller.json
@@ -9,22 +9,18 @@
     "cli": "nx",
     "type": "object",
     "properties": {
+      "path": {
+        "description": "Path where the controller will be generated.",
+        "type": "string",
+        "$default": { "$source": "argv", "index": 0 },
+        "x-prompt": "Where should the controller be generated?"
+      },
       "name": {
         "description": "The name of the controller.",
         "type": "string",
         "$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"]
-      },
-      "directory": {
-        "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"]
-      },
       "skipFormat": {
         "description": "Skip formatting files.",
         "type": "boolean",
@@ -53,7 +49,7 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name"],
+    "required": ["path"],
     "presets": []
   },
   "description": "Run the `controller` NestJS generator with Nx project support.",

diff --git a/docs/generated/packages/nest/generators/decorator.json b/docs/generated/packages/nest/generators/decorator.json
@@ -9,21 +9,16 @@
     "cli": "nx",
     "type": "object",
     "properties": {
-      "name": {
-        "description": "The name of the decorator.",
+      "path": {
+        "description": "Path where the decorator will be generated.",
         "type": "string",
         "$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"]
+        "x-prompt": "Where should the decorator be generated?"
       },
-      "directory": {
-        "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.",
+      "name": {
+        "description": "The name of the decorator.",
         "type": "string",
-        "aliases": ["dir", "path"]
+        "x-prompt": "What name would you like to use?"
       },
       "skipFormat": {
         "description": "Skip formatting files.",
@@ -38,7 +33,7 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name"],
+    "required": ["path"],
     "presets": []
   },
   "description": "Run the `decorator` NestJS generator with Nx project support.",

diff --git a/docs/generated/packages/nest/generators/filter.json b/docs/generated/packages/nest/generators/filter.json
@@ -9,21 +9,16 @@
     "cli": "nx",
     "type": "object",
     "properties": {
-      "name": {
-        "description": "The name of the filter.",
+      "path": {
+        "description": "Path where the filter will be generated.",
         "type": "string",
         "$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"]
+        "x-prompt": "Where should the filter be generated?"
       },
-      "directory": {
-        "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.",
+      "name": {
+        "description": "The name of the filter.",
         "type": "string",
-        "aliases": ["dir", "path"]
+        "x-prompt": "What name would you like to use?"
       },
       "skipFormat": {
         "type": "boolean",
@@ -44,7 +39,7 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name"],
+    "required": ["path"],
     "presets": []
   },
   "description": "Run the `filter` NestJS generator with Nx project support.",

diff --git a/docs/generated/packages/nest/generators/gateway.json b/docs/generated/packages/nest/generators/gateway.json
@@ -9,21 +9,16 @@
     "cli": "nx",
     "type": "object",
     "properties": {
-      "name": {
-        "description": "The name of the gateway.",
+      "path": {
+        "description": "Path where the gateway will be generated.",
         "type": "string",
         "$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"]
+        "x-prompt": "Where should the gateway be generated?"
       },
-      "directory": {
-        "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.",
+      "name": {
+        "description": "The name of the gateway.",
         "type": "string",
-        "aliases": ["dir", "path"]
+        "x-prompt": "What name would you like to use?"
       },
       "skipFormat": {
         "description": "Skip formatting files.",
@@ -44,7 +39,7 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name"],
+    "required": ["path"],
     "presets": []
   },
   "description": "Run the `gateway` NestJS generator with Nx project support.",

diff --git a/docs/generated/packages/nest/generators/guard.json b/docs/generated/packages/nest/generators/guard.json
@@ -9,21 +9,16 @@
     "cli": "nx",
     "type": "object",
     "properties": {
-      "name": {
-        "description": "The name of the guard.",
+      "path": {
+        "description": "Path where the guard will be generated.",
         "type": "string",
         "$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"]
+        "x-prompt": "Where should the guard be generated?"
       },
-      "directory": {
-        "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.",
+      "name": {
+        "description": "The name of the guard.",
         "type": "string",
-        "aliases": ["dir", "path"]
+        "x-prompt": "What name would you like to use?"
       },
       "skipFormat": {
         "description": "Skip formatting files.",

diff --git a/docs/generated/packages/nest/generators/interceptor.json b/docs/generated/packages/nest/generators/interceptor.json
@@ -9,21 +9,16 @@
     "cli": "nx",
     "type": "object",
     "properties": {
-      "name": {
-        "description": "The name of the interceptor.",
+      "path": {
+        "description": "Path where the interceptor will be generated.",
         "type": "string",
         "$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"]
+        "x-prompt": "Where should the interceptor be generated?"
       },
-      "directory": {
-        "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.",
+      "name": {
+        "description": "The name of the interceptor.",
         "type": "string",
-        "aliases": ["dir", "path"]
+        "x-prompt": "What name would you like to use?"
       },
       "skipFormat": {
         "description": "Skip formatting files.",

diff --git a/docs/generated/packages/nest/generators/interface.json b/docs/generated/packages/nest/generators/interface.json
@@ -9,28 +9,16 @@
     "cli": "nx",
     "type": "object",
     "properties": {
-      "name": {
-        "description": "The name of the interface.",
+      "path": {
+        "description": "Path where the interface will be generated.",
         "type": "string",
         "$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"]
+        "x-prompt": "Where should the interface be generated?"
       },
-      "project": {
-        "description": "The Nest project to target.",
-        "type": "string",
-        "$default": { "$source": "projectName" },
-        "alias": "p",
-        "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 v20."
-      },
-      "directory": {
-        "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.",
+      "name": {
+        "description": "The name of the interface.",
         "type": "string",
-        "aliases": ["dir", "path"]
+        "x-prompt": "What name would you like to use?"
       },
       "skipFormat": {
         "description": "Skip formatting files.",
@@ -46,7 +34,7 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name"],
+    "required": ["path"],
     "presets": []
   },
   "description": "Run the `interface` NestJS generator with Nx project support.",

diff --git a/docs/generated/packages/nest/generators/middleware.json b/docs/generated/packages/nest/generators/middleware.json
@@ -9,21 +9,16 @@
     "cli": "nx",
     "type": "object",
     "properties": {
-      "name": {
-        "description": "The name of the middleware.",
+      "path": {
+        "description": "Path where the middleware will be generated.",
         "type": "string",
         "$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"]
+        "x-prompt": "Where should the middleware be generated?"
       },
-      "directory": {
-        "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.",
+      "name": {
+        "description": "The name of the middleware.",
         "type": "string",
-        "aliases": ["dir", "path"]
+        "x-prompt": "What name would you like to use?"
       },
       "skipFormat": {
         "description": "Skip formatting files.",
@@ -44,7 +39,7 @@
       }
     },
     "additionalProperties": false,
-    "required": ["name"],
+    "required": ["path"],
     "presets": []
   },
   "description": "Run the `middleware` NestJS generator with Nx project support.",