From a547fd4e702feb0c49bcb8d066bd192cf7fbd673 Mon Sep 17 00:00:00 2001 From: Alan Agius Date: Wed, 15 Jan 2025 16:13:06 +0000 Subject: [PATCH] docs: enhance descriptions for schematics options Refined and clarified the descriptions for various schematics options to improve their readability and accuracy. These changes aim to make the documentation more user-friendly and accessible for developers. Closes #25571 --- packages/angular/pwa/pwa/schema.json | 7 ++-- .../angular/ssr/schematics/ng-add/schema.json | 7 ++-- .../schematics/angular/app-shell/schema.json | 6 +-- .../angular/application/schema.json | 36 ++++++++-------- packages/schematics/angular/class/schema.json | 12 +++--- .../schematics/angular/component/schema.json | 42 +++++++++---------- .../schematics/angular/config/schema.json | 6 +-- .../schematics/angular/directive/schema.json | 24 +++++------ packages/schematics/angular/enum/schema.json | 10 ++--- .../angular/environments/schema.json | 4 +- packages/schematics/angular/guard/schema.json | 16 +++---- .../angular/interceptor/schema.json | 14 +++---- .../schematics/angular/interface/schema.json | 12 +++--- .../schematics/angular/library/schema.json | 18 ++++---- .../schematics/angular/ng-new/schema.json | 40 +++++++++--------- packages/schematics/angular/pipe/schema.json | 20 ++++----- .../schematics/angular/resolver/schema.json | 16 +++---- .../schematics/angular/server/schema.json | 8 ++-- .../angular/service-worker/schema.json | 6 +-- .../schematics/angular/service/schema.json | 12 +++--- packages/schematics/angular/ssr/schema.json | 7 ++-- .../schematics/angular/web-worker/schema.json | 10 ++--- .../schematics/angular/workspace/schema.json | 12 +++--- 23 files changed, 174 insertions(+), 171 deletions(-) diff --git a/packages/angular/pwa/pwa/schema.json b/packages/angular/pwa/pwa/schema.json index ff41cebe8335..0fa36696cd5e 100644 --- a/packages/angular/pwa/pwa/schema.json +++ b/packages/angular/pwa/pwa/schema.json @@ -3,22 +3,23 @@ "$id": "SchematicsAngularPWA", "title": "Angular PWA Options Schema", "type": "object", + "description": "Transforms your Angular application into a Progressive Web App (PWA). PWAs provide a native app-like experience, allowing users to install your app on their devices and access it offline. This schematic configures your project for PWA functionality, adding a service worker, a web app manifest, and other necessary features.", "properties": { "project": { "type": "string", - "description": "The name of the project.", + "description": "The name of the project to transform into a PWA. If not specified, the CLI will determine the project from the current directory.", "$default": { "$source": "projectName" } }, "target": { "type": "string", - "description": "The target to apply service worker to.", + "description": "The build target to apply the service worker to. This is typically `build`, indicating that the service worker should be generated during the standard build process.", "default": "build" }, "title": { "type": "string", - "description": "The title of the application." + "description": "The title of the application. This will be used in the web app manifest, which is a JSON file that provides metadata about your PWA (e.g., name, icons, display options)." } }, "required": [] diff --git a/packages/angular/ssr/schematics/ng-add/schema.json b/packages/angular/ssr/schematics/ng-add/schema.json index 7ae66a1165e8..f82d7373620b 100644 --- a/packages/angular/ssr/schematics/ng-add/schema.json +++ b/packages/angular/ssr/schematics/ng-add/schema.json @@ -3,21 +3,22 @@ "$id": "SchematicsAngularNgAddSSR", "title": "Angular SSR Options Schema", "type": "object", + "description": "Adds Server-Side Rendering (SSR) capabilities to an existing Angular application. SSR allows your app to be rendered on the server, leading to faster initial load times and improved SEO. This schematic modifies your project to enable SSR, sets up the necessary configurations, and installs the required dependencies.", "properties": { "project": { "type": "string", - "description": "The name of the project.", + "description": "The name of the project you want to enable SSR for. If not specified, the CLI will determine the project from the current directory.", "$default": { "$source": "projectName" } }, "skipInstall": { - "description": "Skip installing dependency packages.", + "description": "Skip the automatic installation of packages. You will need to manually install the dependencies later.", "type": "boolean", "default": false }, "serverRouting": { - "description": "Creates a server application using the Server Routing and App Engine APIs (Developer Preview).", + "description": "Configure the server application to use the Angular Server Routing API and App Engine APIs (currently in Developer Preview).", "type": "boolean" } }, diff --git a/packages/schematics/angular/app-shell/schema.json b/packages/schematics/angular/app-shell/schema.json index 9f4a1c1dcbc7..262fb3fa45b0 100644 --- a/packages/schematics/angular/app-shell/schema.json +++ b/packages/schematics/angular/app-shell/schema.json @@ -3,18 +3,18 @@ "$id": "SchematicsAngularAppShell", "title": "Angular AppShell Options Schema", "type": "object", - "description": "Generates an application shell for running a server-side version of an app.", + "description": "Configures your project to generate an app-shell during build time.", "additionalProperties": false, "properties": { "project": { "type": "string", - "description": "The name of the related client app.", + "description": "The name of the project where the app-shell should be generated.", "$default": { "$source": "projectName" } }, "serverRouting": { - "description": "Creates a server application using the Server Routing API (Developer Preview).", + "description": "Set up a server application using the Server Routing and App Engine APIs (Developer Preview).", "type": "boolean", "default": false } diff --git a/packages/schematics/angular/application/schema.json b/packages/schematics/angular/application/schema.json index 7a0ccd24dc93..b7d8e382aad2 100644 --- a/packages/schematics/angular/application/schema.json +++ b/packages/schematics/angular/application/schema.json @@ -3,15 +3,15 @@ "$id": "SchematicsAngularApp", "title": "Angular Application Options Schema", "type": "object", - "description": "Generates a new basic application definition in the \"projects\" subfolder of the workspace.", + "description": "Generates a new Angular application within your workspace. This schematic sets up the foundational structure of your project, including the root component, module, and configuration files. You can customize various aspects of the application, such as routing, styling, and testing.", "additionalProperties": false, "properties": { "projectRoot": { - "description": "The root directory of the new application.", + "description": "The directory where the new application's files will be created, relative to the workspace root. If not specified, the application will be created in a subfolder within the `projects` directory, using the application's name.", "type": "string" }, "name": { - "description": "The name of the new application.", + "description": "The name for the new application. This name will be used for the project directory and various identifiers throughout the application's code.", "type": "string", "pattern": "^(?:@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*/)?[a-zA-Z0-9-~][a-zA-Z0-9-._~]*$", "$default": { @@ -21,37 +21,37 @@ "x-prompt": "What name would you like to use for the application?" }, "inlineStyle": { - "description": "Include styles inline in the root component.ts file. Only CSS styles can be included inline. Default is false, meaning that an external styles file is created and referenced in the root component.ts file.", + "description": "Include the styles for the root component directly within the `app.component.ts` file. Only CSS styles can be included inline. By default, a separate stylesheet file (e.g., `app.component.css`) is created.", "type": "boolean", "alias": "s", "x-user-analytics": "ep.ng_inline_style" }, "inlineTemplate": { - "description": "Include template inline in the root component.ts file. Default is false, meaning that an external template file is created and referenced in the root component.ts file. ", + "description": "Include the HTML template for the root component directly within the `app.component.ts` file. By default, a separate template file (e.g., `app.component.html`) is created.", "type": "boolean", "alias": "t", "x-user-analytics": "ep.ng_inline_template" }, "viewEncapsulation": { - "description": "The view encapsulation strategy to use in the new application.", + "description": "Sets the view encapsulation mode for the application's components. This determines how component styles are scoped and applied.", "enum": ["Emulated", "None", "ShadowDom"], "type": "string" }, "routing": { "type": "boolean", - "description": "Creates an application with routing enabled.", + "description": "Generate an application with routing already configured. This sets up the necessary files and modules for managing navigation between different views in your application.", "default": true, "x-user-analytics": "ep.ng_routing" }, "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 application. For example, if the prefix is `my-app` and you generate a component named `my-component`, the selector will be `my-app-my-component`.", "default": "app", "alias": "p" }, "style": { - "description": "The file extension or preprocessor to use for style files.", + "description": "The type of stylesheet files to be created for components in the application.", "type": "string", "default": "css", "enum": ["css", "scss", "sass", "less"], @@ -80,7 +80,7 @@ "x-user-analytics": "ep.ng_style" }, "skipTests": { - "description": "Do not create \"spec.ts\" test files for the application.", + "description": "Skip the generation of a unit test files `spec.ts`.", "type": "boolean", "default": false, "alias": "S" @@ -88,42 +88,42 @@ "skipPackageJson": { "type": "boolean", "default": false, - "description": "Do not add dependencies to the \"package.json\" file." + "description": "Do not add dependencies to the `package.json` file." }, "minimal": { - "description": "Create a bare-bones project without any testing frameworks. (Use for learning purposes only.)", + "description": "Generate a minimal project without any testing frameworks. This is intended for learning purposes and simple experimentation, not for production applications.", "type": "boolean", "default": false }, "skipInstall": { - "description": "Skip installing dependency packages.", + "description": "Skip the automatic installation of packages. You will need to manually install the dependencies later.", "type": "boolean", "default": false }, "strict": { - "description": "Creates an application with stricter bundle budgets settings.", + "description": "Enable stricter bundle budget settings for the application. This helps to keep your application's bundle size small and improve performance. For more information, see https://angular.dev/tools/cli/template-typecheck#strict-mode", "type": "boolean", "default": true }, "standalone": { - "description": "Creates an application based upon the standalone API, without NgModules.", + "description": "Create an application that utilizes the standalone API, eliminating the need for NgModules. This can simplify the structure of your application.", "type": "boolean", "default": true, "x-user-analytics": "ep.ng_standalone" }, "ssr": { - "description": "Creates an application with Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) enabled.", + "description": "Configure the application for Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering).", "x-prompt": "Do you want to enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering)?", "type": "boolean", "default": false, "x-user-analytics": "ep.ng_ssr" }, "serverRouting": { - "description": "Creates a server application using the Server Routing and App Engine APIs (Developer Preview).", + "description": "Set up a server application using the Server Routing and App Engine APIs (Developer Preview).", "type": "boolean" }, "experimentalZoneless": { - "description": "Create an application that does not utilize zone.js.", + "description": "Generate an application that does not use `zone.js`.", "type": "boolean", "default": false } diff --git a/packages/schematics/angular/class/schema.json b/packages/schematics/angular/class/schema.json index f56137e84944..93bf45225265 100644 --- a/packages/schematics/angular/class/schema.json +++ b/packages/schematics/angular/class/schema.json @@ -3,12 +3,12 @@ "$id": "SchematicsAngularClass", "title": "Angular Class Options Schema", "type": "object", - "description": "Creates a new, generic class definition in the given project.", + "description": "Creates a new class in your project. Classes are the fundamental building blocks for object-oriented programming in TypeScript. They provide a blueprint for creating objects with properties and methods. This schematic helps you generate a new class with the basic structure and optional test files.", "additionalProperties": false, "properties": { "name": { "type": "string", - "description": "The name of the new class.", + "description": "The name for the new class. This will be used to create the class file (e.g., `my-class.ts`) and, if enabled, the corresponding test file `my-class.spec.ts`.", "$default": { "$source": "argv", "index": 0 @@ -21,24 +21,24 @@ "$default": { "$source": "workingDirectory" }, - "description": "The path at which to create the class, relative to the workspace root.", + "description": "The path where the class file should be created, relative to the workspace root. If not specified, the class 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 class should be added. If not specified, the CLI will determine the project from the current directory.", "$default": { "$source": "projectName" } }, "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 class.", "default": false }, "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 class names. For example, if you set the type to `helper`, the filename will be `my-class.helper.ts`." } }, "required": ["name", "project"] diff --git a/packages/schematics/angular/component/schema.json b/packages/schematics/angular/component/schema.json index 9b95d4f1b8f3..101c19c75b64 100644 --- a/packages/schematics/angular/component/schema.json +++ b/packages/schematics/angular/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"] diff --git a/packages/schematics/angular/config/schema.json b/packages/schematics/angular/config/schema.json index 87cb32851223..14bb34f07260 100644 --- a/packages/schematics/angular/config/schema.json +++ b/packages/schematics/angular/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": { diff --git a/packages/schematics/angular/directive/schema.json b/packages/schematics/angular/directive/schema.json index a5664d79c1ca..753c520774ee 100644 --- a/packages/schematics/angular/directive/schema.json +++ b/packages/schematics/angular/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"] diff --git a/packages/schematics/angular/enum/schema.json b/packages/schematics/angular/enum/schema.json index 41948b8801bd..ae6b17f457bd 100644 --- a/packages/schematics/angular/enum/schema.json +++ b/packages/schematics/angular/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"] diff --git a/packages/schematics/angular/environments/schema.json b/packages/schematics/angular/environments/schema.json index 6aea81664e04..599373861cb5 100644 --- a/packages/schematics/angular/environments/schema.json +++ b/packages/schematics/angular/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" } diff --git a/packages/schematics/angular/guard/schema.json b/packages/schematics/angular/guard/schema.json index 371347a513ba..0f6952c459f6 100644 --- a/packages/schematics/angular/guard/schema.json +++ b/packages/schematics/angular/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": { diff --git a/packages/schematics/angular/interceptor/schema.json b/packages/schematics/angular/interceptor/schema.json index 67c3b8e70a50..ff072a5557d2 100755 --- a/packages/schematics/angular/interceptor/schema.json +++ b/packages/schematics/angular/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 } }, diff --git a/packages/schematics/angular/interface/schema.json b/packages/schematics/angular/interface/schema.json index 410749fcb89e..ab47d1713ab4 100644 --- a/packages/schematics/angular/interface/schema.json +++ b/packages/schematics/angular/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 diff --git a/packages/schematics/angular/library/schema.json b/packages/schematics/angular/library/schema.json index d2b1ff037279..62ffdbb422a0 100644 --- a/packages/schematics/angular/library/schema.json +++ b/packages/schematics/angular/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" diff --git a/packages/schematics/angular/ng-new/schema.json b/packages/schematics/angular/ng-new/schema.json index 870460ae8817..5b214c73b141 100644 --- a/packages/schematics/angular/ng-new/schema.json +++ b/packages/schematics/angular/ng-new/schema.json @@ -3,15 +3,15 @@ "$id": "SchematicsAngularNgNew", "title": "Angular Ng New Options Schema", "type": "object", - "description": "Creates a new project by combining the workspace and application schematics.", + "description": "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.", "additionalProperties": false, "properties": { "directory": { "type": "string", - "description": "The directory name to create the workspace in." + "description": "The directory where the new workspace and project should be created. If not specified, the workspace will be created in the current directory." }, "name": { - "description": "The name of the new workspace and initial project.", + "description": "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.", "type": "string", "$default": { "$source": "argv", @@ -20,18 +20,18 @@ "x-prompt": "What name would you like to use for the new workspace and initial project?" }, "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 }, "skipGit": { - "description": "Do not initialize a git repository.", + "description": "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.", "type": "boolean", "default": false, "alias": "g" }, "commit": { - "description": "Initial git repository commit information.", + "description": "Configure the initial Git commit for the new repository.", "oneOf": [ { "type": "boolean" }, { @@ -54,24 +54,24 @@ "default": true }, "newProjectRoot": { - "description": "The path where new projects will be created, relative to the new workspace root.", + "description": "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.", "type": "string", "default": "projects" }, "inlineStyle": { - "description": "Include styles inline in the component TS file. By default, an external styles file is created and referenced in the component TypeScript file.", + "description": "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.", "type": "boolean", "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 TypeScript file.", + "description": "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.", "type": "boolean", "alias": "t", "x-user-analytics": "ep.ng_inline_template" }, "viewEncapsulation": { - "description": "The view encapsulation strategy to use in the initial project.", + "description": "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).", "enum": ["Emulated", "None", "ShadowDom"], "type": "string" }, @@ -85,41 +85,41 @@ }, "routing": { "type": "boolean", - "description": "Enable routing in the initial project.", + "description": "Enable routing in the initial application project. This sets up the necessary files and modules for managing navigation between different views in your application.", "x-user-analytics": "ep.ng_routing" }, "prefix": { "type": "string", "format": "html-selector", - "description": "The prefix to apply to generated selectors for the initial project.", + "description": "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`.", "minLength": 1, "default": "app", "alias": "p" }, "style": { - "description": "The file extension or preprocessor to use for style files.", + "description": "The type of stylesheet files to be created for components in the initial project.", "type": "string", "enum": ["css", "scss", "sass", "less"], "x-user-analytics": "ep.ng_style" }, "skipTests": { - "description": "Do not generate \"spec.ts\" test files for the new project.", + "description": "Skip the generation of unit test files `spec.ts`.", "type": "boolean", "default": false, "alias": "S" }, "createApplication": { - "description": "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.", + "description": "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.", "type": "boolean", "default": true }, "minimal": { - "description": "Create a workspace without any testing frameworks. (Use for learning purposes only.)", + "description": "Generate a minimal Angular workspace without any testing frameworks. This is intended for learning purposes and simple experimentation, not for production applications.", "type": "boolean", "default": false }, "strict": { - "description": "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", + "description": "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", "type": "boolean", "default": true }, @@ -135,16 +135,16 @@ "x-user-analytics": "ep.ng_standalone" }, "ssr": { - "description": "Creates an application with Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) enabled.", + "description": "Configure the initial application for Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering).", "type": "boolean", "x-user-analytics": "ep.ng_ssr" }, "serverRouting": { - "description": "Creates a server application using the Server Routing and App Engine APIs (Developer Preview).", + "description": "Create a server application in the initial project using the Server Routing and App Engine APIs (Developer Preview).", "type": "boolean" }, "experimentalZoneless": { - "description": "Create an application that does not utilize zone.js.", + "description": "Create an initial application that does not utilize `zone.js`.", "type": "boolean", "default": false } diff --git a/packages/schematics/angular/pipe/schema.json b/packages/schematics/angular/pipe/schema.json index ce9ba2699b7f..62dc7fa217b4 100644 --- a/packages/schematics/angular/pipe/schema.json +++ b/packages/schematics/angular/pipe/schema.json @@ -4,11 +4,11 @@ "title": "Angular Pipe Options Schema", "type": "object", "additionalProperties": false, - "description": "Creates a new, generic pipe definition in the given project.", + "description": "Creates a new pipe in your project. Pipes are used to transform data for display in templates. They take input values and apply a specific transformation, such as formatting dates, currency, or filtering arrays. This schematic generates the necessary files and boilerplate code for a new pipe.", "properties": { "name": { "type": "string", - "description": "The name of the pipe.", + "description": "The name for the new pipe. This will be used to create the pipe's class and spec files (e.g., `my-pipe.pipe.ts` and `my-pipe.pipe.spec.ts`).", "$default": { "$source": "argv", "index": 0 @@ -21,12 +21,12 @@ "$default": { "$source": "workingDirectory" }, - "description": "The path at which to create the pipe, relative to the workspace root.", + "description": "The path where the pipe files should be created, relative to the workspace root. If not provided, the pipe 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 pipe should be created. If not specified, the CLI will determine the project from the current directory.", "$default": { "$source": "projectName" } @@ -34,33 +34,33 @@ "flat": { "type": "boolean", "default": true, - "description": "When true (the default) creates files at the top level of the project." + "description": "Creates the new pipe files at the top level of the current project. If set to false, a new folder with the pipe's name will be created to contain the files." }, "skipTests": { "type": "boolean", - "description": "Do not create \"spec.ts\" test files for the new pipe.", + "description": "Prevent the generation of a unit test file `spec.ts` for the new pipe.", "default": false }, "skipImport": { "type": "boolean", "default": false, - "description": "Do not import this pipe into the owning NgModule." + "description": "Do not automatically import the new pipe into its closest NgModule." }, "standalone": { - "description": "Whether the generated pipe is standalone.", + "description": "Generate a standalone pipe. Standalone pipes 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, directives, or pipes.", "type": "boolean", "default": true, "x-user-analytics": "ep.ng_standalone" }, "module": { "type": "string", - "description": "The declaring NgModule.", + "description": "Specify the NgModule where the pipe should be declared. If not provided, the CLI will attempt to find the closest NgModule in the pipe's path.", "alias": "m" }, "export": { "type": "boolean", "default": false, - "description": "The declaring NgModule exports this pipe." + "description": "Automatically export the pipe from the specified NgModule, making it accessible to other modules in the application." } }, "required": ["name", "project"] diff --git a/packages/schematics/angular/resolver/schema.json b/packages/schematics/angular/resolver/schema.json index aa0d5016796b..a364e9271397 100644 --- a/packages/schematics/angular/resolver/schema.json +++ b/packages/schematics/angular/resolver/schema.json @@ -1,14 +1,14 @@ { "$schema": "http://json-schema.org/draft-07/schema", "$id": "SchematicsAngularResolver", - "title": "Angular resolver Options Schema", + "title": "Angular Resolver Options Schema", "type": "object", "additionalProperties": false, - "description": "Generates a new, generic resolver definition in the given project.", + "description": "Creates a new resolver in your project. Resolvers are used to pre-fetch data before a route is activated, ensuring that the necessary data is available before the component is displayed. This can improve the user experience by preventing delays and loading states. This schematic generates a new resolver with the specified name and options.", "properties": { "name": { "type": "string", - "description": "The name of the new resolver.", + "description": "The name for the new resolver. This will be used to create the resolver's class and spec files (e.g., `my-resolver.resolver.ts` and `my-resolver.resolver.spec.ts`).", "$default": { "$source": "argv", "index": 0 @@ -17,17 +17,17 @@ }, "skipTests": { "type": "boolean", - "description": "Do not create \"spec.ts\" test files for the new resolver.", + "description": "Skip the generation of a unit test file `spec.ts` for the new resolver.", "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 resolver files at the top level of the current project. If set to false, a new folder with the resolver's name will be created to contain the files.", "default": true }, "functional": { "type": "boolean", - "description": "Creates the resolver as a `ResolveFn`.", + "description": "Creates the resolver as a function `ResolveFn` instead of a class. Functional resolvers can be simpler for basic scenarios.", "default": true }, "path": { @@ -36,12 +36,12 @@ "$default": { "$source": "workingDirectory" }, - "description": "The path at which to create the interface that defines the resolver, relative to the current workspace.", + "description": "The path where the resolver files should be created, relative to the current workspace. If not provided, the resolver 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 resolver should be created. If not specified, the CLI will determine the project from the current directory.", "$default": { "$source": "projectName" } diff --git a/packages/schematics/angular/server/schema.json b/packages/schematics/angular/server/schema.json index ca5ad0e6fdc4..bad36a9ee36a 100644 --- a/packages/schematics/angular/server/schema.json +++ b/packages/schematics/angular/server/schema.json @@ -4,22 +4,22 @@ "title": "Angular Server App Options Schema", "type": "object", "additionalProperties": false, - "description": "Pass this schematic to the \"run\" command to set up server-side rendering for an app.", + "description": "Sets up server-side rendering (SSR) for your Angular application. SSR allows your app to be rendered on the server, improving initial load performance and SEO. This schematic configures your project for SSR and generates the necessary files.", "properties": { "project": { "type": "string", - "description": "The name of the project.", + "description": "The name of the project to enable server-side rendering for.", "$default": { "$source": "projectName" } }, "skipInstall": { - "description": "Do not install packages for dependencies.", + "description": "Skip the automatic installation of packages. You will need to manually install the dependencies later.", "type": "boolean", "default": false }, "serverRouting": { - "description": "Creates a server application using the Server Routing and App Engine APIs (Developer Preview).", + "description": "Configure the server application to use the Server Routing and App Engine APIs (Developer Preview).", "type": "boolean" } }, diff --git a/packages/schematics/angular/service-worker/schema.json b/packages/schematics/angular/service-worker/schema.json index af19ad3384fe..8eba57a14432 100644 --- a/packages/schematics/angular/service-worker/schema.json +++ b/packages/schematics/angular/service-worker/schema.json @@ -4,18 +4,18 @@ "title": "Angular Service Worker Options Schema", "type": "object", "additionalProperties": false, - "description": "Pass this schematic to the \"run\" command to create a service worker", + "description": "Adds a service worker to your project. Service workers enable your application to work offline or on low-quality networks by caching assets and intercepting network requests. This schematic configures your project to use a service worker.", "properties": { "project": { "type": "string", - "description": "The name of the project.", + "description": "The name of the project to add the service worker to. If not specified, the CLI will determine the project from the current directory.", "$default": { "$source": "projectName" } }, "target": { "type": "string", - "description": "The target to apply service worker to.", + "description": "The build target to apply the service worker to. This is typically `build`, indicating that the service worker should be generated during the standard build process.", "default": "build" } }, diff --git a/packages/schematics/angular/service/schema.json b/packages/schematics/angular/service/schema.json index bd04386e6280..d5a4d0418acd 100644 --- a/packages/schematics/angular/service/schema.json +++ b/packages/schematics/angular/service/schema.json @@ -4,11 +4,11 @@ "title": "Angular Service Options Schema", "type": "object", "additionalProperties": false, - "description": "Creates a new, generic service definition in the given project.", + "description": "Creates a new service in your project. Services are used to encapsulate reusable logic, such as data access, API calls, or utility functions. This schematic simplifies the process of generating a new service with the necessary files and boilerplate code.", "properties": { "name": { "type": "string", - "description": "The name of the service.", + "description": "The name for the new service. This will be used to create the service's class and spec files (e.g., `my-service.service.ts` and `my-service.service.spec.ts`).", "$default": { "$source": "argv", "index": 0 @@ -20,12 +20,12 @@ "$default": { "$source": "workingDirectory" }, - "description": "The path at which to create the service, relative to the workspace root.", + "description": "The path where the service files should be created, relative to the workspace root. If not provided, the service 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 service should be added. If not specified, the CLI will determine the project from the current directory.", "$default": { "$source": "projectName" } @@ -33,11 +33,11 @@ "flat": { "type": "boolean", "default": true, - "description": "When true (the default), creates files at the top level of the project." + "description": "Creates files at the top level of the project or the given path. If set to false, a new folder with the service's name will be created to contain the files." }, "skipTests": { "type": "boolean", - "description": "Do not create \"spec.ts\" test files for the new service.", + "description": "Skip the generation of a unit test file `spec.ts` for the service.", "default": false } }, diff --git a/packages/schematics/angular/ssr/schema.json b/packages/schematics/angular/ssr/schema.json index 788ad7fec3d4..669f1449ad13 100644 --- a/packages/schematics/angular/ssr/schema.json +++ b/packages/schematics/angular/ssr/schema.json @@ -3,21 +3,22 @@ "$id": "SchematicsAngularSSR", "title": "Angular SSR Options Schema", "type": "object", + "description": "Enables Server-Side Rendering (SSR) for your Angular application. SSR allows your app to be rendered on the server, which can significantly improve its initial load performance and Search Engine Optimization (SEO). This schematic configures your project for SSR, generating the necessary files and making the required modifications to your project's structure.", "properties": { "project": { "type": "string", - "description": "The name of the project.", + "description": "The name of the project you want to enable SSR for.", "$default": { "$source": "projectName" } }, "skipInstall": { - "description": "Skip installing dependency packages.", + "description": "Skip the automatic installation of packages. You will need to manually install the dependencies later.", "type": "boolean", "default": false }, "serverRouting": { - "description": "Creates a server application using the Server Routing and App Engine APIs (Developer Preview).", + "description": "Configure the server application to use the Angular Server Routing API and App Engine APIs (currently in Developer Preview).", "type": "boolean" } }, diff --git a/packages/schematics/angular/web-worker/schema.json b/packages/schematics/angular/web-worker/schema.json index 2e00bcbf225b..e2b5977d21cf 100644 --- a/packages/schematics/angular/web-worker/schema.json +++ b/packages/schematics/angular/web-worker/schema.json @@ -4,7 +4,7 @@ "title": "Angular Web Worker Options Schema", "type": "object", "additionalProperties": false, - "description": "Creates a new, generic web worker definition in the given project.", + "description": "Creates a new web worker in your project. Web workers allow you to run JavaScript code in the background, improving the performance and responsiveness of your application by offloading computationally intensive tasks. This schematic generates the necessary files for a new web worker and provides an optional code snippet to demonstrate its usage.", "properties": { "path": { "type": "string", @@ -12,19 +12,19 @@ "$default": { "$source": "workingDirectory" }, - "description": "The path at which to create the worker file, relative to the current workspace.", + "description": "The path where the web worker file should be created, relative to the current workspace. If not specified, the worker 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 web worker should be created. If not specified, the CLI will determine the project from the current directory.", "$default": { "$source": "projectName" } }, "name": { "type": "string", - "description": "The name of the worker.", + "description": "The name for the new web worker. This will be used to create the worker file (e.g., `my-worker.worker.ts`).", "$default": { "$source": "argv", "index": 0 @@ -34,7 +34,7 @@ "snippet": { "type": "boolean", "default": true, - "description": "Add a worker creation snippet in a sibling file of the same name." + "description": "Generate a code snippet that demonstrates how to create and use the new web worker." } }, "required": ["name", "project"] diff --git a/packages/schematics/angular/workspace/schema.json b/packages/schematics/angular/workspace/schema.json index 0b4240fe05cb..cd09b5d870c0 100644 --- a/packages/schematics/angular/workspace/schema.json +++ b/packages/schematics/angular/workspace/schema.json @@ -2,12 +2,12 @@ "$schema": "http://json-schema.org/draft-07/schema", "$id": "SchematicsAngularWorkspace", "title": "Angular Workspace Options Schema", - "description": "Initializes an empty workspace and adds the necessary dependencies required by an Angular application.", + "description": "Creates a new Angular workspace. A workspace provides a structured environment for developing multiple projects, allowing you to manage dependencies, configurations, and build processes for a collection of applications and libraries. This schematic sets up the basic structure of the workspace and installs the necessary Angular dependencies.", "type": "object", "additionalProperties": false, "properties": { "name": { - "description": "The name of the workspace.", + "description": "The name for the new workspace. This name will be used for the root directory and will be referenced in various configuration files.", "type": "string", "$default": { "$source": "argv", @@ -15,7 +15,7 @@ } }, "newProjectRoot": { - "description": "The path where new projects will be created.", + "description": "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.", "type": "string", "visible": "false" }, @@ -28,17 +28,17 @@ } }, "minimal": { - "description": "Create a workspace without any testing frameworks. (Use for learning purposes only.)", + "description": "Create a workspace without any testing frameworks. This is intended for learning purposes and simple experimentation, not for production applications.", "type": "boolean", "default": false }, "strict": { - "description": "Create a workspace with stricter type checking options. This setting helps improve maintainability and catch bugs ahead of time. For more information, see https://angular.dev/tools/cli/template-typecheck#strict-mode", + "description": "Enable stricter type checking and bundle budget settings for projects created within the workspace. This helps improve maintainability and catch bugs early on. For more information, see https://angular.dev/tools/cli/template-typecheck#strict-mode", "type": "boolean", "default": true }, "packageManager": { - "description": "The package manager used to install dependencies.", + "description": "The package manager to use for installing dependencies.", "type": "string", "enum": ["npm", "yarn", "pnpm", "cnpm", "bun"] }