@mavogel/mvc-projen 0.0.24 → 0.0.26

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 CHANGED
@@ -36,7 +36,6 @@ new MvcCdkConstructLibrary(options: MvcCdkConstructLibraryOptions)
36
36
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
37
37
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
38
38
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addTask">addTask</a></code> | Adds a new task to this project. |
39
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
40
39
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
41
40
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
42
41
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
@@ -44,25 +43,19 @@ new MvcCdkConstructLibrary(options: MvcCdkConstructLibraryOptions)
44
43
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
45
44
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.synth">synth</a></code> | Synthesize all project files into `outdir`. |
46
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. |
47
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
48
46
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
49
47
  | <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. |
50
48
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addBins">addBins</a></code> | *No description.* |
51
49
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
52
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
53
50
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addDeps">addDeps</a></code> | Defines normal dependencies. |
54
51
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
55
52
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addFields">addFields</a></code> | Directly set fields in `package.json`. |
56
53
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
57
54
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
58
55
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
59
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
60
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
61
56
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
62
57
  | <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. |
63
58
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
64
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addCdkDependencies">addCdkDependencies</a></code> | Adds dependencies to AWS CDK modules. |
65
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.addCdkTestDependencies">addCdkTestDependencies</a></code> | Adds AWS CDK modules as dev dependencies. |
66
59
 
67
60
  ---
68
61
 
@@ -173,22 +166,6 @@ Task properties.
173
166
 
174
167
  ---
175
168
 
176
- ##### ~~`addTip`~~ <a name="addTip" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addTip"></a>
177
-
178
- ```typescript
179
- public addTip(message: string): void
180
- ```
181
-
182
- Prints a "tip" message during synthesis.
183
-
184
- ###### `message`<sup>Required</sup> <a name="message" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addTip.parameter.message"></a>
185
-
186
- - *Type:* string
187
-
188
- The message.
189
-
190
- ---
191
-
192
169
  ##### `annotateGenerated` <a name="annotateGenerated" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.annotateGenerated"></a>
193
170
 
194
171
  ```typescript
@@ -254,7 +231,7 @@ public runTaskCommand(task: Task): string
254
231
  Returns the shell command to execute in order to run a task.
255
232
 
256
233
  This will
257
- typically be `npx projen TASK`.
234
+ typically be `pnpm projen TASK`.
258
235
 
259
236
  ###### `task`<sup>Required</sup> <a name="task" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.runTaskCommand.parameter.task"></a>
260
237
 
@@ -276,8 +253,10 @@ Synthesize all project files into `outdir`.
276
253
  2. Delete all generated files
277
254
  3. Synthesize all subprojects
278
255
  4. Synthesize all components of this project
279
- 5. Call "postSynthesize()" for all components of this project
280
- 6. Call "this.postSynthesize()"
256
+ 5. Call "projectCreation()" for all components, only if the project is being created for the first time
257
+ 6. Call "postSynthesize()" for all components of this project
258
+ 7. Call "this.postSynthesize()"
259
+ 8. Call "postProjectCreation()" for all components, only if the project is being created for the first time
281
260
 
282
261
  ##### `tryFindFile` <a name="tryFindFile" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindFile"></a>
283
262
 
@@ -298,22 +277,6 @@ from the root of _this_ project.
298
277
 
299
278
  ---
300
279
 
301
- ##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindJsonFile"></a>
302
-
303
- ```typescript
304
- public tryFindJsonFile(filePath: string): JsonFile
305
- ```
306
-
307
- Finds a json file by name.
308
-
309
- ###### `filePath`<sup>Required</sup> <a name="filePath" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindJsonFile.parameter.filePath"></a>
310
-
311
- - *Type:* string
312
-
313
- The file path.
314
-
315
- ---
316
-
317
280
  ##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.tryFindObjectFile"></a>
318
281
 
319
282
  ```typescript
@@ -379,27 +342,13 @@ Bundled dependencies will be added as normal dependencies as well as to the
379
342
  Names modules to install.
380
343
 
381
344
  By default, the the dependency will
382
- be installed in the next `npx projen` run and the version will be recorded
383
- in your `package.json` file. You can upgrade manually or using `yarn
384
- add/upgrade`. If you wish to specify a version range use this syntax:
345
+ be installed in the next `pnpm projen` run and the version will be recorded
346
+ in your `package.json` file. You can upgrade manually or using `pnpm
347
+ add/update`. If you wish to specify a version range use this syntax:
385
348
  `module@^7`.
386
349
 
387
350
  ---
388
351
 
389
- ##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addCompileCommand"></a>
390
-
391
- ```typescript
392
- public addCompileCommand(commands: ...string[]): void
393
- ```
394
-
395
- DEPRECATED.
396
-
397
- ###### `commands`<sup>Required</sup> <a name="commands" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addCompileCommand.parameter.commands"></a>
398
-
399
- - *Type:* ...string[]
400
-
401
- ---
402
-
403
352
  ##### `addDeps` <a name="addDeps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addDeps"></a>
404
353
 
405
354
  ```typescript
@@ -415,9 +364,9 @@ Defines normal dependencies.
415
364
  Names modules to install.
416
365
 
417
366
  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:
367
+ be installed in the next `pnpm projen` run and the version will be recorded
368
+ in your `package.json` file. You can upgrade manually or using `pnpm
369
+ add/update`. If you wish to specify a version range use this syntax:
421
370
  `module@^7`.
422
371
 
423
372
  ---
@@ -437,9 +386,9 @@ Defines development/test dependencies.
437
386
  Names modules to install.
438
387
 
439
388
  By default, the the dependency will
440
- be installed in the next `npx projen` run and the version will be recorded
441
- in your `package.json` file. You can upgrade manually or using `yarn
442
- add/upgrade`. If you wish to specify a version range use this syntax:
389
+ be installed in the next `pnpm projen` run and the version will be recorded
390
+ in your `package.json` file. You can upgrade manually or using `pnpm
391
+ add/update`. If you wish to specify a version range use this syntax:
443
392
  `module@^7`.
444
393
 
445
394
  ---
@@ -495,9 +444,9 @@ your code against the minimum version required from your consumers.
495
444
  Names modules to install.
496
445
 
497
446
  By default, the the dependency will
498
- be installed in the next `npx projen` run and the version will be recorded
499
- in your `package.json` file. You can upgrade manually or using `yarn
500
- add/upgrade`. If you wish to specify a version range use this syntax:
447
+ be installed in the next `pnpm projen` run and the version will be recorded
448
+ in your `package.json` file. You can upgrade manually or using `pnpm
449
+ add/update`. If you wish to specify a version range use this syntax:
501
450
  `module@^7`.
502
451
 
503
452
  ---
@@ -518,36 +467,6 @@ The scripts to set.
518
467
 
519
468
  ---
520
469
 
521
- ##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addTestCommand"></a>
522
-
523
- ```typescript
524
- public addTestCommand(commands: ...string[]): void
525
- ```
526
-
527
- DEPRECATED.
528
-
529
- ###### `commands`<sup>Required</sup> <a name="commands" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addTestCommand.parameter.commands"></a>
530
-
531
- - *Type:* ...string[]
532
-
533
- ---
534
-
535
- ##### ~~`hasScript`~~ <a name="hasScript" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.hasScript"></a>
536
-
537
- ```typescript
538
- public hasScript(name: string): boolean
539
- ```
540
-
541
- Indicates if a script by the name name is defined.
542
-
543
- ###### `name`<sup>Required</sup> <a name="name" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.hasScript.parameter.name"></a>
544
-
545
- - *Type:* string
546
-
547
- The name of the script.
548
-
549
- ---
550
-
551
470
  ##### `removeScript` <a name="removeScript" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.removeScript"></a>
552
471
 
553
472
  ```typescript
@@ -604,40 +523,6 @@ The command to execute.
604
523
 
605
524
  ---
606
525
 
607
- ##### ~~`addCdkDependencies`~~ <a name="addCdkDependencies" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addCdkDependencies"></a>
608
-
609
- ```typescript
610
- public addCdkDependencies(deps: ...string[]): void
611
- ```
612
-
613
- Adds dependencies to AWS CDK modules.
614
-
615
- Since this is a library project, dependencies will be added as peer dependencies.
616
-
617
- ###### `deps`<sup>Required</sup> <a name="deps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addCdkDependencies.parameter.deps"></a>
618
-
619
- - *Type:* ...string[]
620
-
621
- names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
622
-
623
- ---
624
-
625
- ##### ~~`addCdkTestDependencies`~~ <a name="addCdkTestDependencies" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addCdkTestDependencies"></a>
626
-
627
- ```typescript
628
- public addCdkTestDependencies(deps: ...string[]): void
629
- ```
630
-
631
- Adds AWS CDK modules as dev dependencies.
632
-
633
- ###### `deps`<sup>Required</sup> <a name="deps" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.addCdkTestDependencies.parameter.deps"></a>
634
-
635
- - *Type:* ...string[]
636
-
637
- names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
638
-
639
- ---
640
-
641
526
  #### Static Functions <a name="Static Functions" id="Static Functions"></a>
642
527
 
643
528
  | **Name** | **Description** |
@@ -743,21 +628,16 @@ When given a project, this it the project itself.
743
628
  | <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". |
744
629
  | <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`. |
745
630
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
746
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
747
631
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
748
632
  | <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). |
749
633
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
750
634
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
751
635
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
752
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
753
636
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
754
637
  | <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`). |
755
638
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
756
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
757
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
758
639
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
759
640
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
760
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
761
641
  | <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). |
762
642
  | <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. |
763
643
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
@@ -768,11 +648,11 @@ When given a project, this it the project itself.
768
648
  | <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. |
769
649
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
770
650
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
771
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
772
651
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
773
652
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
774
653
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
775
654
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
655
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner used for executing TypeScript files. |
776
656
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
777
657
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
778
658
  | <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). |
@@ -783,7 +663,6 @@ When given a project, this it the project itself.
783
663
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.tsconfigEslint">tsconfigEslint</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
784
664
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.cdkDeps">cdkDeps</a></code> | <code>projen.awscdk.AwsCdkDeps</code> | *No description.* |
785
665
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | The target CDK version for this library. |
786
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibrary.property.version">version</a></code> | <code>string</code> | *No description.* |
787
666
 
788
667
  ---
789
668
 
@@ -1054,7 +933,9 @@ the project is being ejected.
1054
933
 
1055
934
  ---
1056
935
 
1057
- ##### `initProject`<sup>Optional</sup> <a name="initProject" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.initProject"></a>
936
+ ##### ~~`initProject`~~<sup>Optional</sup> <a name="initProject" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.initProject"></a>
937
+
938
+ - *Deprecated:* use the `initProject` argument passed to `Component.projectCreation()` instead.
1058
939
 
1059
940
  ```typescript
1060
941
  public readonly initProject: InitProject;
@@ -1084,16 +965,6 @@ If undefined, this is the root project.
1084
965
 
1085
966
  ---
1086
967
 
1087
- ##### `projectType`<sup>Required</sup> <a name="projectType" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.projectType"></a>
1088
-
1089
- ```typescript
1090
- public readonly projectType: ProjectType;
1091
- ```
1092
-
1093
- - *Type:* projen.ProjectType
1094
-
1095
- ---
1096
-
1097
968
  ##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.autoApprove"></a>
1098
969
 
1099
970
  ```typescript
@@ -1162,18 +1033,6 @@ This will be `undefined` for subprojects.
1162
1033
 
1163
1034
  ---
1164
1035
 
1165
- ##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.allowLibraryDependencies"></a>
1166
-
1167
- - *Deprecated:* use `package.allowLibraryDependencies`
1168
-
1169
- ```typescript
1170
- public readonly allowLibraryDependencies: boolean;
1171
- ```
1172
-
1173
- - *Type:* boolean
1174
-
1175
- ---
1176
-
1177
1036
  ##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.artifactsDirectory"></a>
1178
1037
 
1179
1038
  ```typescript
@@ -1212,30 +1071,6 @@ public readonly bundler: Bundler;
1212
1071
 
1213
1072
  ---
1214
1073
 
1215
- ##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.entrypoint"></a>
1216
-
1217
- - *Deprecated:* use `package.entrypoint`
1218
-
1219
- ```typescript
1220
- public readonly entrypoint: string;
1221
- ```
1222
-
1223
- - *Type:* string
1224
-
1225
- ---
1226
-
1227
- ##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.manifest"></a>
1228
-
1229
- - *Deprecated:* use `package.addField(x, y)`
1230
-
1231
- ```typescript
1232
- public readonly manifest: any;
1233
- ```
1234
-
1235
- - *Type:* any
1236
-
1237
- ---
1238
-
1239
1074
  ##### `npmrc`<sup>Required</sup> <a name="npmrc" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.npmrc"></a>
1240
1075
 
1241
1076
  ```typescript
@@ -1260,20 +1095,6 @@ API for managing the node package.
1260
1095
 
1261
1096
  ---
1262
1097
 
1263
- ##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.packageManager"></a>
1264
-
1265
- - *Deprecated:* use `package.packageManager`
1266
-
1267
- ```typescript
1268
- public readonly packageManager: NodePackageManager;
1269
- ```
1270
-
1271
- - *Type:* projen.javascript.NodePackageManager
1272
-
1273
- The package manager to use.
1274
-
1275
- ---
1276
-
1277
1098
  ##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.runScriptCommand"></a>
1278
1099
 
1279
1100
  ```typescript
@@ -1396,23 +1217,6 @@ public readonly prettier: Prettier;
1396
1217
 
1397
1218
  ---
1398
1219
 
1399
- ##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.publisher"></a>
1400
-
1401
- - *Deprecated:* use `release.publisher`.
1402
-
1403
- ```typescript
1404
- public readonly publisher: Publisher;
1405
- ```
1406
-
1407
- - *Type:* projen.release.Publisher
1408
-
1409
- Package publisher.
1410
-
1411
- This will be `undefined` if the project does not have a
1412
- release workflow.
1413
-
1414
- ---
1415
-
1416
1220
  ##### `release`<sup>Optional</sup> <a name="release" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.release"></a>
1417
1221
 
1418
1222
  ```typescript
@@ -1459,6 +1263,18 @@ The directory in which compiled .js files reside.
1459
1263
 
1460
1264
  ---
1461
1265
 
1266
+ ##### `runner`<sup>Required</sup> <a name="runner" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.runner"></a>
1267
+
1268
+ ```typescript
1269
+ public readonly runner: TypeScriptRunner;
1270
+ ```
1271
+
1272
+ - *Type:* projen.typescript.TypeScriptRunner
1273
+
1274
+ The TypeScript runner used for executing TypeScript files.
1275
+
1276
+ ---
1277
+
1462
1278
  ##### `srcdir`<sup>Required</sup> <a name="srcdir" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.srcdir"></a>
1463
1279
 
1464
1280
  ```typescript
@@ -1569,18 +1385,6 @@ The target CDK version for this library.
1569
1385
 
1570
1386
  ---
1571
1387
 
1572
- ##### ~~`version`~~<sup>Required</sup> <a name="version" id="@mavogel/mvc-projen.MvcCdkConstructLibrary.property.version"></a>
1573
-
1574
- - *Deprecated:* use `cdkVersion`
1575
-
1576
- ```typescript
1577
- public readonly version: string;
1578
- ```
1579
-
1580
- - *Type:* string
1581
-
1582
- ---
1583
-
1584
1388
  #### Constants <a name="Constants" id="Constants"></a>
1585
1389
 
1586
1390
  | **Name** | **Type** | **Description** |
@@ -1654,17 +1458,14 @@ const mvcCdkConstructLibraryOptions: MvcCdkConstructLibraryOptions = { ... }
1654
1458
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
1655
1459
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
1656
1460
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.gitpod">gitpod</a></code> | <code>boolean</code> | Add a Gitpod development environment. |
1657
- | <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. |
1658
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.mergifyOptions">mergifyOptions</a></code> | <code>projen.github.MergifyOptions</code> | Options for mergify. |
1659
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
1660
1461
  | <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. |
1661
- | <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. |
1662
1462
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.readme">readme</a></code> | <code>projen.SampleReadmeProps</code> | The README setup. |
1663
1463
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
1664
1464
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.staleOptions">staleOptions</a></code> | <code>projen.github.StaleOptions</code> | Auto-close stale issues and pull requests. |
1665
1465
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
1666
1466
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.addPackageManagerToDevEngines">addPackageManagerToDevEngines</a></code> | <code>boolean</code> | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. |
1667
1467
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
1468
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.allowScripts">allowScripts</a></code> | <code>string[]</code> | List of dependency (package) names that are allowed to run lifecycle install scripts (`preinstall`, `install`, `postinstall`, `prepare`) during dependency installation. |
1668
1469
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
1669
1470
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
1670
1471
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorOrganization">authorOrganization</a></code> | <code>boolean</code> | Is the author an organization. |
@@ -1690,7 +1491,6 @@ const mvcCdkConstructLibraryOptions: MvcCdkConstructLibraryOptions = { ... }
1690
1491
  | <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. |
1691
1492
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
1692
1493
  | <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. |
1693
- | <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. |
1694
1494
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
1695
1495
  | <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. |
1696
1496
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
@@ -1698,11 +1498,11 @@ const mvcCdkConstructLibraryOptions: MvcCdkConstructLibraryOptions = { ... }
1698
1498
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
1699
1499
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
1700
1500
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
1501
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.pnpmOptions">pnpmOptions</a></code> | <code>projen.javascript.PnpmOptions</code> | Options for pnpm. |
1701
1502
  | <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. |
1702
1503
  | <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. |
1703
1504
  | <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. |
1704
1505
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
1705
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.scripts">scripts</a></code> | <code>{[ key: string ]: string}</code> | npm scripts to include. |
1706
1506
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
1707
1507
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
1708
1508
  | <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. |
@@ -1718,10 +1518,8 @@ const mvcCdkConstructLibraryOptions: MvcCdkConstructLibraryOptions = { ... }
1718
1518
  | <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. |
1719
1519
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
1720
1520
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
1721
- | <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`. |
1722
1521
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
1723
1522
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
1724
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
1725
1523
  | <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. |
1726
1524
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
1727
1525
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
@@ -1731,7 +1529,6 @@ const mvcCdkConstructLibraryOptions: MvcCdkConstructLibraryOptions = { ... }
1731
1529
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
1732
1530
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
1733
1531
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
1734
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
1735
1532
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
1736
1533
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
1737
1534
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
@@ -1740,13 +1537,13 @@ const mvcCdkConstructLibraryOptions: MvcCdkConstructLibraryOptions = { ... }
1740
1537
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
1741
1538
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
1742
1539
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
1743
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
1744
1540
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
1745
1541
  | <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. |
1746
1542
  | <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@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
1747
1543
  | <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. |
1748
1544
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
1749
1545
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
1546
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
1750
1547
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
1751
1548
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
1752
1549
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.depsUpgrade">depsUpgrade</a></code> | <code>boolean</code> | Use tasks and github workflows to handle dependency upgrades. |
@@ -1754,8 +1551,6 @@ const mvcCdkConstructLibraryOptions: MvcCdkConstructLibraryOptions = { ... }
1754
1551
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
1755
1552
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.jest">jest</a></code> | <code>boolean</code> | Setup jest unit tests. |
1756
1553
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.jestOptions">jestOptions</a></code> | <code>projen.javascript.JestOptions</code> | Jest options. |
1757
- | <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. |
1758
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
1759
1554
  | <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. |
1760
1555
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
1761
1556
  | <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`). |
@@ -1769,13 +1564,12 @@ const mvcCdkConstructLibraryOptions: MvcCdkConstructLibraryOptions = { ... }
1769
1564
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.pullRequestTemplateContents">pullRequestTemplateContents</a></code> | <code>string[]</code> | The contents of the pull request template. |
1770
1565
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
1771
1566
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
1772
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
1773
1567
  | <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. |
1774
1568
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
1775
1569
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
1776
1570
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
1777
1571
  | <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). |
1778
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
1572
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
1779
1573
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
1780
1574
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
1781
1575
  | <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. |
@@ -1784,12 +1578,13 @@ const mvcCdkConstructLibraryOptions: MvcCdkConstructLibraryOptions = { ... }
1784
1578
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.libdir">libdir</a></code> | <code>string</code> | Typescript artifacts output directory. |
1785
1579
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcTs">projenrcTs</a></code> | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`). |
1786
1580
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenrcTsOptions">projenrcTsOptions</a></code> | <code>projen.typescript.ProjenrcOptions</code> | Options for .projenrc.ts. |
1581
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner to use for executing TypeScript files. |
1787
1582
  | <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. |
1788
1583
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.srcdir">srcdir</a></code> | <code>string</code> | Typescript sources directory. |
1789
1584
  | <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`. |
1790
1585
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
1791
1586
  | <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). |
1792
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
1587
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
1793
1588
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
1794
1589
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
1795
1590
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.author">author</a></code> | <code>string</code> | The name of the library author. |
@@ -1799,23 +1594,17 @@ const mvcCdkConstructLibraryOptions: MvcCdkConstructLibraryOptions = { ... }
1799
1594
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
1800
1595
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
1801
1596
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.docgenFilePath">docgenFilePath</a></code> | <code>string</code> | File path for generated docs. |
1802
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.dotnet">dotnet</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | *No description.* |
1803
1597
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.excludeTypescript">excludeTypescript</a></code> | <code>string[]</code> | Accepts a list of glob patterns. |
1804
1598
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.jsiiVersion">jsiiVersion</a></code> | <code>string</code> | Version of the jsii compiler to use. |
1805
1599
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishToGo">publishToGo</a></code> | <code>projen.cdk.JsiiGoTarget</code> | Publish Go bindings to a git repository. |
1806
1600
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishToMaven">publishToMaven</a></code> | <code>projen.cdk.JsiiJavaTarget</code> | Publish to maven. |
1807
1601
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishToNuget">publishToNuget</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | Publish to NuGet. |
1808
1602
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.publishToPypi">publishToPypi</a></code> | <code>projen.cdk.JsiiPythonTarget</code> | Publish to pypi. |
1809
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.python">python</a></code> | <code>projen.cdk.JsiiPythonTarget</code> | *No description.* |
1810
1603
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.rootdir">rootdir</a></code> | <code>string</code> | *No description.* |
1604
+ | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.validateTsconfig">validateTsconfig</a></code> | <code>projen.cdk.ValidateTsconfig</code> | Level of tsconfig validation jsii should perform on the user-provided tsconfig. |
1811
1605
  | <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:. |
1812
1606
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | Minimum version of the AWS CDK to depend on. |
1813
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkAssert">cdkAssert</a></code> | <code>boolean</code> | Warning: NodeJS only. |
1814
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkAssertions">cdkAssertions</a></code> | <code>boolean</code> | Install the assertions library? |
1815
1607
  | <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. |
1816
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkDependencies">cdkDependencies</a></code> | <code>string[]</code> | Which AWS CDKv1 modules this project requires. |
1817
- | <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`). |
1818
- | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkTestDependencies">cdkTestDependencies</a></code> | <code>string[]</code> | AWS CDK modules required for testing. |
1819
1608
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkVersionPinning">cdkVersionPinning</a></code> | <code>boolean</code> | Use pinned version instead of caret version for CDK. |
1820
1609
  | <code><a href="#@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.constructsVersion">constructsVersion</a></code> | <code>string</code> | Minimum version of the `constructs` library to depend on. |
1821
1610
  | <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. |
@@ -2116,51 +1905,6 @@ Add a Gitpod development environment.
2116
1905
 
2117
1906
  ---
2118
1907
 
2119
- ##### ~~`mergify`~~<sup>Optional</sup> <a name="mergify" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.mergify"></a>
2120
-
2121
- - *Deprecated:* use `githubOptions.mergify` instead
2122
-
2123
- ```typescript
2124
- public readonly mergify: boolean;
2125
- ```
2126
-
2127
- - *Type:* boolean
2128
- - *Default:* true
2129
-
2130
- Whether mergify should be enabled on this repository or not.
2131
-
2132
- ---
2133
-
2134
- ##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="mergifyOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.mergifyOptions"></a>
2135
-
2136
- - *Deprecated:* use `githubOptions.mergifyOptions` instead
2137
-
2138
- ```typescript
2139
- public readonly mergifyOptions: MergifyOptions;
2140
- ```
2141
-
2142
- - *Type:* projen.github.MergifyOptions
2143
- - *Default:* default options
2144
-
2145
- Options for mergify.
2146
-
2147
- ---
2148
-
2149
- ##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projectType"></a>
2150
-
2151
- - *Deprecated:* no longer supported at the base project level
2152
-
2153
- ```typescript
2154
- public readonly projectType: ProjectType;
2155
- ```
2156
-
2157
- - *Type:* projen.ProjectType
2158
- - *Default:* ProjectType.UNKNOWN
2159
-
2160
- Which type of project this is (library/app).
2161
-
2162
- ---
2163
-
2164
1908
  ##### `projenCredentials`<sup>Optional</sup> <a name="projenCredentials" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenCredentials"></a>
2165
1909
 
2166
1910
  ```typescript
@@ -2174,24 +1918,6 @@ Choose a method of providing GitHub API access for projen workflows.
2174
1918
 
2175
1919
  ---
2176
1920
 
2177
- ##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="projenTokenSecret" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.projenTokenSecret"></a>
2178
-
2179
- - *Deprecated:* use `projenCredentials`
2180
-
2181
- ```typescript
2182
- public readonly projenTokenSecret: string;
2183
- ```
2184
-
2185
- - *Type:* string
2186
- - *Default:* "PROJEN_GITHUB_TOKEN"
2187
-
2188
- The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
2189
-
2190
- This token needs to have the `repo`, `workflows`
2191
- and `packages` scope.
2192
-
2193
- ---
2194
-
2195
1921
  ##### `readme`<sup>Optional</sup> <a name="readme" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.readme"></a>
2196
1922
 
2197
1923
  ```typescript
@@ -2286,6 +2012,44 @@ for specifying these.
2286
2012
 
2287
2013
  ---
2288
2014
 
2015
+ ##### `allowScripts`<sup>Optional</sup> <a name="allowScripts" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.allowScripts"></a>
2016
+
2017
+ ```typescript
2018
+ public readonly allowScripts: string[];
2019
+ ```
2020
+
2021
+ - *Type:* string[]
2022
+ - *Default:* all install scripts are allowed to run (package manager default)
2023
+
2024
+ List of dependency (package) names that are allowed to run lifecycle install scripts (`preinstall`, `install`, `postinstall`, `prepare`) during dependency installation.
2025
+
2026
+ These scripts can execute arbitrary code, making them a common
2027
+ supply-chain attack vector. Package managers are moving toward
2028
+ blocking them by default and requiring an explicit allowlist.
2029
+ Configuring `allowScripts` sets up that allowlist so scripts only run
2030
+ for the packages you have explicitly reviewed and trust.
2031
+
2032
+ Support for this setting depends on the configured `packageManager`:
2033
+
2034
+ - `NPM`: written to the native `allowScripts` field in `package.json`
2035
+ (requires npm >= 11.16; see https://docs.npmjs.com/cli/v11/commands/npm-approve-scripts).
2036
+ - `BUN`: written to the native `trustedDependencies` field in
2037
+ `package.json` (see https://bun.com/docs/pm/lifecycle).
2038
+ - `PNPM`: written to the `onlyBuiltDependencies` setting in
2039
+ `pnpm-workspace.yaml` (see https://pnpm.io/settings#onlybuiltdependencies).
2040
+ - `YARN2`, `YARN_BERRY`: written to the native
2041
+ `dependenciesMeta.<pkg>.built` allowlist in `package.json`, combined
2042
+ with `enableScripts: false` in `.yarnrc.yml` (see
2043
+ https://yarnpkg.com/features/security#postinstalls). If you set
2044
+ `yarnBerryOptions.yarnRcOptions.enableScripts` explicitly, that value
2045
+ is respected instead of being overridden.
2046
+ - `YARN`, `YARN_CLASSIC`: not supported. Yarn Classic has no native
2047
+ mechanism to allowlist install scripts for specific dependencies.
2048
+ Setting this option with one of these package managers throws an
2049
+ error at synthesis time.
2050
+
2051
+ ---
2052
+
2289
2053
  ##### `authorEmail`<sup>Optional</sup> <a name="authorEmail" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.authorEmail"></a>
2290
2054
 
2291
2055
  ```typescript
@@ -2402,11 +2166,11 @@ added both to the `dependencies` section and `bundledDependencies` section of
2402
2166
  your `package.json`.
2403
2167
 
2404
2168
  The recommendation is to only specify the module name here (e.g.
2405
- `express`). This will behave similar to `yarn add` or `npm install` in the
2169
+ `express`). This will behave similar to `pnpm add` or `npm install` in the
2406
2170
  sense that it will add the module as a dependency to your `package.json`
2407
2171
  file with the latest version (`^`). You can specify semver requirements in
2408
- the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
2409
- this will be what you `package.json` will eventually include.
2172
+ the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
2173
+ this will be what your `package.json` will eventually include.
2410
2174
 
2411
2175
  ---
2412
2176
 
@@ -2468,11 +2232,11 @@ public readonly deps: string[];
2468
2232
  Runtime dependencies of this module.
2469
2233
 
2470
2234
  The recommendation is to only specify the module name here (e.g.
2471
- `express`). This will behave similar to `yarn add` or `npm install` in the
2235
+ `express`). This will behave similar to `pnpm add` or `npm install` in the
2472
2236
  sense that it will add the module as a dependency to your `package.json`
2473
2237
  file with the latest version (`^`). You can specify semver requirements in
2474
- the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
2475
- this will be what you `package.json` will eventually include.
2238
+ the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
2239
+ this will be what your `package.json` will eventually include.
2476
2240
 
2477
2241
  ---
2478
2242
 
@@ -2514,11 +2278,11 @@ available in your build environment but will not be fetched when this
2514
2278
  module is consumed.
2515
2279
 
2516
2280
  The recommendation is to only specify the module name here (e.g.
2517
- `express`). This will behave similar to `yarn add` or `npm install` in the
2281
+ `express`). This will behave similar to `pnpm add` or `npm install` in the
2518
2282
  sense that it will add the module as a dependency to your `package.json`
2519
2283
  file with the latest version (`^`). You can specify semver requirements in
2520
- the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
2521
- this will be what you `package.json` will eventually include.
2284
+ the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
2285
+ this will be what your `package.json` will eventually include.
2522
2286
 
2523
2287
  ---
2524
2288
 
@@ -2691,22 +2455,6 @@ which is using npm internally and supports provenance statements independently o
2691
2455
 
2692
2456
  ---
2693
2457
 
2694
- ##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="npmRegistry" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmRegistry"></a>
2695
-
2696
- - *Deprecated:* use `npmRegistryUrl` instead
2697
-
2698
- ```typescript
2699
- public readonly npmRegistry: string;
2700
- ```
2701
-
2702
- - *Type:* string
2703
-
2704
- The host name of the npm registry to publish to.
2705
-
2706
- Cannot be set together with `npmRegistryUrl`.
2707
-
2708
- ---
2709
-
2710
2458
  ##### `npmRegistryUrl`<sup>Optional</sup> <a name="npmRegistryUrl" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmRegistryUrl"></a>
2711
2459
 
2712
2460
  ```typescript
@@ -2813,6 +2561,19 @@ test your module against the lowest peer version required.
2813
2561
 
2814
2562
  ---
2815
2563
 
2564
+ ##### `pnpmOptions`<sup>Optional</sup> <a name="pnpmOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.pnpmOptions"></a>
2565
+
2566
+ ```typescript
2567
+ public readonly pnpmOptions: PnpmOptions;
2568
+ ```
2569
+
2570
+ - *Type:* projen.javascript.PnpmOptions
2571
+ - *Default:* all default options
2572
+
2573
+ Options for pnpm.
2574
+
2575
+ ---
2576
+
2816
2577
  ##### `pnpmVersion`<sup>Optional</sup> <a name="pnpmVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.pnpmVersion"></a>
2817
2578
 
2818
2579
  ```typescript
@@ -2820,7 +2581,7 @@ public readonly pnpmVersion: string;
2820
2581
  ```
2821
2582
 
2822
2583
  - *Type:* string
2823
- - *Default:* "9"
2584
+ - *Default:* "10.33.0"
2824
2585
 
2825
2586
  The version of PNPM to use if using PNPM as a package manager.
2826
2587
 
@@ -2865,25 +2626,6 @@ Options for privately hosted scoped packages.
2865
2626
 
2866
2627
  ---
2867
2628
 
2868
- ##### ~~`scripts`~~<sup>Optional</sup> <a name="scripts" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.scripts"></a>
2869
-
2870
- - *Deprecated:* use `project.addTask()` or `package.setScript()`
2871
-
2872
- ```typescript
2873
- public readonly scripts: {[ key: string ]: string};
2874
- ```
2875
-
2876
- - *Type:* {[ key: string ]: string}
2877
- - *Default:* {}
2878
-
2879
- npm scripts to include.
2880
-
2881
- If a script has the same name as a standard script,
2882
- the standard script will be overwritten.
2883
- Also adds the script as a task.
2884
-
2885
- ---
2886
-
2887
2629
  ##### `stability`<sup>Optional</sup> <a name="stability" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.stability"></a>
2888
2630
 
2889
2631
  ```typescript
@@ -3126,21 +2868,6 @@ on a per artifact basis.
3126
2868
 
3127
2869
  ---
3128
2870
 
3129
- ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseEveryCommit"></a>
3130
-
3131
- - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
3132
-
3133
- ```typescript
3134
- public readonly releaseEveryCommit: boolean;
3135
- ```
3136
-
3137
- - *Type:* boolean
3138
- - *Default:* true
3139
-
3140
- Automatically release new versions every commit to one of branches in `releaseBranches`.
3141
-
3142
- ---
3143
-
3144
2871
  ##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseFailureIssue"></a>
3145
2872
 
3146
2873
  ```typescript
@@ -3169,21 +2896,6 @@ Only applies if `releaseFailureIssue` is true.
3169
2896
 
3170
2897
  ---
3171
2898
 
3172
- ##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="releaseSchedule" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseSchedule"></a>
3173
-
3174
- - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
3175
-
3176
- ```typescript
3177
- public readonly releaseSchedule: string;
3178
- ```
3179
-
3180
- - *Type:* string
3181
- - *Default:* no scheduled releases
3182
-
3183
- CRON schedule to trigger new releases.
3184
-
3185
- ---
3186
-
3187
2899
  ##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseTagPrefix"></a>
3188
2900
 
3189
2901
  ```typescript
@@ -3306,19 +3018,6 @@ Github Runner Group selection options.
3306
3018
 
3307
3019
  ---
3308
3020
 
3309
- ##### `defaultReleaseBranch`<sup>Required</sup> <a name="defaultReleaseBranch" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.defaultReleaseBranch"></a>
3310
-
3311
- ```typescript
3312
- public readonly defaultReleaseBranch: string;
3313
- ```
3314
-
3315
- - *Type:* string
3316
- - *Default:* "main"
3317
-
3318
- The name of the main release branch.
3319
-
3320
- ---
3321
-
3322
3021
  ##### `artifactsDirectory`<sup>Optional</sup> <a name="artifactsDirectory" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.artifactsDirectory"></a>
3323
3022
 
3324
3023
  ```typescript
@@ -3428,21 +3127,6 @@ Options for PR build workflow.
3428
3127
 
3429
3128
  ---
3430
3129
 
3431
- ##### ~~`buildWorkflowTriggers`~~<sup>Optional</sup> <a name="buildWorkflowTriggers" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.buildWorkflowTriggers"></a>
3432
-
3433
- - *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers`
3434
-
3435
- ```typescript
3436
- public readonly buildWorkflowTriggers: Triggers;
3437
- ```
3438
-
3439
- - *Type:* projen.github.workflows.Triggers
3440
- - *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
3441
-
3442
- Build workflow triggers.
3443
-
3444
- ---
3445
-
3446
3130
  ##### `bundlerOptions`<sup>Optional</sup> <a name="bundlerOptions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.bundlerOptions"></a>
3447
3131
 
3448
3132
  ```typescript
@@ -3522,6 +3206,19 @@ The copyright years to put in the LICENSE file.
3522
3206
 
3523
3207
  ---
3524
3208
 
3209
+ ##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.defaultReleaseBranch"></a>
3210
+
3211
+ ```typescript
3212
+ public readonly defaultReleaseBranch: string;
3213
+ ```
3214
+
3215
+ - *Type:* string
3216
+ - *Default:* "main"
3217
+
3218
+ The name of the main release branch.
3219
+
3220
+ ---
3221
+
3525
3222
  ##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.dependabot"></a>
3526
3223
 
3527
3224
  ```typescript
@@ -3616,41 +3313,6 @@ Jest options.
3616
3313
 
3617
3314
  ---
3618
3315
 
3619
- ##### ~~`mutableBuild`~~<sup>Optional</sup> <a name="mutableBuild" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.mutableBuild"></a>
3620
-
3621
- - *Deprecated:* - Use `buildWorkflowOptions.mutableBuild`
3622
-
3623
- ```typescript
3624
- public readonly mutableBuild: boolean;
3625
- ```
3626
-
3627
- - *Type:* boolean
3628
- - *Default:* true
3629
-
3630
- Automatically update files modified during builds to pull-request branches.
3631
-
3632
- This means
3633
- that any files synthesized by projen or e.g. test snapshots will always be up-to-date
3634
- before a PR is merged.
3635
-
3636
- Implies that PR builds do not have anti-tamper checks.
3637
-
3638
- ---
3639
-
3640
- ##### ~~`npmignore`~~<sup>Optional</sup> <a name="npmignore" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmignore"></a>
3641
-
3642
- - *Deprecated:* - use `project.addPackageIgnore`
3643
-
3644
- ```typescript
3645
- public readonly npmignore: string[];
3646
- ```
3647
-
3648
- - *Type:* string[]
3649
-
3650
- Additional entries to .npmignore.
3651
-
3652
- ---
3653
-
3654
3316
  ##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.npmignoreEnabled"></a>
3655
3317
 
3656
3318
  ```typescript
@@ -3819,21 +3481,6 @@ Automatically release to npm when new versions are introduced.
3819
3481
 
3820
3482
  ---
3821
3483
 
3822
- ##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="releaseWorkflow" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.releaseWorkflow"></a>
3823
-
3824
- - *Deprecated:* see `release`.
3825
-
3826
- ```typescript
3827
- public readonly releaseWorkflow: boolean;
3828
- ```
3829
-
3830
- - *Type:* boolean
3831
- - *Default:* true if not a subproject
3832
-
3833
- DEPRECATED: renamed to `release`.
3834
-
3835
- ---
3836
-
3837
3484
  ##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="workflowBootstrapSteps" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.workflowBootstrapSteps"></a>
3838
3485
 
3839
3486
  ```typescript
@@ -3910,7 +3557,7 @@ public readonly disableTsconfigDev: boolean;
3910
3557
  - *Type:* boolean
3911
3558
  - *Default:* false
3912
3559
 
3913
- Do not generate a `tsconfig.dev.json` file.
3560
+ Do not generate a development tsconfig file.
3914
3561
 
3915
3562
  ---
3916
3563
 
@@ -4017,6 +3664,22 @@ Options for .projenrc.ts.
4017
3664
 
4018
3665
  ---
4019
3666
 
3667
+ ##### `runner`<sup>Optional</sup> <a name="runner" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.runner"></a>
3668
+
3669
+ ```typescript
3670
+ public readonly runner: TypeScriptRunner;
3671
+ ```
3672
+
3673
+ - *Type:* projen.typescript.TypeScriptRunner
3674
+ - *Default:* TypeScriptRunner.tsNode()
3675
+
3676
+ The TypeScript runner to use for executing TypeScript files.
3677
+
3678
+ This is a project-level setting that components (e.g. projenrc) will
3679
+ use as their default runner.
3680
+
3681
+ ---
3682
+
4020
3683
  ##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.sampleCode"></a>
4021
3684
 
4022
3685
  ```typescript
@@ -4094,9 +3757,13 @@ public readonly tsconfigDevFile: string;
4094
3757
  ```
4095
3758
 
4096
3759
  - *Type:* string
4097
- - *Default:* "tsconfig.dev.json"
3760
+ - *Default:* "{testdir}/tsconfig.json"
4098
3761
 
4099
- The name of the development tsconfig.json file.
3762
+ The name (and path) of the development tsconfig file.
3763
+
3764
+ By default this lives inside the test directory (e.g. `test/tsconfig.json`)
3765
+ so that the TypeScript language service resolves it as the nearest config
3766
+ for test files.
4100
3767
 
4101
3768
  ---
4102
3769
 
@@ -4222,18 +3889,6 @@ File path for generated docs.
4222
3889
 
4223
3890
  ---
4224
3891
 
4225
- ##### ~~`dotnet`~~<sup>Optional</sup> <a name="dotnet" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.dotnet"></a>
4226
-
4227
- - *Deprecated:* use `publishToNuget`
4228
-
4229
- ```typescript
4230
- public readonly dotnet: JsiiDotNetTarget;
4231
- ```
4232
-
4233
- - *Type:* projen.cdk.JsiiDotNetTarget
4234
-
4235
- ---
4236
-
4237
3892
  ##### `excludeTypescript`<sup>Optional</sup> <a name="excludeTypescript" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.excludeTypescript"></a>
4238
3893
 
4239
3894
  ```typescript
@@ -4324,26 +3979,32 @@ Publish to pypi.
4324
3979
 
4325
3980
  ---
4326
3981
 
4327
- ##### ~~`python`~~<sup>Optional</sup> <a name="python" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.python"></a>
4328
-
4329
- - *Deprecated:* use `publishToPyPi`
3982
+ ##### `rootdir`<sup>Optional</sup> <a name="rootdir" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.rootdir"></a>
4330
3983
 
4331
3984
  ```typescript
4332
- public readonly python: JsiiPythonTarget;
3985
+ public readonly rootdir: string;
4333
3986
  ```
4334
3987
 
4335
- - *Type:* projen.cdk.JsiiPythonTarget
3988
+ - *Type:* string
3989
+ - *Default:* "."
4336
3990
 
4337
3991
  ---
4338
3992
 
4339
- ##### `rootdir`<sup>Optional</sup> <a name="rootdir" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.rootdir"></a>
3993
+ ##### `validateTsconfig`<sup>Optional</sup> <a name="validateTsconfig" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.validateTsconfig"></a>
4340
3994
 
4341
3995
  ```typescript
4342
- public readonly rootdir: string;
3996
+ public readonly validateTsconfig: ValidateTsconfig;
4343
3997
  ```
4344
3998
 
4345
- - *Type:* string
4346
- - *Default:* "."
3999
+ - *Type:* projen.cdk.ValidateTsconfig
4000
+ - *Default:* ValidateTsconfig.STRICT
4001
+
4002
+ Level of tsconfig validation jsii should perform on the user-provided tsconfig.
4003
+
4004
+ Only relevant when the project synthesizes its own tsconfig
4005
+ (i.e. `disableTsconfig` is not set on the TypeScriptProject).
4006
+
4007
+ > [https://aws.github.io/jsii/user-guides/lib-author/configuration/#validatetsconfig](https://aws.github.io/jsii/user-guides/lib-author/configuration/#validatetsconfig)
4347
4008
 
4348
4009
  ---
4349
4010
 
@@ -4384,39 +4045,6 @@ Minimum version of the AWS CDK to depend on.
4384
4045
 
4385
4046
  ---
4386
4047
 
4387
- ##### ~~`cdkAssert`~~<sup>Optional</sup> <a name="cdkAssert" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkAssert"></a>
4388
-
4389
- - *Deprecated:* The
4390
-
4391
- ```typescript
4392
- public readonly cdkAssert: boolean;
4393
- ```
4394
-
4395
- - *Type:* boolean
4396
- - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0
4397
-
4398
- Warning: NodeJS only.
4399
-
4400
- Install the
4401
-
4402
- ---
4403
-
4404
- ##### `cdkAssertions`<sup>Optional</sup> <a name="cdkAssertions" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkAssertions"></a>
4405
-
4406
- ```typescript
4407
- public readonly cdkAssertions: boolean;
4408
- ```
4409
-
4410
- - *Type:* boolean
4411
- - *Default:* will be included by default for AWS CDK >= 1.111.0 < 2.0.0
4412
-
4413
- Install the assertions library?
4414
-
4415
- Only needed for CDK 1.x. If using CDK 2.x then
4416
- assertions is already included in 'aws-cdk-lib'
4417
-
4418
- ---
4419
-
4420
4048
  ##### `cdkCliVersion`<sup>Optional</sup> <a name="cdkCliVersion" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkCliVersion"></a>
4421
4049
 
4422
4050
  ```typescript
@@ -4435,56 +4063,6 @@ option to restrict it to a specific version or version range.
4435
4063
 
4436
4064
  ---
4437
4065
 
4438
- ##### ~~`cdkDependencies`~~<sup>Optional</sup> <a name="cdkDependencies" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkDependencies"></a>
4439
-
4440
- - *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)
4441
-
4442
- ```typescript
4443
- public readonly cdkDependencies: string[];
4444
- ```
4445
-
4446
- - *Type:* string[]
4447
-
4448
- Which AWS CDKv1 modules this project requires.
4449
-
4450
- ---
4451
-
4452
- ##### ~~`cdkDependenciesAsDeps`~~<sup>Optional</sup> <a name="cdkDependenciesAsDeps" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkDependenciesAsDeps"></a>
4453
-
4454
- - *Deprecated:* Not supported in CDK v2.
4455
-
4456
- ```typescript
4457
- public readonly cdkDependenciesAsDeps: boolean;
4458
- ```
4459
-
4460
- - *Type:* boolean
4461
- - *Default:* true
4462
-
4463
- If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).
4464
-
4465
- This is to ensure that downstream consumers actually have your CDK dependencies installed
4466
- when using npm < 7 or yarn, where peer dependencies are not automatically installed.
4467
- If this is disabled, `cdkDependencies` will be added to `devDependencies` to ensure
4468
- they are present during development.
4469
-
4470
- Note: this setting only applies to construct library projects
4471
-
4472
- ---
4473
-
4474
- ##### ~~`cdkTestDependencies`~~<sup>Optional</sup> <a name="cdkTestDependencies" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkTestDependencies"></a>
4475
-
4476
- - *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead
4477
-
4478
- ```typescript
4479
- public readonly cdkTestDependencies: string[];
4480
- ```
4481
-
4482
- - *Type:* string[]
4483
-
4484
- AWS CDK modules required for testing.
4485
-
4486
- ---
4487
-
4488
4066
  ##### `cdkVersionPinning`<sup>Optional</sup> <a name="cdkVersionPinning" id="@mavogel/mvc-projen.MvcCdkConstructLibraryOptions.property.cdkVersionPinning"></a>
4489
4067
 
4490
4068
  ```typescript