|
3 | 3 | "$id": "SchematicsAngularApp", |
4 | 4 | "title": "Angular Application Options Schema", |
5 | 5 | "type": "object", |
6 | | - "description": "Generates a new basic application definition in the \"projects\" subfolder of the workspace.", |
| 6 | + "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.", |
7 | 7 | "additionalProperties": false, |
8 | 8 | "properties": { |
9 | 9 | "projectRoot": { |
10 | | - "description": "The root directory of the new application.", |
| 10 | + "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.", |
11 | 11 | "type": "string" |
12 | 12 | }, |
13 | 13 | "name": { |
14 | | - "description": "The name of the new application.", |
| 14 | + "description": "The name for the new application. This name will be used for the project directory and various identifiers throughout the application's code.", |
15 | 15 | "type": "string", |
16 | 16 | "pattern": "^(?:@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*/)?[a-zA-Z0-9-~][a-zA-Z0-9-._~]*$", |
17 | 17 | "$default": { |
|
21 | 21 | "x-prompt": "What name would you like to use for the application?" |
22 | 22 | }, |
23 | 23 | "inlineStyle": { |
24 | | - "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.", |
| 24 | + "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.", |
25 | 25 | "type": "boolean", |
26 | 26 | "alias": "s", |
27 | 27 | "x-user-analytics": "ep.ng_inline_style" |
28 | 28 | }, |
29 | 29 | "inlineTemplate": { |
30 | | - "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. ", |
| 30 | + "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.", |
31 | 31 | "type": "boolean", |
32 | 32 | "alias": "t", |
33 | 33 | "x-user-analytics": "ep.ng_inline_template" |
34 | 34 | }, |
35 | 35 | "viewEncapsulation": { |
36 | | - "description": "The view encapsulation strategy to use in the new application.", |
| 36 | + "description": "Sets the view encapsulation mode for the application's components. This determines how component styles are scoped and applied.", |
37 | 37 | "enum": ["Emulated", "None", "ShadowDom"], |
38 | 38 | "type": "string" |
39 | 39 | }, |
40 | 40 | "routing": { |
41 | 41 | "type": "boolean", |
42 | | - "description": "Creates an application with routing enabled.", |
| 42 | + "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.", |
43 | 43 | "default": true, |
44 | 44 | "x-user-analytics": "ep.ng_routing" |
45 | 45 | }, |
46 | 46 | "prefix": { |
47 | 47 | "type": "string", |
48 | 48 | "format": "html-selector", |
49 | | - "description": "A prefix to apply to generated selectors.", |
| 49 | + "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`.", |
50 | 50 | "default": "app", |
51 | 51 | "alias": "p" |
52 | 52 | }, |
53 | 53 | "style": { |
54 | | - "description": "The file extension or preprocessor to use for style files.", |
| 54 | + "description": "The type of stylesheet files to be created for components in the application.", |
55 | 55 | "type": "string", |
56 | 56 | "default": "css", |
57 | 57 | "enum": ["css", "scss", "sass", "less"], |
|
80 | 80 | "x-user-analytics": "ep.ng_style" |
81 | 81 | }, |
82 | 82 | "skipTests": { |
83 | | - "description": "Do not create \"spec.ts\" test files for the application.", |
| 83 | + "description": "Skip the generation of a unit test files `spec.ts`.", |
84 | 84 | "type": "boolean", |
85 | 85 | "default": false, |
86 | 86 | "alias": "S" |
87 | 87 | }, |
88 | 88 | "skipPackageJson": { |
89 | 89 | "type": "boolean", |
90 | 90 | "default": false, |
91 | | - "description": "Do not add dependencies to the \"package.json\" file." |
| 91 | + "description": "Do not add dependencies to the `package.json` file." |
92 | 92 | }, |
93 | 93 | "minimal": { |
94 | | - "description": "Create a bare-bones project without any testing frameworks. (Use for learning purposes only.)", |
| 94 | + "description": "Generate a minimal project without any testing frameworks. This is intended for learning purposes and simple experimentation, not for production applications.", |
95 | 95 | "type": "boolean", |
96 | 96 | "default": false |
97 | 97 | }, |
98 | 98 | "skipInstall": { |
99 | | - "description": "Skip installing dependency packages.", |
| 99 | + "description": "Skip the automatic installation of packages. You will need to manually install the dependencies later.", |
100 | 100 | "type": "boolean", |
101 | 101 | "default": false |
102 | 102 | }, |
103 | 103 | "strict": { |
104 | | - "description": "Creates an application with stricter bundle budgets settings.", |
| 104 | + "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", |
105 | 105 | "type": "boolean", |
106 | 106 | "default": true |
107 | 107 | }, |
108 | 108 | "standalone": { |
109 | | - "description": "Creates an application based upon the standalone API, without NgModules.", |
| 109 | + "description": "Create an application that utilizes the standalone API, eliminating the need for NgModules. This can simplify the structure of your application.", |
110 | 110 | "type": "boolean", |
111 | 111 | "default": true, |
112 | 112 | "x-user-analytics": "ep.ng_standalone" |
113 | 113 | }, |
114 | 114 | "ssr": { |
115 | | - "description": "Creates an application with Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) enabled.", |
| 115 | + "description": "Configure the application for Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering).", |
116 | 116 | "x-prompt": "Do you want to enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering)?", |
117 | 117 | "type": "boolean", |
118 | 118 | "default": false, |
119 | 119 | "x-user-analytics": "ep.ng_ssr" |
120 | 120 | }, |
121 | 121 | "serverRouting": { |
122 | | - "description": "Creates a server application using the Server Routing and App Engine APIs (Developer Preview).", |
| 122 | + "description": "Set up a server application using the Server Routing and App Engine APIs (Developer Preview).", |
123 | 123 | "type": "boolean" |
124 | 124 | }, |
125 | 125 | "experimentalZoneless": { |
126 | | - "description": "Create an application that does not utilize zone.js.", |
| 126 | + "description": "Generate an application that does not use `zone.js`.", |
127 | 127 | "type": "boolean", |
128 | 128 | "default": false |
129 | 129 | } |
|
0 commit comments