cdklabs-projen-project-types 0.3.14 → 0.3.15
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/.jsii +335 -263
- package/API.md +390 -0
- package/lib/cdk-construct-library-options.d.ts +5 -0
- package/lib/cdk-construct-library-options.js +1 -1
- package/lib/cdk-jsii-options.d.ts +5 -0
- package/lib/cdk-jsii-options.js +1 -1
- package/lib/cdk.js +2 -2
- package/lib/cdklabs.js +3 -3
- package/lib/jsii.js +1 -1
- package/lib/retryautomerge.js +4 -2
- package/lib/rosetta.js +1 -1
- package/lib/yarn/monorepo-options.d.ts +5 -0
- package/lib/yarn/monorepo-options.js +1 -1
- package/lib/yarn/monorepo-release.js +1 -1
- package/lib/yarn/monorepo.js +2 -2
- package/lib/yarn/typescript-workspace-options.d.ts +5 -0
- package/lib/yarn/typescript-workspace-options.js +1 -1
- package/lib/yarn/typescript-workspace-release.js +1 -1
- package/lib/yarn/typescript-workspace.js +1 -1
- package/package.json +6 -6
package/API.md
CHANGED
|
@@ -31,6 +31,7 @@ new CdkConstructLibrary(options: CdkConstructLibraryOptions)
|
|
|
31
31
|
| **Name** | **Description** |
|
|
32
32
|
| --- | --- |
|
|
33
33
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
34
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
34
35
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
35
36
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
36
37
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
@@ -73,6 +74,27 @@ public toString(): string
|
|
|
73
74
|
|
|
74
75
|
Returns a string representation of this construct.
|
|
75
76
|
|
|
77
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.CdkConstructLibrary.with"></a>
|
|
78
|
+
|
|
79
|
+
```typescript
|
|
80
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Applies one or more mixins to this construct.
|
|
84
|
+
|
|
85
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
86
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
87
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
88
|
+
constructs.
|
|
89
|
+
|
|
90
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.CdkConstructLibrary.with.parameter.mixins"></a>
|
|
91
|
+
|
|
92
|
+
- *Type:* ...constructs.IMixin[]
|
|
93
|
+
|
|
94
|
+
The mixins to apply.
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
76
98
|
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="cdklabs-projen-project-types.CdkConstructLibrary.addExcludeFromCleanup"></a>
|
|
77
99
|
|
|
78
100
|
```typescript
|
|
@@ -1633,6 +1655,7 @@ new CdkJsiiProject(options: CdkJsiiProjectOptions)
|
|
|
1633
1655
|
| **Name** | **Description** |
|
|
1634
1656
|
| --- | --- |
|
|
1635
1657
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
1658
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
1636
1659
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
1637
1660
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
1638
1661
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
@@ -1673,6 +1696,27 @@ public toString(): string
|
|
|
1673
1696
|
|
|
1674
1697
|
Returns a string representation of this construct.
|
|
1675
1698
|
|
|
1699
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.CdkJsiiProject.with"></a>
|
|
1700
|
+
|
|
1701
|
+
```typescript
|
|
1702
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
1703
|
+
```
|
|
1704
|
+
|
|
1705
|
+
Applies one or more mixins to this construct.
|
|
1706
|
+
|
|
1707
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
1708
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
1709
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
1710
|
+
constructs.
|
|
1711
|
+
|
|
1712
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.CdkJsiiProject.with.parameter.mixins"></a>
|
|
1713
|
+
|
|
1714
|
+
- *Type:* ...constructs.IMixin[]
|
|
1715
|
+
|
|
1716
|
+
The mixins to apply.
|
|
1717
|
+
|
|
1718
|
+
---
|
|
1719
|
+
|
|
1676
1720
|
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="cdklabs-projen-project-types.CdkJsiiProject.addExcludeFromCleanup"></a>
|
|
1677
1721
|
|
|
1678
1722
|
```typescript
|
|
@@ -3162,6 +3206,7 @@ new CdklabsConstructLibrary(options: CdklabsConstructLibraryOptions)
|
|
|
3162
3206
|
| **Name** | **Description** |
|
|
3163
3207
|
| --- | --- |
|
|
3164
3208
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
3209
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
3165
3210
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
3166
3211
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
3167
3212
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
@@ -3204,6 +3249,27 @@ public toString(): string
|
|
|
3204
3249
|
|
|
3205
3250
|
Returns a string representation of this construct.
|
|
3206
3251
|
|
|
3252
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.CdklabsConstructLibrary.with"></a>
|
|
3253
|
+
|
|
3254
|
+
```typescript
|
|
3255
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
3256
|
+
```
|
|
3257
|
+
|
|
3258
|
+
Applies one or more mixins to this construct.
|
|
3259
|
+
|
|
3260
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
3261
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
3262
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
3263
|
+
constructs.
|
|
3264
|
+
|
|
3265
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.CdklabsConstructLibrary.with.parameter.mixins"></a>
|
|
3266
|
+
|
|
3267
|
+
- *Type:* ...constructs.IMixin[]
|
|
3268
|
+
|
|
3269
|
+
The mixins to apply.
|
|
3270
|
+
|
|
3271
|
+
---
|
|
3272
|
+
|
|
3207
3273
|
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="cdklabs-projen-project-types.CdklabsConstructLibrary.addExcludeFromCleanup"></a>
|
|
3208
3274
|
|
|
3209
3275
|
```typescript
|
|
@@ -4764,6 +4830,7 @@ new CdklabsJsiiProject(options: CdklabsJsiiProjectOptions)
|
|
|
4764
4830
|
| **Name** | **Description** |
|
|
4765
4831
|
| --- | --- |
|
|
4766
4832
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
4833
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
4767
4834
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
4768
4835
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
4769
4836
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
@@ -4804,6 +4871,27 @@ public toString(): string
|
|
|
4804
4871
|
|
|
4805
4872
|
Returns a string representation of this construct.
|
|
4806
4873
|
|
|
4874
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.CdklabsJsiiProject.with"></a>
|
|
4875
|
+
|
|
4876
|
+
```typescript
|
|
4877
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
4878
|
+
```
|
|
4879
|
+
|
|
4880
|
+
Applies one or more mixins to this construct.
|
|
4881
|
+
|
|
4882
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
4883
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
4884
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
4885
|
+
constructs.
|
|
4886
|
+
|
|
4887
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.CdklabsJsiiProject.with.parameter.mixins"></a>
|
|
4888
|
+
|
|
4889
|
+
- *Type:* ...constructs.IMixin[]
|
|
4890
|
+
|
|
4891
|
+
The mixins to apply.
|
|
4892
|
+
|
|
4893
|
+
---
|
|
4894
|
+
|
|
4807
4895
|
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="cdklabs-projen-project-types.CdklabsJsiiProject.addExcludeFromCleanup"></a>
|
|
4808
4896
|
|
|
4809
4897
|
```typescript
|
|
@@ -6293,6 +6381,7 @@ new yarn.CdkLabsMonorepo(options: CdkLabsMonorepoOptions)
|
|
|
6293
6381
|
| **Name** | **Description** |
|
|
6294
6382
|
| --- | --- |
|
|
6295
6383
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
6384
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
6296
6385
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
6297
6386
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
6298
6387
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
@@ -6335,6 +6424,27 @@ public toString(): string
|
|
|
6335
6424
|
|
|
6336
6425
|
Returns a string representation of this construct.
|
|
6337
6426
|
|
|
6427
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.with"></a>
|
|
6428
|
+
|
|
6429
|
+
```typescript
|
|
6430
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
6431
|
+
```
|
|
6432
|
+
|
|
6433
|
+
Applies one or more mixins to this construct.
|
|
6434
|
+
|
|
6435
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
6436
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
6437
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
6438
|
+
constructs.
|
|
6439
|
+
|
|
6440
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.with.parameter.mixins"></a>
|
|
6441
|
+
|
|
6442
|
+
- *Type:* ...constructs.IMixin[]
|
|
6443
|
+
|
|
6444
|
+
The mixins to apply.
|
|
6445
|
+
|
|
6446
|
+
---
|
|
6447
|
+
|
|
6338
6448
|
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.addExcludeFromCleanup"></a>
|
|
6339
6449
|
|
|
6340
6450
|
```typescript
|
|
@@ -7891,6 +8001,7 @@ new CdklabsTypeScriptProject(options: CdklabsTypeScriptProjectOptions)
|
|
|
7891
8001
|
| **Name** | **Description** |
|
|
7892
8002
|
| --- | --- |
|
|
7893
8003
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
8004
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
7894
8005
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
7895
8006
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
7896
8007
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
@@ -7931,6 +8042,27 @@ public toString(): string
|
|
|
7931
8042
|
|
|
7932
8043
|
Returns a string representation of this construct.
|
|
7933
8044
|
|
|
8045
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.CdklabsTypeScriptProject.with"></a>
|
|
8046
|
+
|
|
8047
|
+
```typescript
|
|
8048
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
8049
|
+
```
|
|
8050
|
+
|
|
8051
|
+
Applies one or more mixins to this construct.
|
|
8052
|
+
|
|
8053
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
8054
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
8055
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
8056
|
+
constructs.
|
|
8057
|
+
|
|
8058
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.CdklabsTypeScriptProject.with.parameter.mixins"></a>
|
|
8059
|
+
|
|
8060
|
+
- *Type:* ...constructs.IMixin[]
|
|
8061
|
+
|
|
8062
|
+
The mixins to apply.
|
|
8063
|
+
|
|
8064
|
+
---
|
|
8065
|
+
|
|
7934
8066
|
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="cdklabs-projen-project-types.CdklabsTypeScriptProject.addExcludeFromCleanup"></a>
|
|
7935
8067
|
|
|
7936
8068
|
```typescript
|
|
@@ -9420,6 +9552,7 @@ new CdkTypeScriptProject(options: CdkTypeScriptProjectOptions)
|
|
|
9420
9552
|
| **Name** | **Description** |
|
|
9421
9553
|
| --- | --- |
|
|
9422
9554
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
9555
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
9423
9556
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
9424
9557
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
9425
9558
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
@@ -9460,6 +9593,27 @@ public toString(): string
|
|
|
9460
9593
|
|
|
9461
9594
|
Returns a string representation of this construct.
|
|
9462
9595
|
|
|
9596
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.CdkTypeScriptProject.with"></a>
|
|
9597
|
+
|
|
9598
|
+
```typescript
|
|
9599
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
9600
|
+
```
|
|
9601
|
+
|
|
9602
|
+
Applies one or more mixins to this construct.
|
|
9603
|
+
|
|
9604
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
9605
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
9606
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
9607
|
+
constructs.
|
|
9608
|
+
|
|
9609
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.CdkTypeScriptProject.with.parameter.mixins"></a>
|
|
9610
|
+
|
|
9611
|
+
- *Type:* ...constructs.IMixin[]
|
|
9612
|
+
|
|
9613
|
+
The mixins to apply.
|
|
9614
|
+
|
|
9615
|
+
---
|
|
9616
|
+
|
|
9463
9617
|
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="cdklabs-projen-project-types.CdkTypeScriptProject.addExcludeFromCleanup"></a>
|
|
9464
9618
|
|
|
9465
9619
|
```typescript
|
|
@@ -10949,6 +11103,7 @@ new yarn.Monorepo(options: MonorepoOptions)
|
|
|
10949
11103
|
| **Name** | **Description** |
|
|
10950
11104
|
| --- | --- |
|
|
10951
11105
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
11106
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
10952
11107
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
10953
11108
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
10954
11109
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
@@ -10991,6 +11146,27 @@ public toString(): string
|
|
|
10991
11146
|
|
|
10992
11147
|
Returns a string representation of this construct.
|
|
10993
11148
|
|
|
11149
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.yarn.Monorepo.with"></a>
|
|
11150
|
+
|
|
11151
|
+
```typescript
|
|
11152
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
11153
|
+
```
|
|
11154
|
+
|
|
11155
|
+
Applies one or more mixins to this construct.
|
|
11156
|
+
|
|
11157
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
11158
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
11159
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
11160
|
+
constructs.
|
|
11161
|
+
|
|
11162
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.yarn.Monorepo.with.parameter.mixins"></a>
|
|
11163
|
+
|
|
11164
|
+
- *Type:* ...constructs.IMixin[]
|
|
11165
|
+
|
|
11166
|
+
The mixins to apply.
|
|
11167
|
+
|
|
11168
|
+
---
|
|
11169
|
+
|
|
10994
11170
|
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="cdklabs-projen-project-types.yarn.Monorepo.addExcludeFromCleanup"></a>
|
|
10995
11171
|
|
|
10996
11172
|
```typescript
|
|
@@ -12552,6 +12728,7 @@ new yarn.MonorepoRelease(project: Project, options?: MonorepoReleaseOptions)
|
|
|
12552
12728
|
| **Name** | **Description** |
|
|
12553
12729
|
| --- | --- |
|
|
12554
12730
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoRelease.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
12731
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoRelease.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
12555
12732
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoRelease.postSynthesize">postSynthesize</a></code> | Called after synthesis. |
|
|
12556
12733
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoRelease.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
|
|
12557
12734
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoRelease.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
|
|
@@ -12568,6 +12745,27 @@ public toString(): string
|
|
|
12568
12745
|
|
|
12569
12746
|
Returns a string representation of this construct.
|
|
12570
12747
|
|
|
12748
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.yarn.MonorepoRelease.with"></a>
|
|
12749
|
+
|
|
12750
|
+
```typescript
|
|
12751
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
12752
|
+
```
|
|
12753
|
+
|
|
12754
|
+
Applies one or more mixins to this construct.
|
|
12755
|
+
|
|
12756
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
12757
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
12758
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
12759
|
+
constructs.
|
|
12760
|
+
|
|
12761
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.yarn.MonorepoRelease.with.parameter.mixins"></a>
|
|
12762
|
+
|
|
12763
|
+
- *Type:* ...constructs.IMixin[]
|
|
12764
|
+
|
|
12765
|
+
The mixins to apply.
|
|
12766
|
+
|
|
12767
|
+
---
|
|
12768
|
+
|
|
12571
12769
|
##### `postSynthesize` <a name="postSynthesize" id="cdklabs-projen-project-types.yarn.MonorepoRelease.postSynthesize"></a>
|
|
12572
12770
|
|
|
12573
12771
|
```typescript
|
|
@@ -12770,6 +12968,7 @@ new Rosetta(project: JsiiProject, options?: RosettaOptions)
|
|
|
12770
12968
|
| **Name** | **Description** |
|
|
12771
12969
|
| --- | --- |
|
|
12772
12970
|
| <code><a href="#cdklabs-projen-project-types.Rosetta.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
12971
|
+
| <code><a href="#cdklabs-projen-project-types.Rosetta.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
12773
12972
|
| <code><a href="#cdklabs-projen-project-types.Rosetta.postSynthesize">postSynthesize</a></code> | Called after synthesis. |
|
|
12774
12973
|
| <code><a href="#cdklabs-projen-project-types.Rosetta.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
|
|
12775
12974
|
| <code><a href="#cdklabs-projen-project-types.Rosetta.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
|
|
@@ -12784,6 +12983,27 @@ public toString(): string
|
|
|
12784
12983
|
|
|
12785
12984
|
Returns a string representation of this construct.
|
|
12786
12985
|
|
|
12986
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.Rosetta.with"></a>
|
|
12987
|
+
|
|
12988
|
+
```typescript
|
|
12989
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
12990
|
+
```
|
|
12991
|
+
|
|
12992
|
+
Applies one or more mixins to this construct.
|
|
12993
|
+
|
|
12994
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
12995
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
12996
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
12997
|
+
constructs.
|
|
12998
|
+
|
|
12999
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.Rosetta.with.parameter.mixins"></a>
|
|
13000
|
+
|
|
13001
|
+
- *Type:* ...constructs.IMixin[]
|
|
13002
|
+
|
|
13003
|
+
The mixins to apply.
|
|
13004
|
+
|
|
13005
|
+
---
|
|
13006
|
+
|
|
12787
13007
|
##### `postSynthesize` <a name="postSynthesize" id="cdklabs-projen-project-types.Rosetta.postSynthesize"></a>
|
|
12788
13008
|
|
|
12789
13009
|
```typescript
|
|
@@ -12930,6 +13150,7 @@ new yarn.TypeScriptWorkspace(options: TypeScriptWorkspaceOptions)
|
|
|
12930
13150
|
| **Name** | **Description** |
|
|
12931
13151
|
| --- | --- |
|
|
12932
13152
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
13153
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
12933
13154
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
12934
13155
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
12935
13156
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
@@ -12972,6 +13193,27 @@ public toString(): string
|
|
|
12972
13193
|
|
|
12973
13194
|
Returns a string representation of this construct.
|
|
12974
13195
|
|
|
13196
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspace.with"></a>
|
|
13197
|
+
|
|
13198
|
+
```typescript
|
|
13199
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
13200
|
+
```
|
|
13201
|
+
|
|
13202
|
+
Applies one or more mixins to this construct.
|
|
13203
|
+
|
|
13204
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
13205
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
13206
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
13207
|
+
constructs.
|
|
13208
|
+
|
|
13209
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspace.with.parameter.mixins"></a>
|
|
13210
|
+
|
|
13211
|
+
- *Type:* ...constructs.IMixin[]
|
|
13212
|
+
|
|
13213
|
+
The mixins to apply.
|
|
13214
|
+
|
|
13215
|
+
---
|
|
13216
|
+
|
|
12975
13217
|
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspace.addExcludeFromCleanup"></a>
|
|
12976
13218
|
|
|
12977
13219
|
```typescript
|
|
@@ -14533,6 +14775,7 @@ new yarn.WorkspaceRelease(project: TypeScriptWorkspace, options: WorkspaceReleas
|
|
|
14533
14775
|
| **Name** | **Description** |
|
|
14534
14776
|
| --- | --- |
|
|
14535
14777
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceRelease.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
14778
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceRelease.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
14536
14779
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceRelease.postSynthesize">postSynthesize</a></code> | Called after synthesis. |
|
|
14537
14780
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceRelease.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
|
|
14538
14781
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceRelease.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
|
|
@@ -14547,6 +14790,27 @@ public toString(): string
|
|
|
14547
14790
|
|
|
14548
14791
|
Returns a string representation of this construct.
|
|
14549
14792
|
|
|
14793
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.yarn.WorkspaceRelease.with"></a>
|
|
14794
|
+
|
|
14795
|
+
```typescript
|
|
14796
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
14797
|
+
```
|
|
14798
|
+
|
|
14799
|
+
Applies one or more mixins to this construct.
|
|
14800
|
+
|
|
14801
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
14802
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
14803
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
14804
|
+
constructs.
|
|
14805
|
+
|
|
14806
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.yarn.WorkspaceRelease.with.parameter.mixins"></a>
|
|
14807
|
+
|
|
14808
|
+
- *Type:* ...constructs.IMixin[]
|
|
14809
|
+
|
|
14810
|
+
The mixins to apply.
|
|
14811
|
+
|
|
14812
|
+
---
|
|
14813
|
+
|
|
14550
14814
|
##### `postSynthesize` <a name="postSynthesize" id="cdklabs-projen-project-types.yarn.WorkspaceRelease.postSynthesize"></a>
|
|
14551
14815
|
|
|
14552
14816
|
```typescript
|
|
@@ -14960,6 +15224,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
14960
15224
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
|
|
14961
15225
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
|
|
14962
15226
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.private">private</a></code> | <code>boolean</code> | Whether or not this package is private. |
|
|
15227
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.projectTree">projectTree</a></code> | <code>boolean</code> | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. |
|
|
14963
15228
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
14964
15229
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
14965
15230
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
@@ -16829,6 +17094,19 @@ Setting this variable to true means that your project is created with sane defau
|
|
|
16829
17094
|
|
|
16830
17095
|
---
|
|
16831
17096
|
|
|
17097
|
+
##### `projectTree`<sup>Optional</sup> <a name="projectTree" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.projectTree"></a>
|
|
17098
|
+
|
|
17099
|
+
```typescript
|
|
17100
|
+
public readonly projectTree: boolean;
|
|
17101
|
+
```
|
|
17102
|
+
|
|
17103
|
+
- *Type:* boolean
|
|
17104
|
+
- *Default:* false
|
|
17105
|
+
|
|
17106
|
+
Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging.
|
|
17107
|
+
|
|
17108
|
+
---
|
|
17109
|
+
|
|
16832
17110
|
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.projectType"></a>
|
|
16833
17111
|
|
|
16834
17112
|
- *Deprecated:* no longer supported at the base project level
|
|
@@ -17926,6 +18204,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
17926
18204
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
|
|
17927
18205
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
|
|
17928
18206
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.private">private</a></code> | <code>boolean</code> | Whether or not this package is private. |
|
|
18207
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.projectTree">projectTree</a></code> | <code>boolean</code> | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. |
|
|
17929
18208
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
17930
18209
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
17931
18210
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
@@ -19560,6 +19839,19 @@ Setting this variable to true means that your project is created with sane defau
|
|
|
19560
19839
|
|
|
19561
19840
|
---
|
|
19562
19841
|
|
|
19842
|
+
##### `projectTree`<sup>Optional</sup> <a name="projectTree" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.projectTree"></a>
|
|
19843
|
+
|
|
19844
|
+
```typescript
|
|
19845
|
+
public readonly projectTree: boolean;
|
|
19846
|
+
```
|
|
19847
|
+
|
|
19848
|
+
- *Type:* boolean
|
|
19849
|
+
- *Default:* false
|
|
19850
|
+
|
|
19851
|
+
Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging.
|
|
19852
|
+
|
|
19853
|
+
---
|
|
19854
|
+
|
|
19563
19855
|
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.projectType"></a>
|
|
19564
19856
|
|
|
19565
19857
|
- *Deprecated:* no longer supported at the base project level
|
|
@@ -20661,6 +20953,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
20661
20953
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
|
|
20662
20954
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
|
|
20663
20955
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.private">private</a></code> | <code>boolean</code> | Whether or not this package is private. |
|
|
20956
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.projectTree">projectTree</a></code> | <code>boolean</code> | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. |
|
|
20664
20957
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
20665
20958
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
20666
20959
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
@@ -22532,6 +22825,19 @@ Setting this variable to true means that your project is created with sane defau
|
|
|
22532
22825
|
|
|
22533
22826
|
---
|
|
22534
22827
|
|
|
22828
|
+
##### `projectTree`<sup>Optional</sup> <a name="projectTree" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.projectTree"></a>
|
|
22829
|
+
|
|
22830
|
+
```typescript
|
|
22831
|
+
public readonly projectTree: boolean;
|
|
22832
|
+
```
|
|
22833
|
+
|
|
22834
|
+
- *Type:* boolean
|
|
22835
|
+
- *Default:* false
|
|
22836
|
+
|
|
22837
|
+
Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging.
|
|
22838
|
+
|
|
22839
|
+
---
|
|
22840
|
+
|
|
22535
22841
|
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.projectType"></a>
|
|
22536
22842
|
|
|
22537
22843
|
- *Deprecated:* no longer supported at the base project level
|
|
@@ -23666,6 +23972,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
23666
23972
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
|
|
23667
23973
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
|
|
23668
23974
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.private">private</a></code> | <code>boolean</code> | Whether or not this package is private. |
|
|
23975
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.projectTree">projectTree</a></code> | <code>boolean</code> | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. |
|
|
23669
23976
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
23670
23977
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
23671
23978
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
@@ -25302,6 +25609,19 @@ Setting this variable to true means that your project is created with sane defau
|
|
|
25302
25609
|
|
|
25303
25610
|
---
|
|
25304
25611
|
|
|
25612
|
+
##### `projectTree`<sup>Optional</sup> <a name="projectTree" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.projectTree"></a>
|
|
25613
|
+
|
|
25614
|
+
```typescript
|
|
25615
|
+
public readonly projectTree: boolean;
|
|
25616
|
+
```
|
|
25617
|
+
|
|
25618
|
+
- *Type:* boolean
|
|
25619
|
+
- *Default:* false
|
|
25620
|
+
|
|
25621
|
+
Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging.
|
|
25622
|
+
|
|
25623
|
+
---
|
|
25624
|
+
|
|
25305
25625
|
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.projectType"></a>
|
|
25306
25626
|
|
|
25307
25627
|
- *Deprecated:* no longer supported at the base project level
|
|
@@ -26414,6 +26734,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
26414
26734
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.prerelease">prerelease</a></code> | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). |
|
|
26415
26735
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
|
|
26416
26736
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
|
|
26737
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.projectTree">projectTree</a></code> | <code>boolean</code> | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. |
|
|
26417
26738
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
26418
26739
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
26419
26740
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
@@ -27831,6 +28152,19 @@ Prettier options.
|
|
|
27831
28152
|
|
|
27832
28153
|
---
|
|
27833
28154
|
|
|
28155
|
+
##### `projectTree`<sup>Optional</sup> <a name="projectTree" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.projectTree"></a>
|
|
28156
|
+
|
|
28157
|
+
```typescript
|
|
28158
|
+
public readonly projectTree: boolean;
|
|
28159
|
+
```
|
|
28160
|
+
|
|
28161
|
+
- *Type:* boolean
|
|
28162
|
+
- *Default:* false
|
|
28163
|
+
|
|
28164
|
+
Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging.
|
|
28165
|
+
|
|
28166
|
+
---
|
|
28167
|
+
|
|
27834
28168
|
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.projectType"></a>
|
|
27835
28169
|
|
|
27836
28170
|
- *Deprecated:* no longer supported at the base project level
|
|
@@ -28759,6 +29093,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
28759
29093
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
|
|
28760
29094
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. |
|
|
28761
29095
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.parent">parent</a></code> | <code>projen.Project</code> | The parent project, if this project is part of a bigger project. |
|
|
29096
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.projectTree">projectTree</a></code> | <code>boolean</code> | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. |
|
|
28762
29097
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
28763
29098
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.projenrcJson">projenrcJson</a></code> | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
|
|
28764
29099
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.projenrcJsonOptions">projenrcJsonOptions</a></code> | <code>projen.ProjenrcJsonOptions</code> | Options for .projenrc.json. |
|
|
@@ -29011,6 +29346,19 @@ The parent project, if this project is part of a bigger project.
|
|
|
29011
29346
|
|
|
29012
29347
|
---
|
|
29013
29348
|
|
|
29349
|
+
##### `projectTree`<sup>Optional</sup> <a name="projectTree" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.projectTree"></a>
|
|
29350
|
+
|
|
29351
|
+
```typescript
|
|
29352
|
+
public readonly projectTree: boolean;
|
|
29353
|
+
```
|
|
29354
|
+
|
|
29355
|
+
- *Type:* boolean
|
|
29356
|
+
- *Default:* false
|
|
29357
|
+
|
|
29358
|
+
Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging.
|
|
29359
|
+
|
|
29360
|
+
---
|
|
29361
|
+
|
|
29014
29362
|
##### `projenCommand`<sup>Optional</sup> <a name="projenCommand" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.projenCommand"></a>
|
|
29015
29363
|
|
|
29016
29364
|
```typescript
|
|
@@ -31271,6 +31619,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
31271
31619
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
|
|
31272
31620
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. |
|
|
31273
31621
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.parent">parent</a></code> | <code>projen.Project</code> | The parent project, if this project is part of a bigger project. |
|
|
31622
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.projectTree">projectTree</a></code> | <code>boolean</code> | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. |
|
|
31274
31623
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
31275
31624
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.projenrcJson">projenrcJson</a></code> | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
|
|
31276
31625
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.projenrcJsonOptions">projenrcJsonOptions</a></code> | <code>projen.ProjenrcJsonOptions</code> | Options for .projenrc.json. |
|
|
@@ -31523,6 +31872,19 @@ The parent project, if this project is part of a bigger project.
|
|
|
31523
31872
|
|
|
31524
31873
|
---
|
|
31525
31874
|
|
|
31875
|
+
##### `projectTree`<sup>Optional</sup> <a name="projectTree" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.projectTree"></a>
|
|
31876
|
+
|
|
31877
|
+
```typescript
|
|
31878
|
+
public readonly projectTree: boolean;
|
|
31879
|
+
```
|
|
31880
|
+
|
|
31881
|
+
- *Type:* boolean
|
|
31882
|
+
- *Default:* false
|
|
31883
|
+
|
|
31884
|
+
Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging.
|
|
31885
|
+
|
|
31886
|
+
---
|
|
31887
|
+
|
|
31526
31888
|
##### `projenCommand`<sup>Optional</sup> <a name="projenCommand" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.projenCommand"></a>
|
|
31527
31889
|
|
|
31528
31890
|
```typescript
|
|
@@ -33872,6 +34234,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
33872
34234
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.prerelease">prerelease</a></code> | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). |
|
|
33873
34235
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
|
|
33874
34236
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
|
|
34237
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.projectTree">projectTree</a></code> | <code>boolean</code> | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. |
|
|
33875
34238
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
33876
34239
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
33877
34240
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
@@ -35289,6 +35652,19 @@ Prettier options.
|
|
|
35289
35652
|
|
|
35290
35653
|
---
|
|
35291
35654
|
|
|
35655
|
+
##### `projectTree`<sup>Optional</sup> <a name="projectTree" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.projectTree"></a>
|
|
35656
|
+
|
|
35657
|
+
```typescript
|
|
35658
|
+
public readonly projectTree: boolean;
|
|
35659
|
+
```
|
|
35660
|
+
|
|
35661
|
+
- *Type:* boolean
|
|
35662
|
+
- *Default:* false
|
|
35663
|
+
|
|
35664
|
+
Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging.
|
|
35665
|
+
|
|
35666
|
+
---
|
|
35667
|
+
|
|
35292
35668
|
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.projectType"></a>
|
|
35293
35669
|
|
|
35294
35670
|
- *Deprecated:* no longer supported at the base project level
|
|
@@ -36697,6 +37073,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
|
|
|
36697
37073
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
|
|
36698
37074
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
|
|
36699
37075
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.private">private</a></code> | <code>boolean</code> | Make this a private package. |
|
|
37076
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.projectTree">projectTree</a></code> | <code>boolean</code> | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. |
|
|
36700
37077
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
36701
37078
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
36702
37079
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
@@ -38123,6 +38500,19 @@ Make this a private package.
|
|
|
38123
38500
|
|
|
38124
38501
|
---
|
|
38125
38502
|
|
|
38503
|
+
##### `projectTree`<sup>Optional</sup> <a name="projectTree" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.projectTree"></a>
|
|
38504
|
+
|
|
38505
|
+
```typescript
|
|
38506
|
+
public readonly projectTree: boolean;
|
|
38507
|
+
```
|
|
38508
|
+
|
|
38509
|
+
- *Type:* boolean
|
|
38510
|
+
- *Default:* false
|
|
38511
|
+
|
|
38512
|
+
Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging.
|
|
38513
|
+
|
|
38514
|
+
---
|
|
38515
|
+
|
|
38126
38516
|
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.projectType"></a>
|
|
38127
38517
|
|
|
38128
38518
|
- *Deprecated:* no longer supported at the base project level
|