cdklabs-projen-project-types 0.6.13 → 0.6.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +857 -578
- package/.yarn/install-state.gz +0 -0
- package/API.md +582 -38
- package/lib/cdk-construct-library-options.d.ts +28 -1
- package/lib/cdk-construct-library-options.js +1 -1
- package/lib/cdk-jsii-options.d.ts +28 -1
- 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.js +1 -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 +28 -1
- package/lib/yarn/monorepo-options.js +1 -1
- package/lib/yarn/monorepo-release-options.d.ts +9 -0
- package/lib/yarn/monorepo-release-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 +28 -1
- package/lib/yarn/typescript-workspace-options.js +1 -1
- package/lib/yarn/typescript-workspace-release.js +1 -1
- package/lib/yarn/typescript-workspace.js +1 -1
- package/package.json +6 -6
package/API.md
CHANGED
|
@@ -14319,12 +14319,13 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
14319
14319
|
| <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. |
|
|
14320
14320
|
| <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. |
|
|
14321
14321
|
| <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. |
|
|
14322
|
-
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
14322
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
|
|
14323
14323
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
14324
14324
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
14325
14325
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
|
|
14326
14326
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
|
|
14327
14327
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
|
|
14328
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
14328
14329
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.constructsVersion">constructsVersion</a></code> | <code>string</code> | Minimum version of the `constructs` library to depend on. |
|
|
14329
14330
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
14330
14331
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -14356,6 +14357,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
14356
14357
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.ghAutoMergeOptions">ghAutoMergeOptions</a></code> | <code>projen.github.AutoQueueOptions</code> | Options for the GitHub auto merge workflow. |
|
|
14357
14358
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
|
|
14358
14359
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
|
|
14360
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
14359
14361
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
|
|
14360
14362
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
|
|
14361
14363
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
|
|
@@ -14455,6 +14457,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
14455
14457
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
14456
14458
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
14457
14459
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
14460
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
14458
14461
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
14459
14462
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.upgradeCdklabsProjenProjectTypes">upgradeCdklabsProjenProjectTypes</a></code> | <code>boolean</code> | Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. |
|
|
14460
14463
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.upgradeRuntimeDepsAsFix">upgradeRuntimeDepsAsFix</a></code> | <code>boolean</code> | Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. |
|
|
@@ -15029,7 +15032,7 @@ public readonly codeCov: boolean;
|
|
|
15029
15032
|
- *Type:* boolean
|
|
15030
15033
|
- *Default:* false
|
|
15031
15034
|
|
|
15032
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
15035
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
15033
15036
|
|
|
15034
15037
|
---
|
|
15035
15038
|
|
|
@@ -15101,6 +15104,21 @@ Emit a compressed version of the assembly.
|
|
|
15101
15104
|
|
|
15102
15105
|
---
|
|
15103
15106
|
|
|
15107
|
+
##### `config`<sup>Optional</sup> <a name="config" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.config"></a>
|
|
15108
|
+
|
|
15109
|
+
```typescript
|
|
15110
|
+
public readonly config: {[ key: string ]: any};
|
|
15111
|
+
```
|
|
15112
|
+
|
|
15113
|
+
- *Type:* {[ key: string ]: any}
|
|
15114
|
+
- *Default:* no package configuration
|
|
15115
|
+
|
|
15116
|
+
Configuration values available to package scripts at runtime.
|
|
15117
|
+
|
|
15118
|
+
Values should be JSON-serializable.
|
|
15119
|
+
|
|
15120
|
+
---
|
|
15121
|
+
|
|
15104
15122
|
##### `constructsVersion`<sup>Optional</sup> <a name="constructsVersion" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.constructsVersion"></a>
|
|
15105
15123
|
|
|
15106
15124
|
```typescript
|
|
@@ -15564,6 +15582,22 @@ Options for GitHub integration.
|
|
|
15564
15582
|
|
|
15565
15583
|
---
|
|
15566
15584
|
|
|
15585
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.githubReleaseLatest"></a>
|
|
15586
|
+
|
|
15587
|
+
```typescript
|
|
15588
|
+
public readonly githubReleaseLatest: boolean;
|
|
15589
|
+
```
|
|
15590
|
+
|
|
15591
|
+
- *Type:* boolean
|
|
15592
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
15593
|
+
|
|
15594
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
15595
|
+
|
|
15596
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
15597
|
+
mark it as latest.
|
|
15598
|
+
|
|
15599
|
+
---
|
|
15600
|
+
|
|
15567
15601
|
##### `gitignore`<sup>Optional</sup> <a name="gitignore" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.gitignore"></a>
|
|
15568
15602
|
|
|
15569
15603
|
```typescript
|
|
@@ -16243,6 +16277,10 @@ public readonly projenCommand: string;
|
|
|
16243
16277
|
|
|
16244
16278
|
The shell command to use in order to run the projen CLI.
|
|
16245
16279
|
|
|
16280
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
16281
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
16282
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
16283
|
+
|
|
16246
16284
|
Can be used to customize in special environments.
|
|
16247
16285
|
|
|
16248
16286
|
---
|
|
@@ -16954,6 +16992,21 @@ Options for ts-jest.
|
|
|
16954
16992
|
|
|
16955
16993
|
---
|
|
16956
16994
|
|
|
16995
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.typecheckTests"></a>
|
|
16996
|
+
|
|
16997
|
+
```typescript
|
|
16998
|
+
public readonly typecheckTests: boolean;
|
|
16999
|
+
```
|
|
17000
|
+
|
|
17001
|
+
- *Type:* boolean
|
|
17002
|
+
- *Default:* false
|
|
17003
|
+
|
|
17004
|
+
Type-check the test suite as part of the `test` task.
|
|
17005
|
+
|
|
17006
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
17007
|
+
|
|
17008
|
+
---
|
|
17009
|
+
|
|
16957
17010
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.typescriptVersion"></a>
|
|
16958
17011
|
|
|
16959
17012
|
```typescript
|
|
@@ -17107,7 +17160,9 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
17107
17160
|
|
|
17108
17161
|
---
|
|
17109
17162
|
|
|
17110
|
-
#####
|
|
17163
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowRunsOn"></a>
|
|
17164
|
+
|
|
17165
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
17111
17166
|
|
|
17112
17167
|
```typescript
|
|
17113
17168
|
public readonly workflowRunsOn: string[];
|
|
@@ -17120,7 +17175,9 @@ Github Runner selection labels.
|
|
|
17120
17175
|
|
|
17121
17176
|
---
|
|
17122
17177
|
|
|
17123
|
-
#####
|
|
17178
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowRunsOnGroup"></a>
|
|
17179
|
+
|
|
17180
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
17124
17181
|
|
|
17125
17182
|
```typescript
|
|
17126
17183
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -17194,12 +17251,13 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
17194
17251
|
| <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. |
|
|
17195
17252
|
| <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. |
|
|
17196
17253
|
| <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. |
|
|
17197
|
-
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
17254
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
|
|
17198
17255
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
17199
17256
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
17200
17257
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
|
|
17201
17258
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
|
|
17202
17259
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
|
|
17260
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
17203
17261
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
17204
17262
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
17205
17263
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
|
|
@@ -17228,6 +17286,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
17228
17286
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.ghAutoMergeOptions">ghAutoMergeOptions</a></code> | <code>projen.github.AutoQueueOptions</code> | Options for the GitHub auto merge workflow. |
|
|
17229
17287
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
|
|
17230
17288
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
|
|
17289
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
17231
17290
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
|
|
17232
17291
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
|
|
17233
17292
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
|
|
@@ -17321,6 +17380,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
17321
17380
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
17322
17381
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
17323
17382
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
17383
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
17324
17384
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
17325
17385
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.upgradeCdklabsProjenProjectTypes">upgradeCdklabsProjenProjectTypes</a></code> | <code>boolean</code> | Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. |
|
|
17326
17386
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.upgradeRuntimeDepsAsFix">upgradeRuntimeDepsAsFix</a></code> | <code>boolean</code> | Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. |
|
|
@@ -17827,7 +17887,7 @@ public readonly codeCov: boolean;
|
|
|
17827
17887
|
- *Type:* boolean
|
|
17828
17888
|
- *Default:* false
|
|
17829
17889
|
|
|
17830
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
17890
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
17831
17891
|
|
|
17832
17892
|
---
|
|
17833
17893
|
|
|
@@ -17899,6 +17959,21 @@ Emit a compressed version of the assembly.
|
|
|
17899
17959
|
|
|
17900
17960
|
---
|
|
17901
17961
|
|
|
17962
|
+
##### `config`<sup>Optional</sup> <a name="config" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.config"></a>
|
|
17963
|
+
|
|
17964
|
+
```typescript
|
|
17965
|
+
public readonly config: {[ key: string ]: any};
|
|
17966
|
+
```
|
|
17967
|
+
|
|
17968
|
+
- *Type:* {[ key: string ]: any}
|
|
17969
|
+
- *Default:* no package configuration
|
|
17970
|
+
|
|
17971
|
+
Configuration values available to package scripts at runtime.
|
|
17972
|
+
|
|
17973
|
+
Values should be JSON-serializable.
|
|
17974
|
+
|
|
17975
|
+
---
|
|
17976
|
+
|
|
17902
17977
|
##### `copyrightOwner`<sup>Optional</sup> <a name="copyrightOwner" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.copyrightOwner"></a>
|
|
17903
17978
|
|
|
17904
17979
|
```typescript
|
|
@@ -18323,6 +18398,22 @@ Options for GitHub integration.
|
|
|
18323
18398
|
|
|
18324
18399
|
---
|
|
18325
18400
|
|
|
18401
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.githubReleaseLatest"></a>
|
|
18402
|
+
|
|
18403
|
+
```typescript
|
|
18404
|
+
public readonly githubReleaseLatest: boolean;
|
|
18405
|
+
```
|
|
18406
|
+
|
|
18407
|
+
- *Type:* boolean
|
|
18408
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
18409
|
+
|
|
18410
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
18411
|
+
|
|
18412
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
18413
|
+
mark it as latest.
|
|
18414
|
+
|
|
18415
|
+
---
|
|
18416
|
+
|
|
18326
18417
|
##### `gitignore`<sup>Optional</sup> <a name="gitignore" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.gitignore"></a>
|
|
18327
18418
|
|
|
18328
18419
|
```typescript
|
|
@@ -18958,6 +19049,10 @@ public readonly projenCommand: string;
|
|
|
18958
19049
|
|
|
18959
19050
|
The shell command to use in order to run the projen CLI.
|
|
18960
19051
|
|
|
19052
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
19053
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
19054
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
19055
|
+
|
|
18961
19056
|
Can be used to customize in special environments.
|
|
18962
19057
|
|
|
18963
19058
|
---
|
|
@@ -19644,6 +19739,21 @@ Options for ts-jest.
|
|
|
19644
19739
|
|
|
19645
19740
|
---
|
|
19646
19741
|
|
|
19742
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.typecheckTests"></a>
|
|
19743
|
+
|
|
19744
|
+
```typescript
|
|
19745
|
+
public readonly typecheckTests: boolean;
|
|
19746
|
+
```
|
|
19747
|
+
|
|
19748
|
+
- *Type:* boolean
|
|
19749
|
+
- *Default:* false
|
|
19750
|
+
|
|
19751
|
+
Type-check the test suite as part of the `test` task.
|
|
19752
|
+
|
|
19753
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
19754
|
+
|
|
19755
|
+
---
|
|
19756
|
+
|
|
19647
19757
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.typescriptVersion"></a>
|
|
19648
19758
|
|
|
19649
19759
|
```typescript
|
|
@@ -19799,7 +19909,9 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
19799
19909
|
|
|
19800
19910
|
---
|
|
19801
19911
|
|
|
19802
|
-
#####
|
|
19912
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowRunsOn"></a>
|
|
19913
|
+
|
|
19914
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
19803
19915
|
|
|
19804
19916
|
```typescript
|
|
19805
19917
|
public readonly workflowRunsOn: string[];
|
|
@@ -19812,7 +19924,9 @@ Github Runner selection labels.
|
|
|
19812
19924
|
|
|
19813
19925
|
---
|
|
19814
19926
|
|
|
19815
|
-
#####
|
|
19927
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowRunsOnGroup"></a>
|
|
19928
|
+
|
|
19929
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
19816
19930
|
|
|
19817
19931
|
```typescript
|
|
19818
19932
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -19888,12 +20002,13 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
19888
20002
|
| <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. |
|
|
19889
20003
|
| <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. |
|
|
19890
20004
|
| <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. |
|
|
19891
|
-
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
20005
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
|
|
19892
20006
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
19893
20007
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
19894
20008
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
|
|
19895
20009
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
|
|
19896
20010
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
|
|
20011
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
19897
20012
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.constructsVersion">constructsVersion</a></code> | <code>string</code> | Minimum version of the `constructs` library to depend on. |
|
|
19898
20013
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
19899
20014
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -19925,6 +20040,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
19925
20040
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.ghAutoMergeOptions">ghAutoMergeOptions</a></code> | <code>projen.github.AutoQueueOptions</code> | Options for the GitHub auto merge workflow. |
|
|
19926
20041
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
|
|
19927
20042
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
|
|
20043
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
19928
20044
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
|
|
19929
20045
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
|
|
19930
20046
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
|
|
@@ -20024,6 +20140,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
20024
20140
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
20025
20141
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
20026
20142
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
20143
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
20027
20144
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
20028
20145
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.upgradeCdklabsProjenProjectTypes">upgradeCdklabsProjenProjectTypes</a></code> | <code>boolean</code> | Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. |
|
|
20029
20146
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.upgradeRuntimeDepsAsFix">upgradeRuntimeDepsAsFix</a></code> | <code>boolean</code> | Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. |
|
|
@@ -20600,7 +20717,7 @@ public readonly codeCov: boolean;
|
|
|
20600
20717
|
- *Type:* boolean
|
|
20601
20718
|
- *Default:* false
|
|
20602
20719
|
|
|
20603
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
20720
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
20604
20721
|
|
|
20605
20722
|
---
|
|
20606
20723
|
|
|
@@ -20672,6 +20789,21 @@ Emit a compressed version of the assembly.
|
|
|
20672
20789
|
|
|
20673
20790
|
---
|
|
20674
20791
|
|
|
20792
|
+
##### `config`<sup>Optional</sup> <a name="config" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.config"></a>
|
|
20793
|
+
|
|
20794
|
+
```typescript
|
|
20795
|
+
public readonly config: {[ key: string ]: any};
|
|
20796
|
+
```
|
|
20797
|
+
|
|
20798
|
+
- *Type:* {[ key: string ]: any}
|
|
20799
|
+
- *Default:* no package configuration
|
|
20800
|
+
|
|
20801
|
+
Configuration values available to package scripts at runtime.
|
|
20802
|
+
|
|
20803
|
+
Values should be JSON-serializable.
|
|
20804
|
+
|
|
20805
|
+
---
|
|
20806
|
+
|
|
20675
20807
|
##### `constructsVersion`<sup>Optional</sup> <a name="constructsVersion" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.constructsVersion"></a>
|
|
20676
20808
|
|
|
20677
20809
|
```typescript
|
|
@@ -21135,6 +21267,22 @@ Options for GitHub integration.
|
|
|
21135
21267
|
|
|
21136
21268
|
---
|
|
21137
21269
|
|
|
21270
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.githubReleaseLatest"></a>
|
|
21271
|
+
|
|
21272
|
+
```typescript
|
|
21273
|
+
public readonly githubReleaseLatest: boolean;
|
|
21274
|
+
```
|
|
21275
|
+
|
|
21276
|
+
- *Type:* boolean
|
|
21277
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
21278
|
+
|
|
21279
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
21280
|
+
|
|
21281
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
21282
|
+
mark it as latest.
|
|
21283
|
+
|
|
21284
|
+
---
|
|
21285
|
+
|
|
21138
21286
|
##### `gitignore`<sup>Optional</sup> <a name="gitignore" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.gitignore"></a>
|
|
21139
21287
|
|
|
21140
21288
|
```typescript
|
|
@@ -21814,6 +21962,10 @@ public readonly projenCommand: string;
|
|
|
21814
21962
|
|
|
21815
21963
|
The shell command to use in order to run the projen CLI.
|
|
21816
21964
|
|
|
21965
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
21966
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
21967
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
21968
|
+
|
|
21817
21969
|
Can be used to customize in special environments.
|
|
21818
21970
|
|
|
21819
21971
|
---
|
|
@@ -22525,6 +22677,21 @@ Options for ts-jest.
|
|
|
22525
22677
|
|
|
22526
22678
|
---
|
|
22527
22679
|
|
|
22680
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.typecheckTests"></a>
|
|
22681
|
+
|
|
22682
|
+
```typescript
|
|
22683
|
+
public readonly typecheckTests: boolean;
|
|
22684
|
+
```
|
|
22685
|
+
|
|
22686
|
+
- *Type:* boolean
|
|
22687
|
+
- *Default:* false
|
|
22688
|
+
|
|
22689
|
+
Type-check the test suite as part of the `test` task.
|
|
22690
|
+
|
|
22691
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
22692
|
+
|
|
22693
|
+
---
|
|
22694
|
+
|
|
22528
22695
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.typescriptVersion"></a>
|
|
22529
22696
|
|
|
22530
22697
|
```typescript
|
|
@@ -22678,7 +22845,9 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
22678
22845
|
|
|
22679
22846
|
---
|
|
22680
22847
|
|
|
22681
|
-
#####
|
|
22848
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowRunsOn"></a>
|
|
22849
|
+
|
|
22850
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
22682
22851
|
|
|
22683
22852
|
```typescript
|
|
22684
22853
|
public readonly workflowRunsOn: string[];
|
|
@@ -22691,7 +22860,9 @@ Github Runner selection labels.
|
|
|
22691
22860
|
|
|
22692
22861
|
---
|
|
22693
22862
|
|
|
22694
|
-
#####
|
|
22863
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowRunsOnGroup"></a>
|
|
22864
|
+
|
|
22865
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
22695
22866
|
|
|
22696
22867
|
```typescript
|
|
22697
22868
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -22802,12 +22973,13 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
22802
22973
|
| <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. |
|
|
22803
22974
|
| <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. |
|
|
22804
22975
|
| <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. |
|
|
22805
|
-
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
22976
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
|
|
22806
22977
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
22807
22978
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
22808
22979
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
|
|
22809
22980
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
|
|
22810
22981
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
|
|
22982
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
22811
22983
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
22812
22984
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
22813
22985
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
|
|
@@ -22836,6 +23008,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
22836
23008
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.ghAutoMergeOptions">ghAutoMergeOptions</a></code> | <code>projen.github.AutoQueueOptions</code> | Options for the GitHub auto merge workflow. |
|
|
22837
23009
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
|
|
22838
23010
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
|
|
23011
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
22839
23012
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
|
|
22840
23013
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
|
|
22841
23014
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
|
|
@@ -22929,6 +23102,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
22929
23102
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
22930
23103
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
22931
23104
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
23105
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
22932
23106
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
22933
23107
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.upgradeCdklabsProjenProjectTypes">upgradeCdklabsProjenProjectTypes</a></code> | <code>boolean</code> | Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. |
|
|
22934
23108
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.upgradeRuntimeDepsAsFix">upgradeRuntimeDepsAsFix</a></code> | <code>boolean</code> | Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. |
|
|
@@ -23437,7 +23611,7 @@ public readonly codeCov: boolean;
|
|
|
23437
23611
|
- *Type:* boolean
|
|
23438
23612
|
- *Default:* false
|
|
23439
23613
|
|
|
23440
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
23614
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
23441
23615
|
|
|
23442
23616
|
---
|
|
23443
23617
|
|
|
@@ -23509,6 +23683,21 @@ Emit a compressed version of the assembly.
|
|
|
23509
23683
|
|
|
23510
23684
|
---
|
|
23511
23685
|
|
|
23686
|
+
##### `config`<sup>Optional</sup> <a name="config" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.config"></a>
|
|
23687
|
+
|
|
23688
|
+
```typescript
|
|
23689
|
+
public readonly config: {[ key: string ]: any};
|
|
23690
|
+
```
|
|
23691
|
+
|
|
23692
|
+
- *Type:* {[ key: string ]: any}
|
|
23693
|
+
- *Default:* no package configuration
|
|
23694
|
+
|
|
23695
|
+
Configuration values available to package scripts at runtime.
|
|
23696
|
+
|
|
23697
|
+
Values should be JSON-serializable.
|
|
23698
|
+
|
|
23699
|
+
---
|
|
23700
|
+
|
|
23512
23701
|
##### `copyrightOwner`<sup>Optional</sup> <a name="copyrightOwner" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.copyrightOwner"></a>
|
|
23513
23702
|
|
|
23514
23703
|
```typescript
|
|
@@ -23933,6 +24122,22 @@ Options for GitHub integration.
|
|
|
23933
24122
|
|
|
23934
24123
|
---
|
|
23935
24124
|
|
|
24125
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.githubReleaseLatest"></a>
|
|
24126
|
+
|
|
24127
|
+
```typescript
|
|
24128
|
+
public readonly githubReleaseLatest: boolean;
|
|
24129
|
+
```
|
|
24130
|
+
|
|
24131
|
+
- *Type:* boolean
|
|
24132
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
24133
|
+
|
|
24134
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
24135
|
+
|
|
24136
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
24137
|
+
mark it as latest.
|
|
24138
|
+
|
|
24139
|
+
---
|
|
24140
|
+
|
|
23936
24141
|
##### `gitignore`<sup>Optional</sup> <a name="gitignore" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.gitignore"></a>
|
|
23937
24142
|
|
|
23938
24143
|
```typescript
|
|
@@ -24568,6 +24773,10 @@ public readonly projenCommand: string;
|
|
|
24568
24773
|
|
|
24569
24774
|
The shell command to use in order to run the projen CLI.
|
|
24570
24775
|
|
|
24776
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
24777
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
24778
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
24779
|
+
|
|
24571
24780
|
Can be used to customize in special environments.
|
|
24572
24781
|
|
|
24573
24782
|
---
|
|
@@ -25254,6 +25463,21 @@ Options for ts-jest.
|
|
|
25254
25463
|
|
|
25255
25464
|
---
|
|
25256
25465
|
|
|
25466
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.typecheckTests"></a>
|
|
25467
|
+
|
|
25468
|
+
```typescript
|
|
25469
|
+
public readonly typecheckTests: boolean;
|
|
25470
|
+
```
|
|
25471
|
+
|
|
25472
|
+
- *Type:* boolean
|
|
25473
|
+
- *Default:* false
|
|
25474
|
+
|
|
25475
|
+
Type-check the test suite as part of the `test` task.
|
|
25476
|
+
|
|
25477
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
25478
|
+
|
|
25479
|
+
---
|
|
25480
|
+
|
|
25257
25481
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.typescriptVersion"></a>
|
|
25258
25482
|
|
|
25259
25483
|
```typescript
|
|
@@ -25409,7 +25633,9 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
25409
25633
|
|
|
25410
25634
|
---
|
|
25411
25635
|
|
|
25412
|
-
#####
|
|
25636
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowRunsOn"></a>
|
|
25637
|
+
|
|
25638
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
25413
25639
|
|
|
25414
25640
|
```typescript
|
|
25415
25641
|
public readonly workflowRunsOn: string[];
|
|
@@ -25422,7 +25648,9 @@ Github Runner selection labels.
|
|
|
25422
25648
|
|
|
25423
25649
|
---
|
|
25424
25650
|
|
|
25425
|
-
#####
|
|
25651
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowRunsOnGroup"></a>
|
|
25652
|
+
|
|
25653
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
25426
25654
|
|
|
25427
25655
|
```typescript
|
|
25428
25656
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -25535,9 +25763,10 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
25535
25763
|
| <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. |
|
|
25536
25764
|
| <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. |
|
|
25537
25765
|
| <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. |
|
|
25538
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
25766
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
|
|
25539
25767
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
25540
25768
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
25769
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
25541
25770
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.consistentVersions">consistentVersions</a></code> | <code>string[]</code> | Package names that must use a consistent version across all workspaces. |
|
|
25542
25771
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
25543
25772
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -25562,6 +25791,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
25562
25791
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.eslintOptions">eslintOptions</a></code> | <code>projen.javascript.EslintOptions</code> | Eslint options. |
|
|
25563
25792
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
|
|
25564
25793
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
|
|
25794
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
25565
25795
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
|
|
25566
25796
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
|
|
25567
25797
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
|
|
@@ -25643,6 +25873,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
25643
25873
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
25644
25874
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
25645
25875
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
25876
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
25646
25877
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
25647
25878
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
25648
25879
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
|
|
@@ -26153,7 +26384,7 @@ public readonly codeCov: boolean;
|
|
|
26153
26384
|
- *Type:* boolean
|
|
26154
26385
|
- *Default:* false
|
|
26155
26386
|
|
|
26156
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
26387
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
26157
26388
|
|
|
26158
26389
|
---
|
|
26159
26390
|
|
|
@@ -26183,6 +26414,21 @@ Whether to commit the managed files by default.
|
|
|
26183
26414
|
|
|
26184
26415
|
---
|
|
26185
26416
|
|
|
26417
|
+
##### `config`<sup>Optional</sup> <a name="config" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.config"></a>
|
|
26418
|
+
|
|
26419
|
+
```typescript
|
|
26420
|
+
public readonly config: {[ key: string ]: any};
|
|
26421
|
+
```
|
|
26422
|
+
|
|
26423
|
+
- *Type:* {[ key: string ]: any}
|
|
26424
|
+
- *Default:* no package configuration
|
|
26425
|
+
|
|
26426
|
+
Configuration values available to package scripts at runtime.
|
|
26427
|
+
|
|
26428
|
+
Values should be JSON-serializable.
|
|
26429
|
+
|
|
26430
|
+
---
|
|
26431
|
+
|
|
26186
26432
|
##### `consistentVersions`<sup>Optional</sup> <a name="consistentVersions" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.consistentVersions"></a>
|
|
26187
26433
|
|
|
26188
26434
|
```typescript
|
|
@@ -26551,6 +26797,22 @@ Options for GitHub integration.
|
|
|
26551
26797
|
|
|
26552
26798
|
---
|
|
26553
26799
|
|
|
26800
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.githubReleaseLatest"></a>
|
|
26801
|
+
|
|
26802
|
+
```typescript
|
|
26803
|
+
public readonly githubReleaseLatest: boolean;
|
|
26804
|
+
```
|
|
26805
|
+
|
|
26806
|
+
- *Type:* boolean
|
|
26807
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
26808
|
+
|
|
26809
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
26810
|
+
|
|
26811
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
26812
|
+
mark it as latest.
|
|
26813
|
+
|
|
26814
|
+
---
|
|
26815
|
+
|
|
26554
26816
|
##### `gitignore`<sup>Optional</sup> <a name="gitignore" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.gitignore"></a>
|
|
26555
26817
|
|
|
26556
26818
|
```typescript
|
|
@@ -27117,6 +27379,10 @@ public readonly projenCommand: string;
|
|
|
27117
27379
|
|
|
27118
27380
|
The shell command to use in order to run the projen CLI.
|
|
27119
27381
|
|
|
27382
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
27383
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
27384
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
27385
|
+
|
|
27120
27386
|
Can be used to customize in special environments.
|
|
27121
27387
|
|
|
27122
27388
|
---
|
|
@@ -27703,6 +27969,21 @@ Options for ts-jest.
|
|
|
27703
27969
|
|
|
27704
27970
|
---
|
|
27705
27971
|
|
|
27972
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.typecheckTests"></a>
|
|
27973
|
+
|
|
27974
|
+
```typescript
|
|
27975
|
+
public readonly typecheckTests: boolean;
|
|
27976
|
+
```
|
|
27977
|
+
|
|
27978
|
+
- *Type:* boolean
|
|
27979
|
+
- *Default:* false
|
|
27980
|
+
|
|
27981
|
+
Type-check the test suite as part of the `test` task.
|
|
27982
|
+
|
|
27983
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
27984
|
+
|
|
27985
|
+
---
|
|
27986
|
+
|
|
27706
27987
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.typescriptVersion"></a>
|
|
27707
27988
|
|
|
27708
27989
|
```typescript
|
|
@@ -27840,7 +28121,9 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
27840
28121
|
|
|
27841
28122
|
---
|
|
27842
28123
|
|
|
27843
|
-
#####
|
|
28124
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowRunsOn"></a>
|
|
28125
|
+
|
|
28126
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
27844
28127
|
|
|
27845
28128
|
```typescript
|
|
27846
28129
|
public readonly workflowRunsOn: string[];
|
|
@@ -27853,7 +28136,9 @@ Github Runner selection labels.
|
|
|
27853
28136
|
|
|
27854
28137
|
---
|
|
27855
28138
|
|
|
27856
|
-
#####
|
|
28139
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowRunsOnGroup"></a>
|
|
28140
|
+
|
|
28141
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
27857
28142
|
|
|
27858
28143
|
```typescript
|
|
27859
28144
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -28007,6 +28292,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
28007
28292
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
28008
28293
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
28009
28294
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
28295
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
28010
28296
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
|
|
28011
28297
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
|
|
28012
28298
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
@@ -28037,6 +28323,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
28037
28323
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
28038
28324
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
28039
28325
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.bumpPackage">bumpPackage</a></code> | <code>string</code> | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. |
|
|
28326
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
28040
28327
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
|
|
28041
28328
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
28042
28329
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
@@ -28070,7 +28357,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
28070
28357
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
28071
28358
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
28072
28359
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
28073
|
-
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
28360
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. |
|
|
28074
28361
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
28075
28362
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
28076
28363
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -28117,6 +28404,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
28117
28404
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
28118
28405
|
| <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. |
|
|
28119
28406
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
28407
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
28120
28408
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
28121
28409
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
28122
28410
|
| <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. |
|
|
@@ -28247,6 +28535,10 @@ public readonly projenCommand: string;
|
|
|
28247
28535
|
|
|
28248
28536
|
The shell command to use in order to run the projen CLI.
|
|
28249
28537
|
|
|
28538
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
28539
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
28540
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
28541
|
+
|
|
28250
28542
|
Can be used to customize in special environments.
|
|
28251
28543
|
|
|
28252
28544
|
---
|
|
@@ -28712,6 +29004,23 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
28712
29004
|
|
|
28713
29005
|
---
|
|
28714
29006
|
|
|
29007
|
+
##### `config`<sup>Optional</sup> <a name="config" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.config"></a>
|
|
29008
|
+
|
|
29009
|
+
```typescript
|
|
29010
|
+
public readonly config: {[ key: string ]: any};
|
|
29011
|
+
```
|
|
29012
|
+
|
|
29013
|
+
- *Type:* {[ key: string ]: any}
|
|
29014
|
+
- *Default:* no package configuration
|
|
29015
|
+
|
|
29016
|
+
Configuration values available to package scripts at runtime.
|
|
29017
|
+
|
|
29018
|
+
Values should be JSON-serializable.
|
|
29019
|
+
|
|
29020
|
+
> [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config)
|
|
29021
|
+
|
|
29022
|
+
---
|
|
29023
|
+
|
|
28715
29024
|
##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.dedupeDeps"></a>
|
|
28716
29025
|
|
|
28717
29026
|
```typescript
|
|
@@ -29204,6 +29513,22 @@ This can be any compatible package version, including the deprecated `standard-v
|
|
|
29204
29513
|
|
|
29205
29514
|
---
|
|
29206
29515
|
|
|
29516
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.githubReleaseLatest"></a>
|
|
29517
|
+
|
|
29518
|
+
```typescript
|
|
29519
|
+
public readonly githubReleaseLatest: boolean;
|
|
29520
|
+
```
|
|
29521
|
+
|
|
29522
|
+
- *Type:* boolean
|
|
29523
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
29524
|
+
|
|
29525
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
29526
|
+
|
|
29527
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
29528
|
+
mark it as latest.
|
|
29529
|
+
|
|
29530
|
+
---
|
|
29531
|
+
|
|
29207
29532
|
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.jsiiReleaseVersion"></a>
|
|
29208
29533
|
|
|
29209
29534
|
```typescript
|
|
@@ -29531,7 +29856,9 @@ Container image to use for GitHub workflows.
|
|
|
29531
29856
|
|
|
29532
29857
|
---
|
|
29533
29858
|
|
|
29534
|
-
#####
|
|
29859
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.workflowRunsOn"></a>
|
|
29860
|
+
|
|
29861
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
29535
29862
|
|
|
29536
29863
|
```typescript
|
|
29537
29864
|
public readonly workflowRunsOn: string[];
|
|
@@ -29544,7 +29871,9 @@ Github Runner selection labels.
|
|
|
29544
29871
|
|
|
29545
29872
|
---
|
|
29546
29873
|
|
|
29547
|
-
#####
|
|
29874
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.workflowRunsOnGroup"></a>
|
|
29875
|
+
|
|
29876
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
29548
29877
|
|
|
29549
29878
|
```typescript
|
|
29550
29879
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -29701,7 +30030,10 @@ public readonly codeCov: boolean;
|
|
|
29701
30030
|
- *Type:* boolean
|
|
29702
30031
|
- *Default:* false
|
|
29703
30032
|
|
|
29704
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
30033
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/.
|
|
30034
|
+
|
|
30035
|
+
Uses codecov/codecov-action. By default, OIDC auth is used.
|
|
30036
|
+
Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
29705
30037
|
|
|
29706
30038
|
---
|
|
29707
30039
|
|
|
@@ -30325,6 +30657,21 @@ Options for ts-jest.
|
|
|
30325
30657
|
|
|
30326
30658
|
---
|
|
30327
30659
|
|
|
30660
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.typecheckTests"></a>
|
|
30661
|
+
|
|
30662
|
+
```typescript
|
|
30663
|
+
public readonly typecheckTests: boolean;
|
|
30664
|
+
```
|
|
30665
|
+
|
|
30666
|
+
- *Type:* boolean
|
|
30667
|
+
- *Default:* false
|
|
30668
|
+
|
|
30669
|
+
Type-check the test suite as part of the `test` task.
|
|
30670
|
+
|
|
30671
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
30672
|
+
|
|
30673
|
+
---
|
|
30674
|
+
|
|
30328
30675
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.typescriptVersion"></a>
|
|
30329
30676
|
|
|
30330
30677
|
```typescript
|
|
@@ -30505,6 +30852,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
30505
30852
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
30506
30853
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
30507
30854
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
30855
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
30508
30856
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
|
|
30509
30857
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
|
|
30510
30858
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
@@ -30535,6 +30883,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
30535
30883
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
30536
30884
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
30537
30885
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.bumpPackage">bumpPackage</a></code> | <code>string</code> | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. |
|
|
30886
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
30538
30887
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
|
|
30539
30888
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
30540
30889
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
@@ -30568,7 +30917,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
30568
30917
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
30569
30918
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
30570
30919
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
30571
|
-
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
30920
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. |
|
|
30572
30921
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
30573
30922
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
30574
30923
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -30615,6 +30964,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
30615
30964
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
30616
30965
|
| <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. |
|
|
30617
30966
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
30967
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
30618
30968
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
30619
30969
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
30620
30970
|
| <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. |
|
|
@@ -30745,6 +31095,10 @@ public readonly projenCommand: string;
|
|
|
30745
31095
|
|
|
30746
31096
|
The shell command to use in order to run the projen CLI.
|
|
30747
31097
|
|
|
31098
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
31099
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
31100
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
31101
|
+
|
|
30748
31102
|
Can be used to customize in special environments.
|
|
30749
31103
|
|
|
30750
31104
|
---
|
|
@@ -31210,6 +31564,23 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
31210
31564
|
|
|
31211
31565
|
---
|
|
31212
31566
|
|
|
31567
|
+
##### `config`<sup>Optional</sup> <a name="config" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.config"></a>
|
|
31568
|
+
|
|
31569
|
+
```typescript
|
|
31570
|
+
public readonly config: {[ key: string ]: any};
|
|
31571
|
+
```
|
|
31572
|
+
|
|
31573
|
+
- *Type:* {[ key: string ]: any}
|
|
31574
|
+
- *Default:* no package configuration
|
|
31575
|
+
|
|
31576
|
+
Configuration values available to package scripts at runtime.
|
|
31577
|
+
|
|
31578
|
+
Values should be JSON-serializable.
|
|
31579
|
+
|
|
31580
|
+
> [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config)
|
|
31581
|
+
|
|
31582
|
+
---
|
|
31583
|
+
|
|
31213
31584
|
##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.dedupeDeps"></a>
|
|
31214
31585
|
|
|
31215
31586
|
```typescript
|
|
@@ -31702,6 +32073,22 @@ This can be any compatible package version, including the deprecated `standard-v
|
|
|
31702
32073
|
|
|
31703
32074
|
---
|
|
31704
32075
|
|
|
32076
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.githubReleaseLatest"></a>
|
|
32077
|
+
|
|
32078
|
+
```typescript
|
|
32079
|
+
public readonly githubReleaseLatest: boolean;
|
|
32080
|
+
```
|
|
32081
|
+
|
|
32082
|
+
- *Type:* boolean
|
|
32083
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
32084
|
+
|
|
32085
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
32086
|
+
|
|
32087
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
32088
|
+
mark it as latest.
|
|
32089
|
+
|
|
32090
|
+
---
|
|
32091
|
+
|
|
31705
32092
|
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.jsiiReleaseVersion"></a>
|
|
31706
32093
|
|
|
31707
32094
|
```typescript
|
|
@@ -32029,7 +32416,9 @@ Container image to use for GitHub workflows.
|
|
|
32029
32416
|
|
|
32030
32417
|
---
|
|
32031
32418
|
|
|
32032
|
-
#####
|
|
32419
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.workflowRunsOn"></a>
|
|
32420
|
+
|
|
32421
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
32033
32422
|
|
|
32034
32423
|
```typescript
|
|
32035
32424
|
public readonly workflowRunsOn: string[];
|
|
@@ -32042,7 +32431,9 @@ Github Runner selection labels.
|
|
|
32042
32431
|
|
|
32043
32432
|
---
|
|
32044
32433
|
|
|
32045
|
-
#####
|
|
32434
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.workflowRunsOnGroup"></a>
|
|
32435
|
+
|
|
32436
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
32046
32437
|
|
|
32047
32438
|
```typescript
|
|
32048
32439
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -32199,7 +32590,10 @@ public readonly codeCov: boolean;
|
|
|
32199
32590
|
- *Type:* boolean
|
|
32200
32591
|
- *Default:* false
|
|
32201
32592
|
|
|
32202
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
32593
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/.
|
|
32594
|
+
|
|
32595
|
+
Uses codecov/codecov-action. By default, OIDC auth is used.
|
|
32596
|
+
Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
32203
32597
|
|
|
32204
32598
|
---
|
|
32205
32599
|
|
|
@@ -32823,6 +33217,21 @@ Options for ts-jest.
|
|
|
32823
33217
|
|
|
32824
33218
|
---
|
|
32825
33219
|
|
|
33220
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.typecheckTests"></a>
|
|
33221
|
+
|
|
33222
|
+
```typescript
|
|
33223
|
+
public readonly typecheckTests: boolean;
|
|
33224
|
+
```
|
|
33225
|
+
|
|
33226
|
+
- *Type:* boolean
|
|
33227
|
+
- *Default:* false
|
|
33228
|
+
|
|
33229
|
+
Type-check the test suite as part of the `test` task.
|
|
33230
|
+
|
|
33231
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
33232
|
+
|
|
33233
|
+
---
|
|
33234
|
+
|
|
32826
33235
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.typescriptVersion"></a>
|
|
32827
33236
|
|
|
32828
33237
|
```typescript
|
|
@@ -33358,9 +33767,10 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
33358
33767
|
| <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. |
|
|
33359
33768
|
| <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. |
|
|
33360
33769
|
| <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. |
|
|
33361
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
33770
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
|
|
33362
33771
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
33363
33772
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
33773
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
33364
33774
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.consistentVersions">consistentVersions</a></code> | <code>string[]</code> | Package names that must use a consistent version across all workspaces. |
|
|
33365
33775
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
33366
33776
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -33385,6 +33795,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
33385
33795
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.eslintOptions">eslintOptions</a></code> | <code>projen.javascript.EslintOptions</code> | Eslint options. |
|
|
33386
33796
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
|
|
33387
33797
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
|
|
33798
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
33388
33799
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
|
|
33389
33800
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
|
|
33390
33801
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
|
|
@@ -33466,6 +33877,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
33466
33877
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
33467
33878
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
33468
33879
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
33880
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
33469
33881
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
33470
33882
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
33471
33883
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
|
|
@@ -33976,7 +34388,7 @@ public readonly codeCov: boolean;
|
|
|
33976
34388
|
- *Type:* boolean
|
|
33977
34389
|
- *Default:* false
|
|
33978
34390
|
|
|
33979
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
34391
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
33980
34392
|
|
|
33981
34393
|
---
|
|
33982
34394
|
|
|
@@ -34006,6 +34418,21 @@ Whether to commit the managed files by default.
|
|
|
34006
34418
|
|
|
34007
34419
|
---
|
|
34008
34420
|
|
|
34421
|
+
##### `config`<sup>Optional</sup> <a name="config" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.config"></a>
|
|
34422
|
+
|
|
34423
|
+
```typescript
|
|
34424
|
+
public readonly config: {[ key: string ]: any};
|
|
34425
|
+
```
|
|
34426
|
+
|
|
34427
|
+
- *Type:* {[ key: string ]: any}
|
|
34428
|
+
- *Default:* no package configuration
|
|
34429
|
+
|
|
34430
|
+
Configuration values available to package scripts at runtime.
|
|
34431
|
+
|
|
34432
|
+
Values should be JSON-serializable.
|
|
34433
|
+
|
|
34434
|
+
---
|
|
34435
|
+
|
|
34009
34436
|
##### `consistentVersions`<sup>Optional</sup> <a name="consistentVersions" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.consistentVersions"></a>
|
|
34010
34437
|
|
|
34011
34438
|
```typescript
|
|
@@ -34374,6 +34801,22 @@ Options for GitHub integration.
|
|
|
34374
34801
|
|
|
34375
34802
|
---
|
|
34376
34803
|
|
|
34804
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.githubReleaseLatest"></a>
|
|
34805
|
+
|
|
34806
|
+
```typescript
|
|
34807
|
+
public readonly githubReleaseLatest: boolean;
|
|
34808
|
+
```
|
|
34809
|
+
|
|
34810
|
+
- *Type:* boolean
|
|
34811
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
34812
|
+
|
|
34813
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
34814
|
+
|
|
34815
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
34816
|
+
mark it as latest.
|
|
34817
|
+
|
|
34818
|
+
---
|
|
34819
|
+
|
|
34377
34820
|
##### `gitignore`<sup>Optional</sup> <a name="gitignore" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.gitignore"></a>
|
|
34378
34821
|
|
|
34379
34822
|
```typescript
|
|
@@ -34940,6 +35383,10 @@ public readonly projenCommand: string;
|
|
|
34940
35383
|
|
|
34941
35384
|
The shell command to use in order to run the projen CLI.
|
|
34942
35385
|
|
|
35386
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
35387
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
35388
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
35389
|
+
|
|
34943
35390
|
Can be used to customize in special environments.
|
|
34944
35391
|
|
|
34945
35392
|
---
|
|
@@ -35526,6 +35973,21 @@ Options for ts-jest.
|
|
|
35526
35973
|
|
|
35527
35974
|
---
|
|
35528
35975
|
|
|
35976
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.typecheckTests"></a>
|
|
35977
|
+
|
|
35978
|
+
```typescript
|
|
35979
|
+
public readonly typecheckTests: boolean;
|
|
35980
|
+
```
|
|
35981
|
+
|
|
35982
|
+
- *Type:* boolean
|
|
35983
|
+
- *Default:* false
|
|
35984
|
+
|
|
35985
|
+
Type-check the test suite as part of the `test` task.
|
|
35986
|
+
|
|
35987
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
35988
|
+
|
|
35989
|
+
---
|
|
35990
|
+
|
|
35529
35991
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.typescriptVersion"></a>
|
|
35530
35992
|
|
|
35531
35993
|
```typescript
|
|
@@ -35663,7 +36125,9 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
35663
36125
|
|
|
35664
36126
|
---
|
|
35665
36127
|
|
|
35666
|
-
#####
|
|
36128
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowRunsOn"></a>
|
|
36129
|
+
|
|
36130
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
35667
36131
|
|
|
35668
36132
|
```typescript
|
|
35669
36133
|
public readonly workflowRunsOn: string[];
|
|
@@ -35676,7 +36140,9 @@ Github Runner selection labels.
|
|
|
35676
36140
|
|
|
35677
36141
|
---
|
|
35678
36142
|
|
|
35679
|
-
#####
|
|
36143
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowRunsOnGroup"></a>
|
|
36144
|
+
|
|
36145
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
35680
36146
|
|
|
35681
36147
|
```typescript
|
|
35682
36148
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -35737,6 +36203,7 @@ const monorepoReleaseOptions: yarn.MonorepoReleaseOptions = { ... }
|
|
|
35737
36203
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.branchName">branchName</a></code> | <code>string</code> | Branch name to release from. |
|
|
35738
36204
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.buildWithNx">buildWithNx</a></code> | <code>boolean</code> | Build the monorepo using Nx during the release. |
|
|
35739
36205
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.bumpPackage">bumpPackage</a></code> | <code>string</code> | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. |
|
|
36206
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
35740
36207
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
|
|
35741
36208
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
35742
36209
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
@@ -35803,6 +36270,22 @@ This can be any compatible package version, including the deprecated `standard-v
|
|
|
35803
36270
|
|
|
35804
36271
|
---
|
|
35805
36272
|
|
|
36273
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.githubReleaseLatest"></a>
|
|
36274
|
+
|
|
36275
|
+
```typescript
|
|
36276
|
+
public readonly githubReleaseLatest: boolean;
|
|
36277
|
+
```
|
|
36278
|
+
|
|
36279
|
+
- *Type:* boolean
|
|
36280
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
36281
|
+
|
|
36282
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
36283
|
+
|
|
36284
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
36285
|
+
mark it as latest.
|
|
36286
|
+
|
|
36287
|
+
---
|
|
36288
|
+
|
|
35806
36289
|
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.jsiiReleaseVersion"></a>
|
|
35807
36290
|
|
|
35808
36291
|
```typescript
|
|
@@ -36059,7 +36542,9 @@ Container image to use for GitHub workflows.
|
|
|
36059
36542
|
|
|
36060
36543
|
---
|
|
36061
36544
|
|
|
36062
|
-
#####
|
|
36545
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.workflowRunsOn"></a>
|
|
36546
|
+
|
|
36547
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
36063
36548
|
|
|
36064
36549
|
```typescript
|
|
36065
36550
|
public readonly workflowRunsOn: string[];
|
|
@@ -36072,7 +36557,9 @@ Github Runner selection labels.
|
|
|
36072
36557
|
|
|
36073
36558
|
---
|
|
36074
36559
|
|
|
36075
|
-
#####
|
|
36560
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.workflowRunsOnGroup"></a>
|
|
36561
|
+
|
|
36562
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
36076
36563
|
|
|
36077
36564
|
```typescript
|
|
36078
36565
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -36229,9 +36716,10 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
|
|
|
36229
36716
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
36230
36717
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
36231
36718
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
36232
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
36719
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
|
|
36233
36720
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
36234
36721
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
36722
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
36235
36723
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
36236
36724
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
36237
36725
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
|
|
@@ -36255,6 +36743,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
|
|
|
36255
36743
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.excludeDepsFromUpgrade">excludeDepsFromUpgrade</a></code> | <code>string[]</code> | Dependencies that should be excluded from upgrades. |
|
|
36256
36744
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
|
|
36257
36745
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
|
|
36746
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
36258
36747
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
|
|
36259
36748
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
|
|
36260
36749
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
|
|
@@ -36336,6 +36825,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
|
|
|
36336
36825
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
36337
36826
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
36338
36827
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
36828
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
36339
36829
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
36340
36830
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
36341
36831
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
|
|
@@ -36816,7 +37306,7 @@ public readonly codeCov: boolean;
|
|
|
36816
37306
|
- *Type:* boolean
|
|
36817
37307
|
- *Default:* false
|
|
36818
37308
|
|
|
36819
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
37309
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
36820
37310
|
|
|
36821
37311
|
---
|
|
36822
37312
|
|
|
@@ -36846,6 +37336,21 @@ Whether to commit the managed files by default.
|
|
|
36846
37336
|
|
|
36847
37337
|
---
|
|
36848
37338
|
|
|
37339
|
+
##### `config`<sup>Optional</sup> <a name="config" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.config"></a>
|
|
37340
|
+
|
|
37341
|
+
```typescript
|
|
37342
|
+
public readonly config: {[ key: string ]: any};
|
|
37343
|
+
```
|
|
37344
|
+
|
|
37345
|
+
- *Type:* {[ key: string ]: any}
|
|
37346
|
+
- *Default:* no package configuration
|
|
37347
|
+
|
|
37348
|
+
Configuration values available to package scripts at runtime.
|
|
37349
|
+
|
|
37350
|
+
Values should be JSON-serializable.
|
|
37351
|
+
|
|
37352
|
+
---
|
|
37353
|
+
|
|
36849
37354
|
##### `copyrightOwner`<sup>Optional</sup> <a name="copyrightOwner" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.copyrightOwner"></a>
|
|
36850
37355
|
|
|
36851
37356
|
```typescript
|
|
@@ -37198,6 +37703,22 @@ Options for GitHub integration.
|
|
|
37198
37703
|
|
|
37199
37704
|
---
|
|
37200
37705
|
|
|
37706
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.githubReleaseLatest"></a>
|
|
37707
|
+
|
|
37708
|
+
```typescript
|
|
37709
|
+
public readonly githubReleaseLatest: boolean;
|
|
37710
|
+
```
|
|
37711
|
+
|
|
37712
|
+
- *Type:* boolean
|
|
37713
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
37714
|
+
|
|
37715
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
37716
|
+
|
|
37717
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
37718
|
+
mark it as latest.
|
|
37719
|
+
|
|
37720
|
+
---
|
|
37721
|
+
|
|
37201
37722
|
##### `gitignore`<sup>Optional</sup> <a name="gitignore" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.gitignore"></a>
|
|
37202
37723
|
|
|
37203
37724
|
```typescript
|
|
@@ -37786,6 +38307,10 @@ public readonly projenCommand: string;
|
|
|
37786
38307
|
|
|
37787
38308
|
The shell command to use in order to run the projen CLI.
|
|
37788
38309
|
|
|
38310
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
38311
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
38312
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
38313
|
+
|
|
37789
38314
|
Can be used to customize in special environments.
|
|
37790
38315
|
|
|
37791
38316
|
---
|
|
@@ -38348,6 +38873,21 @@ Options for ts-jest.
|
|
|
38348
38873
|
|
|
38349
38874
|
---
|
|
38350
38875
|
|
|
38876
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.typecheckTests"></a>
|
|
38877
|
+
|
|
38878
|
+
```typescript
|
|
38879
|
+
public readonly typecheckTests: boolean;
|
|
38880
|
+
```
|
|
38881
|
+
|
|
38882
|
+
- *Type:* boolean
|
|
38883
|
+
- *Default:* false
|
|
38884
|
+
|
|
38885
|
+
Type-check the test suite as part of the `test` task.
|
|
38886
|
+
|
|
38887
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
38888
|
+
|
|
38889
|
+
---
|
|
38890
|
+
|
|
38351
38891
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.typescriptVersion"></a>
|
|
38352
38892
|
|
|
38353
38893
|
```typescript
|
|
@@ -38459,7 +38999,9 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
38459
38999
|
|
|
38460
39000
|
---
|
|
38461
39001
|
|
|
38462
|
-
#####
|
|
39002
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowRunsOn"></a>
|
|
39003
|
+
|
|
39004
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
38463
39005
|
|
|
38464
39006
|
```typescript
|
|
38465
39007
|
public readonly workflowRunsOn: string[];
|
|
@@ -38472,7 +39014,9 @@ Github Runner selection labels.
|
|
|
38472
39014
|
|
|
38473
39015
|
---
|
|
38474
39016
|
|
|
38475
|
-
#####
|
|
39017
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowRunsOnGroup"></a>
|
|
39018
|
+
|
|
39019
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
38476
39020
|
|
|
38477
39021
|
```typescript
|
|
38478
39022
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|