cdklabs-projen-project-types 0.1.183 → 0.1.185

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
@@ -1,170 +1,3 @@
1
- # Cdklabs Projen Project Types
2
-
3
- This repository stores custom project types extended from `projen` with cdklabs defaults
4
- baked in. This is meant to serve as a hook for continuous management of all repos we own.
5
- With cdklabs projen types, we can add new configuration as they come up and have it
6
- propagate to all repositories using the type.
7
-
8
- ## CdklabsConstructLibrary
9
-
10
- This type extends projen's `awscdk.AwsConstructLibrary` project type and should be used in place
11
- of that type.
12
-
13
- ### Usage
14
-
15
- From the command line:
16
-
17
- ```bash
18
- npx projen new --from cdklabs-projen-project-types cdklabs-construct-lib
19
- ```
20
-
21
- From inside `cdk-ops`:
22
-
23
- ```ts
24
- this.cdklabs.addPreApprovedRepo({
25
- repo: 'cdk-new-lib',
26
- owner: 'conroyka@amazon.com',
27
- createWith: {
28
- projectType: ProjectType.CDKLABS_MANAGED_CONSTRUCT_LIB,
29
- },
30
- });
31
- ```
32
-
33
- ### Features
34
-
35
- - `cdklabsPublishingDefaults`
36
-
37
- By default, this is turned on. `cdklabsPublishingDefaults` provides publishing defaults based off
38
- of the project's name. Specifically, the defaults look like this:
39
-
40
- ```ts
41
- return {
42
- publishToPypi: {
43
- distName: npmPackageName,
44
- module: changeDelimiter(npmPackageName, '_'),
45
- },
46
- publishToMaven: {
47
- javaPackage: `io.github.cdklabs.${changeDelimiter(npmPackageName, '.')}`,
48
- mavenGroupId: 'io.github.cdklabs',
49
- mavenArtifactId: npmPackageName,
50
- mavenEndpoint: 'https://s01.oss.sonatype.org',
51
- },
52
- publishToNuget: {
53
- dotNetNamespace: `Cdklabs${upperCaseName(npmPackageName)}`,
54
- packageId: `Cdklabs${upperCaseName(npmPackageName)}`,
55
- },
56
- publishToGo: {
57
- moduleName: `${npmPackageName}-go`,
58
- },
59
- };
60
- ```
61
-
62
- Additionally, we also require that we publish to all jsii language targets (including go) when
63
- we specify a library as `stable`.
64
-
65
- - `private`
66
-
67
- By default, a project is created as `private`. Turning this off simply means setting `private: false`.
68
- A project being `private` means it gets certain properties set as default that are true for private
69
- projects. Today, that means setting `private: true` in `package.json`, removing `.mergify.yml` from
70
- the project, and removing `.npmignore`.
71
-
72
- - `releasableCommits`
73
-
74
- By default this project type releases `ReleasableCommits.featuresAndFixes`, to not release a new
75
- version every day on a package that only sees devDependency updates. You may want to override this
76
- if you need something more specific.
77
-
78
- ## CdklabsTypeScriptProject
79
-
80
- This type extends projen's `typescript.TypeScriptProject` project type and should be used in place
81
- of that type.
82
-
83
- ### Usage
84
-
85
- ```bash
86
- npx projen new --from cdklabs-projen-project-types cdklabs-ts-proj
87
- ```
88
-
89
- From inside `cdk-ops`:
90
-
91
- ```ts
92
- this.cdklabs.addPreApprovedRepo({
93
- repo: 'cdk-new-lib',
94
- owner: 'conroyka@amazon.com',
95
- createWith: {
96
- projectType: ProjectType.CDKLABS_MANAGED_TS_PROJECT,
97
- },
98
- });
99
- ```
100
-
101
- ### Features
102
-
103
- - `private`
104
-
105
- By default, a project is created as `private`. Turning this off simply means setting `private: false`.
106
- A project being `private` means it gets certain properties set as default that are true for private
107
- projects. Today, that means setting `private: true` in `package.json`, removing `.mergify.yml` from
108
- the project, and removing `.npmignore`.
109
-
110
- ## CdklabsMonorepo
111
-
112
- A TypeScript monorepo using Yarn Workspaces.
113
- Individual workspaces can be added with `yarn.TypeScriptWorkspace` which extends projen's `typescript.TypeScriptProject`.
114
-
115
- ### Usage
116
-
117
- ```bash
118
- npx projen new --from cdklabs-projen-project-types cdklabs-yarn-monorepo
119
- ```
120
-
121
- ### Features
122
-
123
- ```ts
124
- const project = new yarn.CdkLabsMonorepo({
125
- defaultReleaseBranch: "main",
126
- devDeps: ["cdklabs-projen-project-types"],
127
- name: "monorepo",
128
- });
129
- ```
130
-
131
- - Workspace commands: `projen build|compile|package|test|upgrade`\
132
- Will run the specific command in all workspaces and the root if applicable.
133
-
134
- - Workspace run: `projen run <command>`\
135
- Executes the given command in all workspaces
136
-
137
- - Automatic dependency installation\
138
- The monorepo will know if a dependency has been added for a workspace and run `yarn install` as part of `projen`
139
-
140
- - `projen` at any level\
141
- The default `projen` command can be run in any workspace and will execute the monorepo synth command.
142
-
143
- - Release\
144
- This feature is not supported at this time.
145
- Any release functionality must be implemented.
146
-
147
- - `vscodeWorkspace: boolean`\
148
- You can specify if a VSCode Workspace file should be created for the monorepo.
149
-
150
- #### Workspaces
151
-
152
- ```ts
153
- new yarn.TypeScriptWorkspace({
154
- parent: project,
155
- name: 'workspace'
156
- })
157
- ```
158
-
159
- - `parent: yarn.Monorepo`\
160
- Workspaces (aka subprojects) must be added using the `parent` option.
161
-
162
- - `workspaceScope: string`\
163
- The location the workspace is placed at. Defaults to `./packages`
164
-
165
- - `excludeDepsFromUpgrade: Array<string>`\
166
- List any dependencies that should not be updated in the workspace.
167
-
168
1
  # API Reference <a name="API Reference" id="api-reference"></a>
169
2
 
170
3
  ## Constructs <a name="Constructs" id="Constructs"></a>
@@ -365,7 +198,7 @@ new CdkConstructLibrary(options: CdkConstructLibraryOptions)
365
198
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.toString">toString</a></code> | Returns a string representation of this construct. |
366
199
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
367
200
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
368
- | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.addPackageIgnore">addPackageIgnore</a></code> | Exclude these files from the bundled package. |
201
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
369
202
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.addTask">addTask</a></code> | Adds a new task to this project. |
370
203
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
371
204
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
@@ -446,15 +279,14 @@ The glob pattern to ignore.
446
279
  public addPackageIgnore(pattern: string): void
447
280
  ```
448
281
 
449
- Exclude these files from the bundled package.
450
-
451
- Implemented by project types based on the
452
- packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
282
+ Adds patterns to be ignored by npm.
453
283
 
454
284
  ###### `pattern`<sup>Required</sup> <a name="pattern" id="cdklabs-projen-project-types.CdkConstructLibrary.addPackageIgnore.parameter.pattern"></a>
455
285
 
456
286
  - *Type:* string
457
287
 
288
+ The pattern to ignore.
289
+
458
290
  ---
459
291
 
460
292
  ##### `addTask` <a name="addTask" id="cdklabs-projen-project-types.CdkConstructLibrary.addTask"></a>
@@ -1893,6 +1725,7 @@ public readonly private: boolean;
1893
1725
  | **Name** | **Type** | **Description** |
1894
1726
  | --- | --- | --- |
1895
1727
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.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). |
1728
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
1896
1729
 
1897
1730
  ---
1898
1731
 
@@ -1911,6 +1744,16 @@ this task should synthesize the project files.
1911
1744
 
1912
1745
  ---
1913
1746
 
1747
+ ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="cdklabs-projen-project-types.CdkConstructLibrary.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
1748
+
1749
+ ```typescript
1750
+ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
1751
+ ```
1752
+
1753
+ - *Type:* string
1754
+
1755
+ ---
1756
+
1914
1757
  ### CdkJsiiProject <a name="CdkJsiiProject" id="cdklabs-projen-project-types.CdkJsiiProject"></a>
1915
1758
 
1916
1759
  Create a Cdk Jsii Jsii project.
@@ -1942,7 +1785,7 @@ new CdkJsiiProject(options: CdkJsiiProjectOptions)
1942
1785
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.toString">toString</a></code> | Returns a string representation of this construct. |
1943
1786
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
1944
1787
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
1945
- | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.addPackageIgnore">addPackageIgnore</a></code> | Exclude these files from the bundled package. |
1788
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
1946
1789
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.addTask">addTask</a></code> | Adds a new task to this project. |
1947
1790
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
1948
1791
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
@@ -2021,15 +1864,14 @@ The glob pattern to ignore.
2021
1864
  public addPackageIgnore(pattern: string): void
2022
1865
  ```
2023
1866
 
2024
- Exclude these files from the bundled package.
2025
-
2026
- Implemented by project types based on the
2027
- packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
1867
+ Adds patterns to be ignored by npm.
2028
1868
 
2029
1869
  ###### `pattern`<sup>Required</sup> <a name="pattern" id="cdklabs-projen-project-types.CdkJsiiProject.addPackageIgnore.parameter.pattern"></a>
2030
1870
 
2031
1871
  - *Type:* string
2032
1872
 
1873
+ The pattern to ignore.
1874
+
2033
1875
  ---
2034
1876
 
2035
1877
  ##### `addTask` <a name="addTask" id="cdklabs-projen-project-types.CdkJsiiProject.addTask"></a>
@@ -3397,6 +3239,7 @@ public readonly private: boolean;
3397
3239
  | **Name** | **Type** | **Description** |
3398
3240
  | --- | --- | --- |
3399
3241
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.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). |
3242
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
3400
3243
 
3401
3244
  ---
3402
3245
 
@@ -3415,6 +3258,16 @@ this task should synthesize the project files.
3415
3258
 
3416
3259
  ---
3417
3260
 
3261
+ ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="cdklabs-projen-project-types.CdkJsiiProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
3262
+
3263
+ ```typescript
3264
+ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
3265
+ ```
3266
+
3267
+ - *Type:* string
3268
+
3269
+ ---
3270
+
3418
3271
  ### CdklabsConstructLibrary <a name="CdklabsConstructLibrary" id="cdklabs-projen-project-types.CdklabsConstructLibrary"></a>
3419
3272
 
3420
3273
  Create a Cdklabs Construct Library Project.
@@ -3446,7 +3299,7 @@ new CdklabsConstructLibrary(options: CdklabsConstructLibraryOptions)
3446
3299
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.toString">toString</a></code> | Returns a string representation of this construct. |
3447
3300
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
3448
3301
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
3449
- | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.addPackageIgnore">addPackageIgnore</a></code> | Exclude these files from the bundled package. |
3302
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
3450
3303
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.addTask">addTask</a></code> | Adds a new task to this project. |
3451
3304
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
3452
3305
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
@@ -3527,15 +3380,14 @@ The glob pattern to ignore.
3527
3380
  public addPackageIgnore(pattern: string): void
3528
3381
  ```
3529
3382
 
3530
- Exclude these files from the bundled package.
3531
-
3532
- Implemented by project types based on the
3533
- packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
3383
+ Adds patterns to be ignored by npm.
3534
3384
 
3535
3385
  ###### `pattern`<sup>Required</sup> <a name="pattern" id="cdklabs-projen-project-types.CdklabsConstructLibrary.addPackageIgnore.parameter.pattern"></a>
3536
3386
 
3537
3387
  - *Type:* string
3538
3388
 
3389
+ The pattern to ignore.
3390
+
3539
3391
  ---
3540
3392
 
3541
3393
  ##### `addTask` <a name="addTask" id="cdklabs-projen-project-types.CdklabsConstructLibrary.addTask"></a>
@@ -4974,6 +4826,7 @@ public readonly private: boolean;
4974
4826
  | **Name** | **Type** | **Description** |
4975
4827
  | --- | --- | --- |
4976
4828
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.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). |
4829
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
4977
4830
 
4978
4831
  ---
4979
4832
 
@@ -4992,6 +4845,16 @@ this task should synthesize the project files.
4992
4845
 
4993
4846
  ---
4994
4847
 
4848
+ ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="cdklabs-projen-project-types.CdklabsConstructLibrary.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
4849
+
4850
+ ```typescript
4851
+ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
4852
+ ```
4853
+
4854
+ - *Type:* string
4855
+
4856
+ ---
4857
+
4995
4858
  ### CdklabsJsiiProject <a name="CdklabsJsiiProject" id="cdklabs-projen-project-types.CdklabsJsiiProject"></a>
4996
4859
 
4997
4860
  Create a Cdklabs Jsii Project.
@@ -5023,7 +4886,7 @@ new CdklabsJsiiProject(options: CdklabsJsiiProjectOptions)
5023
4886
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.toString">toString</a></code> | Returns a string representation of this construct. |
5024
4887
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
5025
4888
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
5026
- | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.addPackageIgnore">addPackageIgnore</a></code> | Exclude these files from the bundled package. |
4889
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
5027
4890
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.addTask">addTask</a></code> | Adds a new task to this project. |
5028
4891
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
5029
4892
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
@@ -5102,15 +4965,14 @@ The glob pattern to ignore.
5102
4965
  public addPackageIgnore(pattern: string): void
5103
4966
  ```
5104
4967
 
5105
- Exclude these files from the bundled package.
5106
-
5107
- Implemented by project types based on the
5108
- packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
4968
+ Adds patterns to be ignored by npm.
5109
4969
 
5110
4970
  ###### `pattern`<sup>Required</sup> <a name="pattern" id="cdklabs-projen-project-types.CdklabsJsiiProject.addPackageIgnore.parameter.pattern"></a>
5111
4971
 
5112
4972
  - *Type:* string
5113
4973
 
4974
+ The pattern to ignore.
4975
+
5114
4976
  ---
5115
4977
 
5116
4978
  ##### `addTask` <a name="addTask" id="cdklabs-projen-project-types.CdklabsJsiiProject.addTask"></a>
@@ -6478,6 +6340,7 @@ public readonly private: boolean;
6478
6340
  | **Name** | **Type** | **Description** |
6479
6341
  | --- | --- | --- |
6480
6342
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.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). |
6343
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
6481
6344
 
6482
6345
  ---
6483
6346
 
@@ -6496,6 +6359,16 @@ this task should synthesize the project files.
6496
6359
 
6497
6360
  ---
6498
6361
 
6362
+ ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="cdklabs-projen-project-types.CdklabsJsiiProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
6363
+
6364
+ ```typescript
6365
+ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
6366
+ ```
6367
+
6368
+ - *Type:* string
6369
+
6370
+ ---
6371
+
6499
6372
  ### CdkLabsMonorepo <a name="CdkLabsMonorepo" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo"></a>
6500
6373
 
6501
6374
  Opinionated implementation of yarn.Monorepo.
@@ -6527,7 +6400,7 @@ new yarn.CdkLabsMonorepo(options: CdkLabsMonorepoOptions)
6527
6400
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.toString">toString</a></code> | Returns a string representation of this construct. |
6528
6401
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
6529
6402
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
6530
- | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.addPackageIgnore">addPackageIgnore</a></code> | Exclude these files from the bundled package. |
6403
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
6531
6404
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.addTask">addTask</a></code> | Adds a new task to this project. |
6532
6405
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
6533
6406
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
@@ -6608,15 +6481,14 @@ The glob pattern to ignore.
6608
6481
  public addPackageIgnore(pattern: string): void
6609
6482
  ```
6610
6483
 
6611
- Exclude these files from the bundled package.
6612
-
6613
- Implemented by project types based on the
6614
- packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
6484
+ Adds patterns to be ignored by npm.
6615
6485
 
6616
6486
  ###### `pattern`<sup>Required</sup> <a name="pattern" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.addPackageIgnore.parameter.pattern"></a>
6617
6487
 
6618
6488
  - *Type:* string
6619
6489
 
6490
+ The pattern to ignore.
6491
+
6620
6492
  ---
6621
6493
 
6622
6494
  ##### `addTask` <a name="addTask" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.addTask"></a>
@@ -7245,6 +7117,7 @@ When given a project, this it the project itself.
7245
7117
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.eslint">eslint</a></code> | <code>projen.javascript.Eslint</code> | *No description.* |
7246
7118
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
7247
7119
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.tsconfigEslint">tsconfigEslint</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
7120
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.repositoryUrl">repositoryUrl</a></code> | <code>string</code> | The URL where the actual code for the package lives. |
7248
7121
 
7249
7122
  ---
7250
7123
 
@@ -7994,11 +7867,24 @@ public readonly tsconfigEslint: TypescriptConfig;
7994
7867
 
7995
7868
  ---
7996
7869
 
7870
+ ##### `repositoryUrl`<sup>Optional</sup> <a name="repositoryUrl" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.repositoryUrl"></a>
7871
+
7872
+ ```typescript
7873
+ public readonly repositoryUrl: string;
7874
+ ```
7875
+
7876
+ - *Type:* string
7877
+
7878
+ The URL where the actual code for the package lives.
7879
+
7880
+ ---
7881
+
7997
7882
  #### Constants <a name="Constants" id="Constants"></a>
7998
7883
 
7999
7884
  | **Name** | **Type** | **Description** |
8000
7885
  | --- | --- | --- |
8001
7886
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.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). |
7887
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
8002
7888
 
8003
7889
  ---
8004
7890
 
@@ -8017,6 +7903,16 @@ this task should synthesize the project files.
8017
7903
 
8018
7904
  ---
8019
7905
 
7906
+ ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
7907
+
7908
+ ```typescript
7909
+ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
7910
+ ```
7911
+
7912
+ - *Type:* string
7913
+
7914
+ ---
7915
+
8020
7916
  ### CdklabsTypeScriptProject <a name="CdklabsTypeScriptProject" id="cdklabs-projen-project-types.CdklabsTypeScriptProject"></a>
8021
7917
 
8022
7918
  Create a Cdklabs TypeScript Project.
@@ -8048,7 +7944,7 @@ new CdklabsTypeScriptProject(options: CdklabsTypeScriptProjectOptions)
8048
7944
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.toString">toString</a></code> | Returns a string representation of this construct. |
8049
7945
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
8050
7946
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
8051
- | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.addPackageIgnore">addPackageIgnore</a></code> | Exclude these files from the bundled package. |
7947
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
8052
7948
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.addTask">addTask</a></code> | Adds a new task to this project. |
8053
7949
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
8054
7950
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
@@ -8127,15 +8023,14 @@ The glob pattern to ignore.
8127
8023
  public addPackageIgnore(pattern: string): void
8128
8024
  ```
8129
8025
 
8130
- Exclude these files from the bundled package.
8131
-
8132
- Implemented by project types based on the
8133
- packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
8026
+ Adds patterns to be ignored by npm.
8134
8027
 
8135
8028
  ###### `pattern`<sup>Required</sup> <a name="pattern" id="cdklabs-projen-project-types.CdklabsTypeScriptProject.addPackageIgnore.parameter.pattern"></a>
8136
8029
 
8137
8030
  - *Type:* string
8138
8031
 
8032
+ The pattern to ignore.
8033
+
8139
8034
  ---
8140
8035
 
8141
8036
  ##### `addTask` <a name="addTask" id="cdklabs-projen-project-types.CdklabsTypeScriptProject.addTask"></a>
@@ -9503,6 +9398,7 @@ public readonly private: boolean;
9503
9398
  | **Name** | **Type** | **Description** |
9504
9399
  | --- | --- | --- |
9505
9400
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.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). |
9401
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
9506
9402
 
9507
9403
  ---
9508
9404
 
@@ -9521,6 +9417,16 @@ this task should synthesize the project files.
9521
9417
 
9522
9418
  ---
9523
9419
 
9420
+ ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="cdklabs-projen-project-types.CdklabsTypeScriptProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
9421
+
9422
+ ```typescript
9423
+ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
9424
+ ```
9425
+
9426
+ - *Type:* string
9427
+
9428
+ ---
9429
+
9524
9430
  ### CdkTypeScriptProject <a name="CdkTypeScriptProject" id="cdklabs-projen-project-types.CdkTypeScriptProject"></a>
9525
9431
 
9526
9432
  Create a Cdk TypeScript Project.
@@ -9552,7 +9458,7 @@ new CdkTypeScriptProject(options: CdkTypeScriptProjectOptions)
9552
9458
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.toString">toString</a></code> | Returns a string representation of this construct. |
9553
9459
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
9554
9460
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
9555
- | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.addPackageIgnore">addPackageIgnore</a></code> | Exclude these files from the bundled package. |
9461
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
9556
9462
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.addTask">addTask</a></code> | Adds a new task to this project. |
9557
9463
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
9558
9464
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
@@ -9631,15 +9537,14 @@ The glob pattern to ignore.
9631
9537
  public addPackageIgnore(pattern: string): void
9632
9538
  ```
9633
9539
 
9634
- Exclude these files from the bundled package.
9635
-
9636
- Implemented by project types based on the
9637
- packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
9540
+ Adds patterns to be ignored by npm.
9638
9541
 
9639
9542
  ###### `pattern`<sup>Required</sup> <a name="pattern" id="cdklabs-projen-project-types.CdkTypeScriptProject.addPackageIgnore.parameter.pattern"></a>
9640
9543
 
9641
9544
  - *Type:* string
9642
9545
 
9546
+ The pattern to ignore.
9547
+
9643
9548
  ---
9644
9549
 
9645
9550
  ##### `addTask` <a name="addTask" id="cdklabs-projen-project-types.CdkTypeScriptProject.addTask"></a>
@@ -11007,6 +10912,7 @@ public readonly private: boolean;
11007
10912
  | **Name** | **Type** | **Description** |
11008
10913
  | --- | --- | --- |
11009
10914
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.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). |
10915
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
11010
10916
 
11011
10917
  ---
11012
10918
 
@@ -11025,6 +10931,16 @@ this task should synthesize the project files.
11025
10931
 
11026
10932
  ---
11027
10933
 
10934
+ ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="cdklabs-projen-project-types.CdkTypeScriptProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
10935
+
10936
+ ```typescript
10937
+ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
10938
+ ```
10939
+
10940
+ - *Type:* string
10941
+
10942
+ ---
10943
+
11028
10944
  ### MergeQueue <a name="MergeQueue" id="cdklabs-projen-project-types.MergeQueue"></a>
11029
10945
 
11030
10946
  Merge pull requests using a merge queue.
@@ -11221,7 +11137,7 @@ new yarn.Monorepo(options: MonorepoOptions)
11221
11137
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.toString">toString</a></code> | Returns a string representation of this construct. |
11222
11138
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
11223
11139
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
11224
- | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.addPackageIgnore">addPackageIgnore</a></code> | Exclude these files from the bundled package. |
11140
+ | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
11225
11141
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.addTask">addTask</a></code> | Adds a new task to this project. |
11226
11142
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
11227
11143
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
@@ -11302,15 +11218,14 @@ The glob pattern to ignore.
11302
11218
  public addPackageIgnore(pattern: string): void
11303
11219
  ```
11304
11220
 
11305
- Exclude these files from the bundled package.
11306
-
11307
- Implemented by project types based on the
11308
- packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
11221
+ Adds patterns to be ignored by npm.
11309
11222
 
11310
11223
  ###### `pattern`<sup>Required</sup> <a name="pattern" id="cdklabs-projen-project-types.yarn.Monorepo.addPackageIgnore.parameter.pattern"></a>
11311
11224
 
11312
11225
  - *Type:* string
11313
11226
 
11227
+ The pattern to ignore.
11228
+
11314
11229
  ---
11315
11230
 
11316
11231
  ##### `addTask` <a name="addTask" id="cdklabs-projen-project-types.yarn.Monorepo.addTask"></a>
@@ -11939,6 +11854,7 @@ When given a project, this it the project itself.
11939
11854
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.eslint">eslint</a></code> | <code>projen.javascript.Eslint</code> | *No description.* |
11940
11855
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
11941
11856
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.tsconfigEslint">tsconfigEslint</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
11857
+ | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.repositoryUrl">repositoryUrl</a></code> | <code>string</code> | The URL where the actual code for the package lives. |
11942
11858
 
11943
11859
  ---
11944
11860
 
@@ -12688,11 +12604,24 @@ public readonly tsconfigEslint: TypescriptConfig;
12688
12604
 
12689
12605
  ---
12690
12606
 
12607
+ ##### `repositoryUrl`<sup>Optional</sup> <a name="repositoryUrl" id="cdklabs-projen-project-types.yarn.Monorepo.property.repositoryUrl"></a>
12608
+
12609
+ ```typescript
12610
+ public readonly repositoryUrl: string;
12611
+ ```
12612
+
12613
+ - *Type:* string
12614
+
12615
+ The URL where the actual code for the package lives.
12616
+
12617
+ ---
12618
+
12691
12619
  #### Constants <a name="Constants" id="Constants"></a>
12692
12620
 
12693
12621
  | **Name** | **Type** | **Description** |
12694
12622
  | --- | --- | --- |
12695
12623
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.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). |
12624
+ | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
12696
12625
 
12697
12626
  ---
12698
12627
 
@@ -12711,6 +12640,16 @@ this task should synthesize the project files.
12711
12640
 
12712
12641
  ---
12713
12642
 
12643
+ ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="cdklabs-projen-project-types.yarn.Monorepo.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
12644
+
12645
+ ```typescript
12646
+ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
12647
+ ```
12648
+
12649
+ - *Type:* string
12650
+
12651
+ ---
12652
+
12714
12653
  ### Rosetta <a name="Rosetta" id="cdklabs-projen-project-types.Rosetta"></a>
12715
12654
 
12716
12655
  The Rosetta component adds builtin rosetta support for a construct library.
@@ -12911,7 +12850,7 @@ new yarn.TypeScriptWorkspace(options: TypeScriptWorkspaceOptions)
12911
12850
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.toString">toString</a></code> | Returns a string representation of this construct. |
12912
12851
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
12913
12852
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
12914
- | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.addPackageIgnore">addPackageIgnore</a></code> | Exclude these files from the bundled package. |
12853
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
12915
12854
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.addTask">addTask</a></code> | Adds a new task to this project. |
12916
12855
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
12917
12856
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
@@ -12990,15 +12929,14 @@ The glob pattern to ignore.
12990
12929
  public addPackageIgnore(pattern: string): void
12991
12930
  ```
12992
12931
 
12993
- Exclude these files from the bundled package.
12994
-
12995
- Implemented by project types based on the
12996
- packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
12932
+ Adds patterns to be ignored by npm.
12997
12933
 
12998
12934
  ###### `pattern`<sup>Required</sup> <a name="pattern" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspace.addPackageIgnore.parameter.pattern"></a>
12999
12935
 
13000
12936
  - *Type:* string
13001
12937
 
12938
+ The pattern to ignore.
12939
+
13002
12940
  ---
13003
12941
 
13004
12942
  ##### `addTask` <a name="addTask" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspace.addTask"></a>
@@ -14366,6 +14304,7 @@ public readonly workspaceDirectory: string;
14366
14304
  | **Name** | **Type** | **Description** |
14367
14305
  | --- | --- | --- |
14368
14306
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.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). |
14307
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
14369
14308
 
14370
14309
  ---
14371
14310
 
@@ -14384,6 +14323,16 @@ this task should synthesize the project files.
14384
14323
 
14385
14324
  ---
14386
14325
 
14326
+ ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
14327
+
14328
+ ```typescript
14329
+ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
14330
+ ```
14331
+
14332
+ - *Type:* string
14333
+
14334
+ ---
14335
+
14387
14336
  ## Structs <a name="Structs" id="Structs"></a>
14388
14337
 
14389
14338
  ### AutoMergeOptions <a name="AutoMergeOptions" id="cdklabs-projen-project-types.AutoMergeOptions"></a>
@@ -14705,6 +14654,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
14705
14654
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
14706
14655
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
14707
14656
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
14657
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
14708
14658
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.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@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
14709
14659
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.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. |
14710
14660
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
@@ -14752,6 +14702,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
14752
14702
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
14753
14703
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
14754
14704
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
14705
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
14755
14706
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
14756
14707
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.author">author</a></code> | <code>string</code> | The name of the library author. |
14757
14708
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.authorAddress">authorAddress</a></code> | <code>string</code> | Email or URL of the library author. |
@@ -15996,7 +15947,7 @@ public readonly releaseWorkflowName: string;
15996
15947
  ```
15997
15948
 
15998
15949
  - *Type:* string
15999
- - *Default:* "Release"
15950
+ - *Default:* "release"
16000
15951
 
16001
15952
  The name of the default release workflow.
16002
15953
 
@@ -16146,6 +16097,21 @@ Options for `Bundler`.
16146
16097
 
16147
16098
  ---
16148
16099
 
16100
+ ##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.checkLicenses"></a>
16101
+
16102
+ ```typescript
16103
+ public readonly checkLicenses: LicenseCheckerOptions;
16104
+ ```
16105
+
16106
+ - *Type:* projen.javascript.LicenseCheckerOptions
16107
+ - *Default:* no license checks are run during the build and all licenses will be accepted
16108
+
16109
+ Configure which licenses should be deemed acceptable for use by dependencies.
16110
+
16111
+ This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
16112
+
16113
+ ---
16114
+
16149
16115
  ##### `codeCov`<sup>Optional</sup> <a name="codeCov" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeCov"></a>
16150
16116
 
16151
16117
  ```typescript
@@ -16772,6 +16738,18 @@ The name of the development tsconfig.json file.
16772
16738
 
16773
16739
  ---
16774
16740
 
16741
+ ##### `tsJestOptions`<sup>Optional</sup> <a name="tsJestOptions" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.tsJestOptions"></a>
16742
+
16743
+ ```typescript
16744
+ public readonly tsJestOptions: TsJestOptions;
16745
+ ```
16746
+
16747
+ - *Type:* projen.typescript.TsJestOptions
16748
+
16749
+ Options for ts-jest.
16750
+
16751
+ ---
16752
+
16775
16753
  ##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.typescriptVersion"></a>
16776
16754
 
16777
16755
  ```typescript
@@ -17447,6 +17425,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
17447
17425
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
17448
17426
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
17449
17427
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
17428
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
17450
17429
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.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@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
17451
17430
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.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. |
17452
17431
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
@@ -17494,6 +17473,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
17494
17473
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
17495
17474
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
17496
17475
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
17476
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
17497
17477
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
17498
17478
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.author">author</a></code> | <code>string</code> | The name of the library author. |
17499
17479
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.authorAddress">authorAddress</a></code> | <code>string</code> | Email or URL of the library author. |
@@ -18722,7 +18702,7 @@ public readonly releaseWorkflowName: string;
18722
18702
  ```
18723
18703
 
18724
18704
  - *Type:* string
18725
- - *Default:* "Release"
18705
+ - *Default:* "release"
18726
18706
 
18727
18707
  The name of the default release workflow.
18728
18708
 
@@ -18872,6 +18852,21 @@ Options for `Bundler`.
18872
18852
 
18873
18853
  ---
18874
18854
 
18855
+ ##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.checkLicenses"></a>
18856
+
18857
+ ```typescript
18858
+ public readonly checkLicenses: LicenseCheckerOptions;
18859
+ ```
18860
+
18861
+ - *Type:* projen.javascript.LicenseCheckerOptions
18862
+ - *Default:* no license checks are run during the build and all licenses will be accepted
18863
+
18864
+ Configure which licenses should be deemed acceptable for use by dependencies.
18865
+
18866
+ This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
18867
+
18868
+ ---
18869
+
18875
18870
  ##### `codeCov`<sup>Optional</sup> <a name="codeCov" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeCov"></a>
18876
18871
 
18877
18872
  ```typescript
@@ -19498,6 +19493,18 @@ The name of the development tsconfig.json file.
19498
19493
 
19499
19494
  ---
19500
19495
 
19496
+ ##### `tsJestOptions`<sup>Optional</sup> <a name="tsJestOptions" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.tsJestOptions"></a>
19497
+
19498
+ ```typescript
19499
+ public readonly tsJestOptions: TsJestOptions;
19500
+ ```
19501
+
19502
+ - *Type:* projen.typescript.TsJestOptions
19503
+
19504
+ Options for ts-jest.
19505
+
19506
+ ---
19507
+
19501
19508
  ##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.typescriptVersion"></a>
19502
19509
 
19503
19510
  ```typescript
@@ -19935,6 +19942,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
19935
19942
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
19936
19943
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
19937
19944
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
19945
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
19938
19946
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.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@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
19939
19947
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.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. |
19940
19948
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
@@ -19982,6 +19990,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
19982
19990
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
19983
19991
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
19984
19992
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
19993
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
19985
19994
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
19986
19995
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.author">author</a></code> | <code>string</code> | The name of the library author. |
19987
19996
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.authorAddress">authorAddress</a></code> | <code>string</code> | Email or URL of the library author. |
@@ -21228,7 +21237,7 @@ public readonly releaseWorkflowName: string;
21228
21237
  ```
21229
21238
 
21230
21239
  - *Type:* string
21231
- - *Default:* "Release"
21240
+ - *Default:* "release"
21232
21241
 
21233
21242
  The name of the default release workflow.
21234
21243
 
@@ -21378,6 +21387,21 @@ Options for `Bundler`.
21378
21387
 
21379
21388
  ---
21380
21389
 
21390
+ ##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.checkLicenses"></a>
21391
+
21392
+ ```typescript
21393
+ public readonly checkLicenses: LicenseCheckerOptions;
21394
+ ```
21395
+
21396
+ - *Type:* projen.javascript.LicenseCheckerOptions
21397
+ - *Default:* no license checks are run during the build and all licenses will be accepted
21398
+
21399
+ Configure which licenses should be deemed acceptable for use by dependencies.
21400
+
21401
+ This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
21402
+
21403
+ ---
21404
+
21381
21405
  ##### `codeCov`<sup>Optional</sup> <a name="codeCov" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeCov"></a>
21382
21406
 
21383
21407
  ```typescript
@@ -22004,6 +22028,18 @@ The name of the development tsconfig.json file.
22004
22028
 
22005
22029
  ---
22006
22030
 
22031
+ ##### `tsJestOptions`<sup>Optional</sup> <a name="tsJestOptions" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.tsJestOptions"></a>
22032
+
22033
+ ```typescript
22034
+ public readonly tsJestOptions: TsJestOptions;
22035
+ ```
22036
+
22037
+ - *Type:* projen.typescript.TsJestOptions
22038
+
22039
+ Options for ts-jest.
22040
+
22041
+ ---
22042
+
22007
22043
  ##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.typescriptVersion"></a>
22008
22044
 
22009
22045
  ```typescript
@@ -22718,6 +22754,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
22718
22754
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
22719
22755
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
22720
22756
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
22757
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
22721
22758
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.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@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
22722
22759
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.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. |
22723
22760
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
@@ -22765,6 +22802,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
22765
22802
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
22766
22803
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
22767
22804
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
22805
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
22768
22806
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
22769
22807
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.author">author</a></code> | <code>string</code> | The name of the library author. |
22770
22808
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.authorAddress">authorAddress</a></code> | <code>string</code> | Email or URL of the library author. |
@@ -23995,7 +24033,7 @@ public readonly releaseWorkflowName: string;
23995
24033
  ```
23996
24034
 
23997
24035
  - *Type:* string
23998
- - *Default:* "Release"
24036
+ - *Default:* "release"
23999
24037
 
24000
24038
  The name of the default release workflow.
24001
24039
 
@@ -24145,6 +24183,21 @@ Options for `Bundler`.
24145
24183
 
24146
24184
  ---
24147
24185
 
24186
+ ##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.checkLicenses"></a>
24187
+
24188
+ ```typescript
24189
+ public readonly checkLicenses: LicenseCheckerOptions;
24190
+ ```
24191
+
24192
+ - *Type:* projen.javascript.LicenseCheckerOptions
24193
+ - *Default:* no license checks are run during the build and all licenses will be accepted
24194
+
24195
+ Configure which licenses should be deemed acceptable for use by dependencies.
24196
+
24197
+ This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
24198
+
24199
+ ---
24200
+
24148
24201
  ##### `codeCov`<sup>Optional</sup> <a name="codeCov" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeCov"></a>
24149
24202
 
24150
24203
  ```typescript
@@ -24771,6 +24824,18 @@ The name of the development tsconfig.json file.
24771
24824
 
24772
24825
  ---
24773
24826
 
24827
+ ##### `tsJestOptions`<sup>Optional</sup> <a name="tsJestOptions" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.tsJestOptions"></a>
24828
+
24829
+ ```typescript
24830
+ public readonly tsJestOptions: TsJestOptions;
24831
+ ```
24832
+
24833
+ - *Type:* projen.typescript.TsJestOptions
24834
+
24835
+ Options for ts-jest.
24836
+
24837
+ ---
24838
+
24774
24839
  ##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.typescriptVersion"></a>
24775
24840
 
24776
24841
  ```typescript
@@ -25176,6 +25241,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
25176
25241
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
25177
25242
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
25178
25243
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
25244
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
25179
25245
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
25180
25246
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
25181
25247
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.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@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
@@ -25280,6 +25346,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
25280
25346
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
25281
25347
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
25282
25348
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
25349
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
25283
25350
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
25284
25351
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with standard-version package. |
25285
25352
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
@@ -25572,6 +25639,21 @@ Options for `Bundler`.
25572
25639
 
25573
25640
  ---
25574
25641
 
25642
+ ##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.checkLicenses"></a>
25643
+
25644
+ ```typescript
25645
+ public readonly checkLicenses: LicenseCheckerOptions;
25646
+ ```
25647
+
25648
+ - *Type:* projen.javascript.LicenseCheckerOptions
25649
+ - *Default:* no license checks are run during the build and all licenses will be accepted
25650
+
25651
+ Configure which licenses should be deemed acceptable for use by dependencies.
25652
+
25653
+ This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
25654
+
25655
+ ---
25656
+
25575
25657
  ##### `clobber`<sup>Optional</sup> <a name="clobber" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.clobber"></a>
25576
25658
 
25577
25659
  ```typescript
@@ -26823,7 +26905,7 @@ public readonly releaseWorkflowName: string;
26823
26905
  ```
26824
26906
 
26825
26907
  - *Type:* string
26826
- - *Default:* "Release"
26908
+ - *Default:* "release"
26827
26909
 
26828
26910
  The name of the default release workflow.
26829
26911
 
@@ -27038,6 +27120,18 @@ The name of the development tsconfig.json file.
27038
27120
 
27039
27121
  ---
27040
27122
 
27123
+ ##### `tsJestOptions`<sup>Optional</sup> <a name="tsJestOptions" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.tsJestOptions"></a>
27124
+
27125
+ ```typescript
27126
+ public readonly tsJestOptions: TsJestOptions;
27127
+ ```
27128
+
27129
+ - *Type:* projen.typescript.TsJestOptions
27130
+
27131
+ Options for ts-jest.
27132
+
27133
+ ---
27134
+
27041
27135
  ##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.typescriptVersion"></a>
27042
27136
 
27043
27137
  ```typescript
@@ -27365,6 +27459,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
27365
27459
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
27366
27460
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
27367
27461
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
27462
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
27368
27463
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.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@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
27369
27464
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.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. |
27370
27465
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
@@ -27412,6 +27507,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
27412
27507
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
27413
27508
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
27414
27509
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
27510
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
27415
27511
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
27416
27512
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.enablePRAutoMerge">enablePRAutoMerge</a></code> | <code>boolean</code> | Whether to enable the auto merge workflow for PRs This will enable the auto merge workflow as well as the merge queue. |
27417
27513
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.ghAutoMergeOptions">ghAutoMergeOptions</a></code> | <code><a href="#cdklabs-projen-project-types.AutoMergeOptions">AutoMergeOptions</a></code> | Options for the GitHub auto merge workflow (the workflow that turns on auto merge on all PRs). |
@@ -28624,7 +28720,7 @@ public readonly releaseWorkflowName: string;
28624
28720
  ```
28625
28721
 
28626
28722
  - *Type:* string
28627
- - *Default:* "Release"
28723
+ - *Default:* "release"
28628
28724
 
28629
28725
  The name of the default release workflow.
28630
28726
 
@@ -28774,6 +28870,21 @@ Options for `Bundler`.
28774
28870
 
28775
28871
  ---
28776
28872
 
28873
+ ##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.checkLicenses"></a>
28874
+
28875
+ ```typescript
28876
+ public readonly checkLicenses: LicenseCheckerOptions;
28877
+ ```
28878
+
28879
+ - *Type:* projen.javascript.LicenseCheckerOptions
28880
+ - *Default:* no license checks are run during the build and all licenses will be accepted
28881
+
28882
+ Configure which licenses should be deemed acceptable for use by dependencies.
28883
+
28884
+ This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
28885
+
28886
+ ---
28887
+
28777
28888
  ##### `codeCov`<sup>Optional</sup> <a name="codeCov" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeCov"></a>
28778
28889
 
28779
28890
  ```typescript
@@ -29400,6 +29511,18 @@ The name of the development tsconfig.json file.
29400
29511
 
29401
29512
  ---
29402
29513
 
29514
+ ##### `tsJestOptions`<sup>Optional</sup> <a name="tsJestOptions" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.tsJestOptions"></a>
29515
+
29516
+ ```typescript
29517
+ public readonly tsJestOptions: TsJestOptions;
29518
+ ```
29519
+
29520
+ - *Type:* projen.typescript.TsJestOptions
29521
+
29522
+ Options for ts-jest.
29523
+
29524
+ ---
29525
+
29403
29526
  ##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.typescriptVersion"></a>
29404
29527
 
29405
29528
  ```typescript
@@ -29618,6 +29741,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
29618
29741
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
29619
29742
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
29620
29743
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
29744
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
29621
29745
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.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@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
29622
29746
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.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. |
29623
29747
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
@@ -29665,6 +29789,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
29665
29789
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
29666
29790
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
29667
29791
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
29792
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
29668
29793
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
29669
29794
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.enablePRAutoMerge">enablePRAutoMerge</a></code> | <code>boolean</code> | Whether to enable the auto merge workflow for PRs This will enable the auto merge workflow as well as the merge queue. |
29670
29795
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.ghAutoMergeOptions">ghAutoMergeOptions</a></code> | <code><a href="#cdklabs-projen-project-types.AutoMergeOptions">AutoMergeOptions</a></code> | Options for the GitHub auto merge workflow (the workflow that turns on auto merge on all PRs). |
@@ -30877,7 +31002,7 @@ public readonly releaseWorkflowName: string;
30877
31002
  ```
30878
31003
 
30879
31004
  - *Type:* string
30880
- - *Default:* "Release"
31005
+ - *Default:* "release"
30881
31006
 
30882
31007
  The name of the default release workflow.
30883
31008
 
@@ -31027,6 +31152,21 @@ Options for `Bundler`.
31027
31152
 
31028
31153
  ---
31029
31154
 
31155
+ ##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.checkLicenses"></a>
31156
+
31157
+ ```typescript
31158
+ public readonly checkLicenses: LicenseCheckerOptions;
31159
+ ```
31160
+
31161
+ - *Type:* projen.javascript.LicenseCheckerOptions
31162
+ - *Default:* no license checks are run during the build and all licenses will be accepted
31163
+
31164
+ Configure which licenses should be deemed acceptable for use by dependencies.
31165
+
31166
+ This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
31167
+
31168
+ ---
31169
+
31030
31170
  ##### `codeCov`<sup>Optional</sup> <a name="codeCov" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeCov"></a>
31031
31171
 
31032
31172
  ```typescript
@@ -31653,6 +31793,18 @@ The name of the development tsconfig.json file.
31653
31793
 
31654
31794
  ---
31655
31795
 
31796
+ ##### `tsJestOptions`<sup>Optional</sup> <a name="tsJestOptions" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.tsJestOptions"></a>
31797
+
31798
+ ```typescript
31799
+ public readonly tsJestOptions: TsJestOptions;
31800
+ ```
31801
+
31802
+ - *Type:* projen.typescript.TsJestOptions
31803
+
31804
+ Options for ts-jest.
31805
+
31806
+ ---
31807
+
31656
31808
  ##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.typescriptVersion"></a>
31657
31809
 
31658
31810
  ```typescript
@@ -31861,6 +32013,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
31861
32013
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
31862
32014
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
31863
32015
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
32016
+ | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
31864
32017
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
31865
32018
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
31866
32019
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.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@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
@@ -31965,6 +32118,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
31965
32118
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
31966
32119
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
31967
32120
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
32121
+ | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
31968
32122
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
31969
32123
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with standard-version package. |
31970
32124
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
@@ -32257,6 +32411,21 @@ Options for `Bundler`.
32257
32411
 
32258
32412
  ---
32259
32413
 
32414
+ ##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.checkLicenses"></a>
32415
+
32416
+ ```typescript
32417
+ public readonly checkLicenses: LicenseCheckerOptions;
32418
+ ```
32419
+
32420
+ - *Type:* projen.javascript.LicenseCheckerOptions
32421
+ - *Default:* no license checks are run during the build and all licenses will be accepted
32422
+
32423
+ Configure which licenses should be deemed acceptable for use by dependencies.
32424
+
32425
+ This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
32426
+
32427
+ ---
32428
+
32260
32429
  ##### `clobber`<sup>Optional</sup> <a name="clobber" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.clobber"></a>
32261
32430
 
32262
32431
  ```typescript
@@ -33508,7 +33677,7 @@ public readonly releaseWorkflowName: string;
33508
33677
  ```
33509
33678
 
33510
33679
  - *Type:* string
33511
- - *Default:* "Release"
33680
+ - *Default:* "release"
33512
33681
 
33513
33682
  The name of the default release workflow.
33514
33683
 
@@ -33723,6 +33892,18 @@ The name of the development tsconfig.json file.
33723
33892
 
33724
33893
  ---
33725
33894
 
33895
+ ##### `tsJestOptions`<sup>Optional</sup> <a name="tsJestOptions" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.tsJestOptions"></a>
33896
+
33897
+ ```typescript
33898
+ public readonly tsJestOptions: TsJestOptions;
33899
+ ```
33900
+
33901
+ - *Type:* projen.typescript.TsJestOptions
33902
+
33903
+ Options for ts-jest.
33904
+
33905
+ ---
33906
+
33726
33907
  ##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.typescriptVersion"></a>
33727
33908
 
33728
33909
  ```typescript
@@ -33965,6 +34146,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
33965
34146
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
33966
34147
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
33967
34148
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
34149
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
33968
34150
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
33969
34151
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
33970
34152
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.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@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
@@ -34072,6 +34254,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
34072
34254
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
34073
34255
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
34074
34256
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
34257
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
34075
34258
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
34076
34259
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with standard-version package. |
34077
34260
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
@@ -34350,6 +34533,21 @@ Options for `Bundler`.
34350
34533
 
34351
34534
  ---
34352
34535
 
34536
+ ##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.checkLicenses"></a>
34537
+
34538
+ ```typescript
34539
+ public readonly checkLicenses: LicenseCheckerOptions;
34540
+ ```
34541
+
34542
+ - *Type:* projen.javascript.LicenseCheckerOptions
34543
+ - *Default:* no license checks are run during the build and all licenses will be accepted
34544
+
34545
+ Configure which licenses should be deemed acceptable for use by dependencies.
34546
+
34547
+ This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
34548
+
34549
+ ---
34550
+
34353
34551
  ##### `clobber`<sup>Optional</sup> <a name="clobber" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.clobber"></a>
34354
34552
 
34355
34553
  ```typescript
@@ -35637,7 +35835,7 @@ public readonly releaseWorkflowName: string;
35637
35835
  ```
35638
35836
 
35639
35837
  - *Type:* string
35640
- - *Default:* "Release"
35838
+ - *Default:* "release"
35641
35839
 
35642
35840
  The name of the default release workflow.
35643
35841
 
@@ -35853,6 +36051,18 @@ The name of the development tsconfig.json file.
35853
36051
 
35854
36052
  ---
35855
36053
 
36054
+ ##### `tsJestOptions`<sup>Optional</sup> <a name="tsJestOptions" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.tsJestOptions"></a>
36055
+
36056
+ ```typescript
36057
+ public readonly tsJestOptions: TsJestOptions;
36058
+ ```
36059
+
36060
+ - *Type:* projen.typescript.TsJestOptions
36061
+
36062
+ Options for ts-jest.
36063
+
36064
+ ---
36065
+
35856
36066
  ##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.typescriptVersion"></a>
35857
36067
 
35858
36068
  ```typescript