@nikovirtala/projen-constructs 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +4114 -18
- package/API.md +257 -257
- package/README.md +137 -23
- package/lib/components/bundle-lambda-function-code.d.ts +62 -0
- package/lib/components/bundle-lambda-function-code.js +175 -0
- package/lib/components/colima.d.ts +5 -0
- package/lib/components/colima.js +22 -0
- package/lib/components/homebrew.d.ts +12 -0
- package/lib/components/homebrew.js +42 -0
- package/lib/components/index.d.ts +7 -0
- package/lib/components/index.js +24 -0
- package/lib/components/lambda-function-construct-generator.d.ts +30 -0
- package/lib/components/lambda-function-construct-generator.js +195 -0
- package/lib/components/localstack.d.ts +11 -0
- package/lib/components/localstack.js +42 -0
- package/lib/components/typedoc-config.d.ts +78 -0
- package/lib/components/typedoc-config.js +93 -0
- package/lib/components/typedoc.d.ts +18 -0
- package/lib/components/typedoc.js +58 -0
- package/lib/components/vitest-bundled-define-config.d.ts +1 -0
- package/lib/components/vitest-bundled-define-config.js +6 -0
- package/lib/components/vitest.d.ts +87 -0
- package/lib/components/vitest.js +204 -0
- package/lib/index.d.ts +1 -4
- package/lib/index.js +2 -5
- package/lib/projects/awscdk-app.js +38 -0
- package/lib/{awscdk-construct-project.d.ts → projects/awscdk-construct.d.ts} +1 -1
- package/lib/projects/awscdk-construct.js +38 -0
- package/lib/projects/index.d.ts +4 -0
- package/lib/projects/index.js +21 -0
- package/lib/projects/jsii.js +38 -0
- package/lib/projects/typescript.js +39 -0
- package/node_modules/case/LICENSE +22 -0
- package/node_modules/case/README.md +139 -0
- package/node_modules/case/case.d.ts +43 -0
- package/node_modules/case/dist/Case.js +171 -0
- package/node_modules/case/dist/Case.min.js +5 -0
- package/node_modules/case/dist/Case.min.js.map +1 -0
- package/node_modules/case/dist/Case.plus.js +189 -0
- package/node_modules/case/dist/Case.plus.min.js +5 -0
- package/node_modules/case/dist/Case.plus.min.js.map +1 -0
- package/node_modules/case/package.json +58 -0
- package/package.json +10 -2
- package/lib/awscdk-app-project.js +0 -38
- package/lib/awscdk-construct-project.js +0 -38
- package/lib/jsii-project.js +0 -38
- package/lib/typescript-project.js +0 -39
- /package/lib/{awscdk-app-project.d.ts → projects/awscdk-app.d.ts} +0 -0
- /package/lib/{jsii-project.d.ts → projects/jsii.d.ts} +0 -0
- /package/lib/{typescript-project.d.ts → projects/typescript.d.ts} +0 -0
package/API.md
CHANGED
|
@@ -2,23 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
## Constructs <a name="Constructs" id="Constructs"></a>
|
|
4
4
|
|
|
5
|
-
###
|
|
5
|
+
### AwsCdkConstructProject <a name="AwsCdkConstructProject" id="@nikovirtala/projen-constructs.AwsCdkConstructProject"></a>
|
|
6
6
|
|
|
7
|
-
#### Initializers <a name="Initializers" id="@nikovirtala/projen-constructs.
|
|
7
|
+
#### Initializers <a name="Initializers" id="@nikovirtala/projen-constructs.AwsCdkConstructProject.Initializer"></a>
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
import {
|
|
10
|
+
import { AwsCdkConstructProject } from '@nikovirtala/projen-constructs'
|
|
11
11
|
|
|
12
|
-
new
|
|
12
|
+
new AwsCdkConstructProject(options: AwsCdkConstructLibraryOptions)
|
|
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.AwsCdkConstructProject.Initializer.parameter.options">options</a></code> | <code>projen.awscdk.AwsCdkConstructLibraryOptions</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.AwsCdkConstructProject.Initializer.parameter.options"></a>
|
|
22
22
|
|
|
23
23
|
- *Type:* projen.awscdk.AwsCdkConstructLibraryOptions
|
|
24
24
|
|
|
@@ -28,42 +28,42 @@ new AwsCdkConstructLibraryProject(options: AwsCdkConstructLibraryOptions)
|
|
|
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.AwsCdkConstructProject.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
32
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
33
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
34
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
35
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addTask">addTask</a></code> | Adds a new task to this project. |
|
|
36
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
|
|
37
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
|
|
38
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
|
|
39
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
|
|
40
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.removeTask">removeTask</a></code> | Removes a task from a project. |
|
|
41
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
|
|
42
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.synth">synth</a></code> | Synthesize all project files into `outdir`. |
|
|
43
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.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.AwsCdkConstructProject.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
|
|
45
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
|
|
46
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.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.AwsCdkConstructProject.addBins">addBins</a></code> | *No description.* |
|
|
48
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
|
|
49
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
|
|
50
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addDeps">addDeps</a></code> | Defines normal dependencies. |
|
|
51
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
|
|
52
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
|
|
53
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
|
|
54
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
|
|
55
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
|
|
56
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
|
|
57
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
|
|
58
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
|
59
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.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.AwsCdkConstructProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
|
|
61
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addCdkDependencies">addCdkDependencies</a></code> | Adds dependencies to AWS CDK modules. |
|
|
62
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.addCdkTestDependencies">addCdkTestDependencies</a></code> | Adds AWS CDK modules as dev dependencies. |
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
##### `toString` <a name="toString" id="@nikovirtala/projen-constructs.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
622
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.isProject">isProject</a></code> | Test whether the given construct is a project. |
|
|
623
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.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.AwsCdkConstructProject.isConstruct"></a>
|
|
628
628
|
|
|
629
629
|
```typescript
|
|
630
|
-
import {
|
|
630
|
+
import { AwsCdkConstructProject } from '@nikovirtala/projen-constructs'
|
|
631
631
|
|
|
632
|
-
|
|
632
|
+
AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.isProject"></a>
|
|
660
660
|
|
|
661
661
|
```typescript
|
|
662
|
-
import {
|
|
662
|
+
import { AwsCdkConstructProject } from '@nikovirtala/projen-constructs'
|
|
663
663
|
|
|
664
|
-
|
|
664
|
+
AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.of"></a>
|
|
676
676
|
|
|
677
677
|
```typescript
|
|
678
|
-
import {
|
|
678
|
+
import { AwsCdkConstructProject } from '@nikovirtala/projen-constructs'
|
|
679
679
|
|
|
680
|
-
|
|
680
|
+
AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
698
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.buildTask">buildTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
699
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
700
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.compileTask">compileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
701
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.components">components</a></code> | <code>projen.Component[]</code> | Returns all the components within this project. |
|
|
702
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.deps">deps</a></code> | <code>projen.Dependencies</code> | Project dependencies. |
|
|
703
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.ejected">ejected</a></code> | <code>boolean</code> | Whether or not the project is being ejected. |
|
|
704
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.files">files</a></code> | <code>projen.FileBase[]</code> | All files in this project. |
|
|
705
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.gitattributes">gitattributes</a></code> | <code>projen.GitAttributesFile</code> | The .gitattributes file for this repository. |
|
|
706
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.gitignore">gitignore</a></code> | <code>projen.IgnoreFile</code> | .gitignore. |
|
|
707
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.logger">logger</a></code> | <code>projen.Logger</code> | Logging utilities. |
|
|
708
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.name">name</a></code> | <code>string</code> | Project name. |
|
|
709
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.outdir">outdir</a></code> | <code>string</code> | Absolute output directory of this project. |
|
|
710
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.packageTask">packageTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
711
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.postCompileTask">postCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
712
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.preCompileTask">preCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
713
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
|
|
714
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.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.AwsCdkConstructProject.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
|
|
716
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.subprojects">subprojects</a></code> | <code>projen.Project[]</code> | Returns all the subprojects within this project. |
|
|
717
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
|
|
718
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
719
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
|
|
722
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
|
|
723
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
|
|
724
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.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.AwsCdkConstructProject.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
|
|
726
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
|
|
727
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
|
|
728
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
|
|
729
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
|
|
730
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.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.AwsCdkConstructProject.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
|
|
732
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
|
|
733
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
|
|
734
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
|
|
735
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
|
|
736
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
|
|
737
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
|
|
740
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
|
|
741
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
|
|
742
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
|
|
743
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version supported by this package. |
|
|
744
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.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.AwsCdkConstructProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
746
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
747
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
748
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
|
|
749
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
750
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
751
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
752
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
753
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
754
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.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.AwsCdkConstructProject.property.watchTask">watchTask</a></code> | <code>projen.Task</code> | The "watch" task. |
|
|
756
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.docgen">docgen</a></code> | <code>boolean</code> | *No description.* |
|
|
757
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.eslint">eslint</a></code> | <code>projen.javascript.Eslint</code> | *No description.* |
|
|
758
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
|
|
759
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.tsconfigEslint">tsconfigEslint</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
|
|
760
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.cdkDeps">cdkDeps</a></code> | <code>projen.awscdk.AwsCdkDeps</code> | *No description.* |
|
|
761
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | The target CDK version for this library. |
|
|
762
|
+
| <code><a href="#@nikovirtala/projen-constructs.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.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.AwsCdkConstructProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
|
|
1585
1585
|
|
|
1586
1586
|
```typescript
|
|
1587
1587
|
public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
|