cdklabs-projen-project-types 0.6.8 → 0.6.10

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.
Binary file
package/API.md CHANGED
@@ -14328,6 +14328,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
14328
14328
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.constructsVersion">constructsVersion</a></code> | <code>string</code> | Minimum version of the `constructs` library to depend on. |
14329
14329
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
14330
14330
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
14331
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
14331
14332
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
14332
14333
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
14333
14334
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
@@ -15124,6 +15125,10 @@ public readonly copyrightOwner: string;
15124
15125
 
15125
15126
  License copyright owner.
15126
15127
 
15128
+ This value is only used if the selected license text contains the
15129
+ `$copyright_owner` placeholder. For example, it has no effect on the
15130
+ MPL-2.0 license text.
15131
+
15127
15132
  ---
15128
15133
 
15129
15134
  ##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.copyrightPeriod"></a>
@@ -15137,6 +15142,38 @@ public readonly copyrightPeriod: string;
15137
15142
 
15138
15143
  The copyright years to put in the LICENSE file.
15139
15144
 
15145
+ This value is only used if the selected license text contains the
15146
+ `$copyright_period` placeholder. For example, it has no effect on the
15147
+ MPL-2.0 license text.
15148
+
15149
+ ---
15150
+
15151
+ ##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.dedupeDeps"></a>
15152
+
15153
+ ```typescript
15154
+ public readonly dedupeDeps: boolean;
15155
+ ```
15156
+
15157
+ - *Type:* boolean
15158
+ - *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
15159
+
15160
+ Add a `dedupe` task that deduplicates project dependencies.
15161
+
15162
+ Deduplication prevents multiple versions of the same package from being
15163
+ installed, if a single version can satisfy all requested version ranges.
15164
+ This prevents version proliferation and reduces the size of the dependency
15165
+ tree.
15166
+
15167
+ The behavior depends on the package manager:
15168
+ - npm: runs `npm dedupe` after every mutating install.
15169
+ - pnpm: runs `pnpm dedupe` after every mutating install.
15170
+ - Yarn Berry: runs `yarn dedupe` after every mutating install. If
15171
+ `yarnBerryOptions.dedupePackages` is set, only the listed packages are
15172
+ deduplicated.
15173
+ - Yarn Classic: `yarn install` already deduplicates, so the task only
15174
+ prints an informational message.
15175
+ - Bun: not supported, enabling this option throws an error.
15176
+
15140
15177
  ---
15141
15178
 
15142
15179
  ##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.defaultReleaseBranch"></a>
@@ -17165,6 +17202,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
17165
17202
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
17166
17203
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
17167
17204
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
17205
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
17168
17206
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
17169
17207
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
17170
17208
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
@@ -17872,6 +17910,10 @@ public readonly copyrightOwner: string;
17872
17910
 
17873
17911
  License copyright owner.
17874
17912
 
17913
+ This value is only used if the selected license text contains the
17914
+ `$copyright_owner` placeholder. For example, it has no effect on the
17915
+ MPL-2.0 license text.
17916
+
17875
17917
  ---
17876
17918
 
17877
17919
  ##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.copyrightPeriod"></a>
@@ -17885,6 +17927,38 @@ public readonly copyrightPeriod: string;
17885
17927
 
17886
17928
  The copyright years to put in the LICENSE file.
17887
17929
 
17930
+ This value is only used if the selected license text contains the
17931
+ `$copyright_period` placeholder. For example, it has no effect on the
17932
+ MPL-2.0 license text.
17933
+
17934
+ ---
17935
+
17936
+ ##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.dedupeDeps"></a>
17937
+
17938
+ ```typescript
17939
+ public readonly dedupeDeps: boolean;
17940
+ ```
17941
+
17942
+ - *Type:* boolean
17943
+ - *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
17944
+
17945
+ Add a `dedupe` task that deduplicates project dependencies.
17946
+
17947
+ Deduplication prevents multiple versions of the same package from being
17948
+ installed, if a single version can satisfy all requested version ranges.
17949
+ This prevents version proliferation and reduces the size of the dependency
17950
+ tree.
17951
+
17952
+ The behavior depends on the package manager:
17953
+ - npm: runs `npm dedupe` after every mutating install.
17954
+ - pnpm: runs `pnpm dedupe` after every mutating install.
17955
+ - Yarn Berry: runs `yarn dedupe` after every mutating install. If
17956
+ `yarnBerryOptions.dedupePackages` is set, only the listed packages are
17957
+ deduplicated.
17958
+ - Yarn Classic: `yarn install` already deduplicates, so the task only
17959
+ prints an informational message.
17960
+ - Bun: not supported, enabling this option throws an error.
17961
+
17888
17962
  ---
17889
17963
 
17890
17964
  ##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.defaultReleaseBranch"></a>
@@ -19823,6 +19897,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
19823
19897
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.constructsVersion">constructsVersion</a></code> | <code>string</code> | Minimum version of the `constructs` library to depend on. |
19824
19898
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
19825
19899
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
19900
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
19826
19901
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
19827
19902
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
19828
19903
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
@@ -20621,6 +20696,10 @@ public readonly copyrightOwner: string;
20621
20696
 
20622
20697
  License copyright owner.
20623
20698
 
20699
+ This value is only used if the selected license text contains the
20700
+ `$copyright_owner` placeholder. For example, it has no effect on the
20701
+ MPL-2.0 license text.
20702
+
20624
20703
  ---
20625
20704
 
20626
20705
  ##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.copyrightPeriod"></a>
@@ -20634,6 +20713,38 @@ public readonly copyrightPeriod: string;
20634
20713
 
20635
20714
  The copyright years to put in the LICENSE file.
20636
20715
 
20716
+ This value is only used if the selected license text contains the
20717
+ `$copyright_period` placeholder. For example, it has no effect on the
20718
+ MPL-2.0 license text.
20719
+
20720
+ ---
20721
+
20722
+ ##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.dedupeDeps"></a>
20723
+
20724
+ ```typescript
20725
+ public readonly dedupeDeps: boolean;
20726
+ ```
20727
+
20728
+ - *Type:* boolean
20729
+ - *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
20730
+
20731
+ Add a `dedupe` task that deduplicates project dependencies.
20732
+
20733
+ Deduplication prevents multiple versions of the same package from being
20734
+ installed, if a single version can satisfy all requested version ranges.
20735
+ This prevents version proliferation and reduces the size of the dependency
20736
+ tree.
20737
+
20738
+ The behavior depends on the package manager:
20739
+ - npm: runs `npm dedupe` after every mutating install.
20740
+ - pnpm: runs `pnpm dedupe` after every mutating install.
20741
+ - Yarn Berry: runs `yarn dedupe` after every mutating install. If
20742
+ `yarnBerryOptions.dedupePackages` is set, only the listed packages are
20743
+ deduplicated.
20744
+ - Yarn Classic: `yarn install` already deduplicates, so the task only
20745
+ prints an informational message.
20746
+ - Bun: not supported, enabling this option throws an error.
20747
+
20637
20748
  ---
20638
20749
 
20639
20750
  ##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.defaultReleaseBranch"></a>
@@ -22699,6 +22810,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
22699
22810
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
22700
22811
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
22701
22812
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
22813
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
22702
22814
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
22703
22815
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
22704
22816
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
@@ -23408,6 +23520,10 @@ public readonly copyrightOwner: string;
23408
23520
 
23409
23521
  License copyright owner.
23410
23522
 
23523
+ This value is only used if the selected license text contains the
23524
+ `$copyright_owner` placeholder. For example, it has no effect on the
23525
+ MPL-2.0 license text.
23526
+
23411
23527
  ---
23412
23528
 
23413
23529
  ##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.copyrightPeriod"></a>
@@ -23421,6 +23537,38 @@ public readonly copyrightPeriod: string;
23421
23537
 
23422
23538
  The copyright years to put in the LICENSE file.
23423
23539
 
23540
+ This value is only used if the selected license text contains the
23541
+ `$copyright_period` placeholder. For example, it has no effect on the
23542
+ MPL-2.0 license text.
23543
+
23544
+ ---
23545
+
23546
+ ##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.dedupeDeps"></a>
23547
+
23548
+ ```typescript
23549
+ public readonly dedupeDeps: boolean;
23550
+ ```
23551
+
23552
+ - *Type:* boolean
23553
+ - *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
23554
+
23555
+ Add a `dedupe` task that deduplicates project dependencies.
23556
+
23557
+ Deduplication prevents multiple versions of the same package from being
23558
+ installed, if a single version can satisfy all requested version ranges.
23559
+ This prevents version proliferation and reduces the size of the dependency
23560
+ tree.
23561
+
23562
+ The behavior depends on the package manager:
23563
+ - npm: runs `npm dedupe` after every mutating install.
23564
+ - pnpm: runs `pnpm dedupe` after every mutating install.
23565
+ - Yarn Berry: runs `yarn dedupe` after every mutating install. If
23566
+ `yarnBerryOptions.dedupePackages` is set, only the listed packages are
23567
+ deduplicated.
23568
+ - Yarn Classic: `yarn install` already deduplicates, so the task only
23569
+ prints an informational message.
23570
+ - Bun: not supported, enabling this option throws an error.
23571
+
23424
23572
  ---
23425
23573
 
23426
23574
  ##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.defaultReleaseBranch"></a>
@@ -25393,6 +25541,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
25393
25541
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.consistentVersions">consistentVersions</a></code> | <code>string[]</code> | Package names that must use a consistent version across all workspaces. |
25394
25542
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
25395
25543
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
25544
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
25396
25545
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
25397
25546
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
25398
25547
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
@@ -26061,6 +26210,10 @@ public readonly copyrightOwner: string;
26061
26210
 
26062
26211
  License copyright owner.
26063
26212
 
26213
+ This value is only used if the selected license text contains the
26214
+ `$copyright_owner` placeholder. For example, it has no effect on the
26215
+ MPL-2.0 license text.
26216
+
26064
26217
  ---
26065
26218
 
26066
26219
  ##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.copyrightPeriod"></a>
@@ -26074,6 +26227,38 @@ public readonly copyrightPeriod: string;
26074
26227
 
26075
26228
  The copyright years to put in the LICENSE file.
26076
26229
 
26230
+ This value is only used if the selected license text contains the
26231
+ `$copyright_period` placeholder. For example, it has no effect on the
26232
+ MPL-2.0 license text.
26233
+
26234
+ ---
26235
+
26236
+ ##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.dedupeDeps"></a>
26237
+
26238
+ ```typescript
26239
+ public readonly dedupeDeps: boolean;
26240
+ ```
26241
+
26242
+ - *Type:* boolean
26243
+ - *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
26244
+
26245
+ Add a `dedupe` task that deduplicates project dependencies.
26246
+
26247
+ Deduplication prevents multiple versions of the same package from being
26248
+ installed, if a single version can satisfy all requested version ranges.
26249
+ This prevents version proliferation and reduces the size of the dependency
26250
+ tree.
26251
+
26252
+ The behavior depends on the package manager:
26253
+ - npm: runs `npm dedupe` after every mutating install.
26254
+ - pnpm: runs `pnpm dedupe` after every mutating install.
26255
+ - Yarn Berry: runs `yarn dedupe` after every mutating install. If
26256
+ `yarnBerryOptions.dedupePackages` is set, only the listed packages are
26257
+ deduplicated.
26258
+ - Yarn Classic: `yarn install` already deduplicates, so the task only
26259
+ prints an informational message.
26260
+ - Bun: not supported, enabling this option throws an error.
26261
+
26077
26262
  ---
26078
26263
 
26079
26264
  ##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.defaultReleaseBranch"></a>
@@ -27822,6 +28007,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
27822
28007
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
27823
28008
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
27824
28009
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
28010
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
27825
28011
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
27826
28012
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
27827
28013
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
@@ -28526,6 +28712,34 @@ This is required if publishing packages to, or installing scoped packages from A
28526
28712
 
28527
28713
  ---
28528
28714
 
28715
+ ##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.dedupeDeps"></a>
28716
+
28717
+ ```typescript
28718
+ public readonly dedupeDeps: boolean;
28719
+ ```
28720
+
28721
+ - *Type:* boolean
28722
+ - *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
28723
+
28724
+ Add a `dedupe` task that deduplicates project dependencies.
28725
+
28726
+ Deduplication prevents multiple versions of the same package from being
28727
+ installed, if a single version can satisfy all requested version ranges.
28728
+ This prevents version proliferation and reduces the size of the dependency
28729
+ tree.
28730
+
28731
+ The behavior depends on the package manager:
28732
+ - npm: runs `npm dedupe` after every mutating install.
28733
+ - pnpm: runs `pnpm dedupe` after every mutating install.
28734
+ - Yarn Berry: runs `yarn dedupe` after every mutating install. If
28735
+ `yarnBerryOptions.dedupePackages` is set, only the listed packages are
28736
+ deduplicated.
28737
+ - Yarn Classic: `yarn install` already deduplicates, so the task only
28738
+ prints an informational message.
28739
+ - Bun: not supported, enabling this option throws an error.
28740
+
28741
+ ---
28742
+
28529
28743
  ##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.deleteOrphanedLockFiles"></a>
28530
28744
 
28531
28745
  ```typescript
@@ -29515,6 +29729,10 @@ public readonly copyrightOwner: string;
29515
29729
 
29516
29730
  License copyright owner.
29517
29731
 
29732
+ This value is only used if the selected license text contains the
29733
+ `$copyright_owner` placeholder. For example, it has no effect on the
29734
+ MPL-2.0 license text.
29735
+
29518
29736
  ---
29519
29737
 
29520
29738
  ##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.copyrightPeriod"></a>
@@ -29528,6 +29746,10 @@ public readonly copyrightPeriod: string;
29528
29746
 
29529
29747
  The copyright years to put in the LICENSE file.
29530
29748
 
29749
+ This value is only used if the selected license text contains the
29750
+ `$copyright_period` placeholder. For example, it has no effect on the
29751
+ MPL-2.0 license text.
29752
+
29531
29753
  ---
29532
29754
 
29533
29755
  ##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.defaultReleaseBranch"></a>
@@ -30283,6 +30505,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
30283
30505
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
30284
30506
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
30285
30507
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
30508
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
30286
30509
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
30287
30510
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
30288
30511
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
@@ -30987,6 +31210,34 @@ This is required if publishing packages to, or installing scoped packages from A
30987
31210
 
30988
31211
  ---
30989
31212
 
31213
+ ##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.dedupeDeps"></a>
31214
+
31215
+ ```typescript
31216
+ public readonly dedupeDeps: boolean;
31217
+ ```
31218
+
31219
+ - *Type:* boolean
31220
+ - *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
31221
+
31222
+ Add a `dedupe` task that deduplicates project dependencies.
31223
+
31224
+ Deduplication prevents multiple versions of the same package from being
31225
+ installed, if a single version can satisfy all requested version ranges.
31226
+ This prevents version proliferation and reduces the size of the dependency
31227
+ tree.
31228
+
31229
+ The behavior depends on the package manager:
31230
+ - npm: runs `npm dedupe` after every mutating install.
31231
+ - pnpm: runs `pnpm dedupe` after every mutating install.
31232
+ - Yarn Berry: runs `yarn dedupe` after every mutating install. If
31233
+ `yarnBerryOptions.dedupePackages` is set, only the listed packages are
31234
+ deduplicated.
31235
+ - Yarn Classic: `yarn install` already deduplicates, so the task only
31236
+ prints an informational message.
31237
+ - Bun: not supported, enabling this option throws an error.
31238
+
31239
+ ---
31240
+
30990
31241
  ##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.deleteOrphanedLockFiles"></a>
30991
31242
 
30992
31243
  ```typescript
@@ -31976,6 +32227,10 @@ public readonly copyrightOwner: string;
31976
32227
 
31977
32228
  License copyright owner.
31978
32229
 
32230
+ This value is only used if the selected license text contains the
32231
+ `$copyright_owner` placeholder. For example, it has no effect on the
32232
+ MPL-2.0 license text.
32233
+
31979
32234
  ---
31980
32235
 
31981
32236
  ##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.copyrightPeriod"></a>
@@ -31989,6 +32244,10 @@ public readonly copyrightPeriod: string;
31989
32244
 
31990
32245
  The copyright years to put in the LICENSE file.
31991
32246
 
32247
+ This value is only used if the selected license text contains the
32248
+ `$copyright_period` placeholder. For example, it has no effect on the
32249
+ MPL-2.0 license text.
32250
+
31992
32251
  ---
31993
32252
 
31994
32253
  ##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.defaultReleaseBranch"></a>
@@ -33105,6 +33364,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
33105
33364
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.consistentVersions">consistentVersions</a></code> | <code>string[]</code> | Package names that must use a consistent version across all workspaces. |
33106
33365
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
33107
33366
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
33367
+ | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
33108
33368
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
33109
33369
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
33110
33370
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
@@ -33773,6 +34033,10 @@ public readonly copyrightOwner: string;
33773
34033
 
33774
34034
  License copyright owner.
33775
34035
 
34036
+ This value is only used if the selected license text contains the
34037
+ `$copyright_owner` placeholder. For example, it has no effect on the
34038
+ MPL-2.0 license text.
34039
+
33776
34040
  ---
33777
34041
 
33778
34042
  ##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.copyrightPeriod"></a>
@@ -33786,6 +34050,38 @@ public readonly copyrightPeriod: string;
33786
34050
 
33787
34051
  The copyright years to put in the LICENSE file.
33788
34052
 
34053
+ This value is only used if the selected license text contains the
34054
+ `$copyright_period` placeholder. For example, it has no effect on the
34055
+ MPL-2.0 license text.
34056
+
34057
+ ---
34058
+
34059
+ ##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.dedupeDeps"></a>
34060
+
34061
+ ```typescript
34062
+ public readonly dedupeDeps: boolean;
34063
+ ```
34064
+
34065
+ - *Type:* boolean
34066
+ - *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
34067
+
34068
+ Add a `dedupe` task that deduplicates project dependencies.
34069
+
34070
+ Deduplication prevents multiple versions of the same package from being
34071
+ installed, if a single version can satisfy all requested version ranges.
34072
+ This prevents version proliferation and reduces the size of the dependency
34073
+ tree.
34074
+
34075
+ The behavior depends on the package manager:
34076
+ - npm: runs `npm dedupe` after every mutating install.
34077
+ - pnpm: runs `pnpm dedupe` after every mutating install.
34078
+ - Yarn Berry: runs `yarn dedupe` after every mutating install. If
34079
+ `yarnBerryOptions.dedupePackages` is set, only the listed packages are
34080
+ deduplicated.
34081
+ - Yarn Classic: `yarn install` already deduplicates, so the task only
34082
+ prints an informational message.
34083
+ - Bun: not supported, enabling this option throws an error.
34084
+
33789
34085
  ---
33790
34086
 
33791
34087
  ##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.defaultReleaseBranch"></a>
@@ -35938,6 +36234,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
35938
36234
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
35939
36235
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
35940
36236
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
36237
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
35941
36238
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
35942
36239
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
35943
36240
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
@@ -36560,6 +36857,10 @@ public readonly copyrightOwner: string;
36560
36857
 
36561
36858
  License copyright owner.
36562
36859
 
36860
+ This value is only used if the selected license text contains the
36861
+ `$copyright_owner` placeholder. For example, it has no effect on the
36862
+ MPL-2.0 license text.
36863
+
36563
36864
  ---
36564
36865
 
36565
36866
  ##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.copyrightPeriod"></a>
@@ -36573,6 +36874,38 @@ public readonly copyrightPeriod: string;
36573
36874
 
36574
36875
  The copyright years to put in the LICENSE file.
36575
36876
 
36877
+ This value is only used if the selected license text contains the
36878
+ `$copyright_period` placeholder. For example, it has no effect on the
36879
+ MPL-2.0 license text.
36880
+
36881
+ ---
36882
+
36883
+ ##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.dedupeDeps"></a>
36884
+
36885
+ ```typescript
36886
+ public readonly dedupeDeps: boolean;
36887
+ ```
36888
+
36889
+ - *Type:* boolean
36890
+ - *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
36891
+
36892
+ Add a `dedupe` task that deduplicates project dependencies.
36893
+
36894
+ Deduplication prevents multiple versions of the same package from being
36895
+ installed, if a single version can satisfy all requested version ranges.
36896
+ This prevents version proliferation and reduces the size of the dependency
36897
+ tree.
36898
+
36899
+ The behavior depends on the package manager:
36900
+ - npm: runs `npm dedupe` after every mutating install.
36901
+ - pnpm: runs `pnpm dedupe` after every mutating install.
36902
+ - Yarn Berry: runs `yarn dedupe` after every mutating install. If
36903
+ `yarnBerryOptions.dedupePackages` is set, only the listed packages are
36904
+ deduplicated.
36905
+ - Yarn Classic: `yarn install` already deduplicates, so the task only
36906
+ prints an informational message.
36907
+ - Bun: not supported, enabling this option throws an error.
36908
+
36576
36909
  ---
36577
36910
 
36578
36911
  ##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.deleteOrphanedLockFiles"></a>
@@ -277,14 +277,39 @@ export interface CdkConstructLibraryOptions {
277
277
  readonly constructsVersion?: string;
278
278
  /**
279
279
  * License copyright owner.
280
+ * This value is only used if the selected license text contains the
281
+ * `$copyright_owner` placeholder. For example, it has no effect on the
282
+ * MPL-2.0 license text.
280
283
  * @default - defaults to the value of authorName or "" if `authorName` is undefined.
281
284
  */
282
285
  readonly copyrightOwner?: string;
283
286
  /**
284
287
  * The copyright years to put in the LICENSE file.
288
+ * This value is only used if the selected license text contains the
289
+ * `$copyright_period` placeholder. For example, it has no effect on the
290
+ * MPL-2.0 license text.
285
291
  * @default - current year
286
292
  */
287
293
  readonly copyrightPeriod?: string;
294
+ /**
295
+ * Add a `dedupe` task that deduplicates project dependencies.
296
+ * Deduplication prevents multiple versions of the same package from being
297
+ * installed, if a single version can satisfy all requested version ranges.
298
+ * This prevents version proliferation and reduces the size of the dependency
299
+ * tree.
300
+ *
301
+ * The behavior depends on the package manager:
302
+ * - npm: runs `npm dedupe` after every mutating install.
303
+ * - pnpm: runs `pnpm dedupe` after every mutating install.
304
+ * - Yarn Berry: runs `yarn dedupe` after every mutating install. If
305
+ * `yarnBerryOptions.dedupePackages` is set, only the listed packages are
306
+ * deduplicated.
307
+ * - Yarn Classic: `yarn install` already deduplicates, so the task only
308
+ * prints an informational message.
309
+ * - Bun: not supported, enabling this option throws an error.
310
+ * @default - false, unless `yarnBerryOptions.dedupePackages` is set
311
+ */
312
+ readonly dedupeDeps?: boolean;
288
313
  /**
289
314
  * The name of the main release branch.
290
315
  * @default "main"