@nx/angular 0.0.0-pr-29122-4727ac1 → 0.0.0-pr-29114-4447aa0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/angular",
-  "version": "0.0.0-pr-29122-4727ac1",
+  "version": "0.0.0-pr-29114-4447aa0",
   "private": false,
   "description": "The Nx Plugin for Angular contains executors, generators, and utilities for managing Angular applications and libraries within an Nx workspace. It provides: \n\n- Integration with libraries such as Storybook, Jest, ESLint, Tailwind CSS, Playwright and Cypress. \n\n- Generators to help scaffold code quickly (like: Micro Frontends, Libraries, both internal to your codebase and publishable to npm) \n\n- Single Component Application Modules (SCAMs) \n\n- NgRx helpers. \n\n- Utilities for automatic workspace refactoring.",
   "repository": {
@@ -78,13 +78,13 @@
     "semver": "^7.5.3",
     "tslib": "^2.3.0",
     "webpack-merge": "^5.8.0",
-    "@nx/devkit": "0.0.0-pr-29122-4727ac1",
-    "@nx/js": "0.0.0-pr-29122-4727ac1",
-    "@nx/eslint": "0.0.0-pr-29122-4727ac1",
-    "@nx/webpack": "0.0.0-pr-29122-4727ac1",
-    "@nx/module-federation": "0.0.0-pr-29122-4727ac1",
-    "@nx/web": "0.0.0-pr-29122-4727ac1",
-    "@nx/workspace": "0.0.0-pr-29122-4727ac1",
+    "@nx/devkit": "0.0.0-pr-29114-4447aa0",
+    "@nx/js": "0.0.0-pr-29114-4447aa0",
+    "@nx/eslint": "0.0.0-pr-29114-4447aa0",
+    "@nx/webpack": "0.0.0-pr-29114-4447aa0",
+    "@nx/module-federation": "0.0.0-pr-29114-4447aa0",
+    "@nx/web": "0.0.0-pr-29114-4447aa0",
+    "@nx/workspace": "0.0.0-pr-29114-4447aa0",
     "piscina": "^4.4.0"
   },
   "peerDependencies": {

package/src/generators/component/schema.json

@@ -9,16 +9,17 @@
   "properties": {
     "path": {
       "type": "string",
-      "description": "The file path to the component without the file extension and suffix. Relative to the current working directory.",
+      "description": "The path at which to create the component file, relative to the workspace root. By default, it is set to the root of the project.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What is the component file path?"
+      "x-prompt": "Where to create the component?"
     },
     "name": {
       "type": "string",
-      "description": "The component symbol name. Defaults to the last segment of the file path."
+      "description": "The name of the component.",
+      "x-prompt": "What name would you like to use for the component?"
     },
     "prefix": {
       "type": "string",

package/src/generators/directive/schema.d.ts

@@ -1,3 +1,5 @@
+import { NameAndDirectoryFormat } from '@nx/devkit/src/generators/artifact-name-and-directory-utils';
+
 export interface Schema {
   path: string;
   name?: string;

package/src/generators/directive/schema.json

@@ -6,29 +6,20 @@
   "type": "object",
   "description": "Creates a new Angular directive.",
   "additionalProperties": false,
-  "examples": [
-    {
-      "description": "Generate a directive with the exported symbol matching the file name. It results in the directive `FooDirective` at `mylib/src/lib/foo.directive.ts`",
-      "command": "nx g @nx/angular:directive mylib/src/lib/foo"
-    },
-    {
-      "description": "Generate a directive with the exported symbol different from the file name. It results in the directive `CustomDirective` at `mylib/src/lib/foo.directive.ts`",
-      "command": "nx g @nx/angular:directive mylib/src/lib/foo --name=custom"
-    }
-  ],
   "properties": {
     "path": {
       "type": "string",
-      "description": "The file path to the directive without the file extension and suffix. Relative to the current working directory.",
+      "description": "The path at which to create the directive file.",
+      "x-prompt": "Where to put the directive?",
       "$default": {
         "$source": "argv",
         "index": 0
-      },
-      "x-prompt": "What is the directive file path?"
+      }
     },
     "name": {
       "type": "string",
-      "description": "The directive symbol name. Defaults to the last segment of the file path."
+      "description": "The name of the new directive.",
+      "x-prompt": "What name would you like to use for the directive?"
     },
     "prefix": {
       "type": "string",

package/src/generators/pipe/schema.d.ts

@@ -1,3 +1,5 @@
+import { NameAndDirectoryFormat } from '@nx/devkit/src/generators/artifact-name-and-directory-utils';
+
 export interface Schema {
   path: string;
   name?: string;

package/src/generators/pipe/schema.json

@@ -6,29 +6,20 @@
   "cli": "nx",
   "additionalProperties": false,
   "description": "Creates an Angular pipe.",
-  "examples": [
-    {
-      "description": "Generate a pipe with the exported symbol matching the file name. It results in the pipe `FooPipe` at `mylib/src/lib/foo.pipe.ts`",
-      "command": "nx g @nx/angular:pipe mylib/src/lib/foo"
-    },
-    {
-      "description": "Generate a pipe with the exported symbol different from the file name. It results in the pipe `CustomPipe` at `mylib/src/lib/foo.pipe.ts`",
-      "command": "nx g @nx/angular:pipe mylib/src/lib/foo --name=custom"
-    }
-  ],
   "properties": {
     "path": {
       "type": "string",
-      "description": "The file path to the pipe without the file extension and suffix. Relative to the current working directory.",
+      "description": "The path at which to create the pipe file, relative to the workspace root.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What is the pipe file path?"
+      "x-prompt": "What is the path of the new pipe?"
     },
     "name": {
       "type": "string",
-      "description": "The pipe symbol name. Defaults to the last segment of the file path."
+      "description": "The name of the pipe.",
+      "x-prompt": "What name would you like to use for the pipe?"
     },
     "skipTests": {
       "type": "boolean",

package/src/generators/scam/schema.d.ts

@@ -1,3 +1,5 @@
+import { NameAndDirectoryFormat } from '@nx/devkit/src/generators/artifact-name-and-directory-utils';
+
 export interface Schema {
   path: string;
   name?: string;

package/src/generators/scam/schema.json

@@ -6,12 +6,8 @@
   "type": "object",
   "examples": [
     {
-      "description": "Generate a component with the exported symbol matching the file name. It results in the component `FooComponent` at `mylib/src/lib/foo.component.ts`",
-      "command": "nx g @nx/angular:scam mylib/src/lib/foo"
-    },
-    {
-      "description": "Generate a component with the exported symbol different from the file name. It results in the component `CustomComponent` at `mylib/src/lib/foo.component.ts`",
-      "command": "nx g @nx/angular:scam mylib/src/lib/foo --name=custom"
+      "command": "nx g @nx/angular:scam my-lib/src/lib/my-sample/my-sample",
+      "description": "Generate a `MySampleComponent` component in the `my-lib` library."
     }
   ],
   "description": "Creates a new Angular SCAM.",
@@ -19,16 +15,17 @@
   "properties": {
     "path": {
       "type": "string",
-      "description": "The file path to the SCAM without the file extension and suffix. Relative to the current working directory.",
+      "description": "The path at which to create the SCAM file, relative to the workspace root.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What is the SCAM file path?"
+      "x-prompt": "What is the path of the new SCAM?"
     },
     "name": {
       "type": "string",
-      "description": "The component symbol name. Defaults to the last segment of the file path."
+      "description": "The name of the component.",
+      "x-prompt": "What name would you like to use for the component?"
     },
     "displayBlock": {
       "description": "Specifies if the style will contain `:host { display: block; }`.",

package/src/generators/scam-directive/schema.d.ts

@@ -1,3 +1,5 @@
+import { NameAndDirectoryFormat } from '@nx/devkit/src/generators/artifact-name-and-directory-utils';
+
 export interface Schema {
   path: string;
   name?: string;

package/src/generators/scam-directive/schema.json

@@ -6,12 +6,8 @@
   "type": "object",
   "examples": [
     {
-      "description": "Generate a directive with the exported symbol matching the file name. It results in the directive `FooDirective` at `mylib/src/lib/foo.directive.ts`",
-      "command": "nx g @nx/angular:scam-directive mylib/src/lib/foo"
-    },
-    {
-      "description": "Generate a directive with the exported symbol different from the file name. It results in the directive `CustomDirective` at `mylib/src/lib/foo.directive.ts`",
-      "command": "nx g @nx/angular:scam-directive mylib/src/lib/foo --name=custom"
+      "command": "nx g @nx/angular:scam-directive my-sample --directory=my-lib/src/lib/my-sample",
+      "description": "Generate a `MySampleDirective` directive in a `my-sample` folder in the `my-lib` library"
     }
   ],
   "description": "Creates a new, generic Angular directive definition in the given or default project.",
@@ -19,16 +15,38 @@
   "properties": {
     "path": {
       "type": "string",
-      "description": "The file path to the SCAM directive without the file extension and suffix. Relative to the current working directory.",
+      "description": "The path at which to create the SCAM Directive files, relative to the workspace root.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What is the SCAM directive file path?"
+      "x-prompt": "What is the path of the new directive?"
     },
     "name": {
       "type": "string",
-      "description": "The directive symbol name. Defaults to the last segment of the file path."
+      "description": "The name of the directive.",
+      "x-prompt": "What name would you like to use for the directive?",
+      "x-priority": "important"
+    },
+    "directory": {
+      "type": "string",
+      "description": "The directory at which to create the SCAM Directive files. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
+      "aliases": ["dir", "path"],
+      "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"]
+    },
+    "project": {
+      "type": "string",
+      "description": "The name of the project.",
+      "$default": {
+        "$source": "projectName"
+      },
+      "x-dropdown": "projects",
+      "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."
     },
     "skipTests": {
       "type": "boolean",
@@ -41,6 +59,12 @@
       "default": true,
       "x-priority": "important"
     },
+    "flat": {
+      "type": "boolean",
+      "description": "Create the new files at the top level of the current project.",
+      "default": true,
+      "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
+    },
     "selector": {
       "type": "string",
       "format": "html-selector",

package/src/generators/scam-pipe/schema.d.ts

@@ -1,3 +1,5 @@
+import { NameAndDirectoryFormat } from '@nx/devkit/src/generators/artifact-name-and-directory-utils';
+
 export interface Schema {
   path: string;
   name?: string;

package/src/generators/scam-pipe/schema.json

@@ -6,12 +6,8 @@
   "type": "object",
   "examples": [
     {
-      "description": "Generate a pipe with the exported symbol matching the file name. It results in the pipe `FooPipe` at `mylib/src/lib/foo.pipe.ts`",
-      "command": "nx g @nx/angular:scam-pipe mylib/src/lib/foo"
-    },
-    {
-      "description": "Generate a pipe with the exported symbol different from the file name. It results in the pipe `CustomPipe` at `mylib/src/lib/foo.pipe.ts`",
-      "command": "nx g @nx/angular:scam-pipe mylib/src/lib/foo --name=custom"
+      "command": "nx g @nx/angular:scam-pipe mylib/src/lib/my-transformation/my-transformation",
+      "description": "Generates a `MyTransformationPipe` in a `my-transformation` folder in the `my-lib` project"
     }
   ],
   "description": "Creates a new, generic Angular pipe definition in the given or default project.",
@@ -19,16 +15,18 @@
   "properties": {
     "path": {
       "type": "string",
-      "description": "The file path to the SCAM pipe without the file extension and suffix. Relative to the current working directory.",
+      "description": "The path at which to create the pipe file, relative to the workspace root.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What is the SCAM pipe file path?"
+      "x-prompt": "What is the path of the new pipe?"
     },
     "name": {
       "type": "string",
-      "description": "The pipe symbol name. Defaults to the last segment of the file path."
+      "description": "The name of the pipe.",
+      "x-prompt": "What name would you like to use for the pipe?",
+      "x-priority": "important"
     },
     "skipTests": {
       "type": "boolean",
@@ -41,6 +39,12 @@
       "default": true,
       "x-priority": "important"
     },
+    "flat": {
+      "type": "boolean",
+      "description": "Create the new files at the top level of the current project.",
+      "default": true,
+      "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
+    },
     "export": {
       "type": "boolean",
       "description": "Specifies if the SCAM should be exported from the project's entry point (normally `index.ts`). It only applies to libraries.",