cdklabs-projen-project-types 0.3.19 → 0.3.20
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 +920 -704
- package/API.md +433 -7
- package/lib/cdk-construct-library-options.d.ts +22 -1
- package/lib/cdk-construct-library-options.js +1 -1
- package/lib/cdk-jsii-options.d.ts +22 -1
- 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/rosetta.js +1 -1
- package/lib/yarn/monorepo-options.d.ts +21 -0
- package/lib/yarn/monorepo-options.js +1 -1
- package/lib/yarn/monorepo-release.js +3 -3
- package/lib/yarn/monorepo.js +11 -6
- package/lib/yarn/typescript-workspace-options.d.ts +22 -1
- 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 +2 -2
package/API.md
CHANGED
|
@@ -15105,6 +15105,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
15105
15105
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | Minimum version of the AWS CDK to depend on. |
|
|
15106
15106
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
15107
15107
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
15108
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.addPackageManagerToDevEngines">addPackageManagerToDevEngines</a></code> | <code>boolean</code> | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. |
|
|
15108
15109
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
15109
15110
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
15110
15111
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
@@ -15150,6 +15151,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
15150
15151
|
| <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. |
|
|
15151
15152
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
15152
15153
|
| <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. |
|
|
15154
|
+
| <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. |
|
|
15153
15155
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
15154
15156
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
|
|
15155
15157
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
@@ -15158,6 +15160,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
15158
15160
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
15159
15161
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.devContainer">devContainer</a></code> | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces). |
|
|
15160
15162
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
|
|
15163
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.devEngines">devEngines</a></code> | <code>projen.javascript.DevEngines</code> | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. |
|
|
15161
15164
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
15162
15165
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
|
|
15163
15166
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
@@ -15365,6 +15368,19 @@ This is the name of your project.
|
|
|
15365
15368
|
|
|
15366
15369
|
---
|
|
15367
15370
|
|
|
15371
|
+
##### `addPackageManagerToDevEngines`<sup>Optional</sup> <a name="addPackageManagerToDevEngines" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.addPackageManagerToDevEngines"></a>
|
|
15372
|
+
|
|
15373
|
+
```typescript
|
|
15374
|
+
public readonly addPackageManagerToDevEngines: boolean;
|
|
15375
|
+
```
|
|
15376
|
+
|
|
15377
|
+
- *Type:* boolean
|
|
15378
|
+
- *Default:* true
|
|
15379
|
+
|
|
15380
|
+
Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`.
|
|
15381
|
+
|
|
15382
|
+
---
|
|
15383
|
+
|
|
15368
15384
|
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.allowLibraryDependencies"></a>
|
|
15369
15385
|
|
|
15370
15386
|
```typescript
|
|
@@ -16015,6 +16031,24 @@ The copyright years to put in the LICENSE file.
|
|
|
16015
16031
|
|
|
16016
16032
|
---
|
|
16017
16033
|
|
|
16034
|
+
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.deleteOrphanedLockFiles"></a>
|
|
16035
|
+
|
|
16036
|
+
```typescript
|
|
16037
|
+
public readonly deleteOrphanedLockFiles: boolean;
|
|
16038
|
+
```
|
|
16039
|
+
|
|
16040
|
+
- *Type:* boolean
|
|
16041
|
+
- *Default:* true
|
|
16042
|
+
|
|
16043
|
+
Automatically delete lockfiles from package managers that are not the active one.
|
|
16044
|
+
|
|
16045
|
+
Only triggered when the lockfile for the configured package
|
|
16046
|
+
manager already exists.
|
|
16047
|
+
|
|
16048
|
+
This is useful when migrating between package managers to avoid conflicts.
|
|
16049
|
+
|
|
16050
|
+
---
|
|
16051
|
+
|
|
16018
16052
|
##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.dependabot"></a>
|
|
16019
16053
|
|
|
16020
16054
|
```typescript
|
|
@@ -16143,6 +16177,18 @@ this will be what you `package.json` will eventually include.
|
|
|
16143
16177
|
|
|
16144
16178
|
---
|
|
16145
16179
|
|
|
16180
|
+
##### `devEngines`<sup>Optional</sup> <a name="devEngines" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.devEngines"></a>
|
|
16181
|
+
|
|
16182
|
+
```typescript
|
|
16183
|
+
public readonly devEngines: DevEngines;
|
|
16184
|
+
```
|
|
16185
|
+
|
|
16186
|
+
- *Type:* projen.javascript.DevEngines
|
|
16187
|
+
|
|
16188
|
+
Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry.
|
|
16189
|
+
|
|
16190
|
+
---
|
|
16191
|
+
|
|
16146
16192
|
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.disableTsconfig"></a>
|
|
16147
16193
|
|
|
16148
16194
|
```typescript
|
|
@@ -16945,7 +16991,7 @@ public readonly packageManager: NodePackageManager;
|
|
|
16945
16991
|
```
|
|
16946
16992
|
|
|
16947
16993
|
- *Type:* projen.javascript.NodePackageManager
|
|
16948
|
-
- *Default:*
|
|
16994
|
+
- *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails.
|
|
16949
16995
|
|
|
16950
16996
|
The Node Package Manager used to execute scripts.
|
|
16951
16997
|
|
|
@@ -18114,6 +18160,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
18114
18160
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.authorAddress">authorAddress</a></code> | <code>string</code> | Email or URL of the library author. |
|
|
18115
18161
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
18116
18162
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
18163
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.addPackageManagerToDevEngines">addPackageManagerToDevEngines</a></code> | <code>boolean</code> | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. |
|
|
18117
18164
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
18118
18165
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
18119
18166
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
@@ -18150,6 +18197,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
18150
18197
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
|
|
18151
18198
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
18152
18199
|
| <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. |
|
|
18200
|
+
| <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. |
|
|
18153
18201
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
18154
18202
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
|
|
18155
18203
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
@@ -18158,6 +18206,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
18158
18206
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
18159
18207
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.devContainer">devContainer</a></code> | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces). |
|
|
18160
18208
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
|
|
18209
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.devEngines">devEngines</a></code> | <code>projen.javascript.DevEngines</code> | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. |
|
|
18161
18210
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
18162
18211
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
|
|
18163
18212
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
@@ -18344,6 +18393,19 @@ This is the name of your project.
|
|
|
18344
18393
|
|
|
18345
18394
|
---
|
|
18346
18395
|
|
|
18396
|
+
##### `addPackageManagerToDevEngines`<sup>Optional</sup> <a name="addPackageManagerToDevEngines" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.addPackageManagerToDevEngines"></a>
|
|
18397
|
+
|
|
18398
|
+
```typescript
|
|
18399
|
+
public readonly addPackageManagerToDevEngines: boolean;
|
|
18400
|
+
```
|
|
18401
|
+
|
|
18402
|
+
- *Type:* boolean
|
|
18403
|
+
- *Default:* true
|
|
18404
|
+
|
|
18405
|
+
Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`.
|
|
18406
|
+
|
|
18407
|
+
---
|
|
18408
|
+
|
|
18347
18409
|
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.allowLibraryDependencies"></a>
|
|
18348
18410
|
|
|
18349
18411
|
```typescript
|
|
@@ -18843,6 +18905,24 @@ The copyright years to put in the LICENSE file.
|
|
|
18843
18905
|
|
|
18844
18906
|
---
|
|
18845
18907
|
|
|
18908
|
+
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.deleteOrphanedLockFiles"></a>
|
|
18909
|
+
|
|
18910
|
+
```typescript
|
|
18911
|
+
public readonly deleteOrphanedLockFiles: boolean;
|
|
18912
|
+
```
|
|
18913
|
+
|
|
18914
|
+
- *Type:* boolean
|
|
18915
|
+
- *Default:* true
|
|
18916
|
+
|
|
18917
|
+
Automatically delete lockfiles from package managers that are not the active one.
|
|
18918
|
+
|
|
18919
|
+
Only triggered when the lockfile for the configured package
|
|
18920
|
+
manager already exists.
|
|
18921
|
+
|
|
18922
|
+
This is useful when migrating between package managers to avoid conflicts.
|
|
18923
|
+
|
|
18924
|
+
---
|
|
18925
|
+
|
|
18846
18926
|
##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.dependabot"></a>
|
|
18847
18927
|
|
|
18848
18928
|
```typescript
|
|
@@ -18971,6 +19051,18 @@ this will be what you `package.json` will eventually include.
|
|
|
18971
19051
|
|
|
18972
19052
|
---
|
|
18973
19053
|
|
|
19054
|
+
##### `devEngines`<sup>Optional</sup> <a name="devEngines" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.devEngines"></a>
|
|
19055
|
+
|
|
19056
|
+
```typescript
|
|
19057
|
+
public readonly devEngines: DevEngines;
|
|
19058
|
+
```
|
|
19059
|
+
|
|
19060
|
+
- *Type:* projen.javascript.DevEngines
|
|
19061
|
+
|
|
19062
|
+
Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry.
|
|
19063
|
+
|
|
19064
|
+
---
|
|
19065
|
+
|
|
18974
19066
|
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.disableTsconfig"></a>
|
|
18975
19067
|
|
|
18976
19068
|
```typescript
|
|
@@ -19703,7 +19795,7 @@ public readonly packageManager: NodePackageManager;
|
|
|
19703
19795
|
```
|
|
19704
19796
|
|
|
19705
19797
|
- *Type:* projen.javascript.NodePackageManager
|
|
19706
|
-
- *Default:*
|
|
19798
|
+
- *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails.
|
|
19707
19799
|
|
|
19708
19800
|
The Node Package Manager used to execute scripts.
|
|
19709
19801
|
|
|
@@ -20848,6 +20940,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
20848
20940
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | Minimum version of the AWS CDK to depend on. |
|
|
20849
20941
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
20850
20942
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
20943
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.addPackageManagerToDevEngines">addPackageManagerToDevEngines</a></code> | <code>boolean</code> | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. |
|
|
20851
20944
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
20852
20945
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
20853
20946
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
@@ -20893,6 +20986,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
20893
20986
|
| <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. |
|
|
20894
20987
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
20895
20988
|
| <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. |
|
|
20989
|
+
| <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. |
|
|
20896
20990
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
20897
20991
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
|
|
20898
20992
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
@@ -20901,6 +20995,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
20901
20995
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
20902
20996
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.devContainer">devContainer</a></code> | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces). |
|
|
20903
20997
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
|
|
20998
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.devEngines">devEngines</a></code> | <code>projen.javascript.DevEngines</code> | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. |
|
|
20904
20999
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
20905
21000
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
|
|
20906
21001
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
@@ -21110,6 +21205,19 @@ This is the name of your project.
|
|
|
21110
21205
|
|
|
21111
21206
|
---
|
|
21112
21207
|
|
|
21208
|
+
##### `addPackageManagerToDevEngines`<sup>Optional</sup> <a name="addPackageManagerToDevEngines" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.addPackageManagerToDevEngines"></a>
|
|
21209
|
+
|
|
21210
|
+
```typescript
|
|
21211
|
+
public readonly addPackageManagerToDevEngines: boolean;
|
|
21212
|
+
```
|
|
21213
|
+
|
|
21214
|
+
- *Type:* boolean
|
|
21215
|
+
- *Default:* true
|
|
21216
|
+
|
|
21217
|
+
Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`.
|
|
21218
|
+
|
|
21219
|
+
---
|
|
21220
|
+
|
|
21113
21221
|
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.allowLibraryDependencies"></a>
|
|
21114
21222
|
|
|
21115
21223
|
```typescript
|
|
@@ -21760,6 +21868,24 @@ The copyright years to put in the LICENSE file.
|
|
|
21760
21868
|
|
|
21761
21869
|
---
|
|
21762
21870
|
|
|
21871
|
+
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.deleteOrphanedLockFiles"></a>
|
|
21872
|
+
|
|
21873
|
+
```typescript
|
|
21874
|
+
public readonly deleteOrphanedLockFiles: boolean;
|
|
21875
|
+
```
|
|
21876
|
+
|
|
21877
|
+
- *Type:* boolean
|
|
21878
|
+
- *Default:* true
|
|
21879
|
+
|
|
21880
|
+
Automatically delete lockfiles from package managers that are not the active one.
|
|
21881
|
+
|
|
21882
|
+
Only triggered when the lockfile for the configured package
|
|
21883
|
+
manager already exists.
|
|
21884
|
+
|
|
21885
|
+
This is useful when migrating between package managers to avoid conflicts.
|
|
21886
|
+
|
|
21887
|
+
---
|
|
21888
|
+
|
|
21763
21889
|
##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.dependabot"></a>
|
|
21764
21890
|
|
|
21765
21891
|
```typescript
|
|
@@ -21888,6 +22014,18 @@ this will be what you `package.json` will eventually include.
|
|
|
21888
22014
|
|
|
21889
22015
|
---
|
|
21890
22016
|
|
|
22017
|
+
##### `devEngines`<sup>Optional</sup> <a name="devEngines" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.devEngines"></a>
|
|
22018
|
+
|
|
22019
|
+
```typescript
|
|
22020
|
+
public readonly devEngines: DevEngines;
|
|
22021
|
+
```
|
|
22022
|
+
|
|
22023
|
+
- *Type:* projen.javascript.DevEngines
|
|
22024
|
+
|
|
22025
|
+
Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry.
|
|
22026
|
+
|
|
22027
|
+
---
|
|
22028
|
+
|
|
21891
22029
|
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.disableTsconfig"></a>
|
|
21892
22030
|
|
|
21893
22031
|
```typescript
|
|
@@ -22690,7 +22828,7 @@ public readonly packageManager: NodePackageManager;
|
|
|
22690
22828
|
```
|
|
22691
22829
|
|
|
22692
22830
|
- *Type:* projen.javascript.NodePackageManager
|
|
22693
|
-
- *Default:*
|
|
22831
|
+
- *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails.
|
|
22694
22832
|
|
|
22695
22833
|
The Node Package Manager used to execute scripts.
|
|
22696
22834
|
|
|
@@ -23896,6 +24034,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
23896
24034
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.authorAddress">authorAddress</a></code> | <code>string</code> | Email or URL of the library author. |
|
|
23897
24035
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
23898
24036
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
24037
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.addPackageManagerToDevEngines">addPackageManagerToDevEngines</a></code> | <code>boolean</code> | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. |
|
|
23899
24038
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
23900
24039
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
23901
24040
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
@@ -23932,6 +24071,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
23932
24071
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
|
|
23933
24072
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
23934
24073
|
| <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. |
|
|
24074
|
+
| <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. |
|
|
23935
24075
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
23936
24076
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
|
|
23937
24077
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
@@ -23940,6 +24080,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
23940
24080
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
23941
24081
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.devContainer">devContainer</a></code> | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces). |
|
|
23942
24082
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
|
|
24083
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.devEngines">devEngines</a></code> | <code>projen.javascript.DevEngines</code> | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. |
|
|
23943
24084
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
23944
24085
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
|
|
23945
24086
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
@@ -24128,6 +24269,19 @@ This is the name of your project.
|
|
|
24128
24269
|
|
|
24129
24270
|
---
|
|
24130
24271
|
|
|
24272
|
+
##### `addPackageManagerToDevEngines`<sup>Optional</sup> <a name="addPackageManagerToDevEngines" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.addPackageManagerToDevEngines"></a>
|
|
24273
|
+
|
|
24274
|
+
```typescript
|
|
24275
|
+
public readonly addPackageManagerToDevEngines: boolean;
|
|
24276
|
+
```
|
|
24277
|
+
|
|
24278
|
+
- *Type:* boolean
|
|
24279
|
+
- *Default:* true
|
|
24280
|
+
|
|
24281
|
+
Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`.
|
|
24282
|
+
|
|
24283
|
+
---
|
|
24284
|
+
|
|
24131
24285
|
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.allowLibraryDependencies"></a>
|
|
24132
24286
|
|
|
24133
24287
|
```typescript
|
|
@@ -24627,6 +24781,24 @@ The copyright years to put in the LICENSE file.
|
|
|
24627
24781
|
|
|
24628
24782
|
---
|
|
24629
24783
|
|
|
24784
|
+
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.deleteOrphanedLockFiles"></a>
|
|
24785
|
+
|
|
24786
|
+
```typescript
|
|
24787
|
+
public readonly deleteOrphanedLockFiles: boolean;
|
|
24788
|
+
```
|
|
24789
|
+
|
|
24790
|
+
- *Type:* boolean
|
|
24791
|
+
- *Default:* true
|
|
24792
|
+
|
|
24793
|
+
Automatically delete lockfiles from package managers that are not the active one.
|
|
24794
|
+
|
|
24795
|
+
Only triggered when the lockfile for the configured package
|
|
24796
|
+
manager already exists.
|
|
24797
|
+
|
|
24798
|
+
This is useful when migrating between package managers to avoid conflicts.
|
|
24799
|
+
|
|
24800
|
+
---
|
|
24801
|
+
|
|
24630
24802
|
##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.dependabot"></a>
|
|
24631
24803
|
|
|
24632
24804
|
```typescript
|
|
@@ -24755,6 +24927,18 @@ this will be what you `package.json` will eventually include.
|
|
|
24755
24927
|
|
|
24756
24928
|
---
|
|
24757
24929
|
|
|
24930
|
+
##### `devEngines`<sup>Optional</sup> <a name="devEngines" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.devEngines"></a>
|
|
24931
|
+
|
|
24932
|
+
```typescript
|
|
24933
|
+
public readonly devEngines: DevEngines;
|
|
24934
|
+
```
|
|
24935
|
+
|
|
24936
|
+
- *Type:* projen.javascript.DevEngines
|
|
24937
|
+
|
|
24938
|
+
Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry.
|
|
24939
|
+
|
|
24940
|
+
---
|
|
24941
|
+
|
|
24758
24942
|
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.disableTsconfig"></a>
|
|
24759
24943
|
|
|
24760
24944
|
```typescript
|
|
@@ -25487,7 +25671,7 @@ public readonly packageManager: NodePackageManager;
|
|
|
25487
25671
|
```
|
|
25488
25672
|
|
|
25489
25673
|
- *Type:* projen.javascript.NodePackageManager
|
|
25490
|
-
- *Default:*
|
|
25674
|
+
- *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails.
|
|
25491
25675
|
|
|
25492
25676
|
The Node Package Manager used to execute scripts.
|
|
25493
25677
|
|
|
@@ -26670,6 +26854,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
26670
26854
|
| --- | --- | --- |
|
|
26671
26855
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
26672
26856
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
26857
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.addPackageManagerToDevEngines">addPackageManagerToDevEngines</a></code> | <code>boolean</code> | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. |
|
|
26673
26858
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
26674
26859
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
26675
26860
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
@@ -26705,6 +26890,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
26705
26890
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
26706
26891
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
26707
26892
|
| <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. |
|
|
26893
|
+
| <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. |
|
|
26708
26894
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
26709
26895
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
|
|
26710
26896
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
@@ -26713,6 +26899,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
26713
26899
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
26714
26900
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.devContainer">devContainer</a></code> | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces). |
|
|
26715
26901
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
|
|
26902
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.devEngines">devEngines</a></code> | <code>projen.javascript.DevEngines</code> | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. |
|
|
26716
26903
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
26717
26904
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
|
|
26718
26905
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
@@ -26855,6 +27042,19 @@ This is the name of your project.
|
|
|
26855
27042
|
|
|
26856
27043
|
---
|
|
26857
27044
|
|
|
27045
|
+
##### `addPackageManagerToDevEngines`<sup>Optional</sup> <a name="addPackageManagerToDevEngines" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.addPackageManagerToDevEngines"></a>
|
|
27046
|
+
|
|
27047
|
+
```typescript
|
|
27048
|
+
public readonly addPackageManagerToDevEngines: boolean;
|
|
27049
|
+
```
|
|
27050
|
+
|
|
27051
|
+
- *Type:* boolean
|
|
27052
|
+
- *Default:* true
|
|
27053
|
+
|
|
27054
|
+
Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`.
|
|
27055
|
+
|
|
27056
|
+
---
|
|
27057
|
+
|
|
26858
27058
|
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.allowLibraryDependencies"></a>
|
|
26859
27059
|
|
|
26860
27060
|
```typescript
|
|
@@ -27342,6 +27542,24 @@ The copyright years to put in the LICENSE file.
|
|
|
27342
27542
|
|
|
27343
27543
|
---
|
|
27344
27544
|
|
|
27545
|
+
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.deleteOrphanedLockFiles"></a>
|
|
27546
|
+
|
|
27547
|
+
```typescript
|
|
27548
|
+
public readonly deleteOrphanedLockFiles: boolean;
|
|
27549
|
+
```
|
|
27550
|
+
|
|
27551
|
+
- *Type:* boolean
|
|
27552
|
+
- *Default:* true
|
|
27553
|
+
|
|
27554
|
+
Automatically delete lockfiles from package managers that are not the active one.
|
|
27555
|
+
|
|
27556
|
+
Only triggered when the lockfile for the configured package
|
|
27557
|
+
manager already exists.
|
|
27558
|
+
|
|
27559
|
+
This is useful when migrating between package managers to avoid conflicts.
|
|
27560
|
+
|
|
27561
|
+
---
|
|
27562
|
+
|
|
27345
27563
|
##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.dependabot"></a>
|
|
27346
27564
|
|
|
27347
27565
|
```typescript
|
|
@@ -27470,6 +27688,18 @@ this will be what you `package.json` will eventually include.
|
|
|
27470
27688
|
|
|
27471
27689
|
---
|
|
27472
27690
|
|
|
27691
|
+
##### `devEngines`<sup>Optional</sup> <a name="devEngines" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.devEngines"></a>
|
|
27692
|
+
|
|
27693
|
+
```typescript
|
|
27694
|
+
public readonly devEngines: DevEngines;
|
|
27695
|
+
```
|
|
27696
|
+
|
|
27697
|
+
- *Type:* projen.javascript.DevEngines
|
|
27698
|
+
|
|
27699
|
+
Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry.
|
|
27700
|
+
|
|
27701
|
+
---
|
|
27702
|
+
|
|
27473
27703
|
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.disableTsconfig"></a>
|
|
27474
27704
|
|
|
27475
27705
|
```typescript
|
|
@@ -29180,6 +29410,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
29180
29410
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
|
|
29181
29411
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.staleOptions">staleOptions</a></code> | <code>projen.github.StaleOptions</code> | Auto-close stale issues and pull requests. |
|
|
29182
29412
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
|
|
29413
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.addPackageManagerToDevEngines">addPackageManagerToDevEngines</a></code> | <code>boolean</code> | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. |
|
|
29183
29414
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
29184
29415
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
|
|
29185
29416
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
|
|
@@ -29192,9 +29423,11 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
29192
29423
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
29193
29424
|
| <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. |
|
|
29194
29425
|
| <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. |
|
|
29426
|
+
| <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. |
|
|
29195
29427
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
29196
29428
|
| <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. |
|
|
29197
29429
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
|
|
29430
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.devEngines">devEngines</a></code> | <code>projen.javascript.DevEngines</code> | Configure the `devEngines` field in `package.json`. |
|
|
29198
29431
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.entrypoint">entrypoint</a></code> | <code>string</code> | Module entrypoint (`main` in `package.json`). |
|
|
29199
29432
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.homepage">homepage</a></code> | <code>string</code> | Package's Homepage / Website. |
|
|
29200
29433
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.keywords">keywords</a></code> | <code>string[]</code> | Keywords to include in `package.json`. |
|
|
@@ -29743,6 +29976,19 @@ Enabled by default for root projects. Disabled for non-root projects.
|
|
|
29743
29976
|
|
|
29744
29977
|
---
|
|
29745
29978
|
|
|
29979
|
+
##### `addPackageManagerToDevEngines`<sup>Optional</sup> <a name="addPackageManagerToDevEngines" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.addPackageManagerToDevEngines"></a>
|
|
29980
|
+
|
|
29981
|
+
```typescript
|
|
29982
|
+
public readonly addPackageManagerToDevEngines: boolean;
|
|
29983
|
+
```
|
|
29984
|
+
|
|
29985
|
+
- *Type:* boolean
|
|
29986
|
+
- *Default:* true
|
|
29987
|
+
|
|
29988
|
+
Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`.
|
|
29989
|
+
|
|
29990
|
+
---
|
|
29991
|
+
|
|
29746
29992
|
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.allowLibraryDependencies"></a>
|
|
29747
29993
|
|
|
29748
29994
|
```typescript
|
|
@@ -29911,6 +30157,24 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
29911
30157
|
|
|
29912
30158
|
---
|
|
29913
30159
|
|
|
30160
|
+
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.deleteOrphanedLockFiles"></a>
|
|
30161
|
+
|
|
30162
|
+
```typescript
|
|
30163
|
+
public readonly deleteOrphanedLockFiles: boolean;
|
|
30164
|
+
```
|
|
30165
|
+
|
|
30166
|
+
- *Type:* boolean
|
|
30167
|
+
- *Default:* true
|
|
30168
|
+
|
|
30169
|
+
Automatically delete lockfiles from package managers that are not the active one.
|
|
30170
|
+
|
|
30171
|
+
Only triggered when the lockfile for the configured package
|
|
30172
|
+
manager already exists.
|
|
30173
|
+
|
|
30174
|
+
This is useful when migrating between package managers to avoid conflicts.
|
|
30175
|
+
|
|
30176
|
+
---
|
|
30177
|
+
|
|
29914
30178
|
##### `deps`<sup>Optional</sup> <a name="deps" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.deps"></a>
|
|
29915
30179
|
|
|
29916
30180
|
```typescript
|
|
@@ -29984,6 +30248,24 @@ this will be what you `package.json` will eventually include.
|
|
|
29984
30248
|
```
|
|
29985
30249
|
|
|
29986
30250
|
|
|
30251
|
+
##### `devEngines`<sup>Optional</sup> <a name="devEngines" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.devEngines"></a>
|
|
30252
|
+
|
|
30253
|
+
```typescript
|
|
30254
|
+
public readonly devEngines: DevEngines;
|
|
30255
|
+
```
|
|
30256
|
+
|
|
30257
|
+
- *Type:* projen.javascript.DevEngines
|
|
30258
|
+
|
|
30259
|
+
Configure the `devEngines` field in `package.json`.
|
|
30260
|
+
|
|
30261
|
+
The `devEngines.packageManager` field is automatically populated based on
|
|
30262
|
+
the resolved `packageManager` value. Any fields provided here are merged
|
|
30263
|
+
with the auto-populated `packageManager` entry.
|
|
30264
|
+
|
|
30265
|
+
> [https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines)
|
|
30266
|
+
|
|
30267
|
+
---
|
|
30268
|
+
|
|
29987
30269
|
##### `entrypoint`<sup>Optional</sup> <a name="entrypoint" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.entrypoint"></a>
|
|
29988
30270
|
|
|
29989
30271
|
```typescript
|
|
@@ -30192,7 +30474,7 @@ public readonly packageManager: NodePackageManager;
|
|
|
30192
30474
|
```
|
|
30193
30475
|
|
|
30194
30476
|
- *Type:* projen.javascript.NodePackageManager
|
|
30195
|
-
- *Default:*
|
|
30477
|
+
- *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails.
|
|
30196
30478
|
|
|
30197
30479
|
The Node Package Manager used to execute scripts.
|
|
30198
30480
|
|
|
@@ -31706,6 +31988,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
31706
31988
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
|
|
31707
31989
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.staleOptions">staleOptions</a></code> | <code>projen.github.StaleOptions</code> | Auto-close stale issues and pull requests. |
|
|
31708
31990
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
|
|
31991
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.addPackageManagerToDevEngines">addPackageManagerToDevEngines</a></code> | <code>boolean</code> | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. |
|
|
31709
31992
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
31710
31993
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
|
|
31711
31994
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
|
|
@@ -31718,9 +32001,11 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
31718
32001
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
31719
32002
|
| <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. |
|
|
31720
32003
|
| <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. |
|
|
32004
|
+
| <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. |
|
|
31721
32005
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
31722
32006
|
| <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. |
|
|
31723
32007
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
|
|
32008
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.devEngines">devEngines</a></code> | <code>projen.javascript.DevEngines</code> | Configure the `devEngines` field in `package.json`. |
|
|
31724
32009
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.entrypoint">entrypoint</a></code> | <code>string</code> | Module entrypoint (`main` in `package.json`). |
|
|
31725
32010
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.homepage">homepage</a></code> | <code>string</code> | Package's Homepage / Website. |
|
|
31726
32011
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.keywords">keywords</a></code> | <code>string[]</code> | Keywords to include in `package.json`. |
|
|
@@ -32269,6 +32554,19 @@ Enabled by default for root projects. Disabled for non-root projects.
|
|
|
32269
32554
|
|
|
32270
32555
|
---
|
|
32271
32556
|
|
|
32557
|
+
##### `addPackageManagerToDevEngines`<sup>Optional</sup> <a name="addPackageManagerToDevEngines" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.addPackageManagerToDevEngines"></a>
|
|
32558
|
+
|
|
32559
|
+
```typescript
|
|
32560
|
+
public readonly addPackageManagerToDevEngines: boolean;
|
|
32561
|
+
```
|
|
32562
|
+
|
|
32563
|
+
- *Type:* boolean
|
|
32564
|
+
- *Default:* true
|
|
32565
|
+
|
|
32566
|
+
Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`.
|
|
32567
|
+
|
|
32568
|
+
---
|
|
32569
|
+
|
|
32272
32570
|
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.allowLibraryDependencies"></a>
|
|
32273
32571
|
|
|
32274
32572
|
```typescript
|
|
@@ -32437,6 +32735,24 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
32437
32735
|
|
|
32438
32736
|
---
|
|
32439
32737
|
|
|
32738
|
+
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.deleteOrphanedLockFiles"></a>
|
|
32739
|
+
|
|
32740
|
+
```typescript
|
|
32741
|
+
public readonly deleteOrphanedLockFiles: boolean;
|
|
32742
|
+
```
|
|
32743
|
+
|
|
32744
|
+
- *Type:* boolean
|
|
32745
|
+
- *Default:* true
|
|
32746
|
+
|
|
32747
|
+
Automatically delete lockfiles from package managers that are not the active one.
|
|
32748
|
+
|
|
32749
|
+
Only triggered when the lockfile for the configured package
|
|
32750
|
+
manager already exists.
|
|
32751
|
+
|
|
32752
|
+
This is useful when migrating between package managers to avoid conflicts.
|
|
32753
|
+
|
|
32754
|
+
---
|
|
32755
|
+
|
|
32440
32756
|
##### `deps`<sup>Optional</sup> <a name="deps" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.deps"></a>
|
|
32441
32757
|
|
|
32442
32758
|
```typescript
|
|
@@ -32510,6 +32826,24 @@ this will be what you `package.json` will eventually include.
|
|
|
32510
32826
|
```
|
|
32511
32827
|
|
|
32512
32828
|
|
|
32829
|
+
##### `devEngines`<sup>Optional</sup> <a name="devEngines" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.devEngines"></a>
|
|
32830
|
+
|
|
32831
|
+
```typescript
|
|
32832
|
+
public readonly devEngines: DevEngines;
|
|
32833
|
+
```
|
|
32834
|
+
|
|
32835
|
+
- *Type:* projen.javascript.DevEngines
|
|
32836
|
+
|
|
32837
|
+
Configure the `devEngines` field in `package.json`.
|
|
32838
|
+
|
|
32839
|
+
The `devEngines.packageManager` field is automatically populated based on
|
|
32840
|
+
the resolved `packageManager` value. Any fields provided here are merged
|
|
32841
|
+
with the auto-populated `packageManager` entry.
|
|
32842
|
+
|
|
32843
|
+
> [https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines)
|
|
32844
|
+
|
|
32845
|
+
---
|
|
32846
|
+
|
|
32513
32847
|
##### `entrypoint`<sup>Optional</sup> <a name="entrypoint" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.entrypoint"></a>
|
|
32514
32848
|
|
|
32515
32849
|
```typescript
|
|
@@ -32718,7 +33052,7 @@ public readonly packageManager: NodePackageManager;
|
|
|
32718
33052
|
```
|
|
32719
33053
|
|
|
32720
33054
|
- *Type:* projen.javascript.NodePackageManager
|
|
32721
|
-
- *Default:*
|
|
33055
|
+
- *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails.
|
|
32722
33056
|
|
|
32723
33057
|
The Node Package Manager used to execute scripts.
|
|
32724
33058
|
|
|
@@ -34206,6 +34540,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
34206
34540
|
| --- | --- | --- |
|
|
34207
34541
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
34208
34542
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
34543
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.addPackageManagerToDevEngines">addPackageManagerToDevEngines</a></code> | <code>boolean</code> | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. |
|
|
34209
34544
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
34210
34545
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
34211
34546
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
@@ -34241,6 +34576,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
34241
34576
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
34242
34577
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
34243
34578
|
| <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. |
|
|
34579
|
+
| <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. |
|
|
34244
34580
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
34245
34581
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
|
|
34246
34582
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
@@ -34249,6 +34585,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
34249
34585
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
34250
34586
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.devContainer">devContainer</a></code> | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces). |
|
|
34251
34587
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
|
|
34588
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.devEngines">devEngines</a></code> | <code>projen.javascript.DevEngines</code> | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. |
|
|
34252
34589
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
34253
34590
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
|
|
34254
34591
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
@@ -34391,6 +34728,19 @@ This is the name of your project.
|
|
|
34391
34728
|
|
|
34392
34729
|
---
|
|
34393
34730
|
|
|
34731
|
+
##### `addPackageManagerToDevEngines`<sup>Optional</sup> <a name="addPackageManagerToDevEngines" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.addPackageManagerToDevEngines"></a>
|
|
34732
|
+
|
|
34733
|
+
```typescript
|
|
34734
|
+
public readonly addPackageManagerToDevEngines: boolean;
|
|
34735
|
+
```
|
|
34736
|
+
|
|
34737
|
+
- *Type:* boolean
|
|
34738
|
+
- *Default:* true
|
|
34739
|
+
|
|
34740
|
+
Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`.
|
|
34741
|
+
|
|
34742
|
+
---
|
|
34743
|
+
|
|
34394
34744
|
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.allowLibraryDependencies"></a>
|
|
34395
34745
|
|
|
34396
34746
|
```typescript
|
|
@@ -34878,6 +35228,24 @@ The copyright years to put in the LICENSE file.
|
|
|
34878
35228
|
|
|
34879
35229
|
---
|
|
34880
35230
|
|
|
35231
|
+
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.deleteOrphanedLockFiles"></a>
|
|
35232
|
+
|
|
35233
|
+
```typescript
|
|
35234
|
+
public readonly deleteOrphanedLockFiles: boolean;
|
|
35235
|
+
```
|
|
35236
|
+
|
|
35237
|
+
- *Type:* boolean
|
|
35238
|
+
- *Default:* true
|
|
35239
|
+
|
|
35240
|
+
Automatically delete lockfiles from package managers that are not the active one.
|
|
35241
|
+
|
|
35242
|
+
Only triggered when the lockfile for the configured package
|
|
35243
|
+
manager already exists.
|
|
35244
|
+
|
|
35245
|
+
This is useful when migrating between package managers to avoid conflicts.
|
|
35246
|
+
|
|
35247
|
+
---
|
|
35248
|
+
|
|
34881
35249
|
##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.dependabot"></a>
|
|
34882
35250
|
|
|
34883
35251
|
```typescript
|
|
@@ -35006,6 +35374,18 @@ this will be what you `package.json` will eventually include.
|
|
|
35006
35374
|
|
|
35007
35375
|
---
|
|
35008
35376
|
|
|
35377
|
+
##### `devEngines`<sup>Optional</sup> <a name="devEngines" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.devEngines"></a>
|
|
35378
|
+
|
|
35379
|
+
```typescript
|
|
35380
|
+
public readonly devEngines: DevEngines;
|
|
35381
|
+
```
|
|
35382
|
+
|
|
35383
|
+
- *Type:* projen.javascript.DevEngines
|
|
35384
|
+
|
|
35385
|
+
Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry.
|
|
35386
|
+
|
|
35387
|
+
---
|
|
35388
|
+
|
|
35009
35389
|
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.disableTsconfig"></a>
|
|
35010
35390
|
|
|
35011
35391
|
```typescript
|
|
@@ -37096,6 +37476,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
|
|
|
37096
37476
|
| --- | --- | --- |
|
|
37097
37477
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
37098
37478
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.parent">parent</a></code> | <code>cdklabs-projen-project-types.yarn.Monorepo</code> | The parent `yarn.Monorepo` project. |
|
|
37479
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.addPackageManagerToDevEngines">addPackageManagerToDevEngines</a></code> | <code>boolean</code> | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. |
|
|
37099
37480
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
37100
37481
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.allowPrivateDeps">allowPrivateDeps</a></code> | <code>boolean</code> | Allow private workspace dependencies in the 'deps' parameter. |
|
|
37101
37482
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
@@ -37129,6 +37510,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
|
|
|
37129
37510
|
| <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. |
|
|
37130
37511
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
37131
37512
|
| <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. |
|
|
37513
|
+
| <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. |
|
|
37132
37514
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
37133
37515
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
|
|
37134
37516
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.deps">deps</a></code> | <code>string \| cdklabs-projen-project-types.yarn.IWorkspaceReference[]</code> | Runtime dependencies of this module. |
|
|
@@ -37136,6 +37518,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
|
|
|
37136
37518
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
37137
37519
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.devContainer">devContainer</a></code> | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces). |
|
|
37138
37520
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.devDeps">devDeps</a></code> | <code>string \| cdklabs-projen-project-types.yarn.IWorkspaceReference[]</code> | Build dependencies for this module. |
|
|
37521
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.devEngines">devEngines</a></code> | <code>projen.javascript.DevEngines</code> | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. |
|
|
37139
37522
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
37140
37523
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
|
|
37141
37524
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
@@ -37277,6 +37660,19 @@ The parent `yarn.Monorepo` project.
|
|
|
37277
37660
|
|
|
37278
37661
|
---
|
|
37279
37662
|
|
|
37663
|
+
##### `addPackageManagerToDevEngines`<sup>Optional</sup> <a name="addPackageManagerToDevEngines" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.addPackageManagerToDevEngines"></a>
|
|
37664
|
+
|
|
37665
|
+
```typescript
|
|
37666
|
+
public readonly addPackageManagerToDevEngines: boolean;
|
|
37667
|
+
```
|
|
37668
|
+
|
|
37669
|
+
- *Type:* boolean
|
|
37670
|
+
- *Default:* true
|
|
37671
|
+
|
|
37672
|
+
Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`.
|
|
37673
|
+
|
|
37674
|
+
---
|
|
37675
|
+
|
|
37280
37676
|
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.allowLibraryDependencies"></a>
|
|
37281
37677
|
|
|
37282
37678
|
```typescript
|
|
@@ -37737,6 +38133,24 @@ The copyright years to put in the LICENSE file.
|
|
|
37737
38133
|
|
|
37738
38134
|
---
|
|
37739
38135
|
|
|
38136
|
+
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.deleteOrphanedLockFiles"></a>
|
|
38137
|
+
|
|
38138
|
+
```typescript
|
|
38139
|
+
public readonly deleteOrphanedLockFiles: boolean;
|
|
38140
|
+
```
|
|
38141
|
+
|
|
38142
|
+
- *Type:* boolean
|
|
38143
|
+
- *Default:* true
|
|
38144
|
+
|
|
38145
|
+
Automatically delete lockfiles from package managers that are not the active one.
|
|
38146
|
+
|
|
38147
|
+
Only triggered when the lockfile for the configured package
|
|
38148
|
+
manager already exists.
|
|
38149
|
+
|
|
38150
|
+
This is useful when migrating between package managers to avoid conflicts.
|
|
38151
|
+
|
|
38152
|
+
---
|
|
38153
|
+
|
|
37740
38154
|
##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.dependabot"></a>
|
|
37741
38155
|
|
|
37742
38156
|
```typescript
|
|
@@ -37852,6 +38266,18 @@ this will be what you `package.json` will eventually include.
|
|
|
37852
38266
|
|
|
37853
38267
|
---
|
|
37854
38268
|
|
|
38269
|
+
##### `devEngines`<sup>Optional</sup> <a name="devEngines" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.devEngines"></a>
|
|
38270
|
+
|
|
38271
|
+
```typescript
|
|
38272
|
+
public readonly devEngines: DevEngines;
|
|
38273
|
+
```
|
|
38274
|
+
|
|
38275
|
+
- *Type:* projen.javascript.DevEngines
|
|
38276
|
+
|
|
38277
|
+
Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry.
|
|
38278
|
+
|
|
38279
|
+
---
|
|
38280
|
+
|
|
37855
38281
|
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.disableTsconfig"></a>
|
|
37856
38282
|
|
|
37857
38283
|
```typescript
|
|
@@ -38493,7 +38919,7 @@ public readonly packageManager: NodePackageManager;
|
|
|
38493
38919
|
```
|
|
38494
38920
|
|
|
38495
38921
|
- *Type:* projen.javascript.NodePackageManager
|
|
38496
|
-
- *Default:*
|
|
38922
|
+
- *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails.
|
|
38497
38923
|
|
|
38498
38924
|
The Node Package Manager used to execute scripts.
|
|
38499
38925
|
|