@schematics/angular 19.1.0-rc.0 → 19.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/app-shell/schema.d.ts +4 -3
  2. package/app-shell/schema.json +3 -3
  3. package/application/schema.d.ts +40 -25
  4. package/application/schema.js +3 -2
  5. package/application/schema.json +18 -18
  6. package/class/schema.d.ts +13 -6
  7. package/class/schema.json +6 -6
  8. package/component/schema.d.ts +47 -29
  9. package/component/schema.js +5 -4
  10. package/component/schema.json +21 -21
  11. package/config/schema.d.ts +6 -4
  12. package/config/schema.js +1 -1
  13. package/config/schema.json +3 -3
  14. package/directive/schema.d.ts +25 -13
  15. package/directive/schema.json +12 -12
  16. package/enum/schema.d.ts +11 -6
  17. package/enum/schema.json +5 -5
  18. package/environments/schema.d.ts +5 -2
  19. package/environments/schema.json +2 -2
  20. package/guard/schema.d.ts +18 -9
  21. package/guard/schema.json +8 -8
  22. package/interceptor/schema.d.ts +16 -7
  23. package/interceptor/schema.json +7 -7
  24. package/interface/schema.d.ts +14 -6
  25. package/interface/schema.json +6 -6
  26. package/library/schema.d.ts +22 -10
  27. package/library/schema.json +9 -9
  28. package/ng-new/schema.d.ts +51 -31
  29. package/ng-new/schema.js +5 -2
  30. package/ng-new/schema.json +20 -20
  31. package/package.json +3 -3
  32. package/pipe/schema.d.ts +21 -10
  33. package/pipe/schema.json +10 -10
  34. package/resolver/schema.d.ts +15 -8
  35. package/resolver/schema.json +8 -8
  36. package/server/schema.d.ts +7 -4
  37. package/server/schema.json +4 -4
  38. package/service/schema.d.ts +12 -6
  39. package/service/schema.json +6 -6
  40. package/service-worker/schema.d.ts +7 -3
  41. package/service-worker/schema.json +3 -3
  42. package/ssr/schema.d.ts +12 -4
  43. package/ssr/schema.json +4 -3
  44. package/utility/latest-versions/package.json +2 -2
  45. package/utility/latest-versions.js +3 -3
  46. package/web-worker/schema.d.ts +11 -5
  47. package/web-worker/schema.json +5 -5
  48. package/workspace/schema.d.ts +15 -10
  49. package/workspace/schema.js +1 -1
  50. package/workspace/schema.json +6 -6
@@ -3,15 +3,15 @@
3
3
  "$id": "SchematicsAngularNgNew",
4
4
  "title": "Angular Ng New Options Schema",
5
5
  "type": "object",
6
- "description": "Creates a new project by combining the workspace and application schematics.",
6
+ "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.",
7
7
  "additionalProperties": false,
8
8
  "properties": {
9
9
  "directory": {
10
10
  "type": "string",
11
- "description": "The directory name to create the workspace in."
11
+ "description": "The directory where the new workspace and project should be created. If not specified, the workspace will be created in the current directory."
12
12
  },
13
13
  "name": {
14
- "description": "The name of the new workspace and initial project.",
14
+ "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.",
15
15
  "type": "string",
16
16
  "$default": {
17
17
  "$source": "argv",
@@ -20,18 +20,18 @@
20
20
  "x-prompt": "What name would you like to use for the new workspace and initial project?"
21
21
  },
22
22
  "skipInstall": {
23
- "description": "Do not install dependency packages.",
23
+ "description": "Skip the automatic installation of packages. You will need to manually install the dependencies later.",
24
24
  "type": "boolean",
25
25
  "default": false
26
26
  },
27
27
  "skipGit": {
28
- "description": "Do not initialize a git repository.",
28
+ "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.",
29
29
  "type": "boolean",
30
30
  "default": false,
31
31
  "alias": "g"
32
32
  },
33
33
  "commit": {
34
- "description": "Initial git repository commit information.",
34
+ "description": "Configure the initial Git commit for the new repository.",
35
35
  "oneOf": [
36
36
  { "type": "boolean" },
37
37
  {
@@ -54,24 +54,24 @@
54
54
  "default": true
55
55
  },
56
56
  "newProjectRoot": {
57
- "description": "The path where new projects will be created, relative to the new workspace root.",
57
+ "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.",
58
58
  "type": "string",
59
59
  "default": "projects"
60
60
  },
61
61
  "inlineStyle": {
62
- "description": "Include styles inline in the component TS file. By default, an external styles file is created and referenced in the component TypeScript file.",
62
+ "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.",
63
63
  "type": "boolean",
64
64
  "alias": "s",
65
65
  "x-user-analytics": "ep.ng_inline_style"
66
66
  },
67
67
  "inlineTemplate": {
68
- "description": "Include template inline in the component TS file. By default, an external template file is created and referenced in the component TypeScript file.",
68
+ "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.",
69
69
  "type": "boolean",
70
70
  "alias": "t",
71
71
  "x-user-analytics": "ep.ng_inline_template"
72
72
  },
73
73
  "viewEncapsulation": {
74
- "description": "The view encapsulation strategy to use in the initial project.",
74
+ "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).",
75
75
  "enum": ["Emulated", "None", "ShadowDom"],
76
76
  "type": "string"
77
77
  },
@@ -85,41 +85,41 @@
85
85
  },
86
86
  "routing": {
87
87
  "type": "boolean",
88
- "description": "Enable routing in the initial project.",
88
+ "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.",
89
89
  "x-user-analytics": "ep.ng_routing"
90
90
  },
91
91
  "prefix": {
92
92
  "type": "string",
93
93
  "format": "html-selector",
94
- "description": "The prefix to apply to generated selectors for the initial project.",
94
+ "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`.",
95
95
  "minLength": 1,
96
96
  "default": "app",
97
97
  "alias": "p"
98
98
  },
99
99
  "style": {
100
- "description": "The file extension or preprocessor to use for style files.",
100
+ "description": "The type of stylesheet files to be created for components in the initial project.",
101
101
  "type": "string",
102
102
  "enum": ["css", "scss", "sass", "less"],
103
103
  "x-user-analytics": "ep.ng_style"
104
104
  },
105
105
  "skipTests": {
106
- "description": "Do not generate \"spec.ts\" test files for the new project.",
106
+ "description": "Skip the generation of unit test files `spec.ts`.",
107
107
  "type": "boolean",
108
108
  "default": false,
109
109
  "alias": "S"
110
110
  },
111
111
  "createApplication": {
112
- "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.",
112
+ "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.",
113
113
  "type": "boolean",
114
114
  "default": true
115
115
  },
116
116
  "minimal": {
117
- "description": "Create a workspace without any testing frameworks. (Use for learning purposes only.)",
117
+ "description": "Generate a minimal Angular workspace without any testing frameworks. This is intended for learning purposes and simple experimentation, not for production applications.",
118
118
  "type": "boolean",
119
119
  "default": false
120
120
  },
121
121
  "strict": {
122
- "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",
122
+ "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",
123
123
  "type": "boolean",
124
124
  "default": true
125
125
  },
@@ -135,16 +135,16 @@
135
135
  "x-user-analytics": "ep.ng_standalone"
136
136
  },
137
137
  "ssr": {
138
- "description": "Creates an application with Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) enabled.",
138
+ "description": "Configure the initial application for Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering).",
139
139
  "type": "boolean",
140
140
  "x-user-analytics": "ep.ng_ssr"
141
141
  },
142
142
  "serverRouting": {
143
- "description": "Creates a server application using the Server Routing and App Engine APIs (Developer Preview).",
143
+ "description": "Create a server application in the initial project using the Server Routing and App Engine APIs (Developer Preview).",
144
144
  "type": "boolean"
145
145
  },
146
146
  "experimentalZoneless": {
147
- "description": "Create an application that does not utilize zone.js.",
147
+ "description": "Create an initial application that does not utilize `zone.js`.",
148
148
  "type": "boolean",
149
149
  "default": false
150
150
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@schematics/angular",
3
- "version": "19.1.0-rc.0",
3
+ "version": "19.1.0",
4
4
  "description": "Schematics specific to Angular",
5
5
  "homepage": "https://github.com/angular/angular-cli",
6
6
  "keywords": [
@@ -22,8 +22,8 @@
22
22
  },
23
23
  "schematics": "./collection.json",
24
24
  "dependencies": {
25
- "@angular-devkit/core": "19.1.0-rc.0",
26
- "@angular-devkit/schematics": "19.1.0-rc.0",
25
+ "@angular-devkit/core": "19.1.0",
26
+ "@angular-devkit/schematics": "19.1.0",
27
27
  "jsonc-parser": "3.3.1"
28
28
  },
29
29
  "repository": {
package/pipe/schema.d.ts CHANGED
@@ -1,41 +1,52 @@
1
1
  /**
2
- * Creates a new, generic pipe definition in the given project.
2
+ * Creates a new pipe in your project. Pipes are used to transform data for display in
3
+ * templates. They take input values and apply a specific transformation, such as formatting
4
+ * dates, currency, or filtering arrays. This schematic generates the necessary files and
5
+ * boilerplate code for a new pipe.
3
6
  */
4
7
  export interface Schema {
5
8
  /**
6
- * The declaring NgModule exports this pipe.
9
+ * Automatically export the pipe from the specified NgModule, making it accessible to other
10
+ * modules in the application.
7
11
  */
8
12
  export?: boolean;
9
13
  /**
10
- * When true (the default) creates files at the top level of the project.
14
+ * Creates the new pipe files at the top level of the current project. If set to false, a
15
+ * new folder with the pipe's name will be created to contain the files.
11
16
  */
12
17
  flat?: boolean;
13
18
  /**
14
- * The declaring NgModule.
19
+ * Specify the NgModule where the pipe should be declared. If not provided, the CLI will
20
+ * attempt to find the closest NgModule in the pipe's path.
15
21
  */
16
22
  module?: string;
17
23
  /**
18
- * The name of the pipe.
24
+ * The name for the new pipe. This will be used to create the pipe's class and spec files
25
+ * (e.g., `my-pipe.pipe.ts` and `my-pipe.pipe.spec.ts`).
19
26
  */
20
27
  name: string;
21
28
  /**
22
- * The path at which to create the pipe, relative to the workspace root.
29
+ * The path where the pipe files should be created, relative to the workspace root. If not
30
+ * provided, the pipe will be created in the current directory.
23
31
  */
24
32
  path?: string;
25
33
  /**
26
- * The name of the project.
34
+ * The name of the project where the pipe should be created. If not specified, the CLI will
35
+ * determine the project from the current directory.
27
36
  */
28
37
  project: string;
29
38
  /**
30
- * Do not import this pipe into the owning NgModule.
39
+ * Do not automatically import the new pipe into its closest NgModule.
31
40
  */
32
41
  skipImport?: boolean;
33
42
  /**
34
- * Do not create "spec.ts" test files for the new pipe.
43
+ * Prevent the generation of a unit test file `spec.ts` for the new pipe.
35
44
  */
36
45
  skipTests?: boolean;
37
46
  /**
38
- * Whether the generated pipe is standalone.
47
+ * Generate a standalone pipe. Standalone pipes are self-contained and don't need to be
48
+ * declared in an NgModule. They can be used independently or imported directly into other
49
+ * standalone components, directives, or pipes.
39
50
  */
40
51
  standalone?: boolean;
41
52
  }
package/pipe/schema.json CHANGED
@@ -4,11 +4,11 @@
4
4
  "title": "Angular Pipe Options Schema",
5
5
  "type": "object",
6
6
  "additionalProperties": false,
7
- "description": "Creates a new, generic pipe definition in the given project.",
7
+ "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.",
8
8
  "properties": {
9
9
  "name": {
10
10
  "type": "string",
11
- "description": "The name of the pipe.",
11
+ "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`).",
12
12
  "$default": {
13
13
  "$source": "argv",
14
14
  "index": 0
@@ -21,12 +21,12 @@
21
21
  "$default": {
22
22
  "$source": "workingDirectory"
23
23
  },
24
- "description": "The path at which to create the pipe, relative to the workspace root.",
24
+ "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.",
25
25
  "visible": false
26
26
  },
27
27
  "project": {
28
28
  "type": "string",
29
- "description": "The name of the project.",
29
+ "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.",
30
30
  "$default": {
31
31
  "$source": "projectName"
32
32
  }
@@ -34,33 +34,33 @@
34
34
  "flat": {
35
35
  "type": "boolean",
36
36
  "default": true,
37
- "description": "When true (the default) creates files at the top level of the project."
37
+ "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."
38
38
  },
39
39
  "skipTests": {
40
40
  "type": "boolean",
41
- "description": "Do not create \"spec.ts\" test files for the new pipe.",
41
+ "description": "Prevent the generation of a unit test file `spec.ts` for the new pipe.",
42
42
  "default": false
43
43
  },
44
44
  "skipImport": {
45
45
  "type": "boolean",
46
46
  "default": false,
47
- "description": "Do not import this pipe into the owning NgModule."
47
+ "description": "Do not automatically import the new pipe into its closest NgModule."
48
48
  },
49
49
  "standalone": {
50
- "description": "Whether the generated pipe is standalone.",
50
+ "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.",
51
51
  "type": "boolean",
52
52
  "default": true,
53
53
  "x-user-analytics": "ep.ng_standalone"
54
54
  },
55
55
  "module": {
56
56
  "type": "string",
57
- "description": "The declaring NgModule.",
57
+ "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.",
58
58
  "alias": "m"
59
59
  },
60
60
  "export": {
61
61
  "type": "boolean",
62
62
  "default": false,
63
- "description": "The declaring NgModule exports this pipe."
63
+ "description": "Automatically export the pipe from the specified NgModule, making it accessible to other modules in the application."
64
64
  }
65
65
  },
66
66
  "required": ["name", "project"]
@@ -1,30 +1,37 @@
1
1
  /**
2
- * Generates a new, generic resolver definition in the given project.
2
+ * Creates a new resolver in your project. Resolvers are used to pre-fetch data before a
3
+ * route is activated, ensuring that the necessary data is available before the component is
4
+ * displayed. This can improve the user experience by preventing delays and loading states.
5
+ * This schematic generates a new resolver with the specified name and options.
3
6
  */
4
7
  export interface Schema {
5
8
  /**
6
- * When true (the default), creates the new files at the top level of the current project.
9
+ * Creates the new resolver files at the top level of the current project. If set to false,
10
+ * a new folder with the resolver's name will be created to contain the files.
7
11
  */
8
12
  flat?: boolean;
9
13
  /**
10
- * Creates the resolver as a `ResolveFn`.
14
+ * Creates the resolver as a function `ResolveFn` instead of a class. Functional resolvers
15
+ * can be simpler for basic scenarios.
11
16
  */
12
17
  functional?: boolean;
13
18
  /**
14
- * The name of the new resolver.
19
+ * The name for the new resolver. This will be used to create the resolver's class and spec
20
+ * files (e.g., `my-resolver.resolver.ts` and `my-resolver.resolver.spec.ts`).
15
21
  */
16
22
  name: string;
17
23
  /**
18
- * The path at which to create the interface that defines the resolver, relative to the
19
- * current workspace.
24
+ * The path where the resolver files should be created, relative to the current workspace.
25
+ * If not provided, the resolver will be created in the current directory.
20
26
  */
21
27
  path?: string;
22
28
  /**
23
- * The name of the project.
29
+ * The name of the project where the resolver should be created. If not specified, the CLI
30
+ * will determine the project from the current directory.
24
31
  */
25
32
  project: string;
26
33
  /**
27
- * Do not create "spec.ts" test files for the new resolver.
34
+ * Skip the generation of a unit test file `spec.ts` for the new resolver.
28
35
  */
29
36
  skipTests?: boolean;
30
37
  }
@@ -1,14 +1,14 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema",
3
3
  "$id": "SchematicsAngularResolver",
4
- "title": "Angular resolver Options Schema",
4
+ "title": "Angular Resolver Options Schema",
5
5
  "type": "object",
6
6
  "additionalProperties": false,
7
- "description": "Generates a new, generic resolver definition in the given project.",
7
+ "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.",
8
8
  "properties": {
9
9
  "name": {
10
10
  "type": "string",
11
- "description": "The name of the new resolver.",
11
+ "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`).",
12
12
  "$default": {
13
13
  "$source": "argv",
14
14
  "index": 0
@@ -17,17 +17,17 @@
17
17
  },
18
18
  "skipTests": {
19
19
  "type": "boolean",
20
- "description": "Do not create \"spec.ts\" test files for the new resolver.",
20
+ "description": "Skip the generation of a unit test file `spec.ts` for the new resolver.",
21
21
  "default": false
22
22
  },
23
23
  "flat": {
24
24
  "type": "boolean",
25
- "description": "When true (the default), creates the new files at the top level of the current project.",
25
+ "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.",
26
26
  "default": true
27
27
  },
28
28
  "functional": {
29
29
  "type": "boolean",
30
- "description": "Creates the resolver as a `ResolveFn`.",
30
+ "description": "Creates the resolver as a function `ResolveFn` instead of a class. Functional resolvers can be simpler for basic scenarios.",
31
31
  "default": true
32
32
  },
33
33
  "path": {
@@ -36,12 +36,12 @@
36
36
  "$default": {
37
37
  "$source": "workingDirectory"
38
38
  },
39
- "description": "The path at which to create the interface that defines the resolver, relative to the current workspace.",
39
+ "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.",
40
40
  "visible": false
41
41
  },
42
42
  "project": {
43
43
  "type": "string",
44
- "description": "The name of the project.",
44
+ "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.",
45
45
  "$default": {
46
46
  "$source": "projectName"
47
47
  }
@@ -1,18 +1,21 @@
1
1
  /**
2
- * Pass this schematic to the "run" command to set up server-side rendering for an app.
2
+ * Sets up server-side rendering (SSR) for your Angular application. SSR allows your app to
3
+ * be rendered on the server, improving initial load performance and SEO. This schematic
4
+ * configures your project for SSR and generates the necessary files.
3
5
  */
4
6
  export interface Schema {
5
7
  /**
6
- * The name of the project.
8
+ * The name of the project to enable server-side rendering for.
7
9
  */
8
10
  project: string;
9
11
  /**
10
- * Creates a server application using the Server Routing and App Engine APIs (Developer
12
+ * Configure the server application to use the Server Routing and App Engine APIs (Developer
11
13
  * Preview).
12
14
  */
13
15
  serverRouting?: boolean;
14
16
  /**
15
- * Do not install packages for dependencies.
17
+ * Skip the automatic installation of packages. You will need to manually install the
18
+ * dependencies later.
16
19
  */
17
20
  skipInstall?: boolean;
18
21
  }
@@ -4,22 +4,22 @@
4
4
  "title": "Angular Server App Options Schema",
5
5
  "type": "object",
6
6
  "additionalProperties": false,
7
- "description": "Pass this schematic to the \"run\" command to set up server-side rendering for an app.",
7
+ "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.",
8
8
  "properties": {
9
9
  "project": {
10
10
  "type": "string",
11
- "description": "The name of the project.",
11
+ "description": "The name of the project to enable server-side rendering for.",
12
12
  "$default": {
13
13
  "$source": "projectName"
14
14
  }
15
15
  },
16
16
  "skipInstall": {
17
- "description": "Do not install packages for dependencies.",
17
+ "description": "Skip the automatic installation of packages. You will need to manually install the dependencies later.",
18
18
  "type": "boolean",
19
19
  "default": false
20
20
  },
21
21
  "serverRouting": {
22
- "description": "Creates a server application using the Server Routing and App Engine APIs (Developer Preview).",
22
+ "description": "Configure the server application to use the Server Routing and App Engine APIs (Developer Preview).",
23
23
  "type": "boolean"
24
24
  }
25
25
  },
@@ -1,25 +1,31 @@
1
1
  /**
2
- * Creates a new, generic service definition in the given project.
2
+ * Creates a new service in your project. Services are used to encapsulate reusable logic,
3
+ * such as data access, API calls, or utility functions. This schematic simplifies the
4
+ * process of generating a new service with the necessary files and boilerplate code.
3
5
  */
4
6
  export interface Schema {
5
7
  /**
6
- * When true (the default), creates files at the top level of the project.
8
+ * Creates files at the top level of the project or the given path. If set to false, a new
9
+ * folder with the service's name will be created to contain the files.
7
10
  */
8
11
  flat?: boolean;
9
12
  /**
10
- * The name of the service.
13
+ * The name for the new service. This will be used to create the service's class and spec
14
+ * files (e.g., `my-service.service.ts` and `my-service.service.spec.ts`).
11
15
  */
12
16
  name: string;
13
17
  /**
14
- * The path at which to create the service, relative to the workspace root.
18
+ * The path where the service files should be created, relative to the workspace root. If
19
+ * not provided, the service will be created in the project's `src/app` directory.
15
20
  */
16
21
  path?: string;
17
22
  /**
18
- * The name of the project.
23
+ * The name of the project where the service should be added. If not specified, the CLI will
24
+ * determine the project from the current directory.
19
25
  */
20
26
  project: string;
21
27
  /**
22
- * Do not create "spec.ts" test files for the new service.
28
+ * Skip the generation of a unit test file `spec.ts` for the service.
23
29
  */
24
30
  skipTests?: boolean;
25
31
  }
@@ -4,11 +4,11 @@
4
4
  "title": "Angular Service Options Schema",
5
5
  "type": "object",
6
6
  "additionalProperties": false,
7
- "description": "Creates a new, generic service definition in the given project.",
7
+ "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.",
8
8
  "properties": {
9
9
  "name": {
10
10
  "type": "string",
11
- "description": "The name of the service.",
11
+ "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`).",
12
12
  "$default": {
13
13
  "$source": "argv",
14
14
  "index": 0
@@ -20,12 +20,12 @@
20
20
  "$default": {
21
21
  "$source": "workingDirectory"
22
22
  },
23
- "description": "The path at which to create the service, relative to the workspace root.",
23
+ "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.",
24
24
  "visible": false
25
25
  },
26
26
  "project": {
27
27
  "type": "string",
28
- "description": "The name of the project.",
28
+ "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.",
29
29
  "$default": {
30
30
  "$source": "projectName"
31
31
  }
@@ -33,11 +33,11 @@
33
33
  "flat": {
34
34
  "type": "boolean",
35
35
  "default": true,
36
- "description": "When true (the default), creates files at the top level of the project."
36
+ "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."
37
37
  },
38
38
  "skipTests": {
39
39
  "type": "boolean",
40
- "description": "Do not create \"spec.ts\" test files for the new service.",
40
+ "description": "Skip the generation of a unit test file `spec.ts` for the service.",
41
41
  "default": false
42
42
  }
43
43
  },
@@ -1,13 +1,17 @@
1
1
  /**
2
- * Pass this schematic to the "run" command to create a service worker
2
+ * Adds a service worker to your project. Service workers enable your application to work
3
+ * offline or on low-quality networks by caching assets and intercepting network requests.
4
+ * This schematic configures your project to use a service worker.
3
5
  */
4
6
  export interface Schema {
5
7
  /**
6
- * The name of the project.
8
+ * The name of the project to add the service worker to. If not specified, the CLI will
9
+ * determine the project from the current directory.
7
10
  */
8
11
  project: string;
9
12
  /**
10
- * The target to apply service worker to.
13
+ * The build target to apply the service worker to. This is typically `build`, indicating
14
+ * that the service worker should be generated during the standard build process.
11
15
  */
12
16
  target?: string;
13
17
  }
@@ -4,18 +4,18 @@
4
4
  "title": "Angular Service Worker Options Schema",
5
5
  "type": "object",
6
6
  "additionalProperties": false,
7
- "description": "Pass this schematic to the \"run\" command to create a service worker",
7
+ "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.",
8
8
  "properties": {
9
9
  "project": {
10
10
  "type": "string",
11
- "description": "The name of the project.",
11
+ "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.",
12
12
  "$default": {
13
13
  "$source": "projectName"
14
14
  }
15
15
  },
16
16
  "target": {
17
17
  "type": "string",
18
- "description": "The target to apply service worker to.",
18
+ "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.",
19
19
  "default": "build"
20
20
  }
21
21
  },
package/ssr/schema.d.ts CHANGED
@@ -1,15 +1,23 @@
1
+ /**
2
+ * Enables Server-Side Rendering (SSR) for your Angular application. SSR allows your app to
3
+ * be rendered on the server, which can significantly improve its initial load performance
4
+ * and Search Engine Optimization (SEO). This schematic configures your project for SSR,
5
+ * generating the necessary files and making the required modifications to your project's
6
+ * structure.
7
+ */
1
8
  export interface Schema {
2
9
  /**
3
- * The name of the project.
10
+ * The name of the project you want to enable SSR for.
4
11
  */
5
12
  project: string;
6
13
  /**
7
- * Creates a server application using the Server Routing and App Engine APIs (Developer
8
- * Preview).
14
+ * Configure the server application to use the Angular Server Routing API and App Engine
15
+ * APIs (currently in Developer Preview).
9
16
  */
10
17
  serverRouting?: boolean;
11
18
  /**
12
- * Skip installing dependency packages.
19
+ * Skip the automatic installation of packages. You will need to manually install the
20
+ * dependencies later.
13
21
  */
14
22
  skipInstall?: boolean;
15
23
  }