@rxap/plugin-nestjs 20.2.0-dev.8 → 20.2.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 (43) hide show
  1. package/CHANGELOG.md +34 -0
  2. package/README.md +105 -105
  3. package/package.json +11 -11
  4. package/src/generators/dynamic-configuration-module/__snapshots__/generator.spec.ts.snap +6 -6
  5. package/src/generators/dynamic-configuration-module/generator.js +1 -1
  6. package/src/generators/dynamic-configuration-module/generator.js.map +1 -1
  7. package/src/generators/dynamic-configuration-module/schema.json +9 -4
  8. package/src/generators/feature-microservice/schema.json +25 -18
  9. package/src/generators/frontend-microservice/schema.json +28 -20
  10. package/src/generators/health-indicator/generator.js +1 -1
  11. package/src/generators/health-indicator/generator.js.map +1 -1
  12. package/src/generators/health-indicator/schema.json +8 -4
  13. package/src/generators/health-indicator-init/generator.js +1 -1
  14. package/src/generators/health-indicator-init/generator.js.map +1 -1
  15. package/src/generators/health-indicator-init/schema.json +5 -2
  16. package/src/generators/init/schema.json +10 -5
  17. package/src/generators/init-application/coerce-environment-files.d.ts +1 -1
  18. package/src/generators/init-application/coerce-environment-files.js +1 -1
  19. package/src/generators/init-application/coerce-environment-files.js.map +1 -1
  20. package/src/generators/init-application/generator.js +22 -23
  21. package/src/generators/init-application/generator.js.map +1 -1
  22. package/src/generators/init-application/schema.json +41 -26
  23. package/src/generators/init-application/update-main-file.d.ts +1 -1
  24. package/src/generators/init-application/update-main-file.js +1 -1
  25. package/src/generators/init-application/update-main-file.js.map +1 -1
  26. package/src/generators/init-library/schema.json +13 -7
  27. package/src/generators/jwt/generator.js +4 -4
  28. package/src/generators/jwt/generator.js.map +1 -1
  29. package/src/generators/jwt/schema.json +12 -2
  30. package/src/generators/microservice/schema.json +102 -28
  31. package/src/generators/open-api/generator.js +4 -4
  32. package/src/generators/open-api/generator.js.map +1 -1
  33. package/src/generators/open-api/schema.json +12 -2
  34. package/src/generators/sentry/generator.js +18 -91
  35. package/src/generators/sentry/generator.js.map +1 -1
  36. package/src/generators/sentry/schema.json +19 -4
  37. package/src/generators/swagger/coerce-environment-files.d.ts +1 -1
  38. package/src/generators/swagger/coerce-environment-files.js +1 -1
  39. package/src/generators/swagger/coerce-environment-files.js.map +1 -1
  40. package/src/generators/swagger/generator.js +1 -1
  41. package/src/generators/swagger/generator.js.map +1 -1
  42. package/src/generators/swagger/schema.json +16 -3
  43. package/src/generators/validator/schema.json +11 -2
package/CHANGELOG.md CHANGED
@@ -3,6 +3,40 @@
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.2.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-nestjs@20.2.0-dev.14...@rxap/plugin-nestjs@20.2.0) (2026-01-23)
7
+
8
+ **Note:** Version bump only for package @rxap/plugin-nestjs
9
+
10
+ # [20.2.0-dev.14](https://gitlab.com/rxap/packages/compare/@rxap/plugin-nestjs@20.2.0-dev.13...@rxap/plugin-nestjs@20.2.0-dev.14) (2026-01-19)
11
+
12
+ **Note:** Version bump only for package @rxap/plugin-nestjs
13
+
14
+ # [20.2.0-dev.13](https://gitlab.com/rxap/packages/compare/@rxap/plugin-nestjs@20.2.0-dev.12...@rxap/plugin-nestjs@20.2.0-dev.13) (2026-01-13)
15
+
16
+ ### Features
17
+
18
+ - **nestjs:** enhance Sentry setup and validation schema handling ([aabfcb9](https://gitlab.com/rxap/packages/commit/aabfcb9f32d463c277517b39b1b68548a5116706))
19
+
20
+ # [20.2.0-dev.12](https://gitlab.com/rxap/packages/compare/@rxap/plugin-nestjs@20.2.0-dev.11...@rxap/plugin-nestjs@20.2.0-dev.12) (2026-01-12)
21
+
22
+ ### Bug Fixes
23
+
24
+ - update package groups ([ba8753f](https://gitlab.com/rxap/packages/commit/ba8753f5f34680adc282d84c557fc43385bfa987))
25
+
26
+ # [20.2.0-dev.11](https://gitlab.com/rxap/packages/compare/@rxap/plugin-nestjs@20.2.0-dev.10...@rxap/plugin-nestjs@20.2.0-dev.11) (2026-01-12)
27
+
28
+ ### Features
29
+
30
+ - **schema:** enhance generator schema documentation with descriptions and examples ([0ae4939](https://gitlab.com/rxap/packages/commit/0ae4939d77e3e313ace4a77d8f5dd86c3c918d29))
31
+
32
+ # [20.2.0-dev.10](https://gitlab.com/rxap/packages/compare/@rxap/plugin-nestjs@20.2.0-dev.9...@rxap/plugin-nestjs@20.2.0-dev.10) (2025-10-07)
33
+
34
+ **Note:** Version bump only for package @rxap/plugin-nestjs
35
+
36
+ # [20.2.0-dev.9](https://gitlab.com/rxap/packages/compare/@rxap/plugin-nestjs@20.2.0-dev.8...@rxap/plugin-nestjs@20.2.0-dev.9) (2025-10-07)
37
+
38
+ **Note:** Version bump only for package @rxap/plugin-nestjs
39
+
6
40
  # [20.2.0-dev.8](https://gitlab.com/rxap/packages/compare/@rxap/plugin-nestjs@20.2.0-dev.7...@rxap/plugin-nestjs@20.2.0-dev.8) (2025-10-06)
7
41
 
8
42
  **Note:** Version bump only for package @rxap/plugin-nestjs
package/README.md CHANGED
@@ -100,11 +100,11 @@ nx g @rxap/plugin-nestjs:init
100
100
 
101
101
  Option | Type | Default | Description
102
102
  --- | --- | --- | ---
103
- project | string | |
104
- projects | array | |
105
- skipFormat | boolean | false |
106
- overwrite | boolean | false | Whether to overwrite existing files
107
- skipProjects | boolean | false | Whether to skip executing project specific initialization
103
+ project | string | | The name of the project to initialize with NestJS.
104
+ projects | array | | The list of projects to initialize with NestJS.
105
+ skipFormat | boolean | false | Whether to skip formatting files with Prettier after initialization.
106
+ overwrite | boolean | false | Whether to overwrite existing files during initialization.
107
+ skipProjects | boolean | false | Whether to skip executing project-specific initialization logic.
108
108
 
109
109
  ## init-library
110
110
  > init-library generator
@@ -115,12 +115,12 @@ nx g @rxap/plugin-nestjs:init-library
115
115
 
116
116
  Option | Type | Default | Description
117
117
  --- | --- | --- | ---
118
- project | string | |
119
- projects | array | |
120
- overwrite | boolean | false | Whether to overwrite existing files
121
- skipFormat | boolean | false |
122
- skipProjects | boolean | false | Whether to skip executing project specific initialization
123
- targets | object | |
118
+ project | string | | The name of the library project to initialize with NestJS.
119
+ projects | array | | The list of library projects to initialize with NestJS.
120
+ overwrite | boolean | false | Whether to overwrite existing files during initialization.
121
+ skipFormat | boolean | false | Whether to skip formatting files with Prettier after initialization.
122
+ skipProjects | boolean | false | Whether to skip executing project-specific initialization logic.
123
+ targets | object | | Configuration for specific project targets.
124
124
 
125
125
  ## init-application
126
126
  > init-application generator
@@ -131,33 +131,33 @@ nx g @rxap/plugin-nestjs:init-application
131
131
 
132
132
  Option | Type | Default | Description
133
133
  --- | --- | --- | ---
134
- project | string | |
135
- projects | array | |
136
- sentry | boolean | true | Whether this service should use sentry
137
- skipFormat | boolean | false |
138
- swagger | boolean | true | Whether this service should use swagger
139
- swaggerLive | boolean | false | Whether this service should start a swagger live server
140
- generateMain | boolean | false | Whether the main file should be generated
141
- healthIndicator | boolean | true | Whether this service should use a health indicator
142
- healthIndicatorList | array | | A list of health indicators
143
- validator | boolean | true | Whether this service use the ValidationPipe
144
- platform | string | express |
145
- port | number | | The default port where the server is listens
134
+ project | string | | The name of the application project to initialize with NestJS.
135
+ projects | array | | The list of application projects to initialize with NestJS.
136
+ sentry | boolean | true | Whether this application should use Sentry for error tracking.
137
+ skipFormat | boolean | false | Whether to skip formatting files with Prettier after initialization.
138
+ swagger | boolean | true | Whether this application should support Swagger/OpenAPI documentation generation.
139
+ swaggerLive | boolean | false | Whether this application should start a live Swagger server in development mode.
140
+ generateMain | boolean | false | Whether to generate the 'main.ts' entry point file.
141
+ healthIndicator | boolean | true | Whether this application should include a health indicator endpoint.
142
+ healthIndicatorList | array | | A list of specific health indicators to include.
143
+ validator | boolean | true | Whether this application should use the NestJS 'ValidationPipe'.
144
+ platform | string | express | The underlying HTTP server platform to use.
145
+ port | number | | The default port number for the application server.
146
146
  apiPrefix | | |
147
- pluginBuildInfoOptions | object | |
148
- pluginDockerOptions | object | |
149
- sentryDsn | string | | Default sentry dsn
150
- overwrite | boolean | false | Whether to overwrite existing files
151
- jwt | boolean | false | Whether the application should use jwt
152
- openApi | boolean | false | Whether the application should use openApi as client
153
- skipProjects | boolean | false | Whether to skip executing project specific initialization
154
- apiConfigurationFile | string | | The api configuration file to use
155
- standalone | boolean | false | Whether the nest service should be standalone
156
- typeorm | string | none |
157
- bootstrap | string | monolithic |
158
- transport | string | none | The transport to use for microservices communication
159
- minio | boolean | false | Whether the application should use minio
160
- openai | boolean | false | Whether the application should use openai
147
+ pluginBuildInfoOptions | object | | Options for the build-info plugin.
148
+ pluginDockerOptions | object | | Options for the Docker plugin.
149
+ sentryDsn | string | | The default Sentry DSN for error reporting.
150
+ overwrite | boolean | false | Whether to overwrite existing files during initialization.
151
+ jwt | boolean | false | Whether the application should use JWT authentication.
152
+ openApi | boolean | false | Whether the application should use an OpenAPI client.
153
+ skipProjects | boolean | false | Whether to skip executing project-specific initialization logic.
154
+ apiConfigurationFile | string | | The path to the API configuration file.
155
+ standalone | boolean | false | Whether the NestJS application should be a standalone application.
156
+ typeorm | string | none | The TypeORM database driver to use.
157
+ bootstrap | string | monolithic | The type of application bootstrap to use.
158
+ transport | string | none | The transport mechanism to use for microservices communication.
159
+ minio | boolean | false | Whether the application should use Minio for object storage.
160
+ openai | boolean | false | Whether the application should use OpenAI integration.
161
161
 
162
162
  ## swagger
163
163
  > swagger generator
@@ -169,8 +169,8 @@ nx g @rxap/plugin-nestjs:swagger
169
169
  Option | Type | Default | Description
170
170
  --- | --- | --- | ---
171
171
  project | string | | The name of the project.
172
- overwrite | boolean | |
173
- standalone | boolean | false | Whether the nest service should be standalone
172
+ overwrite | boolean | false | Whether to overwrite existing files.
173
+ standalone | boolean | false | Whether the NestJS service should be standalone.
174
174
 
175
175
  ## sentry
176
176
  > sentry generator
@@ -182,9 +182,9 @@ nx g @rxap/plugin-nestjs:sentry
182
182
  Option | Type | Default | Description
183
183
  --- | --- | --- | ---
184
184
  project | string | | The name of the project.
185
- dsn | string | | Default sentry dsn
186
- required | boolean | | Whether or not the sentry dsn should be required to start the application
187
- overwrite | boolean | false | Whether to overwrite existing files
185
+ dsn | string | | The default Sentry DSN.
186
+ required | boolean | false | Whether or not the Sentry DSN should be required to start the application.
187
+ overwrite | boolean | false | Whether to overwrite existing files.
188
188
 
189
189
  ## validator
190
190
  > validator generator
@@ -196,7 +196,7 @@ nx g @rxap/plugin-nestjs:validator
196
196
  Option | Type | Default | Description
197
197
  --- | --- | --- | ---
198
198
  project | string | | The name of the project.
199
- overwrite | boolean | |
199
+ overwrite | boolean | false | Whether to overwrite existing files.
200
200
 
201
201
  ## open-api
202
202
  > open-api generator
@@ -207,8 +207,8 @@ nx g @rxap/plugin-nestjs:open-api
207
207
 
208
208
  Option | Type | Default | Description
209
209
  --- | --- | --- | ---
210
- project | string | |
211
- overwrite | boolean | |
210
+ project | string | | The name of the project to add OpenApi support to.
211
+ overwrite | boolean | false | Whether to overwrite existing files.
212
212
 
213
213
  ## jwt
214
214
  > jwt generator
@@ -219,8 +219,8 @@ nx g @rxap/plugin-nestjs:jwt
219
219
 
220
220
  Option | Type | Default | Description
221
221
  --- | --- | --- | ---
222
- project | string | |
223
- overwrite | boolean | |
222
+ project | string | | The name of the project to add JWT support to.
223
+ overwrite | boolean | false | Whether to overwrite existing files.
224
224
 
225
225
  ## health-indicator
226
226
  > health-indicator generator
@@ -231,9 +231,9 @@ nx g @rxap/plugin-nestjs:health-indicator
231
231
 
232
232
  Option | Type | Default | Description
233
233
  --- | --- | --- | ---
234
- name | string | | The name of the health indicator class
234
+ name | string | | The name of the health indicator class.
235
235
  project | string | | The name of the project.
236
- overwrite | boolean | |
236
+ overwrite | boolean | false | Whether to overwrite existing files.
237
237
 
238
238
  ## health-indicator-init
239
239
  > health-indicator-init generator
@@ -245,7 +245,7 @@ nx g @rxap/plugin-nestjs:health-indicator-init
245
245
  Option | Type | Default | Description
246
246
  --- | --- | --- | ---
247
247
  project | string | | The name of the project.
248
- overwrite | boolean | |
248
+ overwrite | boolean | false | Whether to overwrite existing files.
249
249
 
250
250
  ## microservice
251
251
  > microservice generator
@@ -256,25 +256,25 @@ nx g @rxap/plugin-nestjs:microservice
256
256
 
257
257
  Option | Type | Default | Description
258
258
  --- | --- | --- | ---
259
- name | string | | The name of microservice
260
- directory | string | | The directory to create the microservice in
261
- sentry | boolean | true | Whether this service should use sentry
262
- skipFormat | boolean | false |
263
- swagger | boolean | true | Whether this service should use swagger
259
+ name | string | | The name of the microservice.
260
+ directory | string | | The directory where the microservice will be created.
261
+ sentry | boolean | true | Whether this microservice should use Sentry for error tracking.
262
+ skipFormat | boolean | false | Whether to skip formatting the generated files.
263
+ swagger | boolean | true | Whether this microservice should use Swagger/OpenAPI for documentation.
264
264
  swaggerLive | boolean | false | Whether this service should start a swagger live server
265
- generateMain | boolean | | Whether the main file should be generated
266
- healthIndicator | boolean | true | Whether this service should use a health indicator
267
- healthIndicatorList | array | | A list of health indicators
268
- validator | boolean | true | Whether this service use the ValidationPipe
265
+ generateMain | boolean | true | Whether the main entry point file (`main.ts`) should be generated.
266
+ healthIndicator | boolean | true | Whether this microservice should include a health indicator endpoint.
267
+ healthIndicatorList | array | | A list of additional health indicators to include.
268
+ validator | boolean | true | Whether this microservice should use the NestJS `ValidationPipe`.
269
269
  platform | string | express |
270
- port | number | | The default port where the server is listens
270
+ port | number | | The default port number where the server will listen.
271
271
  apiPrefix | | |
272
- sentryDsn | string | | Default sentry dsn
273
- overwrite | boolean | false | Whether to overwrite existing files
274
- jwt | boolean | false | Whether the application should use jwt
275
- openApi | boolean | false | Whether the application should use openApi as client
276
- apiConfigurationFile | string | | The api configuration file to use
277
- standalone | boolean | false | Whether the nest service should be standalone
272
+ sentryDsn | string | | The default Sentry DSN for error tracking.
273
+ overwrite | boolean | false | Whether to overwrite existing files, if any.
274
+ jwt | boolean | false | Whether the microservice should use JWT for authentication.
275
+ openApi | boolean | false | Whether the microservice should use an OpenAPI client.
276
+ apiConfigurationFile | string | | The path to the API configuration file.
277
+ standalone | boolean | false | Whether the NestJS service should be standalone (without a module).
278
278
 
279
279
  ## feature-microservice
280
280
  > feature-microservice generator
@@ -285,23 +285,23 @@ nx g @rxap/plugin-nestjs:feature-microservice
285
285
 
286
286
  Option | Type | Default | Description
287
287
  --- | --- | --- | ---
288
- feature | string | | The feature of the frontend project
289
- sentry | boolean | true | Whether this service should use sentry
290
- skipFormat | boolean | false |
291
- swagger | boolean | true | Whether this service should use swagger
292
- swaggerLive | boolean | false | Whether this service should start a swagger live server
293
- generateMain | boolean | | Whether the main file should be generated
294
- healthIndicator | boolean | true | Whether this service should use a health indicator
295
- healthIndicatorList | array | | A list of health indicators
296
- validator | boolean | true | Whether this service use the ValidationPipe
297
- platform | string | express |
298
- port | number | | The default port where the server is listens
299
- sentryDsn | string | | Default sentry dsn
300
- overwrite | boolean | false | Whether to overwrite existing files
301
- jwt | boolean | false | Whether the application should use jwt
302
- openApi | boolean | false | Whether the application should use openApi as client
303
- apiConfigurationFile | string | | The api configuration file to use
304
- standalone | boolean | false | Whether the nest service should be standalone
288
+ feature | string | | The name of the frontend feature project.
289
+ sentry | boolean | true | Whether this service should use Sentry for error tracking.
290
+ skipFormat | boolean | false | Whether to skip formatting files with Prettier after generation.
291
+ swagger | boolean | true | Whether this service should support Swagger/OpenAPI documentation generation.
292
+ swaggerLive | boolean | false | Whether this service should start a live Swagger server in development mode.
293
+ generateMain | boolean | false | Whether to generate the 'main.ts' entry point file.
294
+ healthIndicator | boolean | true | Whether this service should include a health indicator endpoint.
295
+ healthIndicatorList | array | | A list of specific health indicators to include.
296
+ validator | boolean | true | Whether this service should use the NestJS 'ValidationPipe'.
297
+ platform | string | express | The underlying HTTP server platform to use.
298
+ port | number | | The default port number for the microservice server.
299
+ sentryDsn | string | | The default Sentry DSN for error reporting.
300
+ overwrite | boolean | false | Whether to overwrite existing files during generation.
301
+ jwt | boolean | false | Whether the application should use JWT authentication.
302
+ openApi | boolean | false | Whether the application should use an OpenAPI client.
303
+ apiConfigurationFile | string | | The path to the API configuration file.
304
+ standalone | boolean | false | Whether the NestJS service should be a standalone application (not part of a larger monorepo structure).
305
305
 
306
306
  ## frontend-microservice
307
307
  > frontend-microservice generator
@@ -312,24 +312,24 @@ nx g @rxap/plugin-nestjs:frontend-microservice
312
312
 
313
313
  Option | Type | Default | Description
314
314
  --- | --- | --- | ---
315
- frontend | string | | The name of frontend project
316
- feature | string | | The feature of the frontend project
317
- sentry | boolean | true | Whether this service should use sentry
318
- skipFormat | boolean | false |
319
- swagger | boolean | true | Whether this service should use swagger
320
- swaggerLive | boolean | false | Whether this service should start a swagger live server
321
- generateMain | boolean | | Whether the main file should be generated
322
- healthIndicator | boolean | true | Whether this service should use a health indicator
323
- healthIndicatorList | array | | A list of health indicators
324
- validator | boolean | true | Whether this service use the ValidationPipe
325
- platform | string | express |
326
- port | number | | The default port where the server is listens
327
- sentryDsn | string | | Default sentry dsn
328
- overwrite | boolean | false | Whether to overwrite existing files
329
- jwt | boolean | false | Whether the application should use jwt
330
- openApi | boolean | false | Whether the application should use openApi as client
331
- apiConfigurationFile | string | | The api configuration file to use
332
- standalone | boolean | false | Whether the nest service should be standalone
315
+ frontend | string | | The name of the frontend project.
316
+ feature | string | | The name of the frontend feature project.
317
+ sentry | boolean | true | Whether this service should use Sentry for error tracking.
318
+ skipFormat | boolean | false | Whether to skip formatting files with Prettier after generation.
319
+ swagger | boolean | true | Whether this service should support Swagger/OpenAPI documentation generation.
320
+ swaggerLive | boolean | false | Whether this service should start a live Swagger server in development mode.
321
+ generateMain | boolean | false | Whether to generate the 'main.ts' entry point file.
322
+ healthIndicator | boolean | true | Whether this service should include a health indicator endpoint.
323
+ healthIndicatorList | array | | A list of specific health indicators to include.
324
+ validator | boolean | true | Whether this service should use the NestJS 'ValidationPipe'.
325
+ platform | string | express | The underlying HTTP server platform to use.
326
+ port | number | | The default port number for the microservice server.
327
+ sentryDsn | string | | The default Sentry DSN for error reporting.
328
+ overwrite | boolean | false | Whether to overwrite existing files during generation.
329
+ jwt | boolean | false | Whether the application should use JWT authentication.
330
+ openApi | boolean | false | Whether the application should use an OpenAPI client.
331
+ apiConfigurationFile | string | | The path to the API configuration file.
332
+ standalone | boolean | false | Whether the NestJS service should be a standalone application (not part of a larger monorepo structure).
333
333
 
334
334
  ## dynamic-configuration-module
335
335
  > Extends the module with the dynamic configuration module pattern
@@ -340,10 +340,10 @@ nx g @rxap/plugin-nestjs:dynamic-configuration-module
340
340
 
341
341
  Option | Type | Default | Description
342
342
  --- | --- | --- | ---
343
- project | string | |
344
- overwrite | boolean | |
345
- name | string | | name of the module. defaults to the project name
346
- isGlobal | boolean | true |
343
+ project | string | | The name of the project to add the dynamic configuration module to.
344
+ overwrite | boolean | false | Whether to overwrite existing files.
345
+ name | string | | The name of the module. Defaults to the project name.
346
+ isGlobal | boolean | true | Whether the configuration module should be registered globally.
347
347
  # Executors
348
348
 
349
349
  ## package-json
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "20.2.0-dev.8",
2
+ "version": "20.2.0",
3
3
  "name": "@rxap/plugin-nestjs",
4
4
  "description": "This npm package provides generators and executors for NestJS applications within an Nx workspace. It helps streamline the setup of NestJS projects with features like Swagger, Sentry, health indicators, and standardized configurations. It also includes executors for generating package.json files and Swagger documentation.\n",
5
5
  "license": "GPL-3.0-or-later",
@@ -7,15 +7,15 @@
7
7
  "@nx/devkit": "20.5.0",
8
8
  "@nx/js": "20.5.0",
9
9
  "@nx/nest": "20.5.0",
10
- "@rxap/node-utilities": "^1.3.11-dev.2",
11
- "@rxap/plugin-application": "^20.0.5-dev.2",
12
- "@rxap/plugin-library": "^20.2.2-dev.3",
13
- "@rxap/plugin-open-api": "^20.1.1-dev.8",
14
- "@rxap/plugin-utilities": "^20.0.5-dev.2",
15
- "@rxap/ts-morph": "^1.6.0-dev.2",
16
- "@rxap/utilities": "^16.5.0-dev.0",
17
- "@rxap/workspace-ts-morph": "^19.1.13-dev.3",
18
- "@rxap/workspace-utilities": "^19.8.1-dev.2",
10
+ "@rxap/node-utilities": "^1.3.11",
11
+ "@rxap/plugin-application": "^20.1.0",
12
+ "@rxap/plugin-library": "^20.3.0",
13
+ "@rxap/plugin-open-api": "^20.2.0",
14
+ "@rxap/plugin-utilities": "^20.0.5",
15
+ "@rxap/ts-morph": "^1.6.0",
16
+ "@rxap/utilities": "^16.5.0",
17
+ "@rxap/workspace-ts-morph": "^19.1.13",
18
+ "@rxap/workspace-utilities": "^19.9.0",
19
19
  "colors": "1.4.0",
20
20
  "semver": "7.5.3",
21
21
  "ts-morph": "18.0.0",
@@ -55,7 +55,7 @@
55
55
  },
56
56
  "schematics": "./generators.json",
57
57
  "type": "commonjs",
58
- "gitHead": "1772afc9dec522bb394704aadd91d2ec1b80802b",
58
+ "gitHead": "36b0e9732b24717840935712e316593ff6aba795",
59
59
  "exports": {
60
60
  "./package.json": "./package.json",
61
61
  ".": {
@@ -15,9 +15,9 @@ export const {
15
15
  .build();
16
16
 
17
17
  @Module({
18
- controllers: [],
19
- providers: [],
20
- exports: [],
18
+ controllers: [],
19
+ providers: [],
20
+ exports: [],
21
21
  })
22
22
  @Global()
23
23
  export class TestModule extends ConfigurableModuleClass {
@@ -112,9 +112,9 @@ export const {
112
112
  .build();
113
113
 
114
114
  @Module({
115
- controllers: [],
116
- providers: [],
117
- exports: [],
115
+ controllers: [],
116
+ providers: [],
117
+ exports: [],
118
118
  })
119
119
  export class TestModule extends ConfigurableModuleClass {
120
120
  static register(options: typeof OPTIONS_TYPE): DynamicModule {
@@ -31,7 +31,7 @@ function dynamicConfigurationModuleGenerator(tree, options) {
31
31
  (0, coerce_validation_schema_function_1.coerceValidationSchemaFunction)(project, moduleName);
32
32
  (0, coerce_options_factory_1.coerceOptionsFactory)(project, moduleName);
33
33
  (0, coerce_options_interface_1.coerceOptionsInterface)(project, moduleName);
34
- (0, workspace_ts_morph_1.ApplyTsMorphProject)(tree, project, projectLibSourceRoot);
34
+ yield (0, workspace_ts_morph_1.ApplyTsMorphProject)(tree, project, projectLibSourceRoot);
35
35
  yield (0, plugin_library_1.LibraryIndexExportGenerator)(tree, {
36
36
  project: options.project,
37
37
  generateRootExport: true,
@@ -1 +1 @@
1
- {"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/nestjs/src/generators/dynamic-configuration-module/generator.ts"],"names":[],"mappings":";;AAiBA,kFA0BC;;AA1CD,6CAA+C;AAC/C,iEAGkC;AAClC,mEAAiE;AACjE,+BAA4B;AAC5B,mEAA8D;AAC9D,+FAAwF;AACxF,qEAAgE;AAChE,yEAAoE;AACpE,2FAAqF;AACrF,yDAAoD;AAEpD,yDAAiE;AAEjE,SAAsB,mCAAmC,CACvD,IAAU,EACV,OAAkD;;;QAElD,MAAM,OAAO,GAAG,IAAA,wBAAa,GAAE,CAAC;QAChC,MAAM,iBAAiB,GAAG,IAAA,0CAAoB,EAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACtE,MAAM,oBAAoB,GAAG,IAAA,WAAI,EAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;QAC5D,IAAA,2BAAM,EAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAC;QAC5C,IAAI,UAAU,GAAG,MAAA,OAAO,CAAC,IAAI,mCAAI,OAAO,CAAC,OAAO,CAAC;QACjD,MAAM,gBAAgB,GAAG,IAAA,iCAAc,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAC7D,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,kDAAmD,OAAO,CAAC,OAAQ,EAAE,CAAC,CAAC;QACzF,CAAC;QACD,MAAM,WAAW,GAAG,IAAA,2CAAmB,EAAC,gBAAgB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC5E,UAAU,GAAG,WAAW,CAAC,OAAO,EAAG,CAAC;QACpC,IAAA,qEAA+B,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACrD,IAAA,kEAA8B,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACpD,IAAA,6CAAoB,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAC1C,IAAA,iDAAsB,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAE5C,IAAA,wCAAmB,EAAC,IAAI,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC;QAEzD,MAAM,IAAA,4CAA2B,EAAC,IAAI,EAAE;YACtC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,kBAAkB,EAAE,IAAI;SACzB,CAAC,CAAC;IACL,CAAC;CAAA;AAED,kBAAe,mCAAmC,CAAC"}
1
+ {"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/nestjs/src/generators/dynamic-configuration-module/generator.ts"],"names":[],"mappings":";;AAiBA,kFA0BC;;AA1CD,6CAA+C;AAC/C,iEAGkC;AAClC,mEAAiE;AACjE,+BAA4B;AAC5B,mEAA8D;AAC9D,+FAAwF;AACxF,qEAAgE;AAChE,yEAAoE;AACpE,2FAAqF;AACrF,yDAAoD;AAEpD,yDAAiE;AAEjE,SAAsB,mCAAmC,CACvD,IAAU,EACV,OAAkD;;;QAElD,MAAM,OAAO,GAAG,IAAA,wBAAa,GAAE,CAAC;QAChC,MAAM,iBAAiB,GAAG,IAAA,0CAAoB,EAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACtE,MAAM,oBAAoB,GAAG,IAAA,WAAI,EAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;QAC5D,IAAA,2BAAM,EAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAC;QAC5C,IAAI,UAAU,GAAG,MAAA,OAAO,CAAC,IAAI,mCAAI,OAAO,CAAC,OAAO,CAAC;QACjD,MAAM,gBAAgB,GAAG,IAAA,iCAAc,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAC7D,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,kDAAmD,OAAO,CAAC,OAAQ,EAAE,CAAC,CAAC;QACzF,CAAC;QACD,MAAM,WAAW,GAAG,IAAA,2CAAmB,EAAC,gBAAgB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC5E,UAAU,GAAG,WAAW,CAAC,OAAO,EAAG,CAAC;QACpC,IAAA,qEAA+B,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACrD,IAAA,kEAA8B,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACpD,IAAA,6CAAoB,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAC1C,IAAA,iDAAsB,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAE5C,MAAM,IAAA,wCAAmB,EAAC,IAAI,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC;QAE/D,MAAM,IAAA,4CAA2B,EAAC,IAAI,EAAE;YACtC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,kBAAkB,EAAE,IAAI;SACzB,CAAC,CAAC;IACL,CAAC;CAAA;AAED,kBAAe,mCAAmC,CAAC"}
@@ -6,18 +6,23 @@
6
6
  "properties": {
7
7
  "project": {
8
8
  "type": "string",
9
- "description": ""
9
+ "description": "The name of the project to add the dynamic configuration module to.",
10
+ "examples": ["my-api"]
10
11
  },
11
12
  "overwrite": {
12
- "type": "boolean"
13
+ "type": "boolean",
14
+ "description": "Whether to overwrite existing files.",
15
+ "default": false
13
16
  },
14
17
  "name": {
15
18
  "type": "string",
16
- "description": "name of the module. defaults to the project name"
19
+ "description": "The name of the module. Defaults to the project name.",
20
+ "examples": ["AppConfig"]
17
21
  },
18
22
  "isGlobal": {
19
23
  "type": "boolean",
20
- "default": true
24
+ "default": true,
25
+ "description": "Whether the configuration module should be registered globally."
21
26
  }
22
27
  },
23
28
  "required": ["project"]
@@ -6,39 +6,41 @@
6
6
  "properties": {
7
7
  "feature": {
8
8
  "type": "string",
9
- "description": "The feature of the frontend project",
10
- "x-prompt": "For which feature of the frontend should the microservice be created?"
9
+ "description": "The name of the frontend feature project.",
10
+ "x-prompt": "For which feature of the frontend should the microservice be created?",
11
+ "examples": ["user-profile"]
11
12
  },
12
-
13
13
  "sentry": {
14
14
  "type": "boolean",
15
15
  "default": true,
16
- "description": "Whether this service should use sentry",
16
+ "description": "Whether this service should use Sentry for error tracking.",
17
17
  "x-prompt": "Should this service use sentry?"
18
18
  },
19
19
  "skipFormat": {
20
20
  "type": "boolean",
21
- "default": false
21
+ "default": false,
22
+ "description": "Whether to skip formatting files with Prettier after generation."
22
23
  },
23
24
  "swagger": {
24
25
  "type": "boolean",
25
26
  "default": true,
26
- "description": "Whether this service should use swagger",
27
+ "description": "Whether this service should support Swagger/OpenAPI documentation generation.",
27
28
  "x-prompt": "Should this service support open-api config generation?"
28
29
  },
29
30
  "swaggerLive": {
30
31
  "type": "boolean",
31
32
  "default": false,
32
- "description": "Whether this service should start a swagger live server"
33
+ "description": "Whether this service should start a live Swagger server in development mode."
33
34
  },
34
35
  "generateMain": {
35
36
  "type": "boolean",
36
- "description": "Whether the main file should be generated"
37
+ "description": "Whether to generate the 'main.ts' entry point file.",
38
+ "default": false
37
39
  },
38
40
  "healthIndicator": {
39
41
  "type": "boolean",
40
42
  "default": true,
41
- "description": "Whether this service should use a health indicator",
43
+ "description": "Whether this service should include a health indicator endpoint.",
42
44
  "x-prompt": "Should this service have a health indicator endpoint?"
43
45
  },
44
46
  "healthIndicatorList": {
@@ -46,12 +48,13 @@
46
48
  "items": {
47
49
  "type": "string"
48
50
  },
49
- "description": "A list of health indicators"
51
+ "description": "A list of specific health indicators to include.",
52
+ "examples": [["memory_heap", "memory_rss"]]
50
53
  },
51
54
  "validator": {
52
55
  "type": "boolean",
53
56
  "default": true,
54
- "description": "Whether this service use the ValidationPipe",
57
+ "description": "Whether this service should use the NestJS 'ValidationPipe'.",
55
58
  "x-prompt": "Should this service use the ValidationPipe?"
56
59
  },
57
60
  "platform": {
@@ -61,41 +64,45 @@
61
64
  "fastify"
62
65
  ],
63
66
  "default": "express",
67
+ "description": "The underlying HTTP server platform to use.",
64
68
  "x-prompt": "Whichever platform should be used?"
65
69
  },
66
70
  "port": {
67
71
  "type": "number",
68
- "description": "The default port where the server is listens"
72
+ "description": "The default port number for the microservice server.",
73
+ "examples": [3000]
69
74
  },
70
75
  "sentryDsn": {
71
76
  "type": "string",
72
- "description": "Default sentry dsn"
77
+ "description": "The default Sentry DSN for error reporting.",
78
+ "examples": ["https://examplePublicKey@o0.ingest.sentry.io/0"]
73
79
  },
74
80
  "overwrite": {
75
81
  "type": "boolean",
76
82
  "default": false,
77
- "description": "Whether to overwrite existing files"
83
+ "description": "Whether to overwrite existing files during generation."
78
84
  },
79
85
  "jwt": {
80
86
  "type": "boolean",
81
87
  "default": false,
82
- "description": "Whether the application should use jwt",
88
+ "description": "Whether the application should use JWT authentication.",
83
89
  "x-prompt": "Should this service use jwt?"
84
90
  },
85
91
  "openApi": {
86
92
  "type": "boolean",
87
93
  "default": false,
88
- "description": "Whether the application should use openApi as client",
94
+ "description": "Whether the application should use an OpenAPI client.",
89
95
  "x-prompt": "Should this service use an open api client?"
90
96
  },
91
97
  "apiConfigurationFile": {
92
98
  "type": "string",
93
- "description": "The api configuration file to use"
99
+ "description": "The path to the API configuration file.",
100
+ "examples": ["apps/my-app/src/api-config.json"]
94
101
  },
95
102
  "standalone": {
96
103
  "type": "boolean",
97
104
  "default": false,
98
- "description": "Whether the nest service should be standalone"
105
+ "description": "Whether the NestJS service should be a standalone application (not part of a larger monorepo structure)."
99
106
  }
100
107
  },
101
108
  "required": [