@schematics/angular 19.1.0-rc.0 → 19.1.1

package/component/schema.json

@@ -3,7 +3,7 @@
   "$id": "SchematicsAngularComponent",
   "title": "Angular Component Options Schema",
   "type": "object",
-  "description": "Creates a new, generic component definition in the given project.",
+  "description": "Creates a new Angular component. Components are the basic building blocks of Angular applications. Each component consists of a TypeScript class, an HTML template, and an optional CSS stylesheet. Use this schematic to generate a new component in your project.",
   "additionalProperties": false,
   "properties": {
     "path": {
@@ -12,19 +12,19 @@
       "$default": {
         "$source": "workingDirectory"
       },
-      "description": "The path at which to create the component file, relative to the current workspace. Default is a folder with the same name as the component in the project root.",
+      "description": "The path where the component files should be created, relative to the current workspace. If not provided, a folder with the same name as the component will be created in the project's `src/app` directory.",
       "visible": false
     },
     "project": {
       "type": "string",
-      "description": "The name of the project.",
+      "description": "The name of the project where the component should be added. If not specified, the CLI will determine the project from the current directory.",
       "$default": {
         "$source": "projectName"
       }
     },
     "name": {
       "type": "string",
-      "description": "The name of the component.",
+      "description": "The name for the new component. This will be used to create the component's class, template, and stylesheet files. For example, if you provide `my-component`, the files will be named `my-component.component.ts`, `my-component.component.html`, and `my-component.component.css`.",
       "$default": {
         "$source": "argv",
         "index": 0
@@ -32,39 +32,39 @@
       "x-prompt": "What name would you like to use for the component?"
     },
     "displayBlock": {
-      "description": "Specifies if the style will contain `:host { display: block; }`.",
+      "description": "Adds `:host { display: block; }` to the component's stylesheet, ensuring the component renders as a block-level element. This is useful for layout purposes.",
       "type": "boolean",
       "default": false,
       "alias": "b"
     },
     "inlineStyle": {
-      "description": "Include styles inline in the component.ts file. Only CSS styles can be included inline. By default, an external styles file is created and referenced in the component.ts file.",
+      "description": "Include the component's styles directly in the `component.ts` file. By default, a separate stylesheet file (e.g., `my-component.component.css`) is created.",
       "type": "boolean",
       "default": false,
       "alias": "s",
       "x-user-analytics": "ep.ng_inline_style"
     },
     "inlineTemplate": {
-      "description": "Include template inline in the component.ts file. By default, an external template file is created and referenced in the component.ts file.",
+      "description": "Include the component's HTML template directly in the `component.ts` file. By default, a separate template file (e.g., `my-component.component.html`) is created.",
       "type": "boolean",
       "default": false,
       "alias": "t",
       "x-user-analytics": "ep.ng_inline_template"
     },
     "standalone": {
-      "description": "Whether the generated component is standalone.",
+      "description": "Generate a standalone component. Standalone components are self-contained and don't need to be declared in an NgModule. They can be used independently or imported directly into other standalone components.",
       "type": "boolean",
       "default": true,
       "x-user-analytics": "ep.ng_standalone"
     },
     "viewEncapsulation": {
-      "description": "The view encapsulation strategy to use in the new component.",
+      "description": "Sets the view encapsulation mode for the component. This determines how the component's styles are scoped and applied.",
       "enum": ["Emulated", "None", "ShadowDom"],
       "type": "string",
       "alias": "v"
     },
     "changeDetection": {
-      "description": "The change detection strategy to use in the new component.",
+      "description": "Configures the change detection strategy for the component.",
       "enum": ["Default", "OnPush"],
       "type": "string",
       "default": "Default",
@@ -72,7 +72,7 @@
     },
     "prefix": {
       "type": "string",
-      "description": "The prefix to apply to the generated component selector.",
+      "description": "A prefix to be added to the component's selector. For example, if the prefix is `app` and the component name is `my-component`, the selector will be `app-my-component`.",
       "alias": "p",
       "oneOf": [
         {
@@ -85,7 +85,7 @@
       ]
     },
     "style": {
-      "description": "The file extension or preprocessor to use for style files, or 'none' to skip generating the style file.",
+      "description": "Specify the type of stylesheet to be created for the component, or `none` to skip creating a stylesheet.",
       "type": "string",
       "default": "css",
       "enum": ["css", "scss", "sass", "less", "none"],
@@ -93,48 +93,48 @@
     },
     "type": {
       "type": "string",
-      "description": "Adds a developer-defined type to the filename, in the format \"name.type.ts\".",
+      "description": "Append a custom type to the component's filename. For example, if you set the type to `container`, the file will be named `my-component.container.ts`.",
       "default": "Component"
     },
     "skipTests": {
       "type": "boolean",
-      "description": "Do not create \"spec.ts\" test files for the new component.",
+      "description": "Skip the generation of unit test files `spec.ts`.",
       "default": false
     },
     "flat": {
       "type": "boolean",
-      "description": "Create the new files at the top level of the current project.",
+      "description": "Create the component files directly in the project's `src/app` directory instead of creating a new folder for them.",
       "default": false
     },
     "skipImport": {
       "type": "boolean",
-      "description": "Do not import this component into the owning NgModule.",
+      "description": "Do not automatically import the new component into its closest NgModule.",
       "default": false
     },
     "selector": {
       "type": "string",
       "format": "html-selector",
-      "description": "The HTML selector to use for this component."
+      "description": "The HTML selector to use for this component. If not provided, a selector will be generated based on the component name (e.g., `app-my-component`)."
     },
     "skipSelector": {
       "type": "boolean",
       "default": false,
-      "description": "Specifies if the component should have a selector or not."
+      "description": "Skip the generation of an HTML selector for the component."
     },
     "module": {
       "type": "string",
-      "description": "The declaring NgModule.",
+      "description": "Specify the NgModule where the component should be declared. If not provided, the CLI will attempt to find the closest NgModule in the component's path.",
       "alias": "m"
     },
     "export": {
       "type": "boolean",
       "default": false,
-      "description": "The declaring NgModule exports this component."
+      "description": "Automatically export the component from the specified NgModule, making it accessible to other modules in the application."
     },
     "exportDefault": {
       "type": "boolean",
       "default": false,
-      "description": "Use default export for the component instead of a named export."
+      "description": "Use a default export for the component in its TypeScript file instead of a named export."
     }
   },
   "required": ["name", "project"]

package/config/schema.d.ts

@@ -1,18 +1,20 @@
 /**
- * Generates a configuration file in the given project.
+ * Generates configuration files for your project. These files control various aspects of
+ * your project's build process, testing, and browser compatibility. This schematic helps
+ * you create or update essential configuration files with ease.
  */
 export interface Schema {
     /**
-     * The name of the project.
+     * The name of the project where the configuration file should be created or updated.
      */
     project: string;
     /**
-     * Specifies which type of configuration file to create.
+     * Specifies the type of configuration file to generate.
      */
     type: Type;
 }
 /**
- * Specifies which type of configuration file to create.
+ * Specifies the type of configuration file to generate.
  */
 export declare enum Type {
     Browserslist = "browserslist",

package/config/schema.js

@@ -4,7 +4,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Type = void 0;
 /**
- * Specifies which type of configuration file to create.
+ * Specifies the type of configuration file to generate.
  */
 var Type;
 (function (Type) {

package/config/schema.json

@@ -4,18 +4,18 @@
   "title": "Angular Config File Options Schema",
   "type": "object",
   "additionalProperties": false,
-  "description": "Generates a configuration file in the given project.",
+  "description": "Generates configuration files for your project. These files control various aspects of your project's build process, testing, and browser compatibility. This schematic helps you create or update essential configuration files with ease.",
   "properties": {
     "project": {
       "type": "string",
-      "description": "The name of the project.",
+      "description": "The name of the project where the configuration file should be created or updated.",
       "$default": {
         "$source": "projectName"
       }
     },
     "type": {
       "type": "string",
-      "description": "Specifies which type of configuration file to create.",
+      "description": "Specifies the type of configuration file to generate.",
       "enum": ["karma", "browserslist"],
       "x-prompt": "Which type of configuration file would you like to create?",
       "$default": {

package/directive/schema.d.ts

@@ -1,50 +1,62 @@
 /**
- * Creates a new, generic directive definition in the given project.
+ * Creates a new directive in your project. Directives are used to extend the behavior or
+ * appearance of HTML elements and components. They allow you to manipulate the DOM, add
+ * custom attributes, and respond to events. This schematic generates the necessary files
+ * and boilerplate code for a new directive.
  */
 export interface Schema {
     /**
-     * The declaring NgModule exports this directive.
+     * Automatically export the directive from the specified NgModule, making it accessible to
+     * other modules in the application.
      */
     export?: boolean;
     /**
-     * When true (the default), creates the new files at the top level of the current project.
+     * Creates the new directive files at the top level of the current project. If set to false,
+     * a new folder with the directive's name will be created to contain the files.
      */
     flat?: boolean;
     /**
-     * The declaring NgModule.
+     * Specify the NgModule where the directive should be declared. If not provided, the CLI
+     * will attempt to find the closest NgModule in the directive's path.
      */
     module?: string;
     /**
-     * The name of the new directive.
+     * The name for the new directive. This will be used to create the directive's class and
+     * spec files (e.g., `my-directive.directive.ts` and `my-directive.directive.spec.ts`).
      */
     name: string;
     /**
-     * The path at which to create the interface that defines the directive, relative to the
-     * workspace root.
+     * The path where the directive files should be created, relative to the workspace root. If
+     * not provided, the directive will be created in the current directory.
      */
     path?: string;
     /**
-     * A prefix to apply to generated selectors.
+     * A prefix to be added to the directive's selector. For example, if the prefix is `app` and
+     * the directive name is `highlight`, the selector will be `appHighlight`.
      */
     prefix?: string;
     /**
-     * The name of the project.
+     * The name of the project where the directive should be added. If not specified, the CLI
+     * will determine the project from the current directory.
      */
     project: string;
     /**
-     * The HTML selector to use for this directive.
+     * The HTML selector to use for this directive. If not provided, a selector will be
+     * generated based on the directive's name (e.g., `appHighlight`).
      */
     selector?: string;
     /**
-     * Do not import this directive into the owning NgModule.
+     * Do not automatically import the new directive into its closest NgModule.
      */
     skipImport?: boolean;
     /**
-     * Do not create "spec.ts" test files for the new class.
+     * Skip the generation of a unit test file `spec.ts` for the new directive.
      */
     skipTests?: boolean;
     /**
-     * Whether the generated directive is standalone.
+     * Generate a standalone directive. Standalone directives are self-contained and don't need
+     * to be declared in an NgModule. They can be used independently or imported directly into
+     * other standalone components or directives.
      */
     standalone?: boolean;
 }

package/directive/schema.json

@@ -3,12 +3,12 @@
   "$id": "SchematicsAngularDirective",
   "title": "Angular Directive Options Schema",
   "type": "object",
-  "description": "Creates a new, generic directive definition in the given project.",
+  "description": "Creates a new directive in your project. Directives are used to extend the behavior or appearance of HTML elements and components. They allow you to manipulate the DOM, add custom attributes, and respond to events. This schematic generates the necessary files and boilerplate code for a new directive.",
   "additionalProperties": false,
   "properties": {
     "name": {
       "type": "string",
-      "description": "The name of the new directive.",
+      "description": "The name for the new directive. This will be used to create the directive's class and spec files (e.g., `my-directive.directive.ts` and `my-directive.directive.spec.ts`).",
       "$default": {
         "$source": "argv",
         "index": 0
@@ -21,19 +21,19 @@
       "$default": {
         "$source": "workingDirectory"
       },
-      "description": "The path at which to create the interface that defines the directive, relative to the workspace root.",
+      "description": "The path where the directive files should be created, relative to the workspace root. If not provided, the directive will be created in the current directory.",
       "visible": false
     },
     "project": {
       "type": "string",
-      "description": "The name of the project.",
+      "description": "The name of the project where the directive should be added. If not specified, the CLI will determine the project from the current directory.",
       "$default": {
         "$source": "projectName"
       }
     },
     "prefix": {
       "type": "string",
-      "description": "A prefix to apply to generated selectors.",
+      "description": "A prefix to be added to the directive's selector. For example, if the prefix is `app` and the directive name is `highlight`, the selector will be `appHighlight`.",
       "alias": "p",
       "oneOf": [
         {
@@ -47,39 +47,39 @@
     },
     "skipTests": {
       "type": "boolean",
-      "description": "Do not create \"spec.ts\" test files for the new class.",
+      "description": "Skip the generation of a unit test file `spec.ts` for the new directive.",
       "default": false
     },
     "skipImport": {
       "type": "boolean",
-      "description": "Do not import this directive into the owning NgModule.",
+      "description": "Do not automatically import the new directive into its closest NgModule.",
       "default": false
     },
     "selector": {
       "type": "string",
       "format": "html-selector",
-      "description": "The HTML selector to use for this directive."
+      "description": "The HTML selector to use for this directive. If not provided, a selector will be generated based on the directive's name (e.g., `appHighlight`)."
     },
     "standalone": {
-      "description": "Whether the generated directive is standalone.",
+      "description": "Generate a standalone directive. Standalone directives are self-contained and don't need to be declared in an NgModule. They can be used independently or imported directly into other standalone components or directives.",
       "type": "boolean",
       "default": true,
       "x-user-analytics": "ep.ng_standalone"
     },
     "flat": {
       "type": "boolean",
-      "description": "When true (the default), creates the new files at the top level of the current project.",
+      "description": "Creates the new directive files at the top level of the current project. If set to false, a new folder with the directive's name will be created to contain the files.",
       "default": true
     },
     "module": {
       "type": "string",
-      "description": "The declaring NgModule.",
+      "description": "Specify the NgModule where the directive should be declared. If not provided, the CLI will attempt to find the closest NgModule in the directive's path.",
       "alias": "m"
     },
     "export": {
       "type": "boolean",
       "default": false,
-      "description": "The declaring NgModule exports this directive."
+      "description": "Automatically export the directive from the specified NgModule, making it accessible to other modules in the application."
     }
   },
   "required": ["name", "project"]

package/enum/schema.d.ts

@@ -1,22 +1,27 @@
 /**
- * Generates a new, generic enum definition in the given project.
+ * Creates a new enum in your project. Enums (enumerations) are a way to define a set of
+ * named constants, making your code more readable and maintainable. This schematic
+ * generates a new enum with the specified name and type.
  */
 export interface Schema {
     /**
-     * The name of the enum.
+     * The name for the new enum. This will be used to create the enum file (e.g.,
+     * `my-enum.enum.ts`).
      */
     name: string;
     /**
-     * The path at which to create the enum definition, relative to the current workspace.
+     * The path where the enum file should be created, relative to the current workspace. If not
+     * specified, the enum will be created in the current directory.
      */
     path?: string;
     /**
-     * The name of the project in which to create the enum. Default is the configured default
-     * project for the workspace.
+     * The name of the project where the enum should be created. If not specified, the CLI will
+     * determine the project from the current directory.
      */
     project: string;
     /**
-     * Adds a developer-defined type to the filename, in the format "name.type.ts".
+     * Adds a custom type to the filename, allowing you to create more descriptive enum names.
+     * For example, if you set the type to `status`, the filename will be `my-enum.status.ts`.
      */
     type?: string;
 }

package/enum/schema.json

@@ -3,12 +3,12 @@
   "$id": "SchematicsAngularEnum",
   "title": "Angular Enum Options Schema",
   "type": "object",
-  "description": "Generates a new, generic enum definition in the given project.",
+  "description": "Creates a new enum in your project. Enums (enumerations) are a way to define a set of named constants, making your code more readable and maintainable. This schematic generates a new enum with the specified name and type.",
   "additionalProperties": false,
   "properties": {
     "name": {
       "type": "string",
-      "description": "The name of the enum.",
+      "description": "The name for the new enum. This will be used to create the enum file (e.g., `my-enum.enum.ts`).",
       "$default": {
         "$source": "argv",
         "index": 0
@@ -21,19 +21,19 @@
       "$default": {
         "$source": "workingDirectory"
       },
-      "description": "The path at which to create the enum definition, relative to the current workspace.",
+      "description": "The path where the enum file should be created, relative to the current workspace. If not specified, the enum will be created in the current directory.",
       "visible": false
     },
     "project": {
       "type": "string",
-      "description": "The name of the project in which to create the enum. Default is the configured default project for the workspace.",
+      "description": "The name of the project where the enum should be created. If not specified, the CLI will determine the project from the current directory.",
       "$default": {
         "$source": "projectName"
       }
     },
     "type": {
       "type": "string",
-      "description": "Adds a developer-defined type to the filename, in the format \"name.type.ts\"."
+      "description": "Adds a custom type to the filename, allowing you to create more descriptive enum names. For example, if you set the type to `status`, the filename will be `my-enum.status.ts`."
     }
   },
   "required": ["name", "project"]

package/environments/schema.d.ts

@@ -1,9 +1,12 @@
 /**
- * Generates and configures environment files for a project.
+ * Generates and configures environment files for your project. Environment files allow you
+ * to define different settings and configurations for various environments, such as
+ * development, testing, and production. This schematic helps you create and manage these
+ * files, making it easier to customize your application's behavior for each environment.
  */
 export interface Schema {
     /**
-     * The name of the project.
+     * The name of the project where the environment files should be created or updated.
      */
     project: string;
 }

package/environments/schema.json

@@ -4,11 +4,11 @@
   "title": "Angular Environments Options Schema",
   "type": "object",
   "additionalProperties": false,
-  "description": "Generates and configures environment files for a project.",
+  "description": "Generates and configures environment files for your project. Environment files allow you to define different settings and configurations for various environments, such as development, testing, and production. This schematic helps you create and manage these files, making it easier to customize your application's behavior for each environment.",
   "properties": {
     "project": {
       "type": "string",
-      "description": "The name of the project.",
+      "description": "The name of the project where the environment files should be created or updated.",
       "$default": {
         "$source": "projectName"
       }

package/guard/schema.d.ts

@@ -1,34 +1,43 @@
 /**
- * Generates a new, generic route guard definition in the given project.
+ * Creates a new route guard in your project. Route guards are used to control access to
+ * parts of your application by checking certain conditions before a route is activated.
+ * This schematic generates a new guard with the specified name, type, and options.
  */
 export interface Schema {
     /**
-     * When true (the default), creates the new files at the top level of the current project.
+     * Creates the new guard files at the top level of the current project. If set to false, a
+     * new folder with the guard's name will be created to contain the files.
      */
     flat?: boolean;
     /**
-     * Specifies whether to generate a guard as a function.
+     * Generate the guard as a function instead of a class. Functional guards can be simpler for
+     * basic scenarios.
      */
     functional?: boolean;
     /**
-     * Specifies which type of guard to create.
+     * Specifies the type(s) of guard to create. You can choose one or more of the following:
+     * `CanActivate` (controls access to a route), `CanActivateChild` (controls access to child
+     * routes), `CanDeactivate` (asks for confirmation before leaving a route), `CanMatch`
+     * (determines if a route can be matched).
      */
     implements?: Implement[];
     /**
-     * The name of the new route guard.
+     * The name for the new route guard. This will be used to create the guard's class and spec
+     * files (e.g., `my-guard.guard.ts` and `my-guard.guard.spec.ts`).
      */
     name: string;
     /**
-     * The path at which to create the interface that defines the guard, relative to the current
-     * workspace.
+     * The path where the guard files should be created, relative to the current workspace. If
+     * not provided, the guard will be created in the current directory.
      */
     path?: string;
     /**
-     * The name of the project.
+     * The name of the project where the guard should be created. If not specified, the CLI will
+     * determine the project from the current directory.
      */
     project: string;
     /**
-     * Do not create "spec.ts" test files for the new guard.
+     * Skip the generation of a unit test file `spec.ts` for the new guard.
      */
     skipTests?: boolean;
 }

package/guard/schema.json

@@ -3,12 +3,12 @@
   "$id": "SchematicsAngularGuard",
   "title": "Angular Guard Options Schema",
   "type": "object",
-  "description": "Generates a new, generic route guard definition in the given project.",
+  "description": "Creates a new route guard in your project. Route guards are used to control access to parts of your application by checking certain conditions before a route is activated. This schematic generates a new guard with the specified name, type, and options.",
   "additionalProperties": false,
   "properties": {
     "name": {
       "type": "string",
-      "description": "The name of the new route guard.",
+      "description": "The name for the new route guard. This will be used to create the guard's class and spec files (e.g., `my-guard.guard.ts` and `my-guard.guard.spec.ts`).",
       "$default": {
         "$source": "argv",
         "index": 0
@@ -17,12 +17,12 @@
     },
     "skipTests": {
       "type": "boolean",
-      "description": "Do not create \"spec.ts\" test files for the new guard.",
+      "description": "Skip the generation of a unit test file `spec.ts` for the new guard.",
       "default": false
     },
     "flat": {
       "type": "boolean",
-      "description": "When true (the default), creates the new files at the top level of the current project.",
+      "description": "Creates the new guard files at the top level of the current project. If set to false, a new folder with the guard's name will be created to contain the files.",
       "default": true
     },
     "path": {
@@ -31,25 +31,25 @@
       "$default": {
         "$source": "workingDirectory"
       },
-      "description": "The path at which to create the interface that defines the guard, relative to the current workspace.",
+      "description": "The path where the guard files should be created, relative to the current workspace. If not provided, the guard will be created in the current directory.",
       "visible": false
     },
     "project": {
       "type": "string",
-      "description": "The name of the project.",
+      "description": "The name of the project where the guard should be created. If not specified, the CLI will determine the project from the current directory.",
       "$default": {
         "$source": "projectName"
       }
     },
     "functional": {
       "type": "boolean",
-      "description": "Specifies whether to generate a guard as a function.",
+      "description": "Generate the guard as a function instead of a class. Functional guards can be simpler for basic scenarios.",
       "default": true
     },
     "implements": {
       "alias": "guardType",
       "type": "array",
-      "description": "Specifies which type of guard to create.",
+      "description": "Specifies the type(s) of guard to create. You can choose one or more of the following: `CanActivate` (controls access to a route), `CanActivateChild` (controls access to child routes), `CanDeactivate` (asks for confirmation before leaving a route), `CanMatch` (determines if a route can be matched).",
       "uniqueItems": true,
       "minItems": 1,
       "items": {