@taimos/projen 0.1.89 → 0.1.91
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 +7 -4
- package/API.md +812 -32
- package/lib/components/amplify-deploy.js +1 -1
- package/lib/components/gitleaks.js +1 -1
- package/lib/components/production-release.js +1 -1
- package/lib/projects/api-library.js +1 -1
- package/lib/projects/cdk-app.js +1 -1
- package/lib/projects/cdk-construct.js +1 -1
- package/lib/projects/monorepo.js +1 -1
- package/lib/projects/private-cdk-app.js +1 -1
- package/lib/projects/private-ts-lib.js +1 -1
- package/lib/projects/prod-cdk-app.js +1 -1
- package/lib/projects/ts-lib.js +1 -1
- package/package.json +6 -6
package/API.md
CHANGED
|
@@ -13219,6 +13219,8 @@ const monorepoProjectOptions: MonorepoProjectOptions = { ... }
|
|
|
13219
13219
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
13220
13220
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
13221
13221
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
13222
|
+
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
13223
|
+
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
|
|
13222
13224
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
|
|
13223
13225
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
13224
13226
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
@@ -13248,6 +13250,7 @@ const monorepoProjectOptions: MonorepoProjectOptions = { ... }
|
|
|
13248
13250
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
13249
13251
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
13250
13252
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.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. |
|
|
13253
|
+
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
13251
13254
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
|
|
13252
13255
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
13253
13256
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
@@ -13281,7 +13284,7 @@ const monorepoProjectOptions: MonorepoProjectOptions = { ... }
|
|
|
13281
13284
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
13282
13285
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
13283
13286
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
13284
|
-
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
13287
|
+
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. |
|
|
13285
13288
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
13286
13289
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
13287
13290
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -13328,6 +13331,7 @@ const monorepoProjectOptions: MonorepoProjectOptions = { ... }
|
|
|
13328
13331
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
13329
13332
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
13330
13333
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
13334
|
+
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
13331
13335
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
13332
13336
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.amplifyApps">amplifyApps</a></code> | <code><a href="#@taimos/projen.MonorepoAmplifyApp">MonorepoAmplifyApp</a>[]</code> | AWS Amplify Hosting applications. |
|
|
13333
13337
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.amplifyDeployOptions">amplifyDeployOptions</a></code> | <code><a href="#@taimos/projen.GitHubAmplifyDeployOptions">GitHubAmplifyDeployOptions</a></code> | Drive Amplify Hosting builds from GitHub Actions instead of Amplify's own auto-build, so an app only rebuilds when the packages it is built from actually changed (see `GitHubAmplifyDeploy`). |
|
|
@@ -13464,6 +13468,10 @@ public readonly projenCommand: string;
|
|
|
13464
13468
|
|
|
13465
13469
|
The shell command to use in order to run the projen CLI.
|
|
13466
13470
|
|
|
13471
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
13472
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
13473
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
13474
|
+
|
|
13467
13475
|
Can be used to customize in special environments.
|
|
13468
13476
|
|
|
13469
13477
|
---
|
|
@@ -13929,6 +13937,51 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
13929
13937
|
|
|
13930
13938
|
---
|
|
13931
13939
|
|
|
13940
|
+
##### `config`<sup>Optional</sup> <a name="config" id="@taimos/projen.MonorepoProjectOptions.property.config"></a>
|
|
13941
|
+
|
|
13942
|
+
```typescript
|
|
13943
|
+
public readonly config: {[ key: string ]: any};
|
|
13944
|
+
```
|
|
13945
|
+
|
|
13946
|
+
- *Type:* {[ key: string ]: any}
|
|
13947
|
+
- *Default:* no package configuration
|
|
13948
|
+
|
|
13949
|
+
Configuration values available to package scripts at runtime.
|
|
13950
|
+
|
|
13951
|
+
Values should be JSON-serializable.
|
|
13952
|
+
|
|
13953
|
+
> [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config)
|
|
13954
|
+
|
|
13955
|
+
---
|
|
13956
|
+
|
|
13957
|
+
##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="@taimos/projen.MonorepoProjectOptions.property.dedupeDeps"></a>
|
|
13958
|
+
|
|
13959
|
+
```typescript
|
|
13960
|
+
public readonly dedupeDeps: boolean;
|
|
13961
|
+
```
|
|
13962
|
+
|
|
13963
|
+
- *Type:* boolean
|
|
13964
|
+
- *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
|
|
13965
|
+
|
|
13966
|
+
Add a `dedupe` task that deduplicates project dependencies.
|
|
13967
|
+
|
|
13968
|
+
Deduplication prevents multiple versions of the same package from being
|
|
13969
|
+
installed, if a single version can satisfy all requested version ranges.
|
|
13970
|
+
This prevents version proliferation and reduces the size of the dependency
|
|
13971
|
+
tree.
|
|
13972
|
+
|
|
13973
|
+
The behavior depends on the package manager:
|
|
13974
|
+
- npm: runs `npm dedupe` after every mutating install.
|
|
13975
|
+
- pnpm: runs `pnpm dedupe` after every mutating install.
|
|
13976
|
+
- Yarn Berry: runs `yarn dedupe` after every mutating install. If
|
|
13977
|
+
`yarnBerryOptions.dedupePackages` is set, only the listed packages are
|
|
13978
|
+
deduplicated.
|
|
13979
|
+
- Yarn Classic: `yarn install` already deduplicates, so the task only
|
|
13980
|
+
prints an informational message.
|
|
13981
|
+
- Bun: not supported, enabling this option throws an error.
|
|
13982
|
+
|
|
13983
|
+
---
|
|
13984
|
+
|
|
13932
13985
|
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="@taimos/projen.MonorepoProjectOptions.property.deleteOrphanedLockFiles"></a>
|
|
13933
13986
|
|
|
13934
13987
|
```typescript
|
|
@@ -14393,6 +14446,22 @@ This can be any compatible package version, including the deprecated `standard-v
|
|
|
14393
14446
|
|
|
14394
14447
|
---
|
|
14395
14448
|
|
|
14449
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="@taimos/projen.MonorepoProjectOptions.property.githubReleaseLatest"></a>
|
|
14450
|
+
|
|
14451
|
+
```typescript
|
|
14452
|
+
public readonly githubReleaseLatest: boolean;
|
|
14453
|
+
```
|
|
14454
|
+
|
|
14455
|
+
- *Type:* boolean
|
|
14456
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
14457
|
+
|
|
14458
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
14459
|
+
|
|
14460
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
14461
|
+
mark it as latest.
|
|
14462
|
+
|
|
14463
|
+
---
|
|
14464
|
+
|
|
14396
14465
|
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="@taimos/projen.MonorepoProjectOptions.property.jsiiReleaseVersion"></a>
|
|
14397
14466
|
|
|
14398
14467
|
```typescript
|
|
@@ -14720,7 +14789,9 @@ Container image to use for GitHub workflows.
|
|
|
14720
14789
|
|
|
14721
14790
|
---
|
|
14722
14791
|
|
|
14723
|
-
#####
|
|
14792
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="@taimos/projen.MonorepoProjectOptions.property.workflowRunsOn"></a>
|
|
14793
|
+
|
|
14794
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
14724
14795
|
|
|
14725
14796
|
```typescript
|
|
14726
14797
|
public readonly workflowRunsOn: string[];
|
|
@@ -14733,7 +14804,9 @@ Github Runner selection labels.
|
|
|
14733
14804
|
|
|
14734
14805
|
---
|
|
14735
14806
|
|
|
14736
|
-
#####
|
|
14807
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@taimos/projen.MonorepoProjectOptions.property.workflowRunsOnGroup"></a>
|
|
14808
|
+
|
|
14809
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
14737
14810
|
|
|
14738
14811
|
```typescript
|
|
14739
14812
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -14890,7 +14963,10 @@ public readonly codeCov: boolean;
|
|
|
14890
14963
|
- *Type:* boolean
|
|
14891
14964
|
- *Default:* false
|
|
14892
14965
|
|
|
14893
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
14966
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/.
|
|
14967
|
+
|
|
14968
|
+
Uses codecov/codecov-action. By default, OIDC auth is used.
|
|
14969
|
+
Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
14894
14970
|
|
|
14895
14971
|
---
|
|
14896
14972
|
|
|
@@ -15372,6 +15448,11 @@ public readonly libdir: string;
|
|
|
15372
15448
|
|
|
15373
15449
|
Typescript artifacts output directory.
|
|
15374
15450
|
|
|
15451
|
+
When `libdir` is changed, set `entrypoint` to match it (for example
|
|
15452
|
+
`libdir: "dist"` with `entrypoint: "dist/index.js"`). `types` follows the
|
|
15453
|
+
entrypoint rather than `libdir`, and `main` still defaults to
|
|
15454
|
+
`lib/index.js`.
|
|
15455
|
+
|
|
15375
15456
|
---
|
|
15376
15457
|
|
|
15377
15458
|
##### `projenrcTs`<sup>Optional</sup> <a name="projenrcTs" id="@taimos/projen.MonorepoProjectOptions.property.projenrcTs"></a>
|
|
@@ -15514,6 +15595,21 @@ Options for ts-jest.
|
|
|
15514
15595
|
|
|
15515
15596
|
---
|
|
15516
15597
|
|
|
15598
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="@taimos/projen.MonorepoProjectOptions.property.typecheckTests"></a>
|
|
15599
|
+
|
|
15600
|
+
```typescript
|
|
15601
|
+
public readonly typecheckTests: boolean;
|
|
15602
|
+
```
|
|
15603
|
+
|
|
15604
|
+
- *Type:* boolean
|
|
15605
|
+
- *Default:* false
|
|
15606
|
+
|
|
15607
|
+
Type-check the test suite as part of the `test` task.
|
|
15608
|
+
|
|
15609
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
15610
|
+
|
|
15611
|
+
---
|
|
15612
|
+
|
|
15517
15613
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="@taimos/projen.MonorepoProjectOptions.property.typescriptVersion"></a>
|
|
15518
15614
|
|
|
15519
15615
|
```typescript
|
|
@@ -15891,6 +15987,8 @@ const privateTaimosCdkAppOptions: PrivateTaimosCdkAppOptions = { ... }
|
|
|
15891
15987
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
15892
15988
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
15893
15989
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
15990
|
+
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
15991
|
+
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
|
|
15894
15992
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
|
|
15895
15993
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
15896
15994
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
@@ -15920,6 +16018,7 @@ const privateTaimosCdkAppOptions: PrivateTaimosCdkAppOptions = { ... }
|
|
|
15920
16018
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
15921
16019
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
15922
16020
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.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. |
|
|
16021
|
+
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
15923
16022
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
|
|
15924
16023
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
15925
16024
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
@@ -15953,7 +16052,7 @@ const privateTaimosCdkAppOptions: PrivateTaimosCdkAppOptions = { ... }
|
|
|
15953
16052
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
15954
16053
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
15955
16054
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
15956
|
-
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
16055
|
+
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. |
|
|
15957
16056
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
15958
16057
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
15959
16058
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -16000,6 +16099,7 @@ const privateTaimosCdkAppOptions: PrivateTaimosCdkAppOptions = { ... }
|
|
|
16000
16099
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
16001
16100
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
16002
16101
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
16102
|
+
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
16003
16103
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
16004
16104
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.buildCommand">buildCommand</a></code> | <code>string</code> | A command to execute before synthesis. |
|
|
16005
16105
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.cdkout">cdkout</a></code> | <code>string</code> | cdk.out directory. |
|
|
@@ -16144,6 +16244,10 @@ public readonly projenCommand: string;
|
|
|
16144
16244
|
|
|
16145
16245
|
The shell command to use in order to run the projen CLI.
|
|
16146
16246
|
|
|
16247
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
16248
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
16249
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
16250
|
+
|
|
16147
16251
|
Can be used to customize in special environments.
|
|
16148
16252
|
|
|
16149
16253
|
---
|
|
@@ -16609,6 +16713,51 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
16609
16713
|
|
|
16610
16714
|
---
|
|
16611
16715
|
|
|
16716
|
+
##### `config`<sup>Optional</sup> <a name="config" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.config"></a>
|
|
16717
|
+
|
|
16718
|
+
```typescript
|
|
16719
|
+
public readonly config: {[ key: string ]: any};
|
|
16720
|
+
```
|
|
16721
|
+
|
|
16722
|
+
- *Type:* {[ key: string ]: any}
|
|
16723
|
+
- *Default:* no package configuration
|
|
16724
|
+
|
|
16725
|
+
Configuration values available to package scripts at runtime.
|
|
16726
|
+
|
|
16727
|
+
Values should be JSON-serializable.
|
|
16728
|
+
|
|
16729
|
+
> [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config)
|
|
16730
|
+
|
|
16731
|
+
---
|
|
16732
|
+
|
|
16733
|
+
##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.dedupeDeps"></a>
|
|
16734
|
+
|
|
16735
|
+
```typescript
|
|
16736
|
+
public readonly dedupeDeps: boolean;
|
|
16737
|
+
```
|
|
16738
|
+
|
|
16739
|
+
- *Type:* boolean
|
|
16740
|
+
- *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
|
|
16741
|
+
|
|
16742
|
+
Add a `dedupe` task that deduplicates project dependencies.
|
|
16743
|
+
|
|
16744
|
+
Deduplication prevents multiple versions of the same package from being
|
|
16745
|
+
installed, if a single version can satisfy all requested version ranges.
|
|
16746
|
+
This prevents version proliferation and reduces the size of the dependency
|
|
16747
|
+
tree.
|
|
16748
|
+
|
|
16749
|
+
The behavior depends on the package manager:
|
|
16750
|
+
- npm: runs `npm dedupe` after every mutating install.
|
|
16751
|
+
- pnpm: runs `pnpm dedupe` after every mutating install.
|
|
16752
|
+
- Yarn Berry: runs `yarn dedupe` after every mutating install. If
|
|
16753
|
+
`yarnBerryOptions.dedupePackages` is set, only the listed packages are
|
|
16754
|
+
deduplicated.
|
|
16755
|
+
- Yarn Classic: `yarn install` already deduplicates, so the task only
|
|
16756
|
+
prints an informational message.
|
|
16757
|
+
- Bun: not supported, enabling this option throws an error.
|
|
16758
|
+
|
|
16759
|
+
---
|
|
16760
|
+
|
|
16612
16761
|
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.deleteOrphanedLockFiles"></a>
|
|
16613
16762
|
|
|
16614
16763
|
```typescript
|
|
@@ -17073,6 +17222,22 @@ This can be any compatible package version, including the deprecated `standard-v
|
|
|
17073
17222
|
|
|
17074
17223
|
---
|
|
17075
17224
|
|
|
17225
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.githubReleaseLatest"></a>
|
|
17226
|
+
|
|
17227
|
+
```typescript
|
|
17228
|
+
public readonly githubReleaseLatest: boolean;
|
|
17229
|
+
```
|
|
17230
|
+
|
|
17231
|
+
- *Type:* boolean
|
|
17232
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
17233
|
+
|
|
17234
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
17235
|
+
|
|
17236
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
17237
|
+
mark it as latest.
|
|
17238
|
+
|
|
17239
|
+
---
|
|
17240
|
+
|
|
17076
17241
|
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.jsiiReleaseVersion"></a>
|
|
17077
17242
|
|
|
17078
17243
|
```typescript
|
|
@@ -17400,7 +17565,9 @@ Container image to use for GitHub workflows.
|
|
|
17400
17565
|
|
|
17401
17566
|
---
|
|
17402
17567
|
|
|
17403
|
-
#####
|
|
17568
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.workflowRunsOn"></a>
|
|
17569
|
+
|
|
17570
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
17404
17571
|
|
|
17405
17572
|
```typescript
|
|
17406
17573
|
public readonly workflowRunsOn: string[];
|
|
@@ -17413,7 +17580,9 @@ Github Runner selection labels.
|
|
|
17413
17580
|
|
|
17414
17581
|
---
|
|
17415
17582
|
|
|
17416
|
-
#####
|
|
17583
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.workflowRunsOnGroup"></a>
|
|
17584
|
+
|
|
17585
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
17417
17586
|
|
|
17418
17587
|
```typescript
|
|
17419
17588
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -17570,7 +17739,10 @@ public readonly codeCov: boolean;
|
|
|
17570
17739
|
- *Type:* boolean
|
|
17571
17740
|
- *Default:* false
|
|
17572
17741
|
|
|
17573
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
17742
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/.
|
|
17743
|
+
|
|
17744
|
+
Uses codecov/codecov-action. By default, OIDC auth is used.
|
|
17745
|
+
Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
17574
17746
|
|
|
17575
17747
|
---
|
|
17576
17748
|
|
|
@@ -18052,6 +18224,11 @@ public readonly libdir: string;
|
|
|
18052
18224
|
|
|
18053
18225
|
Typescript artifacts output directory.
|
|
18054
18226
|
|
|
18227
|
+
When `libdir` is changed, set `entrypoint` to match it (for example
|
|
18228
|
+
`libdir: "dist"` with `entrypoint: "dist/index.js"`). `types` follows the
|
|
18229
|
+
entrypoint rather than `libdir`, and `main` still defaults to
|
|
18230
|
+
`lib/index.js`.
|
|
18231
|
+
|
|
18055
18232
|
---
|
|
18056
18233
|
|
|
18057
18234
|
##### `projenrcTs`<sup>Optional</sup> <a name="projenrcTs" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.projenrcTs"></a>
|
|
@@ -18194,6 +18371,21 @@ Options for ts-jest.
|
|
|
18194
18371
|
|
|
18195
18372
|
---
|
|
18196
18373
|
|
|
18374
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.typecheckTests"></a>
|
|
18375
|
+
|
|
18376
|
+
```typescript
|
|
18377
|
+
public readonly typecheckTests: boolean;
|
|
18378
|
+
```
|
|
18379
|
+
|
|
18380
|
+
- *Type:* boolean
|
|
18381
|
+
- *Default:* false
|
|
18382
|
+
|
|
18383
|
+
Type-check the test suite as part of the `test` task.
|
|
18384
|
+
|
|
18385
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
18386
|
+
|
|
18387
|
+
---
|
|
18388
|
+
|
|
18197
18389
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.typescriptVersion"></a>
|
|
18198
18390
|
|
|
18199
18391
|
```typescript
|
|
@@ -18225,6 +18417,10 @@ This command will be called when
|
|
|
18225
18417
|
running `cdk synth` or when `cdk watch` identifies a change in your source
|
|
18226
18418
|
code before redeployment.
|
|
18227
18419
|
|
|
18420
|
+
The CDK CLI runs it through a shell on every synthesis, on the machine of
|
|
18421
|
+
anyone who checks out the project, so shell syntax in it is interpreted and
|
|
18422
|
+
the command should be one you would run yourself.
|
|
18423
|
+
|
|
18228
18424
|
---
|
|
18229
18425
|
|
|
18230
18426
|
##### `cdkout`<sup>Optional</sup> <a name="cdkout" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.cdkout"></a>
|
|
@@ -18564,6 +18760,8 @@ const productionTaimosCdkAppOptions: ProductionTaimosCdkAppOptions = { ... }
|
|
|
18564
18760
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
18565
18761
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
18566
18762
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
18763
|
+
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
18764
|
+
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
|
|
18567
18765
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
|
|
18568
18766
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
18569
18767
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
@@ -18593,6 +18791,7 @@ const productionTaimosCdkAppOptions: ProductionTaimosCdkAppOptions = { ... }
|
|
|
18593
18791
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
18594
18792
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
18595
18793
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.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. |
|
|
18794
|
+
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
18596
18795
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
|
|
18597
18796
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
18598
18797
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
@@ -18626,7 +18825,7 @@ const productionTaimosCdkAppOptions: ProductionTaimosCdkAppOptions = { ... }
|
|
|
18626
18825
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
18627
18826
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
18628
18827
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
18629
|
-
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
18828
|
+
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. |
|
|
18630
18829
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
18631
18830
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
18632
18831
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -18673,6 +18872,7 @@ const productionTaimosCdkAppOptions: ProductionTaimosCdkAppOptions = { ... }
|
|
|
18673
18872
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
18674
18873
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
18675
18874
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
18875
|
+
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
18676
18876
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
18677
18877
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.buildCommand">buildCommand</a></code> | <code>string</code> | A command to execute before synthesis. |
|
|
18678
18878
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.cdkout">cdkout</a></code> | <code>string</code> | cdk.out directory. |
|
|
@@ -18821,6 +19021,10 @@ public readonly projenCommand: string;
|
|
|
18821
19021
|
|
|
18822
19022
|
The shell command to use in order to run the projen CLI.
|
|
18823
19023
|
|
|
19024
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
19025
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
19026
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
19027
|
+
|
|
18824
19028
|
Can be used to customize in special environments.
|
|
18825
19029
|
|
|
18826
19030
|
---
|
|
@@ -19286,6 +19490,51 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
19286
19490
|
|
|
19287
19491
|
---
|
|
19288
19492
|
|
|
19493
|
+
##### `config`<sup>Optional</sup> <a name="config" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.config"></a>
|
|
19494
|
+
|
|
19495
|
+
```typescript
|
|
19496
|
+
public readonly config: {[ key: string ]: any};
|
|
19497
|
+
```
|
|
19498
|
+
|
|
19499
|
+
- *Type:* {[ key: string ]: any}
|
|
19500
|
+
- *Default:* no package configuration
|
|
19501
|
+
|
|
19502
|
+
Configuration values available to package scripts at runtime.
|
|
19503
|
+
|
|
19504
|
+
Values should be JSON-serializable.
|
|
19505
|
+
|
|
19506
|
+
> [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config)
|
|
19507
|
+
|
|
19508
|
+
---
|
|
19509
|
+
|
|
19510
|
+
##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.dedupeDeps"></a>
|
|
19511
|
+
|
|
19512
|
+
```typescript
|
|
19513
|
+
public readonly dedupeDeps: boolean;
|
|
19514
|
+
```
|
|
19515
|
+
|
|
19516
|
+
- *Type:* boolean
|
|
19517
|
+
- *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
|
|
19518
|
+
|
|
19519
|
+
Add a `dedupe` task that deduplicates project dependencies.
|
|
19520
|
+
|
|
19521
|
+
Deduplication prevents multiple versions of the same package from being
|
|
19522
|
+
installed, if a single version can satisfy all requested version ranges.
|
|
19523
|
+
This prevents version proliferation and reduces the size of the dependency
|
|
19524
|
+
tree.
|
|
19525
|
+
|
|
19526
|
+
The behavior depends on the package manager:
|
|
19527
|
+
- npm: runs `npm dedupe` after every mutating install.
|
|
19528
|
+
- pnpm: runs `pnpm dedupe` after every mutating install.
|
|
19529
|
+
- Yarn Berry: runs `yarn dedupe` after every mutating install. If
|
|
19530
|
+
`yarnBerryOptions.dedupePackages` is set, only the listed packages are
|
|
19531
|
+
deduplicated.
|
|
19532
|
+
- Yarn Classic: `yarn install` already deduplicates, so the task only
|
|
19533
|
+
prints an informational message.
|
|
19534
|
+
- Bun: not supported, enabling this option throws an error.
|
|
19535
|
+
|
|
19536
|
+
---
|
|
19537
|
+
|
|
19289
19538
|
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.deleteOrphanedLockFiles"></a>
|
|
19290
19539
|
|
|
19291
19540
|
```typescript
|
|
@@ -19750,6 +19999,22 @@ This can be any compatible package version, including the deprecated `standard-v
|
|
|
19750
19999
|
|
|
19751
20000
|
---
|
|
19752
20001
|
|
|
20002
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.githubReleaseLatest"></a>
|
|
20003
|
+
|
|
20004
|
+
```typescript
|
|
20005
|
+
public readonly githubReleaseLatest: boolean;
|
|
20006
|
+
```
|
|
20007
|
+
|
|
20008
|
+
- *Type:* boolean
|
|
20009
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
20010
|
+
|
|
20011
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
20012
|
+
|
|
20013
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
20014
|
+
mark it as latest.
|
|
20015
|
+
|
|
20016
|
+
---
|
|
20017
|
+
|
|
19753
20018
|
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.jsiiReleaseVersion"></a>
|
|
19754
20019
|
|
|
19755
20020
|
```typescript
|
|
@@ -20077,7 +20342,9 @@ Container image to use for GitHub workflows.
|
|
|
20077
20342
|
|
|
20078
20343
|
---
|
|
20079
20344
|
|
|
20080
|
-
#####
|
|
20345
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.workflowRunsOn"></a>
|
|
20346
|
+
|
|
20347
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
20081
20348
|
|
|
20082
20349
|
```typescript
|
|
20083
20350
|
public readonly workflowRunsOn: string[];
|
|
@@ -20090,7 +20357,9 @@ Github Runner selection labels.
|
|
|
20090
20357
|
|
|
20091
20358
|
---
|
|
20092
20359
|
|
|
20093
|
-
#####
|
|
20360
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.workflowRunsOnGroup"></a>
|
|
20361
|
+
|
|
20362
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
20094
20363
|
|
|
20095
20364
|
```typescript
|
|
20096
20365
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -20247,7 +20516,10 @@ public readonly codeCov: boolean;
|
|
|
20247
20516
|
- *Type:* boolean
|
|
20248
20517
|
- *Default:* false
|
|
20249
20518
|
|
|
20250
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
20519
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/.
|
|
20520
|
+
|
|
20521
|
+
Uses codecov/codecov-action. By default, OIDC auth is used.
|
|
20522
|
+
Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
20251
20523
|
|
|
20252
20524
|
---
|
|
20253
20525
|
|
|
@@ -20729,6 +21001,11 @@ public readonly libdir: string;
|
|
|
20729
21001
|
|
|
20730
21002
|
Typescript artifacts output directory.
|
|
20731
21003
|
|
|
21004
|
+
When `libdir` is changed, set `entrypoint` to match it (for example
|
|
21005
|
+
`libdir: "dist"` with `entrypoint: "dist/index.js"`). `types` follows the
|
|
21006
|
+
entrypoint rather than `libdir`, and `main` still defaults to
|
|
21007
|
+
`lib/index.js`.
|
|
21008
|
+
|
|
20732
21009
|
---
|
|
20733
21010
|
|
|
20734
21011
|
##### `projenrcTs`<sup>Optional</sup> <a name="projenrcTs" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.projenrcTs"></a>
|
|
@@ -20871,6 +21148,21 @@ Options for ts-jest.
|
|
|
20871
21148
|
|
|
20872
21149
|
---
|
|
20873
21150
|
|
|
21151
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.typecheckTests"></a>
|
|
21152
|
+
|
|
21153
|
+
```typescript
|
|
21154
|
+
public readonly typecheckTests: boolean;
|
|
21155
|
+
```
|
|
21156
|
+
|
|
21157
|
+
- *Type:* boolean
|
|
21158
|
+
- *Default:* false
|
|
21159
|
+
|
|
21160
|
+
Type-check the test suite as part of the `test` task.
|
|
21161
|
+
|
|
21162
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
21163
|
+
|
|
21164
|
+
---
|
|
21165
|
+
|
|
20874
21166
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.typescriptVersion"></a>
|
|
20875
21167
|
|
|
20876
21168
|
```typescript
|
|
@@ -20902,6 +21194,10 @@ This command will be called when
|
|
|
20902
21194
|
running `cdk synth` or when `cdk watch` identifies a change in your source
|
|
20903
21195
|
code before redeployment.
|
|
20904
21196
|
|
|
21197
|
+
The CDK CLI runs it through a shell on every synthesis, on the machine of
|
|
21198
|
+
anyone who checks out the project, so shell syntax in it is interpreted and
|
|
21199
|
+
the command should be one you would run yourself.
|
|
21200
|
+
|
|
20905
21201
|
---
|
|
20906
21202
|
|
|
20907
21203
|
##### `cdkout`<sup>Optional</sup> <a name="cdkout" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.cdkout"></a>
|
|
@@ -21335,6 +21631,8 @@ const taimosApiLibraryOptions: TaimosApiLibraryOptions = { ... }
|
|
|
21335
21631
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
21336
21632
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
21337
21633
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
21634
|
+
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
21635
|
+
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
|
|
21338
21636
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
|
|
21339
21637
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
21340
21638
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
@@ -21364,6 +21662,7 @@ const taimosApiLibraryOptions: TaimosApiLibraryOptions = { ... }
|
|
|
21364
21662
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
21365
21663
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
21366
21664
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.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. |
|
|
21665
|
+
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
21367
21666
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
|
|
21368
21667
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
21369
21668
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
@@ -21397,7 +21696,7 @@ const taimosApiLibraryOptions: TaimosApiLibraryOptions = { ... }
|
|
|
21397
21696
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
21398
21697
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
21399
21698
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
21400
|
-
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
21699
|
+
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. |
|
|
21401
21700
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
21402
21701
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
21403
21702
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -21444,6 +21743,7 @@ const taimosApiLibraryOptions: TaimosApiLibraryOptions = { ... }
|
|
|
21444
21743
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
21445
21744
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
21446
21745
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
21746
|
+
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
21447
21747
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
21448
21748
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.privateNpm">privateNpm</a></code> | <code>boolean</code> | Whether to enable private NPM registry authentication. |
|
|
21449
21749
|
| <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.privateNpmTokenEnvVar">privateNpmTokenEnvVar</a></code> | <code>string</code> | The environment variable name containing the NPM authentication token. |
|
|
@@ -21570,6 +21870,10 @@ public readonly projenCommand: string;
|
|
|
21570
21870
|
|
|
21571
21871
|
The shell command to use in order to run the projen CLI.
|
|
21572
21872
|
|
|
21873
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
21874
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
21875
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
21876
|
+
|
|
21573
21877
|
Can be used to customize in special environments.
|
|
21574
21878
|
|
|
21575
21879
|
---
|
|
@@ -22035,6 +22339,51 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
22035
22339
|
|
|
22036
22340
|
---
|
|
22037
22341
|
|
|
22342
|
+
##### `config`<sup>Optional</sup> <a name="config" id="@taimos/projen.TaimosApiLibraryOptions.property.config"></a>
|
|
22343
|
+
|
|
22344
|
+
```typescript
|
|
22345
|
+
public readonly config: {[ key: string ]: any};
|
|
22346
|
+
```
|
|
22347
|
+
|
|
22348
|
+
- *Type:* {[ key: string ]: any}
|
|
22349
|
+
- *Default:* no package configuration
|
|
22350
|
+
|
|
22351
|
+
Configuration values available to package scripts at runtime.
|
|
22352
|
+
|
|
22353
|
+
Values should be JSON-serializable.
|
|
22354
|
+
|
|
22355
|
+
> [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config)
|
|
22356
|
+
|
|
22357
|
+
---
|
|
22358
|
+
|
|
22359
|
+
##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="@taimos/projen.TaimosApiLibraryOptions.property.dedupeDeps"></a>
|
|
22360
|
+
|
|
22361
|
+
```typescript
|
|
22362
|
+
public readonly dedupeDeps: boolean;
|
|
22363
|
+
```
|
|
22364
|
+
|
|
22365
|
+
- *Type:* boolean
|
|
22366
|
+
- *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
|
|
22367
|
+
|
|
22368
|
+
Add a `dedupe` task that deduplicates project dependencies.
|
|
22369
|
+
|
|
22370
|
+
Deduplication prevents multiple versions of the same package from being
|
|
22371
|
+
installed, if a single version can satisfy all requested version ranges.
|
|
22372
|
+
This prevents version proliferation and reduces the size of the dependency
|
|
22373
|
+
tree.
|
|
22374
|
+
|
|
22375
|
+
The behavior depends on the package manager:
|
|
22376
|
+
- npm: runs `npm dedupe` after every mutating install.
|
|
22377
|
+
- pnpm: runs `pnpm dedupe` after every mutating install.
|
|
22378
|
+
- Yarn Berry: runs `yarn dedupe` after every mutating install. If
|
|
22379
|
+
`yarnBerryOptions.dedupePackages` is set, only the listed packages are
|
|
22380
|
+
deduplicated.
|
|
22381
|
+
- Yarn Classic: `yarn install` already deduplicates, so the task only
|
|
22382
|
+
prints an informational message.
|
|
22383
|
+
- Bun: not supported, enabling this option throws an error.
|
|
22384
|
+
|
|
22385
|
+
---
|
|
22386
|
+
|
|
22038
22387
|
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="@taimos/projen.TaimosApiLibraryOptions.property.deleteOrphanedLockFiles"></a>
|
|
22039
22388
|
|
|
22040
22389
|
```typescript
|
|
@@ -22499,6 +22848,22 @@ This can be any compatible package version, including the deprecated `standard-v
|
|
|
22499
22848
|
|
|
22500
22849
|
---
|
|
22501
22850
|
|
|
22851
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="@taimos/projen.TaimosApiLibraryOptions.property.githubReleaseLatest"></a>
|
|
22852
|
+
|
|
22853
|
+
```typescript
|
|
22854
|
+
public readonly githubReleaseLatest: boolean;
|
|
22855
|
+
```
|
|
22856
|
+
|
|
22857
|
+
- *Type:* boolean
|
|
22858
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
22859
|
+
|
|
22860
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
22861
|
+
|
|
22862
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
22863
|
+
mark it as latest.
|
|
22864
|
+
|
|
22865
|
+
---
|
|
22866
|
+
|
|
22502
22867
|
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="@taimos/projen.TaimosApiLibraryOptions.property.jsiiReleaseVersion"></a>
|
|
22503
22868
|
|
|
22504
22869
|
```typescript
|
|
@@ -22826,7 +23191,9 @@ Container image to use for GitHub workflows.
|
|
|
22826
23191
|
|
|
22827
23192
|
---
|
|
22828
23193
|
|
|
22829
|
-
#####
|
|
23194
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="@taimos/projen.TaimosApiLibraryOptions.property.workflowRunsOn"></a>
|
|
23195
|
+
|
|
23196
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
22830
23197
|
|
|
22831
23198
|
```typescript
|
|
22832
23199
|
public readonly workflowRunsOn: string[];
|
|
@@ -22839,7 +23206,9 @@ Github Runner selection labels.
|
|
|
22839
23206
|
|
|
22840
23207
|
---
|
|
22841
23208
|
|
|
22842
|
-
#####
|
|
23209
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@taimos/projen.TaimosApiLibraryOptions.property.workflowRunsOnGroup"></a>
|
|
23210
|
+
|
|
23211
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
22843
23212
|
|
|
22844
23213
|
```typescript
|
|
22845
23214
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -22996,7 +23365,10 @@ public readonly codeCov: boolean;
|
|
|
22996
23365
|
- *Type:* boolean
|
|
22997
23366
|
- *Default:* false
|
|
22998
23367
|
|
|
22999
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
23368
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/.
|
|
23369
|
+
|
|
23370
|
+
Uses codecov/codecov-action. By default, OIDC auth is used.
|
|
23371
|
+
Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
23000
23372
|
|
|
23001
23373
|
---
|
|
23002
23374
|
|
|
@@ -23478,6 +23850,11 @@ public readonly libdir: string;
|
|
|
23478
23850
|
|
|
23479
23851
|
Typescript artifacts output directory.
|
|
23480
23852
|
|
|
23853
|
+
When `libdir` is changed, set `entrypoint` to match it (for example
|
|
23854
|
+
`libdir: "dist"` with `entrypoint: "dist/index.js"`). `types` follows the
|
|
23855
|
+
entrypoint rather than `libdir`, and `main` still defaults to
|
|
23856
|
+
`lib/index.js`.
|
|
23857
|
+
|
|
23481
23858
|
---
|
|
23482
23859
|
|
|
23483
23860
|
##### `projenrcTs`<sup>Optional</sup> <a name="projenrcTs" id="@taimos/projen.TaimosApiLibraryOptions.property.projenrcTs"></a>
|
|
@@ -23620,6 +23997,21 @@ Options for ts-jest.
|
|
|
23620
23997
|
|
|
23621
23998
|
---
|
|
23622
23999
|
|
|
24000
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="@taimos/projen.TaimosApiLibraryOptions.property.typecheckTests"></a>
|
|
24001
|
+
|
|
24002
|
+
```typescript
|
|
24003
|
+
public readonly typecheckTests: boolean;
|
|
24004
|
+
```
|
|
24005
|
+
|
|
24006
|
+
- *Type:* boolean
|
|
24007
|
+
- *Default:* false
|
|
24008
|
+
|
|
24009
|
+
Type-check the test suite as part of the `test` task.
|
|
24010
|
+
|
|
24011
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
24012
|
+
|
|
24013
|
+
---
|
|
24014
|
+
|
|
23623
24015
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="@taimos/projen.TaimosApiLibraryOptions.property.typescriptVersion"></a>
|
|
23624
24016
|
|
|
23625
24017
|
```typescript
|
|
@@ -23748,6 +24140,8 @@ const taimosCdkAppOptions: TaimosCdkAppOptions = { ... }
|
|
|
23748
24140
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
23749
24141
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
23750
24142
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
24143
|
+
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
24144
|
+
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
|
|
23751
24145
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
|
|
23752
24146
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
23753
24147
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
@@ -23777,6 +24171,7 @@ const taimosCdkAppOptions: TaimosCdkAppOptions = { ... }
|
|
|
23777
24171
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
23778
24172
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
23779
24173
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.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. |
|
|
24174
|
+
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
23780
24175
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
|
|
23781
24176
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
23782
24177
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
@@ -23810,7 +24205,7 @@ const taimosCdkAppOptions: TaimosCdkAppOptions = { ... }
|
|
|
23810
24205
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
23811
24206
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
23812
24207
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
23813
|
-
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
24208
|
+
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. |
|
|
23814
24209
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
23815
24210
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
23816
24211
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -23857,6 +24252,7 @@ const taimosCdkAppOptions: TaimosCdkAppOptions = { ... }
|
|
|
23857
24252
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
23858
24253
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
23859
24254
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
24255
|
+
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
23860
24256
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
23861
24257
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.buildCommand">buildCommand</a></code> | <code>string</code> | A command to execute before synthesis. |
|
|
23862
24258
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.cdkout">cdkout</a></code> | <code>string</code> | cdk.out directory. |
|
|
@@ -24001,6 +24397,10 @@ public readonly projenCommand: string;
|
|
|
24001
24397
|
|
|
24002
24398
|
The shell command to use in order to run the projen CLI.
|
|
24003
24399
|
|
|
24400
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
24401
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
24402
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
24403
|
+
|
|
24004
24404
|
Can be used to customize in special environments.
|
|
24005
24405
|
|
|
24006
24406
|
---
|
|
@@ -24466,6 +24866,51 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
24466
24866
|
|
|
24467
24867
|
---
|
|
24468
24868
|
|
|
24869
|
+
##### `config`<sup>Optional</sup> <a name="config" id="@taimos/projen.TaimosCdkAppOptions.property.config"></a>
|
|
24870
|
+
|
|
24871
|
+
```typescript
|
|
24872
|
+
public readonly config: {[ key: string ]: any};
|
|
24873
|
+
```
|
|
24874
|
+
|
|
24875
|
+
- *Type:* {[ key: string ]: any}
|
|
24876
|
+
- *Default:* no package configuration
|
|
24877
|
+
|
|
24878
|
+
Configuration values available to package scripts at runtime.
|
|
24879
|
+
|
|
24880
|
+
Values should be JSON-serializable.
|
|
24881
|
+
|
|
24882
|
+
> [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config)
|
|
24883
|
+
|
|
24884
|
+
---
|
|
24885
|
+
|
|
24886
|
+
##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="@taimos/projen.TaimosCdkAppOptions.property.dedupeDeps"></a>
|
|
24887
|
+
|
|
24888
|
+
```typescript
|
|
24889
|
+
public readonly dedupeDeps: boolean;
|
|
24890
|
+
```
|
|
24891
|
+
|
|
24892
|
+
- *Type:* boolean
|
|
24893
|
+
- *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
|
|
24894
|
+
|
|
24895
|
+
Add a `dedupe` task that deduplicates project dependencies.
|
|
24896
|
+
|
|
24897
|
+
Deduplication prevents multiple versions of the same package from being
|
|
24898
|
+
installed, if a single version can satisfy all requested version ranges.
|
|
24899
|
+
This prevents version proliferation and reduces the size of the dependency
|
|
24900
|
+
tree.
|
|
24901
|
+
|
|
24902
|
+
The behavior depends on the package manager:
|
|
24903
|
+
- npm: runs `npm dedupe` after every mutating install.
|
|
24904
|
+
- pnpm: runs `pnpm dedupe` after every mutating install.
|
|
24905
|
+
- Yarn Berry: runs `yarn dedupe` after every mutating install. If
|
|
24906
|
+
`yarnBerryOptions.dedupePackages` is set, only the listed packages are
|
|
24907
|
+
deduplicated.
|
|
24908
|
+
- Yarn Classic: `yarn install` already deduplicates, so the task only
|
|
24909
|
+
prints an informational message.
|
|
24910
|
+
- Bun: not supported, enabling this option throws an error.
|
|
24911
|
+
|
|
24912
|
+
---
|
|
24913
|
+
|
|
24469
24914
|
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="@taimos/projen.TaimosCdkAppOptions.property.deleteOrphanedLockFiles"></a>
|
|
24470
24915
|
|
|
24471
24916
|
```typescript
|
|
@@ -24930,6 +25375,22 @@ This can be any compatible package version, including the deprecated `standard-v
|
|
|
24930
25375
|
|
|
24931
25376
|
---
|
|
24932
25377
|
|
|
25378
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="@taimos/projen.TaimosCdkAppOptions.property.githubReleaseLatest"></a>
|
|
25379
|
+
|
|
25380
|
+
```typescript
|
|
25381
|
+
public readonly githubReleaseLatest: boolean;
|
|
25382
|
+
```
|
|
25383
|
+
|
|
25384
|
+
- *Type:* boolean
|
|
25385
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
25386
|
+
|
|
25387
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
25388
|
+
|
|
25389
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
25390
|
+
mark it as latest.
|
|
25391
|
+
|
|
25392
|
+
---
|
|
25393
|
+
|
|
24933
25394
|
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="@taimos/projen.TaimosCdkAppOptions.property.jsiiReleaseVersion"></a>
|
|
24934
25395
|
|
|
24935
25396
|
```typescript
|
|
@@ -25257,7 +25718,9 @@ Container image to use for GitHub workflows.
|
|
|
25257
25718
|
|
|
25258
25719
|
---
|
|
25259
25720
|
|
|
25260
|
-
#####
|
|
25721
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="@taimos/projen.TaimosCdkAppOptions.property.workflowRunsOn"></a>
|
|
25722
|
+
|
|
25723
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
25261
25724
|
|
|
25262
25725
|
```typescript
|
|
25263
25726
|
public readonly workflowRunsOn: string[];
|
|
@@ -25270,7 +25733,9 @@ Github Runner selection labels.
|
|
|
25270
25733
|
|
|
25271
25734
|
---
|
|
25272
25735
|
|
|
25273
|
-
#####
|
|
25736
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@taimos/projen.TaimosCdkAppOptions.property.workflowRunsOnGroup"></a>
|
|
25737
|
+
|
|
25738
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
25274
25739
|
|
|
25275
25740
|
```typescript
|
|
25276
25741
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -25427,7 +25892,10 @@ public readonly codeCov: boolean;
|
|
|
25427
25892
|
- *Type:* boolean
|
|
25428
25893
|
- *Default:* false
|
|
25429
25894
|
|
|
25430
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
25895
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/.
|
|
25896
|
+
|
|
25897
|
+
Uses codecov/codecov-action. By default, OIDC auth is used.
|
|
25898
|
+
Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
25431
25899
|
|
|
25432
25900
|
---
|
|
25433
25901
|
|
|
@@ -25909,6 +26377,11 @@ public readonly libdir: string;
|
|
|
25909
26377
|
|
|
25910
26378
|
Typescript artifacts output directory.
|
|
25911
26379
|
|
|
26380
|
+
When `libdir` is changed, set `entrypoint` to match it (for example
|
|
26381
|
+
`libdir: "dist"` with `entrypoint: "dist/index.js"`). `types` follows the
|
|
26382
|
+
entrypoint rather than `libdir`, and `main` still defaults to
|
|
26383
|
+
`lib/index.js`.
|
|
26384
|
+
|
|
25912
26385
|
---
|
|
25913
26386
|
|
|
25914
26387
|
##### `projenrcTs`<sup>Optional</sup> <a name="projenrcTs" id="@taimos/projen.TaimosCdkAppOptions.property.projenrcTs"></a>
|
|
@@ -26051,6 +26524,21 @@ Options for ts-jest.
|
|
|
26051
26524
|
|
|
26052
26525
|
---
|
|
26053
26526
|
|
|
26527
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="@taimos/projen.TaimosCdkAppOptions.property.typecheckTests"></a>
|
|
26528
|
+
|
|
26529
|
+
```typescript
|
|
26530
|
+
public readonly typecheckTests: boolean;
|
|
26531
|
+
```
|
|
26532
|
+
|
|
26533
|
+
- *Type:* boolean
|
|
26534
|
+
- *Default:* false
|
|
26535
|
+
|
|
26536
|
+
Type-check the test suite as part of the `test` task.
|
|
26537
|
+
|
|
26538
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
26539
|
+
|
|
26540
|
+
---
|
|
26541
|
+
|
|
26054
26542
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="@taimos/projen.TaimosCdkAppOptions.property.typescriptVersion"></a>
|
|
26055
26543
|
|
|
26056
26544
|
```typescript
|
|
@@ -26082,6 +26570,10 @@ This command will be called when
|
|
|
26082
26570
|
running `cdk synth` or when `cdk watch` identifies a change in your source
|
|
26083
26571
|
code before redeployment.
|
|
26084
26572
|
|
|
26573
|
+
The CDK CLI runs it through a shell on every synthesis, on the machine of
|
|
26574
|
+
anyone who checks out the project, so shell syntax in it is interpreted and
|
|
26575
|
+
the command should be one you would run yourself.
|
|
26576
|
+
|
|
26085
26577
|
---
|
|
26086
26578
|
|
|
26087
26579
|
##### `cdkout`<sup>Optional</sup> <a name="cdkout" id="@taimos/projen.TaimosCdkAppOptions.property.cdkout"></a>
|
|
@@ -26421,6 +26913,8 @@ const taimosCdkConstructLibraryOptions: TaimosCdkConstructLibraryOptions = { ...
|
|
|
26421
26913
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
26422
26914
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
26423
26915
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
26916
|
+
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
26917
|
+
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
|
|
26424
26918
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
|
|
26425
26919
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
26426
26920
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
@@ -26450,6 +26944,7 @@ const taimosCdkConstructLibraryOptions: TaimosCdkConstructLibraryOptions = { ...
|
|
|
26450
26944
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
26451
26945
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
26452
26946
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.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. |
|
|
26947
|
+
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
26453
26948
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
|
|
26454
26949
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
26455
26950
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
@@ -26483,7 +26978,7 @@ const taimosCdkConstructLibraryOptions: TaimosCdkConstructLibraryOptions = { ...
|
|
|
26483
26978
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
26484
26979
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
26485
26980
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
26486
|
-
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
26981
|
+
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. |
|
|
26487
26982
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
26488
26983
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
26489
26984
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -26530,6 +27025,7 @@ const taimosCdkConstructLibraryOptions: TaimosCdkConstructLibraryOptions = { ...
|
|
|
26530
27025
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
26531
27026
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
26532
27027
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
27028
|
+
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
26533
27029
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
26534
27030
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.author">author</a></code> | <code>string</code> | The name of the library author. |
|
|
26535
27031
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.authorAddress">authorAddress</a></code> | <code>string</code> | Email or URL of the library author. |
|
|
@@ -26681,6 +27177,10 @@ public readonly projenCommand: string;
|
|
|
26681
27177
|
|
|
26682
27178
|
The shell command to use in order to run the projen CLI.
|
|
26683
27179
|
|
|
27180
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
27181
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
27182
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
27183
|
+
|
|
26684
27184
|
Can be used to customize in special environments.
|
|
26685
27185
|
|
|
26686
27186
|
---
|
|
@@ -27146,6 +27646,51 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
27146
27646
|
|
|
27147
27647
|
---
|
|
27148
27648
|
|
|
27649
|
+
##### `config`<sup>Optional</sup> <a name="config" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.config"></a>
|
|
27650
|
+
|
|
27651
|
+
```typescript
|
|
27652
|
+
public readonly config: {[ key: string ]: any};
|
|
27653
|
+
```
|
|
27654
|
+
|
|
27655
|
+
- *Type:* {[ key: string ]: any}
|
|
27656
|
+
- *Default:* no package configuration
|
|
27657
|
+
|
|
27658
|
+
Configuration values available to package scripts at runtime.
|
|
27659
|
+
|
|
27660
|
+
Values should be JSON-serializable.
|
|
27661
|
+
|
|
27662
|
+
> [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config)
|
|
27663
|
+
|
|
27664
|
+
---
|
|
27665
|
+
|
|
27666
|
+
##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.dedupeDeps"></a>
|
|
27667
|
+
|
|
27668
|
+
```typescript
|
|
27669
|
+
public readonly dedupeDeps: boolean;
|
|
27670
|
+
```
|
|
27671
|
+
|
|
27672
|
+
- *Type:* boolean
|
|
27673
|
+
- *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
|
|
27674
|
+
|
|
27675
|
+
Add a `dedupe` task that deduplicates project dependencies.
|
|
27676
|
+
|
|
27677
|
+
Deduplication prevents multiple versions of the same package from being
|
|
27678
|
+
installed, if a single version can satisfy all requested version ranges.
|
|
27679
|
+
This prevents version proliferation and reduces the size of the dependency
|
|
27680
|
+
tree.
|
|
27681
|
+
|
|
27682
|
+
The behavior depends on the package manager:
|
|
27683
|
+
- npm: runs `npm dedupe` after every mutating install.
|
|
27684
|
+
- pnpm: runs `pnpm dedupe` after every mutating install.
|
|
27685
|
+
- Yarn Berry: runs `yarn dedupe` after every mutating install. If
|
|
27686
|
+
`yarnBerryOptions.dedupePackages` is set, only the listed packages are
|
|
27687
|
+
deduplicated.
|
|
27688
|
+
- Yarn Classic: `yarn install` already deduplicates, so the task only
|
|
27689
|
+
prints an informational message.
|
|
27690
|
+
- Bun: not supported, enabling this option throws an error.
|
|
27691
|
+
|
|
27692
|
+
---
|
|
27693
|
+
|
|
27149
27694
|
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.deleteOrphanedLockFiles"></a>
|
|
27150
27695
|
|
|
27151
27696
|
```typescript
|
|
@@ -27610,6 +28155,22 @@ This can be any compatible package version, including the deprecated `standard-v
|
|
|
27610
28155
|
|
|
27611
28156
|
---
|
|
27612
28157
|
|
|
28158
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.githubReleaseLatest"></a>
|
|
28159
|
+
|
|
28160
|
+
```typescript
|
|
28161
|
+
public readonly githubReleaseLatest: boolean;
|
|
28162
|
+
```
|
|
28163
|
+
|
|
28164
|
+
- *Type:* boolean
|
|
28165
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
28166
|
+
|
|
28167
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
28168
|
+
|
|
28169
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
28170
|
+
mark it as latest.
|
|
28171
|
+
|
|
28172
|
+
---
|
|
28173
|
+
|
|
27613
28174
|
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.jsiiReleaseVersion"></a>
|
|
27614
28175
|
|
|
27615
28176
|
```typescript
|
|
@@ -27937,7 +28498,9 @@ Container image to use for GitHub workflows.
|
|
|
27937
28498
|
|
|
27938
28499
|
---
|
|
27939
28500
|
|
|
27940
|
-
#####
|
|
28501
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.workflowRunsOn"></a>
|
|
28502
|
+
|
|
28503
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
27941
28504
|
|
|
27942
28505
|
```typescript
|
|
27943
28506
|
public readonly workflowRunsOn: string[];
|
|
@@ -27950,7 +28513,9 @@ Github Runner selection labels.
|
|
|
27950
28513
|
|
|
27951
28514
|
---
|
|
27952
28515
|
|
|
27953
|
-
#####
|
|
28516
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.workflowRunsOnGroup"></a>
|
|
28517
|
+
|
|
28518
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
27954
28519
|
|
|
27955
28520
|
```typescript
|
|
27956
28521
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -28107,7 +28672,10 @@ public readonly codeCov: boolean;
|
|
|
28107
28672
|
- *Type:* boolean
|
|
28108
28673
|
- *Default:* false
|
|
28109
28674
|
|
|
28110
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
28675
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/.
|
|
28676
|
+
|
|
28677
|
+
Uses codecov/codecov-action. By default, OIDC auth is used.
|
|
28678
|
+
Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
28111
28679
|
|
|
28112
28680
|
---
|
|
28113
28681
|
|
|
@@ -28589,6 +29157,11 @@ public readonly libdir: string;
|
|
|
28589
29157
|
|
|
28590
29158
|
Typescript artifacts output directory.
|
|
28591
29159
|
|
|
29160
|
+
When `libdir` is changed, set `entrypoint` to match it (for example
|
|
29161
|
+
`libdir: "dist"` with `entrypoint: "dist/index.js"`). `types` follows the
|
|
29162
|
+
entrypoint rather than `libdir`, and `main` still defaults to
|
|
29163
|
+
`lib/index.js`.
|
|
29164
|
+
|
|
28592
29165
|
---
|
|
28593
29166
|
|
|
28594
29167
|
##### `projenrcTs`<sup>Optional</sup> <a name="projenrcTs" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.projenrcTs"></a>
|
|
@@ -28731,6 +29304,21 @@ Options for ts-jest.
|
|
|
28731
29304
|
|
|
28732
29305
|
---
|
|
28733
29306
|
|
|
29307
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.typecheckTests"></a>
|
|
29308
|
+
|
|
29309
|
+
```typescript
|
|
29310
|
+
public readonly typecheckTests: boolean;
|
|
29311
|
+
```
|
|
29312
|
+
|
|
29313
|
+
- *Type:* boolean
|
|
29314
|
+
- *Default:* false
|
|
29315
|
+
|
|
29316
|
+
Type-check the test suite as part of the `test` task.
|
|
29317
|
+
|
|
29318
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
29319
|
+
|
|
29320
|
+
---
|
|
29321
|
+
|
|
28734
29322
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.typescriptVersion"></a>
|
|
28735
29323
|
|
|
28736
29324
|
```typescript
|
|
@@ -29214,6 +29802,8 @@ const taimosPrivateTypescriptLibraryOptions: TaimosPrivateTypescriptLibraryOptio
|
|
|
29214
29802
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
29215
29803
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
29216
29804
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
29805
|
+
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
29806
|
+
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
|
|
29217
29807
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
|
|
29218
29808
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
29219
29809
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
@@ -29243,6 +29833,7 @@ const taimosPrivateTypescriptLibraryOptions: TaimosPrivateTypescriptLibraryOptio
|
|
|
29243
29833
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
29244
29834
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
29245
29835
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.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. |
|
|
29836
|
+
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
29246
29837
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
|
|
29247
29838
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
29248
29839
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
@@ -29276,7 +29867,7 @@ const taimosPrivateTypescriptLibraryOptions: TaimosPrivateTypescriptLibraryOptio
|
|
|
29276
29867
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
29277
29868
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
29278
29869
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
29279
|
-
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
29870
|
+
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. |
|
|
29280
29871
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
29281
29872
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
29282
29873
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -29323,6 +29914,7 @@ const taimosPrivateTypescriptLibraryOptions: TaimosPrivateTypescriptLibraryOptio
|
|
|
29323
29914
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
29324
29915
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
29325
29916
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
29917
|
+
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
29326
29918
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
29327
29919
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.privateNpm">privateNpm</a></code> | <code>boolean</code> | Whether to enable private NPM registry authentication. |
|
|
29328
29920
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.privateNpmTokenEnvVar">privateNpmTokenEnvVar</a></code> | <code>string</code> | The environment variable name containing the NPM authentication token. |
|
|
@@ -29447,6 +30039,10 @@ public readonly projenCommand: string;
|
|
|
29447
30039
|
|
|
29448
30040
|
The shell command to use in order to run the projen CLI.
|
|
29449
30041
|
|
|
30042
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
30043
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
30044
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
30045
|
+
|
|
29450
30046
|
Can be used to customize in special environments.
|
|
29451
30047
|
|
|
29452
30048
|
---
|
|
@@ -29912,6 +30508,51 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
29912
30508
|
|
|
29913
30509
|
---
|
|
29914
30510
|
|
|
30511
|
+
##### `config`<sup>Optional</sup> <a name="config" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.config"></a>
|
|
30512
|
+
|
|
30513
|
+
```typescript
|
|
30514
|
+
public readonly config: {[ key: string ]: any};
|
|
30515
|
+
```
|
|
30516
|
+
|
|
30517
|
+
- *Type:* {[ key: string ]: any}
|
|
30518
|
+
- *Default:* no package configuration
|
|
30519
|
+
|
|
30520
|
+
Configuration values available to package scripts at runtime.
|
|
30521
|
+
|
|
30522
|
+
Values should be JSON-serializable.
|
|
30523
|
+
|
|
30524
|
+
> [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config)
|
|
30525
|
+
|
|
30526
|
+
---
|
|
30527
|
+
|
|
30528
|
+
##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.dedupeDeps"></a>
|
|
30529
|
+
|
|
30530
|
+
```typescript
|
|
30531
|
+
public readonly dedupeDeps: boolean;
|
|
30532
|
+
```
|
|
30533
|
+
|
|
30534
|
+
- *Type:* boolean
|
|
30535
|
+
- *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
|
|
30536
|
+
|
|
30537
|
+
Add a `dedupe` task that deduplicates project dependencies.
|
|
30538
|
+
|
|
30539
|
+
Deduplication prevents multiple versions of the same package from being
|
|
30540
|
+
installed, if a single version can satisfy all requested version ranges.
|
|
30541
|
+
This prevents version proliferation and reduces the size of the dependency
|
|
30542
|
+
tree.
|
|
30543
|
+
|
|
30544
|
+
The behavior depends on the package manager:
|
|
30545
|
+
- npm: runs `npm dedupe` after every mutating install.
|
|
30546
|
+
- pnpm: runs `pnpm dedupe` after every mutating install.
|
|
30547
|
+
- Yarn Berry: runs `yarn dedupe` after every mutating install. If
|
|
30548
|
+
`yarnBerryOptions.dedupePackages` is set, only the listed packages are
|
|
30549
|
+
deduplicated.
|
|
30550
|
+
- Yarn Classic: `yarn install` already deduplicates, so the task only
|
|
30551
|
+
prints an informational message.
|
|
30552
|
+
- Bun: not supported, enabling this option throws an error.
|
|
30553
|
+
|
|
30554
|
+
---
|
|
30555
|
+
|
|
29915
30556
|
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.deleteOrphanedLockFiles"></a>
|
|
29916
30557
|
|
|
29917
30558
|
```typescript
|
|
@@ -30376,6 +31017,22 @@ This can be any compatible package version, including the deprecated `standard-v
|
|
|
30376
31017
|
|
|
30377
31018
|
---
|
|
30378
31019
|
|
|
31020
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.githubReleaseLatest"></a>
|
|
31021
|
+
|
|
31022
|
+
```typescript
|
|
31023
|
+
public readonly githubReleaseLatest: boolean;
|
|
31024
|
+
```
|
|
31025
|
+
|
|
31026
|
+
- *Type:* boolean
|
|
31027
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
31028
|
+
|
|
31029
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
31030
|
+
|
|
31031
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
31032
|
+
mark it as latest.
|
|
31033
|
+
|
|
31034
|
+
---
|
|
31035
|
+
|
|
30379
31036
|
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.jsiiReleaseVersion"></a>
|
|
30380
31037
|
|
|
30381
31038
|
```typescript
|
|
@@ -30703,7 +31360,9 @@ Container image to use for GitHub workflows.
|
|
|
30703
31360
|
|
|
30704
31361
|
---
|
|
30705
31362
|
|
|
30706
|
-
#####
|
|
31363
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.workflowRunsOn"></a>
|
|
31364
|
+
|
|
31365
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
30707
31366
|
|
|
30708
31367
|
```typescript
|
|
30709
31368
|
public readonly workflowRunsOn: string[];
|
|
@@ -30716,7 +31375,9 @@ Github Runner selection labels.
|
|
|
30716
31375
|
|
|
30717
31376
|
---
|
|
30718
31377
|
|
|
30719
|
-
#####
|
|
31378
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.workflowRunsOnGroup"></a>
|
|
31379
|
+
|
|
31380
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
30720
31381
|
|
|
30721
31382
|
```typescript
|
|
30722
31383
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -30873,7 +31534,10 @@ public readonly codeCov: boolean;
|
|
|
30873
31534
|
- *Type:* boolean
|
|
30874
31535
|
- *Default:* false
|
|
30875
31536
|
|
|
30876
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
31537
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/.
|
|
31538
|
+
|
|
31539
|
+
Uses codecov/codecov-action. By default, OIDC auth is used.
|
|
31540
|
+
Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
30877
31541
|
|
|
30878
31542
|
---
|
|
30879
31543
|
|
|
@@ -31355,6 +32019,11 @@ public readonly libdir: string;
|
|
|
31355
32019
|
|
|
31356
32020
|
Typescript artifacts output directory.
|
|
31357
32021
|
|
|
32022
|
+
When `libdir` is changed, set `entrypoint` to match it (for example
|
|
32023
|
+
`libdir: "dist"` with `entrypoint: "dist/index.js"`). `types` follows the
|
|
32024
|
+
entrypoint rather than `libdir`, and `main` still defaults to
|
|
32025
|
+
`lib/index.js`.
|
|
32026
|
+
|
|
31358
32027
|
---
|
|
31359
32028
|
|
|
31360
32029
|
##### `projenrcTs`<sup>Optional</sup> <a name="projenrcTs" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.projenrcTs"></a>
|
|
@@ -31497,6 +32166,21 @@ Options for ts-jest.
|
|
|
31497
32166
|
|
|
31498
32167
|
---
|
|
31499
32168
|
|
|
32169
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.typecheckTests"></a>
|
|
32170
|
+
|
|
32171
|
+
```typescript
|
|
32172
|
+
public readonly typecheckTests: boolean;
|
|
32173
|
+
```
|
|
32174
|
+
|
|
32175
|
+
- *Type:* boolean
|
|
32176
|
+
- *Default:* false
|
|
32177
|
+
|
|
32178
|
+
Type-check the test suite as part of the `test` task.
|
|
32179
|
+
|
|
32180
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
32181
|
+
|
|
32182
|
+
---
|
|
32183
|
+
|
|
31500
32184
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.typescriptVersion"></a>
|
|
31501
32185
|
|
|
31502
32186
|
```typescript
|
|
@@ -31593,6 +32277,8 @@ const taimosTypescriptLibraryOptions: TaimosTypescriptLibraryOptions = { ... }
|
|
|
31593
32277
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
31594
32278
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
31595
32279
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
32280
|
+
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.config">config</a></code> | <code>{[ key: string ]: any}</code> | Configuration values available to package scripts at runtime. |
|
|
32281
|
+
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.dedupeDeps">dedupeDeps</a></code> | <code>boolean</code> | Add a `dedupe` task that deduplicates project dependencies. |
|
|
31596
32282
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
|
|
31597
32283
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
31598
32284
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
@@ -31622,6 +32308,7 @@ const taimosTypescriptLibraryOptions: TaimosTypescriptLibraryOptions = { ... }
|
|
|
31622
32308
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
31623
32309
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
31624
32310
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.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. |
|
|
32311
|
+
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.githubReleaseLatest">githubReleaseLatest</a></code> | <code>boolean</code> | Whether GitHub should explicitly mark the release from the default branch as the latest release. |
|
|
31625
32312
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
|
|
31626
32313
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
31627
32314
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
@@ -31655,7 +32342,7 @@ const taimosTypescriptLibraryOptions: TaimosTypescriptLibraryOptions = { ... }
|
|
|
31655
32342
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
31656
32343
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
31657
32344
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
31658
|
-
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
32345
|
+
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. |
|
|
31659
32346
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
31660
32347
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
31661
32348
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -31702,6 +32389,7 @@ const taimosTypescriptLibraryOptions: TaimosTypescriptLibraryOptions = { ... }
|
|
|
31702
32389
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
31703
32390
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
31704
32391
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
32392
|
+
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.typecheckTests">typecheckTests</a></code> | <code>boolean</code> | Type-check the test suite as part of the `test` task. |
|
|
31705
32393
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
31706
32394
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.privateNpm">privateNpm</a></code> | <code>boolean</code> | Whether to enable private NPM registry authentication. |
|
|
31707
32395
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.privateNpmTokenEnvVar">privateNpmTokenEnvVar</a></code> | <code>string</code> | The environment variable name containing the NPM authentication token. |
|
|
@@ -31826,6 +32514,10 @@ public readonly projenCommand: string;
|
|
|
31826
32514
|
|
|
31827
32515
|
The shell command to use in order to run the projen CLI.
|
|
31828
32516
|
|
|
32517
|
+
Inserted verbatim into task steps, workflows and IDE configuration, and run
|
|
32518
|
+
by each of their shells - locally, in CI and in dev containers. Keep it a
|
|
32519
|
+
plain unquoted command, since shell syntax in it executes in all of them.
|
|
32520
|
+
|
|
31829
32521
|
Can be used to customize in special environments.
|
|
31830
32522
|
|
|
31831
32523
|
---
|
|
@@ -32291,6 +32983,51 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
32291
32983
|
|
|
32292
32984
|
---
|
|
32293
32985
|
|
|
32986
|
+
##### `config`<sup>Optional</sup> <a name="config" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.config"></a>
|
|
32987
|
+
|
|
32988
|
+
```typescript
|
|
32989
|
+
public readonly config: {[ key: string ]: any};
|
|
32990
|
+
```
|
|
32991
|
+
|
|
32992
|
+
- *Type:* {[ key: string ]: any}
|
|
32993
|
+
- *Default:* no package configuration
|
|
32994
|
+
|
|
32995
|
+
Configuration values available to package scripts at runtime.
|
|
32996
|
+
|
|
32997
|
+
Values should be JSON-serializable.
|
|
32998
|
+
|
|
32999
|
+
> [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#config)
|
|
33000
|
+
|
|
33001
|
+
---
|
|
33002
|
+
|
|
33003
|
+
##### `dedupeDeps`<sup>Optional</sup> <a name="dedupeDeps" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.dedupeDeps"></a>
|
|
33004
|
+
|
|
33005
|
+
```typescript
|
|
33006
|
+
public readonly dedupeDeps: boolean;
|
|
33007
|
+
```
|
|
33008
|
+
|
|
33009
|
+
- *Type:* boolean
|
|
33010
|
+
- *Default:* false, unless `yarnBerryOptions.dedupePackages` is set
|
|
33011
|
+
|
|
33012
|
+
Add a `dedupe` task that deduplicates project dependencies.
|
|
33013
|
+
|
|
33014
|
+
Deduplication prevents multiple versions of the same package from being
|
|
33015
|
+
installed, if a single version can satisfy all requested version ranges.
|
|
33016
|
+
This prevents version proliferation and reduces the size of the dependency
|
|
33017
|
+
tree.
|
|
33018
|
+
|
|
33019
|
+
The behavior depends on the package manager:
|
|
33020
|
+
- npm: runs `npm dedupe` after every mutating install.
|
|
33021
|
+
- pnpm: runs `pnpm dedupe` after every mutating install.
|
|
33022
|
+
- Yarn Berry: runs `yarn dedupe` after every mutating install. If
|
|
33023
|
+
`yarnBerryOptions.dedupePackages` is set, only the listed packages are
|
|
33024
|
+
deduplicated.
|
|
33025
|
+
- Yarn Classic: `yarn install` already deduplicates, so the task only
|
|
33026
|
+
prints an informational message.
|
|
33027
|
+
- Bun: not supported, enabling this option throws an error.
|
|
33028
|
+
|
|
33029
|
+
---
|
|
33030
|
+
|
|
32294
33031
|
##### `deleteOrphanedLockFiles`<sup>Optional</sup> <a name="deleteOrphanedLockFiles" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.deleteOrphanedLockFiles"></a>
|
|
32295
33032
|
|
|
32296
33033
|
```typescript
|
|
@@ -32755,6 +33492,22 @@ This can be any compatible package version, including the deprecated `standard-v
|
|
|
32755
33492
|
|
|
32756
33493
|
---
|
|
32757
33494
|
|
|
33495
|
+
##### `githubReleaseLatest`<sup>Optional</sup> <a name="githubReleaseLatest" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.githubReleaseLatest"></a>
|
|
33496
|
+
|
|
33497
|
+
```typescript
|
|
33498
|
+
public readonly githubReleaseLatest: boolean;
|
|
33499
|
+
```
|
|
33500
|
+
|
|
33501
|
+
- *Type:* boolean
|
|
33502
|
+
- *Default:* GitHub determines the latest release based on date and semantic version.
|
|
33503
|
+
|
|
33504
|
+
Whether GitHub should explicitly mark the release from the default branch as the latest release.
|
|
33505
|
+
|
|
33506
|
+
Set to `true` to mark the release as latest, or `false` to explicitly not
|
|
33507
|
+
mark it as latest.
|
|
33508
|
+
|
|
33509
|
+
---
|
|
33510
|
+
|
|
32758
33511
|
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.jsiiReleaseVersion"></a>
|
|
32759
33512
|
|
|
32760
33513
|
```typescript
|
|
@@ -33082,7 +33835,9 @@ Container image to use for GitHub workflows.
|
|
|
33082
33835
|
|
|
33083
33836
|
---
|
|
33084
33837
|
|
|
33085
|
-
#####
|
|
33838
|
+
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.workflowRunsOn"></a>
|
|
33839
|
+
|
|
33840
|
+
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
33086
33841
|
|
|
33087
33842
|
```typescript
|
|
33088
33843
|
public readonly workflowRunsOn: string[];
|
|
@@ -33095,7 +33850,9 @@ Github Runner selection labels.
|
|
|
33095
33850
|
|
|
33096
33851
|
---
|
|
33097
33852
|
|
|
33098
|
-
#####
|
|
33853
|
+
##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.workflowRunsOnGroup"></a>
|
|
33854
|
+
|
|
33855
|
+
- *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
|
|
33099
33856
|
|
|
33100
33857
|
```typescript
|
|
33101
33858
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -33252,7 +34009,10 @@ public readonly codeCov: boolean;
|
|
|
33252
34009
|
- *Type:* boolean
|
|
33253
34010
|
- *Default:* false
|
|
33254
34011
|
|
|
33255
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io
|
|
34012
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/.
|
|
34013
|
+
|
|
34014
|
+
Uses codecov/codecov-action. By default, OIDC auth is used.
|
|
34015
|
+
Alternatively a token can be provided via `codeCovTokenSecret`.
|
|
33256
34016
|
|
|
33257
34017
|
---
|
|
33258
34018
|
|
|
@@ -33734,6 +34494,11 @@ public readonly libdir: string;
|
|
|
33734
34494
|
|
|
33735
34495
|
Typescript artifacts output directory.
|
|
33736
34496
|
|
|
34497
|
+
When `libdir` is changed, set `entrypoint` to match it (for example
|
|
34498
|
+
`libdir: "dist"` with `entrypoint: "dist/index.js"`). `types` follows the
|
|
34499
|
+
entrypoint rather than `libdir`, and `main` still defaults to
|
|
34500
|
+
`lib/index.js`.
|
|
34501
|
+
|
|
33737
34502
|
---
|
|
33738
34503
|
|
|
33739
34504
|
##### `projenrcTs`<sup>Optional</sup> <a name="projenrcTs" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.projenrcTs"></a>
|
|
@@ -33876,6 +34641,21 @@ Options for ts-jest.
|
|
|
33876
34641
|
|
|
33877
34642
|
---
|
|
33878
34643
|
|
|
34644
|
+
##### `typecheckTests`<sup>Optional</sup> <a name="typecheckTests" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.typecheckTests"></a>
|
|
34645
|
+
|
|
34646
|
+
```typescript
|
|
34647
|
+
public readonly typecheckTests: boolean;
|
|
34648
|
+
```
|
|
34649
|
+
|
|
34650
|
+
- *Type:* boolean
|
|
34651
|
+
- *Default:* false
|
|
34652
|
+
|
|
34653
|
+
Type-check the test suite as part of the `test` task.
|
|
34654
|
+
|
|
34655
|
+
Adds a `tsc --noEmit` step against the development tsconfig.
|
|
34656
|
+
|
|
34657
|
+
---
|
|
34658
|
+
|
|
33879
34659
|
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.typescriptVersion"></a>
|
|
33880
34660
|
|
|
33881
34661
|
```typescript
|