@mavogel/mvc-projen 0.0.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/API.md ADDED
@@ -0,0 +1,4412 @@
1
+ # API Reference <a name="API Reference" id="api-reference"></a>
2
+
3
+ ## Constructs <a name="Constructs" id="Constructs"></a>
4
+
5
+ ### MvcCdkConstructLibrary <a name="MvcCdkConstructLibrary" id="@mavogel/mvc-projen.MvcCdkConstructLibrary"></a>
6
+
7
+ TypeScript library.
8
+
9
+ #### Initializers <a name="Initializers" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.Initializer"></a>
10
+
11
+ ```typescript
12
+ import { MvcCdkConstructLibrary } from '@mavogel/mvc-projen'
13
+
14
+ new MvcCdkConstructLibrary(options: MvcCdkConstructLibraryOptions)
15
+ ```
16
+
17
+ | **Name** | **Type** | **Description** |
18
+ | --- | --- | --- |
19
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.Initializer.parameter.options">options</a></code> | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions">MvcCdkConstructLibraryOptions</a></code> | *No description.* |
20
+
21
+ ---
22
+
23
+ ##### `options`<sup>Required</sup> <a name="options" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.Initializer.parameter.options"></a>
24
+
25
+ - *Type:* <a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions">MvcCdkConstructLibraryOptions</a>
26
+
27
+ ---
28
+
29
+ #### Methods <a name="Methods" id="Methods"></a>
30
+
31
+ | **Name** | **Description** |
32
+ | --- | --- |
33
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.toString">toString</a></code> | Returns a string representation of this construct. |
34
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
35
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
36
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
37
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addTask">addTask</a></code> | Adds a new task to this project. |
38
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
39
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
40
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
41
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
42
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.removeTask">removeTask</a></code> | Removes a task from a project. |
43
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
44
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.synth">synth</a></code> | Synthesize all project files into `outdir`. |
45
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
46
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
47
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
48
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
49
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addBins">addBins</a></code> | *No description.* |
50
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
51
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
52
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addDeps">addDeps</a></code> | Defines normal dependencies. |
53
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
54
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addFields">addFields</a></code> | Directly set fields in `package.json`. |
55
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
56
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
57
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
58
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
59
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
60
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
61
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
62
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
63
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addCdkDependencies">addCdkDependencies</a></code> | Adds dependencies to AWS CDK modules. |
64
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addCdkTestDependencies">addCdkTestDependencies</a></code> | Adds AWS CDK modules as dev dependencies. |
65
+
66
+ ---
67
+
68
+ ##### `toString` <a name="toString" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.toString"></a>
69
+
70
+ ```typescript
71
+ public toString(): string
72
+ ```
73
+
74
+ Returns a string representation of this construct.
75
+
76
+ ##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addExcludeFromCleanup"></a>
77
+
78
+ ```typescript
79
+ public addExcludeFromCleanup(globs: ...string[]): void
80
+ ```
81
+
82
+ Exclude the matching files from pre-synth cleanup.
83
+
84
+ Can be used when, for example, some
85
+ source files include the projen marker and we don't want them to be erased during synth.
86
+
87
+ ###### `globs`<sup>Required</sup> <a name="globs" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addExcludeFromCleanup.parameter.globs"></a>
88
+
89
+ - *Type:* ...string[]
90
+
91
+ The glob patterns to match.
92
+
93
+ ---
94
+
95
+ ##### `addGitIgnore` <a name="addGitIgnore" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addGitIgnore"></a>
96
+
97
+ ```typescript
98
+ public addGitIgnore(pattern: string): void
99
+ ```
100
+
101
+ Adds a .gitignore pattern.
102
+
103
+ ###### `pattern`<sup>Required</sup> <a name="pattern" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addGitIgnore.parameter.pattern"></a>
104
+
105
+ - *Type:* string
106
+
107
+ The glob pattern to ignore.
108
+
109
+ ---
110
+
111
+ ##### `addPackageIgnore` <a name="addPackageIgnore" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addPackageIgnore"></a>
112
+
113
+ ```typescript
114
+ public addPackageIgnore(pattern: string): void
115
+ ```
116
+
117
+ Adds patterns to be ignored by npm.
118
+
119
+ ###### `pattern`<sup>Required</sup> <a name="pattern" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addPackageIgnore.parameter.pattern"></a>
120
+
121
+ - *Type:* string
122
+
123
+ The pattern to ignore.
124
+
125
+ ---
126
+
127
+ ##### `addTask` <a name="addTask" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addTask"></a>
128
+
129
+ ```typescript
130
+ public addTask(name: string, props?: TaskOptions): Task
131
+ ```
132
+
133
+ Adds a new task to this project.
134
+
135
+ This will fail if the project already has
136
+ a task with this name.
137
+
138
+ ###### `name`<sup>Required</sup> <a name="name" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addTask.parameter.name"></a>
139
+
140
+ - *Type:* string
141
+
142
+ The task name to add.
143
+
144
+ ---
145
+
146
+ ###### `props`<sup>Optional</sup> <a name="props" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addTask.parameter.props"></a>
147
+
148
+ - *Type:* projen.TaskOptions
149
+
150
+ Task properties.
151
+
152
+ ---
153
+
154
+ ##### ~~`addTip`~~ <a name="addTip" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addTip"></a>
155
+
156
+ ```typescript
157
+ public addTip(message: string): void
158
+ ```
159
+
160
+ Prints a "tip" message during synthesis.
161
+
162
+ ###### `message`<sup>Required</sup> <a name="message" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addTip.parameter.message"></a>
163
+
164
+ - *Type:* string
165
+
166
+ The message.
167
+
168
+ ---
169
+
170
+ ##### `annotateGenerated` <a name="annotateGenerated" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.annotateGenerated"></a>
171
+
172
+ ```typescript
173
+ public annotateGenerated(glob: string): void
174
+ ```
175
+
176
+ Marks the provided file(s) as being generated.
177
+
178
+ This is achieved using the
179
+ github-linguist attributes. Generated files do not count against the
180
+ repository statistics and language breakdown.
181
+
182
+ > [https://github.com/github/linguist/blob/master/docs/overrides.md](https://github.com/github/linguist/blob/master/docs/overrides.md)
183
+
184
+ ###### `glob`<sup>Required</sup> <a name="glob" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.annotateGenerated.parameter.glob"></a>
185
+
186
+ - *Type:* string
187
+
188
+ the glob pattern to match (could be a file path).
189
+
190
+ ---
191
+
192
+ ##### `postSynthesize` <a name="postSynthesize" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.postSynthesize"></a>
193
+
194
+ ```typescript
195
+ public postSynthesize(): void
196
+ ```
197
+
198
+ Called after all components are synthesized.
199
+
200
+ Order is *not* guaranteed.
201
+
202
+ ##### `preSynthesize` <a name="preSynthesize" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.preSynthesize"></a>
203
+
204
+ ```typescript
205
+ public preSynthesize(): void
206
+ ```
207
+
208
+ Called before all components are synthesized.
209
+
210
+ ##### `removeTask` <a name="removeTask" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.removeTask"></a>
211
+
212
+ ```typescript
213
+ public removeTask(name: string): Task
214
+ ```
215
+
216
+ Removes a task from a project.
217
+
218
+ ###### `name`<sup>Required</sup> <a name="name" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.removeTask.parameter.name"></a>
219
+
220
+ - *Type:* string
221
+
222
+ The name of the task to remove.
223
+
224
+ ---
225
+
226
+ ##### `runTaskCommand` <a name="runTaskCommand" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.runTaskCommand"></a>
227
+
228
+ ```typescript
229
+ public runTaskCommand(task: Task): string
230
+ ```
231
+
232
+ Returns the shell command to execute in order to run a task.
233
+
234
+ This will
235
+ typically be `npx projen TASK`.
236
+
237
+ ###### `task`<sup>Required</sup> <a name="task" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.runTaskCommand.parameter.task"></a>
238
+
239
+ - *Type:* projen.Task
240
+
241
+ The task for which the command is required.
242
+
243
+ ---
244
+
245
+ ##### `synth` <a name="synth" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.synth"></a>
246
+
247
+ ```typescript
248
+ public synth(): void
249
+ ```
250
+
251
+ Synthesize all project files into `outdir`.
252
+
253
+ 1. Call "this.preSynthesize()"
254
+ 2. Delete all generated files
255
+ 3. Synthesize all subprojects
256
+ 4. Synthesize all components of this project
257
+ 5. Call "postSynthesize()" for all components of this project
258
+ 6. Call "this.postSynthesize()"
259
+
260
+ ##### `tryFindFile` <a name="tryFindFile" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindFile"></a>
261
+
262
+ ```typescript
263
+ public tryFindFile(filePath: string): FileBase
264
+ ```
265
+
266
+ Finds a file at the specified relative path within this project and all its subprojects.
267
+
268
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindFile.parameter.filePath"></a>
269
+
270
+ - *Type:* string
271
+
272
+ The file path.
273
+
274
+ If this path is relative, it will be resolved
275
+ from the root of _this_ project.
276
+
277
+ ---
278
+
279
+ ##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindJsonFile"></a>
280
+
281
+ ```typescript
282
+ public tryFindJsonFile(filePath: string): JsonFile
283
+ ```
284
+
285
+ Finds a json file by name.
286
+
287
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindJsonFile.parameter.filePath"></a>
288
+
289
+ - *Type:* string
290
+
291
+ The file path.
292
+
293
+ ---
294
+
295
+ ##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindObjectFile"></a>
296
+
297
+ ```typescript
298
+ public tryFindObjectFile(filePath: string): ObjectFile
299
+ ```
300
+
301
+ Finds an object file (like JsonFile, YamlFile, etc.) by name.
302
+
303
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindObjectFile.parameter.filePath"></a>
304
+
305
+ - *Type:* string
306
+
307
+ The file path.
308
+
309
+ ---
310
+
311
+ ##### `tryRemoveFile` <a name="tryRemoveFile" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.tryRemoveFile"></a>
312
+
313
+ ```typescript
314
+ public tryRemoveFile(filePath: string): FileBase
315
+ ```
316
+
317
+ Finds a file at the specified relative path within this project and removes it.
318
+
319
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.tryRemoveFile.parameter.filePath"></a>
320
+
321
+ - *Type:* string
322
+
323
+ The file path.
324
+
325
+ If this path is relative, it will be
326
+ resolved from the root of _this_ project.
327
+
328
+ ---
329
+
330
+ ##### `addBins` <a name="addBins" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addBins"></a>
331
+
332
+ ```typescript
333
+ public addBins(bins: {[ key: string ]: string}): void
334
+ ```
335
+
336
+ ###### `bins`<sup>Required</sup> <a name="bins" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addBins.parameter.bins"></a>
337
+
338
+ - *Type:* {[ key: string ]: string}
339
+
340
+ ---
341
+
342
+ ##### `addBundledDeps` <a name="addBundledDeps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addBundledDeps"></a>
343
+
344
+ ```typescript
345
+ public addBundledDeps(deps: ...string[]): void
346
+ ```
347
+
348
+ Defines bundled dependencies.
349
+
350
+ Bundled dependencies will be added as normal dependencies as well as to the
351
+ `bundledDependencies` section of your `package.json`.
352
+
353
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addBundledDeps.parameter.deps"></a>
354
+
355
+ - *Type:* ...string[]
356
+
357
+ Names modules to install.
358
+
359
+ By default, the the dependency will
360
+ be installed in the next `npx projen` run and the version will be recorded
361
+ in your `package.json` file. You can upgrade manually or using `yarn
362
+ add/upgrade`. If you wish to specify a version range use this syntax:
363
+ `module@^7`.
364
+
365
+ ---
366
+
367
+ ##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addCompileCommand"></a>
368
+
369
+ ```typescript
370
+ public addCompileCommand(commands: ...string[]): void
371
+ ```
372
+
373
+ DEPRECATED.
374
+
375
+ ###### `commands`<sup>Required</sup> <a name="commands" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addCompileCommand.parameter.commands"></a>
376
+
377
+ - *Type:* ...string[]
378
+
379
+ ---
380
+
381
+ ##### `addDeps` <a name="addDeps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addDeps"></a>
382
+
383
+ ```typescript
384
+ public addDeps(deps: ...string[]): void
385
+ ```
386
+
387
+ Defines normal dependencies.
388
+
389
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addDeps.parameter.deps"></a>
390
+
391
+ - *Type:* ...string[]
392
+
393
+ Names modules to install.
394
+
395
+ By default, the the dependency will
396
+ be installed in the next `npx projen` run and the version will be recorded
397
+ in your `package.json` file. You can upgrade manually or using `yarn
398
+ add/upgrade`. If you wish to specify a version range use this syntax:
399
+ `module@^7`.
400
+
401
+ ---
402
+
403
+ ##### `addDevDeps` <a name="addDevDeps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addDevDeps"></a>
404
+
405
+ ```typescript
406
+ public addDevDeps(deps: ...string[]): void
407
+ ```
408
+
409
+ Defines development/test dependencies.
410
+
411
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addDevDeps.parameter.deps"></a>
412
+
413
+ - *Type:* ...string[]
414
+
415
+ Names modules to install.
416
+
417
+ By default, the the dependency will
418
+ be installed in the next `npx projen` run and the version will be recorded
419
+ in your `package.json` file. You can upgrade manually or using `yarn
420
+ add/upgrade`. If you wish to specify a version range use this syntax:
421
+ `module@^7`.
422
+
423
+ ---
424
+
425
+ ##### `addFields` <a name="addFields" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addFields"></a>
426
+
427
+ ```typescript
428
+ public addFields(fields: {[ key: string ]: any}): void
429
+ ```
430
+
431
+ Directly set fields in `package.json`.
432
+
433
+ ###### `fields`<sup>Required</sup> <a name="fields" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addFields.parameter.fields"></a>
434
+
435
+ - *Type:* {[ key: string ]: any}
436
+
437
+ The fields to set.
438
+
439
+ ---
440
+
441
+ ##### `addKeywords` <a name="addKeywords" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addKeywords"></a>
442
+
443
+ ```typescript
444
+ public addKeywords(keywords: ...string[]): void
445
+ ```
446
+
447
+ Adds keywords to package.json (deduplicated).
448
+
449
+ ###### `keywords`<sup>Required</sup> <a name="keywords" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addKeywords.parameter.keywords"></a>
450
+
451
+ - *Type:* ...string[]
452
+
453
+ The keywords to add.
454
+
455
+ ---
456
+
457
+ ##### `addPeerDeps` <a name="addPeerDeps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addPeerDeps"></a>
458
+
459
+ ```typescript
460
+ public addPeerDeps(deps: ...string[]): void
461
+ ```
462
+
463
+ Defines peer dependencies.
464
+
465
+ When adding peer dependencies, a devDependency will also be added on the
466
+ pinned version of the declared peer. This will ensure that you are testing
467
+ your code against the minimum version required from your consumers.
468
+
469
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addPeerDeps.parameter.deps"></a>
470
+
471
+ - *Type:* ...string[]
472
+
473
+ Names modules to install.
474
+
475
+ By default, the the dependency will
476
+ be installed in the next `npx projen` run and the version will be recorded
477
+ in your `package.json` file. You can upgrade manually or using `yarn
478
+ add/upgrade`. If you wish to specify a version range use this syntax:
479
+ `module@^7`.
480
+
481
+ ---
482
+
483
+ ##### `addScripts` <a name="addScripts" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addScripts"></a>
484
+
485
+ ```typescript
486
+ public addScripts(scripts: {[ key: string ]: string}): void
487
+ ```
488
+
489
+ Replaces the contents of multiple npm package.json scripts.
490
+
491
+ ###### `scripts`<sup>Required</sup> <a name="scripts" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addScripts.parameter.scripts"></a>
492
+
493
+ - *Type:* {[ key: string ]: string}
494
+
495
+ The scripts to set.
496
+
497
+ ---
498
+
499
+ ##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addTestCommand"></a>
500
+
501
+ ```typescript
502
+ public addTestCommand(commands: ...string[]): void
503
+ ```
504
+
505
+ DEPRECATED.
506
+
507
+ ###### `commands`<sup>Required</sup> <a name="commands" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addTestCommand.parameter.commands"></a>
508
+
509
+ - *Type:* ...string[]
510
+
511
+ ---
512
+
513
+ ##### ~~`hasScript`~~ <a name="hasScript" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.hasScript"></a>
514
+
515
+ ```typescript
516
+ public hasScript(name: string): boolean
517
+ ```
518
+
519
+ Indicates if a script by the name name is defined.
520
+
521
+ ###### `name`<sup>Required</sup> <a name="name" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.hasScript.parameter.name"></a>
522
+
523
+ - *Type:* string
524
+
525
+ The name of the script.
526
+
527
+ ---
528
+
529
+ ##### `removeScript` <a name="removeScript" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.removeScript"></a>
530
+
531
+ ```typescript
532
+ public removeScript(name: string): void
533
+ ```
534
+
535
+ Removes the npm script (always successful).
536
+
537
+ ###### `name`<sup>Required</sup> <a name="name" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.removeScript.parameter.name"></a>
538
+
539
+ - *Type:* string
540
+
541
+ The name of the script.
542
+
543
+ ---
544
+
545
+ ##### `renderWorkflowSetup` <a name="renderWorkflowSetup" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.renderWorkflowSetup"></a>
546
+
547
+ ```typescript
548
+ public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]
549
+ ```
550
+
551
+ Returns the set of workflow steps which should be executed to bootstrap a workflow.
552
+
553
+ ###### `options`<sup>Optional</sup> <a name="options" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.renderWorkflowSetup.parameter.options"></a>
554
+
555
+ - *Type:* projen.javascript.RenderWorkflowSetupOptions
556
+
557
+ Options.
558
+
559
+ ---
560
+
561
+ ##### `setScript` <a name="setScript" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.setScript"></a>
562
+
563
+ ```typescript
564
+ public setScript(name: string, command: string): void
565
+ ```
566
+
567
+ Replaces the contents of an npm package.json script.
568
+
569
+ ###### `name`<sup>Required</sup> <a name="name" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.setScript.parameter.name"></a>
570
+
571
+ - *Type:* string
572
+
573
+ The script name.
574
+
575
+ ---
576
+
577
+ ###### `command`<sup>Required</sup> <a name="command" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.setScript.parameter.command"></a>
578
+
579
+ - *Type:* string
580
+
581
+ The command to execute.
582
+
583
+ ---
584
+
585
+ ##### ~~`addCdkDependencies`~~ <a name="addCdkDependencies" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addCdkDependencies"></a>
586
+
587
+ ```typescript
588
+ public addCdkDependencies(deps: ...string[]): void
589
+ ```
590
+
591
+ Adds dependencies to AWS CDK modules.
592
+
593
+ Since this is a library project, dependencies will be added as peer dependencies.
594
+
595
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addCdkDependencies.parameter.deps"></a>
596
+
597
+ - *Type:* ...string[]
598
+
599
+ names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
600
+
601
+ ---
602
+
603
+ ##### ~~`addCdkTestDependencies`~~ <a name="addCdkTestDependencies" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addCdkTestDependencies"></a>
604
+
605
+ ```typescript
606
+ public addCdkTestDependencies(deps: ...string[]): void
607
+ ```
608
+
609
+ Adds AWS CDK modules as dev dependencies.
610
+
611
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addCdkTestDependencies.parameter.deps"></a>
612
+
613
+ - *Type:* ...string[]
614
+
615
+ names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
616
+
617
+ ---
618
+
619
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
620
+
621
+ | **Name** | **Description** |
622
+ | --- | --- |
623
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
624
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.isProject">isProject</a></code> | Test whether the given construct is a project. |
625
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.of">of</a></code> | Find the closest ancestor project for given construct. |
626
+
627
+ ---
628
+
629
+ ##### `isConstruct` <a name="isConstruct" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.isConstruct"></a>
630
+
631
+ ```typescript
632
+ import { MvcCdkConstructLibrary } from '@mavogel/mvc-projen'
633
+
634
+ MvcCdkConstructLibrary.isConstruct(x: any)
635
+ ```
636
+
637
+ Checks if `x` is a construct.
638
+
639
+ Use this method instead of `instanceof` to properly detect `Construct`
640
+ instances, even when the construct library is symlinked.
641
+
642
+ Explanation: in JavaScript, multiple copies of the `constructs` library on
643
+ disk are seen as independent, completely different libraries. As a
644
+ consequence, the class `Construct` in each copy of the `constructs` library
645
+ is seen as a different class, and an instance of one class will not test as
646
+ `instanceof` the other class. `npm install` will not create installations
647
+ like this, but users may manually symlink construct libraries together or
648
+ use a monorepo tool: in those cases, multiple copies of the `constructs`
649
+ library can be accidentally installed, and `instanceof` will behave
650
+ unpredictably. It is safest to avoid using `instanceof`, and using
651
+ this type-testing method instead.
652
+
653
+ ###### `x`<sup>Required</sup> <a name="x" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.isConstruct.parameter.x"></a>
654
+
655
+ - *Type:* any
656
+
657
+ Any object.
658
+
659
+ ---
660
+
661
+ ##### `isProject` <a name="isProject" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.isProject"></a>
662
+
663
+ ```typescript
664
+ import { MvcCdkConstructLibrary } from '@mavogel/mvc-projen'
665
+
666
+ MvcCdkConstructLibrary.isProject(x: any)
667
+ ```
668
+
669
+ Test whether the given construct is a project.
670
+
671
+ ###### `x`<sup>Required</sup> <a name="x" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.isProject.parameter.x"></a>
672
+
673
+ - *Type:* any
674
+
675
+ ---
676
+
677
+ ##### `of` <a name="of" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.of"></a>
678
+
679
+ ```typescript
680
+ import { MvcCdkConstructLibrary } from '@mavogel/mvc-projen'
681
+
682
+ MvcCdkConstructLibrary.of(construct: IConstruct)
683
+ ```
684
+
685
+ Find the closest ancestor project for given construct.
686
+
687
+ When given a project, this it the project itself.
688
+
689
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.of.parameter.construct"></a>
690
+
691
+ - *Type:* constructs.IConstruct
692
+
693
+ ---
694
+
695
+ #### Properties <a name="Properties" id="Properties"></a>
696
+
697
+ | **Name** | **Type** | **Description** |
698
+ | --- | --- | --- |
699
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
700
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.buildTask">buildTask</a></code> | <code>projen.Task</code> | *No description.* |
701
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
702
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.compileTask">compileTask</a></code> | <code>projen.Task</code> | *No description.* |
703
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.components">components</a></code> | <code>projen.Component[]</code> | Returns all the components within this project. |
704
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.deps">deps</a></code> | <code>projen.Dependencies</code> | Project dependencies. |
705
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.ejected">ejected</a></code> | <code>boolean</code> | Whether or not the project is being ejected. |
706
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.files">files</a></code> | <code>projen.FileBase[]</code> | All files in this project. |
707
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.gitattributes">gitattributes</a></code> | <code>projen.GitAttributesFile</code> | The .gitattributes file for this repository. |
708
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.gitignore">gitignore</a></code> | <code>projen.IgnoreFile</code> | .gitignore. |
709
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.logger">logger</a></code> | <code>projen.Logger</code> | Logging utilities. |
710
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.name">name</a></code> | <code>string</code> | Project name. |
711
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.outdir">outdir</a></code> | <code>string</code> | Absolute output directory of this project. |
712
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.packageTask">packageTask</a></code> | <code>projen.Task</code> | *No description.* |
713
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.postCompileTask">postCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
714
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.preCompileTask">preCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
715
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
716
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.projenCommand">projenCommand</a></code> | <code>string</code> | The command to use in order to run the projen CLI. |
717
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
718
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.subprojects">subprojects</a></code> | <code>projen.Project[]</code> | Returns all the subprojects within this project. |
719
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
720
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
721
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
722
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
723
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
724
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
725
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
726
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
727
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
728
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
729
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
730
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
731
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
732
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
733
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
734
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
735
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
736
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
737
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
738
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
739
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
740
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
741
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
742
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
743
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
744
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version supported by this package. |
745
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
746
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
747
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
748
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
749
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
750
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
751
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
752
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
753
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
754
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
755
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
756
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.watchTask">watchTask</a></code> | <code>projen.Task</code> | The "watch" task. |
757
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.docgen">docgen</a></code> | <code>boolean</code> | *No description.* |
758
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.eslint">eslint</a></code> | <code>projen.javascript.Eslint</code> | *No description.* |
759
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
760
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.tsconfigEslint">tsconfigEslint</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
761
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.cdkDeps">cdkDeps</a></code> | <code>projen.awscdk.AwsCdkDeps</code> | *No description.* |
762
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | The target CDK version for this library. |
763
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.version">version</a></code> | <code>string</code> | *No description.* |
764
+
765
+ ---
766
+
767
+ ##### `node`<sup>Required</sup> <a name="node" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.node"></a>
768
+
769
+ ```typescript
770
+ public readonly node: Node;
771
+ ```
772
+
773
+ - *Type:* constructs.Node
774
+
775
+ The tree node.
776
+
777
+ ---
778
+
779
+ ##### `buildTask`<sup>Required</sup> <a name="buildTask" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.buildTask"></a>
780
+
781
+ ```typescript
782
+ public readonly buildTask: Task;
783
+ ```
784
+
785
+ - *Type:* projen.Task
786
+
787
+ ---
788
+
789
+ ##### `commitGenerated`<sup>Required</sup> <a name="commitGenerated" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.commitGenerated"></a>
790
+
791
+ ```typescript
792
+ public readonly commitGenerated: boolean;
793
+ ```
794
+
795
+ - *Type:* boolean
796
+
797
+ Whether to commit the managed files by default.
798
+
799
+ ---
800
+
801
+ ##### `compileTask`<sup>Required</sup> <a name="compileTask" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.compileTask"></a>
802
+
803
+ ```typescript
804
+ public readonly compileTask: Task;
805
+ ```
806
+
807
+ - *Type:* projen.Task
808
+
809
+ ---
810
+
811
+ ##### `components`<sup>Required</sup> <a name="components" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.components"></a>
812
+
813
+ ```typescript
814
+ public readonly components: Component[];
815
+ ```
816
+
817
+ - *Type:* projen.Component[]
818
+
819
+ Returns all the components within this project.
820
+
821
+ ---
822
+
823
+ ##### `deps`<sup>Required</sup> <a name="deps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.deps"></a>
824
+
825
+ ```typescript
826
+ public readonly deps: Dependencies;
827
+ ```
828
+
829
+ - *Type:* projen.Dependencies
830
+
831
+ Project dependencies.
832
+
833
+ ---
834
+
835
+ ##### `ejected`<sup>Required</sup> <a name="ejected" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.ejected"></a>
836
+
837
+ ```typescript
838
+ public readonly ejected: boolean;
839
+ ```
840
+
841
+ - *Type:* boolean
842
+
843
+ Whether or not the project is being ejected.
844
+
845
+ ---
846
+
847
+ ##### `files`<sup>Required</sup> <a name="files" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.files"></a>
848
+
849
+ ```typescript
850
+ public readonly files: FileBase[];
851
+ ```
852
+
853
+ - *Type:* projen.FileBase[]
854
+
855
+ All files in this project.
856
+
857
+ ---
858
+
859
+ ##### `gitattributes`<sup>Required</sup> <a name="gitattributes" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.gitattributes"></a>
860
+
861
+ ```typescript
862
+ public readonly gitattributes: GitAttributesFile;
863
+ ```
864
+
865
+ - *Type:* projen.GitAttributesFile
866
+
867
+ The .gitattributes file for this repository.
868
+
869
+ ---
870
+
871
+ ##### `gitignore`<sup>Required</sup> <a name="gitignore" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.gitignore"></a>
872
+
873
+ ```typescript
874
+ public readonly gitignore: IgnoreFile;
875
+ ```
876
+
877
+ - *Type:* projen.IgnoreFile
878
+
879
+ .gitignore.
880
+
881
+ ---
882
+
883
+ ##### `logger`<sup>Required</sup> <a name="logger" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.logger"></a>
884
+
885
+ ```typescript
886
+ public readonly logger: Logger;
887
+ ```
888
+
889
+ - *Type:* projen.Logger
890
+
891
+ Logging utilities.
892
+
893
+ ---
894
+
895
+ ##### `name`<sup>Required</sup> <a name="name" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.name"></a>
896
+
897
+ ```typescript
898
+ public readonly name: string;
899
+ ```
900
+
901
+ - *Type:* string
902
+
903
+ Project name.
904
+
905
+ ---
906
+
907
+ ##### `outdir`<sup>Required</sup> <a name="outdir" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.outdir"></a>
908
+
909
+ ```typescript
910
+ public readonly outdir: string;
911
+ ```
912
+
913
+ - *Type:* string
914
+
915
+ Absolute output directory of this project.
916
+
917
+ ---
918
+
919
+ ##### `packageTask`<sup>Required</sup> <a name="packageTask" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.packageTask"></a>
920
+
921
+ ```typescript
922
+ public readonly packageTask: Task;
923
+ ```
924
+
925
+ - *Type:* projen.Task
926
+
927
+ ---
928
+
929
+ ##### `postCompileTask`<sup>Required</sup> <a name="postCompileTask" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.postCompileTask"></a>
930
+
931
+ ```typescript
932
+ public readonly postCompileTask: Task;
933
+ ```
934
+
935
+ - *Type:* projen.Task
936
+
937
+ ---
938
+
939
+ ##### `preCompileTask`<sup>Required</sup> <a name="preCompileTask" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.preCompileTask"></a>
940
+
941
+ ```typescript
942
+ public readonly preCompileTask: Task;
943
+ ```
944
+
945
+ - *Type:* projen.Task
946
+
947
+ ---
948
+
949
+ ##### `projectBuild`<sup>Required</sup> <a name="projectBuild" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.projectBuild"></a>
950
+
951
+ ```typescript
952
+ public readonly projectBuild: ProjectBuild;
953
+ ```
954
+
955
+ - *Type:* projen.ProjectBuild
956
+
957
+ Manages the build process of the project.
958
+
959
+ ---
960
+
961
+ ##### `projenCommand`<sup>Required</sup> <a name="projenCommand" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.projenCommand"></a>
962
+
963
+ ```typescript
964
+ public readonly projenCommand: string;
965
+ ```
966
+
967
+ - *Type:* string
968
+
969
+ The command to use in order to run the projen CLI.
970
+
971
+ ---
972
+
973
+ ##### `root`<sup>Required</sup> <a name="root" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.root"></a>
974
+
975
+ ```typescript
976
+ public readonly root: Project;
977
+ ```
978
+
979
+ - *Type:* projen.Project
980
+
981
+ The root project.
982
+
983
+ ---
984
+
985
+ ##### `subprojects`<sup>Required</sup> <a name="subprojects" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.subprojects"></a>
986
+
987
+ ```typescript
988
+ public readonly subprojects: Project[];
989
+ ```
990
+
991
+ - *Type:* projen.Project[]
992
+
993
+ Returns all the subprojects within this project.
994
+
995
+ ---
996
+
997
+ ##### `tasks`<sup>Required</sup> <a name="tasks" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.tasks"></a>
998
+
999
+ ```typescript
1000
+ public readonly tasks: Tasks;
1001
+ ```
1002
+
1003
+ - *Type:* projen.Tasks
1004
+
1005
+ Project tasks.
1006
+
1007
+ ---
1008
+
1009
+ ##### `testTask`<sup>Required</sup> <a name="testTask" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.testTask"></a>
1010
+
1011
+ ```typescript
1012
+ public readonly testTask: Task;
1013
+ ```
1014
+
1015
+ - *Type:* projen.Task
1016
+
1017
+ ---
1018
+
1019
+ ##### `defaultTask`<sup>Optional</sup> <a name="defaultTask" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.defaultTask"></a>
1020
+
1021
+ ```typescript
1022
+ public readonly defaultTask: Task;
1023
+ ```
1024
+
1025
+ - *Type:* projen.Task
1026
+
1027
+ This is the "default" task, the one that executes "projen".
1028
+
1029
+ Undefined if
1030
+ the project is being ejected.
1031
+
1032
+ ---
1033
+
1034
+ ##### `initProject`<sup>Optional</sup> <a name="initProject" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.initProject"></a>
1035
+
1036
+ ```typescript
1037
+ public readonly initProject: InitProject;
1038
+ ```
1039
+
1040
+ - *Type:* projen.InitProject
1041
+
1042
+ The options used when this project is bootstrapped via `projen new`.
1043
+
1044
+ It
1045
+ includes the original set of options passed to the CLI and also the JSII
1046
+ FQN of the project type.
1047
+
1048
+ ---
1049
+
1050
+ ##### `parent`<sup>Optional</sup> <a name="parent" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.parent"></a>
1051
+
1052
+ ```typescript
1053
+ public readonly parent: Project;
1054
+ ```
1055
+
1056
+ - *Type:* projen.Project
1057
+
1058
+ A parent project.
1059
+
1060
+ If undefined, this is the root project.
1061
+
1062
+ ---
1063
+
1064
+ ##### `projectType`<sup>Required</sup> <a name="projectType" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.projectType"></a>
1065
+
1066
+ ```typescript
1067
+ public readonly projectType: ProjectType;
1068
+ ```
1069
+
1070
+ - *Type:* projen.ProjectType
1071
+
1072
+ ---
1073
+
1074
+ ##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.autoApprove"></a>
1075
+
1076
+ ```typescript
1077
+ public readonly autoApprove: AutoApprove;
1078
+ ```
1079
+
1080
+ - *Type:* projen.github.AutoApprove
1081
+
1082
+ Auto approve set up for this project.
1083
+
1084
+ ---
1085
+
1086
+ ##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.devContainer"></a>
1087
+
1088
+ ```typescript
1089
+ public readonly devContainer: DevContainer;
1090
+ ```
1091
+
1092
+ - *Type:* projen.vscode.DevContainer
1093
+
1094
+ Access for .devcontainer.json (used for GitHub Codespaces).
1095
+
1096
+ This will be `undefined` if devContainer boolean is false
1097
+
1098
+ ---
1099
+
1100
+ ##### `github`<sup>Optional</sup> <a name="github" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.github"></a>
1101
+
1102
+ ```typescript
1103
+ public readonly github: GitHub;
1104
+ ```
1105
+
1106
+ - *Type:* projen.github.GitHub
1107
+
1108
+ Access all github components.
1109
+
1110
+ This will be `undefined` for subprojects.
1111
+
1112
+ ---
1113
+
1114
+ ##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.gitpod"></a>
1115
+
1116
+ ```typescript
1117
+ public readonly gitpod: Gitpod;
1118
+ ```
1119
+
1120
+ - *Type:* projen.Gitpod
1121
+
1122
+ Access for Gitpod.
1123
+
1124
+ This will be `undefined` if gitpod boolean is false
1125
+
1126
+ ---
1127
+
1128
+ ##### `vscode`<sup>Optional</sup> <a name="vscode" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.vscode"></a>
1129
+
1130
+ ```typescript
1131
+ public readonly vscode: VsCode;
1132
+ ```
1133
+
1134
+ - *Type:* projen.vscode.VsCode
1135
+
1136
+ Access all VSCode components.
1137
+
1138
+ This will be `undefined` for subprojects.
1139
+
1140
+ ---
1141
+
1142
+ ##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.allowLibraryDependencies"></a>
1143
+
1144
+ - *Deprecated:* use `package.allowLibraryDependencies`
1145
+
1146
+ ```typescript
1147
+ public readonly allowLibraryDependencies: boolean;
1148
+ ```
1149
+
1150
+ - *Type:* boolean
1151
+
1152
+ ---
1153
+
1154
+ ##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.artifactsDirectory"></a>
1155
+
1156
+ ```typescript
1157
+ public readonly artifactsDirectory: string;
1158
+ ```
1159
+
1160
+ - *Type:* string
1161
+
1162
+ The build output directory.
1163
+
1164
+ An npm tarball will be created under the `js`
1165
+ subdirectory. For example, if this is set to `dist` (the default), the npm
1166
+ tarball will be placed under `dist/js/boom-boom-1.2.3.tg`.
1167
+
1168
+ ---
1169
+
1170
+ ##### `artifactsJavascriptDirectory`<sup>Required</sup> <a name="artifactsJavascriptDirectory" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.artifactsJavascriptDirectory"></a>
1171
+
1172
+ ```typescript
1173
+ public readonly artifactsJavascriptDirectory: string;
1174
+ ```
1175
+
1176
+ - *Type:* string
1177
+
1178
+ The location of the npm tarball after build (`${artifactsDirectory}/js`).
1179
+
1180
+ ---
1181
+
1182
+ ##### `bundler`<sup>Required</sup> <a name="bundler" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.bundler"></a>
1183
+
1184
+ ```typescript
1185
+ public readonly bundler: Bundler;
1186
+ ```
1187
+
1188
+ - *Type:* projen.javascript.Bundler
1189
+
1190
+ ---
1191
+
1192
+ ##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.entrypoint"></a>
1193
+
1194
+ - *Deprecated:* use `package.entrypoint`
1195
+
1196
+ ```typescript
1197
+ public readonly entrypoint: string;
1198
+ ```
1199
+
1200
+ - *Type:* string
1201
+
1202
+ ---
1203
+
1204
+ ##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.manifest"></a>
1205
+
1206
+ - *Deprecated:* use `package.addField(x, y)`
1207
+
1208
+ ```typescript
1209
+ public readonly manifest: any;
1210
+ ```
1211
+
1212
+ - *Type:* any
1213
+
1214
+ ---
1215
+
1216
+ ##### `npmrc`<sup>Required</sup> <a name="npmrc" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.npmrc"></a>
1217
+
1218
+ ```typescript
1219
+ public readonly npmrc: NpmConfig;
1220
+ ```
1221
+
1222
+ - *Type:* projen.javascript.NpmConfig
1223
+
1224
+ The .npmrc file.
1225
+
1226
+ ---
1227
+
1228
+ ##### `package`<sup>Required</sup> <a name="package" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.package"></a>
1229
+
1230
+ ```typescript
1231
+ public readonly package: NodePackage;
1232
+ ```
1233
+
1234
+ - *Type:* projen.javascript.NodePackage
1235
+
1236
+ API for managing the node package.
1237
+
1238
+ ---
1239
+
1240
+ ##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.packageManager"></a>
1241
+
1242
+ - *Deprecated:* use `package.packageManager`
1243
+
1244
+ ```typescript
1245
+ public readonly packageManager: NodePackageManager;
1246
+ ```
1247
+
1248
+ - *Type:* projen.javascript.NodePackageManager
1249
+
1250
+ The package manager to use.
1251
+
1252
+ ---
1253
+
1254
+ ##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.runScriptCommand"></a>
1255
+
1256
+ ```typescript
1257
+ public readonly runScriptCommand: string;
1258
+ ```
1259
+
1260
+ - *Type:* string
1261
+
1262
+ The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager).
1263
+
1264
+ ---
1265
+
1266
+ ##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.autoMerge"></a>
1267
+
1268
+ ```typescript
1269
+ public readonly autoMerge: AutoMerge;
1270
+ ```
1271
+
1272
+ - *Type:* projen.github.AutoMerge
1273
+
1274
+ Component that sets up mergify for merging approved pull requests.
1275
+
1276
+ ---
1277
+
1278
+ ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.buildWorkflow"></a>
1279
+
1280
+ ```typescript
1281
+ public readonly buildWorkflow: BuildWorkflow;
1282
+ ```
1283
+
1284
+ - *Type:* projen.build.BuildWorkflow
1285
+
1286
+ The PR build GitHub workflow.
1287
+
1288
+ `undefined` if `buildWorkflow` is disabled.
1289
+
1290
+ ---
1291
+
1292
+ ##### `buildWorkflowJobId`<sup>Optional</sup> <a name="buildWorkflowJobId" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.buildWorkflowJobId"></a>
1293
+
1294
+ ```typescript
1295
+ public readonly buildWorkflowJobId: string;
1296
+ ```
1297
+
1298
+ - *Type:* string
1299
+
1300
+ The job ID of the build workflow.
1301
+
1302
+ ---
1303
+
1304
+ ##### `jest`<sup>Optional</sup> <a name="jest" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.jest"></a>
1305
+
1306
+ ```typescript
1307
+ public readonly jest: Jest;
1308
+ ```
1309
+
1310
+ - *Type:* projen.javascript.Jest
1311
+
1312
+ The Jest configuration (if enabled).
1313
+
1314
+ ---
1315
+
1316
+ ##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.maxNodeVersion"></a>
1317
+
1318
+ ```typescript
1319
+ public readonly maxNodeVersion: string;
1320
+ ```
1321
+
1322
+ - *Type:* string
1323
+
1324
+ Maximum node version supported by this package.
1325
+
1326
+ The value indicates the package is incompatible with newer versions.
1327
+
1328
+ ---
1329
+
1330
+ ##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.minNodeVersion"></a>
1331
+
1332
+ ```typescript
1333
+ public readonly minNodeVersion: string;
1334
+ ```
1335
+
1336
+ - *Type:* string
1337
+
1338
+ The minimum node version required by this package to function.
1339
+
1340
+ This value indicates the package is incompatible with older versions.
1341
+
1342
+ ---
1343
+
1344
+ ##### `npmignore`<sup>Optional</sup> <a name="npmignore" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.npmignore"></a>
1345
+
1346
+ ```typescript
1347
+ public readonly npmignore: IgnoreFile;
1348
+ ```
1349
+
1350
+ - *Type:* projen.IgnoreFile
1351
+
1352
+ The .npmignore file.
1353
+
1354
+ ---
1355
+
1356
+ ##### `prettier`<sup>Optional</sup> <a name="prettier" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.prettier"></a>
1357
+
1358
+ ```typescript
1359
+ public readonly prettier: Prettier;
1360
+ ```
1361
+
1362
+ - *Type:* projen.javascript.Prettier
1363
+
1364
+ ---
1365
+
1366
+ ##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.publisher"></a>
1367
+
1368
+ - *Deprecated:* use `release.publisher`.
1369
+
1370
+ ```typescript
1371
+ public readonly publisher: Publisher;
1372
+ ```
1373
+
1374
+ - *Type:* projen.release.Publisher
1375
+
1376
+ Package publisher.
1377
+
1378
+ This will be `undefined` if the project does not have a
1379
+ release workflow.
1380
+
1381
+ ---
1382
+
1383
+ ##### `release`<sup>Optional</sup> <a name="release" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.release"></a>
1384
+
1385
+ ```typescript
1386
+ public readonly release: Release;
1387
+ ```
1388
+
1389
+ - *Type:* projen.release.Release
1390
+
1391
+ Release management.
1392
+
1393
+ ---
1394
+
1395
+ ##### `upgradeWorkflow`<sup>Optional</sup> <a name="upgradeWorkflow" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.upgradeWorkflow"></a>
1396
+
1397
+ ```typescript
1398
+ public readonly upgradeWorkflow: UpgradeDependencies;
1399
+ ```
1400
+
1401
+ - *Type:* projen.javascript.UpgradeDependencies
1402
+
1403
+ The upgrade workflow.
1404
+
1405
+ ---
1406
+
1407
+ ##### `docsDirectory`<sup>Required</sup> <a name="docsDirectory" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.docsDirectory"></a>
1408
+
1409
+ ```typescript
1410
+ public readonly docsDirectory: string;
1411
+ ```
1412
+
1413
+ - *Type:* string
1414
+
1415
+ ---
1416
+
1417
+ ##### `libdir`<sup>Required</sup> <a name="libdir" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.libdir"></a>
1418
+
1419
+ ```typescript
1420
+ public readonly libdir: string;
1421
+ ```
1422
+
1423
+ - *Type:* string
1424
+
1425
+ The directory in which compiled .js files reside.
1426
+
1427
+ ---
1428
+
1429
+ ##### `srcdir`<sup>Required</sup> <a name="srcdir" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.srcdir"></a>
1430
+
1431
+ ```typescript
1432
+ public readonly srcdir: string;
1433
+ ```
1434
+
1435
+ - *Type:* string
1436
+
1437
+ The directory in which the .ts sources reside.
1438
+
1439
+ ---
1440
+
1441
+ ##### `testdir`<sup>Required</sup> <a name="testdir" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.testdir"></a>
1442
+
1443
+ ```typescript
1444
+ public readonly testdir: string;
1445
+ ```
1446
+
1447
+ - *Type:* string
1448
+
1449
+ The directory in which tests reside.
1450
+
1451
+ ---
1452
+
1453
+ ##### `tsconfigDev`<sup>Required</sup> <a name="tsconfigDev" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.tsconfigDev"></a>
1454
+
1455
+ ```typescript
1456
+ public readonly tsconfigDev: TypescriptConfig;
1457
+ ```
1458
+
1459
+ - *Type:* projen.javascript.TypescriptConfig
1460
+
1461
+ A typescript configuration file which covers all files (sources, tests, projen).
1462
+
1463
+ ---
1464
+
1465
+ ##### `watchTask`<sup>Required</sup> <a name="watchTask" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.watchTask"></a>
1466
+
1467
+ ```typescript
1468
+ public readonly watchTask: Task;
1469
+ ```
1470
+
1471
+ - *Type:* projen.Task
1472
+
1473
+ The "watch" task.
1474
+
1475
+ ---
1476
+
1477
+ ##### `docgen`<sup>Optional</sup> <a name="docgen" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.docgen"></a>
1478
+
1479
+ ```typescript
1480
+ public readonly docgen: boolean;
1481
+ ```
1482
+
1483
+ - *Type:* boolean
1484
+
1485
+ ---
1486
+
1487
+ ##### `eslint`<sup>Optional</sup> <a name="eslint" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.eslint"></a>
1488
+
1489
+ ```typescript
1490
+ public readonly eslint: Eslint;
1491
+ ```
1492
+
1493
+ - *Type:* projen.javascript.Eslint
1494
+
1495
+ ---
1496
+
1497
+ ##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.tsconfig"></a>
1498
+
1499
+ ```typescript
1500
+ public readonly tsconfig: TypescriptConfig;
1501
+ ```
1502
+
1503
+ - *Type:* projen.javascript.TypescriptConfig
1504
+
1505
+ ---
1506
+
1507
+ ##### `tsconfigEslint`<sup>Optional</sup> <a name="tsconfigEslint" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.tsconfigEslint"></a>
1508
+
1509
+ ```typescript
1510
+ public readonly tsconfigEslint: TypescriptConfig;
1511
+ ```
1512
+
1513
+ - *Type:* projen.javascript.TypescriptConfig
1514
+
1515
+ ---
1516
+
1517
+ ##### `cdkDeps`<sup>Required</sup> <a name="cdkDeps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.cdkDeps"></a>
1518
+
1519
+ ```typescript
1520
+ public readonly cdkDeps: AwsCdkDeps;
1521
+ ```
1522
+
1523
+ - *Type:* projen.awscdk.AwsCdkDeps
1524
+
1525
+ ---
1526
+
1527
+ ##### `cdkVersion`<sup>Required</sup> <a name="cdkVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.cdkVersion"></a>
1528
+
1529
+ ```typescript
1530
+ public readonly cdkVersion: string;
1531
+ ```
1532
+
1533
+ - *Type:* string
1534
+
1535
+ The target CDK version for this library.
1536
+
1537
+ ---
1538
+
1539
+ ##### ~~`version`~~<sup>Required</sup> <a name="version" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.version"></a>
1540
+
1541
+ - *Deprecated:* use `cdkVersion`
1542
+
1543
+ ```typescript
1544
+ public readonly version: string;
1545
+ ```
1546
+
1547
+ - *Type:* string
1548
+
1549
+ ---
1550
+
1551
+ #### Constants <a name="Constants" id="Constants"></a>
1552
+
1553
+ | **Name** | **Type** | **Description** |
1554
+ | --- | --- | --- |
1555
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.DEFAULT_TASK">DEFAULT_TASK</a></code> | <code>string</code> | The name of the default task (the task executed when `projen` is run without arguments). |
1556
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
1557
+
1558
+ ---
1559
+
1560
+ ##### `DEFAULT_TASK`<sup>Required</sup> <a name="DEFAULT_TASK" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.DEFAULT_TASK"></a>
1561
+
1562
+ ```typescript
1563
+ public readonly DEFAULT_TASK: string;
1564
+ ```
1565
+
1566
+ - *Type:* string
1567
+
1568
+ The name of the default task (the task executed when `projen` is run without arguments).
1569
+
1570
+ Normally
1571
+ this task should synthesize the project files.
1572
+
1573
+ ---
1574
+
1575
+ ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
1576
+
1577
+ ```typescript
1578
+ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
1579
+ ```
1580
+
1581
+ - *Type:* string
1582
+
1583
+ ---
1584
+
1585
+ ## Structs <a name="Structs" id="Structs"></a>
1586
+
1587
+ ### MvcCdkConstructLibraryOptions <a name="MvcCdkConstructLibraryOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions"></a>
1588
+
1589
+ The options for the construct.
1590
+
1591
+ #### Initializer <a name="Initializer" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.Initializer"></a>
1592
+
1593
+ ```typescript
1594
+ import { MvcCdkConstructLibraryOptions } from '@mavogel/mvc-projen'
1595
+
1596
+ const mvcCdkConstructLibraryOptions: MvcCdkConstructLibraryOptions = { ... }
1597
+ ```
1598
+
1599
+ #### Properties <a name="Properties" id="Properties"></a>
1600
+
1601
+ | **Name** | **Type** | **Description** |
1602
+ | --- | --- | --- |
1603
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
1604
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
1605
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
1606
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
1607
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
1608
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. |
1609
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.parent">parent</a></code> | <code>projen.Project</code> | The parent project, if this project is part of a bigger project. |
1610
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
1611
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcJson">projenrcJson</a></code> | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
1612
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcJsonOptions">projenrcJsonOptions</a></code> | <code>projen.ProjenrcJsonOptions</code> | Options for .projenrc.json. |
1613
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
1614
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.renovatebotOptions">renovatebotOptions</a></code> | <code>projen.RenovatebotOptions</code> | Options for renovatebot. |
1615
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
1616
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
1617
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
1618
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
1619
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.devContainer">devContainer</a></code> | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces). |
1620
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
1621
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
1622
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.gitpod">gitpod</a></code> | <code>boolean</code> | Add a Gitpod development environment. |
1623
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.mergify">mergify</a></code> | <code>boolean</code> | Whether mergify should be enabled on this repository or not. |
1624
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.mergifyOptions">mergifyOptions</a></code> | <code>projen.github.MergifyOptions</code> | Options for mergify. |
1625
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
1626
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
1627
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenTokenSecret">projenTokenSecret</a></code> | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
1628
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.readme">readme</a></code> | <code>projen.SampleReadmeProps</code> | The README setup. |
1629
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
1630
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.staleOptions">staleOptions</a></code> | <code>projen.github.StaleOptions</code> | Auto-close stale issues and pull requests. |
1631
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
1632
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
1633
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
1634
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
1635
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorOrganization">authorOrganization</a></code> | <code>boolean</code> | Is the author an organization. |
1636
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorUrl">authorUrl</a></code> | <code>string</code> | Author's URL / Website. |
1637
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.autoDetectBin">autoDetectBin</a></code> | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
1638
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
1639
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
1640
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
1641
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
1642
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
1643
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
1644
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
1645
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
1646
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
1647
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.entrypoint">entrypoint</a></code> | <code>string</code> | Module entrypoint (`main` in `package.json`). |
1648
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.homepage">homepage</a></code> | <code>string</code> | Package's Homepage / Website. |
1649
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.keywords">keywords</a></code> | <code>string[]</code> | Keywords to include in `package.json`. |
1650
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.license">license</a></code> | <code>string</code> | License's SPDX identifier. |
1651
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.licensed">licensed</a></code> | <code>boolean</code> | Indicates if a license should be added. |
1652
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | The maximum node version supported by this package. Most projects should not use this option. |
1653
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. Most projects should not use this option. |
1654
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
1655
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
1656
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
1657
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
1658
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
1659
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
1660
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
1661
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
1662
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
1663
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.pnpmVersion">pnpmVersion</a></code> | <code>string</code> | The version of PNPM to use if using PNPM as a package manager. |
1664
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
1665
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
1666
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
1667
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.scripts">scripts</a></code> | <code>{[ key: string ]: string}</code> | npm scripts to include. |
1668
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
1669
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
1670
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bumpPackage">bumpPackage</a></code> | <code>string</code> | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. |
1671
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
1672
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
1673
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
1674
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.nextVersionCommand">nextVersionCommand</a></code> | <code>string</code> | A shell command to control the next version to release. |
1675
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmDistTag">npmDistTag</a></code> | <code>string</code> | The npmDistTag to use when publishing from the default branch. |
1676
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.postBuildSteps">postBuildSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Steps to execute after build as part of the release workflow. |
1677
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.prerelease">prerelease</a></code> | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). |
1678
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishDryRun">publishDryRun</a></code> | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command. |
1679
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
1680
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
1681
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
1682
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
1683
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
1684
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
1685
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
1686
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
1687
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
1688
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
1689
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
1690
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
1691
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
1692
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
1693
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
1694
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
1695
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
1696
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
1697
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
1698
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
1699
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
1700
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
1701
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
1702
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
1703
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
1704
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
1705
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
1706
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
1707
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
1708
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.depsUpgrade">depsUpgrade</a></code> | <code>boolean</code> | Use tasks and github workflows to handle dependency upgrades. |
1709
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.depsUpgradeOptions">depsUpgradeOptions</a></code> | <code>projen.javascript.UpgradeDependenciesOptions</code> | Options for `UpgradeDependencies`. |
1710
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
1711
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.jest">jest</a></code> | <code>boolean</code> | Setup jest unit tests. |
1712
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.jestOptions">jestOptions</a></code> | <code>projen.javascript.JestOptions</code> | Jest options. |
1713
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
1714
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
1715
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
1716
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
1717
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
1718
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
1719
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
1720
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenDevDependency">projenDevDependency</a></code> | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency. |
1721
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcJs">projenrcJs</a></code> | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. |
1722
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcJsOptions">projenrcJsOptions</a></code> | <code>projen.javascript.ProjenrcOptions</code> | Options for .projenrc.js. |
1723
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenVersion">projenVersion</a></code> | <code>string</code> | Version of projen to install. |
1724
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.pullRequestTemplate">pullRequestTemplate</a></code> | <code>boolean</code> | Include a GitHub pull request template. |
1725
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.pullRequestTemplateContents">pullRequestTemplateContents</a></code> | <code>string[]</code> | The contents of the pull request template. |
1726
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
1727
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
1728
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
1729
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
1730
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
1731
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
1732
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
1733
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
1734
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
1735
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
1736
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
1737
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.entrypointTypes">entrypointTypes</a></code> | <code>string</code> | The .d.ts file that includes the type declarations for this module. |
1738
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.eslint">eslint</a></code> | <code>boolean</code> | Setup eslint. |
1739
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.eslintOptions">eslintOptions</a></code> | <code>projen.javascript.EslintOptions</code> | Eslint options. |
1740
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.libdir">libdir</a></code> | <code>string</code> | Typescript artifacts output directory. |
1741
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcTs">projenrcTs</a></code> | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`). |
1742
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcTsOptions">projenrcTsOptions</a></code> | <code>projen.typescript.ProjenrcOptions</code> | Options for .projenrc.ts. |
1743
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.sampleCode">sampleCode</a></code> | <code>boolean</code> | Generate one-time sample in `src/` and `test/` if there are no files there. |
1744
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.srcdir">srcdir</a></code> | <code>string</code> | Typescript sources directory. |
1745
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.testdir">testdir</a></code> | <code>string</code> | Jest tests directory. Tests files should be named `xxx.test.ts`. |
1746
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
1747
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
1748
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
1749
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
1750
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
1751
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.author">author</a></code> | <code>string</code> | The name of the library author. |
1752
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorAddress">authorAddress</a></code> | <code>string</code> | Email or URL of the library author. |
1753
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.repositoryUrl">repositoryUrl</a></code> | <code>string</code> | Git repository URL. |
1754
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
1755
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
1756
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
1757
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.docgenFilePath">docgenFilePath</a></code> | <code>string</code> | File path for generated docs. |
1758
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.dotnet">dotnet</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | *No description.* |
1759
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.excludeTypescript">excludeTypescript</a></code> | <code>string[]</code> | Accepts a list of glob patterns. |
1760
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.jsiiVersion">jsiiVersion</a></code> | <code>string</code> | Version of the jsii compiler to use. |
1761
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishToGo">publishToGo</a></code> | <code>projen.cdk.JsiiGoTarget</code> | Publish Go bindings to a git repository. |
1762
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishToMaven">publishToMaven</a></code> | <code>projen.cdk.JsiiJavaTarget</code> | Publish to maven. |
1763
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishToNuget">publishToNuget</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | Publish to NuGet. |
1764
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishToPypi">publishToPypi</a></code> | <code>projen.cdk.JsiiPythonTarget</code> | Publish to pypi. |
1765
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.python">python</a></code> | <code>projen.cdk.JsiiPythonTarget</code> | *No description.* |
1766
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.rootdir">rootdir</a></code> | <code>string</code> | *No description.* |
1767
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.catalog">catalog</a></code> | <code>projen.cdk.Catalog</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. |
1768
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | Minimum version of the AWS CDK to depend on. |
1769
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkAssert">cdkAssert</a></code> | <code>boolean</code> | Warning: NodeJS only. |
1770
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkAssertions">cdkAssertions</a></code> | <code>boolean</code> | Install the assertions library? |
1771
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkCliVersion">cdkCliVersion</a></code> | <code>string</code> | Version range of the AWS CDK CLI to depend on. |
1772
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkDependencies">cdkDependencies</a></code> | <code>string[]</code> | Which AWS CDKv1 modules this project requires. |
1773
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkDependenciesAsDeps">cdkDependenciesAsDeps</a></code> | <code>boolean</code> | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). |
1774
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkTestDependencies">cdkTestDependencies</a></code> | <code>string[]</code> | AWS CDK modules required for testing. |
1775
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkVersionPinning">cdkVersionPinning</a></code> | <code>boolean</code> | Use pinned version instead of caret version for CDK. |
1776
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.constructsVersion">constructsVersion</a></code> | <code>string</code> | Minimum version of the `constructs` library to depend on. |
1777
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.edgeLambdaAutoDiscover">edgeLambdaAutoDiscover</a></code> | <code>boolean</code> | Automatically adds an `cloudfront.experimental.EdgeFunction` for each `.edge-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. |
1778
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.experimentalIntegRunner">experimentalIntegRunner</a></code> | <code>boolean</code> | Enable experimental support for the AWS CDK integ-runner. |
1779
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.integrationTestAutoDiscover">integrationTestAutoDiscover</a></code> | <code>boolean</code> | Automatically discovers and creates integration tests for each `.integ.ts` file under your test directory. |
1780
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.lambdaAutoDiscover">lambdaAutoDiscover</a></code> | <code>boolean</code> | Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in your source tree. If this is disabled, you either need to explicitly call `aws_lambda.Function.autoDiscover()` or define a `new aws_lambda.Function()` for each handler. |
1781
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.lambdaExtensionAutoDiscover">lambdaExtensionAutoDiscover</a></code> | <code>boolean</code> | Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. |
1782
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.lambdaOptions">lambdaOptions</a></code> | <code>projen.awscdk.LambdaFunctionCommonOptions</code> | Common options for all AWS Lambda functions. |
1783
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.baseAssetsDirectory">baseAssetsDirectory</a></code> | <code>string</code> | Base directory for the assets. |
1784
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.integTestRegions">integTestRegions</a></code> | <code>string[]</code> | The regions to run the integ tests in. |
1785
+
1786
+ ---
1787
+
1788
+ ##### `name`<sup>Required</sup> <a name="name" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.name"></a>
1789
+
1790
+ ```typescript
1791
+ public readonly name: string;
1792
+ ```
1793
+
1794
+ - *Type:* string
1795
+ - *Default:* $BASEDIR
1796
+
1797
+ This is the name of your project.
1798
+
1799
+ ---
1800
+
1801
+ ##### `commitGenerated`<sup>Optional</sup> <a name="commitGenerated" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.commitGenerated"></a>
1802
+
1803
+ ```typescript
1804
+ public readonly commitGenerated: boolean;
1805
+ ```
1806
+
1807
+ - *Type:* boolean
1808
+ - *Default:* true
1809
+
1810
+ Whether to commit the managed files by default.
1811
+
1812
+ ---
1813
+
1814
+ ##### `gitIgnoreOptions`<sup>Optional</sup> <a name="gitIgnoreOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.gitIgnoreOptions"></a>
1815
+
1816
+ ```typescript
1817
+ public readonly gitIgnoreOptions: IgnoreFileOptions;
1818
+ ```
1819
+
1820
+ - *Type:* projen.IgnoreFileOptions
1821
+
1822
+ Configuration options for .gitignore file.
1823
+
1824
+ ---
1825
+
1826
+ ##### `gitOptions`<sup>Optional</sup> <a name="gitOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.gitOptions"></a>
1827
+
1828
+ ```typescript
1829
+ public readonly gitOptions: GitOptions;
1830
+ ```
1831
+
1832
+ - *Type:* projen.GitOptions
1833
+
1834
+ Configuration options for git.
1835
+
1836
+ ---
1837
+
1838
+ ##### `logging`<sup>Optional</sup> <a name="logging" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.logging"></a>
1839
+
1840
+ ```typescript
1841
+ public readonly logging: LoggerOptions;
1842
+ ```
1843
+
1844
+ - *Type:* projen.LoggerOptions
1845
+ - *Default:* {}
1846
+
1847
+ Configure logging options such as verbosity.
1848
+
1849
+ ---
1850
+
1851
+ ##### `outdir`<sup>Optional</sup> <a name="outdir" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.outdir"></a>
1852
+
1853
+ ```typescript
1854
+ public readonly outdir: string;
1855
+ ```
1856
+
1857
+ - *Type:* string
1858
+ - *Default:* "."
1859
+
1860
+ The root directory of the project.
1861
+
1862
+ Relative to this directory, all files are synthesized.
1863
+
1864
+ If this project has a parent, this directory is relative to the parent
1865
+ directory and it cannot be the same as the parent or any of it's other
1866
+ subprojects.
1867
+
1868
+ ---
1869
+
1870
+ ##### `parent`<sup>Optional</sup> <a name="parent" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.parent"></a>
1871
+
1872
+ ```typescript
1873
+ public readonly parent: Project;
1874
+ ```
1875
+
1876
+ - *Type:* projen.Project
1877
+
1878
+ The parent project, if this project is part of a bigger project.
1879
+
1880
+ ---
1881
+
1882
+ ##### `projenCommand`<sup>Optional</sup> <a name="projenCommand" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenCommand"></a>
1883
+
1884
+ ```typescript
1885
+ public readonly projenCommand: string;
1886
+ ```
1887
+
1888
+ - *Type:* string
1889
+ - *Default:* "npx projen"
1890
+
1891
+ The shell command to use in order to run the projen CLI.
1892
+
1893
+ Can be used to customize in special environments.
1894
+
1895
+ ---
1896
+
1897
+ ##### `projenrcJson`<sup>Optional</sup> <a name="projenrcJson" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcJson"></a>
1898
+
1899
+ ```typescript
1900
+ public readonly projenrcJson: boolean;
1901
+ ```
1902
+
1903
+ - *Type:* boolean
1904
+ - *Default:* false
1905
+
1906
+ Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
1907
+
1908
+ ---
1909
+
1910
+ ##### `projenrcJsonOptions`<sup>Optional</sup> <a name="projenrcJsonOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcJsonOptions"></a>
1911
+
1912
+ ```typescript
1913
+ public readonly projenrcJsonOptions: ProjenrcJsonOptions;
1914
+ ```
1915
+
1916
+ - *Type:* projen.ProjenrcJsonOptions
1917
+ - *Default:* default options
1918
+
1919
+ Options for .projenrc.json.
1920
+
1921
+ ---
1922
+
1923
+ ##### `renovatebot`<sup>Optional</sup> <a name="renovatebot" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.renovatebot"></a>
1924
+
1925
+ ```typescript
1926
+ public readonly renovatebot: boolean;
1927
+ ```
1928
+
1929
+ - *Type:* boolean
1930
+ - *Default:* false
1931
+
1932
+ Use renovatebot to handle dependency upgrades.
1933
+
1934
+ ---
1935
+
1936
+ ##### `renovatebotOptions`<sup>Optional</sup> <a name="renovatebotOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.renovatebotOptions"></a>
1937
+
1938
+ ```typescript
1939
+ public readonly renovatebotOptions: RenovatebotOptions;
1940
+ ```
1941
+
1942
+ - *Type:* projen.RenovatebotOptions
1943
+ - *Default:* default options
1944
+
1945
+ Options for renovatebot.
1946
+
1947
+ ---
1948
+
1949
+ ##### `autoApproveOptions`<sup>Optional</sup> <a name="autoApproveOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.autoApproveOptions"></a>
1950
+
1951
+ ```typescript
1952
+ public readonly autoApproveOptions: AutoApproveOptions;
1953
+ ```
1954
+
1955
+ - *Type:* projen.github.AutoApproveOptions
1956
+ - *Default:* auto approve is disabled
1957
+
1958
+ Enable and configure the 'auto approve' workflow.
1959
+
1960
+ ---
1961
+
1962
+ ##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.autoMerge"></a>
1963
+
1964
+ ```typescript
1965
+ public readonly autoMerge: boolean;
1966
+ ```
1967
+
1968
+ - *Type:* boolean
1969
+ - *Default:* true
1970
+
1971
+ Enable automatic merging on GitHub.
1972
+
1973
+ Has no effect if `github.mergify`
1974
+ is set to false.
1975
+
1976
+ ---
1977
+
1978
+ ##### `autoMergeOptions`<sup>Optional</sup> <a name="autoMergeOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.autoMergeOptions"></a>
1979
+
1980
+ ```typescript
1981
+ public readonly autoMergeOptions: AutoMergeOptions;
1982
+ ```
1983
+
1984
+ - *Type:* projen.github.AutoMergeOptions
1985
+ - *Default:* see defaults in `AutoMergeOptions`
1986
+
1987
+ Configure options for automatic merging on GitHub.
1988
+
1989
+ Has no effect if
1990
+ `github.mergify` or `autoMerge` is set to false.
1991
+
1992
+ ---
1993
+
1994
+ ##### `clobber`<sup>Optional</sup> <a name="clobber" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.clobber"></a>
1995
+
1996
+ ```typescript
1997
+ public readonly clobber: boolean;
1998
+ ```
1999
+
2000
+ - *Type:* boolean
2001
+ - *Default:* true, but false for subprojects
2002
+
2003
+ Add a `clobber` task which resets the repo to origin.
2004
+
2005
+ ---
2006
+
2007
+ ##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.devContainer"></a>
2008
+
2009
+ ```typescript
2010
+ public readonly devContainer: boolean;
2011
+ ```
2012
+
2013
+ - *Type:* boolean
2014
+ - *Default:* false
2015
+
2016
+ Add a VSCode development environment (used for GitHub Codespaces).
2017
+
2018
+ ---
2019
+
2020
+ ##### `github`<sup>Optional</sup> <a name="github" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.github"></a>
2021
+
2022
+ ```typescript
2023
+ public readonly github: boolean;
2024
+ ```
2025
+
2026
+ - *Type:* boolean
2027
+ - *Default:* true
2028
+
2029
+ Enable GitHub integration.
2030
+
2031
+ Enabled by default for root projects. Disabled for non-root projects.
2032
+
2033
+ ---
2034
+
2035
+ ##### `githubOptions`<sup>Optional</sup> <a name="githubOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.githubOptions"></a>
2036
+
2037
+ ```typescript
2038
+ public readonly githubOptions: GitHubOptions;
2039
+ ```
2040
+
2041
+ - *Type:* projen.github.GitHubOptions
2042
+ - *Default:* see GitHubOptions
2043
+
2044
+ Options for GitHub integration.
2045
+
2046
+ ---
2047
+
2048
+ ##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.gitpod"></a>
2049
+
2050
+ ```typescript
2051
+ public readonly gitpod: boolean;
2052
+ ```
2053
+
2054
+ - *Type:* boolean
2055
+ - *Default:* false
2056
+
2057
+ Add a Gitpod development environment.
2058
+
2059
+ ---
2060
+
2061
+ ##### ~~`mergify`~~<sup>Optional</sup> <a name="mergify" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.mergify"></a>
2062
+
2063
+ - *Deprecated:* use `githubOptions.mergify` instead
2064
+
2065
+ ```typescript
2066
+ public readonly mergify: boolean;
2067
+ ```
2068
+
2069
+ - *Type:* boolean
2070
+ - *Default:* true
2071
+
2072
+ Whether mergify should be enabled on this repository or not.
2073
+
2074
+ ---
2075
+
2076
+ ##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="mergifyOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.mergifyOptions"></a>
2077
+
2078
+ - *Deprecated:* use `githubOptions.mergifyOptions` instead
2079
+
2080
+ ```typescript
2081
+ public readonly mergifyOptions: MergifyOptions;
2082
+ ```
2083
+
2084
+ - *Type:* projen.github.MergifyOptions
2085
+ - *Default:* default options
2086
+
2087
+ Options for mergify.
2088
+
2089
+ ---
2090
+
2091
+ ##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projectType"></a>
2092
+
2093
+ - *Deprecated:* no longer supported at the base project level
2094
+
2095
+ ```typescript
2096
+ public readonly projectType: ProjectType;
2097
+ ```
2098
+
2099
+ - *Type:* projen.ProjectType
2100
+ - *Default:* ProjectType.UNKNOWN
2101
+
2102
+ Which type of project this is (library/app).
2103
+
2104
+ ---
2105
+
2106
+ ##### `projenCredentials`<sup>Optional</sup> <a name="projenCredentials" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenCredentials"></a>
2107
+
2108
+ ```typescript
2109
+ public readonly projenCredentials: GithubCredentials;
2110
+ ```
2111
+
2112
+ - *Type:* projen.github.GithubCredentials
2113
+ - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
2114
+
2115
+ Choose a method of providing GitHub API access for projen workflows.
2116
+
2117
+ ---
2118
+
2119
+ ##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="projenTokenSecret" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenTokenSecret"></a>
2120
+
2121
+ - *Deprecated:* use `projenCredentials`
2122
+
2123
+ ```typescript
2124
+ public readonly projenTokenSecret: string;
2125
+ ```
2126
+
2127
+ - *Type:* string
2128
+ - *Default:* "PROJEN_GITHUB_TOKEN"
2129
+
2130
+ The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
2131
+
2132
+ This token needs to have the `repo`, `workflows`
2133
+ and `packages` scope.
2134
+
2135
+ ---
2136
+
2137
+ ##### `readme`<sup>Optional</sup> <a name="readme" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.readme"></a>
2138
+
2139
+ ```typescript
2140
+ public readonly readme: SampleReadmeProps;
2141
+ ```
2142
+
2143
+ - *Type:* projen.SampleReadmeProps
2144
+ - *Default:* { filename: 'README.md', contents: '# replace this' }
2145
+
2146
+ The README setup.
2147
+
2148
+ ---
2149
+
2150
+ *Example*
2151
+
2152
+ ```typescript
2153
+ "{ filename: 'readme.md', contents: '# title' }"
2154
+ ```
2155
+
2156
+
2157
+ ##### `stale`<sup>Optional</sup> <a name="stale" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.stale"></a>
2158
+
2159
+ ```typescript
2160
+ public readonly stale: boolean;
2161
+ ```
2162
+
2163
+ - *Type:* boolean
2164
+ - *Default:* false
2165
+
2166
+ Auto-close of stale issues and pull request.
2167
+
2168
+ See `staleOptions` for options.
2169
+
2170
+ ---
2171
+
2172
+ ##### `staleOptions`<sup>Optional</sup> <a name="staleOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.staleOptions"></a>
2173
+
2174
+ ```typescript
2175
+ public readonly staleOptions: StaleOptions;
2176
+ ```
2177
+
2178
+ - *Type:* projen.github.StaleOptions
2179
+ - *Default:* see defaults in `StaleOptions`
2180
+
2181
+ Auto-close stale issues and pull requests.
2182
+
2183
+ To disable set `stale` to `false`.
2184
+
2185
+ ---
2186
+
2187
+ ##### `vscode`<sup>Optional</sup> <a name="vscode" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.vscode"></a>
2188
+
2189
+ ```typescript
2190
+ public readonly vscode: boolean;
2191
+ ```
2192
+
2193
+ - *Type:* boolean
2194
+ - *Default:* true
2195
+
2196
+ Enable VSCode integration.
2197
+
2198
+ Enabled by default for root projects. Disabled for non-root projects.
2199
+
2200
+ ---
2201
+
2202
+ ##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.allowLibraryDependencies"></a>
2203
+
2204
+ ```typescript
2205
+ public readonly allowLibraryDependencies: boolean;
2206
+ ```
2207
+
2208
+ - *Type:* boolean
2209
+ - *Default:* true
2210
+
2211
+ Allow the project to include `peerDependencies` and `bundledDependencies`.
2212
+
2213
+ This is normally only allowed for libraries. For apps, there's no meaning
2214
+ for specifying these.
2215
+
2216
+ ---
2217
+
2218
+ ##### `authorEmail`<sup>Optional</sup> <a name="authorEmail" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorEmail"></a>
2219
+
2220
+ ```typescript
2221
+ public readonly authorEmail: string;
2222
+ ```
2223
+
2224
+ - *Type:* string
2225
+
2226
+ Author's e-mail.
2227
+
2228
+ ---
2229
+
2230
+ ##### `authorName`<sup>Optional</sup> <a name="authorName" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorName"></a>
2231
+
2232
+ ```typescript
2233
+ public readonly authorName: string;
2234
+ ```
2235
+
2236
+ - *Type:* string
2237
+
2238
+ Author's name.
2239
+
2240
+ ---
2241
+
2242
+ ##### `authorOrganization`<sup>Optional</sup> <a name="authorOrganization" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorOrganization"></a>
2243
+
2244
+ ```typescript
2245
+ public readonly authorOrganization: boolean;
2246
+ ```
2247
+
2248
+ - *Type:* boolean
2249
+
2250
+ Is the author an organization.
2251
+
2252
+ ---
2253
+
2254
+ ##### `authorUrl`<sup>Optional</sup> <a name="authorUrl" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorUrl"></a>
2255
+
2256
+ ```typescript
2257
+ public readonly authorUrl: string;
2258
+ ```
2259
+
2260
+ - *Type:* string
2261
+
2262
+ Author's URL / Website.
2263
+
2264
+ ---
2265
+
2266
+ ##### `autoDetectBin`<sup>Optional</sup> <a name="autoDetectBin" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.autoDetectBin"></a>
2267
+
2268
+ ```typescript
2269
+ public readonly autoDetectBin: boolean;
2270
+ ```
2271
+
2272
+ - *Type:* boolean
2273
+ - *Default:* true
2274
+
2275
+ Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
2276
+
2277
+ ---
2278
+
2279
+ ##### `bin`<sup>Optional</sup> <a name="bin" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bin"></a>
2280
+
2281
+ ```typescript
2282
+ public readonly bin: {[ key: string ]: string};
2283
+ ```
2284
+
2285
+ - *Type:* {[ key: string ]: string}
2286
+
2287
+ Binary programs vended with your module.
2288
+
2289
+ You can use this option to add/customize how binaries are represented in
2290
+ your `package.json`, but unless `autoDetectBin` is `false`, every
2291
+ executable file under `bin` will automatically be added to this section.
2292
+
2293
+ ---
2294
+
2295
+ ##### `bugsEmail`<sup>Optional</sup> <a name="bugsEmail" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bugsEmail"></a>
2296
+
2297
+ ```typescript
2298
+ public readonly bugsEmail: string;
2299
+ ```
2300
+
2301
+ - *Type:* string
2302
+
2303
+ The email address to which issues should be reported.
2304
+
2305
+ ---
2306
+
2307
+ ##### `bugsUrl`<sup>Optional</sup> <a name="bugsUrl" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bugsUrl"></a>
2308
+
2309
+ ```typescript
2310
+ public readonly bugsUrl: string;
2311
+ ```
2312
+
2313
+ - *Type:* string
2314
+
2315
+ The url to your project's issue tracker.
2316
+
2317
+ ---
2318
+
2319
+ ##### `bundledDeps`<sup>Optional</sup> <a name="bundledDeps" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bundledDeps"></a>
2320
+
2321
+ ```typescript
2322
+ public readonly bundledDeps: string[];
2323
+ ```
2324
+
2325
+ - *Type:* string[]
2326
+
2327
+ List of dependencies to bundle into this module.
2328
+
2329
+ These modules will be
2330
+ added both to the `dependencies` section and `bundledDependencies` section of
2331
+ your `package.json`.
2332
+
2333
+ The recommendation is to only specify the module name here (e.g.
2334
+ `express`). This will behave similar to `yarn add` or `npm install` in the
2335
+ sense that it will add the module as a dependency to your `package.json`
2336
+ file with the latest version (`^`). You can specify semver requirements in
2337
+ the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
2338
+ this will be what you `package.json` will eventually include.
2339
+
2340
+ ---
2341
+
2342
+ ##### `bunVersion`<sup>Optional</sup> <a name="bunVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bunVersion"></a>
2343
+
2344
+ ```typescript
2345
+ public readonly bunVersion: string;
2346
+ ```
2347
+
2348
+ - *Type:* string
2349
+ - *Default:* "latest"
2350
+
2351
+ The version of Bun to use if using Bun as a package manager.
2352
+
2353
+ ---
2354
+
2355
+ ##### `codeArtifactOptions`<sup>Optional</sup> <a name="codeArtifactOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.codeArtifactOptions"></a>
2356
+
2357
+ ```typescript
2358
+ public readonly codeArtifactOptions: CodeArtifactOptions;
2359
+ ```
2360
+
2361
+ - *Type:* projen.javascript.CodeArtifactOptions
2362
+ - *Default:* undefined
2363
+
2364
+ Options for npm packages using AWS CodeArtifact.
2365
+
2366
+ This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
2367
+
2368
+ ---
2369
+
2370
+ ##### `deps`<sup>Optional</sup> <a name="deps" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.deps"></a>
2371
+
2372
+ ```typescript
2373
+ public readonly deps: string[];
2374
+ ```
2375
+
2376
+ - *Type:* string[]
2377
+ - *Default:* []
2378
+
2379
+ Runtime dependencies of this module.
2380
+
2381
+ The recommendation is to only specify the module name here (e.g.
2382
+ `express`). This will behave similar to `yarn add` or `npm install` in the
2383
+ sense that it will add the module as a dependency to your `package.json`
2384
+ file with the latest version (`^`). You can specify semver requirements in
2385
+ the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
2386
+ this will be what you `package.json` will eventually include.
2387
+
2388
+ ---
2389
+
2390
+ *Example*
2391
+
2392
+ ```typescript
2393
+ [ 'express', 'lodash', 'foo@^2' ]
2394
+ ```
2395
+
2396
+
2397
+ ##### `description`<sup>Optional</sup> <a name="description" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.description"></a>
2398
+
2399
+ ```typescript
2400
+ public readonly description: string;
2401
+ ```
2402
+
2403
+ - *Type:* string
2404
+
2405
+ The description is just a string that helps people understand the purpose of the package.
2406
+
2407
+ It can be used when searching for packages in a package manager as well.
2408
+ See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
2409
+
2410
+ ---
2411
+
2412
+ ##### `devDeps`<sup>Optional</sup> <a name="devDeps" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.devDeps"></a>
2413
+
2414
+ ```typescript
2415
+ public readonly devDeps: string[];
2416
+ ```
2417
+
2418
+ - *Type:* string[]
2419
+ - *Default:* []
2420
+
2421
+ Build dependencies for this module.
2422
+
2423
+ These dependencies will only be
2424
+ available in your build environment but will not be fetched when this
2425
+ module is consumed.
2426
+
2427
+ The recommendation is to only specify the module name here (e.g.
2428
+ `express`). This will behave similar to `yarn add` or `npm install` in the
2429
+ sense that it will add the module as a dependency to your `package.json`
2430
+ file with the latest version (`^`). You can specify semver requirements in
2431
+ the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
2432
+ this will be what you `package.json` will eventually include.
2433
+
2434
+ ---
2435
+
2436
+ *Example*
2437
+
2438
+ ```typescript
2439
+ [ 'typescript', '@types/express' ]
2440
+ ```
2441
+
2442
+
2443
+ ##### `entrypoint`<sup>Optional</sup> <a name="entrypoint" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.entrypoint"></a>
2444
+
2445
+ ```typescript
2446
+ public readonly entrypoint: string;
2447
+ ```
2448
+
2449
+ - *Type:* string
2450
+ - *Default:* "lib/index.js"
2451
+
2452
+ Module entrypoint (`main` in `package.json`).
2453
+
2454
+ Set to an empty string to not include `main` in your package.json
2455
+
2456
+ ---
2457
+
2458
+ ##### `homepage`<sup>Optional</sup> <a name="homepage" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.homepage"></a>
2459
+
2460
+ ```typescript
2461
+ public readonly homepage: string;
2462
+ ```
2463
+
2464
+ - *Type:* string
2465
+
2466
+ Package's Homepage / Website.
2467
+
2468
+ ---
2469
+
2470
+ ##### `keywords`<sup>Optional</sup> <a name="keywords" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.keywords"></a>
2471
+
2472
+ ```typescript
2473
+ public readonly keywords: string[];
2474
+ ```
2475
+
2476
+ - *Type:* string[]
2477
+
2478
+ Keywords to include in `package.json`.
2479
+
2480
+ ---
2481
+
2482
+ ##### `license`<sup>Optional</sup> <a name="license" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.license"></a>
2483
+
2484
+ ```typescript
2485
+ public readonly license: string;
2486
+ ```
2487
+
2488
+ - *Type:* string
2489
+ - *Default:* "Apache-2.0"
2490
+
2491
+ License's SPDX identifier.
2492
+
2493
+ See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.
2494
+ Use the `licensed` option if you want to no license to be specified.
2495
+
2496
+ ---
2497
+
2498
+ ##### `licensed`<sup>Optional</sup> <a name="licensed" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.licensed"></a>
2499
+
2500
+ ```typescript
2501
+ public readonly licensed: boolean;
2502
+ ```
2503
+
2504
+ - *Type:* boolean
2505
+ - *Default:* true
2506
+
2507
+ Indicates if a license should be added.
2508
+
2509
+ ---
2510
+
2511
+ ##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.maxNodeVersion"></a>
2512
+
2513
+ ```typescript
2514
+ public readonly maxNodeVersion: string;
2515
+ ```
2516
+
2517
+ - *Type:* string
2518
+ - *Default:* no maximum version is enforced
2519
+
2520
+ The maximum node version supported by this package. Most projects should not use this option.
2521
+
2522
+ The value indicates that the package is incompatible with any newer versions of node.
2523
+ This requirement is enforced via the engines field.
2524
+
2525
+ You will normally not need to set this option.
2526
+ Consider this option only if your package is known to not function with newer versions of node.
2527
+
2528
+ ---
2529
+
2530
+ ##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.minNodeVersion"></a>
2531
+
2532
+ ```typescript
2533
+ public readonly minNodeVersion: string;
2534
+ ```
2535
+
2536
+ - *Type:* string
2537
+ - *Default:* no minimum version is enforced
2538
+
2539
+ The minimum node version required by this package to function. Most projects should not use this option.
2540
+
2541
+ The value indicates that the package is incompatible with any older versions of node.
2542
+ This requirement is enforced via the engines field.
2543
+
2544
+ You will normally not need to set this option, even if your package is incompatible with EOL versions of node.
2545
+ Consider this option only if your package depends on a specific feature, that is not available in other LTS versions.
2546
+ Setting this option has very high impact on the consumers of your package,
2547
+ as package managers will actively prevent usage with node versions you have marked as incompatible.
2548
+
2549
+ To change the node version of your CI/CD workflows, use `workflowNodeVersion`.
2550
+
2551
+ ---
2552
+
2553
+ ##### `npmAccess`<sup>Optional</sup> <a name="npmAccess" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmAccess"></a>
2554
+
2555
+ ```typescript
2556
+ public readonly npmAccess: NpmAccess;
2557
+ ```
2558
+
2559
+ - *Type:* projen.javascript.NpmAccess
2560
+ - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
2561
+
2562
+ Access level of the npm package.
2563
+
2564
+ ---
2565
+
2566
+ ##### `npmProvenance`<sup>Optional</sup> <a name="npmProvenance" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmProvenance"></a>
2567
+
2568
+ ```typescript
2569
+ public readonly npmProvenance: boolean;
2570
+ ```
2571
+
2572
+ - *Type:* boolean
2573
+ - *Default:* true for public packages, false otherwise
2574
+
2575
+ Should provenance statements be generated when the package is published.
2576
+
2577
+ A supported package manager is required to publish a package with npm provenance statements and
2578
+ you will need to use a supported CI/CD provider.
2579
+
2580
+ Note that the projen `Release` and `Publisher` components are using `publib` to publish packages,
2581
+ which is using npm internally and supports provenance statements independently of the package manager used.
2582
+
2583
+ > [https://docs.npmjs.com/generating-provenance-statements](https://docs.npmjs.com/generating-provenance-statements)
2584
+
2585
+ ---
2586
+
2587
+ ##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="npmRegistry" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmRegistry"></a>
2588
+
2589
+ - *Deprecated:* use `npmRegistryUrl` instead
2590
+
2591
+ ```typescript
2592
+ public readonly npmRegistry: string;
2593
+ ```
2594
+
2595
+ - *Type:* string
2596
+
2597
+ The host name of the npm registry to publish to.
2598
+
2599
+ Cannot be set together with `npmRegistryUrl`.
2600
+
2601
+ ---
2602
+
2603
+ ##### `npmRegistryUrl`<sup>Optional</sup> <a name="npmRegistryUrl" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmRegistryUrl"></a>
2604
+
2605
+ ```typescript
2606
+ public readonly npmRegistryUrl: string;
2607
+ ```
2608
+
2609
+ - *Type:* string
2610
+ - *Default:* "https://registry.npmjs.org"
2611
+
2612
+ The base URL of the npm package registry.
2613
+
2614
+ Must be a URL (e.g. start with "https://" or "http://")
2615
+
2616
+ ---
2617
+
2618
+ ##### `npmTokenSecret`<sup>Optional</sup> <a name="npmTokenSecret" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmTokenSecret"></a>
2619
+
2620
+ ```typescript
2621
+ public readonly npmTokenSecret: string;
2622
+ ```
2623
+
2624
+ - *Type:* string
2625
+ - *Default:* "NPM_TOKEN"
2626
+
2627
+ GitHub secret which contains the NPM token to use when publishing packages.
2628
+
2629
+ ---
2630
+
2631
+ ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.packageManager"></a>
2632
+
2633
+ ```typescript
2634
+ public readonly packageManager: NodePackageManager;
2635
+ ```
2636
+
2637
+ - *Type:* projen.javascript.NodePackageManager
2638
+ - *Default:* NodePackageManager.YARN_CLASSIC
2639
+
2640
+ The Node Package Manager used to execute scripts.
2641
+
2642
+ ---
2643
+
2644
+ ##### `packageName`<sup>Optional</sup> <a name="packageName" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.packageName"></a>
2645
+
2646
+ ```typescript
2647
+ public readonly packageName: string;
2648
+ ```
2649
+
2650
+ - *Type:* string
2651
+ - *Default:* defaults to project name
2652
+
2653
+ The "name" in package.json.
2654
+
2655
+ ---
2656
+
2657
+ ##### `peerDependencyOptions`<sup>Optional</sup> <a name="peerDependencyOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.peerDependencyOptions"></a>
2658
+
2659
+ ```typescript
2660
+ public readonly peerDependencyOptions: PeerDependencyOptions;
2661
+ ```
2662
+
2663
+ - *Type:* projen.javascript.PeerDependencyOptions
2664
+
2665
+ Options for `peerDeps`.
2666
+
2667
+ ---
2668
+
2669
+ ##### `peerDeps`<sup>Optional</sup> <a name="peerDeps" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.peerDeps"></a>
2670
+
2671
+ ```typescript
2672
+ public readonly peerDeps: string[];
2673
+ ```
2674
+
2675
+ - *Type:* string[]
2676
+ - *Default:* []
2677
+
2678
+ Peer dependencies for this module.
2679
+
2680
+ Dependencies listed here are required to
2681
+ be installed (and satisfied) by the _consumer_ of this library. Using peer
2682
+ dependencies allows you to ensure that only a single module of a certain
2683
+ library exists in the `node_modules` tree of your consumers.
2684
+
2685
+ Note that prior to npm@7, peer dependencies are _not_ automatically
2686
+ installed, which means that adding peer dependencies to a library will be a
2687
+ breaking change for your customers.
2688
+
2689
+ Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is
2690
+ enabled by default), projen will automatically add a dev dependency with a
2691
+ pinned version for each peer dependency. This will ensure that you build &
2692
+ test your module against the lowest peer version required.
2693
+
2694
+ ---
2695
+
2696
+ ##### `pnpmVersion`<sup>Optional</sup> <a name="pnpmVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.pnpmVersion"></a>
2697
+
2698
+ ```typescript
2699
+ public readonly pnpmVersion: string;
2700
+ ```
2701
+
2702
+ - *Type:* string
2703
+ - *Default:* "9"
2704
+
2705
+ The version of PNPM to use if using PNPM as a package manager.
2706
+
2707
+ ---
2708
+
2709
+ ##### `repository`<sup>Optional</sup> <a name="repository" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.repository"></a>
2710
+
2711
+ ```typescript
2712
+ public readonly repository: string;
2713
+ ```
2714
+
2715
+ - *Type:* string
2716
+
2717
+ The repository is the location where the actual code for your package lives.
2718
+
2719
+ See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
2720
+
2721
+ ---
2722
+
2723
+ ##### `repositoryDirectory`<sup>Optional</sup> <a name="repositoryDirectory" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.repositoryDirectory"></a>
2724
+
2725
+ ```typescript
2726
+ public readonly repositoryDirectory: string;
2727
+ ```
2728
+
2729
+ - *Type:* string
2730
+
2731
+ If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
2732
+
2733
+ ---
2734
+
2735
+ ##### `scopedPackagesOptions`<sup>Optional</sup> <a name="scopedPackagesOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.scopedPackagesOptions"></a>
2736
+
2737
+ ```typescript
2738
+ public readonly scopedPackagesOptions: ScopedPackagesOptions[];
2739
+ ```
2740
+
2741
+ - *Type:* projen.javascript.ScopedPackagesOptions[]
2742
+ - *Default:* fetch all scoped packages from the public npm registry
2743
+
2744
+ Options for privately hosted scoped packages.
2745
+
2746
+ ---
2747
+
2748
+ ##### ~~`scripts`~~<sup>Optional</sup> <a name="scripts" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.scripts"></a>
2749
+
2750
+ - *Deprecated:* use `project.addTask()` or `package.setScript()`
2751
+
2752
+ ```typescript
2753
+ public readonly scripts: {[ key: string ]: string};
2754
+ ```
2755
+
2756
+ - *Type:* {[ key: string ]: string}
2757
+ - *Default:* {}
2758
+
2759
+ npm scripts to include.
2760
+
2761
+ If a script has the same name as a standard script,
2762
+ the standard script will be overwritten.
2763
+ Also adds the script as a task.
2764
+
2765
+ ---
2766
+
2767
+ ##### `stability`<sup>Optional</sup> <a name="stability" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.stability"></a>
2768
+
2769
+ ```typescript
2770
+ public readonly stability: string;
2771
+ ```
2772
+
2773
+ - *Type:* string
2774
+
2775
+ Package's Stability.
2776
+
2777
+ ---
2778
+
2779
+ ##### `yarnBerryOptions`<sup>Optional</sup> <a name="yarnBerryOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.yarnBerryOptions"></a>
2780
+
2781
+ ```typescript
2782
+ public readonly yarnBerryOptions: YarnBerryOptions;
2783
+ ```
2784
+
2785
+ - *Type:* projen.javascript.YarnBerryOptions
2786
+ - *Default:* Yarn Berry v4 with all default options
2787
+
2788
+ Options for Yarn Berry.
2789
+
2790
+ ---
2791
+
2792
+ ##### `bumpPackage`<sup>Optional</sup> <a name="bumpPackage" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bumpPackage"></a>
2793
+
2794
+ ```typescript
2795
+ public readonly bumpPackage: string;
2796
+ ```
2797
+
2798
+ - *Type:* string
2799
+ - *Default:* A recent version of "commit-and-tag-version"
2800
+
2801
+ The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string.
2802
+
2803
+ This can be any compatible package version, including the deprecated `standard-version@9`.
2804
+
2805
+ ---
2806
+
2807
+ ##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.jsiiReleaseVersion"></a>
2808
+
2809
+ ```typescript
2810
+ public readonly jsiiReleaseVersion: string;
2811
+ ```
2812
+
2813
+ - *Type:* string
2814
+ - *Default:* "latest"
2815
+
2816
+ Version requirement of `publib` which is used to publish modules to npm.
2817
+
2818
+ ---
2819
+
2820
+ ##### `majorVersion`<sup>Optional</sup> <a name="majorVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.majorVersion"></a>
2821
+
2822
+ ```typescript
2823
+ public readonly majorVersion: number;
2824
+ ```
2825
+
2826
+ - *Type:* number
2827
+ - *Default:* Major version is not enforced.
2828
+
2829
+ Major version to release from the default branch.
2830
+
2831
+ If this is specified, we bump the latest version of this major version line.
2832
+ If not specified, we bump the global latest version.
2833
+
2834
+ ---
2835
+
2836
+ ##### `minMajorVersion`<sup>Optional</sup> <a name="minMajorVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.minMajorVersion"></a>
2837
+
2838
+ ```typescript
2839
+ public readonly minMajorVersion: number;
2840
+ ```
2841
+
2842
+ - *Type:* number
2843
+ - *Default:* No minimum version is being enforced
2844
+
2845
+ Minimal Major version to release.
2846
+
2847
+ This can be useful to set to 1, as breaking changes before the 1.x major
2848
+ release are not incrementing the major version number.
2849
+
2850
+ Can not be set together with `majorVersion`.
2851
+
2852
+ ---
2853
+
2854
+ ##### `nextVersionCommand`<sup>Optional</sup> <a name="nextVersionCommand" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.nextVersionCommand"></a>
2855
+
2856
+ ```typescript
2857
+ public readonly nextVersionCommand: string;
2858
+ ```
2859
+
2860
+ - *Type:* string
2861
+ - *Default:* The next version will be determined based on the commit history and project settings.
2862
+
2863
+ A shell command to control the next version to release.
2864
+
2865
+ If present, this shell command will be run before the bump is executed, and
2866
+ it determines what version to release. It will be executed in the following
2867
+ environment:
2868
+
2869
+ - Working directory: the project directory.
2870
+ - `$VERSION`: the current version. Looks like `1.2.3`.
2871
+ - `$LATEST_TAG`: the most recent tag. Looks like `prefix-v1.2.3`, or may be unset.
2872
+
2873
+ The command should print one of the following to `stdout`:
2874
+
2875
+ - Nothing: the next version number will be determined based on commit history.
2876
+ - `x.y.z`: the next version number will be `x.y.z`.
2877
+ - `major|minor|patch`: the next version number will be the current version number
2878
+ with the indicated component bumped.
2879
+
2880
+ This setting cannot be specified together with `minMajorVersion`; the invoked
2881
+ script can be used to achieve the effects of `minMajorVersion`.
2882
+
2883
+ ---
2884
+
2885
+ ##### `npmDistTag`<sup>Optional</sup> <a name="npmDistTag" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmDistTag"></a>
2886
+
2887
+ ```typescript
2888
+ public readonly npmDistTag: string;
2889
+ ```
2890
+
2891
+ - *Type:* string
2892
+ - *Default:* "latest"
2893
+
2894
+ The npmDistTag to use when publishing from the default branch.
2895
+
2896
+ To set the npm dist-tag for release branches, set the `npmDistTag` property
2897
+ for each branch.
2898
+
2899
+ ---
2900
+
2901
+ ##### `postBuildSteps`<sup>Optional</sup> <a name="postBuildSteps" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.postBuildSteps"></a>
2902
+
2903
+ ```typescript
2904
+ public readonly postBuildSteps: JobStep[];
2905
+ ```
2906
+
2907
+ - *Type:* projen.github.workflows.JobStep[]
2908
+ - *Default:* []
2909
+
2910
+ Steps to execute after build as part of the release workflow.
2911
+
2912
+ ---
2913
+
2914
+ ##### `prerelease`<sup>Optional</sup> <a name="prerelease" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.prerelease"></a>
2915
+
2916
+ ```typescript
2917
+ public readonly prerelease: string;
2918
+ ```
2919
+
2920
+ - *Type:* string
2921
+ - *Default:* normal semantic versions
2922
+
2923
+ Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
2924
+
2925
+ ---
2926
+
2927
+ ##### `publishDryRun`<sup>Optional</sup> <a name="publishDryRun" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishDryRun"></a>
2928
+
2929
+ ```typescript
2930
+ public readonly publishDryRun: boolean;
2931
+ ```
2932
+
2933
+ - *Type:* boolean
2934
+ - *Default:* false
2935
+
2936
+ Instead of actually publishing to package managers, just print the publishing command.
2937
+
2938
+ ---
2939
+
2940
+ ##### `publishTasks`<sup>Optional</sup> <a name="publishTasks" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishTasks"></a>
2941
+
2942
+ ```typescript
2943
+ public readonly publishTasks: boolean;
2944
+ ```
2945
+
2946
+ - *Type:* boolean
2947
+ - *Default:* false
2948
+
2949
+ Define publishing tasks that can be executed manually as well as workflows.
2950
+
2951
+ Normally, publishing only happens within automated workflows. Enable this
2952
+ in order to create a publishing task for each publishing activity.
2953
+
2954
+ ---
2955
+
2956
+ ##### `releasableCommits`<sup>Optional</sup> <a name="releasableCommits" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releasableCommits"></a>
2957
+
2958
+ ```typescript
2959
+ public readonly releasableCommits: ReleasableCommits;
2960
+ ```
2961
+
2962
+ - *Type:* projen.ReleasableCommits
2963
+ - *Default:* ReleasableCommits.everyCommit()
2964
+
2965
+ Find commits that should be considered releasable Used to decide if a release is required.
2966
+
2967
+ ---
2968
+
2969
+ ##### `releaseBranches`<sup>Optional</sup> <a name="releaseBranches" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseBranches"></a>
2970
+
2971
+ ```typescript
2972
+ public readonly releaseBranches: {[ key: string ]: BranchOptions};
2973
+ ```
2974
+
2975
+ - *Type:* {[ key: string ]: projen.release.BranchOptions}
2976
+ - *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches.
2977
+
2978
+ Defines additional release branches.
2979
+
2980
+ A workflow will be created for each
2981
+ release branch which will publish releases from commits in this branch.
2982
+ Each release branch _must_ be assigned a major version number which is used
2983
+ to enforce that versions published from that branch always use that major
2984
+ version. If multiple branches are used, the `majorVersion` field must also
2985
+ be provided for the default branch.
2986
+
2987
+ ---
2988
+
2989
+ ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseEveryCommit"></a>
2990
+
2991
+ - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
2992
+
2993
+ ```typescript
2994
+ public readonly releaseEveryCommit: boolean;
2995
+ ```
2996
+
2997
+ - *Type:* boolean
2998
+ - *Default:* true
2999
+
3000
+ Automatically release new versions every commit to one of branches in `releaseBranches`.
3001
+
3002
+ ---
3003
+
3004
+ ##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseFailureIssue"></a>
3005
+
3006
+ ```typescript
3007
+ public readonly releaseFailureIssue: boolean;
3008
+ ```
3009
+
3010
+ - *Type:* boolean
3011
+ - *Default:* false
3012
+
3013
+ Create a github issue on every failed publishing task.
3014
+
3015
+ ---
3016
+
3017
+ ##### `releaseFailureIssueLabel`<sup>Optional</sup> <a name="releaseFailureIssueLabel" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseFailureIssueLabel"></a>
3018
+
3019
+ ```typescript
3020
+ public readonly releaseFailureIssueLabel: string;
3021
+ ```
3022
+
3023
+ - *Type:* string
3024
+ - *Default:* "failed-release"
3025
+
3026
+ The label to apply to issues indicating publish failures.
3027
+
3028
+ Only applies if `releaseFailureIssue` is true.
3029
+
3030
+ ---
3031
+
3032
+ ##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="releaseSchedule" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseSchedule"></a>
3033
+
3034
+ - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
3035
+
3036
+ ```typescript
3037
+ public readonly releaseSchedule: string;
3038
+ ```
3039
+
3040
+ - *Type:* string
3041
+ - *Default:* no scheduled releases
3042
+
3043
+ CRON schedule to trigger new releases.
3044
+
3045
+ ---
3046
+
3047
+ ##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseTagPrefix"></a>
3048
+
3049
+ ```typescript
3050
+ public readonly releaseTagPrefix: string;
3051
+ ```
3052
+
3053
+ - *Type:* string
3054
+ - *Default:* "v"
3055
+
3056
+ Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
3057
+
3058
+ Note: this prefix is used to detect the latest tagged version
3059
+ when bumping, so if you change this on a project with an existing version
3060
+ history, you may need to manually tag your latest release
3061
+ with the new prefix.
3062
+
3063
+ ---
3064
+
3065
+ ##### `releaseTrigger`<sup>Optional</sup> <a name="releaseTrigger" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseTrigger"></a>
3066
+
3067
+ ```typescript
3068
+ public readonly releaseTrigger: ReleaseTrigger;
3069
+ ```
3070
+
3071
+ - *Type:* projen.release.ReleaseTrigger
3072
+ - *Default:* Continuous releases (`ReleaseTrigger.continuous()`)
3073
+
3074
+ The release trigger to use.
3075
+
3076
+ ---
3077
+
3078
+ ##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseWorkflowName"></a>
3079
+
3080
+ ```typescript
3081
+ public readonly releaseWorkflowName: string;
3082
+ ```
3083
+
3084
+ - *Type:* string
3085
+ - *Default:* "release"
3086
+
3087
+ The name of the default release workflow.
3088
+
3089
+ ---
3090
+
3091
+ ##### `releaseWorkflowSetupSteps`<sup>Optional</sup> <a name="releaseWorkflowSetupSteps" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseWorkflowSetupSteps"></a>
3092
+
3093
+ ```typescript
3094
+ public readonly releaseWorkflowSetupSteps: JobStep[];
3095
+ ```
3096
+
3097
+ - *Type:* projen.github.workflows.JobStep[]
3098
+
3099
+ A set of workflow steps to execute in order to setup the workflow container.
3100
+
3101
+ ---
3102
+
3103
+ ##### `versionrcOptions`<sup>Optional</sup> <a name="versionrcOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.versionrcOptions"></a>
3104
+
3105
+ ```typescript
3106
+ public readonly versionrcOptions: {[ key: string ]: any};
3107
+ ```
3108
+
3109
+ - *Type:* {[ key: string ]: any}
3110
+ - *Default:* standard configuration applicable for GitHub repositories
3111
+
3112
+ Custom configuration used when creating changelog with commit-and-tag-version package.
3113
+
3114
+ Given values either append to default configuration or overwrite values in it.
3115
+
3116
+ ---
3117
+
3118
+ ##### `workflowContainerImage`<sup>Optional</sup> <a name="workflowContainerImage" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowContainerImage"></a>
3119
+
3120
+ ```typescript
3121
+ public readonly workflowContainerImage: string;
3122
+ ```
3123
+
3124
+ - *Type:* string
3125
+ - *Default:* default image
3126
+
3127
+ Container image to use for GitHub workflows.
3128
+
3129
+ ---
3130
+
3131
+ ##### `workflowRunsOn`<sup>Optional</sup> <a name="workflowRunsOn" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowRunsOn"></a>
3132
+
3133
+ ```typescript
3134
+ public readonly workflowRunsOn: string[];
3135
+ ```
3136
+
3137
+ - *Type:* string[]
3138
+ - *Default:* ["ubuntu-latest"]
3139
+
3140
+ Github Runner selection labels.
3141
+
3142
+ ---
3143
+
3144
+ ##### `workflowRunsOnGroup`<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowRunsOnGroup"></a>
3145
+
3146
+ ```typescript
3147
+ public readonly workflowRunsOnGroup: GroupRunnerOptions;
3148
+ ```
3149
+
3150
+ - *Type:* projen.GroupRunnerOptions
3151
+
3152
+ Github Runner Group selection options.
3153
+
3154
+ ---
3155
+
3156
+ ##### `defaultReleaseBranch`<sup>Required</sup> <a name="defaultReleaseBranch" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.defaultReleaseBranch"></a>
3157
+
3158
+ ```typescript
3159
+ public readonly defaultReleaseBranch: string;
3160
+ ```
3161
+
3162
+ - *Type:* string
3163
+ - *Default:* "main"
3164
+
3165
+ The name of the main release branch.
3166
+
3167
+ ---
3168
+
3169
+ ##### `artifactsDirectory`<sup>Optional</sup> <a name="artifactsDirectory" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.artifactsDirectory"></a>
3170
+
3171
+ ```typescript
3172
+ public readonly artifactsDirectory: string;
3173
+ ```
3174
+
3175
+ - *Type:* string
3176
+ - *Default:* "dist"
3177
+
3178
+ A directory which will contain build artifacts.
3179
+
3180
+ ---
3181
+
3182
+ ##### `autoApproveUpgrades`<sup>Optional</sup> <a name="autoApproveUpgrades" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.autoApproveUpgrades"></a>
3183
+
3184
+ ```typescript
3185
+ public readonly autoApproveUpgrades: boolean;
3186
+ ```
3187
+
3188
+ - *Type:* boolean
3189
+ - *Default:* true
3190
+
3191
+ Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
3192
+
3193
+ Throw if set to true but `autoApproveOptions` are not defined.
3194
+
3195
+ ---
3196
+
3197
+ ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.buildWorkflow"></a>
3198
+
3199
+ ```typescript
3200
+ public readonly buildWorkflow: boolean;
3201
+ ```
3202
+
3203
+ - *Type:* boolean
3204
+ - *Default:* true if not a subproject
3205
+
3206
+ Define a GitHub workflow for building PRs.
3207
+
3208
+ ---
3209
+
3210
+ ##### `buildWorkflowOptions`<sup>Optional</sup> <a name="buildWorkflowOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.buildWorkflowOptions"></a>
3211
+
3212
+ ```typescript
3213
+ public readonly buildWorkflowOptions: BuildWorkflowOptions;
3214
+ ```
3215
+
3216
+ - *Type:* projen.javascript.BuildWorkflowOptions
3217
+
3218
+ Options for PR build workflow.
3219
+
3220
+ ---
3221
+
3222
+ ##### ~~`buildWorkflowTriggers`~~<sup>Optional</sup> <a name="buildWorkflowTriggers" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.buildWorkflowTriggers"></a>
3223
+
3224
+ - *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers`
3225
+
3226
+ ```typescript
3227
+ public readonly buildWorkflowTriggers: Triggers;
3228
+ ```
3229
+
3230
+ - *Type:* projen.github.workflows.Triggers
3231
+ - *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
3232
+
3233
+ Build workflow triggers.
3234
+
3235
+ ---
3236
+
3237
+ ##### `bundlerOptions`<sup>Optional</sup> <a name="bundlerOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bundlerOptions"></a>
3238
+
3239
+ ```typescript
3240
+ public readonly bundlerOptions: BundlerOptions;
3241
+ ```
3242
+
3243
+ - *Type:* projen.javascript.BundlerOptions
3244
+
3245
+ Options for `Bundler`.
3246
+
3247
+ ---
3248
+
3249
+ ##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.checkLicenses"></a>
3250
+
3251
+ ```typescript
3252
+ public readonly checkLicenses: LicenseCheckerOptions;
3253
+ ```
3254
+
3255
+ - *Type:* projen.javascript.LicenseCheckerOptions
3256
+ - *Default:* no license checks are run during the build and all licenses will be accepted
3257
+
3258
+ Configure which licenses should be deemed acceptable for use by dependencies.
3259
+
3260
+ This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
3261
+
3262
+ ---
3263
+
3264
+ ##### `codeCov`<sup>Optional</sup> <a name="codeCov" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.codeCov"></a>
3265
+
3266
+ ```typescript
3267
+ public readonly codeCov: boolean;
3268
+ ```
3269
+
3270
+ - *Type:* boolean
3271
+ - *Default:* false
3272
+
3273
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
3274
+
3275
+ ---
3276
+
3277
+ ##### `codeCovTokenSecret`<sup>Optional</sup> <a name="codeCovTokenSecret" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.codeCovTokenSecret"></a>
3278
+
3279
+ ```typescript
3280
+ public readonly codeCovTokenSecret: string;
3281
+ ```
3282
+
3283
+ - *Type:* string
3284
+ - *Default:* if this option is not specified, only public repositories are supported
3285
+
3286
+ Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
3287
+
3288
+ ---
3289
+
3290
+ ##### `copyrightOwner`<sup>Optional</sup> <a name="copyrightOwner" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.copyrightOwner"></a>
3291
+
3292
+ ```typescript
3293
+ public readonly copyrightOwner: string;
3294
+ ```
3295
+
3296
+ - *Type:* string
3297
+ - *Default:* defaults to the value of authorName or "" if `authorName` is undefined.
3298
+
3299
+ License copyright owner.
3300
+
3301
+ ---
3302
+
3303
+ ##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.copyrightPeriod"></a>
3304
+
3305
+ ```typescript
3306
+ public readonly copyrightPeriod: string;
3307
+ ```
3308
+
3309
+ - *Type:* string
3310
+ - *Default:* current year
3311
+
3312
+ The copyright years to put in the LICENSE file.
3313
+
3314
+ ---
3315
+
3316
+ ##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.dependabot"></a>
3317
+
3318
+ ```typescript
3319
+ public readonly dependabot: boolean;
3320
+ ```
3321
+
3322
+ - *Type:* boolean
3323
+ - *Default:* false
3324
+
3325
+ Use dependabot to handle dependency upgrades.
3326
+
3327
+ Cannot be used in conjunction with `depsUpgrade`.
3328
+
3329
+ ---
3330
+
3331
+ ##### `dependabotOptions`<sup>Optional</sup> <a name="dependabotOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.dependabotOptions"></a>
3332
+
3333
+ ```typescript
3334
+ public readonly dependabotOptions: DependabotOptions;
3335
+ ```
3336
+
3337
+ - *Type:* projen.github.DependabotOptions
3338
+ - *Default:* default options
3339
+
3340
+ Options for dependabot.
3341
+
3342
+ ---
3343
+
3344
+ ##### `depsUpgrade`<sup>Optional</sup> <a name="depsUpgrade" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.depsUpgrade"></a>
3345
+
3346
+ ```typescript
3347
+ public readonly depsUpgrade: boolean;
3348
+ ```
3349
+
3350
+ - *Type:* boolean
3351
+ - *Default:* true
3352
+
3353
+ Use tasks and github workflows to handle dependency upgrades.
3354
+
3355
+ Cannot be used in conjunction with `dependabot`.
3356
+
3357
+ ---
3358
+
3359
+ ##### `depsUpgradeOptions`<sup>Optional</sup> <a name="depsUpgradeOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.depsUpgradeOptions"></a>
3360
+
3361
+ ```typescript
3362
+ public readonly depsUpgradeOptions: UpgradeDependenciesOptions;
3363
+ ```
3364
+
3365
+ - *Type:* projen.javascript.UpgradeDependenciesOptions
3366
+ - *Default:* default options
3367
+
3368
+ Options for `UpgradeDependencies`.
3369
+
3370
+ ---
3371
+
3372
+ ##### `gitignore`<sup>Optional</sup> <a name="gitignore" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.gitignore"></a>
3373
+
3374
+ ```typescript
3375
+ public readonly gitignore: string[];
3376
+ ```
3377
+
3378
+ - *Type:* string[]
3379
+
3380
+ Additional entries to .gitignore.
3381
+
3382
+ ---
3383
+
3384
+ ##### `jest`<sup>Optional</sup> <a name="jest" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.jest"></a>
3385
+
3386
+ ```typescript
3387
+ public readonly jest: boolean;
3388
+ ```
3389
+
3390
+ - *Type:* boolean
3391
+ - *Default:* true
3392
+
3393
+ Setup jest unit tests.
3394
+
3395
+ ---
3396
+
3397
+ ##### `jestOptions`<sup>Optional</sup> <a name="jestOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.jestOptions"></a>
3398
+
3399
+ ```typescript
3400
+ public readonly jestOptions: JestOptions;
3401
+ ```
3402
+
3403
+ - *Type:* projen.javascript.JestOptions
3404
+ - *Default:* default options
3405
+
3406
+ Jest options.
3407
+
3408
+ ---
3409
+
3410
+ ##### ~~`mutableBuild`~~<sup>Optional</sup> <a name="mutableBuild" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.mutableBuild"></a>
3411
+
3412
+ - *Deprecated:* - Use `buildWorkflowOptions.mutableBuild`
3413
+
3414
+ ```typescript
3415
+ public readonly mutableBuild: boolean;
3416
+ ```
3417
+
3418
+ - *Type:* boolean
3419
+ - *Default:* true
3420
+
3421
+ Automatically update files modified during builds to pull-request branches.
3422
+
3423
+ This means
3424
+ that any files synthesized by projen or e.g. test snapshots will always be up-to-date
3425
+ before a PR is merged.
3426
+
3427
+ Implies that PR builds do not have anti-tamper checks.
3428
+
3429
+ ---
3430
+
3431
+ ##### ~~`npmignore`~~<sup>Optional</sup> <a name="npmignore" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmignore"></a>
3432
+
3433
+ - *Deprecated:* - use `project.addPackageIgnore`
3434
+
3435
+ ```typescript
3436
+ public readonly npmignore: string[];
3437
+ ```
3438
+
3439
+ - *Type:* string[]
3440
+
3441
+ Additional entries to .npmignore.
3442
+
3443
+ ---
3444
+
3445
+ ##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmignoreEnabled"></a>
3446
+
3447
+ ```typescript
3448
+ public readonly npmignoreEnabled: boolean;
3449
+ ```
3450
+
3451
+ - *Type:* boolean
3452
+ - *Default:* true
3453
+
3454
+ Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
3455
+
3456
+ ---
3457
+
3458
+ ##### `npmIgnoreOptions`<sup>Optional</sup> <a name="npmIgnoreOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmIgnoreOptions"></a>
3459
+
3460
+ ```typescript
3461
+ public readonly npmIgnoreOptions: IgnoreFileOptions;
3462
+ ```
3463
+
3464
+ - *Type:* projen.IgnoreFileOptions
3465
+
3466
+ Configuration options for .npmignore file.
3467
+
3468
+ ---
3469
+
3470
+ ##### `package`<sup>Optional</sup> <a name="package" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.package"></a>
3471
+
3472
+ ```typescript
3473
+ public readonly package: boolean;
3474
+ ```
3475
+
3476
+ - *Type:* boolean
3477
+ - *Default:* true
3478
+
3479
+ Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
3480
+
3481
+ ---
3482
+
3483
+ ##### `prettier`<sup>Optional</sup> <a name="prettier" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.prettier"></a>
3484
+
3485
+ ```typescript
3486
+ public readonly prettier: boolean;
3487
+ ```
3488
+
3489
+ - *Type:* boolean
3490
+ - *Default:* false
3491
+
3492
+ Setup prettier.
3493
+
3494
+ ---
3495
+
3496
+ ##### `prettierOptions`<sup>Optional</sup> <a name="prettierOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.prettierOptions"></a>
3497
+
3498
+ ```typescript
3499
+ public readonly prettierOptions: PrettierOptions;
3500
+ ```
3501
+
3502
+ - *Type:* projen.javascript.PrettierOptions
3503
+ - *Default:* default options
3504
+
3505
+ Prettier options.
3506
+
3507
+ ---
3508
+
3509
+ ##### `projenDevDependency`<sup>Optional</sup> <a name="projenDevDependency" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenDevDependency"></a>
3510
+
3511
+ ```typescript
3512
+ public readonly projenDevDependency: boolean;
3513
+ ```
3514
+
3515
+ - *Type:* boolean
3516
+ - *Default:* true if not a subproject
3517
+
3518
+ Indicates of "projen" should be installed as a devDependency.
3519
+
3520
+ ---
3521
+
3522
+ ##### `projenrcJs`<sup>Optional</sup> <a name="projenrcJs" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcJs"></a>
3523
+
3524
+ ```typescript
3525
+ public readonly projenrcJs: boolean;
3526
+ ```
3527
+
3528
+ - *Type:* boolean
3529
+ - *Default:* true if projenrcJson is false
3530
+
3531
+ Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
3532
+
3533
+ ---
3534
+
3535
+ ##### `projenrcJsOptions`<sup>Optional</sup> <a name="projenrcJsOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcJsOptions"></a>
3536
+
3537
+ ```typescript
3538
+ public readonly projenrcJsOptions: ProjenrcOptions;
3539
+ ```
3540
+
3541
+ - *Type:* projen.javascript.ProjenrcOptions
3542
+ - *Default:* default options
3543
+
3544
+ Options for .projenrc.js.
3545
+
3546
+ ---
3547
+
3548
+ ##### `projenVersion`<sup>Optional</sup> <a name="projenVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenVersion"></a>
3549
+
3550
+ ```typescript
3551
+ public readonly projenVersion: string;
3552
+ ```
3553
+
3554
+ - *Type:* string
3555
+ - *Default:* Defaults to the latest version.
3556
+
3557
+ Version of projen to install.
3558
+
3559
+ ---
3560
+
3561
+ ##### `pullRequestTemplate`<sup>Optional</sup> <a name="pullRequestTemplate" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.pullRequestTemplate"></a>
3562
+
3563
+ ```typescript
3564
+ public readonly pullRequestTemplate: boolean;
3565
+ ```
3566
+
3567
+ - *Type:* boolean
3568
+ - *Default:* true
3569
+
3570
+ Include a GitHub pull request template.
3571
+
3572
+ ---
3573
+
3574
+ ##### `pullRequestTemplateContents`<sup>Optional</sup> <a name="pullRequestTemplateContents" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.pullRequestTemplateContents"></a>
3575
+
3576
+ ```typescript
3577
+ public readonly pullRequestTemplateContents: string[];
3578
+ ```
3579
+
3580
+ - *Type:* string[]
3581
+ - *Default:* default content
3582
+
3583
+ The contents of the pull request template.
3584
+
3585
+ ---
3586
+
3587
+ ##### `release`<sup>Optional</sup> <a name="release" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.release"></a>
3588
+
3589
+ ```typescript
3590
+ public readonly release: boolean;
3591
+ ```
3592
+
3593
+ - *Type:* boolean
3594
+ - *Default:* true (false for subprojects)
3595
+
3596
+ Add release management to this project.
3597
+
3598
+ ---
3599
+
3600
+ ##### `releaseToNpm`<sup>Optional</sup> <a name="releaseToNpm" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseToNpm"></a>
3601
+
3602
+ ```typescript
3603
+ public readonly releaseToNpm: boolean;
3604
+ ```
3605
+
3606
+ - *Type:* boolean
3607
+ - *Default:* false
3608
+
3609
+ Automatically release to npm when new versions are introduced.
3610
+
3611
+ ---
3612
+
3613
+ ##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="releaseWorkflow" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseWorkflow"></a>
3614
+
3615
+ - *Deprecated:* see `release`.
3616
+
3617
+ ```typescript
3618
+ public readonly releaseWorkflow: boolean;
3619
+ ```
3620
+
3621
+ - *Type:* boolean
3622
+ - *Default:* true if not a subproject
3623
+
3624
+ DEPRECATED: renamed to `release`.
3625
+
3626
+ ---
3627
+
3628
+ ##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="workflowBootstrapSteps" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowBootstrapSteps"></a>
3629
+
3630
+ ```typescript
3631
+ public readonly workflowBootstrapSteps: JobStep[];
3632
+ ```
3633
+
3634
+ - *Type:* projen.github.workflows.JobStep[]
3635
+ - *Default:* "yarn install --frozen-lockfile && yarn projen"
3636
+
3637
+ Workflow steps to use in order to bootstrap this repo.
3638
+
3639
+ ---
3640
+
3641
+ ##### `workflowGitIdentity`<sup>Optional</sup> <a name="workflowGitIdentity" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowGitIdentity"></a>
3642
+
3643
+ ```typescript
3644
+ public readonly workflowGitIdentity: GitIdentity;
3645
+ ```
3646
+
3647
+ - *Type:* projen.github.GitIdentity
3648
+ - *Default:* GitHub Actions
3649
+
3650
+ The git identity to use in workflows.
3651
+
3652
+ ---
3653
+
3654
+ ##### `workflowNodeVersion`<sup>Optional</sup> <a name="workflowNodeVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowNodeVersion"></a>
3655
+
3656
+ ```typescript
3657
+ public readonly workflowNodeVersion: string;
3658
+ ```
3659
+
3660
+ - *Type:* string
3661
+ - *Default:* `minNodeVersion` if set, otherwise `lts/*`.
3662
+
3663
+ The node version used in GitHub Actions workflows.
3664
+
3665
+ Always use this option if your GitHub Actions workflows require a specific to run.
3666
+
3667
+ ---
3668
+
3669
+ ##### `workflowPackageCache`<sup>Optional</sup> <a name="workflowPackageCache" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowPackageCache"></a>
3670
+
3671
+ ```typescript
3672
+ public readonly workflowPackageCache: boolean;
3673
+ ```
3674
+
3675
+ - *Type:* boolean
3676
+ - *Default:* false
3677
+
3678
+ Enable Node.js package cache in GitHub workflows.
3679
+
3680
+ ---
3681
+
3682
+ ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.disableTsconfig"></a>
3683
+
3684
+ ```typescript
3685
+ public readonly disableTsconfig: boolean;
3686
+ ```
3687
+
3688
+ - *Type:* boolean
3689
+ - *Default:* false
3690
+
3691
+ Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
3692
+
3693
+ ---
3694
+
3695
+ ##### `disableTsconfigDev`<sup>Optional</sup> <a name="disableTsconfigDev" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.disableTsconfigDev"></a>
3696
+
3697
+ ```typescript
3698
+ public readonly disableTsconfigDev: boolean;
3699
+ ```
3700
+
3701
+ - *Type:* boolean
3702
+ - *Default:* false
3703
+
3704
+ Do not generate a `tsconfig.dev.json` file.
3705
+
3706
+ ---
3707
+
3708
+ ##### `docgen`<sup>Optional</sup> <a name="docgen" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.docgen"></a>
3709
+
3710
+ ```typescript
3711
+ public readonly docgen: boolean;
3712
+ ```
3713
+
3714
+ - *Type:* boolean
3715
+ - *Default:* false
3716
+
3717
+ Docgen by Typedoc.
3718
+
3719
+ ---
3720
+
3721
+ ##### `docsDirectory`<sup>Optional</sup> <a name="docsDirectory" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.docsDirectory"></a>
3722
+
3723
+ ```typescript
3724
+ public readonly docsDirectory: string;
3725
+ ```
3726
+
3727
+ - *Type:* string
3728
+ - *Default:* "docs"
3729
+
3730
+ Docs directory.
3731
+
3732
+ ---
3733
+
3734
+ ##### `entrypointTypes`<sup>Optional</sup> <a name="entrypointTypes" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.entrypointTypes"></a>
3735
+
3736
+ ```typescript
3737
+ public readonly entrypointTypes: string;
3738
+ ```
3739
+
3740
+ - *Type:* string
3741
+ - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
3742
+
3743
+ The .d.ts file that includes the type declarations for this module.
3744
+
3745
+ ---
3746
+
3747
+ ##### `eslint`<sup>Optional</sup> <a name="eslint" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.eslint"></a>
3748
+
3749
+ ```typescript
3750
+ public readonly eslint: boolean;
3751
+ ```
3752
+
3753
+ - *Type:* boolean
3754
+ - *Default:* true
3755
+
3756
+ Setup eslint.
3757
+
3758
+ ---
3759
+
3760
+ ##### `eslintOptions`<sup>Optional</sup> <a name="eslintOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.eslintOptions"></a>
3761
+
3762
+ ```typescript
3763
+ public readonly eslintOptions: EslintOptions;
3764
+ ```
3765
+
3766
+ - *Type:* projen.javascript.EslintOptions
3767
+ - *Default:* opinionated default options
3768
+
3769
+ Eslint options.
3770
+
3771
+ ---
3772
+
3773
+ ##### `libdir`<sup>Optional</sup> <a name="libdir" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.libdir"></a>
3774
+
3775
+ ```typescript
3776
+ public readonly libdir: string;
3777
+ ```
3778
+
3779
+ - *Type:* string
3780
+ - *Default:* "lib"
3781
+
3782
+ Typescript artifacts output directory.
3783
+
3784
+ ---
3785
+
3786
+ ##### `projenrcTs`<sup>Optional</sup> <a name="projenrcTs" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcTs"></a>
3787
+
3788
+ ```typescript
3789
+ public readonly projenrcTs: boolean;
3790
+ ```
3791
+
3792
+ - *Type:* boolean
3793
+ - *Default:* false
3794
+
3795
+ Use TypeScript for your projenrc file (`.projenrc.ts`).
3796
+
3797
+ ---
3798
+
3799
+ ##### `projenrcTsOptions`<sup>Optional</sup> <a name="projenrcTsOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcTsOptions"></a>
3800
+
3801
+ ```typescript
3802
+ public readonly projenrcTsOptions: ProjenrcOptions;
3803
+ ```
3804
+
3805
+ - *Type:* projen.typescript.ProjenrcOptions
3806
+
3807
+ Options for .projenrc.ts.
3808
+
3809
+ ---
3810
+
3811
+ ##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.sampleCode"></a>
3812
+
3813
+ ```typescript
3814
+ public readonly sampleCode: boolean;
3815
+ ```
3816
+
3817
+ - *Type:* boolean
3818
+ - *Default:* true
3819
+
3820
+ Generate one-time sample in `src/` and `test/` if there are no files there.
3821
+
3822
+ ---
3823
+
3824
+ ##### `srcdir`<sup>Optional</sup> <a name="srcdir" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.srcdir"></a>
3825
+
3826
+ ```typescript
3827
+ public readonly srcdir: string;
3828
+ ```
3829
+
3830
+ - *Type:* string
3831
+ - *Default:* "src"
3832
+
3833
+ Typescript sources directory.
3834
+
3835
+ ---
3836
+
3837
+ ##### `testdir`<sup>Optional</sup> <a name="testdir" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.testdir"></a>
3838
+
3839
+ ```typescript
3840
+ public readonly testdir: string;
3841
+ ```
3842
+
3843
+ - *Type:* string
3844
+ - *Default:* "test"
3845
+
3846
+ Jest tests directory. Tests files should be named `xxx.test.ts`.
3847
+
3848
+ If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),
3849
+ then tests are going to be compiled into `lib/` and executed as javascript.
3850
+ If the test directory is outside of `src`, then we configure jest to
3851
+ compile the code in-memory.
3852
+
3853
+ ---
3854
+
3855
+ ##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.tsconfig"></a>
3856
+
3857
+ ```typescript
3858
+ public readonly tsconfig: TypescriptConfigOptions;
3859
+ ```
3860
+
3861
+ - *Type:* projen.javascript.TypescriptConfigOptions
3862
+ - *Default:* default options
3863
+
3864
+ Custom TSConfig.
3865
+
3866
+ ---
3867
+
3868
+ ##### `tsconfigDev`<sup>Optional</sup> <a name="tsconfigDev" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.tsconfigDev"></a>
3869
+
3870
+ ```typescript
3871
+ public readonly tsconfigDev: TypescriptConfigOptions;
3872
+ ```
3873
+
3874
+ - *Type:* projen.javascript.TypescriptConfigOptions
3875
+ - *Default:* use the production tsconfig options
3876
+
3877
+ Custom tsconfig options for the development tsconfig.json file (used for testing).
3878
+
3879
+ ---
3880
+
3881
+ ##### `tsconfigDevFile`<sup>Optional</sup> <a name="tsconfigDevFile" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.tsconfigDevFile"></a>
3882
+
3883
+ ```typescript
3884
+ public readonly tsconfigDevFile: string;
3885
+ ```
3886
+
3887
+ - *Type:* string
3888
+ - *Default:* "tsconfig.dev.json"
3889
+
3890
+ The name of the development tsconfig.json file.
3891
+
3892
+ ---
3893
+
3894
+ ##### `tsJestOptions`<sup>Optional</sup> <a name="tsJestOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.tsJestOptions"></a>
3895
+
3896
+ ```typescript
3897
+ public readonly tsJestOptions: TsJestOptions;
3898
+ ```
3899
+
3900
+ - *Type:* projen.typescript.TsJestOptions
3901
+
3902
+ Options for ts-jest.
3903
+
3904
+ ---
3905
+
3906
+ ##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.typescriptVersion"></a>
3907
+
3908
+ ```typescript
3909
+ public readonly typescriptVersion: string;
3910
+ ```
3911
+
3912
+ - *Type:* string
3913
+ - *Default:* "latest"
3914
+
3915
+ TypeScript version to use.
3916
+
3917
+ NOTE: Typescript is not semantically versioned and should remain on the
3918
+ same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
3919
+
3920
+ ---
3921
+
3922
+ ##### `author`<sup>Required</sup> <a name="author" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.author"></a>
3923
+
3924
+ ```typescript
3925
+ public readonly author: string;
3926
+ ```
3927
+
3928
+ - *Type:* string
3929
+ - *Default:* $GIT_USER_NAME
3930
+
3931
+ The name of the library author.
3932
+
3933
+ ---
3934
+
3935
+ ##### `authorAddress`<sup>Required</sup> <a name="authorAddress" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorAddress"></a>
3936
+
3937
+ ```typescript
3938
+ public readonly authorAddress: string;
3939
+ ```
3940
+
3941
+ - *Type:* string
3942
+ - *Default:* $GIT_USER_EMAIL
3943
+
3944
+ Email or URL of the library author.
3945
+
3946
+ ---
3947
+
3948
+ ##### `repositoryUrl`<sup>Required</sup> <a name="repositoryUrl" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.repositoryUrl"></a>
3949
+
3950
+ ```typescript
3951
+ public readonly repositoryUrl: string;
3952
+ ```
3953
+
3954
+ - *Type:* string
3955
+ - *Default:* $GIT_REMOTE
3956
+
3957
+ Git repository URL.
3958
+
3959
+ ---
3960
+
3961
+ ##### `compat`<sup>Optional</sup> <a name="compat" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.compat"></a>
3962
+
3963
+ ```typescript
3964
+ public readonly compat: boolean;
3965
+ ```
3966
+
3967
+ - *Type:* boolean
3968
+ - *Default:* false
3969
+
3970
+ Automatically run API compatibility test against the latest version published to npm after compilation.
3971
+
3972
+ You can manually run compatibility tests using `yarn compat` if this feature is disabled.
3973
+ - You can ignore compatibility failures by adding lines to a ".compatignore" file.
3974
+
3975
+ ---
3976
+
3977
+ ##### `compatIgnore`<sup>Optional</sup> <a name="compatIgnore" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.compatIgnore"></a>
3978
+
3979
+ ```typescript
3980
+ public readonly compatIgnore: string;
3981
+ ```
3982
+
3983
+ - *Type:* string
3984
+ - *Default:* ".compatignore"
3985
+
3986
+ Name of the ignore file for API compatibility tests.
3987
+
3988
+ ---
3989
+
3990
+ ##### `compressAssembly`<sup>Optional</sup> <a name="compressAssembly" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.compressAssembly"></a>
3991
+
3992
+ ```typescript
3993
+ public readonly compressAssembly: boolean;
3994
+ ```
3995
+
3996
+ - *Type:* boolean
3997
+ - *Default:* false
3998
+
3999
+ Emit a compressed version of the assembly.
4000
+
4001
+ ---
4002
+
4003
+ ##### `docgenFilePath`<sup>Optional</sup> <a name="docgenFilePath" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.docgenFilePath"></a>
4004
+
4005
+ ```typescript
4006
+ public readonly docgenFilePath: string;
4007
+ ```
4008
+
4009
+ - *Type:* string
4010
+ - *Default:* "API.md"
4011
+
4012
+ File path for generated docs.
4013
+
4014
+ ---
4015
+
4016
+ ##### ~~`dotnet`~~<sup>Optional</sup> <a name="dotnet" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.dotnet"></a>
4017
+
4018
+ - *Deprecated:* use `publishToNuget`
4019
+
4020
+ ```typescript
4021
+ public readonly dotnet: JsiiDotNetTarget;
4022
+ ```
4023
+
4024
+ - *Type:* projen.cdk.JsiiDotNetTarget
4025
+
4026
+ ---
4027
+
4028
+ ##### `excludeTypescript`<sup>Optional</sup> <a name="excludeTypescript" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.excludeTypescript"></a>
4029
+
4030
+ ```typescript
4031
+ public readonly excludeTypescript: string[];
4032
+ ```
4033
+
4034
+ - *Type:* string[]
4035
+
4036
+ Accepts a list of glob patterns.
4037
+
4038
+ Files matching any of those patterns will be excluded from the TypeScript compiler input.
4039
+
4040
+ By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input.
4041
+ This can be problematic for example when the package's build or test procedure generates .ts files
4042
+ that cannot be compiled with jsii's compiler settings.
4043
+
4044
+ ---
4045
+
4046
+ ##### `jsiiVersion`<sup>Optional</sup> <a name="jsiiVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.jsiiVersion"></a>
4047
+
4048
+ ```typescript
4049
+ public readonly jsiiVersion: string;
4050
+ ```
4051
+
4052
+ - *Type:* string
4053
+ - *Default:* "~5.6.0"
4054
+
4055
+ Version of the jsii compiler to use.
4056
+
4057
+ Set to "*" if you want to manually manage the version of jsii in your
4058
+ project by managing updates to `package.json` on your own.
4059
+
4060
+ NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned
4061
+ and should remain on the same minor, so we recommend using a `~` dependency
4062
+ (e.g. `~5.0.0`).
4063
+
4064
+ ---
4065
+
4066
+ ##### `publishToGo`<sup>Optional</sup> <a name="publishToGo" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishToGo"></a>
4067
+
4068
+ ```typescript
4069
+ public readonly publishToGo: JsiiGoTarget;
4070
+ ```
4071
+
4072
+ - *Type:* projen.cdk.JsiiGoTarget
4073
+ - *Default:* no publishing
4074
+
4075
+ Publish Go bindings to a git repository.
4076
+
4077
+ ---
4078
+
4079
+ ##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishToMaven"></a>
4080
+
4081
+ ```typescript
4082
+ public readonly publishToMaven: JsiiJavaTarget;
4083
+ ```
4084
+
4085
+ - *Type:* projen.cdk.JsiiJavaTarget
4086
+ - *Default:* no publishing
4087
+
4088
+ Publish to maven.
4089
+
4090
+ ---
4091
+
4092
+ ##### `publishToNuget`<sup>Optional</sup> <a name="publishToNuget" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishToNuget"></a>
4093
+
4094
+ ```typescript
4095
+ public readonly publishToNuget: JsiiDotNetTarget;
4096
+ ```
4097
+
4098
+ - *Type:* projen.cdk.JsiiDotNetTarget
4099
+ - *Default:* no publishing
4100
+
4101
+ Publish to NuGet.
4102
+
4103
+ ---
4104
+
4105
+ ##### `publishToPypi`<sup>Optional</sup> <a name="publishToPypi" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishToPypi"></a>
4106
+
4107
+ ```typescript
4108
+ public readonly publishToPypi: JsiiPythonTarget;
4109
+ ```
4110
+
4111
+ - *Type:* projen.cdk.JsiiPythonTarget
4112
+ - *Default:* no publishing
4113
+
4114
+ Publish to pypi.
4115
+
4116
+ ---
4117
+
4118
+ ##### ~~`python`~~<sup>Optional</sup> <a name="python" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.python"></a>
4119
+
4120
+ - *Deprecated:* use `publishToPyPi`
4121
+
4122
+ ```typescript
4123
+ public readonly python: JsiiPythonTarget;
4124
+ ```
4125
+
4126
+ - *Type:* projen.cdk.JsiiPythonTarget
4127
+
4128
+ ---
4129
+
4130
+ ##### `rootdir`<sup>Optional</sup> <a name="rootdir" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.rootdir"></a>
4131
+
4132
+ ```typescript
4133
+ public readonly rootdir: string;
4134
+ ```
4135
+
4136
+ - *Type:* string
4137
+ - *Default:* "."
4138
+
4139
+ ---
4140
+
4141
+ ##### `catalog`<sup>Optional</sup> <a name="catalog" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.catalog"></a>
4142
+
4143
+ ```typescript
4144
+ public readonly catalog: Catalog;
4145
+ ```
4146
+
4147
+ - *Type:* projen.cdk.Catalog
4148
+ - *Default:* new version will be announced
4149
+
4150
+ Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.
4151
+
4152
+ https://awscdk.io/packages/[@SCOPE/]PACKAGE@VERSION
4153
+
4154
+ The catalog will also post a tweet to https://twitter.com/awscdkio with the
4155
+ package name, description and the above link. You can disable these tweets
4156
+ through `{ announce: false }`.
4157
+
4158
+ You can also add a Twitter handle through `{ twitter: 'xx' }` which will be
4159
+ mentioned in the tweet.
4160
+
4161
+ > [https://github.com/construct-catalog/catalog](https://github.com/construct-catalog/catalog)
4162
+
4163
+ ---
4164
+
4165
+ ##### `cdkVersion`<sup>Required</sup> <a name="cdkVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkVersion"></a>
4166
+
4167
+ ```typescript
4168
+ public readonly cdkVersion: string;
4169
+ ```
4170
+
4171
+ - *Type:* string
4172
+ - *Default:* "2.1.0"
4173
+
4174
+ Minimum version of the AWS CDK to depend on.
4175
+
4176
+ ---
4177
+
4178
+ ##### ~~`cdkAssert`~~<sup>Optional</sup> <a name="cdkAssert" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkAssert"></a>
4179
+
4180
+ - *Deprecated:* The
4181
+
4182
+ ```typescript
4183
+ public readonly cdkAssert: boolean;
4184
+ ```
4185
+
4186
+ - *Type:* boolean
4187
+ - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0
4188
+
4189
+ Warning: NodeJS only.
4190
+
4191
+ Install the
4192
+
4193
+ ---
4194
+
4195
+ ##### `cdkAssertions`<sup>Optional</sup> <a name="cdkAssertions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkAssertions"></a>
4196
+
4197
+ ```typescript
4198
+ public readonly cdkAssertions: boolean;
4199
+ ```
4200
+
4201
+ - *Type:* boolean
4202
+ - *Default:* will be included by default for AWS CDK >= 1.111.0 < 2.0.0
4203
+
4204
+ Install the assertions library?
4205
+
4206
+ Only needed for CDK 1.x. If using CDK 2.x then
4207
+ assertions is already included in 'aws-cdk-lib'
4208
+
4209
+ ---
4210
+
4211
+ ##### `cdkCliVersion`<sup>Optional</sup> <a name="cdkCliVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkCliVersion"></a>
4212
+
4213
+ ```typescript
4214
+ public readonly cdkCliVersion: string;
4215
+ ```
4216
+
4217
+ - *Type:* string
4218
+ - *Default:* "^2"
4219
+
4220
+ Version range of the AWS CDK CLI to depend on.
4221
+
4222
+ Can be either a specific version, or an NPM version range.
4223
+
4224
+ By default, the latest 2.x version will be installed; you can use this
4225
+ option to restrict it to a specific version or version range.
4226
+
4227
+ ---
4228
+
4229
+ ##### ~~`cdkDependencies`~~<sup>Optional</sup> <a name="cdkDependencies" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkDependencies"></a>
4230
+
4231
+ - *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)
4232
+
4233
+ ```typescript
4234
+ public readonly cdkDependencies: string[];
4235
+ ```
4236
+
4237
+ - *Type:* string[]
4238
+
4239
+ Which AWS CDKv1 modules this project requires.
4240
+
4241
+ ---
4242
+
4243
+ ##### ~~`cdkDependenciesAsDeps`~~<sup>Optional</sup> <a name="cdkDependenciesAsDeps" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkDependenciesAsDeps"></a>
4244
+
4245
+ - *Deprecated:* Not supported in CDK v2.
4246
+
4247
+ ```typescript
4248
+ public readonly cdkDependenciesAsDeps: boolean;
4249
+ ```
4250
+
4251
+ - *Type:* boolean
4252
+ - *Default:* true
4253
+
4254
+ If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).
4255
+
4256
+ This is to ensure that downstream consumers actually have your CDK dependencies installed
4257
+ when using npm < 7 or yarn, where peer dependencies are not automatically installed.
4258
+ If this is disabled, `cdkDependencies` will be added to `devDependencies` to ensure
4259
+ they are present during development.
4260
+
4261
+ Note: this setting only applies to construct library projects
4262
+
4263
+ ---
4264
+
4265
+ ##### ~~`cdkTestDependencies`~~<sup>Optional</sup> <a name="cdkTestDependencies" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkTestDependencies"></a>
4266
+
4267
+ - *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead
4268
+
4269
+ ```typescript
4270
+ public readonly cdkTestDependencies: string[];
4271
+ ```
4272
+
4273
+ - *Type:* string[]
4274
+
4275
+ AWS CDK modules required for testing.
4276
+
4277
+ ---
4278
+
4279
+ ##### `cdkVersionPinning`<sup>Optional</sup> <a name="cdkVersionPinning" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkVersionPinning"></a>
4280
+
4281
+ ```typescript
4282
+ public readonly cdkVersionPinning: boolean;
4283
+ ```
4284
+
4285
+ - *Type:* boolean
4286
+
4287
+ Use pinned version instead of caret version for CDK.
4288
+
4289
+ You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates.
4290
+ If you use experimental features this will let you define the moment you include breaking changes.
4291
+
4292
+ ---
4293
+
4294
+ ##### `constructsVersion`<sup>Optional</sup> <a name="constructsVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.constructsVersion"></a>
4295
+
4296
+ ```typescript
4297
+ public readonly constructsVersion: string;
4298
+ ```
4299
+
4300
+ - *Type:* string
4301
+ - *Default:* for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
4302
+
4303
+ Minimum version of the `constructs` library to depend on.
4304
+
4305
+ ---
4306
+
4307
+ ##### `edgeLambdaAutoDiscover`<sup>Optional</sup> <a name="edgeLambdaAutoDiscover" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.edgeLambdaAutoDiscover"></a>
4308
+
4309
+ ```typescript
4310
+ public readonly edgeLambdaAutoDiscover: boolean;
4311
+ ```
4312
+
4313
+ - *Type:* boolean
4314
+ - *Default:* true
4315
+
4316
+ Automatically adds an `cloudfront.experimental.EdgeFunction` for each `.edge-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project.
4317
+
4318
+ ---
4319
+
4320
+ ##### `experimentalIntegRunner`<sup>Optional</sup> <a name="experimentalIntegRunner" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.experimentalIntegRunner"></a>
4321
+
4322
+ ```typescript
4323
+ public readonly experimentalIntegRunner: boolean;
4324
+ ```
4325
+
4326
+ - *Type:* boolean
4327
+ - *Default:* false
4328
+
4329
+ Enable experimental support for the AWS CDK integ-runner.
4330
+
4331
+ ---
4332
+
4333
+ ##### `integrationTestAutoDiscover`<sup>Optional</sup> <a name="integrationTestAutoDiscover" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.integrationTestAutoDiscover"></a>
4334
+
4335
+ ```typescript
4336
+ public readonly integrationTestAutoDiscover: boolean;
4337
+ ```
4338
+
4339
+ - *Type:* boolean
4340
+ - *Default:* true
4341
+
4342
+ Automatically discovers and creates integration tests for each `.integ.ts` file under your test directory.
4343
+
4344
+ ---
4345
+
4346
+ ##### `lambdaAutoDiscover`<sup>Optional</sup> <a name="lambdaAutoDiscover" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.lambdaAutoDiscover"></a>
4347
+
4348
+ ```typescript
4349
+ public readonly lambdaAutoDiscover: boolean;
4350
+ ```
4351
+
4352
+ - *Type:* boolean
4353
+ - *Default:* true
4354
+
4355
+ Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in your source tree. If this is disabled, you either need to explicitly call `aws_lambda.Function.autoDiscover()` or define a `new aws_lambda.Function()` for each handler.
4356
+
4357
+ ---
4358
+
4359
+ ##### `lambdaExtensionAutoDiscover`<sup>Optional</sup> <a name="lambdaExtensionAutoDiscover" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.lambdaExtensionAutoDiscover"></a>
4360
+
4361
+ ```typescript
4362
+ public readonly lambdaExtensionAutoDiscover: boolean;
4363
+ ```
4364
+
4365
+ - *Type:* boolean
4366
+ - *Default:* true
4367
+
4368
+ Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project.
4369
+
4370
+ ---
4371
+
4372
+ ##### `lambdaOptions`<sup>Optional</sup> <a name="lambdaOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.lambdaOptions"></a>
4373
+
4374
+ ```typescript
4375
+ public readonly lambdaOptions: LambdaFunctionCommonOptions;
4376
+ ```
4377
+
4378
+ - *Type:* projen.awscdk.LambdaFunctionCommonOptions
4379
+ - *Default:* default options
4380
+
4381
+ Common options for all AWS Lambda functions.
4382
+
4383
+ ---
4384
+
4385
+ ##### `baseAssetsDirectory`<sup>Optional</sup> <a name="baseAssetsDirectory" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.baseAssetsDirectory"></a>
4386
+
4387
+ ```typescript
4388
+ public readonly baseAssetsDirectory: string;
4389
+ ```
4390
+
4391
+ - *Type:* string
4392
+ - *Default:* ${cwd()}/node_modules/mvc-projen/assets
4393
+
4394
+ Base directory for the assets.
4395
+
4396
+ ---
4397
+
4398
+ ##### `integTestRegions`<sup>Optional</sup> <a name="integTestRegions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.integTestRegions"></a>
4399
+
4400
+ ```typescript
4401
+ public readonly integTestRegions: string[];
4402
+ ```
4403
+
4404
+ - *Type:* string[]
4405
+ - *Default:* eu-west-1 and eu-west-2
4406
+
4407
+ The regions to run the integ tests in.
4408
+
4409
+ ---
4410
+
4411
+
4412
+