@rxap/plugin-angular 20.2.1-dev.2 → 20.3.0-dev.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.
- package/CHANGELOG.md +10 -0
- package/README.md +55 -43
- package/generators.json +10 -0
- package/package.json +9 -9
- package/src/generators/convert-to-buildable-library/index.d.ts +2 -0
- package/src/generators/convert-to-buildable-library/index.js +7 -0
- package/src/generators/convert-to-buildable-library/index.js.map +1 -0
- package/src/generators/convert-to-buildable-library/schema.json +6 -1
- package/src/generators/fix-schematic/schema.json +5 -2
- package/src/generators/init/schema.json +17 -6
- package/src/generators/init-application/schema.json +22 -11
- package/src/generators/init-component/schema.json +9 -6
- package/src/generators/init-feature/schema.json +9 -5
- package/src/generators/init-feature-library/schema.json +14 -8
- package/src/generators/init-library/schema.json +12 -7
- package/src/generators/schematic/schema.json +10 -7
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,16 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [20.3.0-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-angular@20.2.1-dev.3...@rxap/plugin-angular@20.3.0-dev.0) (2026-01-12)
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
|
|
10
|
+
- **angular:** add convert-to-buildable-library generator and improve generator schema documentation ([de28ae8](https://gitlab.com/rxap/packages/commit/de28ae8767847b1e2f1ae21e7d204c53b63caca5))
|
|
11
|
+
|
|
12
|
+
## [20.2.1-dev.3](https://gitlab.com/rxap/packages/compare/@rxap/plugin-angular@20.2.1-dev.2...@rxap/plugin-angular@20.2.1-dev.3) (2025-09-18)
|
|
13
|
+
|
|
14
|
+
**Note:** Version bump only for package @rxap/plugin-angular
|
|
15
|
+
|
|
6
16
|
## [20.2.1-dev.2](https://gitlab.com/rxap/packages/compare/@rxap/plugin-angular@20.2.1-dev.1...@rxap/plugin-angular@20.2.1-dev.2) (2025-09-15)
|
|
7
17
|
|
|
8
18
|
**Note:** Version bump only for package @rxap/plugin-angular
|
package/README.md
CHANGED
|
@@ -18,6 +18,7 @@ This package provides generators and executors for Angular projects within an Nx
|
|
|
18
18
|
- [init-feature](#init-feature)
|
|
19
19
|
- [init-feature-library](#init-feature-library)
|
|
20
20
|
- [init-component](#init-component)
|
|
21
|
+
- [convert-to-buildable-library](#convert-to-buildable-library)
|
|
21
22
|
- [Executors](#executors)
|
|
22
23
|
- [tailwind](#tailwind)
|
|
23
24
|
- [check-ng-package](#check-ng-package)
|
|
@@ -155,12 +156,12 @@ nx g @rxap/plugin-angular:init
|
|
|
155
156
|
|
|
156
157
|
Option | Type | Default | Description
|
|
157
158
|
--- | --- | --- | ---
|
|
158
|
-
projects | array | |
|
|
159
|
-
overwrite | boolean | false | Whether to overwrite existing files
|
|
160
|
-
skipFormat | boolean | false |
|
|
161
|
-
skipProjects | boolean | false | Whether to skip executing project
|
|
162
|
-
prefix | string | | The prefix for the
|
|
163
|
-
withSharedLibraries | boolean | false | Whether to
|
|
159
|
+
projects | array | | The name of the projects to initialize.
|
|
160
|
+
overwrite | boolean | false | Whether to overwrite existing files during initialization.
|
|
161
|
+
skipFormat | boolean | false | Whether to skip formatting files after initialization.
|
|
162
|
+
skipProjects | boolean | false | Whether to skip executing project-specific initialization logic.
|
|
163
|
+
prefix | string | | The prefix to use for the generated Angular components.
|
|
164
|
+
withSharedLibraries | boolean | false | Whether to initialize the workspace with shared libraries (components, forms, etc.).
|
|
164
165
|
|
|
165
166
|
## init-application
|
|
166
167
|
> init-application generator
|
|
@@ -171,27 +172,27 @@ nx g @rxap/plugin-angular:init-application
|
|
|
171
172
|
|
|
172
173
|
Option | Type | Default | Description
|
|
173
174
|
--- | --- | --- | ---
|
|
174
|
-
project | string | |
|
|
175
|
-
projects | array | |
|
|
176
|
-
incrementalBuild | boolean | | Whether to enable incremental build
|
|
177
|
-
moduleFederation | string | |
|
|
178
|
-
layoutRoutePath | string | |
|
|
179
|
-
standaloneImport | boolean | | Whether to import the
|
|
175
|
+
project | string | | The name of the project to initialize.
|
|
176
|
+
projects | array | | The list of projects to initialize.
|
|
177
|
+
incrementalBuild | boolean | | Whether to enable incremental build for the project.
|
|
178
|
+
moduleFederation | string | | The module federation role of the project.
|
|
179
|
+
layoutRoutePath | string | | The route path for layout children components.
|
|
180
|
+
standaloneImport | boolean | | Whether to import the MFE remote as a standalone unit.
|
|
180
181
|
skipDocker | boolean | | Whether to skip the docker configuration
|
|
181
182
|
host | string | | Host project for module federation
|
|
182
183
|
deploy | string | | Add target to deploy to after build
|
|
183
184
|
sentry | boolean | true |
|
|
184
|
-
apiStatusCheck | boolean | false |
|
|
185
|
+
apiStatusCheck | boolean | false | Whether to enable API status check during bootstrap.
|
|
185
186
|
authentication | | |
|
|
186
187
|
openApi | boolean | false | Whether to enable OpenAPI
|
|
187
|
-
openApiLegacy | boolean | |
|
|
188
|
+
openApiLegacy | boolean | | Whether to use the legacy OpenAPI client generation method.
|
|
188
189
|
config | boolean | true | Whether to enable configuration
|
|
189
190
|
localazy | boolean | false | Whether to enable Localazy
|
|
190
191
|
i18n | boolean | false | Whether to enable i18n
|
|
191
192
|
serviceWorker | boolean | true | Whether to enable service worker
|
|
192
|
-
languages | array | |
|
|
193
|
+
languages | array | | The list of supported languages for the application.
|
|
193
194
|
material | boolean | true | Whether to enable Angular Material
|
|
194
|
-
generateMain | boolean | | Whether to generate the main file
|
|
195
|
+
generateMain | boolean | | Whether to generate the main.ts entry file.
|
|
195
196
|
overwrite | boolean | | Whether to overwrite existing files
|
|
196
197
|
cleanup | boolean | true | Whether to cleanup files
|
|
197
198
|
i18nStandalone | boolean | false | Whether to compile each language into a separate application
|
|
@@ -200,8 +201,8 @@ localazyReadKey | string | | Localazy read key
|
|
|
200
201
|
authentik | boolean | | Use authentik for authentication
|
|
201
202
|
oauth | boolean | | Use OAuth for authentication
|
|
202
203
|
skipProjects | boolean | | Whether to skip executing project specific initialization
|
|
203
|
-
skipFormat | boolean | |
|
|
204
|
-
coerce | | |
|
|
204
|
+
skipFormat | boolean | | Whether to skip formatting files with Prettier after initialization.
|
|
205
|
+
coerce | | | Configuration coercion options for the project.
|
|
205
206
|
|
|
206
207
|
## init-library
|
|
207
208
|
> init-library generator
|
|
@@ -212,14 +213,14 @@ nx g @rxap/plugin-angular:init-library
|
|
|
212
213
|
|
|
213
214
|
Option | Type | Default | Description
|
|
214
215
|
--- | --- | --- | ---
|
|
215
|
-
project | string | |
|
|
216
|
-
projects | array | |
|
|
216
|
+
project | string | | The name of the library project to initialize.
|
|
217
|
+
projects | array | | The list of library projects to initialize.
|
|
217
218
|
overwrite | boolean | false | Whether to overwrite existing files
|
|
218
219
|
skipProjects | boolean | false | Whether to skip executing project specific initialization
|
|
219
220
|
skipFormat | boolean | false |
|
|
220
|
-
indexExport | boolean | true | Whether to add the index-export target to the library
|
|
221
|
+
indexExport | boolean | true | Whether to add the 'index-export' target to the library.
|
|
221
222
|
coerce | | true |
|
|
222
|
-
targets | object | |
|
|
223
|
+
targets | object | | Target configuration options for the library.
|
|
223
224
|
|
|
224
225
|
## fix-schematic
|
|
225
226
|
> fix-schematic generator
|
|
@@ -230,7 +231,7 @@ nx g @rxap/plugin-angular:fix-schematic
|
|
|
230
231
|
|
|
231
232
|
Option | Type | Default | Description
|
|
232
233
|
--- | --- | --- | ---
|
|
233
|
-
project | string | | The name of the project.
|
|
234
|
+
project | string | | The name of the project to fix schematics for.
|
|
234
235
|
|
|
235
236
|
## schematic
|
|
236
237
|
> Create a Schematic for a project.
|
|
@@ -241,10 +242,10 @@ nx g @rxap/plugin-angular:schematic
|
|
|
241
242
|
|
|
242
243
|
Option | Type | Default | Description
|
|
243
244
|
--- | --- | --- | ---
|
|
244
|
-
project | string | | The name of the project.
|
|
245
|
-
name | string | |
|
|
246
|
-
description | string | |
|
|
247
|
-
skipFormat | boolean | false |
|
|
245
|
+
project | string | | The name of the project where the schematic should be added.
|
|
246
|
+
name | string | | The name of the schematic to create.
|
|
247
|
+
description | string | | A brief description of what the schematic does.
|
|
248
|
+
skipFormat | boolean | false | Whether to skip formatting files with Prettier after schematic creation.
|
|
248
249
|
|
|
249
250
|
## init-feature
|
|
250
251
|
> init-feature generator
|
|
@@ -255,11 +256,11 @@ nx g @rxap/plugin-angular:init-feature
|
|
|
255
256
|
|
|
256
257
|
Option | Type | Default | Description
|
|
257
258
|
--- | --- | --- | ---
|
|
258
|
-
name | string | | The name of the feature
|
|
259
|
-
project | string | | The name of the project where the feature should be added
|
|
260
|
-
overwrite | boolean | |
|
|
261
|
-
skipFormat | boolean | false |
|
|
262
|
-
apiStatusCheck | boolean | false |
|
|
259
|
+
name | string | | The name of the feature to initialize.
|
|
260
|
+
project | string | | The name of the project where the feature should be added.
|
|
261
|
+
overwrite | boolean | | Whether to overwrite the feature if it already exists.
|
|
262
|
+
skipFormat | boolean | false | Whether to skip formatting files with Prettier after initialization.
|
|
263
|
+
apiStatusCheck | boolean | false | Whether to enable API status check for this feature.
|
|
263
264
|
navigation | object | |
|
|
264
265
|
|
|
265
266
|
## init-feature-library
|
|
@@ -271,13 +272,13 @@ nx g @rxap/plugin-angular:init-feature-library
|
|
|
271
272
|
|
|
272
273
|
Option | Type | Default | Description
|
|
273
274
|
--- | --- | --- | ---
|
|
274
|
-
project | string | |
|
|
275
|
-
projects | array | |
|
|
276
|
-
overwrite | boolean | false | Whether to overwrite existing files
|
|
277
|
-
skipProjects | boolean | false | Whether to skip executing project
|
|
278
|
-
skipFormat | boolean | false |
|
|
279
|
-
routes | boolean | true | Whether the library
|
|
280
|
-
targets | object | |
|
|
275
|
+
project | string | | The name of the feature library project to initialize.
|
|
276
|
+
projects | array | | The list of feature library projects to initialize.
|
|
277
|
+
overwrite | boolean | false | Whether to overwrite existing files during initialization.
|
|
278
|
+
skipProjects | boolean | false | Whether to skip executing project-specific initialization logic.
|
|
279
|
+
skipFormat | boolean | false | Whether to skip formatting files with Prettier after initialization.
|
|
280
|
+
routes | boolean | true | Whether the feature library should expose Angular routes.
|
|
281
|
+
targets | object | | Target configuration options for the feature library.
|
|
281
282
|
|
|
282
283
|
## init-component
|
|
283
284
|
> init-component generator
|
|
@@ -289,7 +290,7 @@ nx g @rxap/plugin-angular:init-component
|
|
|
289
290
|
Option | Type | Default | Description
|
|
290
291
|
--- | --- | --- | ---
|
|
291
292
|
directory | string | | The directory 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.
|
|
292
|
-
feature | string | | The name of the feature.
|
|
293
|
+
feature | string | | The name of the feature the component belongs to.
|
|
293
294
|
project | string | | The name of the project.
|
|
294
295
|
name | string | | The name of the component.
|
|
295
296
|
prefix | string | | The prefix to apply to the generated component selector.
|
|
@@ -307,12 +308,23 @@ skipImport | boolean | false | Do not import this component into the owning NgMo
|
|
|
307
308
|
selector | string | | The HTML selector to use for this component.
|
|
308
309
|
skipSelector | boolean | false | Specifies if the component should have a selector or not.
|
|
309
310
|
type | string | component | Adds a developer-defined type to the filename, in the format `name.type.ts`.
|
|
310
|
-
defaultExport | boolean | false |
|
|
311
|
-
export | boolean | false |
|
|
311
|
+
defaultExport | boolean | false | Whether the component class should be the default export of the file.
|
|
312
|
+
export | boolean | false | Whether the component should be exported from the declaring NgModule or project entry point.
|
|
312
313
|
skipFormat | boolean | false | Skip formatting files.
|
|
313
|
-
interactionTests | boolean | true |
|
|
314
|
+
interactionTests | boolean | true | Whether to set up Storybook interaction tests for the component.
|
|
314
315
|
cypressProject | string | | The Cypress project to generate the stories under. By default, inferred from `projectName`.
|
|
315
316
|
specDirectory | string | | Directory where to place the generated spec file. By default matches the value of the `componentPath` option.
|
|
317
|
+
|
|
318
|
+
## convert-to-buildable-library
|
|
319
|
+
> convert-to-buildable-library generator
|
|
320
|
+
|
|
321
|
+
```bash
|
|
322
|
+
nx g @rxap/plugin-angular:convert-to-buildable-library
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
Option | Type | Default | Description
|
|
326
|
+
--- | --- | --- | ---
|
|
327
|
+
project | string | | The name of the project to convert to a buildable library.
|
|
316
328
|
# Executors
|
|
317
329
|
|
|
318
330
|
## tailwind
|
package/generators.json
CHANGED
|
@@ -39,6 +39,11 @@
|
|
|
39
39
|
"factory": "./src/generators/init-component/generator",
|
|
40
40
|
"schema": "./src/generators/init-component/schema.json",
|
|
41
41
|
"description": "init-component generator"
|
|
42
|
+
},
|
|
43
|
+
"convert-to-buildable-library": {
|
|
44
|
+
"factory": "./src/generators/convert-to-buildable-library/generator",
|
|
45
|
+
"schema": "./src/generators/convert-to-buildable-library/schema.json",
|
|
46
|
+
"description": "convert-to-buildable-library generator"
|
|
42
47
|
}
|
|
43
48
|
},
|
|
44
49
|
"schematics": {
|
|
@@ -77,6 +82,11 @@
|
|
|
77
82
|
"schema": "./src/generators/init-component/schema.json",
|
|
78
83
|
"description": "init-component generator"
|
|
79
84
|
},
|
|
85
|
+
"convert-to-buildable-library": {
|
|
86
|
+
"factory": "./src/generators/convert-to-buildable-library/index",
|
|
87
|
+
"schema": "./src/generators/convert-to-buildable-library/schema.json",
|
|
88
|
+
"description": "convert-to-buildable-library generator"
|
|
89
|
+
},
|
|
80
90
|
"init-feature-library": {
|
|
81
91
|
"factory": "./src/generators/init-feature-library/index",
|
|
82
92
|
"schema": "./src/generators/init-feature-library/schema.json",
|
package/package.json
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "20.
|
|
2
|
+
"version": "20.3.0-dev.0",
|
|
3
3
|
"name": "@rxap/plugin-angular",
|
|
4
4
|
"description": "This package provides generators and executors for Angular projects within an Nx workspace. It helps initialize and configure Angular applications and libraries with Rxap-specific defaults and utilities. It also includes executors for tasks like checking ng-package configurations, managing application configurations, and generating i18n files.\n",
|
|
5
5
|
"license": "GPL-3.0-or-later",
|
|
6
6
|
"dependencies": {
|
|
7
7
|
"@nx/angular": "20.5.0",
|
|
8
8
|
"@nx/devkit": "20.5.0",
|
|
9
|
-
"@rxap/plugin-application": "^20.0
|
|
10
|
-
"@rxap/plugin-library": "^20.
|
|
11
|
-
"@rxap/plugin-utilities": "^20.0.5-dev.
|
|
12
|
-
"@rxap/ts-morph": "^1.6.0-dev.
|
|
13
|
-
"@rxap/utilities": "^16.
|
|
14
|
-
"@rxap/workspace-ts-morph": "^19.1.13-dev.
|
|
15
|
-
"@rxap/workspace-utilities": "^19.8.1-dev.
|
|
9
|
+
"@rxap/plugin-application": "^20.1.0-dev.0",
|
|
10
|
+
"@rxap/plugin-library": "^20.3.0-dev.0",
|
|
11
|
+
"@rxap/plugin-utilities": "^20.0.5-dev.2",
|
|
12
|
+
"@rxap/ts-morph": "^1.6.0-dev.2",
|
|
13
|
+
"@rxap/utilities": "^16.5.0-dev.0",
|
|
14
|
+
"@rxap/workspace-ts-morph": "^19.1.13-dev.3",
|
|
15
|
+
"@rxap/workspace-utilities": "^19.8.1-dev.2",
|
|
16
16
|
"colors": "1.4.0",
|
|
17
17
|
"handlebars": "4.7.8",
|
|
18
18
|
"semver": "7.5.3",
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
},
|
|
57
57
|
"schematics": "./generators.json",
|
|
58
58
|
"type": "commonjs",
|
|
59
|
-
"gitHead": "
|
|
59
|
+
"gitHead": "f6923aa9d989b25018f2fcac470963fb1e68049a",
|
|
60
60
|
"exports": {
|
|
61
61
|
"./package.json": "./package.json",
|
|
62
62
|
".": {
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const devkit_1 = require("@nx/devkit");
|
|
4
|
+
const generator_1 = require("./generator");
|
|
5
|
+
const schematic = (0, devkit_1.convertNxGenerator)(generator_1.default);
|
|
6
|
+
exports.default = schematic;
|
|
7
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/angular/src/generators/convert-to-buildable-library/index.ts"],"names":[],"mappings":";;AAAA,uCAAgD;AAChD,2CAAoC;AAEpC,MAAM,SAAS,GAAG,IAAA,2BAAkB,EAAC,mBAAS,CAAC,CAAC;AAChD,kBAAe,SAAS,CAAC"}
|
|
@@ -5,7 +5,12 @@
|
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"project": {
|
|
8
|
-
"type": "string"
|
|
8
|
+
"type": "string",
|
|
9
|
+
"description": "The name of the project to convert to a buildable library.",
|
|
10
|
+
"x-prompt": "What is the name of the project you want to convert?",
|
|
11
|
+
"examples": [
|
|
12
|
+
"my-lib"
|
|
13
|
+
]
|
|
9
14
|
}
|
|
10
15
|
},
|
|
11
16
|
"required": ["project"]
|
|
@@ -6,13 +6,16 @@
|
|
|
6
6
|
"properties": {
|
|
7
7
|
"project": {
|
|
8
8
|
"type": "string",
|
|
9
|
-
"description": "The name of the project.",
|
|
9
|
+
"description": "The name of the project to fix schematics for.",
|
|
10
10
|
"alias": "p",
|
|
11
11
|
"$default": {
|
|
12
12
|
"$source": "projectName"
|
|
13
13
|
},
|
|
14
14
|
"x-prompt": "What is the name of the project for the schematic?",
|
|
15
|
-
"x-priority": "important"
|
|
15
|
+
"x-priority": "important",
|
|
16
|
+
"examples": [
|
|
17
|
+
"my-lib"
|
|
18
|
+
]
|
|
16
19
|
}
|
|
17
20
|
},
|
|
18
21
|
"required": [
|
|
@@ -7,32 +7,43 @@
|
|
|
7
7
|
"projects": {
|
|
8
8
|
"alias": "project",
|
|
9
9
|
"type": "array",
|
|
10
|
+
"description": "The name of the projects to initialize.",
|
|
10
11
|
"items": {
|
|
11
12
|
"type": "string"
|
|
12
|
-
}
|
|
13
|
+
},
|
|
14
|
+
"examples": [
|
|
15
|
+
[
|
|
16
|
+
"my-app",
|
|
17
|
+
"my-lib"
|
|
18
|
+
]
|
|
19
|
+
]
|
|
13
20
|
},
|
|
14
21
|
"overwrite": {
|
|
15
22
|
"type": "boolean",
|
|
16
23
|
"default": false,
|
|
17
|
-
"description": "Whether to overwrite existing files"
|
|
24
|
+
"description": "Whether to overwrite existing files during initialization."
|
|
18
25
|
},
|
|
19
26
|
"skipFormat": {
|
|
20
27
|
"type": "boolean",
|
|
21
|
-
"default": false
|
|
28
|
+
"default": false,
|
|
29
|
+
"description": "Whether to skip formatting files after initialization."
|
|
22
30
|
},
|
|
23
31
|
"skipProjects": {
|
|
24
32
|
"type": "boolean",
|
|
25
33
|
"default": false,
|
|
26
|
-
"description": "Whether to skip executing project
|
|
34
|
+
"description": "Whether to skip executing project-specific initialization logic."
|
|
27
35
|
},
|
|
28
36
|
"prefix": {
|
|
29
37
|
"type": "string",
|
|
30
|
-
"description": "The prefix for the
|
|
38
|
+
"description": "The prefix to use for the generated Angular components.",
|
|
39
|
+
"examples": [
|
|
40
|
+
"rxap"
|
|
41
|
+
]
|
|
31
42
|
},
|
|
32
43
|
"withSharedLibraries": {
|
|
33
44
|
"type": "boolean",
|
|
34
45
|
"default": false,
|
|
35
|
-
"description": "Whether to
|
|
46
|
+
"description": "Whether to initialize the workspace with shared libraries (components, forms, etc.)."
|
|
36
47
|
}
|
|
37
48
|
},
|
|
38
49
|
"required": []
|
|
@@ -5,30 +5,35 @@
|
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"project": {
|
|
8
|
-
"type": "string"
|
|
8
|
+
"type": "string",
|
|
9
|
+
"description": "The name of the project to initialize.",
|
|
10
|
+
"examples": ["my-app"]
|
|
9
11
|
},
|
|
10
12
|
"projects": {
|
|
11
13
|
"type": "array",
|
|
14
|
+
"description": "The list of projects to initialize.",
|
|
12
15
|
"items": {
|
|
13
16
|
"type": "string"
|
|
14
|
-
}
|
|
17
|
+
},
|
|
18
|
+
"examples": [["my-app", "another-app"]]
|
|
15
19
|
},
|
|
16
20
|
"incrementalBuild": {
|
|
17
21
|
"type": "boolean",
|
|
18
|
-
"description": "Whether to enable incremental build"
|
|
22
|
+
"description": "Whether to enable incremental build for the project."
|
|
19
23
|
},
|
|
20
24
|
"moduleFederation": {
|
|
21
25
|
"alias": "mfe",
|
|
22
26
|
"type": "string",
|
|
23
|
-
"enum": ["host", "remote"]
|
|
27
|
+
"enum": ["host", "remote"],
|
|
28
|
+
"description": "The module federation role of the project."
|
|
24
29
|
},
|
|
25
30
|
"layoutRoutePath": {
|
|
26
31
|
"type": "string",
|
|
27
|
-
"description": "
|
|
32
|
+
"description": "The route path for layout children components."
|
|
28
33
|
},
|
|
29
34
|
"standaloneImport": {
|
|
30
35
|
"type": "boolean",
|
|
31
|
-
"description": "Whether to import the
|
|
36
|
+
"description": "Whether to import the MFE remote as a standalone unit."
|
|
32
37
|
},
|
|
33
38
|
"skipDocker": {
|
|
34
39
|
"type": "boolean",
|
|
@@ -50,7 +55,8 @@
|
|
|
50
55
|
},
|
|
51
56
|
"apiStatusCheck": {
|
|
52
57
|
"type": "boolean",
|
|
53
|
-
"default": false
|
|
58
|
+
"default": false,
|
|
59
|
+
"description": "Whether to enable API status check during bootstrap."
|
|
54
60
|
},
|
|
55
61
|
"authentication": {
|
|
56
62
|
"oneOf": [
|
|
@@ -73,7 +79,8 @@
|
|
|
73
79
|
"x-prompt": "Would you like to enable OpenAPI?"
|
|
74
80
|
},
|
|
75
81
|
"openApiLegacy": {
|
|
76
|
-
"type": "boolean"
|
|
82
|
+
"type": "boolean",
|
|
83
|
+
"description": "Whether to use the legacy OpenAPI client generation method."
|
|
77
84
|
},
|
|
78
85
|
"config": {
|
|
79
86
|
"type": "boolean",
|
|
@@ -102,9 +109,11 @@
|
|
|
102
109
|
},
|
|
103
110
|
"languages": {
|
|
104
111
|
"type": "array",
|
|
112
|
+
"description": "The list of supported languages for the application.",
|
|
105
113
|
"items": {
|
|
106
114
|
"type": "string"
|
|
107
|
-
}
|
|
115
|
+
},
|
|
116
|
+
"examples": [["en", "de"]]
|
|
108
117
|
},
|
|
109
118
|
"material": {
|
|
110
119
|
"type": "boolean",
|
|
@@ -115,7 +124,7 @@
|
|
|
115
124
|
"generateMain": {
|
|
116
125
|
"alias": "gm",
|
|
117
126
|
"type": "boolean",
|
|
118
|
-
"description": "Whether to generate the main file"
|
|
127
|
+
"description": "Whether to generate the main.ts entry file."
|
|
119
128
|
},
|
|
120
129
|
"overwrite": {
|
|
121
130
|
"type": "boolean",
|
|
@@ -154,9 +163,11 @@
|
|
|
154
163
|
"description": "Whether to skip executing project specific initialization"
|
|
155
164
|
},
|
|
156
165
|
"skipFormat": {
|
|
157
|
-
"type": "boolean"
|
|
166
|
+
"type": "boolean",
|
|
167
|
+
"description": "Whether to skip formatting files with Prettier after initialization."
|
|
158
168
|
},
|
|
159
169
|
"coerce": {
|
|
170
|
+
"description": "Configuration coercion options for the project.",
|
|
160
171
|
"oneOf": [
|
|
161
172
|
{
|
|
162
173
|
"type": "boolean"
|
|
@@ -13,7 +13,8 @@
|
|
|
13
13
|
},
|
|
14
14
|
"feature": {
|
|
15
15
|
"type": "string",
|
|
16
|
-
"description": "The name of the feature."
|
|
16
|
+
"description": "The name of the feature the component belongs to.",
|
|
17
|
+
"examples": ["user-profile"]
|
|
17
18
|
},
|
|
18
19
|
"project": {
|
|
19
20
|
"type": "string",
|
|
@@ -21,7 +22,8 @@
|
|
|
21
22
|
"$default": {
|
|
22
23
|
"$source": "projectName"
|
|
23
24
|
},
|
|
24
|
-
"x-dropdown": "projects"
|
|
25
|
+
"x-dropdown": "projects",
|
|
26
|
+
"examples": ["my-app"]
|
|
25
27
|
},
|
|
26
28
|
"name": {
|
|
27
29
|
"type": "string",
|
|
@@ -30,7 +32,8 @@
|
|
|
30
32
|
"$source": "argv",
|
|
31
33
|
"index": 0
|
|
32
34
|
},
|
|
33
|
-
"x-prompt": "What name would you like to use for the component?"
|
|
35
|
+
"x-prompt": "What name would you like to use for the component?",
|
|
36
|
+
"examples": ["user-list"]
|
|
34
37
|
},
|
|
35
38
|
"prefix": {
|
|
36
39
|
"type": "string",
|
|
@@ -117,12 +120,12 @@
|
|
|
117
120
|
},
|
|
118
121
|
"defaultExport": {
|
|
119
122
|
"type": "boolean",
|
|
120
|
-
"description": "
|
|
123
|
+
"description": "Whether the component class should be the default export of the file.",
|
|
121
124
|
"default": false
|
|
122
125
|
},
|
|
123
126
|
"export": {
|
|
124
127
|
"type": "boolean",
|
|
125
|
-
"description": "
|
|
128
|
+
"description": "Whether the component should be exported from the declaring NgModule or project entry point.",
|
|
126
129
|
"default": false,
|
|
127
130
|
"x-priority": "important"
|
|
128
131
|
},
|
|
@@ -134,7 +137,7 @@
|
|
|
134
137
|
},
|
|
135
138
|
"interactionTests": {
|
|
136
139
|
"type": "boolean",
|
|
137
|
-
"description": "
|
|
140
|
+
"description": "Whether to set up Storybook interaction tests for the component.",
|
|
138
141
|
"x-priority": "important",
|
|
139
142
|
"default": true
|
|
140
143
|
},
|
|
@@ -6,23 +6,27 @@
|
|
|
6
6
|
"properties": {
|
|
7
7
|
"name": {
|
|
8
8
|
"type": "string",
|
|
9
|
-
"description": "The name of the feature"
|
|
9
|
+
"description": "The name of the feature to initialize.",
|
|
10
|
+
"examples": ["user-profile"]
|
|
10
11
|
},
|
|
11
12
|
"project": {
|
|
12
13
|
"type": "string",
|
|
13
|
-
"description": "The name of the project where the feature should be added"
|
|
14
|
+
"description": "The name of the project where the feature should be added.",
|
|
15
|
+
"examples": ["my-app"]
|
|
14
16
|
},
|
|
15
17
|
"overwrite": {
|
|
16
18
|
"type": "boolean",
|
|
17
|
-
"description": "
|
|
19
|
+
"description": "Whether to overwrite the feature if it already exists."
|
|
18
20
|
},
|
|
19
21
|
"skipFormat": {
|
|
20
22
|
"type": "boolean",
|
|
21
|
-
"default": false
|
|
23
|
+
"default": false,
|
|
24
|
+
"description": "Whether to skip formatting files with Prettier after initialization."
|
|
22
25
|
},
|
|
23
26
|
"apiStatusCheck": {
|
|
24
27
|
"type": "boolean",
|
|
25
|
-
"default": false
|
|
28
|
+
"default": false,
|
|
29
|
+
"description": "Whether to enable API status check for this feature."
|
|
26
30
|
},
|
|
27
31
|
"navigation": {
|
|
28
32
|
"type": "object",
|
|
@@ -5,43 +5,49 @@
|
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"project": {
|
|
8
|
-
"type": "string"
|
|
8
|
+
"type": "string",
|
|
9
|
+
"description": "The name of the feature library project to initialize.",
|
|
10
|
+
"examples": ["feature-user-profile"]
|
|
9
11
|
},
|
|
10
12
|
"projects": {
|
|
11
13
|
"type": "array",
|
|
14
|
+
"description": "The list of feature library projects to initialize.",
|
|
12
15
|
"items": {
|
|
13
16
|
"type": "string"
|
|
14
|
-
}
|
|
17
|
+
},
|
|
18
|
+
"examples": [["feature-user-profile", "feature-admin"]]
|
|
15
19
|
},
|
|
16
20
|
"overwrite": {
|
|
17
21
|
"type": "boolean",
|
|
18
22
|
"default": false,
|
|
19
|
-
"description": "Whether to overwrite existing files"
|
|
23
|
+
"description": "Whether to overwrite existing files during initialization."
|
|
20
24
|
},
|
|
21
25
|
"skipProjects": {
|
|
22
26
|
"type": "boolean",
|
|
23
27
|
"default": false,
|
|
24
|
-
"description": "Whether to skip executing project
|
|
28
|
+
"description": "Whether to skip executing project-specific initialization logic."
|
|
25
29
|
},
|
|
26
30
|
"skipFormat": {
|
|
27
31
|
"type": "boolean",
|
|
28
|
-
"default": false
|
|
32
|
+
"default": false,
|
|
33
|
+
"description": "Whether to skip formatting files with Prettier after initialization."
|
|
29
34
|
},
|
|
30
35
|
"routes": {
|
|
31
36
|
"type": "boolean",
|
|
32
37
|
"default": true,
|
|
33
|
-
"description": "Whether the library
|
|
38
|
+
"description": "Whether the feature library should expose Angular routes."
|
|
34
39
|
},
|
|
35
40
|
"targets": {
|
|
36
41
|
"type": "object",
|
|
42
|
+
"description": "Target configuration options for the feature library.",
|
|
37
43
|
"properties": {
|
|
38
44
|
"fixDependencies": {
|
|
39
45
|
"type": "boolean",
|
|
40
|
-
"description": "
|
|
46
|
+
"description": "Whether to add the 'fix-dependencies' target to the project."
|
|
41
47
|
},
|
|
42
48
|
"indexExport": {
|
|
43
49
|
"type": "boolean",
|
|
44
|
-
"description": "
|
|
50
|
+
"description": "Whether to add the 'index-export' target to the project."
|
|
45
51
|
}
|
|
46
52
|
}
|
|
47
53
|
}
|
|
@@ -5,13 +5,17 @@
|
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"project": {
|
|
8
|
-
"type": "string"
|
|
8
|
+
"type": "string",
|
|
9
|
+
"description": "The name of the library project to initialize.",
|
|
10
|
+
"examples": ["my-lib"]
|
|
9
11
|
},
|
|
10
12
|
"projects": {
|
|
11
13
|
"type": "array",
|
|
14
|
+
"description": "The list of library projects to initialize.",
|
|
12
15
|
"items": {
|
|
13
16
|
"type": "string"
|
|
14
|
-
}
|
|
17
|
+
},
|
|
18
|
+
"examples": [["my-lib", "another-lib"]]
|
|
15
19
|
},
|
|
16
20
|
"overwrite": {
|
|
17
21
|
"type": "boolean",
|
|
@@ -31,7 +35,7 @@
|
|
|
31
35
|
"type": "boolean",
|
|
32
36
|
"deprecated": true,
|
|
33
37
|
"default": true,
|
|
34
|
-
"description": "Whether to add the index-export target to the library"
|
|
38
|
+
"description": "Whether to add the 'index-export' target to the library."
|
|
35
39
|
},
|
|
36
40
|
"coerce": {
|
|
37
41
|
"default": true,
|
|
@@ -57,11 +61,11 @@
|
|
|
57
61
|
},
|
|
58
62
|
"publishable": {
|
|
59
63
|
"type": "boolean",
|
|
60
|
-
"description": "
|
|
64
|
+
"description": "Whether to generate a publishable library."
|
|
61
65
|
},
|
|
62
66
|
"buildable": {
|
|
63
67
|
"type": "boolean",
|
|
64
|
-
"description": "
|
|
68
|
+
"description": "Whether to generate a buildable library."
|
|
65
69
|
},
|
|
66
70
|
"prefix": {
|
|
67
71
|
"type": "string",
|
|
@@ -225,14 +229,15 @@
|
|
|
225
229
|
},
|
|
226
230
|
"targets": {
|
|
227
231
|
"type": "object",
|
|
232
|
+
"description": "Target configuration options for the library.",
|
|
228
233
|
"properties": {
|
|
229
234
|
"fixDependencies": {
|
|
230
235
|
"type": "boolean",
|
|
231
|
-
"description": "
|
|
236
|
+
"description": "Whether to add the 'fix-dependencies' target to the project."
|
|
232
237
|
},
|
|
233
238
|
"indexExport": {
|
|
234
239
|
"type": "boolean",
|
|
235
|
-
"description": "
|
|
240
|
+
"description": "Whether to add the 'index-export' target to the project."
|
|
236
241
|
}
|
|
237
242
|
}
|
|
238
243
|
}
|
|
@@ -6,33 +6,36 @@
|
|
|
6
6
|
"properties": {
|
|
7
7
|
"project": {
|
|
8
8
|
"type": "string",
|
|
9
|
-
"description": "The name of the project.",
|
|
9
|
+
"description": "The name of the project where the schematic should be added.",
|
|
10
10
|
"alias": "p",
|
|
11
11
|
"$default": {
|
|
12
12
|
"$source": "projectName"
|
|
13
13
|
},
|
|
14
14
|
"x-prompt": "What is the name of the project for the schematic?",
|
|
15
|
-
"x-priority": "important"
|
|
15
|
+
"x-priority": "important",
|
|
16
|
+
"examples": ["my-lib"]
|
|
16
17
|
},
|
|
17
18
|
"name": {
|
|
18
19
|
"type": "string",
|
|
19
|
-
"description": "
|
|
20
|
+
"description": "The name of the schematic to create.",
|
|
20
21
|
"$default": {
|
|
21
22
|
"$source": "argv",
|
|
22
23
|
"index": 0
|
|
23
24
|
},
|
|
24
25
|
"x-prompt": "What name would you like to use for the schematic?",
|
|
25
|
-
"x-priority": "important"
|
|
26
|
+
"x-priority": "important",
|
|
27
|
+
"examples": ["new-feature"]
|
|
26
28
|
},
|
|
27
29
|
"description": {
|
|
28
30
|
"type": "string",
|
|
29
|
-
"description": "
|
|
30
|
-
"alias": "d"
|
|
31
|
+
"description": "A brief description of what the schematic does.",
|
|
32
|
+
"alias": "d",
|
|
33
|
+
"examples": ["Generate a new feature module."]
|
|
31
34
|
},
|
|
32
35
|
"skipFormat": {
|
|
33
36
|
"type": "boolean",
|
|
34
37
|
"default": false,
|
|
35
|
-
"description": "
|
|
38
|
+
"description": "Whether to skip formatting files with Prettier after schematic creation.",
|
|
36
39
|
"x-priority": "internal"
|
|
37
40
|
}
|
|
38
41
|
},
|