@rxap/plugin-nestjs 20.1.1 → 20.1.2-dev.1

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 (3) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +190 -128
  3. package/package.json +8 -8
package/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
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.1.2-dev.1](https://gitlab.com/rxap/packages/compare/@rxap/plugin-nestjs@20.1.2-dev.0...@rxap/plugin-nestjs@20.1.2-dev.1) (2025-02-17)
7
+
8
+ **Note:** Version bump only for package @rxap/plugin-nestjs
9
+
10
+ ## [20.1.2-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-nestjs@20.1.1...@rxap/plugin-nestjs@20.1.2-dev.0) (2025-02-17)
11
+
12
+ **Note:** Version bump only for package @rxap/plugin-nestjs
13
+
6
14
  ## [20.1.1](https://gitlab.com/rxap/packages/compare/@rxap/plugin-nestjs@20.1.0...@rxap/plugin-nestjs@20.1.1) (2025-02-13)
7
15
 
8
16
  **Note:** Version bump only for package @rxap/plugin-nestjs
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @rxap/plugin-nestjs
1
+ 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.
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/@rxap/plugin-nestjs?style=flat-square)](https://www.npmjs.com/package/@rxap/plugin-nestjs)
4
4
  [![commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](https://commitizen.github.io/cz-cli/)
@@ -10,7 +10,22 @@
10
10
  - [Installation](#installation)
11
11
  - [Guides](#guides)
12
12
  - [Generators](#generators)
13
+ - [init](#init)
14
+ - [init-library](#init-library)
15
+ - [init-application](#init-application)
16
+ - [swagger](#swagger)
17
+ - [sentry](#sentry)
18
+ - [validator](#validator)
19
+ - [open-api](#open-api)
20
+ - [jwt](#jwt)
21
+ - [health-indicator](#health-indicator)
22
+ - [health-indicator-init](#health-indicator-init)
23
+ - [microservice](#microservice)
24
+ - [feature-microservice](#feature-microservice)
25
+ - [frontend-microservice](#frontend-microservice)
13
26
  - [Executors](#executors)
27
+ - [package-json](#package-json)
28
+ - [swagger-generate](#swagger-generate)
14
29
 
15
30
  # Installation
16
31
 
@@ -79,210 +94,257 @@ nx g @rxap/plugin-nestjs:feature-microservice --feature $FEATURE --frontend $PRO
79
94
  > init generator
80
95
 
81
96
  ```bash
82
- yarn nx g @rxap/plugin-nestjs:init
83
- ```
84
-
85
- ## init-library
86
- > init-library generator
87
-
88
- ```bash
89
- yarn nx g @rxap/plugin-nestjs:init-library
90
- ```
91
-
92
- ## init-application
93
- > init-application generator
94
-
95
- ```bash
96
- yarn nx g @rxap/plugin-nestjs:init-application
97
- ```
98
-
99
- ## swagger
100
- > swagger generator
101
-
102
- ```bash
103
- yarn nx g @rxap/plugin-nestjs:swagger
104
- ```
105
-
106
- ## sentry
107
- > sentry generator
108
-
109
- ```bash
110
- yarn nx g @rxap/plugin-nestjs:sentry
111
- ```
112
-
113
- ## validator
114
- > validator generator
115
-
116
- ```bash
117
- yarn nx g @rxap/plugin-nestjs:validator
118
- ```
119
-
120
- ## open-api
121
- > open-api generator
122
-
123
- ```bash
124
- yarn nx g @rxap/plugin-nestjs:open-api
125
- ```
126
-
127
- ## jwt
128
- > jwt generator
129
-
130
- ```bash
131
- yarn nx g @rxap/plugin-nestjs:jwt
97
+ nx g @rxap/plugin-nestjs:init
132
98
  ```
133
99
 
134
- ## health-indicator
135
- > health-indicator generator
136
-
137
- ```bash
138
- yarn nx g @rxap/plugin-nestjs:health-indicator
139
- ```
140
-
141
- ## health-indicator-init
142
- > health-indicator-init generator
143
-
144
- ```bash
145
- yarn nx g @rxap/plugin-nestjs:health-indicator-init
146
- ```
147
-
148
- ## microservice
149
- > microservice generator
150
-
151
- ```bash
152
- yarn nx g @rxap/plugin-nestjs:microservice
153
- ```
154
-
155
- ## feature-microservice
156
- > feature-microservice generator
157
-
158
- ```bash
159
- yarn nx g @rxap/plugin-nestjs:feature-microservice
160
- ```
161
-
162
- ## frontend-microservice
163
- > frontend-microservice generator
164
-
165
- ```bash
166
- yarn nx g @rxap/plugin-nestjs:frontend-microservice
167
- ```
168
-
169
- ## init
170
- > init generator
171
-
172
- ```bash
173
- yarn nx g @rxap/plugin-nestjs:init
174
- ```
100
+ Option | Type | Default | Description
101
+ --- | --- | --- | ---
102
+ project | string | |
103
+ projects | array | |
104
+ skipFormat | boolean | false |
105
+ overwrite | boolean | false | Whether to overwrite existing files
106
+ skipProjects | boolean | false | Whether to skip executing project specific initialization
175
107
 
176
108
  ## init-library
177
109
  > init-library generator
178
110
 
179
111
  ```bash
180
- yarn nx g @rxap/plugin-nestjs:init-library
112
+ nx g @rxap/plugin-nestjs:init-library
181
113
  ```
182
114
 
115
+ Option | Type | Default | Description
116
+ --- | --- | --- | ---
117
+ project | string | |
118
+ projects | array | |
119
+ overwrite | boolean | false | Whether to overwrite existing files
120
+ skipFormat | boolean | false |
121
+ skipProjects | boolean | false | Whether to skip executing project specific initialization
122
+ targets | object | |
123
+
183
124
  ## init-application
184
125
  > init-application generator
185
126
 
186
127
  ```bash
187
- yarn nx g @rxap/plugin-nestjs:init-application
188
- ```
128
+ nx g @rxap/plugin-nestjs:init-application
129
+ ```
130
+
131
+ Option | Type | Default | Description
132
+ --- | --- | --- | ---
133
+ project | string | |
134
+ projects | array | |
135
+ sentry | boolean | true | Whether this service should use sentry
136
+ skipFormat | boolean | false |
137
+ swagger | boolean | true | Whether this service should use swagger
138
+ swaggerLive | boolean | false | Whether this service should start a swagger live server
139
+ generateMain | boolean | false | Whether the main file should be generated
140
+ healthIndicator | boolean | true | Whether this service should use a health indicator
141
+ healthIndicatorList | array | | A list of health indicators
142
+ validator | boolean | true | Whether this service use the ValidationPipe
143
+ platform | string | express |
144
+ port | number | | The default port where the server is listens
145
+ apiPrefix | | |
146
+ pluginBuildInfoOptions | object | |
147
+ pluginDockerOptions | object | |
148
+ sentryDsn | string | | Default sentry dsn
149
+ overwrite | boolean | false | Whether to overwrite existing files
150
+ jwt | boolean | false | Whether the application should use jwt
151
+ openApi | boolean | false | Whether the application should use openApi as client
152
+ skipProjects | boolean | false | Whether to skip executing project specific initialization
153
+ apiConfigurationFile | string | | The api configuration file to use
154
+ standalone | boolean | false | Whether the nest service should be standalone
155
+ typeorm | string | none |
156
+ bootstrap | string | monolithic |
157
+ transport | string | none | The transport to use for microservices communication
158
+ minio | boolean | false | Whether the application should use minio
159
+ openai | boolean | false | Whether the application should use openai
189
160
 
190
161
  ## swagger
191
162
  > swagger generator
192
163
 
193
164
  ```bash
194
- yarn nx g @rxap/plugin-nestjs:swagger
165
+ nx g @rxap/plugin-nestjs:swagger
195
166
  ```
196
167
 
168
+ Option | Type | Default | Description
169
+ --- | --- | --- | ---
170
+ project | string | | The name of the project.
171
+ overwrite | boolean | |
172
+ standalone | boolean | false | Whether the nest service should be standalone
173
+
197
174
  ## sentry
198
175
  > sentry generator
199
176
 
200
177
  ```bash
201
- yarn nx g @rxap/plugin-nestjs:sentry
178
+ nx g @rxap/plugin-nestjs:sentry
202
179
  ```
203
180
 
181
+ Option | Type | Default | Description
182
+ --- | --- | --- | ---
183
+ project | string | | The name of the project.
184
+ dsn | string | | Default sentry dsn
185
+ required | boolean | | Whether or not the sentry dsn should be required to start the application
186
+ overwrite | boolean | false | Whether to overwrite existing files
187
+
204
188
  ## validator
205
189
  > validator generator
206
190
 
207
191
  ```bash
208
- yarn nx g @rxap/plugin-nestjs:validator
192
+ nx g @rxap/plugin-nestjs:validator
209
193
  ```
210
194
 
195
+ Option | Type | Default | Description
196
+ --- | --- | --- | ---
197
+ project | string | | The name of the project.
198
+ overwrite | boolean | |
199
+
211
200
  ## open-api
212
201
  > open-api generator
213
202
 
214
203
  ```bash
215
- yarn nx g @rxap/plugin-nestjs:open-api
204
+ nx g @rxap/plugin-nestjs:open-api
216
205
  ```
217
206
 
207
+ Option | Type | Default | Description
208
+ --- | --- | --- | ---
209
+ project | string | |
210
+ overwrite | boolean | |
211
+
218
212
  ## jwt
219
213
  > jwt generator
220
214
 
221
215
  ```bash
222
- yarn nx g @rxap/plugin-nestjs:jwt
216
+ nx g @rxap/plugin-nestjs:jwt
223
217
  ```
224
218
 
219
+ Option | Type | Default | Description
220
+ --- | --- | --- | ---
221
+ project | string | |
222
+ overwrite | boolean | |
223
+
225
224
  ## health-indicator
226
225
  > health-indicator generator
227
226
 
228
227
  ```bash
229
- yarn nx g @rxap/plugin-nestjs:health-indicator
228
+ nx g @rxap/plugin-nestjs:health-indicator
230
229
  ```
231
230
 
231
+ Option | Type | Default | Description
232
+ --- | --- | --- | ---
233
+ name | string | | The name of the health indicator class
234
+ project | string | | The name of the project.
235
+ overwrite | boolean | |
236
+
232
237
  ## health-indicator-init
233
238
  > health-indicator-init generator
234
239
 
235
240
  ```bash
236
- yarn nx g @rxap/plugin-nestjs:health-indicator-init
241
+ nx g @rxap/plugin-nestjs:health-indicator-init
237
242
  ```
238
243
 
244
+ Option | Type | Default | Description
245
+ --- | --- | --- | ---
246
+ project | string | | The name of the project.
247
+ overwrite | boolean | |
248
+
239
249
  ## microservice
240
250
  > microservice generator
241
251
 
242
252
  ```bash
243
- yarn nx g @rxap/plugin-nestjs:microservice
244
- ```
253
+ nx g @rxap/plugin-nestjs:microservice
254
+ ```
255
+
256
+ Option | Type | Default | Description
257
+ --- | --- | --- | ---
258
+ name | string | | The name of microservice
259
+ directory | string | | The directory to create the microservice in
260
+ sentry | boolean | true | Whether this service should use sentry
261
+ skipFormat | boolean | false |
262
+ swagger | boolean | true | Whether this service should use swagger
263
+ swaggerLive | boolean | false | Whether this service should start a swagger live server
264
+ generateMain | boolean | | Whether the main file should be generated
265
+ healthIndicator | boolean | true | Whether this service should use a health indicator
266
+ healthIndicatorList | array | | A list of health indicators
267
+ validator | boolean | true | Whether this service use the ValidationPipe
268
+ platform | string | express |
269
+ port | number | | The default port where the server is listens
270
+ apiPrefix | | |
271
+ sentryDsn | string | | Default sentry dsn
272
+ overwrite | boolean | false | Whether to overwrite existing files
273
+ jwt | boolean | false | Whether the application should use jwt
274
+ openApi | boolean | false | Whether the application should use openApi as client
275
+ apiConfigurationFile | string | | The api configuration file to use
276
+ standalone | boolean | false | Whether the nest service should be standalone
245
277
 
246
278
  ## feature-microservice
247
279
  > feature-microservice generator
248
280
 
249
281
  ```bash
250
- yarn nx g @rxap/plugin-nestjs:feature-microservice
251
- ```
282
+ nx g @rxap/plugin-nestjs:feature-microservice
283
+ ```
284
+
285
+ Option | Type | Default | Description
286
+ --- | --- | --- | ---
287
+ feature | string | | The feature of the frontend project
288
+ sentry | boolean | true | Whether this service should use sentry
289
+ skipFormat | boolean | false |
290
+ swagger | boolean | true | Whether this service should use swagger
291
+ swaggerLive | boolean | false | Whether this service should start a swagger live server
292
+ generateMain | boolean | | Whether the main file should be generated
293
+ healthIndicator | boolean | true | Whether this service should use a health indicator
294
+ healthIndicatorList | array | | A list of health indicators
295
+ validator | boolean | true | Whether this service use the ValidationPipe
296
+ platform | string | express |
297
+ port | number | | The default port where the server is listens
298
+ sentryDsn | string | | Default sentry dsn
299
+ overwrite | boolean | false | Whether to overwrite existing files
300
+ jwt | boolean | false | Whether the application should use jwt
301
+ openApi | boolean | false | Whether the application should use openApi as client
302
+ apiConfigurationFile | string | | The api configuration file to use
303
+ standalone | boolean | false | Whether the nest service should be standalone
252
304
 
253
305
  ## frontend-microservice
254
306
  > frontend-microservice generator
255
307
 
256
308
  ```bash
257
- yarn nx g @rxap/plugin-nestjs:frontend-microservice
258
- ```
309
+ nx g @rxap/plugin-nestjs:frontend-microservice
310
+ ```
311
+
312
+ Option | Type | Default | Description
313
+ --- | --- | --- | ---
314
+ frontend | string | | The name of frontend project
315
+ feature | string | | The feature of the frontend project
316
+ sentry | boolean | true | Whether this service should use sentry
317
+ skipFormat | boolean | false |
318
+ swagger | boolean | true | Whether this service should use swagger
319
+ swaggerLive | boolean | false | Whether this service should start a swagger live server
320
+ generateMain | boolean | | Whether the main file should be generated
321
+ healthIndicator | boolean | true | Whether this service should use a health indicator
322
+ healthIndicatorList | array | | A list of health indicators
323
+ validator | boolean | true | Whether this service use the ValidationPipe
324
+ platform | string | express |
325
+ port | number | | The default port where the server is listens
326
+ sentryDsn | string | | Default sentry dsn
327
+ overwrite | boolean | false | Whether to overwrite existing files
328
+ jwt | boolean | false | Whether the application should use jwt
329
+ openApi | boolean | false | Whether the application should use openApi as client
330
+ apiConfigurationFile | string | | The api configuration file to use
331
+ standalone | boolean | false | Whether the nest service should be standalone
259
332
  # Executors
260
333
 
261
334
  ## package-json
262
335
  > package-json executor
263
336
 
264
- **project.json**
265
- ```json
266
- {
267
- "targets": {
268
- "package-json": {
269
- "executor": "@rxap/plugin-nestjs:package-json"
270
- }
271
- }
272
- }
273
- ```
337
+
338
+ Option | Type | Default | Description
339
+ --- | --- | --- | ---
340
+ dependencies | array | |
341
+ includeLocalProjects | boolean | false | Include local projects in the package.json file, if they have a package.json file
274
342
 
275
343
  ## swagger-generate
276
344
  > swagger-generate executor
277
345
 
278
- **project.json**
279
- ```json
280
- {
281
- "targets": {
282
- "swagger-generate": {
283
- "executor": "@rxap/plugin-nestjs:swagger-generate"
284
- }
285
- }
286
- }
287
- ```
346
+
347
+ Option | Type | Default | Description
348
+ --- | --- | --- | ---
349
+ buildTarget | string | |
288
350
 
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "20.1.1",
2
+ "version": "20.1.2-dev.1",
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",
@@ -8,14 +8,14 @@
8
8
  "@nx/js": "20.4.2",
9
9
  "@nx/nest": "20.4.2",
10
10
  "@rxap/node-utilities": "^1.3.8",
11
- "@rxap/plugin-application": "^20.0.1",
12
- "@rxap/plugin-library": "^20.1.1",
13
- "@rxap/plugin-open-api": "^20.0.2",
14
- "@rxap/plugin-utilities": "^20.0.1",
11
+ "@rxap/plugin-application": "^20.0.2-dev.1",
12
+ "@rxap/plugin-library": "^20.1.2-dev.1",
13
+ "@rxap/plugin-open-api": "^20.0.3-dev.1",
14
+ "@rxap/plugin-utilities": "^20.0.2-dev.1",
15
15
  "@rxap/ts-morph": "^1.5.3",
16
16
  "@rxap/utilities": "^16.4.2",
17
- "@rxap/workspace-ts-morph": "^19.1.9",
18
- "@rxap/workspace-utilities": "^19.6.1",
17
+ "@rxap/workspace-ts-morph": "^19.1.10-dev.0",
18
+ "@rxap/workspace-utilities": "^19.6.2-dev.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": "402887412674e616554624b2c11770ca36982b78",
58
+ "gitHead": "0b022b6165e06718ce3edf73ae1d5375f0ff3413",
59
59
  "exports": {
60
60
  "./package.json": "./package.json",
61
61
  ".": {