deployable-awscdk-app-ts 0.0.2 → 0.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/.jsii +40 -23
  2. package/.projenrc.ts +4 -4
  3. package/API.md +390 -167
  4. package/lib/index.d.ts +3 -2
  5. package/lib/index.js +12 -4
  6. package/lib/steps.js +3 -3
  7. package/lib/types.d.ts +9 -2
  8. package/lib/types.js +1 -1
  9. package/package.json +11 -11
package/API.md CHANGED
@@ -1,11 +1,11 @@
1
- # API Reference <a name="API Reference"></a>
1
+ # API Reference <a name="API Reference" id="api-reference"></a>
2
2
 
3
3
 
4
- ## Structs <a name="Structs"></a>
4
+ ## Structs <a name="Structs" id="structs"></a>
5
5
 
6
- ### AWSCredentials <a name="deployable-awscdk-app-ts.AWSCredentials"></a>
6
+ ### AWSCredentials <a name="deployable-awscdk-app-ts.AWSCredentials" id="deployableawscdkapptsawscredentials"></a>
7
7
 
8
- #### Initializer <a name="[object Object].Initializer"></a>
8
+ #### Initializer <a name="[object Object].Initializer" id="object-objectinitializer"></a>
9
9
 
10
10
  ```typescript
11
11
  import { AWSCredentials } from 'deployable-awscdk-app-ts'
@@ -13,7 +13,19 @@ import { AWSCredentials } from 'deployable-awscdk-app-ts'
13
13
  const aWSCredentials: AWSCredentials = { ... }
14
14
  ```
15
15
 
16
- ##### `region`<sup>Required</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.region"></a>
16
+ #### Properties <a name="Properties" id="properties"></a>
17
+
18
+ | **Name** | **Type** | **Description** |
19
+ | --- | --- | --- |
20
+ | [`region`](#deployableawscdkapptsawscredentialspropertyregion)<span title="Required">*</span> | `string` | Default AWS region for the account. |
21
+ | [`accessKeyIdSecretName`](#deployableawscdkapptsawscredentialspropertyaccesskeyidsecretname) | `string` | GitHub Secret name for AWS Access Key Id. |
22
+ | [`assumeRoleDurationSeconds`](#deployableawscdkapptsawscredentialspropertyassumeroledurationseconds) | `number` | Duration of assume role session. |
23
+ | [`roleToAssume`](#deployableawscdkapptsawscredentialspropertyroletoassume) | `string` | ARN of AWS role to be assumed. |
24
+ | [`secretAccessKeySecretName`](#deployableawscdkapptsawscredentialspropertysecretaccesskeysecretname) | `string` | GitHub Secret name for AWS Secret Access Key. |
25
+
26
+ ---
27
+
28
+ ##### `region`<sup>Required</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.region" id="deployableawscdkapptsawscredentialspropertyregion"></a>
17
29
 
18
30
  ```typescript
19
31
  public readonly region: string;
@@ -25,7 +37,7 @@ Default AWS region for the account.
25
37
 
26
38
  ---
27
39
 
28
- ##### `accessKeyIdSecretName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.accessKeyIdSecretName"></a>
40
+ ##### `accessKeyIdSecretName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.accessKeyIdSecretName" id="deployableawscdkapptsawscredentialspropertyaccesskeyidsecretname"></a>
29
41
 
30
42
  ```typescript
31
43
  public readonly accessKeyIdSecretName: string;
@@ -38,7 +50,7 @@ GitHub Secret name for AWS Access Key Id.
38
50
 
39
51
  ---
40
52
 
41
- ##### `assumeRoleDurationSeconds`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.assumeRoleDurationSeconds"></a>
53
+ ##### `assumeRoleDurationSeconds`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.assumeRoleDurationSeconds" id="deployableawscdkapptsawscredentialspropertyassumeroledurationseconds"></a>
42
54
 
43
55
  ```typescript
44
56
  public readonly assumeRoleDurationSeconds: number;
@@ -51,7 +63,7 @@ Duration of assume role session.
51
63
 
52
64
  ---
53
65
 
54
- ##### `roleToAssume`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.roleToAssume"></a>
66
+ ##### `roleToAssume`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.roleToAssume" id="deployableawscdkapptsawscredentialspropertyroletoassume"></a>
55
67
 
56
68
  ```typescript
57
69
  public readonly roleToAssume: string;
@@ -63,7 +75,7 @@ ARN of AWS role to be assumed.
63
75
 
64
76
  ---
65
77
 
66
- ##### `secretAccessKeySecretName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.secretAccessKeySecretName"></a>
78
+ ##### `secretAccessKeySecretName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.secretAccessKeySecretName" id="deployableawscdkapptsawscredentialspropertysecretaccesskeysecretname"></a>
67
79
 
68
80
  ```typescript
69
81
  public readonly secretAccessKeySecretName: string;
@@ -76,9 +88,9 @@ GitHub Secret name for AWS Secret Access Key.
76
88
 
77
89
  ---
78
90
 
79
- ### DeployableAwsCdkTypeScriptAppOptions <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions"></a>
91
+ ### DeployableAwsCdkTypeScriptAppOptions <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptions"></a>
80
92
 
81
- #### Initializer <a name="[object Object].Initializer"></a>
93
+ #### Initializer <a name="[object Object].Initializer" id="object-objectinitializer"></a>
82
94
 
83
95
  ```typescript
84
96
  import { DeployableAwsCdkTypeScriptAppOptions } from 'deployable-awscdk-app-ts'
@@ -86,7 +98,149 @@ import { DeployableAwsCdkTypeScriptAppOptions } from 'deployable-awscdk-app-ts'
86
98
  const deployableAwsCdkTypeScriptAppOptions: DeployableAwsCdkTypeScriptAppOptions = { ... }
87
99
  ```
88
100
 
89
- ##### `name`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.name"></a>
101
+ #### Properties <a name="Properties" id="properties"></a>
102
+
103
+ | **Name** | **Type** | **Description** |
104
+ | --- | --- | --- |
105
+ | [`name`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyname)<span title="Required">*</span> | `string` | This is the name of your project. |
106
+ | [`logging`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertylogging) | [`projen.LoggerOptions`](#projen.LoggerOptions) | Configure logging options such as verbosity. |
107
+ | [`outdir`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyoutdir) | `string` | The root directory of the project. |
108
+ | [`parent`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyparent) | [`projen.Project`](#projen.Project) | The parent project, if this project is part of a bigger project. |
109
+ | [`projenCommand`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojencommand) | `string` | The shell command to use in order to run the projen CLI. |
110
+ | [`projenrcJson`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenrcjson) | `boolean` | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
111
+ | [`projenrcJsonOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenrcjsonoptions) | [`projen.ProjenrcOptions`](#projen.ProjenrcOptions) | Options for .projenrc.json. |
112
+ | [`autoApproveOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyautoapproveoptions) | [`projen.github.AutoApproveOptions`](#projen.github.AutoApproveOptions) | Enable and configure the 'auto approve' workflow. |
113
+ | [`autoMergeOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyautomergeoptions) | [`projen.github.AutoMergeOptions`](#projen.github.AutoMergeOptions) | Configure options for automatic merging on GitHub. |
114
+ | [`clobber`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyclobber) | `boolean` | Add a `clobber` task which resets the repo to origin. |
115
+ | [`devContainer`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydevcontainer) | `boolean` | Add a VSCode development environment (used for GitHub Codespaces). |
116
+ | [`github`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertygithub) | `boolean` | Enable GitHub integration. |
117
+ | [`githubOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertygithuboptions) | [`projen.github.GitHubOptions`](#projen.github.GitHubOptions) | Options for GitHub integration. |
118
+ | [`gitpod`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertygitpod) | `boolean` | Add a Gitpod development environment. |
119
+ | [`mergify`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertymergify) | `boolean` | Whether mergify should be enabled on this repository or not. |
120
+ | [`mergifyOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertymergifyoptions) | [`projen.github.MergifyOptions`](#projen.github.MergifyOptions) | Options for mergify. |
121
+ | [`projectType`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojecttype) | [`projen.ProjectType`](#projen.ProjectType) | Which type of project this is (library/app). |
122
+ | [`readme`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreadme) | [`projen.SampleReadmeProps`](#projen.SampleReadmeProps) | The README setup. |
123
+ | [`stale`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertystale) | `boolean` | Auto-close of stale issues and pull request. |
124
+ | [`staleOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertystaleoptions) | [`projen.github.StaleOptions`](#projen.github.StaleOptions) | Auto-close stale issues and pull requests. |
125
+ | [`vscode`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyvscode) | `boolean` | Enable VSCode integration. |
126
+ | [`allowLibraryDependencies`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyallowlibrarydependencies) | `boolean` | Allow the project to include `peerDependencies` and `bundledDependencies`. |
127
+ | [`authorEmail`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyauthoremail) | `string` | Author's e-mail. |
128
+ | [`authorName`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyauthorname) | `string` | Author's name. |
129
+ | [`authorOrganization`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyauthororganization) | `boolean` | Author's Organization. |
130
+ | [`authorUrl`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyauthorurl) | `string` | Author's URL / Website. |
131
+ | [`autoDetectBin`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyautodetectbin) | `boolean` | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
132
+ | [`bin`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertybin) | {[ key: string ]: `string`} | Binary programs vended with your module. |
133
+ | [`bundledDeps`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertybundleddeps) | `string`[] | List of dependencies to bundle into this module. |
134
+ | [`codeArtifactOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycodeartifactoptions) | [`projen.javascript.CodeArtifactOptions`](#projen.javascript.CodeArtifactOptions) | Options for publishing npm package to AWS CodeArtifact. |
135
+ | [`deps`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydeps) | `string`[] | Runtime dependencies of this module. |
136
+ | [`description`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydescription) | `string` | The description is just a string that helps people understand the purpose of the package. |
137
+ | [`devDeps`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydevdeps) | `string`[] | Build dependencies for this module. |
138
+ | [`entrypoint`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyentrypoint) | `string` | Module entrypoint (`main` in `package.json`). |
139
+ | [`homepage`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyhomepage) | `string` | Package's Homepage / Website. |
140
+ | [`keywords`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertykeywords) | `string`[] | Keywords to include in `package.json`. |
141
+ | [`license`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertylicense) | `string` | License's SPDX identifier. |
142
+ | [`licensed`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertylicensed) | `boolean` | Indicates if a license should be added. |
143
+ | [`maxNodeVersion`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertymaxnodeversion) | `string` | Minimum node.js version to require via `engines` (inclusive). |
144
+ | [`minNodeVersion`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyminnodeversion) | `string` | Minimum Node.js version to require via package.json `engines` (inclusive). |
145
+ | [`npmAccess`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmaccess) | [`projen.javascript.NpmAccess`](#projen.javascript.NpmAccess) | Access level of the npm package. |
146
+ | [`npmDistTag`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmdisttag) | `string` | Tags can be used to provide an alias instead of version numbers. |
147
+ | [`npmRegistry`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmregistry) | `string` | The host name of the npm registry to publish to. |
148
+ | [`npmRegistryUrl`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmregistryurl) | `string` | The base URL of the npm package registry. |
149
+ | [`npmTokenSecret`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmtokensecret) | `string` | GitHub secret which contains the NPM token to use when publishing packages. |
150
+ | [`packageManager`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypackagemanager) | [`projen.javascript.NodePackageManager`](#projen.javascript.NodePackageManager) | The Node Package Manager used to execute scripts. |
151
+ | [`packageName`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypackagename) | `string` | The "name" in package.json. |
152
+ | [`peerDependencyOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypeerdependencyoptions) | [`projen.javascript.PeerDependencyOptions`](#projen.javascript.PeerDependencyOptions) | Options for `peerDeps`. |
153
+ | [`peerDeps`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypeerdeps) | `string`[] | Peer dependencies for this module. |
154
+ | [`repository`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyrepository) | `string` | The repository is the location where the actual code for your package lives. |
155
+ | [`repositoryDirectory`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyrepositorydirectory) | `string` | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
156
+ | [`scripts`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyscripts) | {[ key: string ]: `string`} | npm scripts to include. |
157
+ | [`stability`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertystability) | `string` | Package's Stability. |
158
+ | [`antitamper`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyantitamper) | `boolean` | Checks that after build there are no modified files on git. |
159
+ | [`artifactsDirectory`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyartifactsdirectory) | `string` | A directory which will contain artifacts to be published to npm. |
160
+ | [`jsiiReleaseVersion`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyjsiireleaseversion) | `string` | Version requirement of `jsii-release` which is used to publish modules to npm. |
161
+ | [`majorVersion`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertymajorversion) | `number` | Major version to release from the default branch. |
162
+ | [`postBuildSteps`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypostbuildsteps) | [`projen.github.workflows.JobStep`](#projen.github.workflows.JobStep)[] | Steps to execute after build as part of the release workflow. |
163
+ | [`prerelease`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprerelease) | `string` | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). |
164
+ | [`releaseBranches`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleasebranches) | {[ key: string ]: [`projen.release.BranchOptions`](#projen.release.BranchOptions)} | Defines additional release branches. |
165
+ | [`releaseEveryCommit`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleaseeverycommit) | `boolean` | Automatically release new versions every commit to one of branches in `releaseBranches`. |
166
+ | [`releaseFailureIssue`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleasefailureissue) | `boolean` | Create a github issue on every failed publishing task. |
167
+ | [`releaseFailureIssueLabel`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleasefailureissuelabel) | `string` | The label to apply to issues indicating publish failures. |
168
+ | [`releaseSchedule`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleaseschedule) | `string` | CRON schedule to trigger new releases. |
169
+ | [`releaseTagPrefix`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleasetagprefix) | `string` | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
170
+ | [`releaseTrigger`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleasetrigger) | [`projen.release.ReleaseTrigger`](#projen.release.ReleaseTrigger) | The release trigger to use. |
171
+ | [`releaseWorkflowName`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleaseworkflowname) | `string` | The name of the default release workflow. |
172
+ | [`releaseWorkflowSetupSteps`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleaseworkflowsetupsteps) | [`projen.github.workflows.JobStep`](#projen.github.workflows.JobStep)[] | A set of workflow steps to execute in order to setup the workflow container. |
173
+ | [`versionrcOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyversionrcoptions) | {[ key: string ]: `any`} | Custom configuration used when creating changelog with standard-version package. |
174
+ | [`workflowContainerImage`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyworkflowcontainerimage) | `string` | Container image to use for GitHub workflows. |
175
+ | [`defaultReleaseBranch`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydefaultreleasebranch)<span title="Required">*</span> | `string` | The name of the main release branch. |
176
+ | [`autoApproveProjenUpgrades`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyautoapproveprojenupgrades) | `boolean` | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). |
177
+ | [`autoApproveUpgrades`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyautoapproveupgrades) | `boolean` | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
178
+ | [`buildWorkflow`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertybuildworkflow) | `boolean` | Define a GitHub workflow for building PRs. |
179
+ | [`bundlerOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertybundleroptions) | [`projen.javascript.BundlerOptions`](#projen.javascript.BundlerOptions) | Options for `Bundler`. |
180
+ | [`codeCov`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycodecov) | `boolean` | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. |
181
+ | [`codeCovTokenSecret`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycodecovtokensecret) | `string` | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
182
+ | [`copyrightOwner`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycopyrightowner) | `string` | License copyright owner. |
183
+ | [`copyrightPeriod`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycopyrightperiod) | `string` | The copyright years to put in the LICENSE file. |
184
+ | [`dependabot`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydependabot) | `boolean` | Use dependabot to handle dependency upgrades. |
185
+ | [`dependabotOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydependabotoptions) | [`projen.github.DependabotOptions`](#projen.github.DependabotOptions) | Options for dependabot. |
186
+ | [`depsUpgrade`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydepsupgrade) | `boolean` | Use github workflows to handle dependency upgrades. |
187
+ | [`depsUpgradeOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydepsupgradeoptions) | [`projen.javascript.UpgradeDependenciesOptions`](#projen.javascript.UpgradeDependenciesOptions) | Options for depsUpgrade. |
188
+ | [`gitignore`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertygitignore) | `string`[] | Additional entries to .gitignore. |
189
+ | [`jest`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyjest) | `boolean` | Setup jest unit tests. |
190
+ | [`jestOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyjestoptions) | [`projen.javascript.JestOptions`](#projen.javascript.JestOptions) | Jest options. |
191
+ | [`mutableBuild`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertymutablebuild) | `boolean` | Automatically update files modified during builds to pull-request branches. |
192
+ | [`npmignore`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmignore) | `string`[] | Additional entries to .npmignore. |
193
+ | [`npmignoreEnabled`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmignoreenabled) | `boolean` | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
194
+ | [`projenDevDependency`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojendevdependency) | `boolean` | Indicates of "projen" should be installed as a devDependency. |
195
+ | [`projenrcJs`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenrcjs) | `boolean` | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. |
196
+ | [`projenrcJsOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenrcjsoptions) | [`projen.javascript.ProjenrcOptions`](#projen.javascript.ProjenrcOptions) | Options for .projenrc.js. |
197
+ | [`projenUpgradeAutoMerge`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenupgradeautomerge) | `boolean` | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). |
198
+ | [`projenUpgradeSchedule`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenupgradeschedule) | `string`[] | Customize the projenUpgrade schedule in cron expression. |
199
+ | [`projenUpgradeSecret`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenupgradesecret) | `string` | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). |
200
+ | [`projenVersion`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenversion) | `string` | Version of projen to install. |
201
+ | [`pullRequestTemplate`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypullrequesttemplate) | `boolean` | Include a GitHub pull request template. |
202
+ | [`pullRequestTemplateContents`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypullrequesttemplatecontents) | `string`[] | The contents of the pull request template. |
203
+ | [`release`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyrelease) | `boolean` | Add release management to this project. |
204
+ | [`releaseToNpm`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleasetonpm) | `boolean` | Automatically release to npm when new versions are introduced. |
205
+ | [`releaseWorkflow`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleaseworkflow) | `boolean` | DEPRECATED: renamed to `release`. |
206
+ | [`workflowBootstrapSteps`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyworkflowbootstrapsteps) | `any`[] | Workflow steps to use in order to bootstrap this repo. |
207
+ | [`workflowGitIdentity`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyworkflowgitidentity) | [`projen.github.GitIdentity`](#projen.github.GitIdentity) | The git identity to use in workflows. |
208
+ | [`workflowNodeVersion`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyworkflownodeversion) | `string` | The node version to use in GitHub workflows. |
209
+ | [`disableTsconfig`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydisabletsconfig) | `boolean` | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
210
+ | [`docgen`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydocgen) | `boolean` | Docgen by Typedoc. |
211
+ | [`docsDirectory`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydocsdirectory) | `string` | Docs directory. |
212
+ | [`entrypointTypes`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyentrypointtypes) | `string` | The .d.ts file that includes the type declarations for this module. |
213
+ | [`eslint`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyeslint) | `boolean` | Setup eslint. |
214
+ | [`eslintOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyeslintoptions) | [`projen.javascript.EslintOptions`](#projen.javascript.EslintOptions) | Eslint options. |
215
+ | [`libdir`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertylibdir) | `string` | Typescript artifacts output directory. |
216
+ | [`package`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypackage) | `boolean` | Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. |
217
+ | [`projenrcTs`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenrcts) | `boolean` | Use TypeScript for your projenrc file (`.projenrc.ts`). |
218
+ | [`projenrcTsOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenrctsoptions) | [`projen.typescript.ProjenrcOptions`](#projen.typescript.ProjenrcOptions) | Options for .projenrc.ts. |
219
+ | [`sampleCode`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertysamplecode) | `boolean` | Generate one-time sample in `src/` and `test/` if there are no files there. |
220
+ | [`srcdir`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertysrcdir) | `string` | Typescript sources directory. |
221
+ | [`testdir`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertytestdir) | `string` | Jest tests directory. Tests files should be named `xxx.test.ts`. |
222
+ | [`tsconfig`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertytsconfig) | [`projen.javascript.TypescriptConfigOptions`](#projen.javascript.TypescriptConfigOptions) | Custom TSConfig. |
223
+ | [`tsconfigDev`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertytsconfigdev) | [`projen.javascript.TypescriptConfigOptions`](#projen.javascript.TypescriptConfigOptions) | Custom tsconfig options for the development tsconfig.json file (used for testing). |
224
+ | [`tsconfigDevFile`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertytsconfigdevfile) | `string` | The name of the development tsconfig.json file. |
225
+ | [`typescriptVersion`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertytypescriptversion) | `string` | TypeScript version to use. |
226
+ | [`cdkout`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycdkout) | `string` | cdk.out directory. |
227
+ | [`context`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycontext) | {[ key: string ]: `string`} | Additional context to include in `cdk.json`. |
228
+ | [`featureFlags`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyfeatureflags) | `boolean` | Include all feature flags in cdk.json. |
229
+ | [`requireApproval`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyrequireapproval) | [`projen.awscdk.ApprovalLevel`](#projen.awscdk.ApprovalLevel) | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. |
230
+ | [`watchExcludes`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertywatchexcludes) | `string`[] | Glob patterns to exclude from `cdk watch`. |
231
+ | [`watchIncludes`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertywatchincludes) | `string`[] | Glob patterns to include in `cdk watch`. |
232
+ | [`cdkVersion`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycdkversion)<span title="Required">*</span> | `string` | AWS CDK version to use. |
233
+ | [`appEntrypoint`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyappentrypoint) | `string` | The CDK app's entrypoint (relative to the source directory, which is "src" by default). |
234
+ | [`cdkDependencies`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycdkdependencies) | `string`[] | Which AWS CDK modules (those that start with "@aws-cdk/") this app uses. |
235
+ | [`cdkVersionPinning`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycdkversionpinning) | `boolean` | Use pinned version instead of caret version for CDK. |
236
+ | [`lambdaAutoDiscover`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertylambdaautodiscover) | `boolean` | Automatically adds an `awscdk.LambdaFunction` for each `.lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. |
237
+ | [`lambdaOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertylambdaoptions) | [`projen.awscdk.LambdaFunctionCommonOptions`](#projen.awscdk.LambdaFunctionCommonOptions) | Common options for all AWS Lambda functions. |
238
+ | [`deployOptions`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydeployoptions)<span title="Required">*</span> | [`deployable-awscdk-app-ts.DeployOptions`](#deployable-awscdk-app-ts.DeployOptions) | Deployment options. |
239
+ | [`generateNvmrc`](#deployableawscdkapptsdeployableawscdktypescriptappoptionspropertygeneratenvmrc) | `boolean` | Whether to generate nvmrc file for the node version of the project. |
240
+
241
+ ---
242
+
243
+ ##### `name`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.name" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyname"></a>
90
244
 
91
245
  ```typescript
92
246
  public readonly name: string;
@@ -99,7 +253,7 @@ This is the name of your project.
99
253
 
100
254
  ---
101
255
 
102
- ##### `logging`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.logging"></a>
256
+ ##### `logging`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.logging" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertylogging"></a>
103
257
 
104
258
  ```typescript
105
259
  public readonly logging: LoggerOptions;
@@ -112,7 +266,7 @@ Configure logging options such as verbosity.
112
266
 
113
267
  ---
114
268
 
115
- ##### `outdir`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.outdir"></a>
269
+ ##### `outdir`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.outdir" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyoutdir"></a>
116
270
 
117
271
  ```typescript
118
272
  public readonly outdir: string;
@@ -127,7 +281,7 @@ Relative to this directory, all files are synthesized. If this project has a pa
127
281
 
128
282
  ---
129
283
 
130
- ##### `parent`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.parent"></a>
284
+ ##### `parent`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.parent" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyparent"></a>
131
285
 
132
286
  ```typescript
133
287
  public readonly parent: Project;
@@ -139,7 +293,7 @@ The parent project, if this project is part of a bigger project.
139
293
 
140
294
  ---
141
295
 
142
- ##### `projenCommand`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenCommand"></a>
296
+ ##### `projenCommand`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenCommand" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojencommand"></a>
143
297
 
144
298
  ```typescript
145
299
  public readonly projenCommand: string;
@@ -154,7 +308,7 @@ Can be used to customize in special environments.
154
308
 
155
309
  ---
156
310
 
157
- ##### `projenrcJson`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJson"></a>
311
+ ##### `projenrcJson`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJson" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenrcjson"></a>
158
312
 
159
313
  ```typescript
160
314
  public readonly projenrcJson: boolean;
@@ -167,20 +321,20 @@ Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .pr
167
321
 
168
322
  ---
169
323
 
170
- ##### `projenrcJsonOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJsonOptions"></a>
324
+ ##### `projenrcJsonOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJsonOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenrcjsonoptions"></a>
171
325
 
172
326
  ```typescript
173
327
  public readonly projenrcJsonOptions: ProjenrcOptions;
174
328
  ```
175
329
 
176
- - *Type:* [`projen.json.ProjenrcOptions`](#projen.json.ProjenrcOptions)
330
+ - *Type:* [`projen.ProjenrcOptions`](#projen.ProjenrcOptions)
177
331
  - *Default:* default options
178
332
 
179
333
  Options for .projenrc.json.
180
334
 
181
335
  ---
182
336
 
183
- ##### `autoApproveOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoApproveOptions"></a>
337
+ ##### `autoApproveOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoApproveOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyautoapproveoptions"></a>
184
338
 
185
339
  ```typescript
186
340
  public readonly autoApproveOptions: AutoApproveOptions;
@@ -193,7 +347,7 @@ Enable and configure the 'auto approve' workflow.
193
347
 
194
348
  ---
195
349
 
196
- ##### `autoMergeOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoMergeOptions"></a>
350
+ ##### `autoMergeOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoMergeOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyautomergeoptions"></a>
197
351
 
198
352
  ```typescript
199
353
  public readonly autoMergeOptions: AutoMergeOptions;
@@ -208,7 +362,7 @@ Has no effect if `github.mergify` is set to false.
208
362
 
209
363
  ---
210
364
 
211
- ##### `clobber`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.clobber"></a>
365
+ ##### `clobber`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.clobber" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyclobber"></a>
212
366
 
213
367
  ```typescript
214
368
  public readonly clobber: boolean;
@@ -221,7 +375,7 @@ Add a `clobber` task which resets the repo to origin.
221
375
 
222
376
  ---
223
377
 
224
- ##### `devContainer`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.devContainer"></a>
378
+ ##### `devContainer`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.devContainer" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydevcontainer"></a>
225
379
 
226
380
  ```typescript
227
381
  public readonly devContainer: boolean;
@@ -234,7 +388,7 @@ Add a VSCode development environment (used for GitHub Codespaces).
234
388
 
235
389
  ---
236
390
 
237
- ##### `github`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.github"></a>
391
+ ##### `github`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.github" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertygithub"></a>
238
392
 
239
393
  ```typescript
240
394
  public readonly github: boolean;
@@ -249,7 +403,7 @@ Enabled by default for root projects. Disabled for non-root projects.
249
403
 
250
404
  ---
251
405
 
252
- ##### `githubOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.githubOptions"></a>
406
+ ##### `githubOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.githubOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertygithuboptions"></a>
253
407
 
254
408
  ```typescript
255
409
  public readonly githubOptions: GitHubOptions;
@@ -262,7 +416,7 @@ Options for GitHub integration.
262
416
 
263
417
  ---
264
418
 
265
- ##### `gitpod`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.gitpod"></a>
419
+ ##### `gitpod`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.gitpod" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertygitpod"></a>
266
420
 
267
421
  ```typescript
268
422
  public readonly gitpod: boolean;
@@ -275,7 +429,7 @@ Add a Gitpod development environment.
275
429
 
276
430
  ---
277
431
 
278
- ##### ~~`mergify`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mergify"></a>
432
+ ##### ~~`mergify`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mergify" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertymergify"></a>
279
433
 
280
434
  - *Deprecated:* use `githubOptions.mergify` instead
281
435
 
@@ -290,7 +444,7 @@ Whether mergify should be enabled on this repository or not.
290
444
 
291
445
  ---
292
446
 
293
- ##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mergifyOptions"></a>
447
+ ##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mergifyOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertymergifyoptions"></a>
294
448
 
295
449
  - *Deprecated:* use `githubOptions.mergifyOptions` instead
296
450
 
@@ -305,7 +459,7 @@ Options for mergify.
305
459
 
306
460
  ---
307
461
 
308
- ##### ~~`projectType`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projectType"></a>
462
+ ##### ~~`projectType`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projectType" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojecttype"></a>
309
463
 
310
464
  - *Deprecated:* no longer supported at the base project level
311
465
 
@@ -320,7 +474,7 @@ Which type of project this is (library/app).
320
474
 
321
475
  ---
322
476
 
323
- ##### `readme`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.readme"></a>
477
+ ##### `readme`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.readme" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreadme"></a>
324
478
 
325
479
  ```typescript
326
480
  public readonly readme: SampleReadmeProps;
@@ -333,7 +487,7 @@ The README setup.
333
487
 
334
488
  ---
335
489
 
336
- ##### `stale`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.stale"></a>
490
+ ##### `stale`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.stale" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertystale"></a>
337
491
 
338
492
  ```typescript
339
493
  public readonly stale: boolean;
@@ -348,7 +502,7 @@ See `staleOptions` for options.
348
502
 
349
503
  ---
350
504
 
351
- ##### `staleOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.staleOptions"></a>
505
+ ##### `staleOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.staleOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertystaleoptions"></a>
352
506
 
353
507
  ```typescript
354
508
  public readonly staleOptions: StaleOptions;
@@ -363,7 +517,7 @@ To disable set `stale` to `false`.
363
517
 
364
518
  ---
365
519
 
366
- ##### `vscode`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.vscode"></a>
520
+ ##### `vscode`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.vscode" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyvscode"></a>
367
521
 
368
522
  ```typescript
369
523
  public readonly vscode: boolean;
@@ -378,7 +532,7 @@ Enabled by default for root projects. Disabled for non-root projects.
378
532
 
379
533
  ---
380
534
 
381
- ##### `allowLibraryDependencies`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.allowLibraryDependencies"></a>
535
+ ##### `allowLibraryDependencies`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.allowLibraryDependencies" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyallowlibrarydependencies"></a>
382
536
 
383
537
  ```typescript
384
538
  public readonly allowLibraryDependencies: boolean;
@@ -393,7 +547,7 @@ This is normally only allowed for libraries. For apps, there's no meaning for sp
393
547
 
394
548
  ---
395
549
 
396
- ##### `authorEmail`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorEmail"></a>
550
+ ##### `authorEmail`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorEmail" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyauthoremail"></a>
397
551
 
398
552
  ```typescript
399
553
  public readonly authorEmail: string;
@@ -405,7 +559,7 @@ Author's e-mail.
405
559
 
406
560
  ---
407
561
 
408
- ##### `authorName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorName"></a>
562
+ ##### `authorName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorName" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyauthorname"></a>
409
563
 
410
564
  ```typescript
411
565
  public readonly authorName: string;
@@ -417,7 +571,7 @@ Author's name.
417
571
 
418
572
  ---
419
573
 
420
- ##### `authorOrganization`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorOrganization"></a>
574
+ ##### `authorOrganization`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorOrganization" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyauthororganization"></a>
421
575
 
422
576
  ```typescript
423
577
  public readonly authorOrganization: boolean;
@@ -429,7 +583,7 @@ Author's Organization.
429
583
 
430
584
  ---
431
585
 
432
- ##### `authorUrl`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorUrl"></a>
586
+ ##### `authorUrl`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorUrl" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyauthorurl"></a>
433
587
 
434
588
  ```typescript
435
589
  public readonly authorUrl: string;
@@ -441,7 +595,7 @@ Author's URL / Website.
441
595
 
442
596
  ---
443
597
 
444
- ##### `autoDetectBin`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoDetectBin"></a>
598
+ ##### `autoDetectBin`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoDetectBin" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyautodetectbin"></a>
445
599
 
446
600
  ```typescript
447
601
  public readonly autoDetectBin: boolean;
@@ -454,7 +608,7 @@ Automatically add all executables under the `bin` directory to your `package.jso
454
608
 
455
609
  ---
456
610
 
457
- ##### `bin`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bin"></a>
611
+ ##### `bin`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bin" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertybin"></a>
458
612
 
459
613
  ```typescript
460
614
  public readonly bin: {[ key: string ]: string};
@@ -468,7 +622,7 @@ You can use this option to add/customize how binaries are represented in your `p
468
622
 
469
623
  ---
470
624
 
471
- ##### `bundledDeps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bundledDeps"></a>
625
+ ##### `bundledDeps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bundledDeps" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertybundleddeps"></a>
472
626
 
473
627
  ```typescript
474
628
  public readonly bundledDeps: string[];
@@ -482,20 +636,20 @@ These modules will be added both to the `dependencies` section and `peerDependen
482
636
 
483
637
  ---
484
638
 
485
- ##### `codeArtifactOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeArtifactOptions"></a>
639
+ ##### `codeArtifactOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeArtifactOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycodeartifactoptions"></a>
486
640
 
487
641
  ```typescript
488
642
  public readonly codeArtifactOptions: CodeArtifactOptions;
489
643
  ```
490
644
 
491
- - *Type:* [`projen.CodeArtifactOptions`](#projen.CodeArtifactOptions)
645
+ - *Type:* [`projen.javascript.CodeArtifactOptions`](#projen.javascript.CodeArtifactOptions)
492
646
  - *Default:* undefined
493
647
 
494
648
  Options for publishing npm package to AWS CodeArtifact.
495
649
 
496
650
  ---
497
651
 
498
- ##### `deps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.deps"></a>
652
+ ##### `deps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.deps" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydeps"></a>
499
653
 
500
654
  ```typescript
501
655
  public readonly deps: string[];
@@ -510,7 +664,7 @@ The recommendation is to only specify the module name here (e.g. `express`). Thi
510
664
 
511
665
  ---
512
666
 
513
- ##### `description`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.description"></a>
667
+ ##### `description`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.description" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydescription"></a>
514
668
 
515
669
  ```typescript
516
670
  public readonly description: string;
@@ -524,7 +678,7 @@ It can be used when searching for packages in a package manager as well. See htt
524
678
 
525
679
  ---
526
680
 
527
- ##### `devDeps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.devDeps"></a>
681
+ ##### `devDeps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.devDeps" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydevdeps"></a>
528
682
 
529
683
  ```typescript
530
684
  public readonly devDeps: string[];
@@ -539,7 +693,7 @@ These dependencies will only be available in your build environment but will not
539
693
 
540
694
  ---
541
695
 
542
- ##### `entrypoint`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.entrypoint"></a>
696
+ ##### `entrypoint`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.entrypoint" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyentrypoint"></a>
543
697
 
544
698
  ```typescript
545
699
  public readonly entrypoint: string;
@@ -554,7 +708,7 @@ Set to an empty string to not include `main` in your package.json
554
708
 
555
709
  ---
556
710
 
557
- ##### `homepage`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.homepage"></a>
711
+ ##### `homepage`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.homepage" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyhomepage"></a>
558
712
 
559
713
  ```typescript
560
714
  public readonly homepage: string;
@@ -566,7 +720,7 @@ Package's Homepage / Website.
566
720
 
567
721
  ---
568
722
 
569
- ##### `keywords`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.keywords"></a>
723
+ ##### `keywords`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.keywords" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertykeywords"></a>
570
724
 
571
725
  ```typescript
572
726
  public readonly keywords: string[];
@@ -578,7 +732,7 @@ Keywords to include in `package.json`.
578
732
 
579
733
  ---
580
734
 
581
- ##### `license`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.license"></a>
735
+ ##### `license`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.license" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertylicense"></a>
582
736
 
583
737
  ```typescript
584
738
  public readonly license: string;
@@ -593,7 +747,7 @@ See https://github.com/projen/projen/tree/main/license-text for a list of suppor
593
747
 
594
748
  ---
595
749
 
596
- ##### `licensed`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.licensed"></a>
750
+ ##### `licensed`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.licensed" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertylicensed"></a>
597
751
 
598
752
  ```typescript
599
753
  public readonly licensed: boolean;
@@ -606,7 +760,7 @@ Indicates if a license should be added.
606
760
 
607
761
  ---
608
762
 
609
- ##### `maxNodeVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.maxNodeVersion"></a>
763
+ ##### `maxNodeVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.maxNodeVersion" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertymaxnodeversion"></a>
610
764
 
611
765
  ```typescript
612
766
  public readonly maxNodeVersion: string;
@@ -619,7 +773,7 @@ Minimum node.js version to require via `engines` (inclusive).
619
773
 
620
774
  ---
621
775
 
622
- ##### `minNodeVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.minNodeVersion"></a>
776
+ ##### `minNodeVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.minNodeVersion" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyminnodeversion"></a>
623
777
 
624
778
  ```typescript
625
779
  public readonly minNodeVersion: string;
@@ -632,20 +786,20 @@ Minimum Node.js version to require via package.json `engines` (inclusive).
632
786
 
633
787
  ---
634
788
 
635
- ##### `npmAccess`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmAccess"></a>
789
+ ##### `npmAccess`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmAccess" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmaccess"></a>
636
790
 
637
791
  ```typescript
638
792
  public readonly npmAccess: NpmAccess;
639
793
  ```
640
794
 
641
- - *Type:* [`projen.NpmAccess`](#projen.NpmAccess)
795
+ - *Type:* [`projen.javascript.NpmAccess`](#projen.javascript.NpmAccess)
642
796
  - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
643
797
 
644
798
  Access level of the npm package.
645
799
 
646
800
  ---
647
801
 
648
- ##### `npmDistTag`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmDistTag"></a>
802
+ ##### `npmDistTag`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmDistTag" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmdisttag"></a>
649
803
 
650
804
  ```typescript
651
805
  public readonly npmDistTag: string;
@@ -660,7 +814,7 @@ For example, a project might choose to have multiple streams of development and
660
814
 
661
815
  ---
662
816
 
663
- ##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmRegistry"></a>
817
+ ##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmRegistry" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmregistry"></a>
664
818
 
665
819
  - *Deprecated:* use `npmRegistryUrl` instead
666
820
 
@@ -676,7 +830,7 @@ Cannot be set together with `npmRegistryUrl`.
676
830
 
677
831
  ---
678
832
 
679
- ##### `npmRegistryUrl`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmRegistryUrl"></a>
833
+ ##### `npmRegistryUrl`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmRegistryUrl" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmregistryurl"></a>
680
834
 
681
835
  ```typescript
682
836
  public readonly npmRegistryUrl: string;
@@ -691,7 +845,7 @@ Must be a URL (e.g. start with "https://" or "http://")
691
845
 
692
846
  ---
693
847
 
694
- ##### `npmTokenSecret`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmTokenSecret"></a>
848
+ ##### `npmTokenSecret`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmTokenSecret" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmtokensecret"></a>
695
849
 
696
850
  ```typescript
697
851
  public readonly npmTokenSecret: string;
@@ -704,20 +858,20 @@ GitHub secret which contains the NPM token to use when publishing packages.
704
858
 
705
859
  ---
706
860
 
707
- ##### `packageManager`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.packageManager"></a>
861
+ ##### `packageManager`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.packageManager" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypackagemanager"></a>
708
862
 
709
863
  ```typescript
710
864
  public readonly packageManager: NodePackageManager;
711
865
  ```
712
866
 
713
- - *Type:* [`projen.NodePackageManager`](#projen.NodePackageManager)
867
+ - *Type:* [`projen.javascript.NodePackageManager`](#projen.javascript.NodePackageManager)
714
868
  - *Default:* NodePackageManager.YARN
715
869
 
716
870
  The Node Package Manager used to execute scripts.
717
871
 
718
872
  ---
719
873
 
720
- ##### `packageName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.packageName"></a>
874
+ ##### `packageName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.packageName" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypackagename"></a>
721
875
 
722
876
  ```typescript
723
877
  public readonly packageName: string;
@@ -730,19 +884,19 @@ The "name" in package.json.
730
884
 
731
885
  ---
732
886
 
733
- ##### `peerDependencyOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.peerDependencyOptions"></a>
887
+ ##### `peerDependencyOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.peerDependencyOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypeerdependencyoptions"></a>
734
888
 
735
889
  ```typescript
736
890
  public readonly peerDependencyOptions: PeerDependencyOptions;
737
891
  ```
738
892
 
739
- - *Type:* [`projen.PeerDependencyOptions`](#projen.PeerDependencyOptions)
893
+ - *Type:* [`projen.javascript.PeerDependencyOptions`](#projen.javascript.PeerDependencyOptions)
740
894
 
741
895
  Options for `peerDeps`.
742
896
 
743
897
  ---
744
898
 
745
- ##### `peerDeps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.peerDeps"></a>
899
+ ##### `peerDeps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.peerDeps" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypeerdeps"></a>
746
900
 
747
901
  ```typescript
748
902
  public readonly peerDeps: string[];
@@ -757,7 +911,7 @@ Dependencies listed here are required to be installed (and satisfied) by the _co
757
911
 
758
912
  ---
759
913
 
760
- ##### `repository`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.repository"></a>
914
+ ##### `repository`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.repository" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyrepository"></a>
761
915
 
762
916
  ```typescript
763
917
  public readonly repository: string;
@@ -771,7 +925,7 @@ See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
771
925
 
772
926
  ---
773
927
 
774
- ##### `repositoryDirectory`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.repositoryDirectory"></a>
928
+ ##### `repositoryDirectory`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.repositoryDirectory" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyrepositorydirectory"></a>
775
929
 
776
930
  ```typescript
777
931
  public readonly repositoryDirectory: string;
@@ -783,7 +937,7 @@ If the package.json for your package is not in the root directory (for example i
783
937
 
784
938
  ---
785
939
 
786
- ##### `scripts`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.scripts"></a>
940
+ ##### `scripts`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.scripts" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyscripts"></a>
787
941
 
788
942
  ```typescript
789
943
  public readonly scripts: {[ key: string ]: string};
@@ -798,7 +952,7 @@ If a script has the same name as a standard script, the standard script will be
798
952
 
799
953
  ---
800
954
 
801
- ##### `stability`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.stability"></a>
955
+ ##### `stability`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.stability" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertystability"></a>
802
956
 
803
957
  ```typescript
804
958
  public readonly stability: string;
@@ -810,7 +964,7 @@ Package's Stability.
810
964
 
811
965
  ---
812
966
 
813
- ##### `antitamper`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.antitamper"></a>
967
+ ##### `antitamper`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.antitamper" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyantitamper"></a>
814
968
 
815
969
  ```typescript
816
970
  public readonly antitamper: boolean;
@@ -823,7 +977,7 @@ Checks that after build there are no modified files on git.
823
977
 
824
978
  ---
825
979
 
826
- ##### `artifactsDirectory`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.artifactsDirectory"></a>
980
+ ##### `artifactsDirectory`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.artifactsDirectory" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyartifactsdirectory"></a>
827
981
 
828
982
  ```typescript
829
983
  public readonly artifactsDirectory: string;
@@ -836,7 +990,7 @@ A directory which will contain artifacts to be published to npm.
836
990
 
837
991
  ---
838
992
 
839
- ##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jsiiReleaseVersion"></a>
993
+ ##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jsiiReleaseVersion" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyjsiireleaseversion"></a>
840
994
 
841
995
  ```typescript
842
996
  public readonly jsiiReleaseVersion: string;
@@ -849,7 +1003,7 @@ Version requirement of `jsii-release` which is used to publish modules to npm.
849
1003
 
850
1004
  ---
851
1005
 
852
- ##### `majorVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.majorVersion"></a>
1006
+ ##### `majorVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.majorVersion" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertymajorversion"></a>
853
1007
 
854
1008
  ```typescript
855
1009
  public readonly majorVersion: number;
@@ -864,7 +1018,7 @@ If this is specified, we bump the latest version of this major version line. If
864
1018
 
865
1019
  ---
866
1020
 
867
- ##### `postBuildSteps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.postBuildSteps"></a>
1021
+ ##### `postBuildSteps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.postBuildSteps" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypostbuildsteps"></a>
868
1022
 
869
1023
  ```typescript
870
1024
  public readonly postBuildSteps: JobStep[];
@@ -877,7 +1031,7 @@ Steps to execute after build as part of the release workflow.
877
1031
 
878
1032
  ---
879
1033
 
880
- ##### `prerelease`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.prerelease"></a>
1034
+ ##### `prerelease`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.prerelease" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprerelease"></a>
881
1035
 
882
1036
  ```typescript
883
1037
  public readonly prerelease: string;
@@ -890,7 +1044,7 @@ Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pr
890
1044
 
891
1045
  ---
892
1046
 
893
- ##### `releaseBranches`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseBranches"></a>
1047
+ ##### `releaseBranches`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseBranches" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleasebranches"></a>
894
1048
 
895
1049
  ```typescript
896
1050
  public readonly releaseBranches: {[ key: string ]: BranchOptions};
@@ -905,7 +1059,7 @@ A workflow will be created for each release branch which will publish releases f
905
1059
 
906
1060
  ---
907
1061
 
908
- ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseEveryCommit"></a>
1062
+ ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseEveryCommit" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleaseeverycommit"></a>
909
1063
 
910
1064
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
911
1065
 
@@ -920,7 +1074,7 @@ Automatically release new versions every commit to one of branches in `releaseBr
920
1074
 
921
1075
  ---
922
1076
 
923
- ##### `releaseFailureIssue`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseFailureIssue"></a>
1077
+ ##### `releaseFailureIssue`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseFailureIssue" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleasefailureissue"></a>
924
1078
 
925
1079
  ```typescript
926
1080
  public readonly releaseFailureIssue: boolean;
@@ -933,7 +1087,7 @@ Create a github issue on every failed publishing task.
933
1087
 
934
1088
  ---
935
1089
 
936
- ##### `releaseFailureIssueLabel`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseFailureIssueLabel"></a>
1090
+ ##### `releaseFailureIssueLabel`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseFailureIssueLabel" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleasefailureissuelabel"></a>
937
1091
 
938
1092
  ```typescript
939
1093
  public readonly releaseFailureIssueLabel: string;
@@ -948,7 +1102,7 @@ Only applies if `releaseFailureIssue` is true.
948
1102
 
949
1103
  ---
950
1104
 
951
- ##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseSchedule"></a>
1105
+ ##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseSchedule" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleaseschedule"></a>
952
1106
 
953
1107
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
954
1108
 
@@ -963,7 +1117,7 @@ CRON schedule to trigger new releases.
963
1117
 
964
1118
  ---
965
1119
 
966
- ##### `releaseTagPrefix`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseTagPrefix"></a>
1120
+ ##### `releaseTagPrefix`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseTagPrefix" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleasetagprefix"></a>
967
1121
 
968
1122
  ```typescript
969
1123
  public readonly releaseTagPrefix: string;
@@ -978,7 +1132,7 @@ Note: this prefix is used to detect the latest tagged version when bumping, so i
978
1132
 
979
1133
  ---
980
1134
 
981
- ##### `releaseTrigger`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseTrigger"></a>
1135
+ ##### `releaseTrigger`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseTrigger" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleasetrigger"></a>
982
1136
 
983
1137
  ```typescript
984
1138
  public readonly releaseTrigger: ReleaseTrigger;
@@ -991,7 +1145,7 @@ The release trigger to use.
991
1145
 
992
1146
  ---
993
1147
 
994
- ##### `releaseWorkflowName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflowName"></a>
1148
+ ##### `releaseWorkflowName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflowName" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleaseworkflowname"></a>
995
1149
 
996
1150
  ```typescript
997
1151
  public readonly releaseWorkflowName: string;
@@ -1004,7 +1158,7 @@ The name of the default release workflow.
1004
1158
 
1005
1159
  ---
1006
1160
 
1007
- ##### `releaseWorkflowSetupSteps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflowSetupSteps"></a>
1161
+ ##### `releaseWorkflowSetupSteps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflowSetupSteps" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleaseworkflowsetupsteps"></a>
1008
1162
 
1009
1163
  ```typescript
1010
1164
  public readonly releaseWorkflowSetupSteps: JobStep[];
@@ -1016,7 +1170,7 @@ A set of workflow steps to execute in order to setup the workflow container.
1016
1170
 
1017
1171
  ---
1018
1172
 
1019
- ##### `versionrcOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.versionrcOptions"></a>
1173
+ ##### `versionrcOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.versionrcOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyversionrcoptions"></a>
1020
1174
 
1021
1175
  ```typescript
1022
1176
  public readonly versionrcOptions: {[ key: string ]: any};
@@ -1031,7 +1185,7 @@ Given values either append to default configuration or overwrite values in it.
1031
1185
 
1032
1186
  ---
1033
1187
 
1034
- ##### `workflowContainerImage`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowContainerImage"></a>
1188
+ ##### `workflowContainerImage`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowContainerImage" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyworkflowcontainerimage"></a>
1035
1189
 
1036
1190
  ```typescript
1037
1191
  public readonly workflowContainerImage: string;
@@ -1044,7 +1198,7 @@ Container image to use for GitHub workflows.
1044
1198
 
1045
1199
  ---
1046
1200
 
1047
- ##### `defaultReleaseBranch`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.defaultReleaseBranch"></a>
1201
+ ##### `defaultReleaseBranch`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.defaultReleaseBranch" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydefaultreleasebranch"></a>
1048
1202
 
1049
1203
  ```typescript
1050
1204
  public readonly defaultReleaseBranch: string;
@@ -1057,7 +1211,7 @@ The name of the main release branch.
1057
1211
 
1058
1212
  ---
1059
1213
 
1060
- ##### `autoApproveProjenUpgrades`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoApproveProjenUpgrades"></a>
1214
+ ##### `autoApproveProjenUpgrades`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoApproveProjenUpgrades" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyautoapproveprojenupgrades"></a>
1061
1215
 
1062
1216
  ```typescript
1063
1217
  public readonly autoApproveProjenUpgrades: boolean;
@@ -1072,7 +1226,7 @@ Throw if set to true but `autoApproveOptions` are not defined.
1072
1226
 
1073
1227
  ---
1074
1228
 
1075
- ##### `autoApproveUpgrades`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoApproveUpgrades"></a>
1229
+ ##### `autoApproveUpgrades`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoApproveUpgrades" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyautoapproveupgrades"></a>
1076
1230
 
1077
1231
  ```typescript
1078
1232
  public readonly autoApproveUpgrades: boolean;
@@ -1087,7 +1241,7 @@ Throw if set to true but `autoApproveOptions` are not defined.
1087
1241
 
1088
1242
  ---
1089
1243
 
1090
- ##### `buildWorkflow`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.buildWorkflow"></a>
1244
+ ##### `buildWorkflow`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.buildWorkflow" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertybuildworkflow"></a>
1091
1245
 
1092
1246
  ```typescript
1093
1247
  public readonly buildWorkflow: boolean;
@@ -1100,7 +1254,7 @@ Define a GitHub workflow for building PRs.
1100
1254
 
1101
1255
  ---
1102
1256
 
1103
- ##### `bundlerOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bundlerOptions"></a>
1257
+ ##### `bundlerOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bundlerOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertybundleroptions"></a>
1104
1258
 
1105
1259
  ```typescript
1106
1260
  public readonly bundlerOptions: BundlerOptions;
@@ -1112,7 +1266,7 @@ Options for `Bundler`.
1112
1266
 
1113
1267
  ---
1114
1268
 
1115
- ##### `codeCov`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeCov"></a>
1269
+ ##### `codeCov`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeCov" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycodecov"></a>
1116
1270
 
1117
1271
  ```typescript
1118
1272
  public readonly codeCov: boolean;
@@ -1125,7 +1279,7 @@ Define a GitHub workflow step for sending code coverage metrics to https://codec
1125
1279
 
1126
1280
  ---
1127
1281
 
1128
- ##### `codeCovTokenSecret`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeCovTokenSecret"></a>
1282
+ ##### `codeCovTokenSecret`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeCovTokenSecret" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycodecovtokensecret"></a>
1129
1283
 
1130
1284
  ```typescript
1131
1285
  public readonly codeCovTokenSecret: string;
@@ -1138,7 +1292,7 @@ Define the secret name for a specified https://codecov.io/ token A secret is req
1138
1292
 
1139
1293
  ---
1140
1294
 
1141
- ##### `copyrightOwner`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.copyrightOwner"></a>
1295
+ ##### `copyrightOwner`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.copyrightOwner" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycopyrightowner"></a>
1142
1296
 
1143
1297
  ```typescript
1144
1298
  public readonly copyrightOwner: string;
@@ -1151,7 +1305,7 @@ License copyright owner.
1151
1305
 
1152
1306
  ---
1153
1307
 
1154
- ##### `copyrightPeriod`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.copyrightPeriod"></a>
1308
+ ##### `copyrightPeriod`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.copyrightPeriod" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycopyrightperiod"></a>
1155
1309
 
1156
1310
  ```typescript
1157
1311
  public readonly copyrightPeriod: string;
@@ -1164,7 +1318,7 @@ The copyright years to put in the LICENSE file.
1164
1318
 
1165
1319
  ---
1166
1320
 
1167
- ##### `dependabot`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.dependabot"></a>
1321
+ ##### `dependabot`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.dependabot" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydependabot"></a>
1168
1322
 
1169
1323
  ```typescript
1170
1324
  public readonly dependabot: boolean;
@@ -1179,7 +1333,7 @@ Cannot be used in conjunction with `depsUpgrade`.
1179
1333
 
1180
1334
  ---
1181
1335
 
1182
- ##### `dependabotOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.dependabotOptions"></a>
1336
+ ##### `dependabotOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.dependabotOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydependabotoptions"></a>
1183
1337
 
1184
1338
  ```typescript
1185
1339
  public readonly dependabotOptions: DependabotOptions;
@@ -1192,7 +1346,7 @@ Options for dependabot.
1192
1346
 
1193
1347
  ---
1194
1348
 
1195
- ##### `depsUpgrade`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.depsUpgrade"></a>
1349
+ ##### `depsUpgrade`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.depsUpgrade" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydepsupgrade"></a>
1196
1350
 
1197
1351
  ```typescript
1198
1352
  public readonly depsUpgrade: boolean;
@@ -1207,20 +1361,20 @@ Cannot be used in conjunction with `dependabot`.
1207
1361
 
1208
1362
  ---
1209
1363
 
1210
- ##### `depsUpgradeOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.depsUpgradeOptions"></a>
1364
+ ##### `depsUpgradeOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.depsUpgradeOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydepsupgradeoptions"></a>
1211
1365
 
1212
1366
  ```typescript
1213
1367
  public readonly depsUpgradeOptions: UpgradeDependenciesOptions;
1214
1368
  ```
1215
1369
 
1216
- - *Type:* [`projen.UpgradeDependenciesOptions`](#projen.UpgradeDependenciesOptions)
1370
+ - *Type:* [`projen.javascript.UpgradeDependenciesOptions`](#projen.javascript.UpgradeDependenciesOptions)
1217
1371
  - *Default:* default options
1218
1372
 
1219
1373
  Options for depsUpgrade.
1220
1374
 
1221
1375
  ---
1222
1376
 
1223
- ##### `gitignore`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.gitignore"></a>
1377
+ ##### `gitignore`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.gitignore" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertygitignore"></a>
1224
1378
 
1225
1379
  ```typescript
1226
1380
  public readonly gitignore: string[];
@@ -1232,7 +1386,7 @@ Additional entries to .gitignore.
1232
1386
 
1233
1387
  ---
1234
1388
 
1235
- ##### `jest`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jest"></a>
1389
+ ##### `jest`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jest" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyjest"></a>
1236
1390
 
1237
1391
  ```typescript
1238
1392
  public readonly jest: boolean;
@@ -1245,20 +1399,20 @@ Setup jest unit tests.
1245
1399
 
1246
1400
  ---
1247
1401
 
1248
- ##### `jestOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jestOptions"></a>
1402
+ ##### `jestOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jestOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyjestoptions"></a>
1249
1403
 
1250
1404
  ```typescript
1251
1405
  public readonly jestOptions: JestOptions;
1252
1406
  ```
1253
1407
 
1254
- - *Type:* [`projen.JestOptions`](#projen.JestOptions)
1408
+ - *Type:* [`projen.javascript.JestOptions`](#projen.javascript.JestOptions)
1255
1409
  - *Default:* default options
1256
1410
 
1257
1411
  Jest options.
1258
1412
 
1259
1413
  ---
1260
1414
 
1261
- ##### `mutableBuild`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mutableBuild"></a>
1415
+ ##### `mutableBuild`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mutableBuild" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertymutablebuild"></a>
1262
1416
 
1263
1417
  ```typescript
1264
1418
  public readonly mutableBuild: boolean;
@@ -1273,7 +1427,7 @@ This means that any files synthesized by projen or e.g. test snapshots will alwa
1273
1427
 
1274
1428
  ---
1275
1429
 
1276
- ##### ~~`npmignore`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmignore"></a>
1430
+ ##### ~~`npmignore`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmignore" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmignore"></a>
1277
1431
 
1278
1432
  - *Deprecated:* - use `project.addPackageIgnore`
1279
1433
 
@@ -1287,7 +1441,7 @@ Additional entries to .npmignore.
1287
1441
 
1288
1442
  ---
1289
1443
 
1290
- ##### `npmignoreEnabled`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmignoreEnabled"></a>
1444
+ ##### `npmignoreEnabled`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmignoreEnabled" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertynpmignoreenabled"></a>
1291
1445
 
1292
1446
  ```typescript
1293
1447
  public readonly npmignoreEnabled: boolean;
@@ -1300,7 +1454,7 @@ Defines an .npmignore file. Normally this is only needed for libraries that are
1300
1454
 
1301
1455
  ---
1302
1456
 
1303
- ##### `projenDevDependency`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenDevDependency"></a>
1457
+ ##### `projenDevDependency`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenDevDependency" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojendevdependency"></a>
1304
1458
 
1305
1459
  ```typescript
1306
1460
  public readonly projenDevDependency: boolean;
@@ -1313,7 +1467,7 @@ Indicates of "projen" should be installed as a devDependency.
1313
1467
 
1314
1468
  ---
1315
1469
 
1316
- ##### `projenrcJs`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJs"></a>
1470
+ ##### `projenrcJs`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJs" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenrcjs"></a>
1317
1471
 
1318
1472
  ```typescript
1319
1473
  public readonly projenrcJs: boolean;
@@ -1326,7 +1480,7 @@ Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable
1326
1480
 
1327
1481
  ---
1328
1482
 
1329
- ##### `projenrcJsOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJsOptions"></a>
1483
+ ##### `projenrcJsOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJsOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenrcjsoptions"></a>
1330
1484
 
1331
1485
  ```typescript
1332
1486
  public readonly projenrcJsOptions: ProjenrcOptions;
@@ -1339,7 +1493,7 @@ Options for .projenrc.js.
1339
1493
 
1340
1494
  ---
1341
1495
 
1342
- ##### ~~`projenUpgradeAutoMerge`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenUpgradeAutoMerge"></a>
1496
+ ##### ~~`projenUpgradeAutoMerge`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenUpgradeAutoMerge" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenupgradeautomerge"></a>
1343
1497
 
1344
1498
  - *Deprecated:* use `autoApproveProjenUpgrades`.
1345
1499
 
@@ -1356,7 +1510,7 @@ Throw if set to true but `autoApproveOptions` are not defined.
1356
1510
 
1357
1511
  ---
1358
1512
 
1359
- ##### `projenUpgradeSchedule`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenUpgradeSchedule"></a>
1513
+ ##### `projenUpgradeSchedule`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenUpgradeSchedule" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenupgradeschedule"></a>
1360
1514
 
1361
1515
  ```typescript
1362
1516
  public readonly projenUpgradeSchedule: string[];
@@ -1369,7 +1523,7 @@ Customize the projenUpgrade schedule in cron expression.
1369
1523
 
1370
1524
  ---
1371
1525
 
1372
- ##### `projenUpgradeSecret`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenUpgradeSecret"></a>
1526
+ ##### `projenUpgradeSecret`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenUpgradeSecret" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenupgradesecret"></a>
1373
1527
 
1374
1528
  ```typescript
1375
1529
  public readonly projenUpgradeSecret: string;
@@ -1384,7 +1538,7 @@ This setting is a GitHub secret name which contains a GitHub Access Token with `
1384
1538
 
1385
1539
  ---
1386
1540
 
1387
- ##### `projenVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenVersion"></a>
1541
+ ##### `projenVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenVersion" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenversion"></a>
1388
1542
 
1389
1543
  ```typescript
1390
1544
  public readonly projenVersion: string;
@@ -1397,7 +1551,7 @@ Version of projen to install.
1397
1551
 
1398
1552
  ---
1399
1553
 
1400
- ##### `pullRequestTemplate`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.pullRequestTemplate"></a>
1554
+ ##### `pullRequestTemplate`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.pullRequestTemplate" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypullrequesttemplate"></a>
1401
1555
 
1402
1556
  ```typescript
1403
1557
  public readonly pullRequestTemplate: boolean;
@@ -1410,7 +1564,7 @@ Include a GitHub pull request template.
1410
1564
 
1411
1565
  ---
1412
1566
 
1413
- ##### `pullRequestTemplateContents`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.pullRequestTemplateContents"></a>
1567
+ ##### `pullRequestTemplateContents`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.pullRequestTemplateContents" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypullrequesttemplatecontents"></a>
1414
1568
 
1415
1569
  ```typescript
1416
1570
  public readonly pullRequestTemplateContents: string[];
@@ -1423,7 +1577,7 @@ The contents of the pull request template.
1423
1577
 
1424
1578
  ---
1425
1579
 
1426
- ##### `release`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.release"></a>
1580
+ ##### `release`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.release" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyrelease"></a>
1427
1581
 
1428
1582
  ```typescript
1429
1583
  public readonly release: boolean;
@@ -1436,7 +1590,7 @@ Add release management to this project.
1436
1590
 
1437
1591
  ---
1438
1592
 
1439
- ##### `releaseToNpm`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseToNpm"></a>
1593
+ ##### `releaseToNpm`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseToNpm" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleasetonpm"></a>
1440
1594
 
1441
1595
  ```typescript
1442
1596
  public readonly releaseToNpm: boolean;
@@ -1449,7 +1603,7 @@ Automatically release to npm when new versions are introduced.
1449
1603
 
1450
1604
  ---
1451
1605
 
1452
- ##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflow"></a>
1606
+ ##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflow" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyreleaseworkflow"></a>
1453
1607
 
1454
1608
  - *Deprecated:* see `release`.
1455
1609
 
@@ -1464,7 +1618,7 @@ DEPRECATED: renamed to `release`.
1464
1618
 
1465
1619
  ---
1466
1620
 
1467
- ##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowBootstrapSteps"></a>
1621
+ ##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowBootstrapSteps" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyworkflowbootstrapsteps"></a>
1468
1622
 
1469
1623
  ```typescript
1470
1624
  public readonly workflowBootstrapSteps: any[];
@@ -1477,7 +1631,7 @@ Workflow steps to use in order to bootstrap this repo.
1477
1631
 
1478
1632
  ---
1479
1633
 
1480
- ##### `workflowGitIdentity`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowGitIdentity"></a>
1634
+ ##### `workflowGitIdentity`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowGitIdentity" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyworkflowgitidentity"></a>
1481
1635
 
1482
1636
  ```typescript
1483
1637
  public readonly workflowGitIdentity: GitIdentity;
@@ -1490,7 +1644,7 @@ The git identity to use in workflows.
1490
1644
 
1491
1645
  ---
1492
1646
 
1493
- ##### `workflowNodeVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowNodeVersion"></a>
1647
+ ##### `workflowNodeVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowNodeVersion" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyworkflownodeversion"></a>
1494
1648
 
1495
1649
  ```typescript
1496
1650
  public readonly workflowNodeVersion: string;
@@ -1503,7 +1657,7 @@ The node version to use in GitHub workflows.
1503
1657
 
1504
1658
  ---
1505
1659
 
1506
- ##### `disableTsconfig`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.disableTsconfig"></a>
1660
+ ##### `disableTsconfig`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.disableTsconfig" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydisabletsconfig"></a>
1507
1661
 
1508
1662
  ```typescript
1509
1663
  public readonly disableTsconfig: boolean;
@@ -1516,7 +1670,7 @@ Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.jso
1516
1670
 
1517
1671
  ---
1518
1672
 
1519
- ##### `docgen`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.docgen"></a>
1673
+ ##### `docgen`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.docgen" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydocgen"></a>
1520
1674
 
1521
1675
  ```typescript
1522
1676
  public readonly docgen: boolean;
@@ -1529,7 +1683,7 @@ Docgen by Typedoc.
1529
1683
 
1530
1684
  ---
1531
1685
 
1532
- ##### `docsDirectory`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.docsDirectory"></a>
1686
+ ##### `docsDirectory`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.docsDirectory" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydocsdirectory"></a>
1533
1687
 
1534
1688
  ```typescript
1535
1689
  public readonly docsDirectory: string;
@@ -1542,7 +1696,7 @@ Docs directory.
1542
1696
 
1543
1697
  ---
1544
1698
 
1545
- ##### `entrypointTypes`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.entrypointTypes"></a>
1699
+ ##### `entrypointTypes`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.entrypointTypes" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyentrypointtypes"></a>
1546
1700
 
1547
1701
  ```typescript
1548
1702
  public readonly entrypointTypes: string;
@@ -1555,7 +1709,7 @@ The .d.ts file that includes the type declarations for this module.
1555
1709
 
1556
1710
  ---
1557
1711
 
1558
- ##### `eslint`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.eslint"></a>
1712
+ ##### `eslint`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.eslint" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyeslint"></a>
1559
1713
 
1560
1714
  ```typescript
1561
1715
  public readonly eslint: boolean;
@@ -1568,20 +1722,20 @@ Setup eslint.
1568
1722
 
1569
1723
  ---
1570
1724
 
1571
- ##### `eslintOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.eslintOptions"></a>
1725
+ ##### `eslintOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.eslintOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyeslintoptions"></a>
1572
1726
 
1573
1727
  ```typescript
1574
1728
  public readonly eslintOptions: EslintOptions;
1575
1729
  ```
1576
1730
 
1577
- - *Type:* [`projen.EslintOptions`](#projen.EslintOptions)
1731
+ - *Type:* [`projen.javascript.EslintOptions`](#projen.javascript.EslintOptions)
1578
1732
  - *Default:* opinionated default options
1579
1733
 
1580
1734
  Eslint options.
1581
1735
 
1582
1736
  ---
1583
1737
 
1584
- ##### `libdir`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.libdir"></a>
1738
+ ##### `libdir`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.libdir" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertylibdir"></a>
1585
1739
 
1586
1740
  ```typescript
1587
1741
  public readonly libdir: string;
@@ -1594,7 +1748,7 @@ Typescript artifacts output directory.
1594
1748
 
1595
1749
  ---
1596
1750
 
1597
- ##### `package`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.package"></a>
1751
+ ##### `package`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.package" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertypackage"></a>
1598
1752
 
1599
1753
  ```typescript
1600
1754
  public readonly package: boolean;
@@ -1607,7 +1761,7 @@ Defines a `yarn package` command that will produce a tarball and place it under
1607
1761
 
1608
1762
  ---
1609
1763
 
1610
- ##### `projenrcTs`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcTs"></a>
1764
+ ##### `projenrcTs`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcTs" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenrcts"></a>
1611
1765
 
1612
1766
  ```typescript
1613
1767
  public readonly projenrcTs: boolean;
@@ -1620,7 +1774,7 @@ Use TypeScript for your projenrc file (`.projenrc.ts`).
1620
1774
 
1621
1775
  ---
1622
1776
 
1623
- ##### `projenrcTsOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcTsOptions"></a>
1777
+ ##### `projenrcTsOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcTsOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyprojenrctsoptions"></a>
1624
1778
 
1625
1779
  ```typescript
1626
1780
  public readonly projenrcTsOptions: ProjenrcOptions;
@@ -1632,7 +1786,7 @@ Options for .projenrc.ts.
1632
1786
 
1633
1787
  ---
1634
1788
 
1635
- ##### `sampleCode`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.sampleCode"></a>
1789
+ ##### `sampleCode`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.sampleCode" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertysamplecode"></a>
1636
1790
 
1637
1791
  ```typescript
1638
1792
  public readonly sampleCode: boolean;
@@ -1645,7 +1799,7 @@ Generate one-time sample in `src/` and `test/` if there are no files there.
1645
1799
 
1646
1800
  ---
1647
1801
 
1648
- ##### `srcdir`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.srcdir"></a>
1802
+ ##### `srcdir`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.srcdir" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertysrcdir"></a>
1649
1803
 
1650
1804
  ```typescript
1651
1805
  public readonly srcdir: string;
@@ -1658,7 +1812,7 @@ Typescript sources directory.
1658
1812
 
1659
1813
  ---
1660
1814
 
1661
- ##### `testdir`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.testdir"></a>
1815
+ ##### `testdir`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.testdir" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertytestdir"></a>
1662
1816
 
1663
1817
  ```typescript
1664
1818
  public readonly testdir: string;
@@ -1673,33 +1827,33 @@ If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tes
1673
1827
 
1674
1828
  ---
1675
1829
 
1676
- ##### `tsconfig`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfig"></a>
1830
+ ##### `tsconfig`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfig" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertytsconfig"></a>
1677
1831
 
1678
1832
  ```typescript
1679
1833
  public readonly tsconfig: TypescriptConfigOptions;
1680
1834
  ```
1681
1835
 
1682
- - *Type:* [`projen.TypescriptConfigOptions`](#projen.TypescriptConfigOptions)
1836
+ - *Type:* [`projen.javascript.TypescriptConfigOptions`](#projen.javascript.TypescriptConfigOptions)
1683
1837
  - *Default:* default options
1684
1838
 
1685
1839
  Custom TSConfig.
1686
1840
 
1687
1841
  ---
1688
1842
 
1689
- ##### `tsconfigDev`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfigDev"></a>
1843
+ ##### `tsconfigDev`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfigDev" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertytsconfigdev"></a>
1690
1844
 
1691
1845
  ```typescript
1692
1846
  public readonly tsconfigDev: TypescriptConfigOptions;
1693
1847
  ```
1694
1848
 
1695
- - *Type:* [`projen.TypescriptConfigOptions`](#projen.TypescriptConfigOptions)
1849
+ - *Type:* [`projen.javascript.TypescriptConfigOptions`](#projen.javascript.TypescriptConfigOptions)
1696
1850
  - *Default:* use the production tsconfig options
1697
1851
 
1698
1852
  Custom tsconfig options for the development tsconfig.json file (used for testing).
1699
1853
 
1700
1854
  ---
1701
1855
 
1702
- ##### `tsconfigDevFile`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfigDevFile"></a>
1856
+ ##### `tsconfigDevFile`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfigDevFile" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertytsconfigdevfile"></a>
1703
1857
 
1704
1858
  ```typescript
1705
1859
  public readonly tsconfigDevFile: string;
@@ -1712,7 +1866,7 @@ The name of the development tsconfig.json file.
1712
1866
 
1713
1867
  ---
1714
1868
 
1715
- ##### `typescriptVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.typescriptVersion"></a>
1869
+ ##### `typescriptVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.typescriptVersion" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertytypescriptversion"></a>
1716
1870
 
1717
1871
  ```typescript
1718
1872
  public readonly typescriptVersion: string;
@@ -1727,7 +1881,7 @@ NOTE: Typescript is not semantically versioned and should remain on the same min
1727
1881
 
1728
1882
  ---
1729
1883
 
1730
- ##### `cdkout`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkout"></a>
1884
+ ##### `cdkout`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkout" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycdkout"></a>
1731
1885
 
1732
1886
  ```typescript
1733
1887
  public readonly cdkout: string;
@@ -1740,7 +1894,7 @@ cdk.out directory.
1740
1894
 
1741
1895
  ---
1742
1896
 
1743
- ##### `context`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.context"></a>
1897
+ ##### `context`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.context" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycontext"></a>
1744
1898
 
1745
1899
  ```typescript
1746
1900
  public readonly context: {[ key: string ]: string};
@@ -1753,7 +1907,7 @@ Additional context to include in `cdk.json`.
1753
1907
 
1754
1908
  ---
1755
1909
 
1756
- ##### `featureFlags`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.featureFlags"></a>
1910
+ ##### `featureFlags`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.featureFlags" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyfeatureflags"></a>
1757
1911
 
1758
1912
  ```typescript
1759
1913
  public readonly featureFlags: boolean;
@@ -1766,7 +1920,7 @@ Include all feature flags in cdk.json.
1766
1920
 
1767
1921
  ---
1768
1922
 
1769
- ##### `requireApproval`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.requireApproval"></a>
1923
+ ##### `requireApproval`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.requireApproval" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyrequireapproval"></a>
1770
1924
 
1771
1925
  ```typescript
1772
1926
  public readonly requireApproval: ApprovalLevel;
@@ -1779,7 +1933,33 @@ To protect you against unintended changes that affect your security posture, the
1779
1933
 
1780
1934
  ---
1781
1935
 
1782
- ##### `cdkVersion`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkVersion"></a>
1936
+ ##### `watchExcludes`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.watchExcludes" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertywatchexcludes"></a>
1937
+
1938
+ ```typescript
1939
+ public readonly watchExcludes: string[];
1940
+ ```
1941
+
1942
+ - *Type:* `string`[]
1943
+ - *Default:* []
1944
+
1945
+ Glob patterns to exclude from `cdk watch`.
1946
+
1947
+ ---
1948
+
1949
+ ##### `watchIncludes`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.watchIncludes" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertywatchincludes"></a>
1950
+
1951
+ ```typescript
1952
+ public readonly watchIncludes: string[];
1953
+ ```
1954
+
1955
+ - *Type:* `string`[]
1956
+ - *Default:* []
1957
+
1958
+ Glob patterns to include in `cdk watch`.
1959
+
1960
+ ---
1961
+
1962
+ ##### `cdkVersion`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkVersion" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycdkversion"></a>
1783
1963
 
1784
1964
  ```typescript
1785
1965
  public readonly cdkVersion: string;
@@ -1792,7 +1972,7 @@ AWS CDK version to use.
1792
1972
 
1793
1973
  ---
1794
1974
 
1795
- ##### `appEntrypoint`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.appEntrypoint"></a>
1975
+ ##### `appEntrypoint`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.appEntrypoint" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertyappentrypoint"></a>
1796
1976
 
1797
1977
  ```typescript
1798
1978
  public readonly appEntrypoint: string;
@@ -1805,7 +1985,7 @@ The CDK app's entrypoint (relative to the source directory, which is "src" by de
1805
1985
 
1806
1986
  ---
1807
1987
 
1808
- ##### `cdkDependencies`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkDependencies"></a>
1988
+ ##### `cdkDependencies`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkDependencies" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycdkdependencies"></a>
1809
1989
 
1810
1990
  ```typescript
1811
1991
  public readonly cdkDependencies: string[];
@@ -1817,7 +1997,7 @@ Which AWS CDK modules (those that start with "@aws-cdk/") this app uses.
1817
1997
 
1818
1998
  ---
1819
1999
 
1820
- ##### `cdkVersionPinning`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkVersionPinning"></a>
2000
+ ##### `cdkVersionPinning`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkVersionPinning" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertycdkversionpinning"></a>
1821
2001
 
1822
2002
  ```typescript
1823
2003
  public readonly cdkVersionPinning: boolean;
@@ -1832,7 +2012,7 @@ You can use this to prevent yarn to mix versions for your CDK dependencies and t
1832
2012
 
1833
2013
  ---
1834
2014
 
1835
- ##### `lambdaAutoDiscover`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.lambdaAutoDiscover"></a>
2015
+ ##### `lambdaAutoDiscover`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.lambdaAutoDiscover" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertylambdaautodiscover"></a>
1836
2016
 
1837
2017
  ```typescript
1838
2018
  public readonly lambdaAutoDiscover: boolean;
@@ -1845,7 +2025,7 @@ Automatically adds an `awscdk.LambdaFunction` for each `.lambda.ts` handler in y
1845
2025
 
1846
2026
  ---
1847
2027
 
1848
- ##### `lambdaOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.lambdaOptions"></a>
2028
+ ##### `lambdaOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.lambdaOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertylambdaoptions"></a>
1849
2029
 
1850
2030
  ```typescript
1851
2031
  public readonly lambdaOptions: LambdaFunctionCommonOptions;
@@ -1858,7 +2038,7 @@ Common options for all AWS Lambda functions.
1858
2038
 
1859
2039
  ---
1860
2040
 
1861
- ##### `deployOptions`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.deployOptions"></a>
2041
+ ##### `deployOptions`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.deployOptions" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertydeployoptions"></a>
1862
2042
 
1863
2043
  ```typescript
1864
2044
  public readonly deployOptions: DeployOptions;
@@ -1870,9 +2050,22 @@ Deployment options.
1870
2050
 
1871
2051
  ---
1872
2052
 
1873
- ### DeployOptions <a name="deployable-awscdk-app-ts.DeployOptions"></a>
2053
+ ##### `generateNvmrc`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.generateNvmrc" id="deployableawscdkapptsdeployableawscdktypescriptappoptionspropertygeneratenvmrc"></a>
1874
2054
 
1875
- #### Initializer <a name="[object Object].Initializer"></a>
2055
+ ```typescript
2056
+ public readonly generateNvmrc: boolean;
2057
+ ```
2058
+
2059
+ - *Type:* `boolean`
2060
+ - *Default:* true
2061
+
2062
+ Whether to generate nvmrc file for the node version of the project.
2063
+
2064
+ ---
2065
+
2066
+ ### DeployOptions <a name="deployable-awscdk-app-ts.DeployOptions" id="deployableawscdkapptsdeployoptions"></a>
2067
+
2068
+ #### Initializer <a name="[object Object].Initializer" id="object-objectinitializer"></a>
1876
2069
 
1877
2070
  ```typescript
1878
2071
  import { DeployOptions } from 'deployable-awscdk-app-ts'
@@ -1880,7 +2073,16 @@ import { DeployOptions } from 'deployable-awscdk-app-ts'
1880
2073
  const deployOptions: DeployOptions = { ... }
1881
2074
  ```
1882
2075
 
1883
- ##### `environments`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployOptions.property.environments"></a>
2076
+ #### Properties <a name="Properties" id="properties"></a>
2077
+
2078
+ | **Name** | **Type** | **Description** |
2079
+ | --- | --- | --- |
2080
+ | [`environments`](#deployableawscdkapptsdeployoptionspropertyenvironments)<span title="Required">*</span> | [`deployable-awscdk-app-ts.EnvironmentOptions`](#deployable-awscdk-app-ts.EnvironmentOptions)[] | Environment settings to deploy to. |
2081
+ | [`stackPattern`](#deployableawscdkapptsdeployoptionspropertystackpattern) | `string` | Regex for stacks to be deployed. |
2082
+
2083
+ ---
2084
+
2085
+ ##### `environments`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployOptions.property.environments" id="deployableawscdkapptsdeployoptionspropertyenvironments"></a>
1884
2086
 
1885
2087
  ```typescript
1886
2088
  public readonly environments: EnvironmentOptions[];
@@ -1892,7 +2094,7 @@ Environment settings to deploy to.
1892
2094
 
1893
2095
  ---
1894
2096
 
1895
- ##### `stackPattern`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployOptions.property.stackPattern"></a>
2097
+ ##### `stackPattern`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployOptions.property.stackPattern" id="deployableawscdkapptsdeployoptionspropertystackpattern"></a>
1896
2098
 
1897
2099
  ```typescript
1898
2100
  public readonly stackPattern: string;
@@ -1906,9 +2108,9 @@ if not provided matches all of the stacks in the CDK App.
1906
2108
 
1907
2109
  ---
1908
2110
 
1909
- ### EnvironmentOptions <a name="deployable-awscdk-app-ts.EnvironmentOptions"></a>
2111
+ ### EnvironmentOptions <a name="deployable-awscdk-app-ts.EnvironmentOptions" id="deployableawscdkapptsenvironmentoptions"></a>
1910
2112
 
1911
- #### Initializer <a name="[object Object].Initializer"></a>
2113
+ #### Initializer <a name="[object Object].Initializer" id="object-objectinitializer"></a>
1912
2114
 
1913
2115
  ```typescript
1914
2116
  import { EnvironmentOptions } from 'deployable-awscdk-app-ts'
@@ -1916,7 +2118,16 @@ import { EnvironmentOptions } from 'deployable-awscdk-app-ts'
1916
2118
  const environmentOptions: EnvironmentOptions = { ... }
1917
2119
  ```
1918
2120
 
1919
- ##### `awsCredentials`<sup>Required</sup> <a name="deployable-awscdk-app-ts.EnvironmentOptions.property.awsCredentials"></a>
2121
+ #### Properties <a name="Properties" id="properties"></a>
2122
+
2123
+ | **Name** | **Type** | **Description** |
2124
+ | --- | --- | --- |
2125
+ | [`awsCredentials`](#deployableawscdkapptsenvironmentoptionspropertyawscredentials)<span title="Required">*</span> | [`deployable-awscdk-app-ts.AWSCredentials`](#deployable-awscdk-app-ts.AWSCredentials) | AWS credential details for deployment. |
2126
+ | [`name`](#deployableawscdkapptsenvironmentoptionspropertyname)<span title="Required">*</span> | `string` | Environment name to deploy to. |
2127
+
2128
+ ---
2129
+
2130
+ ##### `awsCredentials`<sup>Required</sup> <a name="deployable-awscdk-app-ts.EnvironmentOptions.property.awsCredentials" id="deployableawscdkapptsenvironmentoptionspropertyawscredentials"></a>
1920
2131
 
1921
2132
  ```typescript
1922
2133
  public readonly awsCredentials: AWSCredentials;
@@ -1928,7 +2139,7 @@ AWS credential details for deployment.
1928
2139
 
1929
2140
  ---
1930
2141
 
1931
- ##### `name`<sup>Required</sup> <a name="deployable-awscdk-app-ts.EnvironmentOptions.property.name"></a>
2142
+ ##### `name`<sup>Required</sup> <a name="deployable-awscdk-app-ts.EnvironmentOptions.property.name" id="deployableawscdkapptsenvironmentoptionspropertyname"></a>
1932
2143
 
1933
2144
  ```typescript
1934
2145
  public readonly name: string;
@@ -1940,11 +2151,11 @@ Environment name to deploy to.
1940
2151
 
1941
2152
  ---
1942
2153
 
1943
- ## Classes <a name="Classes"></a>
2154
+ ## Classes <a name="Classes" id="classes"></a>
1944
2155
 
1945
- ### DeployableAwsCdkTypeScriptApp <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp"></a>
2156
+ ### DeployableAwsCdkTypeScriptApp <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp" id="deployableawscdkapptsdeployableawscdktypescriptapp"></a>
1946
2157
 
1947
- #### Initializers <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.Initializer"></a>
2158
+ #### Initializers <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.Initializer" id="deployableawscdkapptsdeployableawscdktypescriptappinitializer"></a>
1948
2159
 
1949
2160
  ```typescript
1950
2161
  import { DeployableAwsCdkTypeScriptApp } from 'deployable-awscdk-app-ts'
@@ -1952,15 +2163,27 @@ import { DeployableAwsCdkTypeScriptApp } from 'deployable-awscdk-app-ts'
1952
2163
  new DeployableAwsCdkTypeScriptApp(options: DeployableAwsCdkTypeScriptAppOptions)
1953
2164
  ```
1954
2165
 
1955
- ##### `options`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.parameter.options"></a>
2166
+ | **Name** | **Type** | **Description** |
2167
+ | --- | --- | --- |
2168
+ | [`options`](#deployableawscdkapptsdeployableawscdktypescriptappparameteroptions)<span title="Required">*</span> | [`deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions`](#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions) | *No description.* |
2169
+
2170
+ ---
2171
+
2172
+ ##### `options`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.parameter.options" id="deployableawscdkapptsdeployableawscdktypescriptappparameteroptions"></a>
1956
2173
 
1957
2174
  - *Type:* [`deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions`](#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions)
1958
2175
 
1959
2176
  ---
1960
2177
 
1961
- #### Methods <a name="Methods"></a>
2178
+ #### Methods <a name="Methods" id="methods"></a>
2179
+
2180
+ | **Name** | **Description** |
2181
+ | --- | --- |
2182
+ | [`synth`](#deployableawscdkapptsdeployableawscdktypescriptappsynth) | (experimental) Synthesize all project files into `outdir`. |
2183
+
2184
+ ---
1962
2185
 
1963
- ##### `synth` <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.synth"></a>
2186
+ ##### `synth` <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.synth" id="deployableawscdkapptsdeployableawscdktypescriptappsynth"></a>
1964
2187
 
1965
2188
  ```typescript
1966
2189
  public synth()