@nikovirtala/projen-constructs 0.0.11 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +852 -780
- package/API.md +648 -592
- package/lib/components/vitest.js +1 -1
- package/lib/projects/awscdk-app-options.generated.d.ts +6 -0
- package/lib/projects/awscdk-app-options.generated.js +1 -1
- package/lib/projects/{awscdk-construct-options.generated.d.ts → awscdk-construct-library-options.generated.d.ts} +8 -2
- package/lib/projects/awscdk-construct-library-options.generated.js +3 -0
- package/lib/projects/awscdk-construct-library.d.ts +6 -0
- package/lib/projects/awscdk-construct-library.js +19 -0
- package/lib/projects/awscdk-typescript-app-options.generated.d.ts +1098 -0
- package/lib/projects/awscdk-typescript-app-options.generated.js +3 -0
- package/lib/projects/{awscdk-app.d.ts → awscdk-typescript-app.d.ts} +2 -2
- package/lib/projects/awscdk-typescript-app.js +19 -0
- package/lib/projects/index.d.ts +2 -2
- package/lib/projects/index.js +3 -3
- package/lib/projects/jsii-options.generated.d.ts +6 -0
- package/lib/projects/jsii-options.generated.js +1 -1
- package/lib/projects/jsii.js +1 -1
- package/lib/projects/typescript-options.generated.d.ts +6 -0
- package/lib/projects/typescript-options.generated.js +1 -1
- package/lib/projects/typescript.js +1 -1
- package/package.json +1 -1
- package/lib/projects/awscdk-app.js +0 -19
- package/lib/projects/awscdk-construct-options.generated.js +0 -3
- package/lib/projects/awscdk-construct.d.ts +0 -6
- package/lib/projects/awscdk-construct.js +0 -19
package/API.md
CHANGED
|
@@ -2,25 +2,25 @@
|
|
|
2
2
|
|
|
3
3
|
## Constructs <a name="Constructs" id="Constructs"></a>
|
|
4
4
|
|
|
5
|
-
###
|
|
5
|
+
### AwsCdkConstructLibraryProject <a name="AwsCdkConstructLibraryProject" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject"></a>
|
|
6
6
|
|
|
7
|
-
#### Initializers <a name="Initializers" id="@nikovirtala/projen-constructs.
|
|
7
|
+
#### Initializers <a name="Initializers" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.Initializer"></a>
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
import {
|
|
10
|
+
import { AwsCdkConstructLibraryProject } from '@nikovirtala/projen-constructs'
|
|
11
11
|
|
|
12
|
-
new
|
|
12
|
+
new AwsCdkConstructLibraryProject(options: AwsCdkConstructLibraryProjectOptions)
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
| **Name** | **Type** | **Description** |
|
|
16
16
|
| --- | --- | --- |
|
|
17
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
17
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.Initializer.parameter.options">options</a></code> | <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions">AwsCdkConstructLibraryProjectOptions</a></code> | *No description.* |
|
|
18
18
|
|
|
19
19
|
---
|
|
20
20
|
|
|
21
|
-
##### `options`<sup>Required</sup> <a name="options" id="@nikovirtala/projen-constructs.
|
|
21
|
+
##### `options`<sup>Required</sup> <a name="options" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.Initializer.parameter.options"></a>
|
|
22
22
|
|
|
23
|
-
- *Type:* <a href="#@nikovirtala/projen-constructs.
|
|
23
|
+
- *Type:* <a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions">AwsCdkConstructLibraryProjectOptions</a>
|
|
24
24
|
|
|
25
25
|
---
|
|
26
26
|
|
|
@@ -28,42 +28,42 @@ new AwsCdkConstructProject(options: AwsCdkConstructProjectOptions)
|
|
|
28
28
|
|
|
29
29
|
| **Name** | **Description** |
|
|
30
30
|
| --- | --- |
|
|
31
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
32
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
33
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
34
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
35
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
36
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
37
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
38
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
39
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
40
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
41
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
42
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
43
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
44
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
45
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
46
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
47
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
48
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
49
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
50
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
51
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
52
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
53
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
54
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
55
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
56
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
57
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
58
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
59
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
60
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
61
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
62
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
63
|
-
|
|
64
|
-
---
|
|
65
|
-
|
|
66
|
-
##### `toString` <a name="toString" id="@nikovirtala/projen-constructs.
|
|
31
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
32
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
33
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
34
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
35
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addTask">addTask</a></code> | Adds a new task to this project. |
|
|
36
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
|
|
37
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
|
|
38
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
|
|
39
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
|
|
40
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.removeTask">removeTask</a></code> | Removes a task from a project. |
|
|
41
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
|
|
42
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.synth">synth</a></code> | Synthesize all project files into `outdir`. |
|
|
43
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
|
|
44
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
|
|
45
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
|
|
46
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
|
|
47
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addBins">addBins</a></code> | *No description.* |
|
|
48
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
|
|
49
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
|
|
50
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addDeps">addDeps</a></code> | Defines normal dependencies. |
|
|
51
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
|
|
52
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
|
|
53
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
|
|
54
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
|
|
55
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
|
|
56
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
|
|
57
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
|
|
58
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
|
59
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
|
|
60
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
|
|
61
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addCdkDependencies">addCdkDependencies</a></code> | Adds dependencies to AWS CDK modules. |
|
|
62
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addCdkTestDependencies">addCdkTestDependencies</a></code> | Adds AWS CDK modules as dev dependencies. |
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
##### `toString` <a name="toString" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.toString"></a>
|
|
67
67
|
|
|
68
68
|
```typescript
|
|
69
69
|
public toString(): string
|
|
@@ -71,7 +71,7 @@ public toString(): string
|
|
|
71
71
|
|
|
72
72
|
Returns a string representation of this construct.
|
|
73
73
|
|
|
74
|
-
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="@nikovirtala/projen-constructs.
|
|
74
|
+
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addExcludeFromCleanup"></a>
|
|
75
75
|
|
|
76
76
|
```typescript
|
|
77
77
|
public addExcludeFromCleanup(globs: ...string[]): void
|
|
@@ -82,7 +82,7 @@ Exclude the matching files from pre-synth cleanup.
|
|
|
82
82
|
Can be used when, for example, some
|
|
83
83
|
source files include the projen marker and we don't want them to be erased during synth.
|
|
84
84
|
|
|
85
|
-
###### `globs`<sup>Required</sup> <a name="globs" id="@nikovirtala/projen-constructs.
|
|
85
|
+
###### `globs`<sup>Required</sup> <a name="globs" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addExcludeFromCleanup.parameter.globs"></a>
|
|
86
86
|
|
|
87
87
|
- *Type:* ...string[]
|
|
88
88
|
|
|
@@ -90,7 +90,7 @@ The glob patterns to match.
|
|
|
90
90
|
|
|
91
91
|
---
|
|
92
92
|
|
|
93
|
-
##### `addGitIgnore` <a name="addGitIgnore" id="@nikovirtala/projen-constructs.
|
|
93
|
+
##### `addGitIgnore` <a name="addGitIgnore" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addGitIgnore"></a>
|
|
94
94
|
|
|
95
95
|
```typescript
|
|
96
96
|
public addGitIgnore(pattern: string): void
|
|
@@ -98,7 +98,7 @@ public addGitIgnore(pattern: string): void
|
|
|
98
98
|
|
|
99
99
|
Adds a .gitignore pattern.
|
|
100
100
|
|
|
101
|
-
###### `pattern`<sup>Required</sup> <a name="pattern" id="@nikovirtala/projen-constructs.
|
|
101
|
+
###### `pattern`<sup>Required</sup> <a name="pattern" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addGitIgnore.parameter.pattern"></a>
|
|
102
102
|
|
|
103
103
|
- *Type:* string
|
|
104
104
|
|
|
@@ -106,7 +106,7 @@ The glob pattern to ignore.
|
|
|
106
106
|
|
|
107
107
|
---
|
|
108
108
|
|
|
109
|
-
##### `addPackageIgnore` <a name="addPackageIgnore" id="@nikovirtala/projen-constructs.
|
|
109
|
+
##### `addPackageIgnore` <a name="addPackageIgnore" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addPackageIgnore"></a>
|
|
110
110
|
|
|
111
111
|
```typescript
|
|
112
112
|
public addPackageIgnore(pattern: string): void
|
|
@@ -114,7 +114,7 @@ public addPackageIgnore(pattern: string): void
|
|
|
114
114
|
|
|
115
115
|
Adds patterns to be ignored by npm.
|
|
116
116
|
|
|
117
|
-
###### `pattern`<sup>Required</sup> <a name="pattern" id="@nikovirtala/projen-constructs.
|
|
117
|
+
###### `pattern`<sup>Required</sup> <a name="pattern" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addPackageIgnore.parameter.pattern"></a>
|
|
118
118
|
|
|
119
119
|
- *Type:* string
|
|
120
120
|
|
|
@@ -122,7 +122,7 @@ The pattern to ignore.
|
|
|
122
122
|
|
|
123
123
|
---
|
|
124
124
|
|
|
125
|
-
##### `addTask` <a name="addTask" id="@nikovirtala/projen-constructs.
|
|
125
|
+
##### `addTask` <a name="addTask" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addTask"></a>
|
|
126
126
|
|
|
127
127
|
```typescript
|
|
128
128
|
public addTask(name: string, props?: TaskOptions): Task
|
|
@@ -133,7 +133,7 @@ Adds a new task to this project.
|
|
|
133
133
|
This will fail if the project already has
|
|
134
134
|
a task with this name.
|
|
135
135
|
|
|
136
|
-
###### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.
|
|
136
|
+
###### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addTask.parameter.name"></a>
|
|
137
137
|
|
|
138
138
|
- *Type:* string
|
|
139
139
|
|
|
@@ -141,7 +141,7 @@ The task name to add.
|
|
|
141
141
|
|
|
142
142
|
---
|
|
143
143
|
|
|
144
|
-
###### `props`<sup>Optional</sup> <a name="props" id="@nikovirtala/projen-constructs.
|
|
144
|
+
###### `props`<sup>Optional</sup> <a name="props" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addTask.parameter.props"></a>
|
|
145
145
|
|
|
146
146
|
- *Type:* projen.TaskOptions
|
|
147
147
|
|
|
@@ -149,7 +149,7 @@ Task properties.
|
|
|
149
149
|
|
|
150
150
|
---
|
|
151
151
|
|
|
152
|
-
##### ~~`addTip`~~ <a name="addTip" id="@nikovirtala/projen-constructs.
|
|
152
|
+
##### ~~`addTip`~~ <a name="addTip" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addTip"></a>
|
|
153
153
|
|
|
154
154
|
```typescript
|
|
155
155
|
public addTip(message: string): void
|
|
@@ -157,7 +157,7 @@ public addTip(message: string): void
|
|
|
157
157
|
|
|
158
158
|
Prints a "tip" message during synthesis.
|
|
159
159
|
|
|
160
|
-
###### `message`<sup>Required</sup> <a name="message" id="@nikovirtala/projen-constructs.
|
|
160
|
+
###### `message`<sup>Required</sup> <a name="message" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addTip.parameter.message"></a>
|
|
161
161
|
|
|
162
162
|
- *Type:* string
|
|
163
163
|
|
|
@@ -165,7 +165,7 @@ The message.
|
|
|
165
165
|
|
|
166
166
|
---
|
|
167
167
|
|
|
168
|
-
##### `annotateGenerated` <a name="annotateGenerated" id="@nikovirtala/projen-constructs.
|
|
168
|
+
##### `annotateGenerated` <a name="annotateGenerated" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.annotateGenerated"></a>
|
|
169
169
|
|
|
170
170
|
```typescript
|
|
171
171
|
public annotateGenerated(glob: string): void
|
|
@@ -179,7 +179,7 @@ repository statistics and language breakdown.
|
|
|
179
179
|
|
|
180
180
|
> [https://github.com/github/linguist/blob/master/docs/overrides.md](https://github.com/github/linguist/blob/master/docs/overrides.md)
|
|
181
181
|
|
|
182
|
-
###### `glob`<sup>Required</sup> <a name="glob" id="@nikovirtala/projen-constructs.
|
|
182
|
+
###### `glob`<sup>Required</sup> <a name="glob" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.annotateGenerated.parameter.glob"></a>
|
|
183
183
|
|
|
184
184
|
- *Type:* string
|
|
185
185
|
|
|
@@ -187,7 +187,7 @@ the glob pattern to match (could be a file path).
|
|
|
187
187
|
|
|
188
188
|
---
|
|
189
189
|
|
|
190
|
-
##### `postSynthesize` <a name="postSynthesize" id="@nikovirtala/projen-constructs.
|
|
190
|
+
##### `postSynthesize` <a name="postSynthesize" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.postSynthesize"></a>
|
|
191
191
|
|
|
192
192
|
```typescript
|
|
193
193
|
public postSynthesize(): void
|
|
@@ -197,7 +197,7 @@ Called after all components are synthesized.
|
|
|
197
197
|
|
|
198
198
|
Order is *not* guaranteed.
|
|
199
199
|
|
|
200
|
-
##### `preSynthesize` <a name="preSynthesize" id="@nikovirtala/projen-constructs.
|
|
200
|
+
##### `preSynthesize` <a name="preSynthesize" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.preSynthesize"></a>
|
|
201
201
|
|
|
202
202
|
```typescript
|
|
203
203
|
public preSynthesize(): void
|
|
@@ -205,7 +205,7 @@ public preSynthesize(): void
|
|
|
205
205
|
|
|
206
206
|
Called before all components are synthesized.
|
|
207
207
|
|
|
208
|
-
##### `removeTask` <a name="removeTask" id="@nikovirtala/projen-constructs.
|
|
208
|
+
##### `removeTask` <a name="removeTask" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.removeTask"></a>
|
|
209
209
|
|
|
210
210
|
```typescript
|
|
211
211
|
public removeTask(name: string): Task
|
|
@@ -213,7 +213,7 @@ public removeTask(name: string): Task
|
|
|
213
213
|
|
|
214
214
|
Removes a task from a project.
|
|
215
215
|
|
|
216
|
-
###### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.
|
|
216
|
+
###### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.removeTask.parameter.name"></a>
|
|
217
217
|
|
|
218
218
|
- *Type:* string
|
|
219
219
|
|
|
@@ -221,7 +221,7 @@ The name of the task to remove.
|
|
|
221
221
|
|
|
222
222
|
---
|
|
223
223
|
|
|
224
|
-
##### `runTaskCommand` <a name="runTaskCommand" id="@nikovirtala/projen-constructs.
|
|
224
|
+
##### `runTaskCommand` <a name="runTaskCommand" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.runTaskCommand"></a>
|
|
225
225
|
|
|
226
226
|
```typescript
|
|
227
227
|
public runTaskCommand(task: Task): string
|
|
@@ -232,7 +232,7 @@ Returns the shell command to execute in order to run a task.
|
|
|
232
232
|
This will
|
|
233
233
|
typically be `npx projen TASK`.
|
|
234
234
|
|
|
235
|
-
###### `task`<sup>Required</sup> <a name="task" id="@nikovirtala/projen-constructs.
|
|
235
|
+
###### `task`<sup>Required</sup> <a name="task" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.runTaskCommand.parameter.task"></a>
|
|
236
236
|
|
|
237
237
|
- *Type:* projen.Task
|
|
238
238
|
|
|
@@ -240,7 +240,7 @@ The task for which the command is required.
|
|
|
240
240
|
|
|
241
241
|
---
|
|
242
242
|
|
|
243
|
-
##### `synth` <a name="synth" id="@nikovirtala/projen-constructs.
|
|
243
|
+
##### `synth` <a name="synth" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.synth"></a>
|
|
244
244
|
|
|
245
245
|
```typescript
|
|
246
246
|
public synth(): void
|
|
@@ -255,7 +255,7 @@ Synthesize all project files into `outdir`.
|
|
|
255
255
|
5. Call "postSynthesize()" for all components of this project
|
|
256
256
|
6. Call "this.postSynthesize()"
|
|
257
257
|
|
|
258
|
-
##### `tryFindFile` <a name="tryFindFile" id="@nikovirtala/projen-constructs.
|
|
258
|
+
##### `tryFindFile` <a name="tryFindFile" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.tryFindFile"></a>
|
|
259
259
|
|
|
260
260
|
```typescript
|
|
261
261
|
public tryFindFile(filePath: string): FileBase
|
|
@@ -263,7 +263,7 @@ public tryFindFile(filePath: string): FileBase
|
|
|
263
263
|
|
|
264
264
|
Finds a file at the specified relative path within this project and all its subprojects.
|
|
265
265
|
|
|
266
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="@nikovirtala/projen-constructs.
|
|
266
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.tryFindFile.parameter.filePath"></a>
|
|
267
267
|
|
|
268
268
|
- *Type:* string
|
|
269
269
|
|
|
@@ -274,7 +274,7 @@ from the root of _this_ project.
|
|
|
274
274
|
|
|
275
275
|
---
|
|
276
276
|
|
|
277
|
-
##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@nikovirtala/projen-constructs.
|
|
277
|
+
##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.tryFindJsonFile"></a>
|
|
278
278
|
|
|
279
279
|
```typescript
|
|
280
280
|
public tryFindJsonFile(filePath: string): JsonFile
|
|
@@ -282,7 +282,7 @@ public tryFindJsonFile(filePath: string): JsonFile
|
|
|
282
282
|
|
|
283
283
|
Finds a json file by name.
|
|
284
284
|
|
|
285
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="@nikovirtala/projen-constructs.
|
|
285
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.tryFindJsonFile.parameter.filePath"></a>
|
|
286
286
|
|
|
287
287
|
- *Type:* string
|
|
288
288
|
|
|
@@ -290,7 +290,7 @@ The file path.
|
|
|
290
290
|
|
|
291
291
|
---
|
|
292
292
|
|
|
293
|
-
##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@nikovirtala/projen-constructs.
|
|
293
|
+
##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.tryFindObjectFile"></a>
|
|
294
294
|
|
|
295
295
|
```typescript
|
|
296
296
|
public tryFindObjectFile(filePath: string): ObjectFile
|
|
@@ -298,7 +298,7 @@ public tryFindObjectFile(filePath: string): ObjectFile
|
|
|
298
298
|
|
|
299
299
|
Finds an object file (like JsonFile, YamlFile, etc.) by name.
|
|
300
300
|
|
|
301
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="@nikovirtala/projen-constructs.
|
|
301
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.tryFindObjectFile.parameter.filePath"></a>
|
|
302
302
|
|
|
303
303
|
- *Type:* string
|
|
304
304
|
|
|
@@ -306,7 +306,7 @@ The file path.
|
|
|
306
306
|
|
|
307
307
|
---
|
|
308
308
|
|
|
309
|
-
##### `tryRemoveFile` <a name="tryRemoveFile" id="@nikovirtala/projen-constructs.
|
|
309
|
+
##### `tryRemoveFile` <a name="tryRemoveFile" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.tryRemoveFile"></a>
|
|
310
310
|
|
|
311
311
|
```typescript
|
|
312
312
|
public tryRemoveFile(filePath: string): FileBase
|
|
@@ -314,7 +314,7 @@ public tryRemoveFile(filePath: string): FileBase
|
|
|
314
314
|
|
|
315
315
|
Finds a file at the specified relative path within this project and removes it.
|
|
316
316
|
|
|
317
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="@nikovirtala/projen-constructs.
|
|
317
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.tryRemoveFile.parameter.filePath"></a>
|
|
318
318
|
|
|
319
319
|
- *Type:* string
|
|
320
320
|
|
|
@@ -325,19 +325,19 @@ resolved from the root of _this_ project.
|
|
|
325
325
|
|
|
326
326
|
---
|
|
327
327
|
|
|
328
|
-
##### `addBins` <a name="addBins" id="@nikovirtala/projen-constructs.
|
|
328
|
+
##### `addBins` <a name="addBins" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addBins"></a>
|
|
329
329
|
|
|
330
330
|
```typescript
|
|
331
331
|
public addBins(bins: {[ key: string ]: string}): void
|
|
332
332
|
```
|
|
333
333
|
|
|
334
|
-
###### `bins`<sup>Required</sup> <a name="bins" id="@nikovirtala/projen-constructs.
|
|
334
|
+
###### `bins`<sup>Required</sup> <a name="bins" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addBins.parameter.bins"></a>
|
|
335
335
|
|
|
336
336
|
- *Type:* {[ key: string ]: string}
|
|
337
337
|
|
|
338
338
|
---
|
|
339
339
|
|
|
340
|
-
##### `addBundledDeps` <a name="addBundledDeps" id="@nikovirtala/projen-constructs.
|
|
340
|
+
##### `addBundledDeps` <a name="addBundledDeps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addBundledDeps"></a>
|
|
341
341
|
|
|
342
342
|
```typescript
|
|
343
343
|
public addBundledDeps(deps: ...string[]): void
|
|
@@ -348,7 +348,7 @@ Defines bundled dependencies.
|
|
|
348
348
|
Bundled dependencies will be added as normal dependencies as well as to the
|
|
349
349
|
`bundledDependencies` section of your `package.json`.
|
|
350
350
|
|
|
351
|
-
###### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.
|
|
351
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addBundledDeps.parameter.deps"></a>
|
|
352
352
|
|
|
353
353
|
- *Type:* ...string[]
|
|
354
354
|
|
|
@@ -362,7 +362,7 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
362
362
|
|
|
363
363
|
---
|
|
364
364
|
|
|
365
|
-
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@nikovirtala/projen-constructs.
|
|
365
|
+
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addCompileCommand"></a>
|
|
366
366
|
|
|
367
367
|
```typescript
|
|
368
368
|
public addCompileCommand(commands: ...string[]): void
|
|
@@ -370,13 +370,13 @@ public addCompileCommand(commands: ...string[]): void
|
|
|
370
370
|
|
|
371
371
|
DEPRECATED.
|
|
372
372
|
|
|
373
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="@nikovirtala/projen-constructs.
|
|
373
|
+
###### `commands`<sup>Required</sup> <a name="commands" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addCompileCommand.parameter.commands"></a>
|
|
374
374
|
|
|
375
375
|
- *Type:* ...string[]
|
|
376
376
|
|
|
377
377
|
---
|
|
378
378
|
|
|
379
|
-
##### `addDeps` <a name="addDeps" id="@nikovirtala/projen-constructs.
|
|
379
|
+
##### `addDeps` <a name="addDeps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addDeps"></a>
|
|
380
380
|
|
|
381
381
|
```typescript
|
|
382
382
|
public addDeps(deps: ...string[]): void
|
|
@@ -384,7 +384,7 @@ public addDeps(deps: ...string[]): void
|
|
|
384
384
|
|
|
385
385
|
Defines normal dependencies.
|
|
386
386
|
|
|
387
|
-
###### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.
|
|
387
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addDeps.parameter.deps"></a>
|
|
388
388
|
|
|
389
389
|
- *Type:* ...string[]
|
|
390
390
|
|
|
@@ -398,7 +398,7 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
398
398
|
|
|
399
399
|
---
|
|
400
400
|
|
|
401
|
-
##### `addDevDeps` <a name="addDevDeps" id="@nikovirtala/projen-constructs.
|
|
401
|
+
##### `addDevDeps` <a name="addDevDeps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addDevDeps"></a>
|
|
402
402
|
|
|
403
403
|
```typescript
|
|
404
404
|
public addDevDeps(deps: ...string[]): void
|
|
@@ -406,7 +406,7 @@ public addDevDeps(deps: ...string[]): void
|
|
|
406
406
|
|
|
407
407
|
Defines development/test dependencies.
|
|
408
408
|
|
|
409
|
-
###### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.
|
|
409
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addDevDeps.parameter.deps"></a>
|
|
410
410
|
|
|
411
411
|
- *Type:* ...string[]
|
|
412
412
|
|
|
@@ -420,7 +420,7 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
420
420
|
|
|
421
421
|
---
|
|
422
422
|
|
|
423
|
-
##### `addFields` <a name="addFields" id="@nikovirtala/projen-constructs.
|
|
423
|
+
##### `addFields` <a name="addFields" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addFields"></a>
|
|
424
424
|
|
|
425
425
|
```typescript
|
|
426
426
|
public addFields(fields: {[ key: string ]: any}): void
|
|
@@ -428,7 +428,7 @@ public addFields(fields: {[ key: string ]: any}): void
|
|
|
428
428
|
|
|
429
429
|
Directly set fields in `package.json`.
|
|
430
430
|
|
|
431
|
-
###### `fields`<sup>Required</sup> <a name="fields" id="@nikovirtala/projen-constructs.
|
|
431
|
+
###### `fields`<sup>Required</sup> <a name="fields" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addFields.parameter.fields"></a>
|
|
432
432
|
|
|
433
433
|
- *Type:* {[ key: string ]: any}
|
|
434
434
|
|
|
@@ -436,7 +436,7 @@ The fields to set.
|
|
|
436
436
|
|
|
437
437
|
---
|
|
438
438
|
|
|
439
|
-
##### `addKeywords` <a name="addKeywords" id="@nikovirtala/projen-constructs.
|
|
439
|
+
##### `addKeywords` <a name="addKeywords" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addKeywords"></a>
|
|
440
440
|
|
|
441
441
|
```typescript
|
|
442
442
|
public addKeywords(keywords: ...string[]): void
|
|
@@ -444,7 +444,7 @@ public addKeywords(keywords: ...string[]): void
|
|
|
444
444
|
|
|
445
445
|
Adds keywords to package.json (deduplicated).
|
|
446
446
|
|
|
447
|
-
###### `keywords`<sup>Required</sup> <a name="keywords" id="@nikovirtala/projen-constructs.
|
|
447
|
+
###### `keywords`<sup>Required</sup> <a name="keywords" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addKeywords.parameter.keywords"></a>
|
|
448
448
|
|
|
449
449
|
- *Type:* ...string[]
|
|
450
450
|
|
|
@@ -452,7 +452,7 @@ The keywords to add.
|
|
|
452
452
|
|
|
453
453
|
---
|
|
454
454
|
|
|
455
|
-
##### `addPeerDeps` <a name="addPeerDeps" id="@nikovirtala/projen-constructs.
|
|
455
|
+
##### `addPeerDeps` <a name="addPeerDeps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addPeerDeps"></a>
|
|
456
456
|
|
|
457
457
|
```typescript
|
|
458
458
|
public addPeerDeps(deps: ...string[]): void
|
|
@@ -464,7 +464,7 @@ When adding peer dependencies, a devDependency will also be added on the
|
|
|
464
464
|
pinned version of the declared peer. This will ensure that you are testing
|
|
465
465
|
your code against the minimum version required from your consumers.
|
|
466
466
|
|
|
467
|
-
###### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.
|
|
467
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addPeerDeps.parameter.deps"></a>
|
|
468
468
|
|
|
469
469
|
- *Type:* ...string[]
|
|
470
470
|
|
|
@@ -478,7 +478,7 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
478
478
|
|
|
479
479
|
---
|
|
480
480
|
|
|
481
|
-
##### `addScripts` <a name="addScripts" id="@nikovirtala/projen-constructs.
|
|
481
|
+
##### `addScripts` <a name="addScripts" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addScripts"></a>
|
|
482
482
|
|
|
483
483
|
```typescript
|
|
484
484
|
public addScripts(scripts: {[ key: string ]: string}): void
|
|
@@ -486,7 +486,7 @@ public addScripts(scripts: {[ key: string ]: string}): void
|
|
|
486
486
|
|
|
487
487
|
Replaces the contents of multiple npm package.json scripts.
|
|
488
488
|
|
|
489
|
-
###### `scripts`<sup>Required</sup> <a name="scripts" id="@nikovirtala/projen-constructs.
|
|
489
|
+
###### `scripts`<sup>Required</sup> <a name="scripts" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addScripts.parameter.scripts"></a>
|
|
490
490
|
|
|
491
491
|
- *Type:* {[ key: string ]: string}
|
|
492
492
|
|
|
@@ -494,7 +494,7 @@ The scripts to set.
|
|
|
494
494
|
|
|
495
495
|
---
|
|
496
496
|
|
|
497
|
-
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@nikovirtala/projen-constructs.
|
|
497
|
+
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addTestCommand"></a>
|
|
498
498
|
|
|
499
499
|
```typescript
|
|
500
500
|
public addTestCommand(commands: ...string[]): void
|
|
@@ -502,13 +502,13 @@ public addTestCommand(commands: ...string[]): void
|
|
|
502
502
|
|
|
503
503
|
DEPRECATED.
|
|
504
504
|
|
|
505
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="@nikovirtala/projen-constructs.
|
|
505
|
+
###### `commands`<sup>Required</sup> <a name="commands" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addTestCommand.parameter.commands"></a>
|
|
506
506
|
|
|
507
507
|
- *Type:* ...string[]
|
|
508
508
|
|
|
509
509
|
---
|
|
510
510
|
|
|
511
|
-
##### ~~`hasScript`~~ <a name="hasScript" id="@nikovirtala/projen-constructs.
|
|
511
|
+
##### ~~`hasScript`~~ <a name="hasScript" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.hasScript"></a>
|
|
512
512
|
|
|
513
513
|
```typescript
|
|
514
514
|
public hasScript(name: string): boolean
|
|
@@ -516,7 +516,7 @@ public hasScript(name: string): boolean
|
|
|
516
516
|
|
|
517
517
|
Indicates if a script by the name name is defined.
|
|
518
518
|
|
|
519
|
-
###### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.
|
|
519
|
+
###### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.hasScript.parameter.name"></a>
|
|
520
520
|
|
|
521
521
|
- *Type:* string
|
|
522
522
|
|
|
@@ -524,7 +524,7 @@ The name of the script.
|
|
|
524
524
|
|
|
525
525
|
---
|
|
526
526
|
|
|
527
|
-
##### `removeScript` <a name="removeScript" id="@nikovirtala/projen-constructs.
|
|
527
|
+
##### `removeScript` <a name="removeScript" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.removeScript"></a>
|
|
528
528
|
|
|
529
529
|
```typescript
|
|
530
530
|
public removeScript(name: string): void
|
|
@@ -532,7 +532,7 @@ public removeScript(name: string): void
|
|
|
532
532
|
|
|
533
533
|
Removes the npm script (always successful).
|
|
534
534
|
|
|
535
|
-
###### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.
|
|
535
|
+
###### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.removeScript.parameter.name"></a>
|
|
536
536
|
|
|
537
537
|
- *Type:* string
|
|
538
538
|
|
|
@@ -540,7 +540,7 @@ The name of the script.
|
|
|
540
540
|
|
|
541
541
|
---
|
|
542
542
|
|
|
543
|
-
##### `renderWorkflowSetup` <a name="renderWorkflowSetup" id="@nikovirtala/projen-constructs.
|
|
543
|
+
##### `renderWorkflowSetup` <a name="renderWorkflowSetup" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.renderWorkflowSetup"></a>
|
|
544
544
|
|
|
545
545
|
```typescript
|
|
546
546
|
public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]
|
|
@@ -548,7 +548,7 @@ public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]
|
|
|
548
548
|
|
|
549
549
|
Returns the set of workflow steps which should be executed to bootstrap a workflow.
|
|
550
550
|
|
|
551
|
-
###### `options`<sup>Optional</sup> <a name="options" id="@nikovirtala/projen-constructs.
|
|
551
|
+
###### `options`<sup>Optional</sup> <a name="options" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.renderWorkflowSetup.parameter.options"></a>
|
|
552
552
|
|
|
553
553
|
- *Type:* projen.javascript.RenderWorkflowSetupOptions
|
|
554
554
|
|
|
@@ -556,7 +556,7 @@ Options.
|
|
|
556
556
|
|
|
557
557
|
---
|
|
558
558
|
|
|
559
|
-
##### `setScript` <a name="setScript" id="@nikovirtala/projen-constructs.
|
|
559
|
+
##### `setScript` <a name="setScript" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.setScript"></a>
|
|
560
560
|
|
|
561
561
|
```typescript
|
|
562
562
|
public setScript(name: string, command: string): void
|
|
@@ -564,7 +564,7 @@ public setScript(name: string, command: string): void
|
|
|
564
564
|
|
|
565
565
|
Replaces the contents of an npm package.json script.
|
|
566
566
|
|
|
567
|
-
###### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.
|
|
567
|
+
###### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.setScript.parameter.name"></a>
|
|
568
568
|
|
|
569
569
|
- *Type:* string
|
|
570
570
|
|
|
@@ -572,7 +572,7 @@ The script name.
|
|
|
572
572
|
|
|
573
573
|
---
|
|
574
574
|
|
|
575
|
-
###### `command`<sup>Required</sup> <a name="command" id="@nikovirtala/projen-constructs.
|
|
575
|
+
###### `command`<sup>Required</sup> <a name="command" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.setScript.parameter.command"></a>
|
|
576
576
|
|
|
577
577
|
- *Type:* string
|
|
578
578
|
|
|
@@ -580,7 +580,7 @@ The command to execute.
|
|
|
580
580
|
|
|
581
581
|
---
|
|
582
582
|
|
|
583
|
-
##### ~~`addCdkDependencies`~~ <a name="addCdkDependencies" id="@nikovirtala/projen-constructs.
|
|
583
|
+
##### ~~`addCdkDependencies`~~ <a name="addCdkDependencies" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addCdkDependencies"></a>
|
|
584
584
|
|
|
585
585
|
```typescript
|
|
586
586
|
public addCdkDependencies(deps: ...string[]): void
|
|
@@ -590,7 +590,7 @@ Adds dependencies to AWS CDK modules.
|
|
|
590
590
|
|
|
591
591
|
Since this is a library project, dependencies will be added as peer dependencies.
|
|
592
592
|
|
|
593
|
-
###### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.
|
|
593
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addCdkDependencies.parameter.deps"></a>
|
|
594
594
|
|
|
595
595
|
- *Type:* ...string[]
|
|
596
596
|
|
|
@@ -598,7 +598,7 @@ names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
|
|
|
598
598
|
|
|
599
599
|
---
|
|
600
600
|
|
|
601
|
-
##### ~~`addCdkTestDependencies`~~ <a name="addCdkTestDependencies" id="@nikovirtala/projen-constructs.
|
|
601
|
+
##### ~~`addCdkTestDependencies`~~ <a name="addCdkTestDependencies" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addCdkTestDependencies"></a>
|
|
602
602
|
|
|
603
603
|
```typescript
|
|
604
604
|
public addCdkTestDependencies(deps: ...string[]): void
|
|
@@ -606,7 +606,7 @@ public addCdkTestDependencies(deps: ...string[]): void
|
|
|
606
606
|
|
|
607
607
|
Adds AWS CDK modules as dev dependencies.
|
|
608
608
|
|
|
609
|
-
###### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.
|
|
609
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.addCdkTestDependencies.parameter.deps"></a>
|
|
610
610
|
|
|
611
611
|
- *Type:* ...string[]
|
|
612
612
|
|
|
@@ -618,18 +618,18 @@ names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
|
|
|
618
618
|
|
|
619
619
|
| **Name** | **Description** |
|
|
620
620
|
| --- | --- |
|
|
621
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
622
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
623
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
621
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
622
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.isProject">isProject</a></code> | Test whether the given construct is a project. |
|
|
623
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.of">of</a></code> | Find the closest ancestor project for given construct. |
|
|
624
624
|
|
|
625
625
|
---
|
|
626
626
|
|
|
627
|
-
##### `isConstruct` <a name="isConstruct" id="@nikovirtala/projen-constructs.
|
|
627
|
+
##### `isConstruct` <a name="isConstruct" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.isConstruct"></a>
|
|
628
628
|
|
|
629
629
|
```typescript
|
|
630
|
-
import {
|
|
630
|
+
import { AwsCdkConstructLibraryProject } from '@nikovirtala/projen-constructs'
|
|
631
631
|
|
|
632
|
-
|
|
632
|
+
AwsCdkConstructLibraryProject.isConstruct(x: any)
|
|
633
633
|
```
|
|
634
634
|
|
|
635
635
|
Checks if `x` is a construct.
|
|
@@ -648,7 +648,7 @@ library can be accidentally installed, and `instanceof` will behave
|
|
|
648
648
|
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
649
649
|
this type-testing method instead.
|
|
650
650
|
|
|
651
|
-
###### `x`<sup>Required</sup> <a name="x" id="@nikovirtala/projen-constructs.
|
|
651
|
+
###### `x`<sup>Required</sup> <a name="x" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.isConstruct.parameter.x"></a>
|
|
652
652
|
|
|
653
653
|
- *Type:* any
|
|
654
654
|
|
|
@@ -656,35 +656,35 @@ Any object.
|
|
|
656
656
|
|
|
657
657
|
---
|
|
658
658
|
|
|
659
|
-
##### `isProject` <a name="isProject" id="@nikovirtala/projen-constructs.
|
|
659
|
+
##### `isProject` <a name="isProject" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.isProject"></a>
|
|
660
660
|
|
|
661
661
|
```typescript
|
|
662
|
-
import {
|
|
662
|
+
import { AwsCdkConstructLibraryProject } from '@nikovirtala/projen-constructs'
|
|
663
663
|
|
|
664
|
-
|
|
664
|
+
AwsCdkConstructLibraryProject.isProject(x: any)
|
|
665
665
|
```
|
|
666
666
|
|
|
667
667
|
Test whether the given construct is a project.
|
|
668
668
|
|
|
669
|
-
###### `x`<sup>Required</sup> <a name="x" id="@nikovirtala/projen-constructs.
|
|
669
|
+
###### `x`<sup>Required</sup> <a name="x" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.isProject.parameter.x"></a>
|
|
670
670
|
|
|
671
671
|
- *Type:* any
|
|
672
672
|
|
|
673
673
|
---
|
|
674
674
|
|
|
675
|
-
##### `of` <a name="of" id="@nikovirtala/projen-constructs.
|
|
675
|
+
##### `of` <a name="of" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.of"></a>
|
|
676
676
|
|
|
677
677
|
```typescript
|
|
678
|
-
import {
|
|
678
|
+
import { AwsCdkConstructLibraryProject } from '@nikovirtala/projen-constructs'
|
|
679
679
|
|
|
680
|
-
|
|
680
|
+
AwsCdkConstructLibraryProject.of(construct: IConstruct)
|
|
681
681
|
```
|
|
682
682
|
|
|
683
683
|
Find the closest ancestor project for given construct.
|
|
684
684
|
|
|
685
685
|
When given a project, this it the project itself.
|
|
686
686
|
|
|
687
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="@nikovirtala/projen-constructs.
|
|
687
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.of.parameter.construct"></a>
|
|
688
688
|
|
|
689
689
|
- *Type:* constructs.IConstruct
|
|
690
690
|
|
|
@@ -694,76 +694,76 @@ When given a project, this it the project itself.
|
|
|
694
694
|
|
|
695
695
|
| **Name** | **Type** | **Description** |
|
|
696
696
|
| --- | --- | --- |
|
|
697
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
698
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
699
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
700
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
701
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
702
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
703
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
704
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
705
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
706
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
707
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
708
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
709
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
710
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
711
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
712
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
713
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
714
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
715
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
716
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
717
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
718
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
719
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
720
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
721
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
722
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
723
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
724
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
725
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
726
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
727
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
728
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
729
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
730
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
731
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
732
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
733
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
734
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
735
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
736
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
737
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
738
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
739
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
740
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
741
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
742
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
743
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
744
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
745
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
746
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
747
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
748
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
749
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
750
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
751
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
752
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
753
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
754
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
755
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
756
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
757
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
758
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
759
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
760
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
761
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
762
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
763
|
-
|
|
764
|
-
---
|
|
765
|
-
|
|
766
|
-
##### `node`<sup>Required</sup> <a name="node" id="@nikovirtala/projen-constructs.
|
|
697
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
698
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.buildTask">buildTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
699
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
700
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.compileTask">compileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
701
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.components">components</a></code> | <code>projen.Component[]</code> | Returns all the components within this project. |
|
|
702
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.deps">deps</a></code> | <code>projen.Dependencies</code> | Project dependencies. |
|
|
703
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.ejected">ejected</a></code> | <code>boolean</code> | Whether or not the project is being ejected. |
|
|
704
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.files">files</a></code> | <code>projen.FileBase[]</code> | All files in this project. |
|
|
705
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.gitattributes">gitattributes</a></code> | <code>projen.GitAttributesFile</code> | The .gitattributes file for this repository. |
|
|
706
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.gitignore">gitignore</a></code> | <code>projen.IgnoreFile</code> | .gitignore. |
|
|
707
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.logger">logger</a></code> | <code>projen.Logger</code> | Logging utilities. |
|
|
708
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.name">name</a></code> | <code>string</code> | Project name. |
|
|
709
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.outdir">outdir</a></code> | <code>string</code> | Absolute output directory of this project. |
|
|
710
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.packageTask">packageTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
711
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.postCompileTask">postCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
712
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.preCompileTask">preCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
713
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
|
|
714
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.projenCommand">projenCommand</a></code> | <code>string</code> | The command to use in order to run the projen CLI. |
|
|
715
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
|
|
716
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.subprojects">subprojects</a></code> | <code>projen.Project[]</code> | Returns all the subprojects within this project. |
|
|
717
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
|
|
718
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
719
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
720
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
|
|
721
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
|
|
722
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
|
|
723
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
|
|
724
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
|
|
725
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
|
|
726
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
|
|
727
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
|
|
728
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
|
|
729
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
|
|
730
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
|
|
731
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
|
|
732
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
|
|
733
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
|
|
734
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
|
|
735
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
|
|
736
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
|
|
737
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.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). |
|
|
738
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
|
|
739
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
|
|
740
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
|
|
741
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
|
|
742
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
|
|
743
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version supported by this package. |
|
|
744
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
745
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
746
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
747
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
748
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
|
|
749
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
750
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
751
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
752
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
753
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
754
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
755
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.watchTask">watchTask</a></code> | <code>projen.Task</code> | The "watch" task. |
|
|
756
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.docgen">docgen</a></code> | <code>boolean</code> | *No description.* |
|
|
757
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.eslint">eslint</a></code> | <code>projen.javascript.Eslint</code> | *No description.* |
|
|
758
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
|
|
759
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.tsconfigEslint">tsconfigEslint</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
|
|
760
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.cdkDeps">cdkDeps</a></code> | <code>projen.awscdk.AwsCdkDeps</code> | *No description.* |
|
|
761
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | The target CDK version for this library. |
|
|
762
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.version">version</a></code> | <code>string</code> | *No description.* |
|
|
763
|
+
|
|
764
|
+
---
|
|
765
|
+
|
|
766
|
+
##### `node`<sup>Required</sup> <a name="node" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.node"></a>
|
|
767
767
|
|
|
768
768
|
```typescript
|
|
769
769
|
public readonly node: Node;
|
|
@@ -775,7 +775,7 @@ The tree node.
|
|
|
775
775
|
|
|
776
776
|
---
|
|
777
777
|
|
|
778
|
-
##### `buildTask`<sup>Required</sup> <a name="buildTask" id="@nikovirtala/projen-constructs.
|
|
778
|
+
##### `buildTask`<sup>Required</sup> <a name="buildTask" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.buildTask"></a>
|
|
779
779
|
|
|
780
780
|
```typescript
|
|
781
781
|
public readonly buildTask: Task;
|
|
@@ -785,7 +785,7 @@ public readonly buildTask: Task;
|
|
|
785
785
|
|
|
786
786
|
---
|
|
787
787
|
|
|
788
|
-
##### `commitGenerated`<sup>Required</sup> <a name="commitGenerated" id="@nikovirtala/projen-constructs.
|
|
788
|
+
##### `commitGenerated`<sup>Required</sup> <a name="commitGenerated" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.commitGenerated"></a>
|
|
789
789
|
|
|
790
790
|
```typescript
|
|
791
791
|
public readonly commitGenerated: boolean;
|
|
@@ -797,7 +797,7 @@ Whether to commit the managed files by default.
|
|
|
797
797
|
|
|
798
798
|
---
|
|
799
799
|
|
|
800
|
-
##### `compileTask`<sup>Required</sup> <a name="compileTask" id="@nikovirtala/projen-constructs.
|
|
800
|
+
##### `compileTask`<sup>Required</sup> <a name="compileTask" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.compileTask"></a>
|
|
801
801
|
|
|
802
802
|
```typescript
|
|
803
803
|
public readonly compileTask: Task;
|
|
@@ -807,7 +807,7 @@ public readonly compileTask: Task;
|
|
|
807
807
|
|
|
808
808
|
---
|
|
809
809
|
|
|
810
|
-
##### `components`<sup>Required</sup> <a name="components" id="@nikovirtala/projen-constructs.
|
|
810
|
+
##### `components`<sup>Required</sup> <a name="components" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.components"></a>
|
|
811
811
|
|
|
812
812
|
```typescript
|
|
813
813
|
public readonly components: Component[];
|
|
@@ -819,7 +819,7 @@ Returns all the components within this project.
|
|
|
819
819
|
|
|
820
820
|
---
|
|
821
821
|
|
|
822
|
-
##### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.
|
|
822
|
+
##### `deps`<sup>Required</sup> <a name="deps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.deps"></a>
|
|
823
823
|
|
|
824
824
|
```typescript
|
|
825
825
|
public readonly deps: Dependencies;
|
|
@@ -831,7 +831,7 @@ Project dependencies.
|
|
|
831
831
|
|
|
832
832
|
---
|
|
833
833
|
|
|
834
|
-
##### `ejected`<sup>Required</sup> <a name="ejected" id="@nikovirtala/projen-constructs.
|
|
834
|
+
##### `ejected`<sup>Required</sup> <a name="ejected" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.ejected"></a>
|
|
835
835
|
|
|
836
836
|
```typescript
|
|
837
837
|
public readonly ejected: boolean;
|
|
@@ -843,7 +843,7 @@ Whether or not the project is being ejected.
|
|
|
843
843
|
|
|
844
844
|
---
|
|
845
845
|
|
|
846
|
-
##### `files`<sup>Required</sup> <a name="files" id="@nikovirtala/projen-constructs.
|
|
846
|
+
##### `files`<sup>Required</sup> <a name="files" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.files"></a>
|
|
847
847
|
|
|
848
848
|
```typescript
|
|
849
849
|
public readonly files: FileBase[];
|
|
@@ -855,7 +855,7 @@ All files in this project.
|
|
|
855
855
|
|
|
856
856
|
---
|
|
857
857
|
|
|
858
|
-
##### `gitattributes`<sup>Required</sup> <a name="gitattributes" id="@nikovirtala/projen-constructs.
|
|
858
|
+
##### `gitattributes`<sup>Required</sup> <a name="gitattributes" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.gitattributes"></a>
|
|
859
859
|
|
|
860
860
|
```typescript
|
|
861
861
|
public readonly gitattributes: GitAttributesFile;
|
|
@@ -867,7 +867,7 @@ The .gitattributes file for this repository.
|
|
|
867
867
|
|
|
868
868
|
---
|
|
869
869
|
|
|
870
|
-
##### `gitignore`<sup>Required</sup> <a name="gitignore" id="@nikovirtala/projen-constructs.
|
|
870
|
+
##### `gitignore`<sup>Required</sup> <a name="gitignore" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.gitignore"></a>
|
|
871
871
|
|
|
872
872
|
```typescript
|
|
873
873
|
public readonly gitignore: IgnoreFile;
|
|
@@ -879,7 +879,7 @@ public readonly gitignore: IgnoreFile;
|
|
|
879
879
|
|
|
880
880
|
---
|
|
881
881
|
|
|
882
|
-
##### `logger`<sup>Required</sup> <a name="logger" id="@nikovirtala/projen-constructs.
|
|
882
|
+
##### `logger`<sup>Required</sup> <a name="logger" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.logger"></a>
|
|
883
883
|
|
|
884
884
|
```typescript
|
|
885
885
|
public readonly logger: Logger;
|
|
@@ -891,7 +891,7 @@ Logging utilities.
|
|
|
891
891
|
|
|
892
892
|
---
|
|
893
893
|
|
|
894
|
-
##### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.
|
|
894
|
+
##### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.name"></a>
|
|
895
895
|
|
|
896
896
|
```typescript
|
|
897
897
|
public readonly name: string;
|
|
@@ -903,7 +903,7 @@ Project name.
|
|
|
903
903
|
|
|
904
904
|
---
|
|
905
905
|
|
|
906
|
-
##### `outdir`<sup>Required</sup> <a name="outdir" id="@nikovirtala/projen-constructs.
|
|
906
|
+
##### `outdir`<sup>Required</sup> <a name="outdir" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.outdir"></a>
|
|
907
907
|
|
|
908
908
|
```typescript
|
|
909
909
|
public readonly outdir: string;
|
|
@@ -915,7 +915,7 @@ Absolute output directory of this project.
|
|
|
915
915
|
|
|
916
916
|
---
|
|
917
917
|
|
|
918
|
-
##### `packageTask`<sup>Required</sup> <a name="packageTask" id="@nikovirtala/projen-constructs.
|
|
918
|
+
##### `packageTask`<sup>Required</sup> <a name="packageTask" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.packageTask"></a>
|
|
919
919
|
|
|
920
920
|
```typescript
|
|
921
921
|
public readonly packageTask: Task;
|
|
@@ -925,7 +925,7 @@ public readonly packageTask: Task;
|
|
|
925
925
|
|
|
926
926
|
---
|
|
927
927
|
|
|
928
|
-
##### `postCompileTask`<sup>Required</sup> <a name="postCompileTask" id="@nikovirtala/projen-constructs.
|
|
928
|
+
##### `postCompileTask`<sup>Required</sup> <a name="postCompileTask" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.postCompileTask"></a>
|
|
929
929
|
|
|
930
930
|
```typescript
|
|
931
931
|
public readonly postCompileTask: Task;
|
|
@@ -935,7 +935,7 @@ public readonly postCompileTask: Task;
|
|
|
935
935
|
|
|
936
936
|
---
|
|
937
937
|
|
|
938
|
-
##### `preCompileTask`<sup>Required</sup> <a name="preCompileTask" id="@nikovirtala/projen-constructs.
|
|
938
|
+
##### `preCompileTask`<sup>Required</sup> <a name="preCompileTask" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.preCompileTask"></a>
|
|
939
939
|
|
|
940
940
|
```typescript
|
|
941
941
|
public readonly preCompileTask: Task;
|
|
@@ -945,7 +945,7 @@ public readonly preCompileTask: Task;
|
|
|
945
945
|
|
|
946
946
|
---
|
|
947
947
|
|
|
948
|
-
##### `projectBuild`<sup>Required</sup> <a name="projectBuild" id="@nikovirtala/projen-constructs.
|
|
948
|
+
##### `projectBuild`<sup>Required</sup> <a name="projectBuild" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.projectBuild"></a>
|
|
949
949
|
|
|
950
950
|
```typescript
|
|
951
951
|
public readonly projectBuild: ProjectBuild;
|
|
@@ -957,7 +957,7 @@ Manages the build process of the project.
|
|
|
957
957
|
|
|
958
958
|
---
|
|
959
959
|
|
|
960
|
-
##### `projenCommand`<sup>Required</sup> <a name="projenCommand" id="@nikovirtala/projen-constructs.
|
|
960
|
+
##### `projenCommand`<sup>Required</sup> <a name="projenCommand" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.projenCommand"></a>
|
|
961
961
|
|
|
962
962
|
```typescript
|
|
963
963
|
public readonly projenCommand: string;
|
|
@@ -969,7 +969,7 @@ The command to use in order to run the projen CLI.
|
|
|
969
969
|
|
|
970
970
|
---
|
|
971
971
|
|
|
972
|
-
##### `root`<sup>Required</sup> <a name="root" id="@nikovirtala/projen-constructs.
|
|
972
|
+
##### `root`<sup>Required</sup> <a name="root" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.root"></a>
|
|
973
973
|
|
|
974
974
|
```typescript
|
|
975
975
|
public readonly root: Project;
|
|
@@ -981,7 +981,7 @@ The root project.
|
|
|
981
981
|
|
|
982
982
|
---
|
|
983
983
|
|
|
984
|
-
##### `subprojects`<sup>Required</sup> <a name="subprojects" id="@nikovirtala/projen-constructs.
|
|
984
|
+
##### `subprojects`<sup>Required</sup> <a name="subprojects" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.subprojects"></a>
|
|
985
985
|
|
|
986
986
|
```typescript
|
|
987
987
|
public readonly subprojects: Project[];
|
|
@@ -993,7 +993,7 @@ Returns all the subprojects within this project.
|
|
|
993
993
|
|
|
994
994
|
---
|
|
995
995
|
|
|
996
|
-
##### `tasks`<sup>Required</sup> <a name="tasks" id="@nikovirtala/projen-constructs.
|
|
996
|
+
##### `tasks`<sup>Required</sup> <a name="tasks" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.tasks"></a>
|
|
997
997
|
|
|
998
998
|
```typescript
|
|
999
999
|
public readonly tasks: Tasks;
|
|
@@ -1005,7 +1005,7 @@ Project tasks.
|
|
|
1005
1005
|
|
|
1006
1006
|
---
|
|
1007
1007
|
|
|
1008
|
-
##### `testTask`<sup>Required</sup> <a name="testTask" id="@nikovirtala/projen-constructs.
|
|
1008
|
+
##### `testTask`<sup>Required</sup> <a name="testTask" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.testTask"></a>
|
|
1009
1009
|
|
|
1010
1010
|
```typescript
|
|
1011
1011
|
public readonly testTask: Task;
|
|
@@ -1015,7 +1015,7 @@ public readonly testTask: Task;
|
|
|
1015
1015
|
|
|
1016
1016
|
---
|
|
1017
1017
|
|
|
1018
|
-
##### `defaultTask`<sup>Optional</sup> <a name="defaultTask" id="@nikovirtala/projen-constructs.
|
|
1018
|
+
##### `defaultTask`<sup>Optional</sup> <a name="defaultTask" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.defaultTask"></a>
|
|
1019
1019
|
|
|
1020
1020
|
```typescript
|
|
1021
1021
|
public readonly defaultTask: Task;
|
|
@@ -1030,7 +1030,7 @@ the project is being ejected.
|
|
|
1030
1030
|
|
|
1031
1031
|
---
|
|
1032
1032
|
|
|
1033
|
-
##### `initProject`<sup>Optional</sup> <a name="initProject" id="@nikovirtala/projen-constructs.
|
|
1033
|
+
##### `initProject`<sup>Optional</sup> <a name="initProject" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.initProject"></a>
|
|
1034
1034
|
|
|
1035
1035
|
```typescript
|
|
1036
1036
|
public readonly initProject: InitProject;
|
|
@@ -1046,7 +1046,7 @@ FQN of the project type.
|
|
|
1046
1046
|
|
|
1047
1047
|
---
|
|
1048
1048
|
|
|
1049
|
-
##### `parent`<sup>Optional</sup> <a name="parent" id="@nikovirtala/projen-constructs.
|
|
1049
|
+
##### `parent`<sup>Optional</sup> <a name="parent" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.parent"></a>
|
|
1050
1050
|
|
|
1051
1051
|
```typescript
|
|
1052
1052
|
public readonly parent: Project;
|
|
@@ -1060,7 +1060,7 @@ If undefined, this is the root project.
|
|
|
1060
1060
|
|
|
1061
1061
|
---
|
|
1062
1062
|
|
|
1063
|
-
##### `projectType`<sup>Required</sup> <a name="projectType" id="@nikovirtala/projen-constructs.
|
|
1063
|
+
##### `projectType`<sup>Required</sup> <a name="projectType" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.projectType"></a>
|
|
1064
1064
|
|
|
1065
1065
|
```typescript
|
|
1066
1066
|
public readonly projectType: ProjectType;
|
|
@@ -1070,7 +1070,7 @@ public readonly projectType: ProjectType;
|
|
|
1070
1070
|
|
|
1071
1071
|
---
|
|
1072
1072
|
|
|
1073
|
-
##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@nikovirtala/projen-constructs.
|
|
1073
|
+
##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.autoApprove"></a>
|
|
1074
1074
|
|
|
1075
1075
|
```typescript
|
|
1076
1076
|
public readonly autoApprove: AutoApprove;
|
|
@@ -1082,7 +1082,7 @@ Auto approve set up for this project.
|
|
|
1082
1082
|
|
|
1083
1083
|
---
|
|
1084
1084
|
|
|
1085
|
-
##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@nikovirtala/projen-constructs.
|
|
1085
|
+
##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.devContainer"></a>
|
|
1086
1086
|
|
|
1087
1087
|
```typescript
|
|
1088
1088
|
public readonly devContainer: DevContainer;
|
|
@@ -1096,7 +1096,7 @@ This will be `undefined` if devContainer boolean is false
|
|
|
1096
1096
|
|
|
1097
1097
|
---
|
|
1098
1098
|
|
|
1099
|
-
##### `github`<sup>Optional</sup> <a name="github" id="@nikovirtala/projen-constructs.
|
|
1099
|
+
##### `github`<sup>Optional</sup> <a name="github" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.github"></a>
|
|
1100
1100
|
|
|
1101
1101
|
```typescript
|
|
1102
1102
|
public readonly github: GitHub;
|
|
@@ -1110,7 +1110,7 @@ This will be `undefined` for subprojects.
|
|
|
1110
1110
|
|
|
1111
1111
|
---
|
|
1112
1112
|
|
|
1113
|
-
##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@nikovirtala/projen-constructs.
|
|
1113
|
+
##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.gitpod"></a>
|
|
1114
1114
|
|
|
1115
1115
|
```typescript
|
|
1116
1116
|
public readonly gitpod: Gitpod;
|
|
@@ -1124,7 +1124,7 @@ This will be `undefined` if gitpod boolean is false
|
|
|
1124
1124
|
|
|
1125
1125
|
---
|
|
1126
1126
|
|
|
1127
|
-
##### `vscode`<sup>Optional</sup> <a name="vscode" id="@nikovirtala/projen-constructs.
|
|
1127
|
+
##### `vscode`<sup>Optional</sup> <a name="vscode" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.vscode"></a>
|
|
1128
1128
|
|
|
1129
1129
|
```typescript
|
|
1130
1130
|
public readonly vscode: VsCode;
|
|
@@ -1138,7 +1138,7 @@ This will be `undefined` for subprojects.
|
|
|
1138
1138
|
|
|
1139
1139
|
---
|
|
1140
1140
|
|
|
1141
|
-
##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@nikovirtala/projen-constructs.
|
|
1141
|
+
##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.allowLibraryDependencies"></a>
|
|
1142
1142
|
|
|
1143
1143
|
- *Deprecated:* use `package.allowLibraryDependencies`
|
|
1144
1144
|
|
|
@@ -1150,7 +1150,7 @@ public readonly allowLibraryDependencies: boolean;
|
|
|
1150
1150
|
|
|
1151
1151
|
---
|
|
1152
1152
|
|
|
1153
|
-
##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="@nikovirtala/projen-constructs.
|
|
1153
|
+
##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.artifactsDirectory"></a>
|
|
1154
1154
|
|
|
1155
1155
|
```typescript
|
|
1156
1156
|
public readonly artifactsDirectory: string;
|
|
@@ -1166,7 +1166,7 @@ tarball will be placed under `dist/js/boom-boom-1.2.3.tg`.
|
|
|
1166
1166
|
|
|
1167
1167
|
---
|
|
1168
1168
|
|
|
1169
|
-
##### `artifactsJavascriptDirectory`<sup>Required</sup> <a name="artifactsJavascriptDirectory" id="@nikovirtala/projen-constructs.
|
|
1169
|
+
##### `artifactsJavascriptDirectory`<sup>Required</sup> <a name="artifactsJavascriptDirectory" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.artifactsJavascriptDirectory"></a>
|
|
1170
1170
|
|
|
1171
1171
|
```typescript
|
|
1172
1172
|
public readonly artifactsJavascriptDirectory: string;
|
|
@@ -1178,7 +1178,7 @@ The location of the npm tarball after build (`${artifactsDirectory}/js`).
|
|
|
1178
1178
|
|
|
1179
1179
|
---
|
|
1180
1180
|
|
|
1181
|
-
##### `bundler`<sup>Required</sup> <a name="bundler" id="@nikovirtala/projen-constructs.
|
|
1181
|
+
##### `bundler`<sup>Required</sup> <a name="bundler" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.bundler"></a>
|
|
1182
1182
|
|
|
1183
1183
|
```typescript
|
|
1184
1184
|
public readonly bundler: Bundler;
|
|
@@ -1188,7 +1188,7 @@ public readonly bundler: Bundler;
|
|
|
1188
1188
|
|
|
1189
1189
|
---
|
|
1190
1190
|
|
|
1191
|
-
##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@nikovirtala/projen-constructs.
|
|
1191
|
+
##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.entrypoint"></a>
|
|
1192
1192
|
|
|
1193
1193
|
- *Deprecated:* use `package.entrypoint`
|
|
1194
1194
|
|
|
@@ -1200,7 +1200,7 @@ public readonly entrypoint: string;
|
|
|
1200
1200
|
|
|
1201
1201
|
---
|
|
1202
1202
|
|
|
1203
|
-
##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@nikovirtala/projen-constructs.
|
|
1203
|
+
##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.manifest"></a>
|
|
1204
1204
|
|
|
1205
1205
|
- *Deprecated:* use `package.addField(x, y)`
|
|
1206
1206
|
|
|
@@ -1212,7 +1212,7 @@ public readonly manifest: any;
|
|
|
1212
1212
|
|
|
1213
1213
|
---
|
|
1214
1214
|
|
|
1215
|
-
##### `npmrc`<sup>Required</sup> <a name="npmrc" id="@nikovirtala/projen-constructs.
|
|
1215
|
+
##### `npmrc`<sup>Required</sup> <a name="npmrc" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.npmrc"></a>
|
|
1216
1216
|
|
|
1217
1217
|
```typescript
|
|
1218
1218
|
public readonly npmrc: NpmConfig;
|
|
@@ -1224,7 +1224,7 @@ The .npmrc file.
|
|
|
1224
1224
|
|
|
1225
1225
|
---
|
|
1226
1226
|
|
|
1227
|
-
##### `package`<sup>Required</sup> <a name="package" id="@nikovirtala/projen-constructs.
|
|
1227
|
+
##### `package`<sup>Required</sup> <a name="package" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.package"></a>
|
|
1228
1228
|
|
|
1229
1229
|
```typescript
|
|
1230
1230
|
public readonly package: NodePackage;
|
|
@@ -1236,7 +1236,7 @@ API for managing the node package.
|
|
|
1236
1236
|
|
|
1237
1237
|
---
|
|
1238
1238
|
|
|
1239
|
-
##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@nikovirtala/projen-constructs.
|
|
1239
|
+
##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.packageManager"></a>
|
|
1240
1240
|
|
|
1241
1241
|
- *Deprecated:* use `package.packageManager`
|
|
1242
1242
|
|
|
@@ -1250,7 +1250,7 @@ The package manager to use.
|
|
|
1250
1250
|
|
|
1251
1251
|
---
|
|
1252
1252
|
|
|
1253
|
-
##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@nikovirtala/projen-constructs.
|
|
1253
|
+
##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.runScriptCommand"></a>
|
|
1254
1254
|
|
|
1255
1255
|
```typescript
|
|
1256
1256
|
public readonly runScriptCommand: string;
|
|
@@ -1262,7 +1262,7 @@ The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the p
|
|
|
1262
1262
|
|
|
1263
1263
|
---
|
|
1264
1264
|
|
|
1265
|
-
##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@nikovirtala/projen-constructs.
|
|
1265
|
+
##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.autoMerge"></a>
|
|
1266
1266
|
|
|
1267
1267
|
```typescript
|
|
1268
1268
|
public readonly autoMerge: AutoMerge;
|
|
@@ -1274,7 +1274,7 @@ Component that sets up mergify for merging approved pull requests.
|
|
|
1274
1274
|
|
|
1275
1275
|
---
|
|
1276
1276
|
|
|
1277
|
-
##### `biome`<sup>Optional</sup> <a name="biome" id="@nikovirtala/projen-constructs.
|
|
1277
|
+
##### `biome`<sup>Optional</sup> <a name="biome" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.biome"></a>
|
|
1278
1278
|
|
|
1279
1279
|
```typescript
|
|
1280
1280
|
public readonly biome: Biome;
|
|
@@ -1284,7 +1284,7 @@ public readonly biome: Biome;
|
|
|
1284
1284
|
|
|
1285
1285
|
---
|
|
1286
1286
|
|
|
1287
|
-
##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@nikovirtala/projen-constructs.
|
|
1287
|
+
##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.buildWorkflow"></a>
|
|
1288
1288
|
|
|
1289
1289
|
```typescript
|
|
1290
1290
|
public readonly buildWorkflow: BuildWorkflow;
|
|
@@ -1298,7 +1298,7 @@ The PR build GitHub workflow.
|
|
|
1298
1298
|
|
|
1299
1299
|
---
|
|
1300
1300
|
|
|
1301
|
-
##### `buildWorkflowJobId`<sup>Optional</sup> <a name="buildWorkflowJobId" id="@nikovirtala/projen-constructs.
|
|
1301
|
+
##### `buildWorkflowJobId`<sup>Optional</sup> <a name="buildWorkflowJobId" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.buildWorkflowJobId"></a>
|
|
1302
1302
|
|
|
1303
1303
|
```typescript
|
|
1304
1304
|
public readonly buildWorkflowJobId: string;
|
|
@@ -1310,7 +1310,7 @@ The job ID of the build workflow.
|
|
|
1310
1310
|
|
|
1311
1311
|
---
|
|
1312
1312
|
|
|
1313
|
-
##### `jest`<sup>Optional</sup> <a name="jest" id="@nikovirtala/projen-constructs.
|
|
1313
|
+
##### `jest`<sup>Optional</sup> <a name="jest" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.jest"></a>
|
|
1314
1314
|
|
|
1315
1315
|
```typescript
|
|
1316
1316
|
public readonly jest: Jest;
|
|
@@ -1322,7 +1322,7 @@ The Jest configuration (if enabled).
|
|
|
1322
1322
|
|
|
1323
1323
|
---
|
|
1324
1324
|
|
|
1325
|
-
##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@nikovirtala/projen-constructs.
|
|
1325
|
+
##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.maxNodeVersion"></a>
|
|
1326
1326
|
|
|
1327
1327
|
```typescript
|
|
1328
1328
|
public readonly maxNodeVersion: string;
|
|
@@ -1336,7 +1336,7 @@ The value indicates the package is incompatible with newer versions.
|
|
|
1336
1336
|
|
|
1337
1337
|
---
|
|
1338
1338
|
|
|
1339
|
-
##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@nikovirtala/projen-constructs.
|
|
1339
|
+
##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.minNodeVersion"></a>
|
|
1340
1340
|
|
|
1341
1341
|
```typescript
|
|
1342
1342
|
public readonly minNodeVersion: string;
|
|
@@ -1350,7 +1350,7 @@ This value indicates the package is incompatible with older versions.
|
|
|
1350
1350
|
|
|
1351
1351
|
---
|
|
1352
1352
|
|
|
1353
|
-
##### `npmignore`<sup>Optional</sup> <a name="npmignore" id="@nikovirtala/projen-constructs.
|
|
1353
|
+
##### `npmignore`<sup>Optional</sup> <a name="npmignore" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.npmignore"></a>
|
|
1354
1354
|
|
|
1355
1355
|
```typescript
|
|
1356
1356
|
public readonly npmignore: IgnoreFile;
|
|
@@ -1362,7 +1362,7 @@ The .npmignore file.
|
|
|
1362
1362
|
|
|
1363
1363
|
---
|
|
1364
1364
|
|
|
1365
|
-
##### `prettier`<sup>Optional</sup> <a name="prettier" id="@nikovirtala/projen-constructs.
|
|
1365
|
+
##### `prettier`<sup>Optional</sup> <a name="prettier" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.prettier"></a>
|
|
1366
1366
|
|
|
1367
1367
|
```typescript
|
|
1368
1368
|
public readonly prettier: Prettier;
|
|
@@ -1372,7 +1372,7 @@ public readonly prettier: Prettier;
|
|
|
1372
1372
|
|
|
1373
1373
|
---
|
|
1374
1374
|
|
|
1375
|
-
##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@nikovirtala/projen-constructs.
|
|
1375
|
+
##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.publisher"></a>
|
|
1376
1376
|
|
|
1377
1377
|
- *Deprecated:* use `release.publisher`.
|
|
1378
1378
|
|
|
@@ -1389,7 +1389,7 @@ release workflow.
|
|
|
1389
1389
|
|
|
1390
1390
|
---
|
|
1391
1391
|
|
|
1392
|
-
##### `release`<sup>Optional</sup> <a name="release" id="@nikovirtala/projen-constructs.
|
|
1392
|
+
##### `release`<sup>Optional</sup> <a name="release" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.release"></a>
|
|
1393
1393
|
|
|
1394
1394
|
```typescript
|
|
1395
1395
|
public readonly release: Release;
|
|
@@ -1401,7 +1401,7 @@ Release management.
|
|
|
1401
1401
|
|
|
1402
1402
|
---
|
|
1403
1403
|
|
|
1404
|
-
##### `upgradeWorkflow`<sup>Optional</sup> <a name="upgradeWorkflow" id="@nikovirtala/projen-constructs.
|
|
1404
|
+
##### `upgradeWorkflow`<sup>Optional</sup> <a name="upgradeWorkflow" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.upgradeWorkflow"></a>
|
|
1405
1405
|
|
|
1406
1406
|
```typescript
|
|
1407
1407
|
public readonly upgradeWorkflow: UpgradeDependencies;
|
|
@@ -1413,7 +1413,7 @@ The upgrade workflow.
|
|
|
1413
1413
|
|
|
1414
1414
|
---
|
|
1415
1415
|
|
|
1416
|
-
##### `docsDirectory`<sup>Required</sup> <a name="docsDirectory" id="@nikovirtala/projen-constructs.
|
|
1416
|
+
##### `docsDirectory`<sup>Required</sup> <a name="docsDirectory" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.docsDirectory"></a>
|
|
1417
1417
|
|
|
1418
1418
|
```typescript
|
|
1419
1419
|
public readonly docsDirectory: string;
|
|
@@ -1423,7 +1423,7 @@ public readonly docsDirectory: string;
|
|
|
1423
1423
|
|
|
1424
1424
|
---
|
|
1425
1425
|
|
|
1426
|
-
##### `libdir`<sup>Required</sup> <a name="libdir" id="@nikovirtala/projen-constructs.
|
|
1426
|
+
##### `libdir`<sup>Required</sup> <a name="libdir" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.libdir"></a>
|
|
1427
1427
|
|
|
1428
1428
|
```typescript
|
|
1429
1429
|
public readonly libdir: string;
|
|
@@ -1435,7 +1435,7 @@ The directory in which compiled .js files reside.
|
|
|
1435
1435
|
|
|
1436
1436
|
---
|
|
1437
1437
|
|
|
1438
|
-
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="@nikovirtala/projen-constructs.
|
|
1438
|
+
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.srcdir"></a>
|
|
1439
1439
|
|
|
1440
1440
|
```typescript
|
|
1441
1441
|
public readonly srcdir: string;
|
|
@@ -1447,7 +1447,7 @@ The directory in which the .ts sources reside.
|
|
|
1447
1447
|
|
|
1448
1448
|
---
|
|
1449
1449
|
|
|
1450
|
-
##### `testdir`<sup>Required</sup> <a name="testdir" id="@nikovirtala/projen-constructs.
|
|
1450
|
+
##### `testdir`<sup>Required</sup> <a name="testdir" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.testdir"></a>
|
|
1451
1451
|
|
|
1452
1452
|
```typescript
|
|
1453
1453
|
public readonly testdir: string;
|
|
@@ -1459,7 +1459,7 @@ The directory in which tests reside.
|
|
|
1459
1459
|
|
|
1460
1460
|
---
|
|
1461
1461
|
|
|
1462
|
-
##### `tsconfigDev`<sup>Required</sup> <a name="tsconfigDev" id="@nikovirtala/projen-constructs.
|
|
1462
|
+
##### `tsconfigDev`<sup>Required</sup> <a name="tsconfigDev" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.tsconfigDev"></a>
|
|
1463
1463
|
|
|
1464
1464
|
```typescript
|
|
1465
1465
|
public readonly tsconfigDev: TypescriptConfig;
|
|
@@ -1471,7 +1471,7 @@ A typescript configuration file which covers all files (sources, tests, projen).
|
|
|
1471
1471
|
|
|
1472
1472
|
---
|
|
1473
1473
|
|
|
1474
|
-
##### `watchTask`<sup>Required</sup> <a name="watchTask" id="@nikovirtala/projen-constructs.
|
|
1474
|
+
##### `watchTask`<sup>Required</sup> <a name="watchTask" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.watchTask"></a>
|
|
1475
1475
|
|
|
1476
1476
|
```typescript
|
|
1477
1477
|
public readonly watchTask: Task;
|
|
@@ -1483,7 +1483,7 @@ The "watch" task.
|
|
|
1483
1483
|
|
|
1484
1484
|
---
|
|
1485
1485
|
|
|
1486
|
-
##### `docgen`<sup>Optional</sup> <a name="docgen" id="@nikovirtala/projen-constructs.
|
|
1486
|
+
##### `docgen`<sup>Optional</sup> <a name="docgen" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.docgen"></a>
|
|
1487
1487
|
|
|
1488
1488
|
```typescript
|
|
1489
1489
|
public readonly docgen: boolean;
|
|
@@ -1493,7 +1493,7 @@ public readonly docgen: boolean;
|
|
|
1493
1493
|
|
|
1494
1494
|
---
|
|
1495
1495
|
|
|
1496
|
-
##### `eslint`<sup>Optional</sup> <a name="eslint" id="@nikovirtala/projen-constructs.
|
|
1496
|
+
##### `eslint`<sup>Optional</sup> <a name="eslint" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.eslint"></a>
|
|
1497
1497
|
|
|
1498
1498
|
```typescript
|
|
1499
1499
|
public readonly eslint: Eslint;
|
|
@@ -1503,7 +1503,7 @@ public readonly eslint: Eslint;
|
|
|
1503
1503
|
|
|
1504
1504
|
---
|
|
1505
1505
|
|
|
1506
|
-
##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="@nikovirtala/projen-constructs.
|
|
1506
|
+
##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.tsconfig"></a>
|
|
1507
1507
|
|
|
1508
1508
|
```typescript
|
|
1509
1509
|
public readonly tsconfig: TypescriptConfig;
|
|
@@ -1513,7 +1513,7 @@ public readonly tsconfig: TypescriptConfig;
|
|
|
1513
1513
|
|
|
1514
1514
|
---
|
|
1515
1515
|
|
|
1516
|
-
##### `tsconfigEslint`<sup>Optional</sup> <a name="tsconfigEslint" id="@nikovirtala/projen-constructs.
|
|
1516
|
+
##### `tsconfigEslint`<sup>Optional</sup> <a name="tsconfigEslint" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.tsconfigEslint"></a>
|
|
1517
1517
|
|
|
1518
1518
|
```typescript
|
|
1519
1519
|
public readonly tsconfigEslint: TypescriptConfig;
|
|
@@ -1523,7 +1523,7 @@ public readonly tsconfigEslint: TypescriptConfig;
|
|
|
1523
1523
|
|
|
1524
1524
|
---
|
|
1525
1525
|
|
|
1526
|
-
##### `cdkDeps`<sup>Required</sup> <a name="cdkDeps" id="@nikovirtala/projen-constructs.
|
|
1526
|
+
##### `cdkDeps`<sup>Required</sup> <a name="cdkDeps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.cdkDeps"></a>
|
|
1527
1527
|
|
|
1528
1528
|
```typescript
|
|
1529
1529
|
public readonly cdkDeps: AwsCdkDeps;
|
|
@@ -1533,7 +1533,7 @@ public readonly cdkDeps: AwsCdkDeps;
|
|
|
1533
1533
|
|
|
1534
1534
|
---
|
|
1535
1535
|
|
|
1536
|
-
##### `cdkVersion`<sup>Required</sup> <a name="cdkVersion" id="@nikovirtala/projen-constructs.
|
|
1536
|
+
##### `cdkVersion`<sup>Required</sup> <a name="cdkVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.cdkVersion"></a>
|
|
1537
1537
|
|
|
1538
1538
|
```typescript
|
|
1539
1539
|
public readonly cdkVersion: string;
|
|
@@ -1545,7 +1545,7 @@ The target CDK version for this library.
|
|
|
1545
1545
|
|
|
1546
1546
|
---
|
|
1547
1547
|
|
|
1548
|
-
##### ~~`version`~~<sup>Required</sup> <a name="version" id="@nikovirtala/projen-constructs.
|
|
1548
|
+
##### ~~`version`~~<sup>Required</sup> <a name="version" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.version"></a>
|
|
1549
1549
|
|
|
1550
1550
|
- *Deprecated:* use `cdkVersion`
|
|
1551
1551
|
|
|
@@ -1561,12 +1561,12 @@ public readonly version: string;
|
|
|
1561
1561
|
|
|
1562
1562
|
| **Name** | **Type** | **Description** |
|
|
1563
1563
|
| --- | --- | --- |
|
|
1564
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
1565
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
1564
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.DEFAULT_TASK">DEFAULT_TASK</a></code> | <code>string</code> | The name of the default task (the task executed when `projen` is run without arguments). |
|
|
1565
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
|
|
1566
1566
|
|
|
1567
1567
|
---
|
|
1568
1568
|
|
|
1569
|
-
##### `DEFAULT_TASK`<sup>Required</sup> <a name="DEFAULT_TASK" id="@nikovirtala/projen-constructs.
|
|
1569
|
+
##### `DEFAULT_TASK`<sup>Required</sup> <a name="DEFAULT_TASK" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.DEFAULT_TASK"></a>
|
|
1570
1570
|
|
|
1571
1571
|
```typescript
|
|
1572
1572
|
public readonly DEFAULT_TASK: string;
|
|
@@ -1581,7 +1581,7 @@ this task should synthesize the project files.
|
|
|
1581
1581
|
|
|
1582
1582
|
---
|
|
1583
1583
|
|
|
1584
|
-
##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="@nikovirtala/projen-constructs.
|
|
1584
|
+
##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
|
|
1585
1585
|
|
|
1586
1586
|
```typescript
|
|
1587
1587
|
public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
|
|
@@ -6471,189 +6471,190 @@ public readonly project: Project;
|
|
|
6471
6471
|
|
|
6472
6472
|
## Structs <a name="Structs" id="Structs"></a>
|
|
6473
6473
|
|
|
6474
|
-
###
|
|
6474
|
+
### AwsCdkConstructLibraryProjectOptions <a name="AwsCdkConstructLibraryProjectOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions"></a>
|
|
6475
6475
|
|
|
6476
|
-
|
|
6476
|
+
AwsCdkConstructLibraryProjectOptions.
|
|
6477
6477
|
|
|
6478
|
-
#### Initializer <a name="Initializer" id="@nikovirtala/projen-constructs.
|
|
6478
|
+
#### Initializer <a name="Initializer" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.Initializer"></a>
|
|
6479
6479
|
|
|
6480
6480
|
```typescript
|
|
6481
|
-
import {
|
|
6481
|
+
import { AwsCdkConstructLibraryProjectOptions } from '@nikovirtala/projen-constructs'
|
|
6482
6482
|
|
|
6483
|
-
const
|
|
6483
|
+
const awsCdkConstructLibraryProjectOptions: AwsCdkConstructLibraryProjectOptions = { ... }
|
|
6484
6484
|
```
|
|
6485
6485
|
|
|
6486
6486
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
6487
6487
|
|
|
6488
6488
|
| **Name** | **Type** | **Description** |
|
|
6489
6489
|
| --- | --- | --- |
|
|
6490
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6491
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6492
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6493
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6494
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6495
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6496
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6497
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6498
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6499
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6500
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6501
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6502
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6503
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6504
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6505
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6506
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6507
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6508
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6509
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6510
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6511
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6512
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6513
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6514
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6515
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6516
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6517
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6518
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6519
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6520
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6521
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6522
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6523
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6524
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6525
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6526
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6527
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6528
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6529
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6530
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6531
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6532
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6533
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6534
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6535
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6536
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6537
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6538
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6539
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6540
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6541
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6542
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6543
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6544
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6545
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6546
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6547
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6548
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6549
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6550
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6551
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6552
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6553
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6554
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6555
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6556
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6557
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6558
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6559
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6560
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6561
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6562
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6563
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6564
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6565
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6566
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6567
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6568
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6569
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6570
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6571
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6572
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6573
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6574
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6575
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6576
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6577
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6578
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6579
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6580
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6581
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6582
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6583
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6584
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6585
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6586
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6587
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6588
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6589
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6590
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6591
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6592
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6593
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6594
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6595
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6596
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6597
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6598
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6599
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6600
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6601
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6602
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6603
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6604
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6605
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6606
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6607
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6608
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6609
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6610
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6611
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6612
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6613
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6614
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6615
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6616
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6617
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6618
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6619
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6620
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6621
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6622
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6623
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6624
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6625
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6626
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6627
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6628
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6629
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6630
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6631
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6632
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6633
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6634
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6635
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6636
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6637
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6638
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6639
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6640
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6641
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6642
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6643
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6644
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6645
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6646
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6647
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6648
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6649
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6650
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6651
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6652
|
-
| <code><a href="#@nikovirtala/projen-constructs.
|
|
6653
|
-
|
|
6654
|
-
|
|
6655
|
-
|
|
6656
|
-
|
|
6490
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.author">author</a></code> | <code>string</code> | The name of the library author. |
|
|
6491
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.authorAddress">authorAddress</a></code> | <code>string</code> | Email or URL of the library author. |
|
|
6492
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | Minimum version of the AWS CDK to depend on. |
|
|
6493
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
6494
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
6495
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.repositoryUrl">repositoryUrl</a></code> | <code>string</code> | Git repository URL. |
|
|
6496
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
6497
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
6498
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
6499
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
6500
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
|
|
6501
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
|
|
6502
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.authorOrganization">authorOrganization</a></code> | <code>boolean</code> | Is the author an organization. |
|
|
6503
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.authorUrl">authorUrl</a></code> | <code>string</code> | Author's URL / Website. |
|
|
6504
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
|
|
6505
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
|
|
6506
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.autoDetectBin">autoDetectBin</a></code> | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
|
|
6507
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
|
|
6508
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
|
|
6509
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
|
|
6510
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
|
|
6511
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
6512
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
|
|
6513
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
|
|
6514
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
|
|
6515
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
6516
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bumpPackage">bumpPackage</a></code> | <code>string</code> | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. |
|
|
6517
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
6518
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
6519
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
6520
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.catalog">catalog</a></code> | <code>projen.cdk.Catalog</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. |
|
|
6521
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.cdkAssertions">cdkAssertions</a></code> | <code>boolean</code> | Install the assertions library? |
|
|
6522
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.cdkCliVersion">cdkCliVersion</a></code> | <code>string</code> | Version range of the AWS CDK CLI to depend on. |
|
|
6523
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.cdkVersionPinning">cdkVersionPinning</a></code> | <code>boolean</code> | Use pinned version instead of caret version for CDK. |
|
|
6524
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
6525
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
6526
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
6527
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.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@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
|
|
6528
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
6529
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
6530
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
|
|
6531
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
|
|
6532
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
|
|
6533
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.constructsVersion">constructsVersion</a></code> | <code>string</code> | Minimum version of the `constructs` library to depend on. |
|
|
6534
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
6535
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
6536
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
6537
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
|
|
6538
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
6539
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.depsUpgrade">depsUpgrade</a></code> | <code>boolean</code> | Use tasks and github workflows to handle dependency upgrades. |
|
|
6540
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.depsUpgradeOptions">depsUpgradeOptions</a></code> | <code>projen.javascript.UpgradeDependenciesOptions</code> | Options for `UpgradeDependencies`. |
|
|
6541
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
6542
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.devContainer">devContainer</a></code> | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces). |
|
|
6543
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
|
|
6544
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.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). |
|
|
6545
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
|
|
6546
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
6547
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.docgenFilePath">docgenFilePath</a></code> | <code>string</code> | File path for generated docs. |
|
|
6548
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
|
|
6549
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.edgeLambdaAutoDiscover">edgeLambdaAutoDiscover</a></code> | <code>boolean</code> | Automatically adds an `cloudfront.experimental.EdgeFunction` for each `.edge-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. |
|
|
6550
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.entrypoint">entrypoint</a></code> | <code>string</code> | Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json. |
|
|
6551
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.entrypointTypes">entrypointTypes</a></code> | <code>string</code> | The .d.ts file that includes the type declarations for this module. |
|
|
6552
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.excludeTypescript">excludeTypescript</a></code> | <code>string[]</code> | Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input. |
|
|
6553
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.experimentalIntegRunner">experimentalIntegRunner</a></code> | <code>boolean</code> | Enable experimental support for the AWS CDK integ-runner. |
|
|
6554
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
|
|
6555
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
|
|
6556
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
|
|
6557
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
|
|
6558
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
|
|
6559
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.gitpod">gitpod</a></code> | <code>boolean</code> | Add a Gitpod development environment. |
|
|
6560
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.homepage">homepage</a></code> | <code>string</code> | Package's Homepage / Website. |
|
|
6561
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.integrationTestAutoDiscover">integrationTestAutoDiscover</a></code> | <code>boolean</code> | Automatically discovers and creates integration tests for each `.integ.ts` file under your test directory. |
|
|
6562
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
|
|
6563
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.jsiiVersion">jsiiVersion</a></code> | <code>string</code> | Version of the jsii compiler to use. |
|
|
6564
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.keywords">keywords</a></code> | <code>string[]</code> | Keywords to include in `package.json`. |
|
|
6565
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.lambdaAutoDiscover">lambdaAutoDiscover</a></code> | <code>boolean</code> | Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in your source tree. If this is disabled, you either need to explicitly call `aws_lambda.Function.autoDiscover()` or define a `new aws_lambda.Function()` for each handler. |
|
|
6566
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.lambdaExtensionAutoDiscover">lambdaExtensionAutoDiscover</a></code> | <code>boolean</code> | Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. |
|
|
6567
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.lambdaOptions">lambdaOptions</a></code> | <code>projen.awscdk.LambdaFunctionCommonOptions</code> | Common options for all AWS Lambda functions. |
|
|
6568
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.libdir">libdir</a></code> | <code>string</code> | Typescript artifacts output directory. |
|
|
6569
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.license">license</a></code> | <code>string</code> | License's SPDX identifier. |
|
|
6570
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.licensed">licensed</a></code> | <code>boolean</code> | Indicates if a license should be added. |
|
|
6571
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
|
|
6572
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
6573
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | The maximum node version supported by this package. |
|
|
6574
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
6575
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
6576
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.mise">mise</a></code> | <code>boolean</code> | Create mise.toml with project Node.js version. |
|
|
6577
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.nextVersionCommand">nextVersionCommand</a></code> | <code>string</code> | A shell command to control the next version to release. |
|
|
6578
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
|
|
6579
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmDistTag">npmDistTag</a></code> | <code>string</code> | The npmDistTag to use when publishing from the default branch. |
|
|
6580
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
|
|
6581
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
|
|
6582
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
|
|
6583
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
6584
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
6585
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
|
|
6586
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
|
|
6587
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.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`). |
|
|
6588
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
|
|
6589
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
|
|
6590
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.parent">parent</a></code> | <code>projen.Project</code> | The parent project, if this project is part of a bigger project. |
|
|
6591
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
|
|
6592
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
|
|
6593
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.pnpmVersion">pnpmVersion</a></code> | <code>string</code> | The version of PNPM to use if using PNPM as a package manager. |
|
|
6594
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.postBuildSteps">postBuildSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Steps to execute after build as part of the release workflow. |
|
|
6595
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.prerelease">prerelease</a></code> | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). |
|
|
6596
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
6597
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
6598
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenDevDependency">projenDevDependency</a></code> | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency. |
|
|
6599
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenrcJs">projenrcJs</a></code> | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. |
|
|
6600
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenrcJson">projenrcJson</a></code> | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
|
|
6601
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenrcJsonOptions">projenrcJsonOptions</a></code> | <code>projen.ProjenrcJsonOptions</code> | Options for .projenrc.json. |
|
|
6602
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenrcJsOptions">projenrcJsOptions</a></code> | <code>projen.javascript.ProjenrcOptions</code> | Options for .projenrc.js. |
|
|
6603
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenrcTs">projenrcTs</a></code> | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`). |
|
|
6604
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenrcTsOptions">projenrcTsOptions</a></code> | <code>projen.typescript.ProjenrcOptions</code> | Options for .projenrc.ts. |
|
|
6605
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenVersion">projenVersion</a></code> | <code>string</code> | Version of projen to install. |
|
|
6606
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.publishDryRun">publishDryRun</a></code> | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command. |
|
|
6607
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
|
|
6608
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.publishToGo">publishToGo</a></code> | <code>projen.cdk.JsiiGoTarget</code> | Publish Go bindings to a git repository. |
|
|
6609
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.publishToMaven">publishToMaven</a></code> | <code>projen.cdk.JsiiJavaTarget</code> | Publish to maven. |
|
|
6610
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.publishToNuget">publishToNuget</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | Publish to NuGet. |
|
|
6611
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.publishToPypi">publishToPypi</a></code> | <code>projen.cdk.JsiiPythonTarget</code> | Publish to pypi. |
|
|
6612
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.pullRequestTemplate">pullRequestTemplate</a></code> | <code>boolean</code> | Include a GitHub pull request template. |
|
|
6613
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.pullRequestTemplateContents">pullRequestTemplateContents</a></code> | <code>string[]</code> | The contents of the pull request template. |
|
|
6614
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.readme">readme</a></code> | <code>projen.SampleReadmeProps</code> | The README setup. |
|
|
6615
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
6616
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
|
|
6617
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
6618
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
6619
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
6620
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
6621
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. |
|
|
6622
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
6623
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
6624
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
6625
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
6626
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
6627
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
|
6628
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.renovatebotOptions">renovatebotOptions</a></code> | <code>projen.RenovatebotOptions</code> | Options for renovatebot. |
|
|
6629
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
|
|
6630
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.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. |
|
|
6631
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.rootdir">rootdir</a></code> | <code>string</code> | *No description.* |
|
|
6632
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
6633
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.srcdir">srcdir</a></code> | <code>string</code> | Typescript sources directory. |
|
|
6634
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
6635
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
|
|
6636
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.staleOptions">staleOptions</a></code> | <code>projen.github.StaleOptions</code> | Auto-close stale issues and pull requests. |
|
|
6637
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.testdir">testdir</a></code> | <code>string</code> | Jest tests directory. |
|
|
6638
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
|
|
6639
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
6640
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
|
|
6641
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
6642
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
6643
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.vitest">vitest</a></code> | <code>boolean</code> | Enable testing with Vitest. |
|
|
6644
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.vitestOptions">vitestOptions</a></code> | <code><a href="#@nikovirtala/projen-constructs.VitestOptions">VitestOptions</a></code> | The Vitest configuration (when enabled). |
|
|
6645
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
|
|
6646
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
|
|
6647
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
|
|
6648
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
6649
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
|
|
6650
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
6651
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
6652
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
6653
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
6654
|
+
|
|
6655
|
+
---
|
|
6656
|
+
|
|
6657
|
+
##### `author`<sup>Required</sup> <a name="author" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.author"></a>
|
|
6657
6658
|
|
|
6658
6659
|
```typescript
|
|
6659
6660
|
public readonly author: string;
|
|
@@ -6666,7 +6667,7 @@ The name of the library author.
|
|
|
6666
6667
|
|
|
6667
6668
|
---
|
|
6668
6669
|
|
|
6669
|
-
##### `authorAddress`<sup>Required</sup> <a name="authorAddress" id="@nikovirtala/projen-constructs.
|
|
6670
|
+
##### `authorAddress`<sup>Required</sup> <a name="authorAddress" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.authorAddress"></a>
|
|
6670
6671
|
|
|
6671
6672
|
```typescript
|
|
6672
6673
|
public readonly authorAddress: string;
|
|
@@ -6679,7 +6680,7 @@ Email or URL of the library author.
|
|
|
6679
6680
|
|
|
6680
6681
|
---
|
|
6681
6682
|
|
|
6682
|
-
##### `cdkVersion`<sup>Required</sup> <a name="cdkVersion" id="@nikovirtala/projen-constructs.
|
|
6683
|
+
##### `cdkVersion`<sup>Required</sup> <a name="cdkVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.cdkVersion"></a>
|
|
6683
6684
|
|
|
6684
6685
|
```typescript
|
|
6685
6686
|
public readonly cdkVersion: string;
|
|
@@ -6692,7 +6693,7 @@ Minimum version of the AWS CDK to depend on.
|
|
|
6692
6693
|
|
|
6693
6694
|
---
|
|
6694
6695
|
|
|
6695
|
-
##### `defaultReleaseBranch`<sup>Required</sup> <a name="defaultReleaseBranch" id="@nikovirtala/projen-constructs.
|
|
6696
|
+
##### `defaultReleaseBranch`<sup>Required</sup> <a name="defaultReleaseBranch" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.defaultReleaseBranch"></a>
|
|
6696
6697
|
|
|
6697
6698
|
```typescript
|
|
6698
6699
|
public readonly defaultReleaseBranch: string;
|
|
@@ -6705,7 +6706,7 @@ The name of the main release branch.
|
|
|
6705
6706
|
|
|
6706
6707
|
---
|
|
6707
6708
|
|
|
6708
|
-
##### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.
|
|
6709
|
+
##### `name`<sup>Required</sup> <a name="name" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.name"></a>
|
|
6709
6710
|
|
|
6710
6711
|
```typescript
|
|
6711
6712
|
public readonly name: string;
|
|
@@ -6718,7 +6719,7 @@ This is the name of your project.
|
|
|
6718
6719
|
|
|
6719
6720
|
---
|
|
6720
6721
|
|
|
6721
|
-
##### `repositoryUrl`<sup>Required</sup> <a name="repositoryUrl" id="@nikovirtala/projen-constructs.
|
|
6722
|
+
##### `repositoryUrl`<sup>Required</sup> <a name="repositoryUrl" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.repositoryUrl"></a>
|
|
6722
6723
|
|
|
6723
6724
|
```typescript
|
|
6724
6725
|
public readonly repositoryUrl: string;
|
|
@@ -6731,7 +6732,7 @@ Git repository URL.
|
|
|
6731
6732
|
|
|
6732
6733
|
---
|
|
6733
6734
|
|
|
6734
|
-
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="@nikovirtala/projen-constructs.
|
|
6735
|
+
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.allowLibraryDependencies"></a>
|
|
6735
6736
|
|
|
6736
6737
|
```typescript
|
|
6737
6738
|
public readonly allowLibraryDependencies: boolean;
|
|
@@ -6747,7 +6748,7 @@ for specifying these.
|
|
|
6747
6748
|
|
|
6748
6749
|
---
|
|
6749
6750
|
|
|
6750
|
-
##### `artifactsDirectory`<sup>Optional</sup> <a name="artifactsDirectory" id="@nikovirtala/projen-constructs.
|
|
6751
|
+
##### `artifactsDirectory`<sup>Optional</sup> <a name="artifactsDirectory" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.artifactsDirectory"></a>
|
|
6751
6752
|
|
|
6752
6753
|
```typescript
|
|
6753
6754
|
public readonly artifactsDirectory: string;
|
|
@@ -6760,7 +6761,7 @@ A directory which will contain build artifacts.
|
|
|
6760
6761
|
|
|
6761
6762
|
---
|
|
6762
6763
|
|
|
6763
|
-
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="@nikovirtala/projen-constructs.
|
|
6764
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.auditDeps"></a>
|
|
6764
6765
|
|
|
6765
6766
|
```typescript
|
|
6766
6767
|
public readonly auditDeps: boolean;
|
|
@@ -6777,7 +6778,7 @@ vulnerabilities or above in all dependencies (including dev dependencies).
|
|
|
6777
6778
|
|
|
6778
6779
|
---
|
|
6779
6780
|
|
|
6780
|
-
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="@nikovirtala/projen-constructs.
|
|
6781
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.auditDepsOptions"></a>
|
|
6781
6782
|
|
|
6782
6783
|
```typescript
|
|
6783
6784
|
public readonly auditDepsOptions: AuditOptions;
|
|
@@ -6790,7 +6791,7 @@ Security audit options.
|
|
|
6790
6791
|
|
|
6791
6792
|
---
|
|
6792
6793
|
|
|
6793
|
-
##### `authorEmail`<sup>Optional</sup> <a name="authorEmail" id="@nikovirtala/projen-constructs.
|
|
6794
|
+
##### `authorEmail`<sup>Optional</sup> <a name="authorEmail" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.authorEmail"></a>
|
|
6794
6795
|
|
|
6795
6796
|
```typescript
|
|
6796
6797
|
public readonly authorEmail: string;
|
|
@@ -6802,7 +6803,7 @@ Author's e-mail.
|
|
|
6802
6803
|
|
|
6803
6804
|
---
|
|
6804
6805
|
|
|
6805
|
-
##### `authorName`<sup>Optional</sup> <a name="authorName" id="@nikovirtala/projen-constructs.
|
|
6806
|
+
##### `authorName`<sup>Optional</sup> <a name="authorName" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.authorName"></a>
|
|
6806
6807
|
|
|
6807
6808
|
```typescript
|
|
6808
6809
|
public readonly authorName: string;
|
|
@@ -6814,7 +6815,7 @@ Author's name.
|
|
|
6814
6815
|
|
|
6815
6816
|
---
|
|
6816
6817
|
|
|
6817
|
-
##### `authorOrganization`<sup>Optional</sup> <a name="authorOrganization" id="@nikovirtala/projen-constructs.
|
|
6818
|
+
##### `authorOrganization`<sup>Optional</sup> <a name="authorOrganization" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.authorOrganization"></a>
|
|
6818
6819
|
|
|
6819
6820
|
```typescript
|
|
6820
6821
|
public readonly authorOrganization: boolean;
|
|
@@ -6826,7 +6827,7 @@ Is the author an organization.
|
|
|
6826
6827
|
|
|
6827
6828
|
---
|
|
6828
6829
|
|
|
6829
|
-
##### `authorUrl`<sup>Optional</sup> <a name="authorUrl" id="@nikovirtala/projen-constructs.
|
|
6830
|
+
##### `authorUrl`<sup>Optional</sup> <a name="authorUrl" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.authorUrl"></a>
|
|
6830
6831
|
|
|
6831
6832
|
```typescript
|
|
6832
6833
|
public readonly authorUrl: string;
|
|
@@ -6838,7 +6839,7 @@ Author's URL / Website.
|
|
|
6838
6839
|
|
|
6839
6840
|
---
|
|
6840
6841
|
|
|
6841
|
-
##### `autoApproveOptions`<sup>Optional</sup> <a name="autoApproveOptions" id="@nikovirtala/projen-constructs.
|
|
6842
|
+
##### `autoApproveOptions`<sup>Optional</sup> <a name="autoApproveOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.autoApproveOptions"></a>
|
|
6842
6843
|
|
|
6843
6844
|
```typescript
|
|
6844
6845
|
public readonly autoApproveOptions: AutoApproveOptions;
|
|
@@ -6851,7 +6852,7 @@ Enable and configure the 'auto approve' workflow.
|
|
|
6851
6852
|
|
|
6852
6853
|
---
|
|
6853
6854
|
|
|
6854
|
-
##### `autoApproveUpgrades`<sup>Optional</sup> <a name="autoApproveUpgrades" id="@nikovirtala/projen-constructs.
|
|
6855
|
+
##### `autoApproveUpgrades`<sup>Optional</sup> <a name="autoApproveUpgrades" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.autoApproveUpgrades"></a>
|
|
6855
6856
|
|
|
6856
6857
|
```typescript
|
|
6857
6858
|
public readonly autoApproveUpgrades: boolean;
|
|
@@ -6866,7 +6867,7 @@ Throw if set to true but `autoApproveOptions` are not defined.
|
|
|
6866
6867
|
|
|
6867
6868
|
---
|
|
6868
6869
|
|
|
6869
|
-
##### `autoDetectBin`<sup>Optional</sup> <a name="autoDetectBin" id="@nikovirtala/projen-constructs.
|
|
6870
|
+
##### `autoDetectBin`<sup>Optional</sup> <a name="autoDetectBin" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.autoDetectBin"></a>
|
|
6870
6871
|
|
|
6871
6872
|
```typescript
|
|
6872
6873
|
public readonly autoDetectBin: boolean;
|
|
@@ -6879,7 +6880,7 @@ Automatically add all executables under the `bin` directory to your `package.jso
|
|
|
6879
6880
|
|
|
6880
6881
|
---
|
|
6881
6882
|
|
|
6882
|
-
##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@nikovirtala/projen-constructs.
|
|
6883
|
+
##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.autoMerge"></a>
|
|
6883
6884
|
|
|
6884
6885
|
```typescript
|
|
6885
6886
|
public readonly autoMerge: boolean;
|
|
@@ -6895,7 +6896,7 @@ is set to false.
|
|
|
6895
6896
|
|
|
6896
6897
|
---
|
|
6897
6898
|
|
|
6898
|
-
##### `autoMergeOptions`<sup>Optional</sup> <a name="autoMergeOptions" id="@nikovirtala/projen-constructs.
|
|
6899
|
+
##### `autoMergeOptions`<sup>Optional</sup> <a name="autoMergeOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.autoMergeOptions"></a>
|
|
6899
6900
|
|
|
6900
6901
|
```typescript
|
|
6901
6902
|
public readonly autoMergeOptions: AutoMergeOptions;
|
|
@@ -6911,7 +6912,7 @@ Has no effect if
|
|
|
6911
6912
|
|
|
6912
6913
|
---
|
|
6913
6914
|
|
|
6914
|
-
##### `bin`<sup>Optional</sup> <a name="bin" id="@nikovirtala/projen-constructs.
|
|
6915
|
+
##### `bin`<sup>Optional</sup> <a name="bin" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bin"></a>
|
|
6915
6916
|
|
|
6916
6917
|
```typescript
|
|
6917
6918
|
public readonly bin: {[ key: string ]: string};
|
|
@@ -6927,7 +6928,20 @@ executable file under `bin` will automatically be added to this section.
|
|
|
6927
6928
|
|
|
6928
6929
|
---
|
|
6929
6930
|
|
|
6930
|
-
##### `
|
|
6931
|
+
##### `biome`<sup>Optional</sup> <a name="biome" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.biome"></a>
|
|
6932
|
+
|
|
6933
|
+
```typescript
|
|
6934
|
+
public readonly biome: boolean;
|
|
6935
|
+
```
|
|
6936
|
+
|
|
6937
|
+
- *Type:* boolean
|
|
6938
|
+
- *Default:* false
|
|
6939
|
+
|
|
6940
|
+
Setup Biome.
|
|
6941
|
+
|
|
6942
|
+
---
|
|
6943
|
+
|
|
6944
|
+
##### `biomeOptions`<sup>Optional</sup> <a name="biomeOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.biomeOptions"></a>
|
|
6931
6945
|
|
|
6932
6946
|
```typescript
|
|
6933
6947
|
public readonly biomeOptions: BiomeOptions;
|
|
@@ -6940,7 +6954,7 @@ Biome options.
|
|
|
6940
6954
|
|
|
6941
6955
|
---
|
|
6942
6956
|
|
|
6943
|
-
##### `bugsEmail`<sup>Optional</sup> <a name="bugsEmail" id="@nikovirtala/projen-constructs.
|
|
6957
|
+
##### `bugsEmail`<sup>Optional</sup> <a name="bugsEmail" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bugsEmail"></a>
|
|
6944
6958
|
|
|
6945
6959
|
```typescript
|
|
6946
6960
|
public readonly bugsEmail: string;
|
|
@@ -6952,7 +6966,7 @@ The email address to which issues should be reported.
|
|
|
6952
6966
|
|
|
6953
6967
|
---
|
|
6954
6968
|
|
|
6955
|
-
##### `bugsUrl`<sup>Optional</sup> <a name="bugsUrl" id="@nikovirtala/projen-constructs.
|
|
6969
|
+
##### `bugsUrl`<sup>Optional</sup> <a name="bugsUrl" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bugsUrl"></a>
|
|
6956
6970
|
|
|
6957
6971
|
```typescript
|
|
6958
6972
|
public readonly bugsUrl: string;
|
|
@@ -6964,7 +6978,7 @@ The url to your project's issue tracker.
|
|
|
6964
6978
|
|
|
6965
6979
|
---
|
|
6966
6980
|
|
|
6967
|
-
##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@nikovirtala/projen-constructs.
|
|
6981
|
+
##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.buildWorkflow"></a>
|
|
6968
6982
|
|
|
6969
6983
|
```typescript
|
|
6970
6984
|
public readonly buildWorkflow: boolean;
|
|
@@ -6977,7 +6991,7 @@ Define a GitHub workflow for building PRs.
|
|
|
6977
6991
|
|
|
6978
6992
|
---
|
|
6979
6993
|
|
|
6980
|
-
##### `buildWorkflowOptions`<sup>Optional</sup> <a name="buildWorkflowOptions" id="@nikovirtala/projen-constructs.
|
|
6994
|
+
##### `buildWorkflowOptions`<sup>Optional</sup> <a name="buildWorkflowOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.buildWorkflowOptions"></a>
|
|
6981
6995
|
|
|
6982
6996
|
```typescript
|
|
6983
6997
|
public readonly buildWorkflowOptions: BuildWorkflowOptions;
|
|
@@ -6989,7 +7003,7 @@ Options for PR build workflow.
|
|
|
6989
7003
|
|
|
6990
7004
|
---
|
|
6991
7005
|
|
|
6992
|
-
##### `bumpPackage`<sup>Optional</sup> <a name="bumpPackage" id="@nikovirtala/projen-constructs.
|
|
7006
|
+
##### `bumpPackage`<sup>Optional</sup> <a name="bumpPackage" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bumpPackage"></a>
|
|
6993
7007
|
|
|
6994
7008
|
```typescript
|
|
6995
7009
|
public readonly bumpPackage: string;
|
|
@@ -7004,7 +7018,7 @@ This can be any compatible package version, including the deprecated `standard-v
|
|
|
7004
7018
|
|
|
7005
7019
|
---
|
|
7006
7020
|
|
|
7007
|
-
##### `bundledDeps`<sup>Optional</sup> <a name="bundledDeps" id="@nikovirtala/projen-constructs.
|
|
7021
|
+
##### `bundledDeps`<sup>Optional</sup> <a name="bundledDeps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bundledDeps"></a>
|
|
7008
7022
|
|
|
7009
7023
|
```typescript
|
|
7010
7024
|
public readonly bundledDeps: string[];
|
|
@@ -7027,7 +7041,7 @@ this will be what you `package.json` will eventually include.
|
|
|
7027
7041
|
|
|
7028
7042
|
---
|
|
7029
7043
|
|
|
7030
|
-
##### `bundlerOptions`<sup>Optional</sup> <a name="bundlerOptions" id="@nikovirtala/projen-constructs.
|
|
7044
|
+
##### `bundlerOptions`<sup>Optional</sup> <a name="bundlerOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bundlerOptions"></a>
|
|
7031
7045
|
|
|
7032
7046
|
```typescript
|
|
7033
7047
|
public readonly bundlerOptions: BundlerOptions;
|
|
@@ -7039,7 +7053,7 @@ Options for `Bundler`.
|
|
|
7039
7053
|
|
|
7040
7054
|
---
|
|
7041
7055
|
|
|
7042
|
-
##### `bunVersion`<sup>Optional</sup> <a name="bunVersion" id="@nikovirtala/projen-constructs.
|
|
7056
|
+
##### `bunVersion`<sup>Optional</sup> <a name="bunVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.bunVersion"></a>
|
|
7043
7057
|
|
|
7044
7058
|
```typescript
|
|
7045
7059
|
public readonly bunVersion: string;
|
|
@@ -7052,7 +7066,7 @@ The version of Bun to use if using Bun as a package manager.
|
|
|
7052
7066
|
|
|
7053
7067
|
---
|
|
7054
7068
|
|
|
7055
|
-
##### `catalog`<sup>Optional</sup> <a name="catalog" id="@nikovirtala/projen-constructs.
|
|
7069
|
+
##### `catalog`<sup>Optional</sup> <a name="catalog" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.catalog"></a>
|
|
7056
7070
|
|
|
7057
7071
|
```typescript
|
|
7058
7072
|
public readonly catalog: Catalog;
|
|
@@ -7074,7 +7088,7 @@ mentioned in the tweet.
|
|
|
7074
7088
|
|
|
7075
7089
|
---
|
|
7076
7090
|
|
|
7077
|
-
##### `cdkAssertions`<sup>Optional</sup> <a name="cdkAssertions" id="@nikovirtala/projen-constructs.
|
|
7091
|
+
##### `cdkAssertions`<sup>Optional</sup> <a name="cdkAssertions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.cdkAssertions"></a>
|
|
7078
7092
|
|
|
7079
7093
|
```typescript
|
|
7080
7094
|
public readonly cdkAssertions: boolean;
|
|
@@ -7090,7 +7104,7 @@ assertions is already included in 'aws-cdk-lib'
|
|
|
7090
7104
|
|
|
7091
7105
|
---
|
|
7092
7106
|
|
|
7093
|
-
##### `cdkCliVersion`<sup>Optional</sup> <a name="cdkCliVersion" id="@nikovirtala/projen-constructs.
|
|
7107
|
+
##### `cdkCliVersion`<sup>Optional</sup> <a name="cdkCliVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.cdkCliVersion"></a>
|
|
7094
7108
|
|
|
7095
7109
|
```typescript
|
|
7096
7110
|
public readonly cdkCliVersion: string;
|
|
@@ -7108,7 +7122,7 @@ option to restrict it to a specific version or version range.
|
|
|
7108
7122
|
|
|
7109
7123
|
---
|
|
7110
7124
|
|
|
7111
|
-
##### `cdkVersionPinning`<sup>Optional</sup> <a name="cdkVersionPinning" id="@nikovirtala/projen-constructs.
|
|
7125
|
+
##### `cdkVersionPinning`<sup>Optional</sup> <a name="cdkVersionPinning" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.cdkVersionPinning"></a>
|
|
7112
7126
|
|
|
7113
7127
|
```typescript
|
|
7114
7128
|
public readonly cdkVersionPinning: boolean;
|
|
@@ -7123,7 +7137,7 @@ If you use experimental features this will let you define the moment you include
|
|
|
7123
7137
|
|
|
7124
7138
|
---
|
|
7125
7139
|
|
|
7126
|
-
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="@nikovirtala/projen-constructs.
|
|
7140
|
+
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.checkLicenses"></a>
|
|
7127
7141
|
|
|
7128
7142
|
```typescript
|
|
7129
7143
|
public readonly checkLicenses: LicenseCheckerOptions;
|
|
@@ -7138,7 +7152,7 @@ This setting will cause the build to fail, if any prohibited or not allowed lice
|
|
|
7138
7152
|
|
|
7139
7153
|
---
|
|
7140
7154
|
|
|
7141
|
-
##### `clobber`<sup>Optional</sup> <a name="clobber" id="@nikovirtala/projen-constructs.
|
|
7155
|
+
##### `clobber`<sup>Optional</sup> <a name="clobber" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.clobber"></a>
|
|
7142
7156
|
|
|
7143
7157
|
```typescript
|
|
7144
7158
|
public readonly clobber: boolean;
|
|
@@ -7151,7 +7165,7 @@ Add a `clobber` task which resets the repo to origin.
|
|
|
7151
7165
|
|
|
7152
7166
|
---
|
|
7153
7167
|
|
|
7154
|
-
##### `codeArtifactOptions`<sup>Optional</sup> <a name="codeArtifactOptions" id="@nikovirtala/projen-constructs.
|
|
7168
|
+
##### `codeArtifactOptions`<sup>Optional</sup> <a name="codeArtifactOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.codeArtifactOptions"></a>
|
|
7155
7169
|
|
|
7156
7170
|
```typescript
|
|
7157
7171
|
public readonly codeArtifactOptions: CodeArtifactOptions;
|
|
@@ -7166,7 +7180,7 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
7166
7180
|
|
|
7167
7181
|
---
|
|
7168
7182
|
|
|
7169
|
-
##### `codeCov`<sup>Optional</sup> <a name="codeCov" id="@nikovirtala/projen-constructs.
|
|
7183
|
+
##### `codeCov`<sup>Optional</sup> <a name="codeCov" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.codeCov"></a>
|
|
7170
7184
|
|
|
7171
7185
|
```typescript
|
|
7172
7186
|
public readonly codeCov: boolean;
|
|
@@ -7179,7 +7193,7 @@ Define a GitHub workflow step for sending code coverage metrics to https://codec
|
|
|
7179
7193
|
|
|
7180
7194
|
---
|
|
7181
7195
|
|
|
7182
|
-
##### `codeCovTokenSecret`<sup>Optional</sup> <a name="codeCovTokenSecret" id="@nikovirtala/projen-constructs.
|
|
7196
|
+
##### `codeCovTokenSecret`<sup>Optional</sup> <a name="codeCovTokenSecret" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.codeCovTokenSecret"></a>
|
|
7183
7197
|
|
|
7184
7198
|
```typescript
|
|
7185
7199
|
public readonly codeCovTokenSecret: string;
|
|
@@ -7192,7 +7206,7 @@ Define the secret name for a specified https://codecov.io/ token.
|
|
|
7192
7206
|
|
|
7193
7207
|
---
|
|
7194
7208
|
|
|
7195
|
-
##### `commitGenerated`<sup>Optional</sup> <a name="commitGenerated" id="@nikovirtala/projen-constructs.
|
|
7209
|
+
##### `commitGenerated`<sup>Optional</sup> <a name="commitGenerated" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.commitGenerated"></a>
|
|
7196
7210
|
|
|
7197
7211
|
```typescript
|
|
7198
7212
|
public readonly commitGenerated: boolean;
|
|
@@ -7205,7 +7219,7 @@ Whether to commit the managed files by default.
|
|
|
7205
7219
|
|
|
7206
7220
|
---
|
|
7207
7221
|
|
|
7208
|
-
##### `compat`<sup>Optional</sup> <a name="compat" id="@nikovirtala/projen-constructs.
|
|
7222
|
+
##### `compat`<sup>Optional</sup> <a name="compat" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.compat"></a>
|
|
7209
7223
|
|
|
7210
7224
|
```typescript
|
|
7211
7225
|
public readonly compat: boolean;
|
|
@@ -7221,7 +7235,7 @@ You can manually run compatibility tests using `yarn compat` if this feature is
|
|
|
7221
7235
|
|
|
7222
7236
|
---
|
|
7223
7237
|
|
|
7224
|
-
##### `compatIgnore`<sup>Optional</sup> <a name="compatIgnore" id="@nikovirtala/projen-constructs.
|
|
7238
|
+
##### `compatIgnore`<sup>Optional</sup> <a name="compatIgnore" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.compatIgnore"></a>
|
|
7225
7239
|
|
|
7226
7240
|
```typescript
|
|
7227
7241
|
public readonly compatIgnore: string;
|
|
@@ -7234,7 +7248,7 @@ Name of the ignore file for API compatibility tests.
|
|
|
7234
7248
|
|
|
7235
7249
|
---
|
|
7236
7250
|
|
|
7237
|
-
##### `compressAssembly`<sup>Optional</sup> <a name="compressAssembly" id="@nikovirtala/projen-constructs.
|
|
7251
|
+
##### `compressAssembly`<sup>Optional</sup> <a name="compressAssembly" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.compressAssembly"></a>
|
|
7238
7252
|
|
|
7239
7253
|
```typescript
|
|
7240
7254
|
public readonly compressAssembly: boolean;
|
|
@@ -7247,7 +7261,7 @@ Emit a compressed version of the assembly.
|
|
|
7247
7261
|
|
|
7248
7262
|
---
|
|
7249
7263
|
|
|
7250
|
-
##### `constructsVersion`<sup>Optional</sup> <a name="constructsVersion" id="@nikovirtala/projen-constructs.
|
|
7264
|
+
##### `constructsVersion`<sup>Optional</sup> <a name="constructsVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.constructsVersion"></a>
|
|
7251
7265
|
|
|
7252
7266
|
```typescript
|
|
7253
7267
|
public readonly constructsVersion: string;
|
|
@@ -7260,7 +7274,7 @@ Minimum version of the `constructs` library to depend on.
|
|
|
7260
7274
|
|
|
7261
7275
|
---
|
|
7262
7276
|
|
|
7263
|
-
##### `copyrightOwner`<sup>Optional</sup> <a name="copyrightOwner" id="@nikovirtala/projen-constructs.
|
|
7277
|
+
##### `copyrightOwner`<sup>Optional</sup> <a name="copyrightOwner" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.copyrightOwner"></a>
|
|
7264
7278
|
|
|
7265
7279
|
```typescript
|
|
7266
7280
|
public readonly copyrightOwner: string;
|
|
@@ -7273,7 +7287,7 @@ License copyright owner.
|
|
|
7273
7287
|
|
|
7274
7288
|
---
|
|
7275
7289
|
|
|
7276
|
-
##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="@nikovirtala/projen-constructs.
|
|
7290
|
+
##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.copyrightPeriod"></a>
|
|
7277
7291
|
|
|
7278
7292
|
```typescript
|
|
7279
7293
|
public readonly copyrightPeriod: string;
|
|
@@ -7286,7 +7300,7 @@ The copyright years to put in the LICENSE file.
|
|
|
7286
7300
|
|
|
7287
7301
|
---
|
|
7288
7302
|
|
|
7289
|
-
##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="@nikovirtala/projen-constructs.
|
|
7303
|
+
##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.dependabot"></a>
|
|
7290
7304
|
|
|
7291
7305
|
```typescript
|
|
7292
7306
|
public readonly dependabot: boolean;
|
|
@@ -7301,7 +7315,7 @@ Cannot be used in conjunction with `depsUpgrade`.
|
|
|
7301
7315
|
|
|
7302
7316
|
---
|
|
7303
7317
|
|
|
7304
|
-
##### `dependabotOptions`<sup>Optional</sup> <a name="dependabotOptions" id="@nikovirtala/projen-constructs.
|
|
7318
|
+
##### `dependabotOptions`<sup>Optional</sup> <a name="dependabotOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.dependabotOptions"></a>
|
|
7305
7319
|
|
|
7306
7320
|
```typescript
|
|
7307
7321
|
public readonly dependabotOptions: DependabotOptions;
|
|
@@ -7314,7 +7328,7 @@ Options for dependabot.
|
|
|
7314
7328
|
|
|
7315
7329
|
---
|
|
7316
7330
|
|
|
7317
|
-
##### `deps`<sup>Optional</sup> <a name="deps" id="@nikovirtala/projen-constructs.
|
|
7331
|
+
##### `deps`<sup>Optional</sup> <a name="deps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.deps"></a>
|
|
7318
7332
|
|
|
7319
7333
|
```typescript
|
|
7320
7334
|
public readonly deps: string[];
|
|
@@ -7334,7 +7348,7 @@ this will be what you `package.json` will eventually include.
|
|
|
7334
7348
|
|
|
7335
7349
|
---
|
|
7336
7350
|
|
|
7337
|
-
##### `depsUpgrade`<sup>Optional</sup> <a name="depsUpgrade" id="@nikovirtala/projen-constructs.
|
|
7351
|
+
##### `depsUpgrade`<sup>Optional</sup> <a name="depsUpgrade" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.depsUpgrade"></a>
|
|
7338
7352
|
|
|
7339
7353
|
```typescript
|
|
7340
7354
|
public readonly depsUpgrade: boolean;
|
|
@@ -7349,7 +7363,7 @@ Cannot be used in conjunction with `dependabot`.
|
|
|
7349
7363
|
|
|
7350
7364
|
---
|
|
7351
7365
|
|
|
7352
|
-
##### `depsUpgradeOptions`<sup>Optional</sup> <a name="depsUpgradeOptions" id="@nikovirtala/projen-constructs.
|
|
7366
|
+
##### `depsUpgradeOptions`<sup>Optional</sup> <a name="depsUpgradeOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.depsUpgradeOptions"></a>
|
|
7353
7367
|
|
|
7354
7368
|
```typescript
|
|
7355
7369
|
public readonly depsUpgradeOptions: UpgradeDependenciesOptions;
|
|
@@ -7362,7 +7376,7 @@ Options for `UpgradeDependencies`.
|
|
|
7362
7376
|
|
|
7363
7377
|
---
|
|
7364
7378
|
|
|
7365
|
-
##### `description`<sup>Optional</sup> <a name="description" id="@nikovirtala/projen-constructs.
|
|
7379
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.description"></a>
|
|
7366
7380
|
|
|
7367
7381
|
```typescript
|
|
7368
7382
|
public readonly description: string;
|
|
@@ -7377,7 +7391,7 @@ See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
|
|
|
7377
7391
|
|
|
7378
7392
|
---
|
|
7379
7393
|
|
|
7380
|
-
##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@nikovirtala/projen-constructs.
|
|
7394
|
+
##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.devContainer"></a>
|
|
7381
7395
|
|
|
7382
7396
|
```typescript
|
|
7383
7397
|
public readonly devContainer: boolean;
|
|
@@ -7390,7 +7404,7 @@ Add a VSCode development environment (used for GitHub Codespaces).
|
|
|
7390
7404
|
|
|
7391
7405
|
---
|
|
7392
7406
|
|
|
7393
|
-
##### `devDeps`<sup>Optional</sup> <a name="devDeps" id="@nikovirtala/projen-constructs.
|
|
7407
|
+
##### `devDeps`<sup>Optional</sup> <a name="devDeps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.devDeps"></a>
|
|
7394
7408
|
|
|
7395
7409
|
```typescript
|
|
7396
7410
|
public readonly devDeps: string[];
|
|
@@ -7414,7 +7428,7 @@ this will be what you `package.json` will eventually include.
|
|
|
7414
7428
|
|
|
7415
7429
|
---
|
|
7416
7430
|
|
|
7417
|
-
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="@nikovirtala/projen-constructs.
|
|
7431
|
+
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.disableTsconfig"></a>
|
|
7418
7432
|
|
|
7419
7433
|
```typescript
|
|
7420
7434
|
public readonly disableTsconfig: boolean;
|
|
@@ -7427,7 +7441,7 @@ Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.jso
|
|
|
7427
7441
|
|
|
7428
7442
|
---
|
|
7429
7443
|
|
|
7430
|
-
##### `disableTsconfigDev`<sup>Optional</sup> <a name="disableTsconfigDev" id="@nikovirtala/projen-constructs.
|
|
7444
|
+
##### `disableTsconfigDev`<sup>Optional</sup> <a name="disableTsconfigDev" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.disableTsconfigDev"></a>
|
|
7431
7445
|
|
|
7432
7446
|
```typescript
|
|
7433
7447
|
public readonly disableTsconfigDev: boolean;
|
|
@@ -7440,7 +7454,7 @@ Do not generate a `tsconfig.dev.json` file.
|
|
|
7440
7454
|
|
|
7441
7455
|
---
|
|
7442
7456
|
|
|
7443
|
-
##### `docgen`<sup>Optional</sup> <a name="docgen" id="@nikovirtala/projen-constructs.
|
|
7457
|
+
##### `docgen`<sup>Optional</sup> <a name="docgen" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.docgen"></a>
|
|
7444
7458
|
|
|
7445
7459
|
```typescript
|
|
7446
7460
|
public readonly docgen: boolean;
|
|
@@ -7453,7 +7467,7 @@ Docgen by Typedoc.
|
|
|
7453
7467
|
|
|
7454
7468
|
---
|
|
7455
7469
|
|
|
7456
|
-
##### `docgenFilePath`<sup>Optional</sup> <a name="docgenFilePath" id="@nikovirtala/projen-constructs.
|
|
7470
|
+
##### `docgenFilePath`<sup>Optional</sup> <a name="docgenFilePath" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.docgenFilePath"></a>
|
|
7457
7471
|
|
|
7458
7472
|
```typescript
|
|
7459
7473
|
public readonly docgenFilePath: string;
|
|
@@ -7466,7 +7480,7 @@ File path for generated docs.
|
|
|
7466
7480
|
|
|
7467
7481
|
---
|
|
7468
7482
|
|
|
7469
|
-
##### `docsDirectory`<sup>Optional</sup> <a name="docsDirectory" id="@nikovirtala/projen-constructs.
|
|
7483
|
+
##### `docsDirectory`<sup>Optional</sup> <a name="docsDirectory" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.docsDirectory"></a>
|
|
7470
7484
|
|
|
7471
7485
|
```typescript
|
|
7472
7486
|
public readonly docsDirectory: string;
|
|
@@ -7479,7 +7493,7 @@ Docs directory.
|
|
|
7479
7493
|
|
|
7480
7494
|
---
|
|
7481
7495
|
|
|
7482
|
-
##### `edgeLambdaAutoDiscover`<sup>Optional</sup> <a name="edgeLambdaAutoDiscover" id="@nikovirtala/projen-constructs.
|
|
7496
|
+
##### `edgeLambdaAutoDiscover`<sup>Optional</sup> <a name="edgeLambdaAutoDiscover" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.edgeLambdaAutoDiscover"></a>
|
|
7483
7497
|
|
|
7484
7498
|
```typescript
|
|
7485
7499
|
public readonly edgeLambdaAutoDiscover: boolean;
|
|
@@ -7492,7 +7506,7 @@ Automatically adds an `cloudfront.experimental.EdgeFunction` for each `.edge-lam
|
|
|
7492
7506
|
|
|
7493
7507
|
---
|
|
7494
7508
|
|
|
7495
|
-
##### `entrypoint`<sup>Optional</sup> <a name="entrypoint" id="@nikovirtala/projen-constructs.
|
|
7509
|
+
##### `entrypoint`<sup>Optional</sup> <a name="entrypoint" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.entrypoint"></a>
|
|
7496
7510
|
|
|
7497
7511
|
```typescript
|
|
7498
7512
|
public readonly entrypoint: string;
|
|
@@ -7505,7 +7519,7 @@ Module entrypoint (`main` in `package.json`). Set to an empty string to not incl
|
|
|
7505
7519
|
|
|
7506
7520
|
---
|
|
7507
7521
|
|
|
7508
|
-
##### `entrypointTypes`<sup>Optional</sup> <a name="entrypointTypes" id="@nikovirtala/projen-constructs.
|
|
7522
|
+
##### `entrypointTypes`<sup>Optional</sup> <a name="entrypointTypes" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.entrypointTypes"></a>
|
|
7509
7523
|
|
|
7510
7524
|
```typescript
|
|
7511
7525
|
public readonly entrypointTypes: string;
|
|
@@ -7518,7 +7532,7 @@ The .d.ts file that includes the type declarations for this module.
|
|
|
7518
7532
|
|
|
7519
7533
|
---
|
|
7520
7534
|
|
|
7521
|
-
##### `excludeTypescript`<sup>Optional</sup> <a name="excludeTypescript" id="@nikovirtala/projen-constructs.
|
|
7535
|
+
##### `excludeTypescript`<sup>Optional</sup> <a name="excludeTypescript" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.excludeTypescript"></a>
|
|
7522
7536
|
|
|
7523
7537
|
```typescript
|
|
7524
7538
|
public readonly excludeTypescript: string[];
|
|
@@ -7534,7 +7548,7 @@ that cannot be compiled with jsii's compiler settings.
|
|
|
7534
7548
|
|
|
7535
7549
|
---
|
|
7536
7550
|
|
|
7537
|
-
##### `experimentalIntegRunner`<sup>Optional</sup> <a name="experimentalIntegRunner" id="@nikovirtala/projen-constructs.
|
|
7551
|
+
##### `experimentalIntegRunner`<sup>Optional</sup> <a name="experimentalIntegRunner" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.experimentalIntegRunner"></a>
|
|
7538
7552
|
|
|
7539
7553
|
```typescript
|
|
7540
7554
|
public readonly experimentalIntegRunner: boolean;
|
|
@@ -7547,7 +7561,7 @@ Enable experimental support for the AWS CDK integ-runner.
|
|
|
7547
7561
|
|
|
7548
7562
|
---
|
|
7549
7563
|
|
|
7550
|
-
##### `github`<sup>Optional</sup> <a name="github" id="@nikovirtala/projen-constructs.
|
|
7564
|
+
##### `github`<sup>Optional</sup> <a name="github" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.github"></a>
|
|
7551
7565
|
|
|
7552
7566
|
```typescript
|
|
7553
7567
|
public readonly github: boolean;
|
|
@@ -7562,7 +7576,7 @@ Enabled by default for root projects. Disabled for non-root projects.
|
|
|
7562
7576
|
|
|
7563
7577
|
---
|
|
7564
7578
|
|
|
7565
|
-
##### `githubOptions`<sup>Optional</sup> <a name="githubOptions" id="@nikovirtala/projen-constructs.
|
|
7579
|
+
##### `githubOptions`<sup>Optional</sup> <a name="githubOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.githubOptions"></a>
|
|
7566
7580
|
|
|
7567
7581
|
```typescript
|
|
7568
7582
|
public readonly githubOptions: GitHubOptions;
|
|
@@ -7575,7 +7589,7 @@ Options for GitHub integration.
|
|
|
7575
7589
|
|
|
7576
7590
|
---
|
|
7577
7591
|
|
|
7578
|
-
##### `gitignore`<sup>Optional</sup> <a name="gitignore" id="@nikovirtala/projen-constructs.
|
|
7592
|
+
##### `gitignore`<sup>Optional</sup> <a name="gitignore" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.gitignore"></a>
|
|
7579
7593
|
|
|
7580
7594
|
```typescript
|
|
7581
7595
|
public readonly gitignore: string[];
|
|
@@ -7587,7 +7601,7 @@ Additional entries to .gitignore.
|
|
|
7587
7601
|
|
|
7588
7602
|
---
|
|
7589
7603
|
|
|
7590
|
-
##### `gitIgnoreOptions`<sup>Optional</sup> <a name="gitIgnoreOptions" id="@nikovirtala/projen-constructs.
|
|
7604
|
+
##### `gitIgnoreOptions`<sup>Optional</sup> <a name="gitIgnoreOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.gitIgnoreOptions"></a>
|
|
7591
7605
|
|
|
7592
7606
|
```typescript
|
|
7593
7607
|
public readonly gitIgnoreOptions: IgnoreFileOptions;
|
|
@@ -7599,7 +7613,7 @@ Configuration options for .gitignore file.
|
|
|
7599
7613
|
|
|
7600
7614
|
---
|
|
7601
7615
|
|
|
7602
|
-
##### `gitOptions`<sup>Optional</sup> <a name="gitOptions" id="@nikovirtala/projen-constructs.
|
|
7616
|
+
##### `gitOptions`<sup>Optional</sup> <a name="gitOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.gitOptions"></a>
|
|
7603
7617
|
|
|
7604
7618
|
```typescript
|
|
7605
7619
|
public readonly gitOptions: GitOptions;
|
|
@@ -7611,7 +7625,7 @@ Configuration options for git.
|
|
|
7611
7625
|
|
|
7612
7626
|
---
|
|
7613
7627
|
|
|
7614
|
-
##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@nikovirtala/projen-constructs.
|
|
7628
|
+
##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.gitpod"></a>
|
|
7615
7629
|
|
|
7616
7630
|
```typescript
|
|
7617
7631
|
public readonly gitpod: boolean;
|
|
@@ -7624,7 +7638,7 @@ Add a Gitpod development environment.
|
|
|
7624
7638
|
|
|
7625
7639
|
---
|
|
7626
7640
|
|
|
7627
|
-
##### `homepage`<sup>Optional</sup> <a name="homepage" id="@nikovirtala/projen-constructs.
|
|
7641
|
+
##### `homepage`<sup>Optional</sup> <a name="homepage" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.homepage"></a>
|
|
7628
7642
|
|
|
7629
7643
|
```typescript
|
|
7630
7644
|
public readonly homepage: string;
|
|
@@ -7636,7 +7650,7 @@ Package's Homepage / Website.
|
|
|
7636
7650
|
|
|
7637
7651
|
---
|
|
7638
7652
|
|
|
7639
|
-
##### `integrationTestAutoDiscover`<sup>Optional</sup> <a name="integrationTestAutoDiscover" id="@nikovirtala/projen-constructs.
|
|
7653
|
+
##### `integrationTestAutoDiscover`<sup>Optional</sup> <a name="integrationTestAutoDiscover" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.integrationTestAutoDiscover"></a>
|
|
7640
7654
|
|
|
7641
7655
|
```typescript
|
|
7642
7656
|
public readonly integrationTestAutoDiscover: boolean;
|
|
@@ -7649,7 +7663,7 @@ Automatically discovers and creates integration tests for each `.integ.ts` file
|
|
|
7649
7663
|
|
|
7650
7664
|
---
|
|
7651
7665
|
|
|
7652
|
-
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="@nikovirtala/projen-constructs.
|
|
7666
|
+
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.jsiiReleaseVersion"></a>
|
|
7653
7667
|
|
|
7654
7668
|
```typescript
|
|
7655
7669
|
public readonly jsiiReleaseVersion: string;
|
|
@@ -7662,7 +7676,7 @@ Version requirement of `publib` which is used to publish modules to npm.
|
|
|
7662
7676
|
|
|
7663
7677
|
---
|
|
7664
7678
|
|
|
7665
|
-
##### `jsiiVersion`<sup>Optional</sup> <a name="jsiiVersion" id="@nikovirtala/projen-constructs.
|
|
7679
|
+
##### `jsiiVersion`<sup>Optional</sup> <a name="jsiiVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.jsiiVersion"></a>
|
|
7666
7680
|
|
|
7667
7681
|
```typescript
|
|
7668
7682
|
public readonly jsiiVersion: string;
|
|
@@ -7682,7 +7696,7 @@ and should remain on the same minor, so we recommend using a `~` dependency
|
|
|
7682
7696
|
|
|
7683
7697
|
---
|
|
7684
7698
|
|
|
7685
|
-
##### `keywords`<sup>Optional</sup> <a name="keywords" id="@nikovirtala/projen-constructs.
|
|
7699
|
+
##### `keywords`<sup>Optional</sup> <a name="keywords" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.keywords"></a>
|
|
7686
7700
|
|
|
7687
7701
|
```typescript
|
|
7688
7702
|
public readonly keywords: string[];
|
|
@@ -7694,7 +7708,7 @@ Keywords to include in `package.json`.
|
|
|
7694
7708
|
|
|
7695
7709
|
---
|
|
7696
7710
|
|
|
7697
|
-
##### `lambdaAutoDiscover`<sup>Optional</sup> <a name="lambdaAutoDiscover" id="@nikovirtala/projen-constructs.
|
|
7711
|
+
##### `lambdaAutoDiscover`<sup>Optional</sup> <a name="lambdaAutoDiscover" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.lambdaAutoDiscover"></a>
|
|
7698
7712
|
|
|
7699
7713
|
```typescript
|
|
7700
7714
|
public readonly lambdaAutoDiscover: boolean;
|
|
@@ -7707,7 +7721,7 @@ Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in you
|
|
|
7707
7721
|
|
|
7708
7722
|
---
|
|
7709
7723
|
|
|
7710
|
-
##### `lambdaExtensionAutoDiscover`<sup>Optional</sup> <a name="lambdaExtensionAutoDiscover" id="@nikovirtala/projen-constructs.
|
|
7724
|
+
##### `lambdaExtensionAutoDiscover`<sup>Optional</sup> <a name="lambdaExtensionAutoDiscover" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.lambdaExtensionAutoDiscover"></a>
|
|
7711
7725
|
|
|
7712
7726
|
```typescript
|
|
7713
7727
|
public readonly lambdaExtensionAutoDiscover: boolean;
|
|
@@ -7720,7 +7734,7 @@ Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` e
|
|
|
7720
7734
|
|
|
7721
7735
|
---
|
|
7722
7736
|
|
|
7723
|
-
##### `lambdaOptions`<sup>Optional</sup> <a name="lambdaOptions" id="@nikovirtala/projen-constructs.
|
|
7737
|
+
##### `lambdaOptions`<sup>Optional</sup> <a name="lambdaOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.lambdaOptions"></a>
|
|
7724
7738
|
|
|
7725
7739
|
```typescript
|
|
7726
7740
|
public readonly lambdaOptions: LambdaFunctionCommonOptions;
|
|
@@ -7733,7 +7747,7 @@ Common options for all AWS Lambda functions.
|
|
|
7733
7747
|
|
|
7734
7748
|
---
|
|
7735
7749
|
|
|
7736
|
-
##### `libdir`<sup>Optional</sup> <a name="libdir" id="@nikovirtala/projen-constructs.
|
|
7750
|
+
##### `libdir`<sup>Optional</sup> <a name="libdir" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.libdir"></a>
|
|
7737
7751
|
|
|
7738
7752
|
```typescript
|
|
7739
7753
|
public readonly libdir: string;
|
|
@@ -7746,7 +7760,7 @@ Typescript artifacts output directory.
|
|
|
7746
7760
|
|
|
7747
7761
|
---
|
|
7748
7762
|
|
|
7749
|
-
##### `license`<sup>Optional</sup> <a name="license" id="@nikovirtala/projen-constructs.
|
|
7763
|
+
##### `license`<sup>Optional</sup> <a name="license" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.license"></a>
|
|
7750
7764
|
|
|
7751
7765
|
```typescript
|
|
7752
7766
|
public readonly license: string;
|
|
@@ -7762,7 +7776,7 @@ Use the `licensed` option if you want to no license to be specified.
|
|
|
7762
7776
|
|
|
7763
7777
|
---
|
|
7764
7778
|
|
|
7765
|
-
##### `licensed`<sup>Optional</sup> <a name="licensed" id="@nikovirtala/projen-constructs.
|
|
7779
|
+
##### `licensed`<sup>Optional</sup> <a name="licensed" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.licensed"></a>
|
|
7766
7780
|
|
|
7767
7781
|
```typescript
|
|
7768
7782
|
public readonly licensed: boolean;
|
|
@@ -7775,7 +7789,7 @@ Indicates if a license should be added.
|
|
|
7775
7789
|
|
|
7776
7790
|
---
|
|
7777
7791
|
|
|
7778
|
-
##### `logging`<sup>Optional</sup> <a name="logging" id="@nikovirtala/projen-constructs.
|
|
7792
|
+
##### `logging`<sup>Optional</sup> <a name="logging" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.logging"></a>
|
|
7779
7793
|
|
|
7780
7794
|
```typescript
|
|
7781
7795
|
public readonly logging: LoggerOptions;
|
|
@@ -7788,7 +7802,7 @@ Configure logging options such as verbosity.
|
|
|
7788
7802
|
|
|
7789
7803
|
---
|
|
7790
7804
|
|
|
7791
|
-
##### `majorVersion`<sup>Optional</sup> <a name="majorVersion" id="@nikovirtala/projen-constructs.
|
|
7805
|
+
##### `majorVersion`<sup>Optional</sup> <a name="majorVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.majorVersion"></a>
|
|
7792
7806
|
|
|
7793
7807
|
```typescript
|
|
7794
7808
|
public readonly majorVersion: number;
|
|
@@ -7804,7 +7818,7 @@ If not specified, we bump the global latest version.
|
|
|
7804
7818
|
|
|
7805
7819
|
---
|
|
7806
7820
|
|
|
7807
|
-
##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@nikovirtala/projen-constructs.
|
|
7821
|
+
##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.maxNodeVersion"></a>
|
|
7808
7822
|
|
|
7809
7823
|
```typescript
|
|
7810
7824
|
public readonly maxNodeVersion: string;
|
|
@@ -7824,7 +7838,7 @@ Consider this option only if your package is known to not function with newer ve
|
|
|
7824
7838
|
|
|
7825
7839
|
---
|
|
7826
7840
|
|
|
7827
|
-
##### `minMajorVersion`<sup>Optional</sup> <a name="minMajorVersion" id="@nikovirtala/projen-constructs.
|
|
7841
|
+
##### `minMajorVersion`<sup>Optional</sup> <a name="minMajorVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.minMajorVersion"></a>
|
|
7828
7842
|
|
|
7829
7843
|
```typescript
|
|
7830
7844
|
public readonly minMajorVersion: number;
|
|
@@ -7842,7 +7856,7 @@ Can not be set together with `majorVersion`.
|
|
|
7842
7856
|
|
|
7843
7857
|
---
|
|
7844
7858
|
|
|
7845
|
-
##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@nikovirtala/projen-constructs.
|
|
7859
|
+
##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.minNodeVersion"></a>
|
|
7846
7860
|
|
|
7847
7861
|
```typescript
|
|
7848
7862
|
public readonly minNodeVersion: string;
|
|
@@ -7866,7 +7880,7 @@ To change the node version of your CI/CD workflows, use `workflowNodeVersion`.
|
|
|
7866
7880
|
|
|
7867
7881
|
---
|
|
7868
7882
|
|
|
7869
|
-
##### `mise`<sup>Optional</sup> <a name="mise" id="@nikovirtala/projen-constructs.
|
|
7883
|
+
##### `mise`<sup>Optional</sup> <a name="mise" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.mise"></a>
|
|
7870
7884
|
|
|
7871
7885
|
```typescript
|
|
7872
7886
|
public readonly mise: boolean;
|
|
@@ -7879,7 +7893,7 @@ Create mise.toml with project Node.js version.
|
|
|
7879
7893
|
|
|
7880
7894
|
---
|
|
7881
7895
|
|
|
7882
|
-
##### `nextVersionCommand`<sup>Optional</sup> <a name="nextVersionCommand" id="@nikovirtala/projen-constructs.
|
|
7896
|
+
##### `nextVersionCommand`<sup>Optional</sup> <a name="nextVersionCommand" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.nextVersionCommand"></a>
|
|
7883
7897
|
|
|
7884
7898
|
```typescript
|
|
7885
7899
|
public readonly nextVersionCommand: string;
|
|
@@ -7911,7 +7925,7 @@ script can be used to achieve the effects of `minMajorVersion`.
|
|
|
7911
7925
|
|
|
7912
7926
|
---
|
|
7913
7927
|
|
|
7914
|
-
##### `npmAccess`<sup>Optional</sup> <a name="npmAccess" id="@nikovirtala/projen-constructs.
|
|
7928
|
+
##### `npmAccess`<sup>Optional</sup> <a name="npmAccess" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmAccess"></a>
|
|
7915
7929
|
|
|
7916
7930
|
```typescript
|
|
7917
7931
|
public readonly npmAccess: NpmAccess;
|
|
@@ -7924,7 +7938,7 @@ Access level of the npm package.
|
|
|
7924
7938
|
|
|
7925
7939
|
---
|
|
7926
7940
|
|
|
7927
|
-
##### `npmDistTag`<sup>Optional</sup> <a name="npmDistTag" id="@nikovirtala/projen-constructs.
|
|
7941
|
+
##### `npmDistTag`<sup>Optional</sup> <a name="npmDistTag" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmDistTag"></a>
|
|
7928
7942
|
|
|
7929
7943
|
```typescript
|
|
7930
7944
|
public readonly npmDistTag: string;
|
|
@@ -7940,7 +7954,7 @@ for each branch.
|
|
|
7940
7954
|
|
|
7941
7955
|
---
|
|
7942
7956
|
|
|
7943
|
-
##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="@nikovirtala/projen-constructs.
|
|
7957
|
+
##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmignoreEnabled"></a>
|
|
7944
7958
|
|
|
7945
7959
|
```typescript
|
|
7946
7960
|
public readonly npmignoreEnabled: boolean;
|
|
@@ -7953,7 +7967,7 @@ Defines an .npmignore file. Normally this is only needed for libraries that are
|
|
|
7953
7967
|
|
|
7954
7968
|
---
|
|
7955
7969
|
|
|
7956
|
-
##### `npmIgnoreOptions`<sup>Optional</sup> <a name="npmIgnoreOptions" id="@nikovirtala/projen-constructs.
|
|
7970
|
+
##### `npmIgnoreOptions`<sup>Optional</sup> <a name="npmIgnoreOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmIgnoreOptions"></a>
|
|
7957
7971
|
|
|
7958
7972
|
```typescript
|
|
7959
7973
|
public readonly npmIgnoreOptions: IgnoreFileOptions;
|
|
@@ -7965,7 +7979,7 @@ Configuration options for .npmignore file.
|
|
|
7965
7979
|
|
|
7966
7980
|
---
|
|
7967
7981
|
|
|
7968
|
-
##### `npmProvenance`<sup>Optional</sup> <a name="npmProvenance" id="@nikovirtala/projen-constructs.
|
|
7982
|
+
##### `npmProvenance`<sup>Optional</sup> <a name="npmProvenance" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmProvenance"></a>
|
|
7969
7983
|
|
|
7970
7984
|
```typescript
|
|
7971
7985
|
public readonly npmProvenance: boolean;
|
|
@@ -7984,7 +7998,7 @@ which is using npm internally and supports provenance statements independently o
|
|
|
7984
7998
|
|
|
7985
7999
|
---
|
|
7986
8000
|
|
|
7987
|
-
##### `npmRegistryUrl`<sup>Optional</sup> <a name="npmRegistryUrl" id="@nikovirtala/projen-constructs.
|
|
8001
|
+
##### `npmRegistryUrl`<sup>Optional</sup> <a name="npmRegistryUrl" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmRegistryUrl"></a>
|
|
7988
8002
|
|
|
7989
8003
|
```typescript
|
|
7990
8004
|
public readonly npmRegistryUrl: string;
|
|
@@ -7999,7 +8013,7 @@ Must be a URL (e.g. start with "https://" or "http://")
|
|
|
7999
8013
|
|
|
8000
8014
|
---
|
|
8001
8015
|
|
|
8002
|
-
##### `npmTokenSecret`<sup>Optional</sup> <a name="npmTokenSecret" id="@nikovirtala/projen-constructs.
|
|
8016
|
+
##### `npmTokenSecret`<sup>Optional</sup> <a name="npmTokenSecret" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmTokenSecret"></a>
|
|
8003
8017
|
|
|
8004
8018
|
```typescript
|
|
8005
8019
|
public readonly npmTokenSecret: string;
|
|
@@ -8012,7 +8026,7 @@ GitHub secret which contains the NPM token to use when publishing packages.
|
|
|
8012
8026
|
|
|
8013
8027
|
---
|
|
8014
8028
|
|
|
8015
|
-
##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="@nikovirtala/projen-constructs.
|
|
8029
|
+
##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.npmTrustedPublishing"></a>
|
|
8016
8030
|
|
|
8017
8031
|
```typescript
|
|
8018
8032
|
public readonly npmTrustedPublishing: boolean;
|
|
@@ -8025,7 +8039,7 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
|
|
|
8025
8039
|
|
|
8026
8040
|
---
|
|
8027
8041
|
|
|
8028
|
-
##### `outdir`<sup>Optional</sup> <a name="outdir" id="@nikovirtala/projen-constructs.
|
|
8042
|
+
##### `outdir`<sup>Optional</sup> <a name="outdir" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.outdir"></a>
|
|
8029
8043
|
|
|
8030
8044
|
```typescript
|
|
8031
8045
|
public readonly outdir: string;
|
|
@@ -8042,7 +8056,7 @@ subprojects.
|
|
|
8042
8056
|
|
|
8043
8057
|
---
|
|
8044
8058
|
|
|
8045
|
-
##### `package`<sup>Optional</sup> <a name="package" id="@nikovirtala/projen-constructs.
|
|
8059
|
+
##### `package`<sup>Optional</sup> <a name="package" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.package"></a>
|
|
8046
8060
|
|
|
8047
8061
|
```typescript
|
|
8048
8062
|
public readonly package: boolean;
|
|
@@ -8055,7 +8069,7 @@ Defines a `package` task that will produce an npm tarball under the artifacts di
|
|
|
8055
8069
|
|
|
8056
8070
|
---
|
|
8057
8071
|
|
|
8058
|
-
##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@nikovirtala/projen-constructs.
|
|
8072
|
+
##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.packageManager"></a>
|
|
8059
8073
|
|
|
8060
8074
|
```typescript
|
|
8061
8075
|
public readonly packageManager: NodePackageManager;
|
|
@@ -8068,7 +8082,7 @@ The Node Package Manager used to execute scripts.
|
|
|
8068
8082
|
|
|
8069
8083
|
---
|
|
8070
8084
|
|
|
8071
|
-
##### `packageName`<sup>Optional</sup> <a name="packageName" id="@nikovirtala/projen-constructs.
|
|
8085
|
+
##### `packageName`<sup>Optional</sup> <a name="packageName" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.packageName"></a>
|
|
8072
8086
|
|
|
8073
8087
|
```typescript
|
|
8074
8088
|
public readonly packageName: string;
|
|
@@ -8081,7 +8095,7 @@ The "name" in package.json.
|
|
|
8081
8095
|
|
|
8082
8096
|
---
|
|
8083
8097
|
|
|
8084
|
-
##### `parent`<sup>Optional</sup> <a name="parent" id="@nikovirtala/projen-constructs.
|
|
8098
|
+
##### `parent`<sup>Optional</sup> <a name="parent" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.parent"></a>
|
|
8085
8099
|
|
|
8086
8100
|
```typescript
|
|
8087
8101
|
public readonly parent: Project;
|
|
@@ -8093,7 +8107,7 @@ The parent project, if this project is part of a bigger project.
|
|
|
8093
8107
|
|
|
8094
8108
|
---
|
|
8095
8109
|
|
|
8096
|
-
##### `peerDependencyOptions`<sup>Optional</sup> <a name="peerDependencyOptions" id="@nikovirtala/projen-constructs.
|
|
8110
|
+
##### `peerDependencyOptions`<sup>Optional</sup> <a name="peerDependencyOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.peerDependencyOptions"></a>
|
|
8097
8111
|
|
|
8098
8112
|
```typescript
|
|
8099
8113
|
public readonly peerDependencyOptions: PeerDependencyOptions;
|
|
@@ -8105,7 +8119,7 @@ Options for `peerDeps`.
|
|
|
8105
8119
|
|
|
8106
8120
|
---
|
|
8107
8121
|
|
|
8108
|
-
##### `peerDeps`<sup>Optional</sup> <a name="peerDeps" id="@nikovirtala/projen-constructs.
|
|
8122
|
+
##### `peerDeps`<sup>Optional</sup> <a name="peerDeps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.peerDeps"></a>
|
|
8109
8123
|
|
|
8110
8124
|
```typescript
|
|
8111
8125
|
public readonly peerDeps: string[];
|
|
@@ -8132,7 +8146,7 @@ test your module against the lowest peer version required.
|
|
|
8132
8146
|
|
|
8133
8147
|
---
|
|
8134
8148
|
|
|
8135
|
-
##### `pnpmVersion`<sup>Optional</sup> <a name="pnpmVersion" id="@nikovirtala/projen-constructs.
|
|
8149
|
+
##### `pnpmVersion`<sup>Optional</sup> <a name="pnpmVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.pnpmVersion"></a>
|
|
8136
8150
|
|
|
8137
8151
|
```typescript
|
|
8138
8152
|
public readonly pnpmVersion: string;
|
|
@@ -8145,7 +8159,7 @@ The version of PNPM to use if using PNPM as a package manager.
|
|
|
8145
8159
|
|
|
8146
8160
|
---
|
|
8147
8161
|
|
|
8148
|
-
##### `postBuildSteps`<sup>Optional</sup> <a name="postBuildSteps" id="@nikovirtala/projen-constructs.
|
|
8162
|
+
##### `postBuildSteps`<sup>Optional</sup> <a name="postBuildSteps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.postBuildSteps"></a>
|
|
8149
8163
|
|
|
8150
8164
|
```typescript
|
|
8151
8165
|
public readonly postBuildSteps: JobStep[];
|
|
@@ -8158,7 +8172,7 @@ Steps to execute after build as part of the release workflow.
|
|
|
8158
8172
|
|
|
8159
8173
|
---
|
|
8160
8174
|
|
|
8161
|
-
##### `prerelease`<sup>Optional</sup> <a name="prerelease" id="@nikovirtala/projen-constructs.
|
|
8175
|
+
##### `prerelease`<sup>Optional</sup> <a name="prerelease" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.prerelease"></a>
|
|
8162
8176
|
|
|
8163
8177
|
```typescript
|
|
8164
8178
|
public readonly prerelease: string;
|
|
@@ -8171,7 +8185,7 @@ Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pr
|
|
|
8171
8185
|
|
|
8172
8186
|
---
|
|
8173
8187
|
|
|
8174
|
-
##### `projenCommand`<sup>Optional</sup> <a name="projenCommand" id="@nikovirtala/projen-constructs.
|
|
8188
|
+
##### `projenCommand`<sup>Optional</sup> <a name="projenCommand" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenCommand"></a>
|
|
8175
8189
|
|
|
8176
8190
|
```typescript
|
|
8177
8191
|
public readonly projenCommand: string;
|
|
@@ -8186,7 +8200,7 @@ Can be used to customize in special environments.
|
|
|
8186
8200
|
|
|
8187
8201
|
---
|
|
8188
8202
|
|
|
8189
|
-
##### `projenCredentials`<sup>Optional</sup> <a name="projenCredentials" id="@nikovirtala/projen-constructs.
|
|
8203
|
+
##### `projenCredentials`<sup>Optional</sup> <a name="projenCredentials" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenCredentials"></a>
|
|
8190
8204
|
|
|
8191
8205
|
```typescript
|
|
8192
8206
|
public readonly projenCredentials: GithubCredentials;
|
|
@@ -8199,7 +8213,7 @@ Choose a method of providing GitHub API access for projen workflows.
|
|
|
8199
8213
|
|
|
8200
8214
|
---
|
|
8201
8215
|
|
|
8202
|
-
##### `projenDevDependency`<sup>Optional</sup> <a name="projenDevDependency" id="@nikovirtala/projen-constructs.
|
|
8216
|
+
##### `projenDevDependency`<sup>Optional</sup> <a name="projenDevDependency" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenDevDependency"></a>
|
|
8203
8217
|
|
|
8204
8218
|
```typescript
|
|
8205
8219
|
public readonly projenDevDependency: boolean;
|
|
@@ -8212,7 +8226,7 @@ Indicates of "projen" should be installed as a devDependency.
|
|
|
8212
8226
|
|
|
8213
8227
|
---
|
|
8214
8228
|
|
|
8215
|
-
##### `projenrcJs`<sup>Optional</sup> <a name="projenrcJs" id="@nikovirtala/projen-constructs.
|
|
8229
|
+
##### `projenrcJs`<sup>Optional</sup> <a name="projenrcJs" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenrcJs"></a>
|
|
8216
8230
|
|
|
8217
8231
|
```typescript
|
|
8218
8232
|
public readonly projenrcJs: boolean;
|
|
@@ -8225,7 +8239,7 @@ Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable
|
|
|
8225
8239
|
|
|
8226
8240
|
---
|
|
8227
8241
|
|
|
8228
|
-
##### `projenrcJson`<sup>Optional</sup> <a name="projenrcJson" id="@nikovirtala/projen-constructs.
|
|
8242
|
+
##### `projenrcJson`<sup>Optional</sup> <a name="projenrcJson" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenrcJson"></a>
|
|
8229
8243
|
|
|
8230
8244
|
```typescript
|
|
8231
8245
|
public readonly projenrcJson: boolean;
|
|
@@ -8238,7 +8252,7 @@ Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .pr
|
|
|
8238
8252
|
|
|
8239
8253
|
---
|
|
8240
8254
|
|
|
8241
|
-
##### `projenrcJsonOptions`<sup>Optional</sup> <a name="projenrcJsonOptions" id="@nikovirtala/projen-constructs.
|
|
8255
|
+
##### `projenrcJsonOptions`<sup>Optional</sup> <a name="projenrcJsonOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenrcJsonOptions"></a>
|
|
8242
8256
|
|
|
8243
8257
|
```typescript
|
|
8244
8258
|
public readonly projenrcJsonOptions: ProjenrcJsonOptions;
|
|
@@ -8251,7 +8265,7 @@ Options for .projenrc.json.
|
|
|
8251
8265
|
|
|
8252
8266
|
---
|
|
8253
8267
|
|
|
8254
|
-
##### `projenrcJsOptions`<sup>Optional</sup> <a name="projenrcJsOptions" id="@nikovirtala/projen-constructs.
|
|
8268
|
+
##### `projenrcJsOptions`<sup>Optional</sup> <a name="projenrcJsOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenrcJsOptions"></a>
|
|
8255
8269
|
|
|
8256
8270
|
```typescript
|
|
8257
8271
|
public readonly projenrcJsOptions: ProjenrcOptions;
|
|
@@ -8264,7 +8278,7 @@ Options for .projenrc.js.
|
|
|
8264
8278
|
|
|
8265
8279
|
---
|
|
8266
8280
|
|
|
8267
|
-
##### `projenrcTs`<sup>Optional</sup> <a name="projenrcTs" id="@nikovirtala/projen-constructs.
|
|
8281
|
+
##### `projenrcTs`<sup>Optional</sup> <a name="projenrcTs" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenrcTs"></a>
|
|
8268
8282
|
|
|
8269
8283
|
```typescript
|
|
8270
8284
|
public readonly projenrcTs: boolean;
|
|
@@ -8277,7 +8291,7 @@ Use TypeScript for your projenrc file (`.projenrc.ts`).
|
|
|
8277
8291
|
|
|
8278
8292
|
---
|
|
8279
8293
|
|
|
8280
|
-
##### `projenrcTsOptions`<sup>Optional</sup> <a name="projenrcTsOptions" id="@nikovirtala/projen-constructs.
|
|
8294
|
+
##### `projenrcTsOptions`<sup>Optional</sup> <a name="projenrcTsOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenrcTsOptions"></a>
|
|
8281
8295
|
|
|
8282
8296
|
```typescript
|
|
8283
8297
|
public readonly projenrcTsOptions: ProjenrcOptions;
|
|
@@ -8289,7 +8303,7 @@ Options for .projenrc.ts.
|
|
|
8289
8303
|
|
|
8290
8304
|
---
|
|
8291
8305
|
|
|
8292
|
-
##### `projenVersion`<sup>Optional</sup> <a name="projenVersion" id="@nikovirtala/projen-constructs.
|
|
8306
|
+
##### `projenVersion`<sup>Optional</sup> <a name="projenVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.projenVersion"></a>
|
|
8293
8307
|
|
|
8294
8308
|
```typescript
|
|
8295
8309
|
public readonly projenVersion: string;
|
|
@@ -8302,7 +8316,7 @@ Version of projen to install.
|
|
|
8302
8316
|
|
|
8303
8317
|
---
|
|
8304
8318
|
|
|
8305
|
-
##### `publishDryRun`<sup>Optional</sup> <a name="publishDryRun" id="@nikovirtala/projen-constructs.
|
|
8319
|
+
##### `publishDryRun`<sup>Optional</sup> <a name="publishDryRun" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.publishDryRun"></a>
|
|
8306
8320
|
|
|
8307
8321
|
```typescript
|
|
8308
8322
|
public readonly publishDryRun: boolean;
|
|
@@ -8315,7 +8329,7 @@ Instead of actually publishing to package managers, just print the publishing co
|
|
|
8315
8329
|
|
|
8316
8330
|
---
|
|
8317
8331
|
|
|
8318
|
-
##### `publishTasks`<sup>Optional</sup> <a name="publishTasks" id="@nikovirtala/projen-constructs.
|
|
8332
|
+
##### `publishTasks`<sup>Optional</sup> <a name="publishTasks" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.publishTasks"></a>
|
|
8319
8333
|
|
|
8320
8334
|
```typescript
|
|
8321
8335
|
public readonly publishTasks: boolean;
|
|
@@ -8331,7 +8345,7 @@ in order to create a publishing task for each publishing activity.
|
|
|
8331
8345
|
|
|
8332
8346
|
---
|
|
8333
8347
|
|
|
8334
|
-
##### `publishToGo`<sup>Optional</sup> <a name="publishToGo" id="@nikovirtala/projen-constructs.
|
|
8348
|
+
##### `publishToGo`<sup>Optional</sup> <a name="publishToGo" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.publishToGo"></a>
|
|
8335
8349
|
|
|
8336
8350
|
```typescript
|
|
8337
8351
|
public readonly publishToGo: JsiiGoTarget;
|
|
@@ -8344,7 +8358,7 @@ Publish Go bindings to a git repository.
|
|
|
8344
8358
|
|
|
8345
8359
|
---
|
|
8346
8360
|
|
|
8347
|
-
##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="@nikovirtala/projen-constructs.
|
|
8361
|
+
##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.publishToMaven"></a>
|
|
8348
8362
|
|
|
8349
8363
|
```typescript
|
|
8350
8364
|
public readonly publishToMaven: JsiiJavaTarget;
|
|
@@ -8357,7 +8371,7 @@ Publish to maven.
|
|
|
8357
8371
|
|
|
8358
8372
|
---
|
|
8359
8373
|
|
|
8360
|
-
##### `publishToNuget`<sup>Optional</sup> <a name="publishToNuget" id="@nikovirtala/projen-constructs.
|
|
8374
|
+
##### `publishToNuget`<sup>Optional</sup> <a name="publishToNuget" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.publishToNuget"></a>
|
|
8361
8375
|
|
|
8362
8376
|
```typescript
|
|
8363
8377
|
public readonly publishToNuget: JsiiDotNetTarget;
|
|
@@ -8370,7 +8384,7 @@ Publish to NuGet.
|
|
|
8370
8384
|
|
|
8371
8385
|
---
|
|
8372
8386
|
|
|
8373
|
-
##### `publishToPypi`<sup>Optional</sup> <a name="publishToPypi" id="@nikovirtala/projen-constructs.
|
|
8387
|
+
##### `publishToPypi`<sup>Optional</sup> <a name="publishToPypi" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.publishToPypi"></a>
|
|
8374
8388
|
|
|
8375
8389
|
```typescript
|
|
8376
8390
|
public readonly publishToPypi: JsiiPythonTarget;
|
|
@@ -8383,7 +8397,7 @@ Publish to pypi.
|
|
|
8383
8397
|
|
|
8384
8398
|
---
|
|
8385
8399
|
|
|
8386
|
-
##### `pullRequestTemplate`<sup>Optional</sup> <a name="pullRequestTemplate" id="@nikovirtala/projen-constructs.
|
|
8400
|
+
##### `pullRequestTemplate`<sup>Optional</sup> <a name="pullRequestTemplate" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.pullRequestTemplate"></a>
|
|
8387
8401
|
|
|
8388
8402
|
```typescript
|
|
8389
8403
|
public readonly pullRequestTemplate: boolean;
|
|
@@ -8396,7 +8410,7 @@ Include a GitHub pull request template.
|
|
|
8396
8410
|
|
|
8397
8411
|
---
|
|
8398
8412
|
|
|
8399
|
-
##### `pullRequestTemplateContents`<sup>Optional</sup> <a name="pullRequestTemplateContents" id="@nikovirtala/projen-constructs.
|
|
8413
|
+
##### `pullRequestTemplateContents`<sup>Optional</sup> <a name="pullRequestTemplateContents" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.pullRequestTemplateContents"></a>
|
|
8400
8414
|
|
|
8401
8415
|
```typescript
|
|
8402
8416
|
public readonly pullRequestTemplateContents: string[];
|
|
@@ -8409,7 +8423,7 @@ The contents of the pull request template.
|
|
|
8409
8423
|
|
|
8410
8424
|
---
|
|
8411
8425
|
|
|
8412
|
-
##### `readme`<sup>Optional</sup> <a name="readme" id="@nikovirtala/projen-constructs.
|
|
8426
|
+
##### `readme`<sup>Optional</sup> <a name="readme" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.readme"></a>
|
|
8413
8427
|
|
|
8414
8428
|
```typescript
|
|
8415
8429
|
public readonly readme: SampleReadmeProps;
|
|
@@ -8422,7 +8436,7 @@ The README setup.
|
|
|
8422
8436
|
|
|
8423
8437
|
---
|
|
8424
8438
|
|
|
8425
|
-
##### `releasableCommits`<sup>Optional</sup> <a name="releasableCommits" id="@nikovirtala/projen-constructs.
|
|
8439
|
+
##### `releasableCommits`<sup>Optional</sup> <a name="releasableCommits" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releasableCommits"></a>
|
|
8426
8440
|
|
|
8427
8441
|
```typescript
|
|
8428
8442
|
public readonly releasableCommits: ReleasableCommits;
|
|
@@ -8435,7 +8449,7 @@ Find commits that should be considered releasable Used to decide if a release is
|
|
|
8435
8449
|
|
|
8436
8450
|
---
|
|
8437
8451
|
|
|
8438
|
-
##### `release`<sup>Optional</sup> <a name="release" id="@nikovirtala/projen-constructs.
|
|
8452
|
+
##### `release`<sup>Optional</sup> <a name="release" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.release"></a>
|
|
8439
8453
|
|
|
8440
8454
|
```typescript
|
|
8441
8455
|
public readonly release: boolean;
|
|
@@ -8448,7 +8462,7 @@ Add release management to this project.
|
|
|
8448
8462
|
|
|
8449
8463
|
---
|
|
8450
8464
|
|
|
8451
|
-
##### `releaseBranches`<sup>Optional</sup> <a name="releaseBranches" id="@nikovirtala/projen-constructs.
|
|
8465
|
+
##### `releaseBranches`<sup>Optional</sup> <a name="releaseBranches" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseBranches"></a>
|
|
8452
8466
|
|
|
8453
8467
|
```typescript
|
|
8454
8468
|
public readonly releaseBranches: {[ key: string ]: BranchOptions};
|
|
@@ -8468,7 +8482,7 @@ be provided for the default branch.
|
|
|
8468
8482
|
|
|
8469
8483
|
---
|
|
8470
8484
|
|
|
8471
|
-
##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="@nikovirtala/projen-constructs.
|
|
8485
|
+
##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseEnvironment"></a>
|
|
8472
8486
|
|
|
8473
8487
|
```typescript
|
|
8474
8488
|
public readonly releaseEnvironment: string;
|
|
@@ -8487,7 +8501,7 @@ on a per artifact basis.
|
|
|
8487
8501
|
|
|
8488
8502
|
---
|
|
8489
8503
|
|
|
8490
|
-
##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="@nikovirtala/projen-constructs.
|
|
8504
|
+
##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseFailureIssue"></a>
|
|
8491
8505
|
|
|
8492
8506
|
```typescript
|
|
8493
8507
|
public readonly releaseFailureIssue: boolean;
|
|
@@ -8500,7 +8514,7 @@ Create a github issue on every failed publishing task.
|
|
|
8500
8514
|
|
|
8501
8515
|
---
|
|
8502
8516
|
|
|
8503
|
-
##### `releaseFailureIssueLabel`<sup>Optional</sup> <a name="releaseFailureIssueLabel" id="@nikovirtala/projen-constructs.
|
|
8517
|
+
##### `releaseFailureIssueLabel`<sup>Optional</sup> <a name="releaseFailureIssueLabel" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseFailureIssueLabel"></a>
|
|
8504
8518
|
|
|
8505
8519
|
```typescript
|
|
8506
8520
|
public readonly releaseFailureIssueLabel: string;
|
|
@@ -8515,7 +8529,7 @@ Only applies if `releaseFailureIssue` is true.
|
|
|
8515
8529
|
|
|
8516
8530
|
---
|
|
8517
8531
|
|
|
8518
|
-
##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="@nikovirtala/projen-constructs.
|
|
8532
|
+
##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseTagPrefix"></a>
|
|
8519
8533
|
|
|
8520
8534
|
```typescript
|
|
8521
8535
|
public readonly releaseTagPrefix: string;
|
|
@@ -8534,7 +8548,7 @@ with the new prefix.
|
|
|
8534
8548
|
|
|
8535
8549
|
---
|
|
8536
8550
|
|
|
8537
|
-
##### `releaseToNpm`<sup>Optional</sup> <a name="releaseToNpm" id="@nikovirtala/projen-constructs.
|
|
8551
|
+
##### `releaseToNpm`<sup>Optional</sup> <a name="releaseToNpm" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseToNpm"></a>
|
|
8538
8552
|
|
|
8539
8553
|
```typescript
|
|
8540
8554
|
public readonly releaseToNpm: boolean;
|
|
@@ -8547,7 +8561,7 @@ Automatically release to npm when new versions are introduced.
|
|
|
8547
8561
|
|
|
8548
8562
|
---
|
|
8549
8563
|
|
|
8550
|
-
##### `releaseTrigger`<sup>Optional</sup> <a name="releaseTrigger" id="@nikovirtala/projen-constructs.
|
|
8564
|
+
##### `releaseTrigger`<sup>Optional</sup> <a name="releaseTrigger" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseTrigger"></a>
|
|
8551
8565
|
|
|
8552
8566
|
```typescript
|
|
8553
8567
|
public readonly releaseTrigger: ReleaseTrigger;
|
|
@@ -8560,7 +8574,7 @@ The release trigger to use.
|
|
|
8560
8574
|
|
|
8561
8575
|
---
|
|
8562
8576
|
|
|
8563
|
-
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="@nikovirtala/projen-constructs.
|
|
8577
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseWorkflowEnv"></a>
|
|
8564
8578
|
|
|
8565
8579
|
```typescript
|
|
8566
8580
|
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
@@ -8573,7 +8587,7 @@ Build environment variables for release workflows.
|
|
|
8573
8587
|
|
|
8574
8588
|
---
|
|
8575
8589
|
|
|
8576
|
-
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="@nikovirtala/projen-constructs.
|
|
8590
|
+
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseWorkflowName"></a>
|
|
8577
8591
|
|
|
8578
8592
|
```typescript
|
|
8579
8593
|
public readonly releaseWorkflowName: string;
|
|
@@ -8586,7 +8600,7 @@ The name of the default release workflow.
|
|
|
8586
8600
|
|
|
8587
8601
|
---
|
|
8588
8602
|
|
|
8589
|
-
##### `releaseWorkflowSetupSteps`<sup>Optional</sup> <a name="releaseWorkflowSetupSteps" id="@nikovirtala/projen-constructs.
|
|
8603
|
+
##### `releaseWorkflowSetupSteps`<sup>Optional</sup> <a name="releaseWorkflowSetupSteps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.releaseWorkflowSetupSteps"></a>
|
|
8590
8604
|
|
|
8591
8605
|
```typescript
|
|
8592
8606
|
public readonly releaseWorkflowSetupSteps: JobStep[];
|
|
@@ -8598,7 +8612,7 @@ A set of workflow steps to execute in order to setup the workflow container.
|
|
|
8598
8612
|
|
|
8599
8613
|
---
|
|
8600
8614
|
|
|
8601
|
-
##### `renovatebot`<sup>Optional</sup> <a name="renovatebot" id="@nikovirtala/projen-constructs.
|
|
8615
|
+
##### `renovatebot`<sup>Optional</sup> <a name="renovatebot" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.renovatebot"></a>
|
|
8602
8616
|
|
|
8603
8617
|
```typescript
|
|
8604
8618
|
public readonly renovatebot: boolean;
|
|
@@ -8611,7 +8625,7 @@ Use renovatebot to handle dependency upgrades.
|
|
|
8611
8625
|
|
|
8612
8626
|
---
|
|
8613
8627
|
|
|
8614
|
-
##### `renovatebotOptions`<sup>Optional</sup> <a name="renovatebotOptions" id="@nikovirtala/projen-constructs.
|
|
8628
|
+
##### `renovatebotOptions`<sup>Optional</sup> <a name="renovatebotOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.renovatebotOptions"></a>
|
|
8615
8629
|
|
|
8616
8630
|
```typescript
|
|
8617
8631
|
public readonly renovatebotOptions: RenovatebotOptions;
|
|
@@ -8624,7 +8638,7 @@ Options for renovatebot.
|
|
|
8624
8638
|
|
|
8625
8639
|
---
|
|
8626
8640
|
|
|
8627
|
-
##### `repository`<sup>Optional</sup> <a name="repository" id="@nikovirtala/projen-constructs.
|
|
8641
|
+
##### `repository`<sup>Optional</sup> <a name="repository" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.repository"></a>
|
|
8628
8642
|
|
|
8629
8643
|
```typescript
|
|
8630
8644
|
public readonly repository: string;
|
|
@@ -8638,7 +8652,7 @@ See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
|
|
|
8638
8652
|
|
|
8639
8653
|
---
|
|
8640
8654
|
|
|
8641
|
-
##### `repositoryDirectory`<sup>Optional</sup> <a name="repositoryDirectory" id="@nikovirtala/projen-constructs.
|
|
8655
|
+
##### `repositoryDirectory`<sup>Optional</sup> <a name="repositoryDirectory" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.repositoryDirectory"></a>
|
|
8642
8656
|
|
|
8643
8657
|
```typescript
|
|
8644
8658
|
public readonly repositoryDirectory: string;
|
|
@@ -8650,7 +8664,7 @@ If the package.json for your package is not in the root directory (for example i
|
|
|
8650
8664
|
|
|
8651
8665
|
---
|
|
8652
8666
|
|
|
8653
|
-
##### `rootdir`<sup>Optional</sup> <a name="rootdir" id="@nikovirtala/projen-constructs.
|
|
8667
|
+
##### `rootdir`<sup>Optional</sup> <a name="rootdir" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.rootdir"></a>
|
|
8654
8668
|
|
|
8655
8669
|
```typescript
|
|
8656
8670
|
public readonly rootdir: string;
|
|
@@ -8661,7 +8675,7 @@ public readonly rootdir: string;
|
|
|
8661
8675
|
|
|
8662
8676
|
---
|
|
8663
8677
|
|
|
8664
|
-
##### `scopedPackagesOptions`<sup>Optional</sup> <a name="scopedPackagesOptions" id="@nikovirtala/projen-constructs.
|
|
8678
|
+
##### `scopedPackagesOptions`<sup>Optional</sup> <a name="scopedPackagesOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.scopedPackagesOptions"></a>
|
|
8665
8679
|
|
|
8666
8680
|
```typescript
|
|
8667
8681
|
public readonly scopedPackagesOptions: ScopedPackagesOptions[];
|
|
@@ -8674,7 +8688,7 @@ Options for privately hosted scoped packages.
|
|
|
8674
8688
|
|
|
8675
8689
|
---
|
|
8676
8690
|
|
|
8677
|
-
##### `srcdir`<sup>Optional</sup> <a name="srcdir" id="@nikovirtala/projen-constructs.
|
|
8691
|
+
##### `srcdir`<sup>Optional</sup> <a name="srcdir" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.srcdir"></a>
|
|
8678
8692
|
|
|
8679
8693
|
```typescript
|
|
8680
8694
|
public readonly srcdir: string;
|
|
@@ -8687,7 +8701,7 @@ Typescript sources directory.
|
|
|
8687
8701
|
|
|
8688
8702
|
---
|
|
8689
8703
|
|
|
8690
|
-
##### `stability`<sup>Optional</sup> <a name="stability" id="@nikovirtala/projen-constructs.
|
|
8704
|
+
##### `stability`<sup>Optional</sup> <a name="stability" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.stability"></a>
|
|
8691
8705
|
|
|
8692
8706
|
```typescript
|
|
8693
8707
|
public readonly stability: string;
|
|
@@ -8699,7 +8713,7 @@ Package's Stability.
|
|
|
8699
8713
|
|
|
8700
8714
|
---
|
|
8701
8715
|
|
|
8702
|
-
##### `stale`<sup>Optional</sup> <a name="stale" id="@nikovirtala/projen-constructs.
|
|
8716
|
+
##### `stale`<sup>Optional</sup> <a name="stale" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.stale"></a>
|
|
8703
8717
|
|
|
8704
8718
|
```typescript
|
|
8705
8719
|
public readonly stale: boolean;
|
|
@@ -8714,7 +8728,7 @@ See `staleOptions` for options.
|
|
|
8714
8728
|
|
|
8715
8729
|
---
|
|
8716
8730
|
|
|
8717
|
-
##### `staleOptions`<sup>Optional</sup> <a name="staleOptions" id="@nikovirtala/projen-constructs.
|
|
8731
|
+
##### `staleOptions`<sup>Optional</sup> <a name="staleOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.staleOptions"></a>
|
|
8718
8732
|
|
|
8719
8733
|
```typescript
|
|
8720
8734
|
public readonly staleOptions: StaleOptions;
|
|
@@ -8729,7 +8743,7 @@ To disable set `stale` to `false`.
|
|
|
8729
8743
|
|
|
8730
8744
|
---
|
|
8731
8745
|
|
|
8732
|
-
##### `testdir`<sup>Optional</sup> <a name="testdir" id="@nikovirtala/projen-constructs.
|
|
8746
|
+
##### `testdir`<sup>Optional</sup> <a name="testdir" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.testdir"></a>
|
|
8733
8747
|
|
|
8734
8748
|
```typescript
|
|
8735
8749
|
public readonly testdir: string;
|
|
@@ -8748,7 +8762,7 @@ compile the code in-memory.
|
|
|
8748
8762
|
|
|
8749
8763
|
---
|
|
8750
8764
|
|
|
8751
|
-
##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="@nikovirtala/projen-constructs.
|
|
8765
|
+
##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.tsconfig"></a>
|
|
8752
8766
|
|
|
8753
8767
|
```typescript
|
|
8754
8768
|
public readonly tsconfig: TypescriptConfigOptions;
|
|
@@ -8761,7 +8775,7 @@ Custom TSConfig.
|
|
|
8761
8775
|
|
|
8762
8776
|
---
|
|
8763
8777
|
|
|
8764
|
-
##### `tsconfigDev`<sup>Optional</sup> <a name="tsconfigDev" id="@nikovirtala/projen-constructs.
|
|
8778
|
+
##### `tsconfigDev`<sup>Optional</sup> <a name="tsconfigDev" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.tsconfigDev"></a>
|
|
8765
8779
|
|
|
8766
8780
|
```typescript
|
|
8767
8781
|
public readonly tsconfigDev: TypescriptConfigOptions;
|
|
@@ -8774,7 +8788,7 @@ Custom tsconfig options for the development tsconfig.json file (used for testing
|
|
|
8774
8788
|
|
|
8775
8789
|
---
|
|
8776
8790
|
|
|
8777
|
-
##### `tsconfigDevFile`<sup>Optional</sup> <a name="tsconfigDevFile" id="@nikovirtala/projen-constructs.
|
|
8791
|
+
##### `tsconfigDevFile`<sup>Optional</sup> <a name="tsconfigDevFile" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.tsconfigDevFile"></a>
|
|
8778
8792
|
|
|
8779
8793
|
```typescript
|
|
8780
8794
|
public readonly tsconfigDevFile: string;
|
|
@@ -8787,7 +8801,7 @@ The name of the development tsconfig.json file.
|
|
|
8787
8801
|
|
|
8788
8802
|
---
|
|
8789
8803
|
|
|
8790
|
-
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="@nikovirtala/projen-constructs.
|
|
8804
|
+
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.typescriptVersion"></a>
|
|
8791
8805
|
|
|
8792
8806
|
```typescript
|
|
8793
8807
|
public readonly typescriptVersion: string;
|
|
@@ -8803,7 +8817,7 @@ same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
|
|
|
8803
8817
|
|
|
8804
8818
|
---
|
|
8805
8819
|
|
|
8806
|
-
##### `versionrcOptions`<sup>Optional</sup> <a name="versionrcOptions" id="@nikovirtala/projen-constructs.
|
|
8820
|
+
##### `versionrcOptions`<sup>Optional</sup> <a name="versionrcOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.versionrcOptions"></a>
|
|
8807
8821
|
|
|
8808
8822
|
```typescript
|
|
8809
8823
|
public readonly versionrcOptions: {[ key: string ]: any};
|
|
@@ -8818,7 +8832,7 @@ Given values either append to default configuration or overwrite values in it.
|
|
|
8818
8832
|
|
|
8819
8833
|
---
|
|
8820
8834
|
|
|
8821
|
-
##### `vitest`<sup>Optional</sup> <a name="vitest" id="@nikovirtala/projen-constructs.
|
|
8835
|
+
##### `vitest`<sup>Optional</sup> <a name="vitest" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.vitest"></a>
|
|
8822
8836
|
|
|
8823
8837
|
```typescript
|
|
8824
8838
|
public readonly vitest: boolean;
|
|
@@ -8831,7 +8845,7 @@ Enable testing with Vitest.
|
|
|
8831
8845
|
|
|
8832
8846
|
---
|
|
8833
8847
|
|
|
8834
|
-
##### `vitestOptions`<sup>Optional</sup> <a name="vitestOptions" id="@nikovirtala/projen-constructs.
|
|
8848
|
+
##### `vitestOptions`<sup>Optional</sup> <a name="vitestOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.vitestOptions"></a>
|
|
8835
8849
|
|
|
8836
8850
|
```typescript
|
|
8837
8851
|
public readonly vitestOptions: VitestOptions;
|
|
@@ -8844,7 +8858,7 @@ The Vitest configuration (when enabled).
|
|
|
8844
8858
|
|
|
8845
8859
|
---
|
|
8846
8860
|
|
|
8847
|
-
##### `vscode`<sup>Optional</sup> <a name="vscode" id="@nikovirtala/projen-constructs.
|
|
8861
|
+
##### `vscode`<sup>Optional</sup> <a name="vscode" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.vscode"></a>
|
|
8848
8862
|
|
|
8849
8863
|
```typescript
|
|
8850
8864
|
public readonly vscode: boolean;
|
|
@@ -8859,7 +8873,7 @@ Enabled by default for root projects. Disabled for non-root projects.
|
|
|
8859
8873
|
|
|
8860
8874
|
---
|
|
8861
8875
|
|
|
8862
|
-
##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="workflowBootstrapSteps" id="@nikovirtala/projen-constructs.
|
|
8876
|
+
##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="workflowBootstrapSteps" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowBootstrapSteps"></a>
|
|
8863
8877
|
|
|
8864
8878
|
```typescript
|
|
8865
8879
|
public readonly workflowBootstrapSteps: JobStep[];
|
|
@@ -8872,7 +8886,7 @@ Workflow steps to use in order to bootstrap this repo.
|
|
|
8872
8886
|
|
|
8873
8887
|
---
|
|
8874
8888
|
|
|
8875
|
-
##### `workflowContainerImage`<sup>Optional</sup> <a name="workflowContainerImage" id="@nikovirtala/projen-constructs.
|
|
8889
|
+
##### `workflowContainerImage`<sup>Optional</sup> <a name="workflowContainerImage" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowContainerImage"></a>
|
|
8876
8890
|
|
|
8877
8891
|
```typescript
|
|
8878
8892
|
public readonly workflowContainerImage: string;
|
|
@@ -8885,7 +8899,7 @@ Container image to use for GitHub workflows.
|
|
|
8885
8899
|
|
|
8886
8900
|
---
|
|
8887
8901
|
|
|
8888
|
-
##### `workflowGitIdentity`<sup>Optional</sup> <a name="workflowGitIdentity" id="@nikovirtala/projen-constructs.
|
|
8902
|
+
##### `workflowGitIdentity`<sup>Optional</sup> <a name="workflowGitIdentity" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowGitIdentity"></a>
|
|
8889
8903
|
|
|
8890
8904
|
```typescript
|
|
8891
8905
|
public readonly workflowGitIdentity: GitIdentity;
|
|
@@ -8898,7 +8912,7 @@ The git identity to use in workflows.
|
|
|
8898
8912
|
|
|
8899
8913
|
---
|
|
8900
8914
|
|
|
8901
|
-
##### `workflowNodeVersion`<sup>Optional</sup> <a name="workflowNodeVersion" id="@nikovirtala/projen-constructs.
|
|
8915
|
+
##### `workflowNodeVersion`<sup>Optional</sup> <a name="workflowNodeVersion" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowNodeVersion"></a>
|
|
8902
8916
|
|
|
8903
8917
|
```typescript
|
|
8904
8918
|
public readonly workflowNodeVersion: string;
|
|
@@ -8913,7 +8927,7 @@ Always use this option if your GitHub Actions workflows require a specific to ru
|
|
|
8913
8927
|
|
|
8914
8928
|
---
|
|
8915
8929
|
|
|
8916
|
-
##### `workflowPackageCache`<sup>Optional</sup> <a name="workflowPackageCache" id="@nikovirtala/projen-constructs.
|
|
8930
|
+
##### `workflowPackageCache`<sup>Optional</sup> <a name="workflowPackageCache" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowPackageCache"></a>
|
|
8917
8931
|
|
|
8918
8932
|
```typescript
|
|
8919
8933
|
public readonly workflowPackageCache: boolean;
|
|
@@ -8926,7 +8940,7 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
8926
8940
|
|
|
8927
8941
|
---
|
|
8928
8942
|
|
|
8929
|
-
##### `workflowRunsOn`<sup>Optional</sup> <a name="workflowRunsOn" id="@nikovirtala/projen-constructs.
|
|
8943
|
+
##### `workflowRunsOn`<sup>Optional</sup> <a name="workflowRunsOn" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowRunsOn"></a>
|
|
8930
8944
|
|
|
8931
8945
|
```typescript
|
|
8932
8946
|
public readonly workflowRunsOn: string[];
|
|
@@ -8939,7 +8953,7 @@ Github Runner selection labels.
|
|
|
8939
8953
|
|
|
8940
8954
|
---
|
|
8941
8955
|
|
|
8942
|
-
##### `workflowRunsOnGroup`<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@nikovirtala/projen-constructs.
|
|
8956
|
+
##### `workflowRunsOnGroup`<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.workflowRunsOnGroup"></a>
|
|
8943
8957
|
|
|
8944
8958
|
```typescript
|
|
8945
8959
|
public readonly workflowRunsOnGroup: GroupRunnerOptions;
|
|
@@ -8951,7 +8965,7 @@ Github Runner Group selection options.
|
|
|
8951
8965
|
|
|
8952
8966
|
---
|
|
8953
8967
|
|
|
8954
|
-
##### `yarnBerryOptions`<sup>Optional</sup> <a name="yarnBerryOptions" id="@nikovirtala/projen-constructs.
|
|
8968
|
+
##### `yarnBerryOptions`<sup>Optional</sup> <a name="yarnBerryOptions" id="@nikovirtala/projen-constructs.AwsCdkConstructLibraryProjectOptions.property.yarnBerryOptions"></a>
|
|
8955
8969
|
|
|
8956
8970
|
```typescript
|
|
8957
8971
|
public readonly yarnBerryOptions: YarnBerryOptions;
|
|
@@ -8999,6 +9013,7 @@ const awsCdkTypeScriptAppProjectOptions: AwsCdkTypeScriptAppProjectOptions = { .
|
|
|
8999
9013
|
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkTypeScriptAppProjectOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
|
|
9000
9014
|
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkTypeScriptAppProjectOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
|
|
9001
9015
|
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkTypeScriptAppProjectOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
|
|
9016
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkTypeScriptAppProjectOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
|
|
9002
9017
|
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkTypeScriptAppProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
9003
9018
|
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkTypeScriptAppProjectOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
|
|
9004
9019
|
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkTypeScriptAppProjectOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
|
|
@@ -9400,6 +9415,19 @@ executable file under `bin` will automatically be added to this section.
|
|
|
9400
9415
|
|
|
9401
9416
|
---
|
|
9402
9417
|
|
|
9418
|
+
##### `biome`<sup>Optional</sup> <a name="biome" id="@nikovirtala/projen-constructs.AwsCdkTypeScriptAppProjectOptions.property.biome"></a>
|
|
9419
|
+
|
|
9420
|
+
```typescript
|
|
9421
|
+
public readonly biome: boolean;
|
|
9422
|
+
```
|
|
9423
|
+
|
|
9424
|
+
- *Type:* boolean
|
|
9425
|
+
- *Default:* false
|
|
9426
|
+
|
|
9427
|
+
Setup Biome.
|
|
9428
|
+
|
|
9429
|
+
---
|
|
9430
|
+
|
|
9403
9431
|
##### `biomeOptions`<sup>Optional</sup> <a name="biomeOptions" id="@nikovirtala/projen-constructs.AwsCdkTypeScriptAppProjectOptions.property.biomeOptions"></a>
|
|
9404
9432
|
|
|
9405
9433
|
```typescript
|
|
@@ -11391,6 +11419,7 @@ const jsiiProjectOptions: JsiiProjectOptions = { ... }
|
|
|
11391
11419
|
| <code><a href="#@nikovirtala/projen-constructs.JsiiProjectOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
|
|
11392
11420
|
| <code><a href="#@nikovirtala/projen-constructs.JsiiProjectOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
|
|
11393
11421
|
| <code><a href="#@nikovirtala/projen-constructs.JsiiProjectOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
|
|
11422
|
+
| <code><a href="#@nikovirtala/projen-constructs.JsiiProjectOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
|
|
11394
11423
|
| <code><a href="#@nikovirtala/projen-constructs.JsiiProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
11395
11424
|
| <code><a href="#@nikovirtala/projen-constructs.JsiiProjectOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
|
|
11396
11425
|
| <code><a href="#@nikovirtala/projen-constructs.JsiiProjectOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
|
|
@@ -11787,6 +11816,19 @@ executable file under `bin` will automatically be added to this section.
|
|
|
11787
11816
|
|
|
11788
11817
|
---
|
|
11789
11818
|
|
|
11819
|
+
##### `biome`<sup>Optional</sup> <a name="biome" id="@nikovirtala/projen-constructs.JsiiProjectOptions.property.biome"></a>
|
|
11820
|
+
|
|
11821
|
+
```typescript
|
|
11822
|
+
public readonly biome: boolean;
|
|
11823
|
+
```
|
|
11824
|
+
|
|
11825
|
+
- *Type:* boolean
|
|
11826
|
+
- *Default:* false
|
|
11827
|
+
|
|
11828
|
+
Setup Biome.
|
|
11829
|
+
|
|
11830
|
+
---
|
|
11831
|
+
|
|
11790
11832
|
##### `biomeOptions`<sup>Optional</sup> <a name="biomeOptions" id="@nikovirtala/projen-constructs.JsiiProjectOptions.property.biomeOptions"></a>
|
|
11791
11833
|
|
|
11792
11834
|
```typescript
|
|
@@ -13694,6 +13736,7 @@ const typeScriptProjectOptions: TypeScriptProjectOptions = { ... }
|
|
|
13694
13736
|
| <code><a href="#@nikovirtala/projen-constructs.TypeScriptProjectOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
|
|
13695
13737
|
| <code><a href="#@nikovirtala/projen-constructs.TypeScriptProjectOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
|
|
13696
13738
|
| <code><a href="#@nikovirtala/projen-constructs.TypeScriptProjectOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
|
|
13739
|
+
| <code><a href="#@nikovirtala/projen-constructs.TypeScriptProjectOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
|
|
13697
13740
|
| <code><a href="#@nikovirtala/projen-constructs.TypeScriptProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
13698
13741
|
| <code><a href="#@nikovirtala/projen-constructs.TypeScriptProjectOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
|
|
13699
13742
|
| <code><a href="#@nikovirtala/projen-constructs.TypeScriptProjectOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
|
|
@@ -14040,6 +14083,19 @@ executable file under `bin` will automatically be added to this section.
|
|
|
14040
14083
|
|
|
14041
14084
|
---
|
|
14042
14085
|
|
|
14086
|
+
##### `biome`<sup>Optional</sup> <a name="biome" id="@nikovirtala/projen-constructs.TypeScriptProjectOptions.property.biome"></a>
|
|
14087
|
+
|
|
14088
|
+
```typescript
|
|
14089
|
+
public readonly biome: boolean;
|
|
14090
|
+
```
|
|
14091
|
+
|
|
14092
|
+
- *Type:* boolean
|
|
14093
|
+
- *Default:* false
|
|
14094
|
+
|
|
14095
|
+
Setup Biome.
|
|
14096
|
+
|
|
14097
|
+
---
|
|
14098
|
+
|
|
14043
14099
|
##### `biomeOptions`<sup>Optional</sup> <a name="biomeOptions" id="@nikovirtala/projen-constructs.TypeScriptProjectOptions.property.biomeOptions"></a>
|
|
14044
14100
|
|
|
14045
14101
|
```typescript
|