@schematics/angular 19.1.0-rc.0 → 19.1.0

package/interceptor/schema.d.ts

@@ -1,29 +1,38 @@
 /**
- * Creates a new, generic interceptor definition in the given project.
+ * Creates a new interceptor in your project. Interceptors are used to intercept and modify
+ * HTTP requests and responses before they reach their destination. This allows you to
+ * perform tasks like adding authentication headers, handling errors, or logging requests.
+ * This schematic generates the necessary files and boilerplate code for a new interceptor.
  */
 export interface Schema {
     /**
-     * When true (the default), creates files at the top level of the project.
+     * Creates the new interceptor files at the top level of the current project. If set to
+     * false, a new folder with the interceptor's name will be created to contain the files.
      */
     flat?: boolean;
     /**
-     * Creates the interceptor as a `HttpInterceptorFn`.
+     * Creates the interceptor as a function `HttpInterceptorFn` instead of a class. Functional
+     * interceptors can be simpler for basic scenarios.
      */
     functional?: boolean;
     /**
-     * The name of the interceptor.
+     * The name for the new interceptor. This will be used to create the interceptor's class and
+     * spec files (e.g., `my-interceptor.interceptor.ts` and
+     * `my-interceptor.interceptor.spec.ts`).
      */
     name: string;
     /**
-     * The path at which to create the interceptor, relative to the workspace root.
+     * The path where the interceptor files should be created, relative to the workspace root.
+     * If not provided, the interceptor will be created in the current directory.
      */
     path?: string;
     /**
-     * The name of the project.
+     * The name of the project where the interceptor 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 interceptor.
+     * Skip the generation of a unit test file `spec.ts` for the new interceptor.
      */
     skipTests?: boolean;
 }

package/interceptor/schema.json

@@ -4,11 +4,11 @@
   "title": "Angular Interceptor Options Schema",
   "type": "object",
   "additionalProperties": false,
-  "description": "Creates a new, generic interceptor definition in the given project.",
+  "description": "Creates a new interceptor in your project. Interceptors are used to intercept and modify HTTP requests and responses before they reach their destination. This allows you to perform tasks like adding authentication headers, handling errors, or logging requests. This schematic generates the necessary files and boilerplate code for a new interceptor.",
   "properties": {
     "name": {
       "type": "string",
-      "description": "The name of the interceptor.",
+      "description": "The name for the new interceptor. This will be used to create the interceptor's class and spec files (e.g., `my-interceptor.interceptor.ts` and `my-interceptor.interceptor.spec.ts`).",
       "$default": {
         "$source": "argv",
         "index": 0
@@ -21,12 +21,12 @@
       "$default": {
         "$source": "workingDirectory"
       },
-      "description": "The path at which to create the interceptor, relative to the workspace root.",
+      "description": "The path where the interceptor files should be created, relative to the workspace root. If not provided, the interceptor 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 interceptor should be created. If not specified, the CLI will determine the project from the current directory.",
       "$default": {
         "$source": "projectName"
       }
@@ -34,16 +34,16 @@
     "flat": {
       "type": "boolean",
       "default": true,
-      "description": "When true (the default), creates files at the top level of the project."
+      "description": "Creates the new interceptor files at the top level of the current project. If set to false, a new folder with the interceptor's name will be created to contain the files."
     },
     "skipTests": {
       "type": "boolean",
-      "description": "Do not create \"spec.ts\" test files for the new interceptor.",
+      "description": "Skip the generation of a unit test file `spec.ts` for the new interceptor.",
       "default": false
     },
     "functional": {
       "type": "boolean",
-      "description": "Creates the interceptor as a `HttpInterceptorFn`.",
+      "description": "Creates the interceptor as a function `HttpInterceptorFn` instead of a class. Functional interceptors can be simpler for basic scenarios.",
       "default": true
     }
   },

package/interface/schema.d.ts

@@ -1,25 +1,33 @@
 /**
- * Creates a new, generic interface definition in the given project.
+ * Creates a new interface in your project. Interfaces define the structure of objects in
+ * TypeScript, ensuring type safety and code clarity. This schematic generates a new
+ * interface with the specified name and type.
  */
 export interface Schema {
     /**
-     * The name of the interface.
+     * The name for the new interface. This will be used to create the interface file (e.g.,
+     * `my-interface.interface.ts`).
      */
     name: string;
     /**
-     * The path at which to create the interface, relative to the workspace root.
+     * The path where the interface file should be created, relative to the workspace root. If
+     * not provided, the interface will be created in the current directory.
      */
     path?: string;
     /**
-     * A prefix to apply to generated selectors.
+     * A prefix to be added to the interface name. This is typically not used for interfaces, as
+     * they don't have selectors like components or directives.
      */
     prefix?: string;
     /**
-     * The name of the project.
+     * The name of the project where the interface 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 interface
+     * names. For example, if you set the type to `data`, the filename will be
+     * `my-interface.data.ts`.
      */
     type?: string;
 }

package/interface/schema.json

@@ -4,11 +4,11 @@
   "title": "Angular Interface Options Schema",
   "type": "object",
   "additionalProperties": false,
-  "description": "Creates a new, generic interface definition in the given project.",
+  "description": "Creates a new interface in your project. Interfaces define the structure of objects in TypeScript, ensuring type safety and code clarity. This schematic generates a new interface with the specified name and type.",
   "properties": {
     "name": {
       "type": "string",
-      "description": "The name of the interface.",
+      "description": "The name for the new interface. This will be used to create the interface file (e.g., `my-interface.interface.ts`).",
       "$default": {
         "$source": "argv",
         "index": 0
@@ -21,23 +21,23 @@
       "$default": {
         "$source": "workingDirectory"
       },
-      "description": "The path at which to create the interface, relative to the workspace root.",
+      "description": "The path where the interface file should be created, relative to the workspace root. If not provided, the interface 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 interface should be created. 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 interface name. This is typically not used for interfaces, as they don't have selectors like components or directives."
     },
     "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 interface names. For example, if you set the type to `data`, the filename will be `my-interface.data.ts`.",
       "$default": {
         "$source": "argv",
         "index": 1

package/library/schema.d.ts

@@ -1,38 +1,50 @@
 /**
- * Creates a new, generic library project in the current workspace.
+ * Creates a new library project in your Angular workspace. Libraries are reusable
+ * collections of components, services, and other Angular artifacts that can be shared
+ * across multiple applications. This schematic simplifies the process of generating a new
+ * library with the necessary files and configurations.
  */
 export interface Schema {
     /**
-     * The path at which to create the library's public API file, relative to the workspace root.
+     * The path to the library's public API file, relative to the workspace root. This file
+     * defines what parts of the library are accessible to applications that import it.
      */
     entryFile?: string;
     /**
-     * The name of the library.
+     * The name for the new library. This name will be used for the project directory and
+     * various identifiers within the library's code.
      */
     name: string;
     /**
-     * A prefix to apply to generated selectors.
+     * A prefix to be added to the selectors of components generated within this library. For
+     * example, if the prefix is `my-lib` and you generate a component named `my-component`, the
+     * selector will be `my-lib-my-component`.
      */
     prefix?: string;
     /**
-     * The root directory of the new library.
+     * The root directory for the new library, relative to the workspace root. If not specified,
+     * the library will be created in a subfolder within the `projects` directory, using the
+     * library's name.
      */
     projectRoot?: string;
     /**
-     * Do not install dependency packages.
+     * Skip the automatic installation of packages. You will need to manually install the
+     * dependencies later.
      */
     skipInstall?: boolean;
     /**
-     * Do not add dependencies to the "package.json" file.
+     * Do not automatically add dependencies to the `package.json` file.
      */
     skipPackageJson?: boolean;
     /**
-     * Do not update "tsconfig.json" to add a path mapping for the new library. The path mapping
-     * is needed to use the library in an app, but can be disabled here to simplify development.
+     * Do not update the workspace `tsconfig.json` file to add a path mapping for the new
+     * library. The path mapping is needed to use the library in an application, but can be
+     * disabled here to simplify development.
      */
     skipTsConfig?: boolean;
     /**
-     * Creates a library based upon the standalone API, without NgModules.
+     * Create a library that utilizes the standalone API, eliminating the need for NgModules.
+     * This can simplify the structure of your library and its usage in applications.
      */
     standalone?: boolean;
 }

package/library/schema.json

@@ -3,12 +3,12 @@
   "$id": "SchematicsLibrary",
   "title": "Library Options Schema",
   "type": "object",
-  "description": "Creates a new, generic library project in the current workspace.",
+  "description": "Creates a new library project in your Angular workspace. Libraries are reusable collections of components, services, and other Angular artifacts that can be shared across multiple applications. This schematic simplifies the process of generating a new library with the necessary files and configurations.",
   "additionalProperties": false,
   "properties": {
     "name": {
       "type": "string",
-      "description": "The name of the library.",
+      "description": "The name for the new library. This name will be used for the project directory and various identifiers within the library's code.",
       "pattern": "^(?:@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*/)?[a-zA-Z0-9-~][a-zA-Z0-9-._~]*$",
       "$default": {
         "$source": "argv",
@@ -19,37 +19,37 @@
     "entryFile": {
       "type": "string",
       "format": "path",
-      "description": "The path at which to create the library's public API file, relative to the workspace root.",
+      "description": "The path to the library's public API file, relative to the workspace root. This file defines what parts of the library are accessible to applications that import it.",
       "default": "public-api"
     },
     "prefix": {
       "type": "string",
       "format": "html-selector",
-      "description": "A prefix to apply to generated selectors.",
+      "description": "A prefix to be added to the selectors of components generated within this library. For example, if the prefix is `my-lib` and you generate a component named `my-component`, the selector will be `my-lib-my-component`.",
       "default": "lib",
       "alias": "p"
     },
     "skipPackageJson": {
       "type": "boolean",
       "default": false,
-      "description": "Do not add dependencies to the \"package.json\" file. "
+      "description": "Do not automatically add dependencies to the `package.json` file."
     },
     "skipInstall": {
-      "description": "Do not install dependency packages.",
+      "description": "Skip the automatic installation of packages. You will need to manually install the dependencies later.",
       "type": "boolean",
       "default": false
     },
     "skipTsConfig": {
       "type": "boolean",
       "default": false,
-      "description": "Do not update \"tsconfig.json\" to add a path mapping for the new library. The path mapping is needed to use the library in an app, but can be disabled here to simplify development."
+      "description": "Do not update the workspace `tsconfig.json` file to add a path mapping for the new library. The path mapping is needed to use the library in an application, but can be disabled here to simplify development."
     },
     "projectRoot": {
       "type": "string",
-      "description": "The root directory of the new library."
+      "description": "The root directory for the new library, relative to the workspace root. If not specified, the library will be created in a subfolder within the `projects` directory, using the library's name."
     },
     "standalone": {
-      "description": "Creates a library based upon the standalone API, without NgModules.",
+      "description": "Create a library that utilizes the standalone API, eliminating the need for NgModules. This can simplify the structure of your library and its usage in applications.",
       "type": "boolean",
       "default": true,
       "x-user-analytics": "ep.ng_standalone"

package/ng-new/schema.d.ts

@@ -1,45 +1,54 @@
 /**
- * Creates a new project by combining the workspace and application schematics.
+ * Creates a new Angular workspace and an initial project. This schematic sets up the
+ * foundation for your Angular development, generating the workspace configuration files and
+ * an optional starter application. You can customize various aspects of the workspace and
+ * the initial project, such as routing, styling, and testing.
  */
 export interface Schema {
     /**
-     * Initial git repository commit information.
+     * Configure the initial Git commit for the new repository.
      */
     commit?: CommitUnion;
     /**
-     * Create a new initial application project in the 'src' folder of the new workspace. When
-     * false, creates an empty workspace with no initial application. You can then use the
-     * generate application command so that all applications are created in the projects folder.
+     * Create a new initial application project in the new workspace. When false, creates an
+     * empty workspace with no initial application. You can then use the `ng generate
+     * application` command to create applications in the `projects` directory.
      */
     createApplication?: boolean;
     /**
-     * The directory name to create the workspace in.
+     * The directory where the new workspace and project should be created. If not specified,
+     * the workspace will be created in the current directory.
      */
     directory?: string;
     /**
-     * Create an application that does not utilize zone.js.
+     * Create an initial application that does not utilize `zone.js`.
      */
     experimentalZoneless?: boolean;
     /**
-     * Include styles inline in the component TS file. By default, an external styles file is
-     * created and referenced in the component TypeScript file.
+     * Include the styles for the initial application's root component directly within the
+     * `app.component.ts` file. By default, a separate stylesheet file (e.g.,
+     * `app.component.css`) is created.
      */
     inlineStyle?: boolean;
     /**
-     * Include template inline in the component TS file. By default, an external template file
-     * is created and referenced in the component TypeScript file.
+     * Include the HTML template for the initial application's root component directly within
+     * the `app.component.ts` file. By default, a separate template file (e.g.,
+     * `app.component.html`) is created.
      */
     inlineTemplate?: boolean;
     /**
-     * Create a workspace without any testing frameworks. (Use for learning purposes only.)
+     * Generate a minimal Angular workspace without any testing frameworks. This is intended for
+     * learning purposes and simple experimentation, not for production applications.
      */
     minimal?: boolean;
     /**
-     * The name of the new workspace and initial project.
+     * The name for the new workspace and the initial project. This name will be used for the
+     * root directory and various identifiers throughout the project.
      */
     name: string;
     /**
-     * The path where new projects will be created, relative to the new workspace root.
+     * The path where new projects will be created within the workspace, relative to the
+     * workspace root. By default, new projects are created in the `projects` directory.
      */
     newProjectRoot?: string;
     /**
@@ -47,33 +56,38 @@ export interface Schema {
      */
     packageManager?: PackageManager;
     /**
-     * The prefix to apply to generated selectors for the initial project.
+     * The prefix to apply to generated selectors for the initial project. For example, if the
+     * prefix is `my-app` and you generate a component named `my-component`, the selector will
+     * be `my-app-my-component`.
      */
     prefix?: string;
     /**
-     * Enable routing in the initial project.
+     * Enable routing in the initial application project. This sets up the necessary files and
+     * modules for managing navigation between different views in your application.
      */
     routing?: boolean;
     /**
-     * Creates a server application using the Server Routing and App Engine APIs (Developer
-     * Preview).
+     * Create a server application in the initial project using the Server Routing and App
+     * Engine APIs (Developer Preview).
      */
     serverRouting?: boolean;
     /**
-     * Do not initialize a git repository.
+     * Do not initialize a Git repository in the new workspace. By default, a Git repository is
+     * initialized to help you track changes to your project.
      */
     skipGit?: boolean;
     /**
-     * Do not install dependency packages.
+     * Skip the automatic installation of packages. You will need to manually install the
+     * dependencies later.
      */
     skipInstall?: boolean;
     /**
-     * Do not generate "spec.ts" test files for the new project.
+     * Skip the generation of unit test files `spec.ts`.
      */
     skipTests?: boolean;
     /**
-     * Creates an application with Server-Side Rendering (SSR) and Static Site Generation
-     * (SSG/Prerendering) enabled.
+     * Configure the initial application for Server-Side Rendering (SSR) and Static Site
+     * Generation (SSG/Prerendering).
      */
     ssr?: boolean;
     /**
@@ -81,13 +95,13 @@ export interface Schema {
      */
     standalone?: boolean;
     /**
-     * Creates a workspace with stricter type checking and stricter bundle budgets settings.
-     * This setting helps improve maintainability and catch bugs ahead of time. For more
-     * information, see https://angular.dev/tools/cli/template-typecheck#strict-mode
+     * Enable stricter type checking and stricter bundle budgets settings. This setting helps
+     * improve maintainability and catch bugs ahead of time. For more information, see
+     * https://angular.dev/tools/cli/template-typecheck#strict-mode
      */
     strict?: boolean;
     /**
-     * The file extension or preprocessor to use for style files.
+     * The type of stylesheet files to be created for components in the initial project.
      */
     style?: Style;
     /**
@@ -95,12 +109,15 @@ export interface Schema {
      */
     version: string;
     /**
-     * The view encapsulation strategy to use in the initial project.
+     * Sets the view encapsulation mode for components in the initial project. This determines
+     * how component styles are scoped and applied. Options include: `Emulated` (default, styles
+     * are scoped to the component), `None` (styles are global), and `ShadowDom` (styles are
+     * encapsulated using Shadow DOM).
      */
     viewEncapsulation?: ViewEncapsulation;
 }
 /**
- * Initial git repository commit information.
+ * Configure the initial Git commit for the new repository.
  */
 export type CommitUnion = boolean | CommitObject;
 export interface CommitObject {
@@ -120,7 +137,7 @@ export declare enum PackageManager {
     Yarn = "yarn"
 }
 /**
- * The file extension or preprocessor to use for style files.
+ * The type of stylesheet files to be created for components in the initial project.
  */
 export declare enum Style {
     Css = "css",
@@ -129,7 +146,10 @@ export declare enum Style {
     Scss = "scss"
 }
 /**
- * The view encapsulation strategy to use in the initial project.
+ * Sets the view encapsulation mode for components in the initial project. This determines
+ * how component styles are scoped and applied. Options include: `Emulated` (default, styles
+ * are scoped to the component), `None` (styles are global), and `ShadowDom` (styles are
+ * encapsulated using Shadow DOM).
  */
 export declare enum ViewEncapsulation {
     Emulated = "Emulated",

package/ng-new/schema.js

@@ -15,7 +15,7 @@ var PackageManager;
     PackageManager["Yarn"] = "yarn";
 })(PackageManager || (exports.PackageManager = PackageManager = {}));
 /**
- * The file extension or preprocessor to use for style files.
+ * The type of stylesheet files to be created for components in the initial project.
  */
 var Style;
 (function (Style) {
@@ -25,7 +25,10 @@ var Style;
     Style["Scss"] = "scss";
 })(Style || (exports.Style = Style = {}));
 /**
- * The view encapsulation strategy to use in the initial project.
+ * Sets the view encapsulation mode for components in the initial project. This determines
+ * how component styles are scoped and applied. Options include: `Emulated` (default, styles
+ * are scoped to the component), `None` (styles are global), and `ShadowDom` (styles are
+ * encapsulated using Shadow DOM).
  */
 var ViewEncapsulation;
 (function (ViewEncapsulation) {