projen-cdktf-hybrid-construct 0.3.1 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.copywrite.hcl +22 -0
- package/.gitattributes +3 -2
- package/.jsii +40 -39
- package/.prettierignore +1 -1
- package/.projenrc.ts +74 -15
- package/API.md +594 -20
- package/LICENSE +355 -19
- package/lib/defaults.d.ts +6 -0
- package/lib/defaults.js +7 -1
- package/lib/hybrid-module.d.ts +4 -0
- package/lib/hybrid-module.js +8 -4
- package/lib/index.d.ts +4 -0
- package/lib/index.js +11 -3
- package/lib/publishing.d.ts +13 -9
- package/lib/publishing.js +6 -2
- package/lib/terraform-module.d.ts +4 -0
- package/lib/terraform-module.js +7 -3
- package/node_modules/tslib/README.md +1 -1
- package/node_modules/tslib/SECURITY.md +41 -0
- package/node_modules/tslib/modules/index.d.ts +37 -0
- package/node_modules/tslib/modules/index.js +13 -0
- package/node_modules/tslib/package.json +12 -3
- package/node_modules/tslib/tslib.d.ts +55 -0
- package/node_modules/tslib/tslib.es6.js +125 -3
- package/node_modules/tslib/tslib.es6.mjs +370 -0
- package/node_modules/tslib/tslib.js +107 -3
- package/package.json +24 -26
- package/projenrc/auto-approve.ts +62 -0
- package/projenrc/automerge.ts +55 -0
- package/projenrc/customized-license.ts +24 -0
package/API.md
CHANGED
@@ -1,3 +1,253 @@
|
|
1
|
+
# Projen-CDKTF-Hybrid-Construct
|
2
|
+
|
3
|
+
Projen template for CDKTF Constructs that should also be used as Terraform Modules and for republishing Terraform Modules as Constructs.
|
4
|
+
|
5
|
+
## Usage
|
6
|
+
|
7
|
+
### `HybridModule`
|
8
|
+
|
9
|
+
If you want to write a CDKTF construct and also publish it as a Terraform Module you can use the `HybridModule` template.
|
10
|
+
|
11
|
+
You can initialize such a project using `npx projen new --from projen-cdktf-hybrid-construct hybrid-module`.
|
12
|
+
|
13
|
+
A configutation might look like this:
|
14
|
+
|
15
|
+
```js
|
16
|
+
const { HybridModule } = require("projen-cdktf-hybrid-construct");
|
17
|
+
|
18
|
+
const project = new HybridModule({
|
19
|
+
// The name of the module & repository need to start with terraform-cdk-
|
20
|
+
name: "terraform-cdk-my-new-hybrid-construct",
|
21
|
+
repositoryUrl:
|
22
|
+
"github.com/DanielMSchmidt/terraform-cdk-my-new-hybrid-construct",
|
23
|
+
|
24
|
+
author: "Daniel Schmidt",
|
25
|
+
authorAddress: "danielmschmidt92@gmail.com",
|
26
|
+
|
27
|
+
// If enabled an example folder with terraform code will be created
|
28
|
+
terraformExamples: {
|
29
|
+
enabled: true,
|
30
|
+
folder: "terraform",
|
31
|
+
// The configuration to add to the example terraform file
|
32
|
+
providerConfig: `
|
33
|
+
terraform {
|
34
|
+
required_providers {
|
35
|
+
aws = {
|
36
|
+
source = "hashicorp/aws"
|
37
|
+
version = "~> 3.74"
|
38
|
+
}
|
39
|
+
}
|
40
|
+
# Terraform binary version constraint
|
41
|
+
required_version = ">= 1.2.0"
|
42
|
+
}
|
43
|
+
|
44
|
+
|
45
|
+
provider "aws" {
|
46
|
+
region = "eu-central-1"
|
47
|
+
}
|
48
|
+
`,
|
49
|
+
},
|
50
|
+
|
51
|
+
// If enabled a constructs example folder will be created
|
52
|
+
constructExamples: {
|
53
|
+
enabled: true,
|
54
|
+
folder: "construct-examples",
|
55
|
+
},
|
56
|
+
});
|
57
|
+
project.synth();
|
58
|
+
```
|
59
|
+
|
60
|
+
### `TerraformModule`
|
61
|
+
|
62
|
+
If you want to republish an existing Terraform module as a CDKTF construct or if you want to repackage them with an easier to use API you can use the `TerraformModule` template.
|
63
|
+
|
64
|
+
You can initialize such a project using `npx projen new --from projen-cdktf-hybrid-construct terraform-module`.
|
65
|
+
|
66
|
+
A configutation might look like this:
|
67
|
+
|
68
|
+
```js
|
69
|
+
const { TerraformModule } = require("projen-cdktf-hybrid-construct");
|
70
|
+
|
71
|
+
const project = new TerraformModule({
|
72
|
+
name: "my-module",
|
73
|
+
author: "Daniel Schmidt",
|
74
|
+
authorAddress: "danielmschmidt92@gmail.com",
|
75
|
+
repositoryUrl: "github.com/DanielMSchmidt/my-module",
|
76
|
+
|
77
|
+
terraformModules: [
|
78
|
+
{
|
79
|
+
name: "eks",
|
80
|
+
source: "terraform-aws-modules/eks/aws",
|
81
|
+
version: "~> 18.0",
|
82
|
+
},
|
83
|
+
{
|
84
|
+
name: "eks-managed-nodegroup",
|
85
|
+
source: "terraform-aws-modules/eks/aws//modules/eks-managed-node-group",
|
86
|
+
version: "~> 18.0",
|
87
|
+
},
|
88
|
+
],
|
89
|
+
});
|
90
|
+
|
91
|
+
project.synth();
|
92
|
+
```
|
93
|
+
|
94
|
+
## Publishing
|
95
|
+
|
96
|
+
### Open Source
|
97
|
+
|
98
|
+
We have a helper method for easy configuration, but there are still some manual steps required.
|
99
|
+
|
100
|
+
```js
|
101
|
+
const {
|
102
|
+
HybridModule,
|
103
|
+
publishToRegistries,
|
104
|
+
} = require("projen-cdktf-hybrid-construct");
|
105
|
+
|
106
|
+
const project = new HybridModule({
|
107
|
+
// ... all the other options
|
108
|
+
...publishToRegistries({
|
109
|
+
name: "my-new-hybrid-construct",
|
110
|
+
namespace: "my-org",
|
111
|
+
registries: ["npm", "pypi", "nuget", "maven"],
|
112
|
+
}),
|
113
|
+
});
|
114
|
+
```
|
115
|
+
|
116
|
+
#### Terraform
|
117
|
+
|
118
|
+
1. [Sign in at the registry](https://registry.terraform.io/sign-in)
|
119
|
+
2. [Select your repository](https://registry.terraform.io/github/create) and create the module
|
120
|
+
|
121
|
+
Please make sure your repository name starts with `terraform-cdk-`.
|
122
|
+
|
123
|
+
#### npm (Typescript)
|
124
|
+
|
125
|
+
1. Create an account at [npmjs.com](https://npmjs.com/)
|
126
|
+
2. Create an [automation token](https://docs.npmjs.com/creating-and-viewing-access-tokens) on npm
|
127
|
+
3. Create a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `NPM_TOKEN` and the value of the token
|
128
|
+
|
129
|
+
#### pypi (Python)
|
130
|
+
|
131
|
+
1. Create an account at [pypi.org](https://pypi.org/)
|
132
|
+
2. Create an [API token](https://pypi.org/help/#apitoken) on pypi
|
133
|
+
3. Create a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `TWINE_USERNAME` and the value `__token__` and a second one with the name `TWINE_PASSWORD` and the value of the token
|
134
|
+
4. Set the `publishToPypi` section in the options of `HybridModule` or `TerraformModule` (or use the helper mentioned above)
|
135
|
+
|
136
|
+
```js
|
137
|
+
const name = "name-of-my-hybrid-construct";
|
138
|
+
new HybridModule({
|
139
|
+
name,
|
140
|
+
// ... other options
|
141
|
+
publishToPypi: {
|
142
|
+
distName: name,
|
143
|
+
module: name.replace(/-/g, "_"),
|
144
|
+
},
|
145
|
+
});
|
146
|
+
```
|
147
|
+
|
148
|
+
#### Maven (Java)
|
149
|
+
|
150
|
+
1. [Create a Sonatype account and repository](https://central.sonatype.org/publish/publish-guide/#introduction)
|
151
|
+
2. Create [GitHub Action Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) to configure maven:
|
152
|
+
- `MAVEN_USERNAME`
|
153
|
+
- `MAVEN_PASSWORD`
|
154
|
+
- `MAVEN_STAGING_PROFILE_ID`
|
155
|
+
- `MAVEN_GPG_PRIVATE_KEY_PASSPHRASE`
|
156
|
+
- `MAVEN_GPG_PRIVATE_KEY_PASSPHRASE`
|
157
|
+
3. Setup the `publishToMaven` section in the options of `HybridModule` or `TerraformModule` (or use the helper mentioned above)
|
158
|
+
|
159
|
+
```js
|
160
|
+
const githubNamespace = "my-org";
|
161
|
+
const name = "name-of-my-hybrid-construct";
|
162
|
+
new HybridModule({
|
163
|
+
name,
|
164
|
+
// ... other options
|
165
|
+
publishToMaven: {
|
166
|
+
javaPackage: name.replace(/-/g, "_"),
|
167
|
+
mavenGroupId: `com.${githubNamespace}`,
|
168
|
+
mavenArtifactId: name,
|
169
|
+
},
|
170
|
+
});
|
171
|
+
```
|
172
|
+
|
173
|
+
#### NuGet (C#)
|
174
|
+
|
175
|
+
1. [Create a NuGet account](https://www.nuget.org/users/account/LogOn) (you might need to create a Microsoft Account if you don't have one)
|
176
|
+
2. [Create API keys](https://docs.microsoft.com/en-us/nuget/nuget-org/publish-a-package#create-api-keys)
|
177
|
+
3. Create a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `NUGET_API_KEY` and the value of the token
|
178
|
+
4. Setup the `publishToNuget` section in the options of `HybridModule` or `TerraformModule` (or use the helper mentioned above)
|
179
|
+
|
180
|
+
```js
|
181
|
+
const githubNamespace = "my-org";
|
182
|
+
const name = "name-of-my-hybrid-construct";
|
183
|
+
|
184
|
+
new HybridModule({
|
185
|
+
name,
|
186
|
+
// ... other options
|
187
|
+
publishToNuget: {
|
188
|
+
dotNetNamespace: `MyOrg.NameOfMyHybridConstruct`,
|
189
|
+
packageId: `MyOrg.NameOfMyHybridConstruct`,
|
190
|
+
},
|
191
|
+
});
|
192
|
+
```
|
193
|
+
|
194
|
+
### Github Packages
|
195
|
+
|
196
|
+
We have a helper method for easy configuration, no extra steps needed:
|
197
|
+
|
198
|
+
```js
|
199
|
+
const {
|
200
|
+
HybridModule,
|
201
|
+
publishToGithubPackages,
|
202
|
+
} = require("projen-cdktf-hybrid-construct");
|
203
|
+
|
204
|
+
const project = new HybridModule({
|
205
|
+
// ... all the other options
|
206
|
+
...publishToGithubPackages({
|
207
|
+
name: "my-new-hybrid-construct",
|
208
|
+
namespace: "my-org",
|
209
|
+
registries: ["npm", "maven"], // pypi and nuget are not yet supported
|
210
|
+
}),
|
211
|
+
});
|
212
|
+
```
|
213
|
+
|
214
|
+
### Artifactory
|
215
|
+
|
216
|
+
We have a helper method for easy configuration, but there are also some manual steps required.
|
217
|
+
|
218
|
+
```js
|
219
|
+
const {
|
220
|
+
HybridModule,
|
221
|
+
publishToGithubPackages,
|
222
|
+
} = require("projen-cdktf-hybrid-construct");
|
223
|
+
|
224
|
+
const project = new HybridModule({
|
225
|
+
// ... all the other options
|
226
|
+
...publishToGithubPackages({
|
227
|
+
name: "my-new-hybrid-construct",
|
228
|
+
namespace: "my-org",
|
229
|
+
registries: ["npm", "pypi", "nuget"], // maven is currently not supported, PRs welcome
|
230
|
+
artifactoryApiUrl: "https://artifactory.my-org.com/api/",
|
231
|
+
artifactoryRepository: "my-repo", // needs to be the same across all registries, defaults to namespace so "my-org" in this case
|
232
|
+
}),
|
233
|
+
});
|
234
|
+
```
|
235
|
+
|
236
|
+
#### Terraform
|
237
|
+
|
238
|
+
You can find more information about publishing Terraform Modules to Artifactory [here](https://www.jfrog.com/confluence/display/JFROG/Terraform+Registry#TerraformRegistry-SettingupaLocalModule/ProviderRegistry).
|
239
|
+
|
240
|
+
#### npm (Typescript)
|
241
|
+
|
242
|
+
1. [Create a virtual npm registry](https://www.jfrog.com/confluence/display/JFROG/npm+Registry#npmRegistry-VirtualnpmRegistry)
|
243
|
+
2. [Authenticate against artifactory to get a token](https://www.jfrog.com/confluence/display/JFROG/npm+Registry#npmRegistry-AuthenticatingthenpmClient)
|
244
|
+
3. Create a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `NPM_TOKEN` and the value of the token
|
245
|
+
|
246
|
+
#### pypi (Python)
|
247
|
+
|
248
|
+
1. Create a [local repository](https://www.jfrog.com/confluence/display/JFROG/PyPI+Repositories#PyPIRepositories-LocalRepositories)
|
249
|
+
2. Create a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `TWINE_USERNAME` and the artifactory user name and a second one with the name `TWINE_PASSWORD` and the artifactory password
|
250
|
+
|
1
251
|
# API Reference <a name="API Reference" id="api-reference"></a>
|
2
252
|
|
3
253
|
|
@@ -58,12 +308,14 @@ const hybridModuleOptions: HybridModuleOptions = { ... }
|
|
58
308
|
| --- | --- | --- |
|
59
309
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
60
310
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
311
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
|
312
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
|
61
313
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
|
62
314
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. |
|
63
315
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.parent">parent</a></code> | <code>projen.Project</code> | The parent project, if this project is part of a bigger project. |
|
64
316
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
65
317
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.projenrcJson">projenrcJson</a></code> | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
|
66
|
-
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.projenrcJsonOptions">projenrcJsonOptions</a></code> | <code>projen.
|
318
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.projenrcJsonOptions">projenrcJsonOptions</a></code> | <code>projen.ProjenrcJsonOptions</code> | Options for .projenrc.json. |
|
67
319
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
68
320
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.renovatebotOptions">renovatebotOptions</a></code> | <code>projen.RenovatebotOptions</code> | Options for renovatebot. |
|
69
321
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
|
@@ -112,6 +364,7 @@ const hybridModuleOptions: HybridModuleOptions = { ... }
|
|
112
364
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
|
113
365
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
|
114
366
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
|
367
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.pnpmVersion">pnpmVersion</a></code> | <code>string</code> | The version of PNPM to use if using PNPM as a package manager. |
|
115
368
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
|
116
369
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
|
117
370
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
@@ -125,6 +378,7 @@ const hybridModuleOptions: HybridModuleOptions = { ... }
|
|
125
378
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.prerelease">prerelease</a></code> | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). |
|
126
379
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.publishDryRun">publishDryRun</a></code> | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command. |
|
127
380
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
|
381
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
128
382
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
129
383
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
130
384
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
@@ -143,7 +397,7 @@ const hybridModuleOptions: HybridModuleOptions = { ... }
|
|
143
397
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
|
144
398
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
145
399
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
146
|
-
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
400
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
|
147
401
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
|
148
402
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
149
403
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
@@ -157,6 +411,7 @@ const hybridModuleOptions: HybridModuleOptions = { ... }
|
|
157
411
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
|
158
412
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
|
159
413
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
|
414
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
|
160
415
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
|
161
416
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
|
162
417
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
|
@@ -172,7 +427,9 @@ const hybridModuleOptions: HybridModuleOptions = { ... }
|
|
172
427
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
|
173
428
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
174
429
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in GitHub workflows. |
|
430
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
175
431
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
432
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
|
176
433
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
177
434
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
|
178
435
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.entrypointTypes">entrypointTypes</a></code> | <code>string</code> | The .d.ts file that includes the type declarations for this module. |
|
@@ -197,6 +454,7 @@ const hybridModuleOptions: HybridModuleOptions = { ... }
|
|
197
454
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.docgenFilePath">docgenFilePath</a></code> | <code>string</code> | File path for generated docs. |
|
198
455
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.dotnet">dotnet</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | *No description.* |
|
199
456
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.excludeTypescript">excludeTypescript</a></code> | <code>string[]</code> | Accepts a list of glob patterns. |
|
457
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.jsiiVersion">jsiiVersion</a></code> | <code>string</code> | Version of the jsii compiler to use. |
|
200
458
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.publishToGo">publishToGo</a></code> | <code>projen.cdk.JsiiGoTarget</code> | Publish Go bindings to a git repository. |
|
201
459
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.publishToMaven">publishToMaven</a></code> | <code>projen.cdk.JsiiJavaTarget</code> | Publish to maven. |
|
202
460
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModuleOptions.property.publishToNuget">publishToNuget</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | Publish to NuGet. |
|
@@ -239,6 +497,30 @@ Whether to commit the managed files by default.
|
|
239
497
|
|
240
498
|
---
|
241
499
|
|
500
|
+
##### `gitIgnoreOptions`<sup>Optional</sup> <a name="gitIgnoreOptions" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.gitIgnoreOptions"></a>
|
501
|
+
|
502
|
+
```typescript
|
503
|
+
public readonly gitIgnoreOptions: IgnoreFileOptions;
|
504
|
+
```
|
505
|
+
|
506
|
+
- *Type:* projen.IgnoreFileOptions
|
507
|
+
|
508
|
+
Configuration options for .gitignore file.
|
509
|
+
|
510
|
+
---
|
511
|
+
|
512
|
+
##### `gitOptions`<sup>Optional</sup> <a name="gitOptions" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.gitOptions"></a>
|
513
|
+
|
514
|
+
```typescript
|
515
|
+
public readonly gitOptions: GitOptions;
|
516
|
+
```
|
517
|
+
|
518
|
+
- *Type:* projen.GitOptions
|
519
|
+
|
520
|
+
Configuration options for git.
|
521
|
+
|
522
|
+
---
|
523
|
+
|
242
524
|
##### `logging`<sup>Optional</sup> <a name="logging" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.logging"></a>
|
243
525
|
|
244
526
|
```typescript
|
@@ -314,10 +596,10 @@ Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .pr
|
|
314
596
|
##### `projenrcJsonOptions`<sup>Optional</sup> <a name="projenrcJsonOptions" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.projenrcJsonOptions"></a>
|
315
597
|
|
316
598
|
```typescript
|
317
|
-
public readonly projenrcJsonOptions:
|
599
|
+
public readonly projenrcJsonOptions: ProjenrcJsonOptions;
|
318
600
|
```
|
319
601
|
|
320
|
-
- *Type:* projen.
|
602
|
+
- *Type:* projen.ProjenrcJsonOptions
|
321
603
|
- *Default:* default options
|
322
604
|
|
323
605
|
Options for .projenrc.json.
|
@@ -402,7 +684,7 @@ public readonly clobber: boolean;
|
|
402
684
|
```
|
403
685
|
|
404
686
|
- *Type:* boolean
|
405
|
-
- *Default:* true
|
687
|
+
- *Default:* true, but false for subprojects
|
406
688
|
|
407
689
|
Add a `clobber` task which resets the repo to origin.
|
408
690
|
|
@@ -1047,6 +1329,19 @@ test your module against the lowest peer version required.
|
|
1047
1329
|
|
1048
1330
|
---
|
1049
1331
|
|
1332
|
+
##### `pnpmVersion`<sup>Optional</sup> <a name="pnpmVersion" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.pnpmVersion"></a>
|
1333
|
+
|
1334
|
+
```typescript
|
1335
|
+
public readonly pnpmVersion: string;
|
1336
|
+
```
|
1337
|
+
|
1338
|
+
- *Type:* string
|
1339
|
+
- *Default:* "7"
|
1340
|
+
|
1341
|
+
The version of PNPM to use if using PNPM as a package manager.
|
1342
|
+
|
1343
|
+
---
|
1344
|
+
|
1050
1345
|
##### `repository`<sup>Optional</sup> <a name="repository" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.repository"></a>
|
1051
1346
|
|
1052
1347
|
```typescript
|
@@ -1086,7 +1381,9 @@ Options for privately hosted scoped packages.
|
|
1086
1381
|
|
1087
1382
|
---
|
1088
1383
|
|
1089
|
-
#####
|
1384
|
+
##### ~~`scripts`~~<sup>Optional</sup> <a name="scripts" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.scripts"></a>
|
1385
|
+
|
1386
|
+
- *Deprecated:* use `project.addTask()` or `package.setScript()`
|
1090
1387
|
|
1091
1388
|
```typescript
|
1092
1389
|
public readonly scripts: {[ key: string ]: string};
|
@@ -1099,6 +1396,7 @@ npm scripts to include.
|
|
1099
1396
|
|
1100
1397
|
If a script has the same name as a standard script,
|
1101
1398
|
the standard script will be overwritten.
|
1399
|
+
Also adds the script as a task.
|
1102
1400
|
|
1103
1401
|
---
|
1104
1402
|
|
@@ -1232,6 +1530,19 @@ in order to create a publishing task for each publishing activity.
|
|
1232
1530
|
|
1233
1531
|
---
|
1234
1532
|
|
1533
|
+
##### `releasableCommits`<sup>Optional</sup> <a name="releasableCommits" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.releasableCommits"></a>
|
1534
|
+
|
1535
|
+
```typescript
|
1536
|
+
public readonly releasableCommits: ReleasableCommits;
|
1537
|
+
```
|
1538
|
+
|
1539
|
+
- *Type:* projen.ReleasableCommits
|
1540
|
+
- *Default:* ReleasableCommits.everyCommit()
|
1541
|
+
|
1542
|
+
Find commits that should be considered releasable Used to decide if a release is required.
|
1543
|
+
|
1544
|
+
---
|
1545
|
+
|
1235
1546
|
##### `releaseBranches`<sup>Optional</sup> <a name="releaseBranches" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.releaseBranches"></a>
|
1236
1547
|
|
1237
1548
|
```typescript
|
@@ -1495,7 +1806,7 @@ public readonly codeCov: boolean;
|
|
1495
1806
|
- *Type:* boolean
|
1496
1807
|
- *Default:* false
|
1497
1808
|
|
1498
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
1809
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
|
1499
1810
|
|
1500
1811
|
---
|
1501
1812
|
|
@@ -1678,6 +1989,18 @@ Defines an .npmignore file. Normally this is only needed for libraries that are
|
|
1678
1989
|
|
1679
1990
|
---
|
1680
1991
|
|
1992
|
+
##### `npmIgnoreOptions`<sup>Optional</sup> <a name="npmIgnoreOptions" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.npmIgnoreOptions"></a>
|
1993
|
+
|
1994
|
+
```typescript
|
1995
|
+
public readonly npmIgnoreOptions: IgnoreFileOptions;
|
1996
|
+
```
|
1997
|
+
|
1998
|
+
- *Type:* projen.IgnoreFileOptions
|
1999
|
+
|
2000
|
+
Configuration options for .npmignore file.
|
2001
|
+
|
2002
|
+
---
|
2003
|
+
|
1681
2004
|
##### `package`<sup>Optional</sup> <a name="package" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.package"></a>
|
1682
2005
|
|
1683
2006
|
```typescript
|
@@ -1875,6 +2198,19 @@ The node version to use in GitHub workflows.
|
|
1875
2198
|
|
1876
2199
|
---
|
1877
2200
|
|
2201
|
+
##### `workflowPackageCache`<sup>Optional</sup> <a name="workflowPackageCache" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.workflowPackageCache"></a>
|
2202
|
+
|
2203
|
+
```typescript
|
2204
|
+
public readonly workflowPackageCache: boolean;
|
2205
|
+
```
|
2206
|
+
|
2207
|
+
- *Type:* boolean
|
2208
|
+
- *Default:* false
|
2209
|
+
|
2210
|
+
Enable Node.js package cache in GitHub workflows.
|
2211
|
+
|
2212
|
+
---
|
2213
|
+
|
1878
2214
|
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.disableTsconfig"></a>
|
1879
2215
|
|
1880
2216
|
```typescript
|
@@ -1888,6 +2224,19 @@ Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.jso
|
|
1888
2224
|
|
1889
2225
|
---
|
1890
2226
|
|
2227
|
+
##### `disableTsconfigDev`<sup>Optional</sup> <a name="disableTsconfigDev" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.disableTsconfigDev"></a>
|
2228
|
+
|
2229
|
+
```typescript
|
2230
|
+
public readonly disableTsconfigDev: boolean;
|
2231
|
+
```
|
2232
|
+
|
2233
|
+
- *Type:* boolean
|
2234
|
+
- *Default:* false
|
2235
|
+
|
2236
|
+
Do not generate a `tsconfig.dev.json` file.
|
2237
|
+
|
2238
|
+
---
|
2239
|
+
|
1891
2240
|
##### `docgen`<sup>Optional</sup> <a name="docgen" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.docgen"></a>
|
1892
2241
|
|
1893
2242
|
```typescript
|
@@ -2214,6 +2563,26 @@ that cannot be compiled with jsii's compiler settings.
|
|
2214
2563
|
|
2215
2564
|
---
|
2216
2565
|
|
2566
|
+
##### `jsiiVersion`<sup>Optional</sup> <a name="jsiiVersion" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.jsiiVersion"></a>
|
2567
|
+
|
2568
|
+
```typescript
|
2569
|
+
public readonly jsiiVersion: string;
|
2570
|
+
```
|
2571
|
+
|
2572
|
+
- *Type:* string
|
2573
|
+
- *Default:* "1.x"
|
2574
|
+
|
2575
|
+
Version of the jsii compiler to use.
|
2576
|
+
|
2577
|
+
Set to "*" if you want to manually manage the version of jsii in your
|
2578
|
+
project by managing updates to `package.json` on your own.
|
2579
|
+
|
2580
|
+
NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned
|
2581
|
+
and should remain on the same minor, so we recommend using a `~` dependency
|
2582
|
+
(e.g. `~5.0.0`).
|
2583
|
+
|
2584
|
+
---
|
2585
|
+
|
2217
2586
|
##### `publishToGo`<sup>Optional</sup> <a name="publishToGo" id="projen-cdktf-hybrid-construct.HybridModuleOptions.property.publishToGo"></a>
|
2218
2587
|
|
2219
2588
|
```typescript
|
@@ -2466,12 +2835,14 @@ const terraformModuleOptions: TerraformModuleOptions = { ... }
|
|
2466
2835
|
| --- | --- | --- |
|
2467
2836
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
2468
2837
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
2838
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
|
2839
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
|
2469
2840
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
|
2470
2841
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. |
|
2471
2842
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.parent">parent</a></code> | <code>projen.Project</code> | The parent project, if this project is part of a bigger project. |
|
2472
2843
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
2473
2844
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.projenrcJson">projenrcJson</a></code> | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
|
2474
|
-
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.projenrcJsonOptions">projenrcJsonOptions</a></code> | <code>projen.
|
2845
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.projenrcJsonOptions">projenrcJsonOptions</a></code> | <code>projen.ProjenrcJsonOptions</code> | Options for .projenrc.json. |
|
2475
2846
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
2476
2847
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.renovatebotOptions">renovatebotOptions</a></code> | <code>projen.RenovatebotOptions</code> | Options for renovatebot. |
|
2477
2848
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
|
@@ -2520,6 +2891,7 @@ const terraformModuleOptions: TerraformModuleOptions = { ... }
|
|
2520
2891
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
|
2521
2892
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
|
2522
2893
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
|
2894
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.pnpmVersion">pnpmVersion</a></code> | <code>string</code> | The version of PNPM to use if using PNPM as a package manager. |
|
2523
2895
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
|
2524
2896
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
|
2525
2897
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
@@ -2533,6 +2905,7 @@ const terraformModuleOptions: TerraformModuleOptions = { ... }
|
|
2533
2905
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.prerelease">prerelease</a></code> | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). |
|
2534
2906
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.publishDryRun">publishDryRun</a></code> | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command. |
|
2535
2907
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
|
2908
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
2536
2909
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
2537
2910
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
2538
2911
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
@@ -2551,7 +2924,7 @@ const terraformModuleOptions: TerraformModuleOptions = { ... }
|
|
2551
2924
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
|
2552
2925
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
2553
2926
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
2554
|
-
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
2927
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
|
2555
2928
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
|
2556
2929
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
2557
2930
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
@@ -2565,6 +2938,7 @@ const terraformModuleOptions: TerraformModuleOptions = { ... }
|
|
2565
2938
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
|
2566
2939
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
|
2567
2940
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
|
2941
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
|
2568
2942
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
|
2569
2943
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
|
2570
2944
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
|
@@ -2580,7 +2954,9 @@ const terraformModuleOptions: TerraformModuleOptions = { ... }
|
|
2580
2954
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
|
2581
2955
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
2582
2956
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in GitHub workflows. |
|
2957
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
2583
2958
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
2959
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
|
2584
2960
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
2585
2961
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
|
2586
2962
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.entrypointTypes">entrypointTypes</a></code> | <code>string</code> | The .d.ts file that includes the type declarations for this module. |
|
@@ -2605,6 +2981,7 @@ const terraformModuleOptions: TerraformModuleOptions = { ... }
|
|
2605
2981
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.docgenFilePath">docgenFilePath</a></code> | <code>string</code> | File path for generated docs. |
|
2606
2982
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.dotnet">dotnet</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | *No description.* |
|
2607
2983
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.excludeTypescript">excludeTypescript</a></code> | <code>string[]</code> | Accepts a list of glob patterns. |
|
2984
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.jsiiVersion">jsiiVersion</a></code> | <code>string</code> | Version of the jsii compiler to use. |
|
2608
2985
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.publishToGo">publishToGo</a></code> | <code>projen.cdk.JsiiGoTarget</code> | Publish Go bindings to a git repository. |
|
2609
2986
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.publishToMaven">publishToMaven</a></code> | <code>projen.cdk.JsiiJavaTarget</code> | Publish to maven. |
|
2610
2987
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModuleOptions.property.publishToNuget">publishToNuget</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | Publish to NuGet. |
|
@@ -2646,6 +3023,30 @@ Whether to commit the managed files by default.
|
|
2646
3023
|
|
2647
3024
|
---
|
2648
3025
|
|
3026
|
+
##### `gitIgnoreOptions`<sup>Optional</sup> <a name="gitIgnoreOptions" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.gitIgnoreOptions"></a>
|
3027
|
+
|
3028
|
+
```typescript
|
3029
|
+
public readonly gitIgnoreOptions: IgnoreFileOptions;
|
3030
|
+
```
|
3031
|
+
|
3032
|
+
- *Type:* projen.IgnoreFileOptions
|
3033
|
+
|
3034
|
+
Configuration options for .gitignore file.
|
3035
|
+
|
3036
|
+
---
|
3037
|
+
|
3038
|
+
##### `gitOptions`<sup>Optional</sup> <a name="gitOptions" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.gitOptions"></a>
|
3039
|
+
|
3040
|
+
```typescript
|
3041
|
+
public readonly gitOptions: GitOptions;
|
3042
|
+
```
|
3043
|
+
|
3044
|
+
- *Type:* projen.GitOptions
|
3045
|
+
|
3046
|
+
Configuration options for git.
|
3047
|
+
|
3048
|
+
---
|
3049
|
+
|
2649
3050
|
##### `logging`<sup>Optional</sup> <a name="logging" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.logging"></a>
|
2650
3051
|
|
2651
3052
|
```typescript
|
@@ -2721,10 +3122,10 @@ Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .pr
|
|
2721
3122
|
##### `projenrcJsonOptions`<sup>Optional</sup> <a name="projenrcJsonOptions" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.projenrcJsonOptions"></a>
|
2722
3123
|
|
2723
3124
|
```typescript
|
2724
|
-
public readonly projenrcJsonOptions:
|
3125
|
+
public readonly projenrcJsonOptions: ProjenrcJsonOptions;
|
2725
3126
|
```
|
2726
3127
|
|
2727
|
-
- *Type:* projen.
|
3128
|
+
- *Type:* projen.ProjenrcJsonOptions
|
2728
3129
|
- *Default:* default options
|
2729
3130
|
|
2730
3131
|
Options for .projenrc.json.
|
@@ -2809,7 +3210,7 @@ public readonly clobber: boolean;
|
|
2809
3210
|
```
|
2810
3211
|
|
2811
3212
|
- *Type:* boolean
|
2812
|
-
- *Default:* true
|
3213
|
+
- *Default:* true, but false for subprojects
|
2813
3214
|
|
2814
3215
|
Add a `clobber` task which resets the repo to origin.
|
2815
3216
|
|
@@ -3454,6 +3855,19 @@ test your module against the lowest peer version required.
|
|
3454
3855
|
|
3455
3856
|
---
|
3456
3857
|
|
3858
|
+
##### `pnpmVersion`<sup>Optional</sup> <a name="pnpmVersion" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.pnpmVersion"></a>
|
3859
|
+
|
3860
|
+
```typescript
|
3861
|
+
public readonly pnpmVersion: string;
|
3862
|
+
```
|
3863
|
+
|
3864
|
+
- *Type:* string
|
3865
|
+
- *Default:* "7"
|
3866
|
+
|
3867
|
+
The version of PNPM to use if using PNPM as a package manager.
|
3868
|
+
|
3869
|
+
---
|
3870
|
+
|
3457
3871
|
##### `repository`<sup>Optional</sup> <a name="repository" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.repository"></a>
|
3458
3872
|
|
3459
3873
|
```typescript
|
@@ -3493,7 +3907,9 @@ Options for privately hosted scoped packages.
|
|
3493
3907
|
|
3494
3908
|
---
|
3495
3909
|
|
3496
|
-
#####
|
3910
|
+
##### ~~`scripts`~~<sup>Optional</sup> <a name="scripts" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.scripts"></a>
|
3911
|
+
|
3912
|
+
- *Deprecated:* use `project.addTask()` or `package.setScript()`
|
3497
3913
|
|
3498
3914
|
```typescript
|
3499
3915
|
public readonly scripts: {[ key: string ]: string};
|
@@ -3506,6 +3922,7 @@ npm scripts to include.
|
|
3506
3922
|
|
3507
3923
|
If a script has the same name as a standard script,
|
3508
3924
|
the standard script will be overwritten.
|
3925
|
+
Also adds the script as a task.
|
3509
3926
|
|
3510
3927
|
---
|
3511
3928
|
|
@@ -3639,6 +4056,19 @@ in order to create a publishing task for each publishing activity.
|
|
3639
4056
|
|
3640
4057
|
---
|
3641
4058
|
|
4059
|
+
##### `releasableCommits`<sup>Optional</sup> <a name="releasableCommits" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.releasableCommits"></a>
|
4060
|
+
|
4061
|
+
```typescript
|
4062
|
+
public readonly releasableCommits: ReleasableCommits;
|
4063
|
+
```
|
4064
|
+
|
4065
|
+
- *Type:* projen.ReleasableCommits
|
4066
|
+
- *Default:* ReleasableCommits.everyCommit()
|
4067
|
+
|
4068
|
+
Find commits that should be considered releasable Used to decide if a release is required.
|
4069
|
+
|
4070
|
+
---
|
4071
|
+
|
3642
4072
|
##### `releaseBranches`<sup>Optional</sup> <a name="releaseBranches" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.releaseBranches"></a>
|
3643
4073
|
|
3644
4074
|
```typescript
|
@@ -3902,7 +4332,7 @@ public readonly codeCov: boolean;
|
|
3902
4332
|
- *Type:* boolean
|
3903
4333
|
- *Default:* false
|
3904
4334
|
|
3905
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
4335
|
+
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
|
3906
4336
|
|
3907
4337
|
---
|
3908
4338
|
|
@@ -4085,6 +4515,18 @@ Defines an .npmignore file. Normally this is only needed for libraries that are
|
|
4085
4515
|
|
4086
4516
|
---
|
4087
4517
|
|
4518
|
+
##### `npmIgnoreOptions`<sup>Optional</sup> <a name="npmIgnoreOptions" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.npmIgnoreOptions"></a>
|
4519
|
+
|
4520
|
+
```typescript
|
4521
|
+
public readonly npmIgnoreOptions: IgnoreFileOptions;
|
4522
|
+
```
|
4523
|
+
|
4524
|
+
- *Type:* projen.IgnoreFileOptions
|
4525
|
+
|
4526
|
+
Configuration options for .npmignore file.
|
4527
|
+
|
4528
|
+
---
|
4529
|
+
|
4088
4530
|
##### `package`<sup>Optional</sup> <a name="package" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.package"></a>
|
4089
4531
|
|
4090
4532
|
```typescript
|
@@ -4282,6 +4724,19 @@ The node version to use in GitHub workflows.
|
|
4282
4724
|
|
4283
4725
|
---
|
4284
4726
|
|
4727
|
+
##### `workflowPackageCache`<sup>Optional</sup> <a name="workflowPackageCache" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.workflowPackageCache"></a>
|
4728
|
+
|
4729
|
+
```typescript
|
4730
|
+
public readonly workflowPackageCache: boolean;
|
4731
|
+
```
|
4732
|
+
|
4733
|
+
- *Type:* boolean
|
4734
|
+
- *Default:* false
|
4735
|
+
|
4736
|
+
Enable Node.js package cache in GitHub workflows.
|
4737
|
+
|
4738
|
+
---
|
4739
|
+
|
4285
4740
|
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.disableTsconfig"></a>
|
4286
4741
|
|
4287
4742
|
```typescript
|
@@ -4295,6 +4750,19 @@ Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.jso
|
|
4295
4750
|
|
4296
4751
|
---
|
4297
4752
|
|
4753
|
+
##### `disableTsconfigDev`<sup>Optional</sup> <a name="disableTsconfigDev" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.disableTsconfigDev"></a>
|
4754
|
+
|
4755
|
+
```typescript
|
4756
|
+
public readonly disableTsconfigDev: boolean;
|
4757
|
+
```
|
4758
|
+
|
4759
|
+
- *Type:* boolean
|
4760
|
+
- *Default:* false
|
4761
|
+
|
4762
|
+
Do not generate a `tsconfig.dev.json` file.
|
4763
|
+
|
4764
|
+
---
|
4765
|
+
|
4298
4766
|
##### `docgen`<sup>Optional</sup> <a name="docgen" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.docgen"></a>
|
4299
4767
|
|
4300
4768
|
```typescript
|
@@ -4621,6 +5089,26 @@ that cannot be compiled with jsii's compiler settings.
|
|
4621
5089
|
|
4622
5090
|
---
|
4623
5091
|
|
5092
|
+
##### `jsiiVersion`<sup>Optional</sup> <a name="jsiiVersion" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.jsiiVersion"></a>
|
5093
|
+
|
5094
|
+
```typescript
|
5095
|
+
public readonly jsiiVersion: string;
|
5096
|
+
```
|
5097
|
+
|
5098
|
+
- *Type:* string
|
5099
|
+
- *Default:* "1.x"
|
5100
|
+
|
5101
|
+
Version of the jsii compiler to use.
|
5102
|
+
|
5103
|
+
Set to "*" if you want to manually manage the version of jsii in your
|
5104
|
+
project by managing updates to `package.json` on your own.
|
5105
|
+
|
5106
|
+
NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned
|
5107
|
+
and should remain on the same minor, so we recommend using a `~` dependency
|
5108
|
+
(e.g. `~5.0.0`).
|
5109
|
+
|
5110
|
+
---
|
5111
|
+
|
4624
5112
|
##### `publishToGo`<sup>Optional</sup> <a name="publishToGo" id="projen-cdktf-hybrid-construct.TerraformModuleOptions.property.publishToGo"></a>
|
4625
5113
|
|
4626
5114
|
```typescript
|
@@ -4883,6 +5371,7 @@ new HybridModule(options: HybridModuleOptions)
|
|
4883
5371
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.addFields">addFields</a></code> | Directly set fields in `package.json`. |
|
4884
5372
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
|
4885
5373
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
|
5374
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
|
4886
5375
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
|
4887
5376
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
|
4888
5377
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
@@ -5299,6 +5788,22 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
5299
5788
|
|
5300
5789
|
---
|
5301
5790
|
|
5791
|
+
##### `addScripts` <a name="addScripts" id="projen-cdktf-hybrid-construct.HybridModule.addScripts"></a>
|
5792
|
+
|
5793
|
+
```typescript
|
5794
|
+
public addScripts(scripts: {[ key: string ]: string}): void
|
5795
|
+
```
|
5796
|
+
|
5797
|
+
Replaces the contents of multiple npm package.json scripts.
|
5798
|
+
|
5799
|
+
###### `scripts`<sup>Required</sup> <a name="scripts" id="projen-cdktf-hybrid-construct.HybridModule.addScripts.parameter.scripts"></a>
|
5800
|
+
|
5801
|
+
- *Type:* {[ key: string ]: string}
|
5802
|
+
|
5803
|
+
The scripts to set.
|
5804
|
+
|
5805
|
+
---
|
5806
|
+
|
5302
5807
|
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="projen-cdktf-hybrid-construct.HybridModule.addTestCommand"></a>
|
5303
5808
|
|
5304
5809
|
```typescript
|
@@ -5313,7 +5818,7 @@ DEPRECATED.
|
|
5313
5818
|
|
5314
5819
|
---
|
5315
5820
|
|
5316
|
-
#####
|
5821
|
+
##### ~~`hasScript`~~ <a name="hasScript" id="projen-cdktf-hybrid-construct.HybridModule.hasScript"></a>
|
5317
5822
|
|
5318
5823
|
```typescript
|
5319
5824
|
public hasScript(name: string): boolean
|
@@ -5408,6 +5913,7 @@ The command to execute.
|
|
5408
5913
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
|
5409
5914
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.projenCommand">projenCommand</a></code> | <code>string</code> | The command to use in order to run the projen CLI. |
|
5410
5915
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
|
5916
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.subprojects">subprojects</a></code> | <code>projen.Project[]</code> | Returns all the subprojects within this project. |
|
5411
5917
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
|
5412
5918
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
|
5413
5919
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
@@ -5425,6 +5931,7 @@ The command to execute.
|
|
5425
5931
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
|
5426
5932
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
|
5427
5933
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
|
5934
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
|
5428
5935
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
|
5429
5936
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
|
5430
5937
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
|
@@ -5432,7 +5939,7 @@ The command to execute.
|
|
5432
5939
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
|
5433
5940
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
|
5434
5941
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
|
5435
|
-
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version required by this
|
5942
|
+
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version required by this package. |
|
5436
5943
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | Minimum node.js version required by this package. |
|
5437
5944
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
5438
5945
|
| <code><a href="#projen-cdktf-hybrid-construct.HybridModule.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
@@ -5658,6 +6165,18 @@ The root project.
|
|
5658
6165
|
|
5659
6166
|
---
|
5660
6167
|
|
6168
|
+
##### `subprojects`<sup>Required</sup> <a name="subprojects" id="projen-cdktf-hybrid-construct.HybridModule.property.subprojects"></a>
|
6169
|
+
|
6170
|
+
```typescript
|
6171
|
+
public readonly subprojects: Project[];
|
6172
|
+
```
|
6173
|
+
|
6174
|
+
- *Type:* projen.Project[]
|
6175
|
+
|
6176
|
+
Returns all the subprojects within this project.
|
6177
|
+
|
6178
|
+
---
|
6179
|
+
|
5661
6180
|
##### `tasks`<sup>Required</sup> <a name="tasks" id="projen-cdktf-hybrid-construct.HybridModule.property.tasks"></a>
|
5662
6181
|
|
5663
6182
|
```typescript
|
@@ -5877,6 +6396,18 @@ public readonly manifest: any;
|
|
5877
6396
|
|
5878
6397
|
---
|
5879
6398
|
|
6399
|
+
##### `npmrc`<sup>Required</sup> <a name="npmrc" id="projen-cdktf-hybrid-construct.HybridModule.property.npmrc"></a>
|
6400
|
+
|
6401
|
+
```typescript
|
6402
|
+
public readonly npmrc: NpmConfig;
|
6403
|
+
```
|
6404
|
+
|
6405
|
+
- *Type:* projen.javascript.NpmConfig
|
6406
|
+
|
6407
|
+
The .npmrc file.
|
6408
|
+
|
6409
|
+
---
|
6410
|
+
|
5880
6411
|
##### `package`<sup>Required</sup> <a name="package" id="projen-cdktf-hybrid-construct.HybridModule.property.package"></a>
|
5881
6412
|
|
5882
6413
|
```typescript
|
@@ -5973,7 +6504,7 @@ public readonly maxNodeVersion: string;
|
|
5973
6504
|
|
5974
6505
|
- *Type:* string
|
5975
6506
|
|
5976
|
-
Maximum node version required by this
|
6507
|
+
Maximum node version required by this package.
|
5977
6508
|
|
5978
6509
|
---
|
5979
6510
|
|
@@ -6236,6 +6767,7 @@ new TerraformModule(options: TerraformModuleOptions)
|
|
6236
6767
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.addFields">addFields</a></code> | Directly set fields in `package.json`. |
|
6237
6768
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
|
6238
6769
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
|
6770
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
|
6239
6771
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
|
6240
6772
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
|
6241
6773
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
@@ -6652,6 +7184,22 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
6652
7184
|
|
6653
7185
|
---
|
6654
7186
|
|
7187
|
+
##### `addScripts` <a name="addScripts" id="projen-cdktf-hybrid-construct.TerraformModule.addScripts"></a>
|
7188
|
+
|
7189
|
+
```typescript
|
7190
|
+
public addScripts(scripts: {[ key: string ]: string}): void
|
7191
|
+
```
|
7192
|
+
|
7193
|
+
Replaces the contents of multiple npm package.json scripts.
|
7194
|
+
|
7195
|
+
###### `scripts`<sup>Required</sup> <a name="scripts" id="projen-cdktf-hybrid-construct.TerraformModule.addScripts.parameter.scripts"></a>
|
7196
|
+
|
7197
|
+
- *Type:* {[ key: string ]: string}
|
7198
|
+
|
7199
|
+
The scripts to set.
|
7200
|
+
|
7201
|
+
---
|
7202
|
+
|
6655
7203
|
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="projen-cdktf-hybrid-construct.TerraformModule.addTestCommand"></a>
|
6656
7204
|
|
6657
7205
|
```typescript
|
@@ -6666,7 +7214,7 @@ DEPRECATED.
|
|
6666
7214
|
|
6667
7215
|
---
|
6668
7216
|
|
6669
|
-
#####
|
7217
|
+
##### ~~`hasScript`~~ <a name="hasScript" id="projen-cdktf-hybrid-construct.TerraformModule.hasScript"></a>
|
6670
7218
|
|
6671
7219
|
```typescript
|
6672
7220
|
public hasScript(name: string): boolean
|
@@ -6761,6 +7309,7 @@ The command to execute.
|
|
6761
7309
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
|
6762
7310
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.projenCommand">projenCommand</a></code> | <code>string</code> | The command to use in order to run the projen CLI. |
|
6763
7311
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
|
7312
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.subprojects">subprojects</a></code> | <code>projen.Project[]</code> | Returns all the subprojects within this project. |
|
6764
7313
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
|
6765
7314
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
|
6766
7315
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
@@ -6778,6 +7327,7 @@ The command to execute.
|
|
6778
7327
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
|
6779
7328
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
|
6780
7329
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
|
7330
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
|
6781
7331
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
|
6782
7332
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
|
6783
7333
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
|
@@ -6785,7 +7335,7 @@ The command to execute.
|
|
6785
7335
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
|
6786
7336
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
|
6787
7337
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
|
6788
|
-
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version required by this
|
7338
|
+
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version required by this package. |
|
6789
7339
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | Minimum node.js version required by this package. |
|
6790
7340
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
6791
7341
|
| <code><a href="#projen-cdktf-hybrid-construct.TerraformModule.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
@@ -7011,6 +7561,18 @@ The root project.
|
|
7011
7561
|
|
7012
7562
|
---
|
7013
7563
|
|
7564
|
+
##### `subprojects`<sup>Required</sup> <a name="subprojects" id="projen-cdktf-hybrid-construct.TerraformModule.property.subprojects"></a>
|
7565
|
+
|
7566
|
+
```typescript
|
7567
|
+
public readonly subprojects: Project[];
|
7568
|
+
```
|
7569
|
+
|
7570
|
+
- *Type:* projen.Project[]
|
7571
|
+
|
7572
|
+
Returns all the subprojects within this project.
|
7573
|
+
|
7574
|
+
---
|
7575
|
+
|
7014
7576
|
##### `tasks`<sup>Required</sup> <a name="tasks" id="projen-cdktf-hybrid-construct.TerraformModule.property.tasks"></a>
|
7015
7577
|
|
7016
7578
|
```typescript
|
@@ -7230,6 +7792,18 @@ public readonly manifest: any;
|
|
7230
7792
|
|
7231
7793
|
---
|
7232
7794
|
|
7795
|
+
##### `npmrc`<sup>Required</sup> <a name="npmrc" id="projen-cdktf-hybrid-construct.TerraformModule.property.npmrc"></a>
|
7796
|
+
|
7797
|
+
```typescript
|
7798
|
+
public readonly npmrc: NpmConfig;
|
7799
|
+
```
|
7800
|
+
|
7801
|
+
- *Type:* projen.javascript.NpmConfig
|
7802
|
+
|
7803
|
+
The .npmrc file.
|
7804
|
+
|
7805
|
+
---
|
7806
|
+
|
7233
7807
|
##### `package`<sup>Required</sup> <a name="package" id="projen-cdktf-hybrid-construct.TerraformModule.property.package"></a>
|
7234
7808
|
|
7235
7809
|
```typescript
|
@@ -7326,7 +7900,7 @@ public readonly maxNodeVersion: string;
|
|
7326
7900
|
|
7327
7901
|
- *Type:* string
|
7328
7902
|
|
7329
|
-
Maximum node version required by this
|
7903
|
+
Maximum node version required by this package.
|
7330
7904
|
|
7331
7905
|
---
|
7332
7906
|
|