cdklabs-projen-project-types 0.3.11 → 0.3.13
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 +830 -681
- package/API.md +315 -27
- package/lib/cdk-construct-library-options.d.ts +16 -3
- package/lib/cdk-construct-library-options.js +1 -1
- package/lib/cdk-jsii-options.d.ts +16 -3
- package/lib/cdk-jsii-options.js +1 -1
- package/lib/cdk.js +2 -2
- package/lib/cdklabs.js +3 -3
- package/lib/common-options.js +2 -2
- package/lib/jsii.js +1 -1
- package/lib/rosetta.js +1 -1
- package/lib/upgrade-cdklabs-projen-project-types.d.ts +1 -1
- package/lib/upgrade-cdklabs-projen-project-types.js +4 -2
- package/lib/yarn/monorepo-options.d.ts +16 -3
- package/lib/yarn/monorepo-options.js +1 -1
- package/lib/yarn/monorepo-release.js +1 -1
- package/lib/yarn/monorepo.js +2 -2
- package/lib/yarn/typescript-workspace-options.d.ts +16 -3
- package/lib/yarn/typescript-workspace-options.js +1 -1
- package/lib/yarn/typescript-workspace-release.js +1 -1
- package/lib/yarn/typescript-workspace.js +18 -13
- package/package.json +6 -6
package/API.md
CHANGED
|
@@ -14843,12 +14843,14 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
14843
14843
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
14844
14844
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
14845
14845
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
14846
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
14847
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
14846
14848
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
|
|
14847
14849
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
|
|
14848
14850
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.authorOrganization">authorOrganization</a></code> | <code>boolean</code> | Is the author an organization. |
|
|
14849
14851
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.authorUrl">authorUrl</a></code> | <code>string</code> | Author's URL / Website. |
|
|
14850
14852
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
|
|
14851
|
-
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
14853
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). |
|
|
14852
14854
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.autoDetectBin">autoDetectBin</a></code> | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
|
|
14853
14855
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
|
|
14854
14856
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
|
|
@@ -15126,6 +15128,36 @@ A directory which will contain build artifacts.
|
|
|
15126
15128
|
|
|
15127
15129
|
---
|
|
15128
15130
|
|
|
15131
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.auditDeps"></a>
|
|
15132
|
+
|
|
15133
|
+
```typescript
|
|
15134
|
+
public readonly auditDeps: boolean;
|
|
15135
|
+
```
|
|
15136
|
+
|
|
15137
|
+
- *Type:* boolean
|
|
15138
|
+
- *Default:* false
|
|
15139
|
+
|
|
15140
|
+
Run security audit on dependencies.
|
|
15141
|
+
|
|
15142
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
15143
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
15144
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
15145
|
+
|
|
15146
|
+
---
|
|
15147
|
+
|
|
15148
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.auditDepsOptions"></a>
|
|
15149
|
+
|
|
15150
|
+
```typescript
|
|
15151
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
15152
|
+
```
|
|
15153
|
+
|
|
15154
|
+
- *Type:* projen.javascript.AuditOptions
|
|
15155
|
+
- *Default:* default options
|
|
15156
|
+
|
|
15157
|
+
Security audit options.
|
|
15158
|
+
|
|
15159
|
+
---
|
|
15160
|
+
|
|
15129
15161
|
##### `authorEmail`<sup>Optional</sup> <a name="authorEmail" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.authorEmail"></a>
|
|
15130
15162
|
|
|
15131
15163
|
```typescript
|
|
@@ -15196,7 +15228,7 @@ public readonly autoApproveUpgrades: boolean;
|
|
|
15196
15228
|
- *Type:* boolean
|
|
15197
15229
|
- *Default:* true
|
|
15198
15230
|
|
|
15199
|
-
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
15231
|
+
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured).
|
|
15200
15232
|
|
|
15201
15233
|
Throw if set to true but `autoApproveOptions` are not defined.
|
|
15202
15234
|
|
|
@@ -15772,7 +15804,7 @@ public readonly depsUpgrade: boolean;
|
|
|
15772
15804
|
```
|
|
15773
15805
|
|
|
15774
15806
|
- *Type:* boolean
|
|
15775
|
-
- *Default:* true
|
|
15807
|
+
- *Default:* `true` for root projects, `false` for subprojects
|
|
15776
15808
|
|
|
15777
15809
|
Use tasks and github workflows to handle dependency upgrades.
|
|
15778
15810
|
|
|
@@ -17792,12 +17824,14 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
17792
17824
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
17793
17825
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
17794
17826
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
17827
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
17828
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
17795
17829
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
|
|
17796
17830
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
|
|
17797
17831
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.authorOrganization">authorOrganization</a></code> | <code>boolean</code> | Is the author an organization. |
|
|
17798
17832
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.authorUrl">authorUrl</a></code> | <code>string</code> | Author's URL / Website. |
|
|
17799
17833
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
|
|
17800
|
-
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
17834
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). |
|
|
17801
17835
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.autoDetectBin">autoDetectBin</a></code> | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
|
|
17802
17836
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
|
|
17803
17837
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
|
|
@@ -18046,6 +18080,36 @@ A directory which will contain build artifacts.
|
|
|
18046
18080
|
|
|
18047
18081
|
---
|
|
18048
18082
|
|
|
18083
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.auditDeps"></a>
|
|
18084
|
+
|
|
18085
|
+
```typescript
|
|
18086
|
+
public readonly auditDeps: boolean;
|
|
18087
|
+
```
|
|
18088
|
+
|
|
18089
|
+
- *Type:* boolean
|
|
18090
|
+
- *Default:* false
|
|
18091
|
+
|
|
18092
|
+
Run security audit on dependencies.
|
|
18093
|
+
|
|
18094
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
18095
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
18096
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
18097
|
+
|
|
18098
|
+
---
|
|
18099
|
+
|
|
18100
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.auditDepsOptions"></a>
|
|
18101
|
+
|
|
18102
|
+
```typescript
|
|
18103
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
18104
|
+
```
|
|
18105
|
+
|
|
18106
|
+
- *Type:* projen.javascript.AuditOptions
|
|
18107
|
+
- *Default:* default options
|
|
18108
|
+
|
|
18109
|
+
Security audit options.
|
|
18110
|
+
|
|
18111
|
+
---
|
|
18112
|
+
|
|
18049
18113
|
##### `authorEmail`<sup>Optional</sup> <a name="authorEmail" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.authorEmail"></a>
|
|
18050
18114
|
|
|
18051
18115
|
```typescript
|
|
@@ -18116,7 +18180,7 @@ public readonly autoApproveUpgrades: boolean;
|
|
|
18116
18180
|
- *Type:* boolean
|
|
18117
18181
|
- *Default:* true
|
|
18118
18182
|
|
|
18119
|
-
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
18183
|
+
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured).
|
|
18120
18184
|
|
|
18121
18185
|
Throw if set to true but `autoApproveOptions` are not defined.
|
|
18122
18186
|
|
|
@@ -18541,7 +18605,7 @@ public readonly depsUpgrade: boolean;
|
|
|
18541
18605
|
```
|
|
18542
18606
|
|
|
18543
18607
|
- *Type:* boolean
|
|
18544
|
-
- *Default:* true
|
|
18608
|
+
- *Default:* `true` for root projects, `false` for subprojects
|
|
18545
18609
|
|
|
18546
18610
|
Use tasks and github workflows to handle dependency upgrades.
|
|
18547
18611
|
|
|
@@ -20480,12 +20544,14 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
20480
20544
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
20481
20545
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
20482
20546
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
20547
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
20548
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
20483
20549
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
|
|
20484
20550
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
|
|
20485
20551
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.authorOrganization">authorOrganization</a></code> | <code>boolean</code> | Is the author an organization. |
|
|
20486
20552
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.authorUrl">authorUrl</a></code> | <code>string</code> | Author's URL / Website. |
|
|
20487
20553
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
|
|
20488
|
-
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
20554
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). |
|
|
20489
20555
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.autoDetectBin">autoDetectBin</a></code> | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
|
|
20490
20556
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
|
|
20491
20557
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
|
|
@@ -20765,6 +20831,36 @@ A directory which will contain build artifacts.
|
|
|
20765
20831
|
|
|
20766
20832
|
---
|
|
20767
20833
|
|
|
20834
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.auditDeps"></a>
|
|
20835
|
+
|
|
20836
|
+
```typescript
|
|
20837
|
+
public readonly auditDeps: boolean;
|
|
20838
|
+
```
|
|
20839
|
+
|
|
20840
|
+
- *Type:* boolean
|
|
20841
|
+
- *Default:* false
|
|
20842
|
+
|
|
20843
|
+
Run security audit on dependencies.
|
|
20844
|
+
|
|
20845
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
20846
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
20847
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
20848
|
+
|
|
20849
|
+
---
|
|
20850
|
+
|
|
20851
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.auditDepsOptions"></a>
|
|
20852
|
+
|
|
20853
|
+
```typescript
|
|
20854
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
20855
|
+
```
|
|
20856
|
+
|
|
20857
|
+
- *Type:* projen.javascript.AuditOptions
|
|
20858
|
+
- *Default:* default options
|
|
20859
|
+
|
|
20860
|
+
Security audit options.
|
|
20861
|
+
|
|
20862
|
+
---
|
|
20863
|
+
|
|
20768
20864
|
##### `authorEmail`<sup>Optional</sup> <a name="authorEmail" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.authorEmail"></a>
|
|
20769
20865
|
|
|
20770
20866
|
```typescript
|
|
@@ -20835,7 +20931,7 @@ public readonly autoApproveUpgrades: boolean;
|
|
|
20835
20931
|
- *Type:* boolean
|
|
20836
20932
|
- *Default:* true
|
|
20837
20933
|
|
|
20838
|
-
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
20934
|
+
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured).
|
|
20839
20935
|
|
|
20840
20936
|
Throw if set to true but `autoApproveOptions` are not defined.
|
|
20841
20937
|
|
|
@@ -21411,7 +21507,7 @@ public readonly depsUpgrade: boolean;
|
|
|
21411
21507
|
```
|
|
21412
21508
|
|
|
21413
21509
|
- *Type:* boolean
|
|
21414
|
-
- *Default:* true
|
|
21510
|
+
- *Default:* `true` for root projects, `false` for subprojects
|
|
21415
21511
|
|
|
21416
21512
|
Use tasks and github workflows to handle dependency upgrades.
|
|
21417
21513
|
|
|
@@ -23468,12 +23564,14 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
23468
23564
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
23469
23565
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
23470
23566
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
23567
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
23568
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
23471
23569
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
|
|
23472
23570
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
|
|
23473
23571
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.authorOrganization">authorOrganization</a></code> | <code>boolean</code> | Is the author an organization. |
|
|
23474
23572
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.authorUrl">authorUrl</a></code> | <code>string</code> | Author's URL / Website. |
|
|
23475
23573
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
|
|
23476
|
-
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
23574
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). |
|
|
23477
23575
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.autoDetectBin">autoDetectBin</a></code> | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
|
|
23478
23576
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
|
|
23479
23577
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
|
|
@@ -23724,6 +23822,36 @@ A directory which will contain build artifacts.
|
|
|
23724
23822
|
|
|
23725
23823
|
---
|
|
23726
23824
|
|
|
23825
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.auditDeps"></a>
|
|
23826
|
+
|
|
23827
|
+
```typescript
|
|
23828
|
+
public readonly auditDeps: boolean;
|
|
23829
|
+
```
|
|
23830
|
+
|
|
23831
|
+
- *Type:* boolean
|
|
23832
|
+
- *Default:* false
|
|
23833
|
+
|
|
23834
|
+
Run security audit on dependencies.
|
|
23835
|
+
|
|
23836
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
23837
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
23838
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
23839
|
+
|
|
23840
|
+
---
|
|
23841
|
+
|
|
23842
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.auditDepsOptions"></a>
|
|
23843
|
+
|
|
23844
|
+
```typescript
|
|
23845
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
23846
|
+
```
|
|
23847
|
+
|
|
23848
|
+
- *Type:* projen.javascript.AuditOptions
|
|
23849
|
+
- *Default:* default options
|
|
23850
|
+
|
|
23851
|
+
Security audit options.
|
|
23852
|
+
|
|
23853
|
+
---
|
|
23854
|
+
|
|
23727
23855
|
##### `authorEmail`<sup>Optional</sup> <a name="authorEmail" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.authorEmail"></a>
|
|
23728
23856
|
|
|
23729
23857
|
```typescript
|
|
@@ -23794,7 +23922,7 @@ public readonly autoApproveUpgrades: boolean;
|
|
|
23794
23922
|
- *Type:* boolean
|
|
23795
23923
|
- *Default:* true
|
|
23796
23924
|
|
|
23797
|
-
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
23925
|
+
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured).
|
|
23798
23926
|
|
|
23799
23927
|
Throw if set to true but `autoApproveOptions` are not defined.
|
|
23800
23928
|
|
|
@@ -24219,7 +24347,7 @@ public readonly depsUpgrade: boolean;
|
|
|
24219
24347
|
```
|
|
24220
24348
|
|
|
24221
24349
|
- *Type:* boolean
|
|
24222
|
-
- *Default:* true
|
|
24350
|
+
- *Default:* `true` for root projects, `false` for subprojects
|
|
24223
24351
|
|
|
24224
24352
|
Use tasks and github workflows to handle dependency upgrades.
|
|
24225
24353
|
|
|
@@ -26196,12 +26324,14 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
26196
26324
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
26197
26325
|
| <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`. |
|
|
26198
26326
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
26327
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
26328
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
26199
26329
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
|
|
26200
26330
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
|
|
26201
26331
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.authorOrganization">authorOrganization</a></code> | <code>boolean</code> | Is the author an organization. |
|
|
26202
26332
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.authorUrl">authorUrl</a></code> | <code>string</code> | Author's URL / Website. |
|
|
26203
26333
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
|
|
26204
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
26334
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). |
|
|
26205
26335
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.autoDetectBin">autoDetectBin</a></code> | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
|
|
26206
26336
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
|
|
26207
26337
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
|
|
@@ -26403,6 +26533,36 @@ A directory which will contain build artifacts.
|
|
|
26403
26533
|
|
|
26404
26534
|
---
|
|
26405
26535
|
|
|
26536
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.auditDeps"></a>
|
|
26537
|
+
|
|
26538
|
+
```typescript
|
|
26539
|
+
public readonly auditDeps: boolean;
|
|
26540
|
+
```
|
|
26541
|
+
|
|
26542
|
+
- *Type:* boolean
|
|
26543
|
+
- *Default:* false
|
|
26544
|
+
|
|
26545
|
+
Run security audit on dependencies.
|
|
26546
|
+
|
|
26547
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
26548
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
26549
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
26550
|
+
|
|
26551
|
+
---
|
|
26552
|
+
|
|
26553
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.auditDepsOptions"></a>
|
|
26554
|
+
|
|
26555
|
+
```typescript
|
|
26556
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
26557
|
+
```
|
|
26558
|
+
|
|
26559
|
+
- *Type:* projen.javascript.AuditOptions
|
|
26560
|
+
- *Default:* default options
|
|
26561
|
+
|
|
26562
|
+
Security audit options.
|
|
26563
|
+
|
|
26564
|
+
---
|
|
26565
|
+
|
|
26406
26566
|
##### `authorEmail`<sup>Optional</sup> <a name="authorEmail" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.authorEmail"></a>
|
|
26407
26567
|
|
|
26408
26568
|
```typescript
|
|
@@ -26473,7 +26633,7 @@ public readonly autoApproveUpgrades: boolean;
|
|
|
26473
26633
|
- *Type:* boolean
|
|
26474
26634
|
- *Default:* true
|
|
26475
26635
|
|
|
26476
|
-
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
26636
|
+
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured).
|
|
26477
26637
|
|
|
26478
26638
|
Throw if set to true but `autoApproveOptions` are not defined.
|
|
26479
26639
|
|
|
@@ -26869,7 +27029,7 @@ public readonly depsUpgrade: boolean;
|
|
|
26869
27029
|
```
|
|
26870
27030
|
|
|
26871
27031
|
- *Type:* boolean
|
|
26872
|
-
- *Default:* true
|
|
27032
|
+
- *Default:* `true` for root projects, `false` for subprojects
|
|
26873
27033
|
|
|
26874
27034
|
Use tasks and github workflows to handle dependency upgrades.
|
|
26875
27035
|
|
|
@@ -28688,7 +28848,9 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
28688
28848
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
28689
28849
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
28690
28850
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
28691
|
-
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.
|
|
28851
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
28852
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
28853
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). |
|
|
28692
28854
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
|
|
28693
28855
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
28694
28856
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
|
|
@@ -30195,6 +30357,36 @@ A directory which will contain build artifacts.
|
|
|
30195
30357
|
|
|
30196
30358
|
---
|
|
30197
30359
|
|
|
30360
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.auditDeps"></a>
|
|
30361
|
+
|
|
30362
|
+
```typescript
|
|
30363
|
+
public readonly auditDeps: boolean;
|
|
30364
|
+
```
|
|
30365
|
+
|
|
30366
|
+
- *Type:* boolean
|
|
30367
|
+
- *Default:* false
|
|
30368
|
+
|
|
30369
|
+
Run security audit on dependencies.
|
|
30370
|
+
|
|
30371
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
30372
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
30373
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
30374
|
+
|
|
30375
|
+
---
|
|
30376
|
+
|
|
30377
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.auditDepsOptions"></a>
|
|
30378
|
+
|
|
30379
|
+
```typescript
|
|
30380
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
30381
|
+
```
|
|
30382
|
+
|
|
30383
|
+
- *Type:* projen.javascript.AuditOptions
|
|
30384
|
+
- *Default:* default options
|
|
30385
|
+
|
|
30386
|
+
Security audit options.
|
|
30387
|
+
|
|
30388
|
+
---
|
|
30389
|
+
|
|
30198
30390
|
##### `autoApproveUpgrades`<sup>Optional</sup> <a name="autoApproveUpgrades" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.autoApproveUpgrades"></a>
|
|
30199
30391
|
|
|
30200
30392
|
```typescript
|
|
@@ -30204,7 +30396,7 @@ public readonly autoApproveUpgrades: boolean;
|
|
|
30204
30396
|
- *Type:* boolean
|
|
30205
30397
|
- *Default:* true
|
|
30206
30398
|
|
|
30207
|
-
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
30399
|
+
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured).
|
|
30208
30400
|
|
|
30209
30401
|
Throw if set to true but `autoApproveOptions` are not defined.
|
|
30210
30402
|
|
|
@@ -30390,7 +30582,7 @@ public readonly depsUpgrade: boolean;
|
|
|
30390
30582
|
```
|
|
30391
30583
|
|
|
30392
30584
|
- *Type:* boolean
|
|
30393
|
-
- *Default:* true
|
|
30585
|
+
- *Default:* `true` for root projects, `false` for subprojects
|
|
30394
30586
|
|
|
30395
30587
|
Use tasks and github workflows to handle dependency upgrades.
|
|
30396
30588
|
|
|
@@ -31168,7 +31360,9 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
31168
31360
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
31169
31361
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
31170
31362
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
31171
|
-
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.
|
|
31363
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
31364
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
31365
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). |
|
|
31172
31366
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
|
|
31173
31367
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
31174
31368
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
|
|
@@ -32675,6 +32869,36 @@ A directory which will contain build artifacts.
|
|
|
32675
32869
|
|
|
32676
32870
|
---
|
|
32677
32871
|
|
|
32872
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.auditDeps"></a>
|
|
32873
|
+
|
|
32874
|
+
```typescript
|
|
32875
|
+
public readonly auditDeps: boolean;
|
|
32876
|
+
```
|
|
32877
|
+
|
|
32878
|
+
- *Type:* boolean
|
|
32879
|
+
- *Default:* false
|
|
32880
|
+
|
|
32881
|
+
Run security audit on dependencies.
|
|
32882
|
+
|
|
32883
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
32884
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
32885
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
32886
|
+
|
|
32887
|
+
---
|
|
32888
|
+
|
|
32889
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.auditDepsOptions"></a>
|
|
32890
|
+
|
|
32891
|
+
```typescript
|
|
32892
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
32893
|
+
```
|
|
32894
|
+
|
|
32895
|
+
- *Type:* projen.javascript.AuditOptions
|
|
32896
|
+
- *Default:* default options
|
|
32897
|
+
|
|
32898
|
+
Security audit options.
|
|
32899
|
+
|
|
32900
|
+
---
|
|
32901
|
+
|
|
32678
32902
|
##### `autoApproveUpgrades`<sup>Optional</sup> <a name="autoApproveUpgrades" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.autoApproveUpgrades"></a>
|
|
32679
32903
|
|
|
32680
32904
|
```typescript
|
|
@@ -32684,7 +32908,7 @@ public readonly autoApproveUpgrades: boolean;
|
|
|
32684
32908
|
- *Type:* boolean
|
|
32685
32909
|
- *Default:* true
|
|
32686
32910
|
|
|
32687
|
-
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
32911
|
+
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured).
|
|
32688
32912
|
|
|
32689
32913
|
Throw if set to true but `autoApproveOptions` are not defined.
|
|
32690
32914
|
|
|
@@ -32870,7 +33094,7 @@ public readonly depsUpgrade: boolean;
|
|
|
32870
33094
|
```
|
|
32871
33095
|
|
|
32872
33096
|
- *Type:* boolean
|
|
32873
|
-
- *Default:* true
|
|
33097
|
+
- *Default:* `true` for root projects, `false` for subprojects
|
|
32874
33098
|
|
|
32875
33099
|
Use tasks and github workflows to handle dependency upgrades.
|
|
32876
33100
|
|
|
@@ -33558,12 +33782,14 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
33558
33782
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
33559
33783
|
| <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`. |
|
|
33560
33784
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
33785
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
33786
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
33561
33787
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
|
|
33562
33788
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
|
|
33563
33789
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.authorOrganization">authorOrganization</a></code> | <code>boolean</code> | Is the author an organization. |
|
|
33564
33790
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.authorUrl">authorUrl</a></code> | <code>string</code> | Author's URL / Website. |
|
|
33565
33791
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
|
|
33566
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
33792
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). |
|
|
33567
33793
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.autoDetectBin">autoDetectBin</a></code> | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
|
|
33568
33794
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
|
|
33569
33795
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
|
|
@@ -33765,6 +33991,36 @@ A directory which will contain build artifacts.
|
|
|
33765
33991
|
|
|
33766
33992
|
---
|
|
33767
33993
|
|
|
33994
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.auditDeps"></a>
|
|
33995
|
+
|
|
33996
|
+
```typescript
|
|
33997
|
+
public readonly auditDeps: boolean;
|
|
33998
|
+
```
|
|
33999
|
+
|
|
34000
|
+
- *Type:* boolean
|
|
34001
|
+
- *Default:* false
|
|
34002
|
+
|
|
34003
|
+
Run security audit on dependencies.
|
|
34004
|
+
|
|
34005
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
34006
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
34007
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
34008
|
+
|
|
34009
|
+
---
|
|
34010
|
+
|
|
34011
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.auditDepsOptions"></a>
|
|
34012
|
+
|
|
34013
|
+
```typescript
|
|
34014
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
34015
|
+
```
|
|
34016
|
+
|
|
34017
|
+
- *Type:* projen.javascript.AuditOptions
|
|
34018
|
+
- *Default:* default options
|
|
34019
|
+
|
|
34020
|
+
Security audit options.
|
|
34021
|
+
|
|
34022
|
+
---
|
|
34023
|
+
|
|
33768
34024
|
##### `authorEmail`<sup>Optional</sup> <a name="authorEmail" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.authorEmail"></a>
|
|
33769
34025
|
|
|
33770
34026
|
```typescript
|
|
@@ -33835,7 +34091,7 @@ public readonly autoApproveUpgrades: boolean;
|
|
|
33835
34091
|
- *Type:* boolean
|
|
33836
34092
|
- *Default:* true
|
|
33837
34093
|
|
|
33838
|
-
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
34094
|
+
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured).
|
|
33839
34095
|
|
|
33840
34096
|
Throw if set to true but `autoApproveOptions` are not defined.
|
|
33841
34097
|
|
|
@@ -34231,7 +34487,7 @@ public readonly depsUpgrade: boolean;
|
|
|
34231
34487
|
```
|
|
34232
34488
|
|
|
34233
34489
|
- *Type:* boolean
|
|
34234
|
-
- *Default:* true
|
|
34490
|
+
- *Default:* `true` for root projects, `false` for subprojects
|
|
34235
34491
|
|
|
34236
34492
|
Use tasks and github workflows to handle dependency upgrades.
|
|
34237
34493
|
|
|
@@ -36351,12 +36607,14 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
|
|
|
36351
36607
|
| <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`. |
|
|
36352
36608
|
| <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. |
|
|
36353
36609
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
36610
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
36611
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
36354
36612
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
|
|
36355
36613
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
|
|
36356
36614
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.authorOrganization">authorOrganization</a></code> | <code>boolean</code> | Is the author an organization. |
|
|
36357
36615
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.authorUrl">authorUrl</a></code> | <code>string</code> | Author's URL / Website. |
|
|
36358
36616
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
|
|
36359
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
36617
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). |
|
|
36360
36618
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
|
|
36361
36619
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
|
|
36362
36620
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
|
|
@@ -36570,6 +36828,36 @@ A directory which will contain build artifacts.
|
|
|
36570
36828
|
|
|
36571
36829
|
---
|
|
36572
36830
|
|
|
36831
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.auditDeps"></a>
|
|
36832
|
+
|
|
36833
|
+
```typescript
|
|
36834
|
+
public readonly auditDeps: boolean;
|
|
36835
|
+
```
|
|
36836
|
+
|
|
36837
|
+
- *Type:* boolean
|
|
36838
|
+
- *Default:* false
|
|
36839
|
+
|
|
36840
|
+
Run security audit on dependencies.
|
|
36841
|
+
|
|
36842
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
36843
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
36844
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
36845
|
+
|
|
36846
|
+
---
|
|
36847
|
+
|
|
36848
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.auditDepsOptions"></a>
|
|
36849
|
+
|
|
36850
|
+
```typescript
|
|
36851
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
36852
|
+
```
|
|
36853
|
+
|
|
36854
|
+
- *Type:* projen.javascript.AuditOptions
|
|
36855
|
+
- *Default:* default options
|
|
36856
|
+
|
|
36857
|
+
Security audit options.
|
|
36858
|
+
|
|
36859
|
+
---
|
|
36860
|
+
|
|
36573
36861
|
##### `authorEmail`<sup>Optional</sup> <a name="authorEmail" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.authorEmail"></a>
|
|
36574
36862
|
|
|
36575
36863
|
```typescript
|
|
@@ -36640,7 +36928,7 @@ public readonly autoApproveUpgrades: boolean;
|
|
|
36640
36928
|
- *Type:* boolean
|
|
36641
36929
|
- *Default:* true
|
|
36642
36930
|
|
|
36643
|
-
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if
|
|
36931
|
+
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured).
|
|
36644
36932
|
|
|
36645
36933
|
Throw if set to true but `autoApproveOptions` are not defined.
|
|
36646
36934
|
|
|
@@ -37010,7 +37298,7 @@ public readonly depsUpgrade: boolean;
|
|
|
37010
37298
|
```
|
|
37011
37299
|
|
|
37012
37300
|
- *Type:* boolean
|
|
37013
|
-
- *Default:* true
|
|
37301
|
+
- *Default:* `true` for root projects, `false` for subprojects
|
|
37014
37302
|
|
|
37015
37303
|
Use tasks and github workflows to handle dependency upgrades.
|
|
37016
37304
|
|