cdklabs-projen-project-types 0.6.4 → 0.6.6
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 +662 -465
- package/.yarn/install-state.gz +0 -0
- package/API.md +581 -0
- package/lib/cdk-common-options.d.ts +5 -0
- package/lib/cdk-common-options.js +1 -1
- package/lib/cdk-construct-library-options.d.ts +12 -0
- package/lib/cdk-construct-library-options.js +1 -1
- package/lib/cdk-jsii-options.d.ts +12 -0
- package/lib/cdk-jsii-options.js +1 -1
- package/lib/cdk.js +2 -2
- package/lib/cdklabs.js +3 -3
- package/lib/check-gha-expressions.d.ts +15 -0
- package/lib/check-gha-expressions.js +65 -0
- package/lib/common-options.js +6 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +2 -1
- package/lib/jsii.js +1 -1
- package/lib/rosetta.js +1 -1
- package/lib/yarn/constraints.js +1 -1
- package/lib/yarn/jsii-build.js +1 -1
- package/lib/yarn/monorepo-options.d.ts +12 -0
- package/lib/yarn/monorepo-options.js +1 -1
- package/lib/yarn/monorepo-release.js +1 -1
- package/lib/yarn/monorepo.js +7 -3
- package/lib/yarn/typescript-workspace-options.d.ts +7 -0
- package/lib/yarn/typescript-workspace-options.js +1 -1
- package/lib/yarn/typescript-workspace-release.js +1 -1
- package/lib/yarn/typescript-workspace.js +1 -1
- package/package.json +6 -6
package/API.md
CHANGED
|
@@ -650,6 +650,7 @@ When given a project, this it the project itself.
|
|
|
650
650
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
651
651
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
652
652
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
653
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner used for executing TypeScript files. |
|
|
653
654
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
654
655
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
655
656
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
@@ -1259,6 +1260,18 @@ The directory in which compiled .js files reside.
|
|
|
1259
1260
|
|
|
1260
1261
|
---
|
|
1261
1262
|
|
|
1263
|
+
##### `runner`<sup>Required</sup> <a name="runner" id="cdklabs-projen-project-types.CdkConstructLibrary.property.runner"></a>
|
|
1264
|
+
|
|
1265
|
+
```typescript
|
|
1266
|
+
public readonly runner: TypeScriptRunner;
|
|
1267
|
+
```
|
|
1268
|
+
|
|
1269
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
1270
|
+
|
|
1271
|
+
The TypeScript runner used for executing TypeScript files.
|
|
1272
|
+
|
|
1273
|
+
---
|
|
1274
|
+
|
|
1262
1275
|
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="cdklabs-projen-project-types.CdkConstructLibrary.property.srcdir"></a>
|
|
1263
1276
|
|
|
1264
1277
|
```typescript
|
|
@@ -2061,6 +2074,7 @@ When given a project, this it the project itself.
|
|
|
2061
2074
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
2062
2075
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
2063
2076
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
2077
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner used for executing TypeScript files. |
|
|
2064
2078
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
2065
2079
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
2066
2080
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
@@ -2668,6 +2682,18 @@ The directory in which compiled .js files reside.
|
|
|
2668
2682
|
|
|
2669
2683
|
---
|
|
2670
2684
|
|
|
2685
|
+
##### `runner`<sup>Required</sup> <a name="runner" id="cdklabs-projen-project-types.CdkJsiiProject.property.runner"></a>
|
|
2686
|
+
|
|
2687
|
+
```typescript
|
|
2688
|
+
public readonly runner: TypeScriptRunner;
|
|
2689
|
+
```
|
|
2690
|
+
|
|
2691
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
2692
|
+
|
|
2693
|
+
The TypeScript runner used for executing TypeScript files.
|
|
2694
|
+
|
|
2695
|
+
---
|
|
2696
|
+
|
|
2671
2697
|
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="cdklabs-projen-project-types.CdkJsiiProject.property.srcdir"></a>
|
|
2672
2698
|
|
|
2673
2699
|
```typescript
|
|
@@ -3448,6 +3474,7 @@ When given a project, this it the project itself.
|
|
|
3448
3474
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
3449
3475
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
3450
3476
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
3477
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner used for executing TypeScript files. |
|
|
3451
3478
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
3452
3479
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
3453
3480
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
@@ -4057,6 +4084,18 @@ The directory in which compiled .js files reside.
|
|
|
4057
4084
|
|
|
4058
4085
|
---
|
|
4059
4086
|
|
|
4087
|
+
##### `runner`<sup>Required</sup> <a name="runner" id="cdklabs-projen-project-types.CdklabsConstructLibrary.property.runner"></a>
|
|
4088
|
+
|
|
4089
|
+
```typescript
|
|
4090
|
+
public readonly runner: TypeScriptRunner;
|
|
4091
|
+
```
|
|
4092
|
+
|
|
4093
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
4094
|
+
|
|
4095
|
+
The TypeScript runner used for executing TypeScript files.
|
|
4096
|
+
|
|
4097
|
+
---
|
|
4098
|
+
|
|
4060
4099
|
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="cdklabs-projen-project-types.CdklabsConstructLibrary.property.srcdir"></a>
|
|
4061
4100
|
|
|
4062
4101
|
```typescript
|
|
@@ -4859,6 +4898,7 @@ When given a project, this it the project itself.
|
|
|
4859
4898
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
4860
4899
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
4861
4900
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
4901
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner used for executing TypeScript files. |
|
|
4862
4902
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
4863
4903
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
4864
4904
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
@@ -5466,6 +5506,18 @@ The directory in which compiled .js files reside.
|
|
|
5466
5506
|
|
|
5467
5507
|
---
|
|
5468
5508
|
|
|
5509
|
+
##### `runner`<sup>Required</sup> <a name="runner" id="cdklabs-projen-project-types.CdklabsJsiiProject.property.runner"></a>
|
|
5510
|
+
|
|
5511
|
+
```typescript
|
|
5512
|
+
public readonly runner: TypeScriptRunner;
|
|
5513
|
+
```
|
|
5514
|
+
|
|
5515
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
5516
|
+
|
|
5517
|
+
The TypeScript runner used for executing TypeScript files.
|
|
5518
|
+
|
|
5519
|
+
---
|
|
5520
|
+
|
|
5469
5521
|
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="cdklabs-projen-project-types.CdklabsJsiiProject.property.srcdir"></a>
|
|
5470
5522
|
|
|
5471
5523
|
```typescript
|
|
@@ -6276,6 +6328,7 @@ yarn.CdkLabsMonorepo.isMonorepo(x: Project)
|
|
|
6276
6328
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
6277
6329
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
6278
6330
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
6331
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner used for executing TypeScript files. |
|
|
6279
6332
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
6280
6333
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
6281
6334
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
@@ -6885,6 +6938,18 @@ The directory in which compiled .js files reside.
|
|
|
6885
6938
|
|
|
6886
6939
|
---
|
|
6887
6940
|
|
|
6941
|
+
##### `runner`<sup>Required</sup> <a name="runner" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.runner"></a>
|
|
6942
|
+
|
|
6943
|
+
```typescript
|
|
6944
|
+
public readonly runner: TypeScriptRunner;
|
|
6945
|
+
```
|
|
6946
|
+
|
|
6947
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
6948
|
+
|
|
6949
|
+
The TypeScript runner used for executing TypeScript files.
|
|
6950
|
+
|
|
6951
|
+
---
|
|
6952
|
+
|
|
6888
6953
|
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.srcdir"></a>
|
|
6889
6954
|
|
|
6890
6955
|
```typescript
|
|
@@ -7689,6 +7754,7 @@ When given a project, this it the project itself.
|
|
|
7689
7754
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
7690
7755
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
7691
7756
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
7757
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner used for executing TypeScript files. |
|
|
7692
7758
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
7693
7759
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
7694
7760
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
@@ -8296,6 +8362,18 @@ The directory in which compiled .js files reside.
|
|
|
8296
8362
|
|
|
8297
8363
|
---
|
|
8298
8364
|
|
|
8365
|
+
##### `runner`<sup>Required</sup> <a name="runner" id="cdklabs-projen-project-types.CdklabsTypeScriptProject.property.runner"></a>
|
|
8366
|
+
|
|
8367
|
+
```typescript
|
|
8368
|
+
public readonly runner: TypeScriptRunner;
|
|
8369
|
+
```
|
|
8370
|
+
|
|
8371
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
8372
|
+
|
|
8373
|
+
The TypeScript runner used for executing TypeScript files.
|
|
8374
|
+
|
|
8375
|
+
---
|
|
8376
|
+
|
|
8299
8377
|
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="cdklabs-projen-project-types.CdklabsTypeScriptProject.property.srcdir"></a>
|
|
8300
8378
|
|
|
8301
8379
|
```typescript
|
|
@@ -9076,6 +9154,7 @@ When given a project, this it the project itself.
|
|
|
9076
9154
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
9077
9155
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
9078
9156
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
9157
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner used for executing TypeScript files. |
|
|
9079
9158
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
9080
9159
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
9081
9160
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
@@ -9683,6 +9762,18 @@ The directory in which compiled .js files reside.
|
|
|
9683
9762
|
|
|
9684
9763
|
---
|
|
9685
9764
|
|
|
9765
|
+
##### `runner`<sup>Required</sup> <a name="runner" id="cdklabs-projen-project-types.CdkTypeScriptProject.property.runner"></a>
|
|
9766
|
+
|
|
9767
|
+
```typescript
|
|
9768
|
+
public readonly runner: TypeScriptRunner;
|
|
9769
|
+
```
|
|
9770
|
+
|
|
9771
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
9772
|
+
|
|
9773
|
+
The TypeScript runner used for executing TypeScript files.
|
|
9774
|
+
|
|
9775
|
+
---
|
|
9776
|
+
|
|
9686
9777
|
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="cdklabs-projen-project-types.CdkTypeScriptProject.property.srcdir"></a>
|
|
9687
9778
|
|
|
9688
9779
|
```typescript
|
|
@@ -9815,6 +9906,191 @@ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
|
|
|
9815
9906
|
|
|
9816
9907
|
---
|
|
9817
9908
|
|
|
9909
|
+
### CheckGhaExpressions <a name="CheckGhaExpressions" id="cdklabs-projen-project-types.CheckGhaExpressions"></a>
|
|
9910
|
+
|
|
9911
|
+
Check GitHub Actions workflows for the use of dangerous expressions directly interpolated in shell steps.
|
|
9912
|
+
|
|
9913
|
+
Some of these can be used to perform command injection attacks. We block all of them to be overly safe,
|
|
9914
|
+
even the ones that are not dangerous.
|
|
9915
|
+
|
|
9916
|
+
Automatically added to all of our project types.
|
|
9917
|
+
|
|
9918
|
+
#### Initializers <a name="Initializers" id="cdklabs-projen-project-types.CheckGhaExpressions.Initializer"></a>
|
|
9919
|
+
|
|
9920
|
+
```typescript
|
|
9921
|
+
import { CheckGhaExpressions } from 'cdklabs-projen-project-types'
|
|
9922
|
+
|
|
9923
|
+
new CheckGhaExpressions(project: IConstruct)
|
|
9924
|
+
```
|
|
9925
|
+
|
|
9926
|
+
| **Name** | **Type** | **Description** |
|
|
9927
|
+
| --- | --- | --- |
|
|
9928
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.Initializer.parameter.project">project</a></code> | <code>constructs.IConstruct</code> | *No description.* |
|
|
9929
|
+
|
|
9930
|
+
---
|
|
9931
|
+
|
|
9932
|
+
##### `project`<sup>Required</sup> <a name="project" id="cdklabs-projen-project-types.CheckGhaExpressions.Initializer.parameter.project"></a>
|
|
9933
|
+
|
|
9934
|
+
- *Type:* constructs.IConstruct
|
|
9935
|
+
|
|
9936
|
+
---
|
|
9937
|
+
|
|
9938
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
9939
|
+
|
|
9940
|
+
| **Name** | **Description** |
|
|
9941
|
+
| --- | --- |
|
|
9942
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
9943
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
9944
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.postSynthesize">postSynthesize</a></code> | Called after synthesis. |
|
|
9945
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
|
|
9946
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
|
|
9947
|
+
|
|
9948
|
+
---
|
|
9949
|
+
|
|
9950
|
+
##### `toString` <a name="toString" id="cdklabs-projen-project-types.CheckGhaExpressions.toString"></a>
|
|
9951
|
+
|
|
9952
|
+
```typescript
|
|
9953
|
+
public toString(): string
|
|
9954
|
+
```
|
|
9955
|
+
|
|
9956
|
+
Returns a string representation of this construct.
|
|
9957
|
+
|
|
9958
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.CheckGhaExpressions.with"></a>
|
|
9959
|
+
|
|
9960
|
+
```typescript
|
|
9961
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
9962
|
+
```
|
|
9963
|
+
|
|
9964
|
+
Applies one or more mixins to this construct.
|
|
9965
|
+
|
|
9966
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
9967
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
9968
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
9969
|
+
constructs.
|
|
9970
|
+
|
|
9971
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.CheckGhaExpressions.with.parameter.mixins"></a>
|
|
9972
|
+
|
|
9973
|
+
- *Type:* ...constructs.IMixin[]
|
|
9974
|
+
|
|
9975
|
+
The mixins to apply.
|
|
9976
|
+
|
|
9977
|
+
---
|
|
9978
|
+
|
|
9979
|
+
##### `postSynthesize` <a name="postSynthesize" id="cdklabs-projen-project-types.CheckGhaExpressions.postSynthesize"></a>
|
|
9980
|
+
|
|
9981
|
+
```typescript
|
|
9982
|
+
public postSynthesize(): void
|
|
9983
|
+
```
|
|
9984
|
+
|
|
9985
|
+
Called after synthesis.
|
|
9986
|
+
|
|
9987
|
+
Order is *not* guaranteed.
|
|
9988
|
+
|
|
9989
|
+
##### `preSynthesize` <a name="preSynthesize" id="cdklabs-projen-project-types.CheckGhaExpressions.preSynthesize"></a>
|
|
9990
|
+
|
|
9991
|
+
```typescript
|
|
9992
|
+
public preSynthesize(): void
|
|
9993
|
+
```
|
|
9994
|
+
|
|
9995
|
+
Called before synthesis.
|
|
9996
|
+
|
|
9997
|
+
##### `synthesize` <a name="synthesize" id="cdklabs-projen-project-types.CheckGhaExpressions.synthesize"></a>
|
|
9998
|
+
|
|
9999
|
+
```typescript
|
|
10000
|
+
public synthesize(): void
|
|
10001
|
+
```
|
|
10002
|
+
|
|
10003
|
+
Synthesizes files to the project output directory.
|
|
10004
|
+
|
|
10005
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
10006
|
+
|
|
10007
|
+
| **Name** | **Description** |
|
|
10008
|
+
| --- | --- |
|
|
10009
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
10010
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.isComponent">isComponent</a></code> | Test whether the given construct is a component. |
|
|
10011
|
+
|
|
10012
|
+
---
|
|
10013
|
+
|
|
10014
|
+
##### `isConstruct` <a name="isConstruct" id="cdklabs-projen-project-types.CheckGhaExpressions.isConstruct"></a>
|
|
10015
|
+
|
|
10016
|
+
```typescript
|
|
10017
|
+
import { CheckGhaExpressions } from 'cdklabs-projen-project-types'
|
|
10018
|
+
|
|
10019
|
+
CheckGhaExpressions.isConstruct(x: any)
|
|
10020
|
+
```
|
|
10021
|
+
|
|
10022
|
+
Checks if `x` is a construct.
|
|
10023
|
+
|
|
10024
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
10025
|
+
instances, even when the construct library is symlinked.
|
|
10026
|
+
|
|
10027
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
10028
|
+
disk are seen as independent, completely different libraries. As a
|
|
10029
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
10030
|
+
is seen as a different class, and an instance of one class will not test as
|
|
10031
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
10032
|
+
like this, but users may manually symlink construct libraries together or
|
|
10033
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
10034
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
10035
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
10036
|
+
this type-testing method instead.
|
|
10037
|
+
|
|
10038
|
+
###### `x`<sup>Required</sup> <a name="x" id="cdklabs-projen-project-types.CheckGhaExpressions.isConstruct.parameter.x"></a>
|
|
10039
|
+
|
|
10040
|
+
- *Type:* any
|
|
10041
|
+
|
|
10042
|
+
Any object.
|
|
10043
|
+
|
|
10044
|
+
---
|
|
10045
|
+
|
|
10046
|
+
##### `isComponent` <a name="isComponent" id="cdklabs-projen-project-types.CheckGhaExpressions.isComponent"></a>
|
|
10047
|
+
|
|
10048
|
+
```typescript
|
|
10049
|
+
import { CheckGhaExpressions } from 'cdklabs-projen-project-types'
|
|
10050
|
+
|
|
10051
|
+
CheckGhaExpressions.isComponent(x: any)
|
|
10052
|
+
```
|
|
10053
|
+
|
|
10054
|
+
Test whether the given construct is a component.
|
|
10055
|
+
|
|
10056
|
+
###### `x`<sup>Required</sup> <a name="x" id="cdklabs-projen-project-types.CheckGhaExpressions.isComponent.parameter.x"></a>
|
|
10057
|
+
|
|
10058
|
+
- *Type:* any
|
|
10059
|
+
|
|
10060
|
+
---
|
|
10061
|
+
|
|
10062
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
10063
|
+
|
|
10064
|
+
| **Name** | **Type** | **Description** |
|
|
10065
|
+
| --- | --- | --- |
|
|
10066
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
10067
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.property.project">project</a></code> | <code>projen.Project</code> | *No description.* |
|
|
10068
|
+
|
|
10069
|
+
---
|
|
10070
|
+
|
|
10071
|
+
##### `node`<sup>Required</sup> <a name="node" id="cdklabs-projen-project-types.CheckGhaExpressions.property.node"></a>
|
|
10072
|
+
|
|
10073
|
+
```typescript
|
|
10074
|
+
public readonly node: Node;
|
|
10075
|
+
```
|
|
10076
|
+
|
|
10077
|
+
- *Type:* constructs.Node
|
|
10078
|
+
|
|
10079
|
+
The tree node.
|
|
10080
|
+
|
|
10081
|
+
---
|
|
10082
|
+
|
|
10083
|
+
##### `project`<sup>Required</sup> <a name="project" id="cdklabs-projen-project-types.CheckGhaExpressions.property.project"></a>
|
|
10084
|
+
|
|
10085
|
+
```typescript
|
|
10086
|
+
public readonly project: Project;
|
|
10087
|
+
```
|
|
10088
|
+
|
|
10089
|
+
- *Type:* projen.Project
|
|
10090
|
+
|
|
10091
|
+
---
|
|
10092
|
+
|
|
10093
|
+
|
|
9818
10094
|
### Constraints <a name="Constraints" id="cdklabs-projen-project-types.yarn.Constraints"></a>
|
|
9819
10095
|
|
|
9820
10096
|
#### Initializers <a name="Initializers" id="cdklabs-projen-project-types.yarn.Constraints.Initializer"></a>
|
|
@@ -10678,6 +10954,7 @@ yarn.Monorepo.isMonorepo(x: Project)
|
|
|
10678
10954
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
10679
10955
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
10680
10956
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
10957
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner used for executing TypeScript files. |
|
|
10681
10958
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
10682
10959
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
10683
10960
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
@@ -11287,6 +11564,18 @@ The directory in which compiled .js files reside.
|
|
|
11287
11564
|
|
|
11288
11565
|
---
|
|
11289
11566
|
|
|
11567
|
+
##### `runner`<sup>Required</sup> <a name="runner" id="cdklabs-projen-project-types.yarn.Monorepo.property.runner"></a>
|
|
11568
|
+
|
|
11569
|
+
```typescript
|
|
11570
|
+
public readonly runner: TypeScriptRunner;
|
|
11571
|
+
```
|
|
11572
|
+
|
|
11573
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
11574
|
+
|
|
11575
|
+
The TypeScript runner used for executing TypeScript files.
|
|
11576
|
+
|
|
11577
|
+
---
|
|
11578
|
+
|
|
11290
11579
|
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="cdklabs-projen-project-types.yarn.Monorepo.property.srcdir"></a>
|
|
11291
11580
|
|
|
11292
11581
|
```typescript
|
|
@@ -12574,6 +12863,7 @@ When given a project, this it the project itself.
|
|
|
12574
12863
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
12575
12864
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
12576
12865
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
12866
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner used for executing TypeScript files. |
|
|
12577
12867
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
12578
12868
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
12579
12869
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
@@ -13184,6 +13474,18 @@ The directory in which compiled .js files reside.
|
|
|
13184
13474
|
|
|
13185
13475
|
---
|
|
13186
13476
|
|
|
13477
|
+
##### `runner`<sup>Required</sup> <a name="runner" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.runner"></a>
|
|
13478
|
+
|
|
13479
|
+
```typescript
|
|
13480
|
+
public readonly runner: TypeScriptRunner;
|
|
13481
|
+
```
|
|
13482
|
+
|
|
13483
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
13484
|
+
|
|
13485
|
+
The TypeScript runner used for executing TypeScript files.
|
|
13486
|
+
|
|
13487
|
+
---
|
|
13488
|
+
|
|
13187
13489
|
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.srcdir"></a>
|
|
13188
13490
|
|
|
13189
13491
|
```typescript
|
|
@@ -13597,6 +13899,7 @@ const cdkCommonOptions: CdkCommonOptions = { ... }
|
|
|
13597
13899
|
|
|
13598
13900
|
| **Name** | **Type** | **Description** |
|
|
13599
13901
|
| --- | --- | --- |
|
|
13902
|
+
| <code><a href="#cdklabs-projen-project-types.CdkCommonOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
13600
13903
|
| <code><a href="#cdklabs-projen-project-types.CdkCommonOptions.property.enablePRAutoMerge">enablePRAutoMerge</a></code> | <code>boolean</code> | Whether to enable the auto merge workflow for PRs. |
|
|
13601
13904
|
| <code><a href="#cdklabs-projen-project-types.CdkCommonOptions.property.ghAutoMergeOptions">ghAutoMergeOptions</a></code> | <code>projen.github.AutoQueueOptions</code> | Options for the GitHub auto merge workflow. |
|
|
13602
13905
|
| <code><a href="#cdklabs-projen-project-types.CdkCommonOptions.property.private">private</a></code> | <code>boolean</code> | Whether or not this package is private. |
|
|
@@ -13607,6 +13910,19 @@ const cdkCommonOptions: CdkCommonOptions = { ... }
|
|
|
13607
13910
|
|
|
13608
13911
|
---
|
|
13609
13912
|
|
|
13913
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdkCommonOptions.property.checkGhaExpressions"></a>
|
|
13914
|
+
|
|
13915
|
+
```typescript
|
|
13916
|
+
public readonly checkGhaExpressions: boolean;
|
|
13917
|
+
```
|
|
13918
|
+
|
|
13919
|
+
- *Type:* boolean
|
|
13920
|
+
- *Default:* true
|
|
13921
|
+
|
|
13922
|
+
Enable GitHub Actions expressions validation.
|
|
13923
|
+
|
|
13924
|
+
---
|
|
13925
|
+
|
|
13610
13926
|
##### `enablePRAutoMerge`<sup>Optional</sup> <a name="enablePRAutoMerge" id="cdklabs-projen-project-types.CdkCommonOptions.property.enablePRAutoMerge"></a>
|
|
13611
13927
|
|
|
13612
13928
|
```typescript
|
|
@@ -13752,6 +14068,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
13752
14068
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.catalog">catalog</a></code> | <code>projen.cdk.Catalog</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. |
|
|
13753
14069
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.cdkCliVersion">cdkCliVersion</a></code> | <code>string</code> | Version range of the AWS CDK CLI to depend on. |
|
|
13754
14070
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.cdkVersionPinning">cdkVersionPinning</a></code> | <code>boolean</code> | Use pinned version instead of caret version for CDK. |
|
|
14071
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
13755
14072
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
13756
14073
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
13757
14074
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
@@ -13874,6 +14191,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
13874
14191
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.repositoryUrl">repositoryUrl</a></code> | <code>string</code> | *No description.* |
|
|
13875
14192
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.rootdir">rootdir</a></code> | <code>string</code> | *No description.* |
|
|
13876
14193
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.rosettaOptions">rosettaOptions</a></code> | <code><a href="#cdklabs-projen-project-types.RosettaOptions">RosettaOptions</a></code> | Options for rosetta:extract task. |
|
|
14194
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner to use for executing TypeScript files. |
|
|
13877
14195
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.sampleCode">sampleCode</a></code> | <code>boolean</code> | Generate one-time sample in `src/` and `test/` if there are no files there. |
|
|
13878
14196
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
13879
14197
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.setNodeEngineVersion">setNodeEngineVersion</a></code> | <code>boolean</code> | Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. |
|
|
@@ -14359,6 +14677,19 @@ If you use experimental features this will let you define the moment you include
|
|
|
14359
14677
|
|
|
14360
14678
|
---
|
|
14361
14679
|
|
|
14680
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.checkGhaExpressions"></a>
|
|
14681
|
+
|
|
14682
|
+
```typescript
|
|
14683
|
+
public readonly checkGhaExpressions: boolean;
|
|
14684
|
+
```
|
|
14685
|
+
|
|
14686
|
+
- *Type:* boolean
|
|
14687
|
+
- *Default:* true
|
|
14688
|
+
|
|
14689
|
+
Enable GitHub Actions expressions validation.
|
|
14690
|
+
|
|
14691
|
+
---
|
|
14692
|
+
|
|
14362
14693
|
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.checkLicenses"></a>
|
|
14363
14694
|
|
|
14364
14695
|
```typescript
|
|
@@ -16077,6 +16408,22 @@ Options for rosetta:extract task.
|
|
|
16077
16408
|
|
|
16078
16409
|
---
|
|
16079
16410
|
|
|
16411
|
+
##### `runner`<sup>Optional</sup> <a name="runner" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.runner"></a>
|
|
16412
|
+
|
|
16413
|
+
```typescript
|
|
16414
|
+
public readonly runner: TypeScriptRunner;
|
|
16415
|
+
```
|
|
16416
|
+
|
|
16417
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
16418
|
+
- *Default:* TypeScriptRunner.tsNode()
|
|
16419
|
+
|
|
16420
|
+
The TypeScript runner to use for executing TypeScript files.
|
|
16421
|
+
|
|
16422
|
+
This is a project-level setting that components (e.g. projenrc) will
|
|
16423
|
+
use as their default runner.
|
|
16424
|
+
|
|
16425
|
+
---
|
|
16426
|
+
|
|
16080
16427
|
##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.sampleCode"></a>
|
|
16081
16428
|
|
|
16082
16429
|
```typescript
|
|
@@ -16506,6 +16853,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
16506
16853
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
16507
16854
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
16508
16855
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
16856
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
16509
16857
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
16510
16858
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
16511
16859
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
@@ -16620,6 +16968,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
16620
16968
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
|
|
16621
16969
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.repositoryUrl">repositoryUrl</a></code> | <code>string</code> | *No description.* |
|
|
16622
16970
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.rootdir">rootdir</a></code> | <code>string</code> | *No description.* |
|
|
16971
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner to use for executing TypeScript files. |
|
|
16623
16972
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.sampleCode">sampleCode</a></code> | <code>boolean</code> | Generate one-time sample in `src/` and `test/` if there are no files there. |
|
|
16624
16973
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
16625
16974
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.setNodeEngineVersion">setNodeEngineVersion</a></code> | <code>boolean</code> | Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. |
|
|
@@ -17036,6 +17385,19 @@ The version of Bun to use if using Bun as a package manager.
|
|
|
17036
17385
|
|
|
17037
17386
|
---
|
|
17038
17387
|
|
|
17388
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.checkGhaExpressions"></a>
|
|
17389
|
+
|
|
17390
|
+
```typescript
|
|
17391
|
+
public readonly checkGhaExpressions: boolean;
|
|
17392
|
+
```
|
|
17393
|
+
|
|
17394
|
+
- *Type:* boolean
|
|
17395
|
+
- *Default:* true
|
|
17396
|
+
|
|
17397
|
+
Enable GitHub Actions expressions validation.
|
|
17398
|
+
|
|
17399
|
+
---
|
|
17400
|
+
|
|
17039
17401
|
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.checkLicenses"></a>
|
|
17040
17402
|
|
|
17041
17403
|
```typescript
|
|
@@ -18659,6 +19021,22 @@ public readonly rootdir: string;
|
|
|
18659
19021
|
|
|
18660
19022
|
---
|
|
18661
19023
|
|
|
19024
|
+
##### `runner`<sup>Optional</sup> <a name="runner" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.runner"></a>
|
|
19025
|
+
|
|
19026
|
+
```typescript
|
|
19027
|
+
public readonly runner: TypeScriptRunner;
|
|
19028
|
+
```
|
|
19029
|
+
|
|
19030
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
19031
|
+
- *Default:* TypeScriptRunner.tsNode()
|
|
19032
|
+
|
|
19033
|
+
The TypeScript runner to use for executing TypeScript files.
|
|
19034
|
+
|
|
19035
|
+
This is a project-level setting that components (e.g. projenrc) will
|
|
19036
|
+
use as their default runner.
|
|
19037
|
+
|
|
19038
|
+
---
|
|
19039
|
+
|
|
18662
19040
|
##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.sampleCode"></a>
|
|
18663
19041
|
|
|
18664
19042
|
```typescript
|
|
@@ -19079,6 +19457,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
19079
19457
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.catalog">catalog</a></code> | <code>projen.cdk.Catalog</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. |
|
|
19080
19458
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.cdkCliVersion">cdkCliVersion</a></code> | <code>string</code> | Version range of the AWS CDK CLI to depend on. |
|
|
19081
19459
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.cdkVersionPinning">cdkVersionPinning</a></code> | <code>boolean</code> | Use pinned version instead of caret version for CDK. |
|
|
19460
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
19082
19461
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
19083
19462
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
19084
19463
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
@@ -19201,6 +19580,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
19201
19580
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.repositoryUrl">repositoryUrl</a></code> | <code>string</code> | *No description.* |
|
|
19202
19581
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.rootdir">rootdir</a></code> | <code>string</code> | *No description.* |
|
|
19203
19582
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.rosettaOptions">rosettaOptions</a></code> | <code><a href="#cdklabs-projen-project-types.RosettaOptions">RosettaOptions</a></code> | Options for rosetta:extract task. |
|
|
19583
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner to use for executing TypeScript files. |
|
|
19204
19584
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.sampleCode">sampleCode</a></code> | <code>boolean</code> | Generate one-time sample in `src/` and `test/` if there are no files there. |
|
|
19205
19585
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
19206
19586
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.setNodeEngineVersion">setNodeEngineVersion</a></code> | <code>boolean</code> | Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. |
|
|
@@ -19688,6 +20068,19 @@ If you use experimental features this will let you define the moment you include
|
|
|
19688
20068
|
|
|
19689
20069
|
---
|
|
19690
20070
|
|
|
20071
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.checkGhaExpressions"></a>
|
|
20072
|
+
|
|
20073
|
+
```typescript
|
|
20074
|
+
public readonly checkGhaExpressions: boolean;
|
|
20075
|
+
```
|
|
20076
|
+
|
|
20077
|
+
- *Type:* boolean
|
|
20078
|
+
- *Default:* true
|
|
20079
|
+
|
|
20080
|
+
Enable GitHub Actions expressions validation.
|
|
20081
|
+
|
|
20082
|
+
---
|
|
20083
|
+
|
|
19691
20084
|
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.checkLicenses"></a>
|
|
19692
20085
|
|
|
19693
20086
|
```typescript
|
|
@@ -21406,6 +21799,22 @@ Options for rosetta:extract task.
|
|
|
21406
21799
|
|
|
21407
21800
|
---
|
|
21408
21801
|
|
|
21802
|
+
##### `runner`<sup>Optional</sup> <a name="runner" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.runner"></a>
|
|
21803
|
+
|
|
21804
|
+
```typescript
|
|
21805
|
+
public readonly runner: TypeScriptRunner;
|
|
21806
|
+
```
|
|
21807
|
+
|
|
21808
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
21809
|
+
- *Default:* TypeScriptRunner.tsNode()
|
|
21810
|
+
|
|
21811
|
+
The TypeScript runner to use for executing TypeScript files.
|
|
21812
|
+
|
|
21813
|
+
This is a project-level setting that components (e.g. projenrc) will
|
|
21814
|
+
use as their default runner.
|
|
21815
|
+
|
|
21816
|
+
---
|
|
21817
|
+
|
|
21409
21818
|
##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.sampleCode"></a>
|
|
21410
21819
|
|
|
21411
21820
|
```typescript
|
|
@@ -21872,6 +22281,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
21872
22281
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
21873
22282
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
21874
22283
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
22284
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
21875
22285
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
21876
22286
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
21877
22287
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
@@ -21986,6 +22396,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
21986
22396
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
|
|
21987
22397
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.repositoryUrl">repositoryUrl</a></code> | <code>string</code> | *No description.* |
|
|
21988
22398
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.rootdir">rootdir</a></code> | <code>string</code> | *No description.* |
|
|
22399
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner to use for executing TypeScript files. |
|
|
21989
22400
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.sampleCode">sampleCode</a></code> | <code>boolean</code> | Generate one-time sample in `src/` and `test/` if there are no files there. |
|
|
21990
22401
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
21991
22402
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.setNodeEngineVersion">setNodeEngineVersion</a></code> | <code>boolean</code> | Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. |
|
|
@@ -22404,6 +22815,19 @@ The version of Bun to use if using Bun as a package manager.
|
|
|
22404
22815
|
|
|
22405
22816
|
---
|
|
22406
22817
|
|
|
22818
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.checkGhaExpressions"></a>
|
|
22819
|
+
|
|
22820
|
+
```typescript
|
|
22821
|
+
public readonly checkGhaExpressions: boolean;
|
|
22822
|
+
```
|
|
22823
|
+
|
|
22824
|
+
- *Type:* boolean
|
|
22825
|
+
- *Default:* true
|
|
22826
|
+
|
|
22827
|
+
Enable GitHub Actions expressions validation.
|
|
22828
|
+
|
|
22829
|
+
---
|
|
22830
|
+
|
|
22407
22831
|
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.checkLicenses"></a>
|
|
22408
22832
|
|
|
22409
22833
|
```typescript
|
|
@@ -24027,6 +24451,22 @@ public readonly rootdir: string;
|
|
|
24027
24451
|
|
|
24028
24452
|
---
|
|
24029
24453
|
|
|
24454
|
+
##### `runner`<sup>Optional</sup> <a name="runner" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.runner"></a>
|
|
24455
|
+
|
|
24456
|
+
```typescript
|
|
24457
|
+
public readonly runner: TypeScriptRunner;
|
|
24458
|
+
```
|
|
24459
|
+
|
|
24460
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
24461
|
+
- *Default:* TypeScriptRunner.tsNode()
|
|
24462
|
+
|
|
24463
|
+
The TypeScript runner to use for executing TypeScript files.
|
|
24464
|
+
|
|
24465
|
+
This is a project-level setting that components (e.g. projenrc) will
|
|
24466
|
+
use as their default runner.
|
|
24467
|
+
|
|
24468
|
+
---
|
|
24469
|
+
|
|
24030
24470
|
##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.sampleCode"></a>
|
|
24031
24471
|
|
|
24032
24472
|
```typescript
|
|
@@ -24484,6 +24924,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
24484
24924
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
24485
24925
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
24486
24926
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
24927
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
24487
24928
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
24488
24929
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
24489
24930
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
@@ -24582,6 +25023,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
24582
25023
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.renovatebotOptions">renovatebotOptions</a></code> | <code>projen.RenovatebotOptions</code> | Options for renovatebot. |
|
|
24583
25024
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
|
|
24584
25025
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
|
|
25026
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner to use for executing TypeScript files. |
|
|
24585
25027
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
24586
25028
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.srcdir">srcdir</a></code> | <code>string</code> | Typescript sources directory. |
|
|
24587
25029
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
@@ -24999,6 +25441,19 @@ The version of Bun to use if using Bun as a package manager.
|
|
|
24999
25441
|
|
|
25000
25442
|
---
|
|
25001
25443
|
|
|
25444
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.checkGhaExpressions"></a>
|
|
25445
|
+
|
|
25446
|
+
```typescript
|
|
25447
|
+
public readonly checkGhaExpressions: boolean;
|
|
25448
|
+
```
|
|
25449
|
+
|
|
25450
|
+
- *Type:* boolean
|
|
25451
|
+
- *Default:* true
|
|
25452
|
+
|
|
25453
|
+
Enable GitHub Actions expressions validation.
|
|
25454
|
+
|
|
25455
|
+
---
|
|
25456
|
+
|
|
25002
25457
|
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.checkLicenses"></a>
|
|
25003
25458
|
|
|
25004
25459
|
```typescript
|
|
@@ -26394,6 +26849,22 @@ If the package.json for your package is not in the root directory (for example i
|
|
|
26394
26849
|
|
|
26395
26850
|
---
|
|
26396
26851
|
|
|
26852
|
+
##### `runner`<sup>Optional</sup> <a name="runner" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.runner"></a>
|
|
26853
|
+
|
|
26854
|
+
```typescript
|
|
26855
|
+
public readonly runner: TypeScriptRunner;
|
|
26856
|
+
```
|
|
26857
|
+
|
|
26858
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
26859
|
+
- *Default:* TypeScriptRunner.tsNode()
|
|
26860
|
+
|
|
26861
|
+
The TypeScript runner to use for executing TypeScript files.
|
|
26862
|
+
|
|
26863
|
+
This is a project-level setting that components (e.g. projenrc) will
|
|
26864
|
+
use as their default runner.
|
|
26865
|
+
|
|
26866
|
+
---
|
|
26867
|
+
|
|
26397
26868
|
##### `scopedPackagesOptions`<sup>Optional</sup> <a name="scopedPackagesOptions" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.scopedPackagesOptions"></a>
|
|
26398
26869
|
|
|
26399
26870
|
```typescript
|
|
@@ -26939,6 +27410,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
26939
27410
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.libdir">libdir</a></code> | <code>string</code> | Typescript artifacts output directory. |
|
|
26940
27411
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.projenrcTs">projenrcTs</a></code> | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`). |
|
|
26941
27412
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.projenrcTsOptions">projenrcTsOptions</a></code> | <code>projen.typescript.ProjenrcOptions</code> | Options for .projenrc.ts. |
|
|
27413
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner to use for executing TypeScript files. |
|
|
26942
27414
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.sampleCode">sampleCode</a></code> | <code>boolean</code> | Generate one-time sample in `src/` and `test/` if there are no files there. |
|
|
26943
27415
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.srcdir">srcdir</a></code> | <code>string</code> | Typescript sources directory. |
|
|
26944
27416
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.testdir">testdir</a></code> | <code>string</code> | Jest tests directory. Tests files should be named `xxx.test.ts`. |
|
|
@@ -26947,6 +27419,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
26947
27419
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
26948
27420
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
26949
27421
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
27422
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
26950
27423
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.enablePRAutoMerge">enablePRAutoMerge</a></code> | <code>boolean</code> | Whether to enable the auto merge workflow for PRs. |
|
|
26951
27424
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.ghAutoMergeOptions">ghAutoMergeOptions</a></code> | <code>projen.github.AutoQueueOptions</code> | Options for the GitHub auto merge workflow. |
|
|
26952
27425
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.private">private</a></code> | <code>boolean</code> | Whether or not this package is private. |
|
|
@@ -28951,6 +29424,22 @@ Options for .projenrc.ts.
|
|
|
28951
29424
|
|
|
28952
29425
|
---
|
|
28953
29426
|
|
|
29427
|
+
##### `runner`<sup>Optional</sup> <a name="runner" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.runner"></a>
|
|
29428
|
+
|
|
29429
|
+
```typescript
|
|
29430
|
+
public readonly runner: TypeScriptRunner;
|
|
29431
|
+
```
|
|
29432
|
+
|
|
29433
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
29434
|
+
- *Default:* TypeScriptRunner.tsNode()
|
|
29435
|
+
|
|
29436
|
+
The TypeScript runner to use for executing TypeScript files.
|
|
29437
|
+
|
|
29438
|
+
This is a project-level setting that components (e.g. projenrc) will
|
|
29439
|
+
use as their default runner.
|
|
29440
|
+
|
|
29441
|
+
---
|
|
29442
|
+
|
|
28954
29443
|
##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.sampleCode"></a>
|
|
28955
29444
|
|
|
28956
29445
|
```typescript
|
|
@@ -29066,6 +29555,19 @@ same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
|
|
|
29066
29555
|
|
|
29067
29556
|
---
|
|
29068
29557
|
|
|
29558
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.checkGhaExpressions"></a>
|
|
29559
|
+
|
|
29560
|
+
```typescript
|
|
29561
|
+
public readonly checkGhaExpressions: boolean;
|
|
29562
|
+
```
|
|
29563
|
+
|
|
29564
|
+
- *Type:* boolean
|
|
29565
|
+
- *Default:* true
|
|
29566
|
+
|
|
29567
|
+
Enable GitHub Actions expressions validation.
|
|
29568
|
+
|
|
29569
|
+
---
|
|
29570
|
+
|
|
29069
29571
|
##### `enablePRAutoMerge`<sup>Optional</sup> <a name="enablePRAutoMerge" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.enablePRAutoMerge"></a>
|
|
29070
29572
|
|
|
29071
29573
|
```typescript
|
|
@@ -29316,6 +29818,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
29316
29818
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.libdir">libdir</a></code> | <code>string</code> | Typescript artifacts output directory. |
|
|
29317
29819
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.projenrcTs">projenrcTs</a></code> | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`). |
|
|
29318
29820
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.projenrcTsOptions">projenrcTsOptions</a></code> | <code>projen.typescript.ProjenrcOptions</code> | Options for .projenrc.ts. |
|
|
29821
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner to use for executing TypeScript files. |
|
|
29319
29822
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.sampleCode">sampleCode</a></code> | <code>boolean</code> | Generate one-time sample in `src/` and `test/` if there are no files there. |
|
|
29320
29823
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.srcdir">srcdir</a></code> | <code>string</code> | Typescript sources directory. |
|
|
29321
29824
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.testdir">testdir</a></code> | <code>string</code> | Jest tests directory. Tests files should be named `xxx.test.ts`. |
|
|
@@ -29324,6 +29827,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
29324
29827
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
29325
29828
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
29326
29829
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
29830
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
29327
29831
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.enablePRAutoMerge">enablePRAutoMerge</a></code> | <code>boolean</code> | Whether to enable the auto merge workflow for PRs. |
|
|
29328
29832
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.ghAutoMergeOptions">ghAutoMergeOptions</a></code> | <code>projen.github.AutoQueueOptions</code> | Options for the GitHub auto merge workflow. |
|
|
29329
29833
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.private">private</a></code> | <code>boolean</code> | Whether or not this package is private. |
|
|
@@ -31328,6 +31832,22 @@ Options for .projenrc.ts.
|
|
|
31328
31832
|
|
|
31329
31833
|
---
|
|
31330
31834
|
|
|
31835
|
+
##### `runner`<sup>Optional</sup> <a name="runner" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.runner"></a>
|
|
31836
|
+
|
|
31837
|
+
```typescript
|
|
31838
|
+
public readonly runner: TypeScriptRunner;
|
|
31839
|
+
```
|
|
31840
|
+
|
|
31841
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
31842
|
+
- *Default:* TypeScriptRunner.tsNode()
|
|
31843
|
+
|
|
31844
|
+
The TypeScript runner to use for executing TypeScript files.
|
|
31845
|
+
|
|
31846
|
+
This is a project-level setting that components (e.g. projenrc) will
|
|
31847
|
+
use as their default runner.
|
|
31848
|
+
|
|
31849
|
+
---
|
|
31850
|
+
|
|
31331
31851
|
##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.sampleCode"></a>
|
|
31332
31852
|
|
|
31333
31853
|
```typescript
|
|
@@ -31443,6 +31963,19 @@ same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
|
|
|
31443
31963
|
|
|
31444
31964
|
---
|
|
31445
31965
|
|
|
31966
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.checkGhaExpressions"></a>
|
|
31967
|
+
|
|
31968
|
+
```typescript
|
|
31969
|
+
public readonly checkGhaExpressions: boolean;
|
|
31970
|
+
```
|
|
31971
|
+
|
|
31972
|
+
- *Type:* boolean
|
|
31973
|
+
- *Default:* true
|
|
31974
|
+
|
|
31975
|
+
Enable GitHub Actions expressions validation.
|
|
31976
|
+
|
|
31977
|
+
---
|
|
31978
|
+
|
|
31446
31979
|
##### `enablePRAutoMerge`<sup>Optional</sup> <a name="enablePRAutoMerge" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.enablePRAutoMerge"></a>
|
|
31447
31980
|
|
|
31448
31981
|
```typescript
|
|
@@ -31944,6 +32477,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
31944
32477
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
31945
32478
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
31946
32479
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
32480
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
31947
32481
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
31948
32482
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
31949
32483
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
@@ -32042,6 +32576,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
32042
32576
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.renovatebotOptions">renovatebotOptions</a></code> | <code>projen.RenovatebotOptions</code> | Options for renovatebot. |
|
|
32043
32577
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
|
|
32044
32578
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
|
|
32579
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner to use for executing TypeScript files. |
|
|
32045
32580
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
32046
32581
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.srcdir">srcdir</a></code> | <code>string</code> | Typescript sources directory. |
|
|
32047
32582
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
@@ -32459,6 +32994,19 @@ The version of Bun to use if using Bun as a package manager.
|
|
|
32459
32994
|
|
|
32460
32995
|
---
|
|
32461
32996
|
|
|
32997
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.checkGhaExpressions"></a>
|
|
32998
|
+
|
|
32999
|
+
```typescript
|
|
33000
|
+
public readonly checkGhaExpressions: boolean;
|
|
33001
|
+
```
|
|
33002
|
+
|
|
33003
|
+
- *Type:* boolean
|
|
33004
|
+
- *Default:* true
|
|
33005
|
+
|
|
33006
|
+
Enable GitHub Actions expressions validation.
|
|
33007
|
+
|
|
33008
|
+
---
|
|
33009
|
+
|
|
32462
33010
|
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.checkLicenses"></a>
|
|
32463
33011
|
|
|
32464
33012
|
```typescript
|
|
@@ -33854,6 +34402,22 @@ If the package.json for your package is not in the root directory (for example i
|
|
|
33854
34402
|
|
|
33855
34403
|
---
|
|
33856
34404
|
|
|
34405
|
+
##### `runner`<sup>Optional</sup> <a name="runner" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.runner"></a>
|
|
34406
|
+
|
|
34407
|
+
```typescript
|
|
34408
|
+
public readonly runner: TypeScriptRunner;
|
|
34409
|
+
```
|
|
34410
|
+
|
|
34411
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
34412
|
+
- *Default:* TypeScriptRunner.tsNode()
|
|
34413
|
+
|
|
34414
|
+
The TypeScript runner to use for executing TypeScript files.
|
|
34415
|
+
|
|
34416
|
+
This is a project-level setting that components (e.g. projenrc) will
|
|
34417
|
+
use as their default runner.
|
|
34418
|
+
|
|
34419
|
+
---
|
|
34420
|
+
|
|
33857
34421
|
##### `scopedPackagesOptions`<sup>Optional</sup> <a name="scopedPackagesOptions" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.scopedPackagesOptions"></a>
|
|
33858
34422
|
|
|
33859
34423
|
```typescript
|
|
@@ -34791,6 +35355,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
|
|
|
34791
35355
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
|
34792
35356
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.renovatebotOptions">renovatebotOptions</a></code> | <code>projen.RenovatebotOptions</code> | Options for renovatebot. |
|
|
34793
35357
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
|
|
35358
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner to use for executing TypeScript files. |
|
|
34794
35359
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.sampleCode">sampleCode</a></code> | <code>boolean</code> | Generate one-time sample in `src/` and `test/` if there are no files there. |
|
|
34795
35360
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
34796
35361
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.srcdir">srcdir</a></code> | <code>string</code> | Typescript sources directory. |
|
|
@@ -36556,6 +37121,22 @@ See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
|
|
|
36556
37121
|
|
|
36557
37122
|
---
|
|
36558
37123
|
|
|
37124
|
+
##### `runner`<sup>Optional</sup> <a name="runner" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.runner"></a>
|
|
37125
|
+
|
|
37126
|
+
```typescript
|
|
37127
|
+
public readonly runner: TypeScriptRunner;
|
|
37128
|
+
```
|
|
37129
|
+
|
|
37130
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
37131
|
+
- *Default:* TypeScriptRunner.tsNode()
|
|
37132
|
+
|
|
37133
|
+
The TypeScript runner to use for executing TypeScript files.
|
|
37134
|
+
|
|
37135
|
+
This is a project-level setting that components (e.g. projenrc) will
|
|
37136
|
+
use as their default runner.
|
|
37137
|
+
|
|
37138
|
+
---
|
|
37139
|
+
|
|
36559
37140
|
##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.sampleCode"></a>
|
|
36560
37141
|
|
|
36561
37142
|
```typescript
|