@rocketleap/rocketleap-projen 0.0.11 → 0.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/.jsii +177 -37
  2. package/.pre-commit-config.yaml +3 -24
  3. package/API.md +1848 -262
  4. package/README.md +103 -1
  5. package/lib/cdk-project.d.ts +29 -7
  6. package/lib/cdk-project.js +75 -19
  7. package/lib/common/compile.d.ts +4 -0
  8. package/lib/common/compile.js +5 -1
  9. package/lib/common/eslint.js +5 -1
  10. package/lib/common/pre-commit.js +3 -7
  11. package/package.json +1 -1
package/API.md CHANGED
@@ -2,29 +2,28 @@
2
2
 
3
3
  ## Constructs <a name="Constructs" id="Constructs"></a>
4
4
 
5
- ### RocketleapCdkProject <a name="RocketleapCdkProject" id="@rocketleap/rocketleap-projen.RocketleapCdkProject"></a>
5
+ ### RocketleapPlatformCdkProject <a name="RocketleapPlatformCdkProject" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject"></a>
6
6
 
7
- A projen project for Rocketleap CDK projects.
7
+ Projen project for Rocketleap Platform CDK projects.
8
8
 
9
- This project type generates a fully configured AWS CDK TypeScript application
10
- with Rocketleap's standard configuration including ESLint, Prettier, Yarn Berry,
11
- and pre-commit hooks.
9
+ This is for platform infrastructure code (e.g., root-cdk, vpc-cdk, iam-cdk).
10
+ Includes the Norberhuis Onderneming B.V. license.
12
11
 
13
- #### Initializers <a name="Initializers" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.Initializer"></a>
12
+ #### Initializers <a name="Initializers" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.Initializer"></a>
14
13
 
15
14
  ```typescript
16
- import { RocketleapCdkProject } from '@rocketleap/rocketleap-projen'
15
+ import { RocketleapPlatformCdkProject } from '@rocketleap/rocketleap-projen'
17
16
 
18
- new RocketleapCdkProject(options: RocketleapCdkProjectOptions)
17
+ new RocketleapPlatformCdkProject(options: RocketleapCdkProjectOptions)
19
18
  ```
20
19
 
21
20
  | **Name** | **Type** | **Description** |
22
21
  | --- | --- | --- |
23
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.Initializer.parameter.options">options</a></code> | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProjectOptions">RocketleapCdkProjectOptions</a></code> | *No description.* |
22
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.Initializer.parameter.options">options</a></code> | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProjectOptions">RocketleapCdkProjectOptions</a></code> | *No description.* |
24
23
 
25
24
  ---
26
25
 
27
- ##### `options`<sup>Required</sup> <a name="options" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.Initializer.parameter.options"></a>
26
+ ##### `options`<sup>Required</sup> <a name="options" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.Initializer.parameter.options"></a>
28
27
 
29
28
  - *Type:* <a href="#@rocketleap/rocketleap-projen.RocketleapCdkProjectOptions">RocketleapCdkProjectOptions</a>
30
29
 
@@ -34,41 +33,41 @@ new RocketleapCdkProject(options: RocketleapCdkProjectOptions)
34
33
 
35
34
  | **Name** | **Description** |
36
35
  | --- | --- |
37
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.toString">toString</a></code> | Returns a string representation of this construct. |
38
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
39
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
40
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
41
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addTask">addTask</a></code> | Adds a new task to this project. |
42
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
43
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
44
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
45
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
46
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.removeTask">removeTask</a></code> | Removes a task from a project. |
47
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
48
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.synth">synth</a></code> | Synthesize all project files into `outdir`. |
49
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
50
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
51
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
52
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
53
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addBins">addBins</a></code> | *No description.* |
54
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
55
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
56
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addDeps">addDeps</a></code> | Defines normal dependencies. |
57
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
58
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
59
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
60
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
61
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
62
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
63
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
64
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
65
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
66
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
67
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.addCdkDependency">addCdkDependency</a></code> | Adds an AWS CDK module dependencies. |
68
-
69
- ---
70
-
71
- ##### `toString` <a name="toString" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.toString"></a>
36
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.toString">toString</a></code> | Returns a string representation of this construct. |
37
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
38
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
39
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
40
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addTask">addTask</a></code> | Adds a new task to this project. |
41
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
42
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
43
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
44
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
45
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.removeTask">removeTask</a></code> | Removes a task from a project. |
46
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
47
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.synth">synth</a></code> | Synthesize all project files into `outdir`. |
48
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
49
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
50
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
51
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
52
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addBins">addBins</a></code> | *No description.* |
53
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
54
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
55
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addDeps">addDeps</a></code> | Defines normal dependencies. |
56
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
57
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
58
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
59
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
60
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
61
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
62
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
63
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
64
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
65
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
66
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addCdkDependency">addCdkDependency</a></code> | Adds an AWS CDK module dependencies. |
67
+
68
+ ---
69
+
70
+ ##### `toString` <a name="toString" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.toString"></a>
72
71
 
73
72
  ```typescript
74
73
  public toString(): string
@@ -76,7 +75,7 @@ public toString(): string
76
75
 
77
76
  Returns a string representation of this construct.
78
77
 
79
- ##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addExcludeFromCleanup"></a>
78
+ ##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addExcludeFromCleanup"></a>
80
79
 
81
80
  ```typescript
82
81
  public addExcludeFromCleanup(globs: ...string[]): void
@@ -87,7 +86,7 @@ Exclude the matching files from pre-synth cleanup.
87
86
  Can be used when, for example, some
88
87
  source files include the projen marker and we don't want them to be erased during synth.
89
88
 
90
- ###### `globs`<sup>Required</sup> <a name="globs" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addExcludeFromCleanup.parameter.globs"></a>
89
+ ###### `globs`<sup>Required</sup> <a name="globs" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addExcludeFromCleanup.parameter.globs"></a>
91
90
 
92
91
  - *Type:* ...string[]
93
92
 
@@ -95,7 +94,7 @@ The glob patterns to match.
95
94
 
96
95
  ---
97
96
 
98
- ##### `addGitIgnore` <a name="addGitIgnore" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addGitIgnore"></a>
97
+ ##### `addGitIgnore` <a name="addGitIgnore" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addGitIgnore"></a>
99
98
 
100
99
  ```typescript
101
100
  public addGitIgnore(pattern: string): void
@@ -103,7 +102,7 @@ public addGitIgnore(pattern: string): void
103
102
 
104
103
  Adds a .gitignore pattern.
105
104
 
106
- ###### `pattern`<sup>Required</sup> <a name="pattern" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addGitIgnore.parameter.pattern"></a>
105
+ ###### `pattern`<sup>Required</sup> <a name="pattern" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addGitIgnore.parameter.pattern"></a>
107
106
 
108
107
  - *Type:* string
109
108
 
@@ -111,7 +110,7 @@ The glob pattern to ignore.
111
110
 
112
111
  ---
113
112
 
114
- ##### `addPackageIgnore` <a name="addPackageIgnore" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addPackageIgnore"></a>
113
+ ##### `addPackageIgnore` <a name="addPackageIgnore" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addPackageIgnore"></a>
115
114
 
116
115
  ```typescript
117
116
  public addPackageIgnore(pattern: string): void
@@ -119,7 +118,7 @@ public addPackageIgnore(pattern: string): void
119
118
 
120
119
  Adds patterns to be ignored by npm.
121
120
 
122
- ###### `pattern`<sup>Required</sup> <a name="pattern" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addPackageIgnore.parameter.pattern"></a>
121
+ ###### `pattern`<sup>Required</sup> <a name="pattern" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addPackageIgnore.parameter.pattern"></a>
123
122
 
124
123
  - *Type:* string
125
124
 
@@ -127,7 +126,7 @@ The pattern to ignore.
127
126
 
128
127
  ---
129
128
 
130
- ##### `addTask` <a name="addTask" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addTask"></a>
129
+ ##### `addTask` <a name="addTask" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addTask"></a>
131
130
 
132
131
  ```typescript
133
132
  public addTask(name: string, props?: TaskOptions): Task
@@ -138,7 +137,7 @@ Adds a new task to this project.
138
137
  This will fail if the project already has
139
138
  a task with this name.
140
139
 
141
- ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addTask.parameter.name"></a>
140
+ ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addTask.parameter.name"></a>
142
141
 
143
142
  - *Type:* string
144
143
 
@@ -146,7 +145,7 @@ The task name to add.
146
145
 
147
146
  ---
148
147
 
149
- ###### `props`<sup>Optional</sup> <a name="props" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addTask.parameter.props"></a>
148
+ ###### `props`<sup>Optional</sup> <a name="props" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addTask.parameter.props"></a>
150
149
 
151
150
  - *Type:* projen.TaskOptions
152
151
 
@@ -154,7 +153,7 @@ Task properties.
154
153
 
155
154
  ---
156
155
 
157
- ##### ~~`addTip`~~ <a name="addTip" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addTip"></a>
156
+ ##### ~~`addTip`~~ <a name="addTip" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addTip"></a>
158
157
 
159
158
  ```typescript
160
159
  public addTip(message: string): void
@@ -162,7 +161,7 @@ public addTip(message: string): void
162
161
 
163
162
  Prints a "tip" message during synthesis.
164
163
 
165
- ###### `message`<sup>Required</sup> <a name="message" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addTip.parameter.message"></a>
164
+ ###### `message`<sup>Required</sup> <a name="message" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addTip.parameter.message"></a>
166
165
 
167
166
  - *Type:* string
168
167
 
@@ -170,7 +169,7 @@ The message.
170
169
 
171
170
  ---
172
171
 
173
- ##### `annotateGenerated` <a name="annotateGenerated" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.annotateGenerated"></a>
172
+ ##### `annotateGenerated` <a name="annotateGenerated" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.annotateGenerated"></a>
174
173
 
175
174
  ```typescript
176
175
  public annotateGenerated(glob: string): void
@@ -184,7 +183,7 @@ repository statistics and language breakdown.
184
183
 
185
184
  > [https://github.com/github/linguist/blob/master/docs/overrides.md](https://github.com/github/linguist/blob/master/docs/overrides.md)
186
185
 
187
- ###### `glob`<sup>Required</sup> <a name="glob" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.annotateGenerated.parameter.glob"></a>
186
+ ###### `glob`<sup>Required</sup> <a name="glob" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.annotateGenerated.parameter.glob"></a>
188
187
 
189
188
  - *Type:* string
190
189
 
@@ -192,7 +191,7 @@ the glob pattern to match (could be a file path).
192
191
 
193
192
  ---
194
193
 
195
- ##### `postSynthesize` <a name="postSynthesize" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.postSynthesize"></a>
194
+ ##### `postSynthesize` <a name="postSynthesize" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.postSynthesize"></a>
196
195
 
197
196
  ```typescript
198
197
  public postSynthesize(): void
@@ -202,7 +201,7 @@ Called after all components are synthesized.
202
201
 
203
202
  Order is *not* guaranteed.
204
203
 
205
- ##### `preSynthesize` <a name="preSynthesize" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.preSynthesize"></a>
204
+ ##### `preSynthesize` <a name="preSynthesize" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.preSynthesize"></a>
206
205
 
207
206
  ```typescript
208
207
  public preSynthesize(): void
@@ -210,7 +209,7 @@ public preSynthesize(): void
210
209
 
211
210
  Called before all components are synthesized.
212
211
 
213
- ##### `removeTask` <a name="removeTask" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.removeTask"></a>
212
+ ##### `removeTask` <a name="removeTask" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.removeTask"></a>
214
213
 
215
214
  ```typescript
216
215
  public removeTask(name: string): Task
@@ -218,7 +217,7 @@ public removeTask(name: string): Task
218
217
 
219
218
  Removes a task from a project.
220
219
 
221
- ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.removeTask.parameter.name"></a>
220
+ ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.removeTask.parameter.name"></a>
222
221
 
223
222
  - *Type:* string
224
223
 
@@ -226,7 +225,7 @@ The name of the task to remove.
226
225
 
227
226
  ---
228
227
 
229
- ##### `runTaskCommand` <a name="runTaskCommand" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.runTaskCommand"></a>
228
+ ##### `runTaskCommand` <a name="runTaskCommand" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.runTaskCommand"></a>
230
229
 
231
230
  ```typescript
232
231
  public runTaskCommand(task: Task): string
@@ -237,7 +236,7 @@ Returns the shell command to execute in order to run a task.
237
236
  This will
238
237
  typically be `npx projen TASK`.
239
238
 
240
- ###### `task`<sup>Required</sup> <a name="task" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.runTaskCommand.parameter.task"></a>
239
+ ###### `task`<sup>Required</sup> <a name="task" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.runTaskCommand.parameter.task"></a>
241
240
 
242
241
  - *Type:* projen.Task
243
242
 
@@ -245,7 +244,7 @@ The task for which the command is required.
245
244
 
246
245
  ---
247
246
 
248
- ##### `synth` <a name="synth" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.synth"></a>
247
+ ##### `synth` <a name="synth" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.synth"></a>
249
248
 
250
249
  ```typescript
251
250
  public synth(): void
@@ -260,7 +259,7 @@ Synthesize all project files into `outdir`.
260
259
  5. Call "postSynthesize()" for all components of this project
261
260
  6. Call "this.postSynthesize()"
262
261
 
263
- ##### `tryFindFile` <a name="tryFindFile" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.tryFindFile"></a>
262
+ ##### `tryFindFile` <a name="tryFindFile" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.tryFindFile"></a>
264
263
 
265
264
  ```typescript
266
265
  public tryFindFile(filePath: string): FileBase
@@ -268,7 +267,7 @@ public tryFindFile(filePath: string): FileBase
268
267
 
269
268
  Finds a file at the specified relative path within this project and all its subprojects.
270
269
 
271
- ###### `filePath`<sup>Required</sup> <a name="filePath" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.tryFindFile.parameter.filePath"></a>
270
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.tryFindFile.parameter.filePath"></a>
272
271
 
273
272
  - *Type:* string
274
273
 
@@ -279,7 +278,7 @@ from the root of _this_ project.
279
278
 
280
279
  ---
281
280
 
282
- ##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.tryFindJsonFile"></a>
281
+ ##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.tryFindJsonFile"></a>
283
282
 
284
283
  ```typescript
285
284
  public tryFindJsonFile(filePath: string): JsonFile
@@ -287,7 +286,7 @@ public tryFindJsonFile(filePath: string): JsonFile
287
286
 
288
287
  Finds a json file by name.
289
288
 
290
- ###### `filePath`<sup>Required</sup> <a name="filePath" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.tryFindJsonFile.parameter.filePath"></a>
289
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.tryFindJsonFile.parameter.filePath"></a>
291
290
 
292
291
  - *Type:* string
293
292
 
@@ -295,7 +294,7 @@ The file path.
295
294
 
296
295
  ---
297
296
 
298
- ##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.tryFindObjectFile"></a>
297
+ ##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.tryFindObjectFile"></a>
299
298
 
300
299
  ```typescript
301
300
  public tryFindObjectFile(filePath: string): ObjectFile
@@ -303,7 +302,7 @@ public tryFindObjectFile(filePath: string): ObjectFile
303
302
 
304
303
  Finds an object file (like JsonFile, YamlFile, etc.) by name.
305
304
 
306
- ###### `filePath`<sup>Required</sup> <a name="filePath" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.tryFindObjectFile.parameter.filePath"></a>
305
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.tryFindObjectFile.parameter.filePath"></a>
307
306
 
308
307
  - *Type:* string
309
308
 
@@ -311,7 +310,7 @@ The file path.
311
310
 
312
311
  ---
313
312
 
314
- ##### `tryRemoveFile` <a name="tryRemoveFile" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.tryRemoveFile"></a>
313
+ ##### `tryRemoveFile` <a name="tryRemoveFile" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.tryRemoveFile"></a>
315
314
 
316
315
  ```typescript
317
316
  public tryRemoveFile(filePath: string): FileBase
@@ -319,7 +318,7 @@ public tryRemoveFile(filePath: string): FileBase
319
318
 
320
319
  Finds a file at the specified relative path within this project and removes it.
321
320
 
322
- ###### `filePath`<sup>Required</sup> <a name="filePath" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.tryRemoveFile.parameter.filePath"></a>
321
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.tryRemoveFile.parameter.filePath"></a>
323
322
 
324
323
  - *Type:* string
325
324
 
@@ -330,19 +329,19 @@ resolved from the root of _this_ project.
330
329
 
331
330
  ---
332
331
 
333
- ##### `addBins` <a name="addBins" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addBins"></a>
332
+ ##### `addBins` <a name="addBins" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addBins"></a>
334
333
 
335
334
  ```typescript
336
335
  public addBins(bins: {[ key: string ]: string}): void
337
336
  ```
338
337
 
339
- ###### `bins`<sup>Required</sup> <a name="bins" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addBins.parameter.bins"></a>
338
+ ###### `bins`<sup>Required</sup> <a name="bins" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addBins.parameter.bins"></a>
340
339
 
341
340
  - *Type:* {[ key: string ]: string}
342
341
 
343
342
  ---
344
343
 
345
- ##### `addBundledDeps` <a name="addBundledDeps" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addBundledDeps"></a>
344
+ ##### `addBundledDeps` <a name="addBundledDeps" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addBundledDeps"></a>
346
345
 
347
346
  ```typescript
348
347
  public addBundledDeps(deps: ...string[]): void
@@ -353,7 +352,7 @@ Defines bundled dependencies.
353
352
  Bundled dependencies will be added as normal dependencies as well as to the
354
353
  `bundledDependencies` section of your `package.json`.
355
354
 
356
- ###### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addBundledDeps.parameter.deps"></a>
355
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addBundledDeps.parameter.deps"></a>
357
356
 
358
357
  - *Type:* ...string[]
359
358
 
@@ -367,7 +366,7 @@ add/upgrade`. If you wish to specify a version range use this syntax:
367
366
 
368
367
  ---
369
368
 
370
- ##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addCompileCommand"></a>
369
+ ##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addCompileCommand"></a>
371
370
 
372
371
  ```typescript
373
372
  public addCompileCommand(commands: ...string[]): void
@@ -375,13 +374,13 @@ public addCompileCommand(commands: ...string[]): void
375
374
 
376
375
  DEPRECATED.
377
376
 
378
- ###### `commands`<sup>Required</sup> <a name="commands" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addCompileCommand.parameter.commands"></a>
377
+ ###### `commands`<sup>Required</sup> <a name="commands" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addCompileCommand.parameter.commands"></a>
379
378
 
380
379
  - *Type:* ...string[]
381
380
 
382
381
  ---
383
382
 
384
- ##### `addDeps` <a name="addDeps" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addDeps"></a>
383
+ ##### `addDeps` <a name="addDeps" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addDeps"></a>
385
384
 
386
385
  ```typescript
387
386
  public addDeps(deps: ...string[]): void
@@ -389,7 +388,7 @@ public addDeps(deps: ...string[]): void
389
388
 
390
389
  Defines normal dependencies.
391
390
 
392
- ###### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addDeps.parameter.deps"></a>
391
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addDeps.parameter.deps"></a>
393
392
 
394
393
  - *Type:* ...string[]
395
394
 
@@ -403,7 +402,7 @@ add/upgrade`. If you wish to specify a version range use this syntax:
403
402
 
404
403
  ---
405
404
 
406
- ##### `addDevDeps` <a name="addDevDeps" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addDevDeps"></a>
405
+ ##### `addDevDeps` <a name="addDevDeps" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addDevDeps"></a>
407
406
 
408
407
  ```typescript
409
408
  public addDevDeps(deps: ...string[]): void
@@ -411,7 +410,7 @@ public addDevDeps(deps: ...string[]): void
411
410
 
412
411
  Defines development/test dependencies.
413
412
 
414
- ###### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addDevDeps.parameter.deps"></a>
413
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addDevDeps.parameter.deps"></a>
415
414
 
416
415
  - *Type:* ...string[]
417
416
 
@@ -425,7 +424,7 @@ add/upgrade`. If you wish to specify a version range use this syntax:
425
424
 
426
425
  ---
427
426
 
428
- ##### `addFields` <a name="addFields" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addFields"></a>
427
+ ##### `addFields` <a name="addFields" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addFields"></a>
429
428
 
430
429
  ```typescript
431
430
  public addFields(fields: {[ key: string ]: any}): void
@@ -433,7 +432,7 @@ public addFields(fields: {[ key: string ]: any}): void
433
432
 
434
433
  Directly set fields in `package.json`.
435
434
 
436
- ###### `fields`<sup>Required</sup> <a name="fields" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addFields.parameter.fields"></a>
435
+ ###### `fields`<sup>Required</sup> <a name="fields" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addFields.parameter.fields"></a>
437
436
 
438
437
  - *Type:* {[ key: string ]: any}
439
438
 
@@ -441,7 +440,7 @@ The fields to set.
441
440
 
442
441
  ---
443
442
 
444
- ##### `addKeywords` <a name="addKeywords" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addKeywords"></a>
443
+ ##### `addKeywords` <a name="addKeywords" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addKeywords"></a>
445
444
 
446
445
  ```typescript
447
446
  public addKeywords(keywords: ...string[]): void
@@ -449,7 +448,7 @@ public addKeywords(keywords: ...string[]): void
449
448
 
450
449
  Adds keywords to package.json (deduplicated).
451
450
 
452
- ###### `keywords`<sup>Required</sup> <a name="keywords" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addKeywords.parameter.keywords"></a>
451
+ ###### `keywords`<sup>Required</sup> <a name="keywords" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addKeywords.parameter.keywords"></a>
453
452
 
454
453
  - *Type:* ...string[]
455
454
 
@@ -457,7 +456,7 @@ The keywords to add.
457
456
 
458
457
  ---
459
458
 
460
- ##### `addPeerDeps` <a name="addPeerDeps" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addPeerDeps"></a>
459
+ ##### `addPeerDeps` <a name="addPeerDeps" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addPeerDeps"></a>
461
460
 
462
461
  ```typescript
463
462
  public addPeerDeps(deps: ...string[]): void
@@ -469,7 +468,7 @@ When adding peer dependencies, a devDependency will also be added on the
469
468
  pinned version of the declared peer. This will ensure that you are testing
470
469
  your code against the minimum version required from your consumers.
471
470
 
472
- ###### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addPeerDeps.parameter.deps"></a>
471
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addPeerDeps.parameter.deps"></a>
473
472
 
474
473
  - *Type:* ...string[]
475
474
 
@@ -483,7 +482,7 @@ add/upgrade`. If you wish to specify a version range use this syntax:
483
482
 
484
483
  ---
485
484
 
486
- ##### `addScripts` <a name="addScripts" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addScripts"></a>
485
+ ##### `addScripts` <a name="addScripts" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addScripts"></a>
487
486
 
488
487
  ```typescript
489
488
  public addScripts(scripts: {[ key: string ]: string}): void
@@ -491,7 +490,7 @@ public addScripts(scripts: {[ key: string ]: string}): void
491
490
 
492
491
  Replaces the contents of multiple npm package.json scripts.
493
492
 
494
- ###### `scripts`<sup>Required</sup> <a name="scripts" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addScripts.parameter.scripts"></a>
493
+ ###### `scripts`<sup>Required</sup> <a name="scripts" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addScripts.parameter.scripts"></a>
495
494
 
496
495
  - *Type:* {[ key: string ]: string}
497
496
 
@@ -499,7 +498,7 @@ The scripts to set.
499
498
 
500
499
  ---
501
500
 
502
- ##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addTestCommand"></a>
501
+ ##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addTestCommand"></a>
503
502
 
504
503
  ```typescript
505
504
  public addTestCommand(commands: ...string[]): void
@@ -507,13 +506,13 @@ public addTestCommand(commands: ...string[]): void
507
506
 
508
507
  DEPRECATED.
509
508
 
510
- ###### `commands`<sup>Required</sup> <a name="commands" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addTestCommand.parameter.commands"></a>
509
+ ###### `commands`<sup>Required</sup> <a name="commands" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addTestCommand.parameter.commands"></a>
511
510
 
512
511
  - *Type:* ...string[]
513
512
 
514
513
  ---
515
514
 
516
- ##### ~~`hasScript`~~ <a name="hasScript" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.hasScript"></a>
515
+ ##### ~~`hasScript`~~ <a name="hasScript" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.hasScript"></a>
517
516
 
518
517
  ```typescript
519
518
  public hasScript(name: string): boolean
@@ -521,7 +520,7 @@ public hasScript(name: string): boolean
521
520
 
522
521
  Indicates if a script by the name name is defined.
523
522
 
524
- ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.hasScript.parameter.name"></a>
523
+ ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.hasScript.parameter.name"></a>
525
524
 
526
525
  - *Type:* string
527
526
 
@@ -529,7 +528,7 @@ The name of the script.
529
528
 
530
529
  ---
531
530
 
532
- ##### `removeScript` <a name="removeScript" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.removeScript"></a>
531
+ ##### `removeScript` <a name="removeScript" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.removeScript"></a>
533
532
 
534
533
  ```typescript
535
534
  public removeScript(name: string): void
@@ -537,7 +536,7 @@ public removeScript(name: string): void
537
536
 
538
537
  Removes the npm script (always successful).
539
538
 
540
- ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.removeScript.parameter.name"></a>
539
+ ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.removeScript.parameter.name"></a>
541
540
 
542
541
  - *Type:* string
543
542
 
@@ -545,7 +544,7 @@ The name of the script.
545
544
 
546
545
  ---
547
546
 
548
- ##### `renderWorkflowSetup` <a name="renderWorkflowSetup" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.renderWorkflowSetup"></a>
547
+ ##### `renderWorkflowSetup` <a name="renderWorkflowSetup" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.renderWorkflowSetup"></a>
549
548
 
550
549
  ```typescript
551
550
  public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]
@@ -553,7 +552,7 @@ public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]
553
552
 
554
553
  Returns the set of workflow steps which should be executed to bootstrap a workflow.
555
554
 
556
- ###### `options`<sup>Optional</sup> <a name="options" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.renderWorkflowSetup.parameter.options"></a>
555
+ ###### `options`<sup>Optional</sup> <a name="options" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.renderWorkflowSetup.parameter.options"></a>
557
556
 
558
557
  - *Type:* projen.javascript.RenderWorkflowSetupOptions
559
558
 
@@ -561,7 +560,7 @@ Options.
561
560
 
562
561
  ---
563
562
 
564
- ##### `setScript` <a name="setScript" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.setScript"></a>
563
+ ##### `setScript` <a name="setScript" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.setScript"></a>
565
564
 
566
565
  ```typescript
567
566
  public setScript(name: string, command: string): void
@@ -569,7 +568,7 @@ public setScript(name: string, command: string): void
569
568
 
570
569
  Replaces the contents of an npm package.json script.
571
570
 
572
- ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.setScript.parameter.name"></a>
571
+ ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.setScript.parameter.name"></a>
573
572
 
574
573
  - *Type:* string
575
574
 
@@ -577,7 +576,7 @@ The script name.
577
576
 
578
577
  ---
579
578
 
580
- ###### `command`<sup>Required</sup> <a name="command" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.setScript.parameter.command"></a>
579
+ ###### `command`<sup>Required</sup> <a name="command" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.setScript.parameter.command"></a>
581
580
 
582
581
  - *Type:* string
583
582
 
@@ -585,7 +584,7 @@ The command to execute.
585
584
 
586
585
  ---
587
586
 
588
- ##### `addCdkDependency` <a name="addCdkDependency" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addCdkDependency"></a>
587
+ ##### `addCdkDependency` <a name="addCdkDependency" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addCdkDependency"></a>
589
588
 
590
589
  ```typescript
591
590
  public addCdkDependency(modules: ...string[]): void
@@ -593,7 +592,7 @@ public addCdkDependency(modules: ...string[]): void
593
592
 
594
593
  Adds an AWS CDK module dependencies.
595
594
 
596
- ###### `modules`<sup>Required</sup> <a name="modules" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.addCdkDependency.parameter.modules"></a>
595
+ ###### `modules`<sup>Required</sup> <a name="modules" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.addCdkDependency.parameter.modules"></a>
597
596
 
598
597
  - *Type:* ...string[]
599
598
 
@@ -605,23 +604,23 @@ The list of modules to depend on.
605
604
 
606
605
  | **Name** | **Description** |
607
606
  | --- | --- |
608
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
609
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.isProject">isProject</a></code> | Test whether the given construct is a project. |
610
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.of">of</a></code> | Find the closest ancestor project for given construct. |
607
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
608
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.isProject">isProject</a></code> | Test whether the given construct is a project. |
609
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.of">of</a></code> | Find the closest ancestor project for given construct. |
611
610
 
612
611
  ---
613
612
 
614
- ##### ~~`isConstruct`~~ <a name="isConstruct" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.isConstruct"></a>
613
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.isConstruct"></a>
615
614
 
616
615
  ```typescript
617
- import { RocketleapCdkProject } from '@rocketleap/rocketleap-projen'
616
+ import { RocketleapPlatformCdkProject } from '@rocketleap/rocketleap-projen'
618
617
 
619
- RocketleapCdkProject.isConstruct(x: any)
618
+ RocketleapPlatformCdkProject.isConstruct(x: any)
620
619
  ```
621
620
 
622
621
  Checks if `x` is a construct.
623
622
 
624
- ###### `x`<sup>Required</sup> <a name="x" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.isConstruct.parameter.x"></a>
623
+ ###### `x`<sup>Required</sup> <a name="x" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.isConstruct.parameter.x"></a>
625
624
 
626
625
  - *Type:* any
627
626
 
@@ -629,35 +628,35 @@ Any object.
629
628
 
630
629
  ---
631
630
 
632
- ##### `isProject` <a name="isProject" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.isProject"></a>
631
+ ##### `isProject` <a name="isProject" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.isProject"></a>
633
632
 
634
633
  ```typescript
635
- import { RocketleapCdkProject } from '@rocketleap/rocketleap-projen'
634
+ import { RocketleapPlatformCdkProject } from '@rocketleap/rocketleap-projen'
636
635
 
637
- RocketleapCdkProject.isProject(x: any)
636
+ RocketleapPlatformCdkProject.isProject(x: any)
638
637
  ```
639
638
 
640
639
  Test whether the given construct is a project.
641
640
 
642
- ###### `x`<sup>Required</sup> <a name="x" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.isProject.parameter.x"></a>
641
+ ###### `x`<sup>Required</sup> <a name="x" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.isProject.parameter.x"></a>
643
642
 
644
643
  - *Type:* any
645
644
 
646
645
  ---
647
646
 
648
- ##### `of` <a name="of" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.of"></a>
647
+ ##### `of` <a name="of" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.of"></a>
649
648
 
650
649
  ```typescript
651
- import { RocketleapCdkProject } from '@rocketleap/rocketleap-projen'
650
+ import { RocketleapPlatformCdkProject } from '@rocketleap/rocketleap-projen'
652
651
 
653
- RocketleapCdkProject.of(construct: IConstruct)
652
+ RocketleapPlatformCdkProject.of(construct: IConstruct)
654
653
  ```
655
654
 
656
655
  Find the closest ancestor project for given construct.
657
656
 
658
657
  When given a project, this it the project itself.
659
658
 
660
- ###### `construct`<sup>Required</sup> <a name="construct" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.of.parameter.construct"></a>
659
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.of.parameter.construct"></a>
661
660
 
662
661
  - *Type:* constructs.IConstruct
663
662
 
@@ -667,78 +666,78 @@ When given a project, this it the project itself.
667
666
 
668
667
  | **Name** | **Type** | **Description** |
669
668
  | --- | --- | --- |
670
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
671
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.buildTask">buildTask</a></code> | <code>projen.Task</code> | *No description.* |
672
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
673
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.compileTask">compileTask</a></code> | <code>projen.Task</code> | *No description.* |
674
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.components">components</a></code> | <code>projen.Component[]</code> | Returns all the components within this project. |
675
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.deps">deps</a></code> | <code>projen.Dependencies</code> | Project dependencies. |
676
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.ejected">ejected</a></code> | <code>boolean</code> | Whether or not the project is being ejected. |
677
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.files">files</a></code> | <code>projen.FileBase[]</code> | All files in this project. |
678
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.gitattributes">gitattributes</a></code> | <code>projen.GitAttributesFile</code> | The .gitattributes file for this repository. |
679
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.gitignore">gitignore</a></code> | <code>projen.IgnoreFile</code> | .gitignore. |
680
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.logger">logger</a></code> | <code>projen.Logger</code> | Logging utilities. |
681
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.name">name</a></code> | <code>string</code> | Project name. |
682
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.outdir">outdir</a></code> | <code>string</code> | Absolute output directory of this project. |
683
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.packageTask">packageTask</a></code> | <code>projen.Task</code> | *No description.* |
684
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.postCompileTask">postCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
685
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.preCompileTask">preCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
686
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
687
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.projenCommand">projenCommand</a></code> | <code>string</code> | The command to use in order to run the projen CLI. |
688
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
689
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.subprojects">subprojects</a></code> | <code>projen.Project[]</code> | Returns all the subprojects within this project. |
690
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
691
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
692
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
693
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
694
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
695
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
696
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
697
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
698
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
699
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
700
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
701
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
702
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
703
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
704
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
705
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
706
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
707
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
708
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
709
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
710
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.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). |
711
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
712
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
713
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
714
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
715
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
716
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version supported by this package. |
717
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
718
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
719
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
720
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
721
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
722
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
723
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
724
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
725
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
726
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
727
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
728
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.watchTask">watchTask</a></code> | <code>projen.Task</code> | The "watch" task. |
729
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.docgen">docgen</a></code> | <code>boolean</code> | *No description.* |
730
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.eslint">eslint</a></code> | <code>projen.javascript.Eslint</code> | *No description.* |
731
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
732
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.tsconfigEslint">tsconfigEslint</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
733
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.appEntrypoint">appEntrypoint</a></code> | <code>string</code> | The CDK app entrypoint. |
734
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.cdkConfig">cdkConfig</a></code> | <code>projen.awscdk.CdkConfig</code> | cdk.json configuration. |
735
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.cdkDeps">cdkDeps</a></code> | <code>projen.awscdk.AwsCdkDeps</code> | *No description.* |
736
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.cdkTasks">cdkTasks</a></code> | <code>projen.awscdk.CdkTasks</code> | Common CDK tasks. |
737
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | The CDK version this app is using. |
738
-
739
- ---
740
-
741
- ##### `node`<sup>Required</sup> <a name="node" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.node"></a>
669
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
670
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.buildTask">buildTask</a></code> | <code>projen.Task</code> | *No description.* |
671
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
672
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.compileTask">compileTask</a></code> | <code>projen.Task</code> | *No description.* |
673
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.components">components</a></code> | <code>projen.Component[]</code> | Returns all the components within this project. |
674
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.deps">deps</a></code> | <code>projen.Dependencies</code> | Project dependencies. |
675
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.ejected">ejected</a></code> | <code>boolean</code> | Whether or not the project is being ejected. |
676
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.files">files</a></code> | <code>projen.FileBase[]</code> | All files in this project. |
677
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.gitattributes">gitattributes</a></code> | <code>projen.GitAttributesFile</code> | The .gitattributes file for this repository. |
678
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.gitignore">gitignore</a></code> | <code>projen.IgnoreFile</code> | .gitignore. |
679
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.logger">logger</a></code> | <code>projen.Logger</code> | Logging utilities. |
680
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.name">name</a></code> | <code>string</code> | Project name. |
681
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.outdir">outdir</a></code> | <code>string</code> | Absolute output directory of this project. |
682
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.packageTask">packageTask</a></code> | <code>projen.Task</code> | *No description.* |
683
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.postCompileTask">postCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
684
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.preCompileTask">preCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
685
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
686
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.projenCommand">projenCommand</a></code> | <code>string</code> | The command to use in order to run the projen CLI. |
687
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
688
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.subprojects">subprojects</a></code> | <code>projen.Project[]</code> | Returns all the subprojects within this project. |
689
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
690
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
691
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
692
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
693
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
694
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
695
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
696
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
697
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
698
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
699
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
700
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
701
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
702
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
703
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
704
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
705
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
706
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
707
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
708
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
709
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.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). |
710
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
711
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
712
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
713
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
714
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
715
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version supported by this package. |
716
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
717
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
718
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
719
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
720
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
721
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
722
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
723
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
724
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
725
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
726
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
727
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.watchTask">watchTask</a></code> | <code>projen.Task</code> | The "watch" task. |
728
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.docgen">docgen</a></code> | <code>boolean</code> | *No description.* |
729
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.eslint">eslint</a></code> | <code>projen.javascript.Eslint</code> | *No description.* |
730
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
731
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.tsconfigEslint">tsconfigEslint</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
732
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.appEntrypoint">appEntrypoint</a></code> | <code>string</code> | The CDK app entrypoint. |
733
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.cdkConfig">cdkConfig</a></code> | <code>projen.awscdk.CdkConfig</code> | cdk.json configuration. |
734
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.cdkDeps">cdkDeps</a></code> | <code>projen.awscdk.AwsCdkDeps</code> | *No description.* |
735
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.cdkTasks">cdkTasks</a></code> | <code>projen.awscdk.CdkTasks</code> | Common CDK tasks. |
736
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | The CDK version this app is using. |
737
+
738
+ ---
739
+
740
+ ##### `node`<sup>Required</sup> <a name="node" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.node"></a>
742
741
 
743
742
  ```typescript
744
743
  public readonly node: Node;
@@ -750,7 +749,7 @@ The tree node.
750
749
 
751
750
  ---
752
751
 
753
- ##### `buildTask`<sup>Required</sup> <a name="buildTask" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.buildTask"></a>
752
+ ##### `buildTask`<sup>Required</sup> <a name="buildTask" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.buildTask"></a>
754
753
 
755
754
  ```typescript
756
755
  public readonly buildTask: Task;
@@ -760,7 +759,7 @@ public readonly buildTask: Task;
760
759
 
761
760
  ---
762
761
 
763
- ##### `commitGenerated`<sup>Required</sup> <a name="commitGenerated" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.commitGenerated"></a>
762
+ ##### `commitGenerated`<sup>Required</sup> <a name="commitGenerated" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.commitGenerated"></a>
764
763
 
765
764
  ```typescript
766
765
  public readonly commitGenerated: boolean;
@@ -772,7 +771,7 @@ Whether to commit the managed files by default.
772
771
 
773
772
  ---
774
773
 
775
- ##### `compileTask`<sup>Required</sup> <a name="compileTask" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.compileTask"></a>
774
+ ##### `compileTask`<sup>Required</sup> <a name="compileTask" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.compileTask"></a>
776
775
 
777
776
  ```typescript
778
777
  public readonly compileTask: Task;
@@ -782,7 +781,7 @@ public readonly compileTask: Task;
782
781
 
783
782
  ---
784
783
 
785
- ##### `components`<sup>Required</sup> <a name="components" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.components"></a>
784
+ ##### `components`<sup>Required</sup> <a name="components" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.components"></a>
786
785
 
787
786
  ```typescript
788
787
  public readonly components: Component[];
@@ -794,7 +793,7 @@ Returns all the components within this project.
794
793
 
795
794
  ---
796
795
 
797
- ##### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.deps"></a>
796
+ ##### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.deps"></a>
798
797
 
799
798
  ```typescript
800
799
  public readonly deps: Dependencies;
@@ -806,7 +805,7 @@ Project dependencies.
806
805
 
807
806
  ---
808
807
 
809
- ##### `ejected`<sup>Required</sup> <a name="ejected" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.ejected"></a>
808
+ ##### `ejected`<sup>Required</sup> <a name="ejected" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.ejected"></a>
810
809
 
811
810
  ```typescript
812
811
  public readonly ejected: boolean;
@@ -818,7 +817,7 @@ Whether or not the project is being ejected.
818
817
 
819
818
  ---
820
819
 
821
- ##### `files`<sup>Required</sup> <a name="files" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.files"></a>
820
+ ##### `files`<sup>Required</sup> <a name="files" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.files"></a>
822
821
 
823
822
  ```typescript
824
823
  public readonly files: FileBase[];
@@ -830,7 +829,7 @@ All files in this project.
830
829
 
831
830
  ---
832
831
 
833
- ##### `gitattributes`<sup>Required</sup> <a name="gitattributes" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.gitattributes"></a>
832
+ ##### `gitattributes`<sup>Required</sup> <a name="gitattributes" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.gitattributes"></a>
834
833
 
835
834
  ```typescript
836
835
  public readonly gitattributes: GitAttributesFile;
@@ -842,7 +841,7 @@ The .gitattributes file for this repository.
842
841
 
843
842
  ---
844
843
 
845
- ##### `gitignore`<sup>Required</sup> <a name="gitignore" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.gitignore"></a>
844
+ ##### `gitignore`<sup>Required</sup> <a name="gitignore" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.gitignore"></a>
846
845
 
847
846
  ```typescript
848
847
  public readonly gitignore: IgnoreFile;
@@ -854,7 +853,7 @@ public readonly gitignore: IgnoreFile;
854
853
 
855
854
  ---
856
855
 
857
- ##### `logger`<sup>Required</sup> <a name="logger" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.logger"></a>
856
+ ##### `logger`<sup>Required</sup> <a name="logger" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.logger"></a>
858
857
 
859
858
  ```typescript
860
859
  public readonly logger: Logger;
@@ -866,7 +865,7 @@ Logging utilities.
866
865
 
867
866
  ---
868
867
 
869
- ##### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.name"></a>
868
+ ##### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.name"></a>
870
869
 
871
870
  ```typescript
872
871
  public readonly name: string;
@@ -878,7 +877,7 @@ Project name.
878
877
 
879
878
  ---
880
879
 
881
- ##### `outdir`<sup>Required</sup> <a name="outdir" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.outdir"></a>
880
+ ##### `outdir`<sup>Required</sup> <a name="outdir" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.outdir"></a>
882
881
 
883
882
  ```typescript
884
883
  public readonly outdir: string;
@@ -890,7 +889,7 @@ Absolute output directory of this project.
890
889
 
891
890
  ---
892
891
 
893
- ##### `packageTask`<sup>Required</sup> <a name="packageTask" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.packageTask"></a>
892
+ ##### `packageTask`<sup>Required</sup> <a name="packageTask" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.packageTask"></a>
894
893
 
895
894
  ```typescript
896
895
  public readonly packageTask: Task;
@@ -900,7 +899,7 @@ public readonly packageTask: Task;
900
899
 
901
900
  ---
902
901
 
903
- ##### `postCompileTask`<sup>Required</sup> <a name="postCompileTask" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.postCompileTask"></a>
902
+ ##### `postCompileTask`<sup>Required</sup> <a name="postCompileTask" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.postCompileTask"></a>
904
903
 
905
904
  ```typescript
906
905
  public readonly postCompileTask: Task;
@@ -910,7 +909,7 @@ public readonly postCompileTask: Task;
910
909
 
911
910
  ---
912
911
 
913
- ##### `preCompileTask`<sup>Required</sup> <a name="preCompileTask" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.preCompileTask"></a>
912
+ ##### `preCompileTask`<sup>Required</sup> <a name="preCompileTask" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.preCompileTask"></a>
914
913
 
915
914
  ```typescript
916
915
  public readonly preCompileTask: Task;
@@ -920,7 +919,7 @@ public readonly preCompileTask: Task;
920
919
 
921
920
  ---
922
921
 
923
- ##### `projectBuild`<sup>Required</sup> <a name="projectBuild" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.projectBuild"></a>
922
+ ##### `projectBuild`<sup>Required</sup> <a name="projectBuild" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.projectBuild"></a>
924
923
 
925
924
  ```typescript
926
925
  public readonly projectBuild: ProjectBuild;
@@ -932,7 +931,7 @@ Manages the build process of the project.
932
931
 
933
932
  ---
934
933
 
935
- ##### `projenCommand`<sup>Required</sup> <a name="projenCommand" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.projenCommand"></a>
934
+ ##### `projenCommand`<sup>Required</sup> <a name="projenCommand" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.projenCommand"></a>
936
935
 
937
936
  ```typescript
938
937
  public readonly projenCommand: string;
@@ -944,7 +943,7 @@ The command to use in order to run the projen CLI.
944
943
 
945
944
  ---
946
945
 
947
- ##### `root`<sup>Required</sup> <a name="root" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.root"></a>
946
+ ##### `root`<sup>Required</sup> <a name="root" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.root"></a>
948
947
 
949
948
  ```typescript
950
949
  public readonly root: Project;
@@ -956,7 +955,7 @@ The root project.
956
955
 
957
956
  ---
958
957
 
959
- ##### `subprojects`<sup>Required</sup> <a name="subprojects" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.subprojects"></a>
958
+ ##### `subprojects`<sup>Required</sup> <a name="subprojects" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.subprojects"></a>
960
959
 
961
960
  ```typescript
962
961
  public readonly subprojects: Project[];
@@ -968,7 +967,7 @@ Returns all the subprojects within this project.
968
967
 
969
968
  ---
970
969
 
971
- ##### `tasks`<sup>Required</sup> <a name="tasks" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.tasks"></a>
970
+ ##### `tasks`<sup>Required</sup> <a name="tasks" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.tasks"></a>
972
971
 
973
972
  ```typescript
974
973
  public readonly tasks: Tasks;
@@ -980,7 +979,7 @@ Project tasks.
980
979
 
981
980
  ---
982
981
 
983
- ##### `testTask`<sup>Required</sup> <a name="testTask" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.testTask"></a>
982
+ ##### `testTask`<sup>Required</sup> <a name="testTask" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.testTask"></a>
984
983
 
985
984
  ```typescript
986
985
  public readonly testTask: Task;
@@ -990,7 +989,7 @@ public readonly testTask: Task;
990
989
 
991
990
  ---
992
991
 
993
- ##### `defaultTask`<sup>Optional</sup> <a name="defaultTask" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.defaultTask"></a>
992
+ ##### `defaultTask`<sup>Optional</sup> <a name="defaultTask" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.defaultTask"></a>
994
993
 
995
994
  ```typescript
996
995
  public readonly defaultTask: Task;
@@ -1005,7 +1004,7 @@ the project is being ejected.
1005
1004
 
1006
1005
  ---
1007
1006
 
1008
- ##### `initProject`<sup>Optional</sup> <a name="initProject" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.initProject"></a>
1007
+ ##### `initProject`<sup>Optional</sup> <a name="initProject" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.initProject"></a>
1009
1008
 
1010
1009
  ```typescript
1011
1010
  public readonly initProject: InitProject;
@@ -1021,7 +1020,7 @@ FQN of the project type.
1021
1020
 
1022
1021
  ---
1023
1022
 
1024
- ##### `parent`<sup>Optional</sup> <a name="parent" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.parent"></a>
1023
+ ##### `parent`<sup>Optional</sup> <a name="parent" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.parent"></a>
1025
1024
 
1026
1025
  ```typescript
1027
1026
  public readonly parent: Project;
@@ -1035,7 +1034,7 @@ If undefined, this is the root project.
1035
1034
 
1036
1035
  ---
1037
1036
 
1038
- ##### `projectType`<sup>Required</sup> <a name="projectType" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.projectType"></a>
1037
+ ##### `projectType`<sup>Required</sup> <a name="projectType" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.projectType"></a>
1039
1038
 
1040
1039
  ```typescript
1041
1040
  public readonly projectType: ProjectType;
@@ -1045,7 +1044,7 @@ public readonly projectType: ProjectType;
1045
1044
 
1046
1045
  ---
1047
1046
 
1048
- ##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.autoApprove"></a>
1047
+ ##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.autoApprove"></a>
1049
1048
 
1050
1049
  ```typescript
1051
1050
  public readonly autoApprove: AutoApprove;
@@ -1057,7 +1056,7 @@ Auto approve set up for this project.
1057
1056
 
1058
1057
  ---
1059
1058
 
1060
- ##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.devContainer"></a>
1059
+ ##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.devContainer"></a>
1061
1060
 
1062
1061
  ```typescript
1063
1062
  public readonly devContainer: DevContainer;
@@ -1071,7 +1070,7 @@ This will be `undefined` if devContainer boolean is false
1071
1070
 
1072
1071
  ---
1073
1072
 
1074
- ##### `github`<sup>Optional</sup> <a name="github" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.github"></a>
1073
+ ##### `github`<sup>Optional</sup> <a name="github" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.github"></a>
1075
1074
 
1076
1075
  ```typescript
1077
1076
  public readonly github: GitHub;
@@ -1085,7 +1084,7 @@ This will be `undefined` for subprojects.
1085
1084
 
1086
1085
  ---
1087
1086
 
1088
- ##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.gitpod"></a>
1087
+ ##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.gitpod"></a>
1089
1088
 
1090
1089
  ```typescript
1091
1090
  public readonly gitpod: Gitpod;
@@ -1099,7 +1098,7 @@ This will be `undefined` if gitpod boolean is false
1099
1098
 
1100
1099
  ---
1101
1100
 
1102
- ##### `vscode`<sup>Optional</sup> <a name="vscode" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.vscode"></a>
1101
+ ##### `vscode`<sup>Optional</sup> <a name="vscode" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.vscode"></a>
1103
1102
 
1104
1103
  ```typescript
1105
1104
  public readonly vscode: VsCode;
@@ -1113,7 +1112,7 @@ This will be `undefined` for subprojects.
1113
1112
 
1114
1113
  ---
1115
1114
 
1116
- ##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.allowLibraryDependencies"></a>
1115
+ ##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.allowLibraryDependencies"></a>
1117
1116
 
1118
1117
  - *Deprecated:* use `package.allowLibraryDependencies`
1119
1118
 
@@ -1125,7 +1124,7 @@ public readonly allowLibraryDependencies: boolean;
1125
1124
 
1126
1125
  ---
1127
1126
 
1128
- ##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.artifactsDirectory"></a>
1127
+ ##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.artifactsDirectory"></a>
1129
1128
 
1130
1129
  ```typescript
1131
1130
  public readonly artifactsDirectory: string;
@@ -1141,7 +1140,7 @@ tarball will be placed under `dist/js/boom-boom-1.2.3.tg`.
1141
1140
 
1142
1141
  ---
1143
1142
 
1144
- ##### `artifactsJavascriptDirectory`<sup>Required</sup> <a name="artifactsJavascriptDirectory" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.artifactsJavascriptDirectory"></a>
1143
+ ##### `artifactsJavascriptDirectory`<sup>Required</sup> <a name="artifactsJavascriptDirectory" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.artifactsJavascriptDirectory"></a>
1145
1144
 
1146
1145
  ```typescript
1147
1146
  public readonly artifactsJavascriptDirectory: string;
@@ -1153,7 +1152,7 @@ The location of the npm tarball after build (`${artifactsDirectory}/js`).
1153
1152
 
1154
1153
  ---
1155
1154
 
1156
- ##### `bundler`<sup>Required</sup> <a name="bundler" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.bundler"></a>
1155
+ ##### `bundler`<sup>Required</sup> <a name="bundler" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.bundler"></a>
1157
1156
 
1158
1157
  ```typescript
1159
1158
  public readonly bundler: Bundler;
@@ -1163,7 +1162,7 @@ public readonly bundler: Bundler;
1163
1162
 
1164
1163
  ---
1165
1164
 
1166
- ##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.entrypoint"></a>
1165
+ ##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.entrypoint"></a>
1167
1166
 
1168
1167
  - *Deprecated:* use `package.entrypoint`
1169
1168
 
@@ -1175,7 +1174,7 @@ public readonly entrypoint: string;
1175
1174
 
1176
1175
  ---
1177
1176
 
1178
- ##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.manifest"></a>
1177
+ ##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.manifest"></a>
1179
1178
 
1180
1179
  - *Deprecated:* use `package.addField(x, y)`
1181
1180
 
@@ -1187,7 +1186,7 @@ public readonly manifest: any;
1187
1186
 
1188
1187
  ---
1189
1188
 
1190
- ##### `npmrc`<sup>Required</sup> <a name="npmrc" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.npmrc"></a>
1189
+ ##### `npmrc`<sup>Required</sup> <a name="npmrc" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.npmrc"></a>
1191
1190
 
1192
1191
  ```typescript
1193
1192
  public readonly npmrc: NpmConfig;
@@ -1199,7 +1198,7 @@ The .npmrc file.
1199
1198
 
1200
1199
  ---
1201
1200
 
1202
- ##### `package`<sup>Required</sup> <a name="package" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.package"></a>
1201
+ ##### `package`<sup>Required</sup> <a name="package" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.package"></a>
1203
1202
 
1204
1203
  ```typescript
1205
1204
  public readonly package: NodePackage;
@@ -1211,7 +1210,7 @@ API for managing the node package.
1211
1210
 
1212
1211
  ---
1213
1212
 
1214
- ##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.packageManager"></a>
1213
+ ##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.packageManager"></a>
1215
1214
 
1216
1215
  - *Deprecated:* use `package.packageManager`
1217
1216
 
@@ -1225,7 +1224,7 @@ The package manager to use.
1225
1224
 
1226
1225
  ---
1227
1226
 
1228
- ##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.runScriptCommand"></a>
1227
+ ##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.runScriptCommand"></a>
1229
1228
 
1230
1229
  ```typescript
1231
1230
  public readonly runScriptCommand: string;
@@ -1237,7 +1236,7 @@ The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the p
1237
1236
 
1238
1237
  ---
1239
1238
 
1240
- ##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.autoMerge"></a>
1239
+ ##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.autoMerge"></a>
1241
1240
 
1242
1241
  ```typescript
1243
1242
  public readonly autoMerge: AutoMerge;
@@ -1249,7 +1248,7 @@ Component that sets up mergify for merging approved pull requests.
1249
1248
 
1250
1249
  ---
1251
1250
 
1252
- ##### `biome`<sup>Optional</sup> <a name="biome" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.biome"></a>
1251
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.biome"></a>
1253
1252
 
1254
1253
  ```typescript
1255
1254
  public readonly biome: Biome;
@@ -1259,7 +1258,7 @@ public readonly biome: Biome;
1259
1258
 
1260
1259
  ---
1261
1260
 
1262
- ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.buildWorkflow"></a>
1261
+ ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.buildWorkflow"></a>
1263
1262
 
1264
1263
  ```typescript
1265
1264
  public readonly buildWorkflow: BuildWorkflow;
@@ -1273,7 +1272,7 @@ The PR build GitHub workflow.
1273
1272
 
1274
1273
  ---
1275
1274
 
1276
- ##### `buildWorkflowJobId`<sup>Optional</sup> <a name="buildWorkflowJobId" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.buildWorkflowJobId"></a>
1275
+ ##### `buildWorkflowJobId`<sup>Optional</sup> <a name="buildWorkflowJobId" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.buildWorkflowJobId"></a>
1277
1276
 
1278
1277
  ```typescript
1279
1278
  public readonly buildWorkflowJobId: string;
@@ -1285,7 +1284,7 @@ The job ID of the build workflow.
1285
1284
 
1286
1285
  ---
1287
1286
 
1288
- ##### `jest`<sup>Optional</sup> <a name="jest" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.jest"></a>
1287
+ ##### `jest`<sup>Optional</sup> <a name="jest" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.jest"></a>
1289
1288
 
1290
1289
  ```typescript
1291
1290
  public readonly jest: Jest;
@@ -1297,7 +1296,7 @@ The Jest configuration (if enabled).
1297
1296
 
1298
1297
  ---
1299
1298
 
1300
- ##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.maxNodeVersion"></a>
1299
+ ##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.maxNodeVersion"></a>
1301
1300
 
1302
1301
  ```typescript
1303
1302
  public readonly maxNodeVersion: string;
@@ -1311,7 +1310,7 @@ The value indicates the package is incompatible with newer versions.
1311
1310
 
1312
1311
  ---
1313
1312
 
1314
- ##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.minNodeVersion"></a>
1313
+ ##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.minNodeVersion"></a>
1315
1314
 
1316
1315
  ```typescript
1317
1316
  public readonly minNodeVersion: string;
@@ -1325,7 +1324,7 @@ This value indicates the package is incompatible with older versions.
1325
1324
 
1326
1325
  ---
1327
1326
 
1328
- ##### `npmignore`<sup>Optional</sup> <a name="npmignore" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.npmignore"></a>
1327
+ ##### `npmignore`<sup>Optional</sup> <a name="npmignore" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.npmignore"></a>
1329
1328
 
1330
1329
  ```typescript
1331
1330
  public readonly npmignore: IgnoreFile;
@@ -1337,7 +1336,7 @@ The .npmignore file.
1337
1336
 
1338
1337
  ---
1339
1338
 
1340
- ##### `prettier`<sup>Optional</sup> <a name="prettier" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.prettier"></a>
1339
+ ##### `prettier`<sup>Optional</sup> <a name="prettier" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.prettier"></a>
1341
1340
 
1342
1341
  ```typescript
1343
1342
  public readonly prettier: Prettier;
@@ -1347,7 +1346,7 @@ public readonly prettier: Prettier;
1347
1346
 
1348
1347
  ---
1349
1348
 
1350
- ##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.publisher"></a>
1349
+ ##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.publisher"></a>
1351
1350
 
1352
1351
  - *Deprecated:* use `release.publisher`.
1353
1352
 
@@ -1364,7 +1363,7 @@ release workflow.
1364
1363
 
1365
1364
  ---
1366
1365
 
1367
- ##### `release`<sup>Optional</sup> <a name="release" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.release"></a>
1366
+ ##### `release`<sup>Optional</sup> <a name="release" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.release"></a>
1368
1367
 
1369
1368
  ```typescript
1370
1369
  public readonly release: Release;
@@ -1376,7 +1375,7 @@ Release management.
1376
1375
 
1377
1376
  ---
1378
1377
 
1379
- ##### `upgradeWorkflow`<sup>Optional</sup> <a name="upgradeWorkflow" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.upgradeWorkflow"></a>
1378
+ ##### `upgradeWorkflow`<sup>Optional</sup> <a name="upgradeWorkflow" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.upgradeWorkflow"></a>
1380
1379
 
1381
1380
  ```typescript
1382
1381
  public readonly upgradeWorkflow: UpgradeDependencies;
@@ -1388,7 +1387,7 @@ The upgrade workflow.
1388
1387
 
1389
1388
  ---
1390
1389
 
1391
- ##### `docsDirectory`<sup>Required</sup> <a name="docsDirectory" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.docsDirectory"></a>
1390
+ ##### `docsDirectory`<sup>Required</sup> <a name="docsDirectory" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.docsDirectory"></a>
1392
1391
 
1393
1392
  ```typescript
1394
1393
  public readonly docsDirectory: string;
@@ -1398,7 +1397,7 @@ public readonly docsDirectory: string;
1398
1397
 
1399
1398
  ---
1400
1399
 
1401
- ##### `libdir`<sup>Required</sup> <a name="libdir" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.libdir"></a>
1400
+ ##### `libdir`<sup>Required</sup> <a name="libdir" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.libdir"></a>
1402
1401
 
1403
1402
  ```typescript
1404
1403
  public readonly libdir: string;
@@ -1410,7 +1409,7 @@ The directory in which compiled .js files reside.
1410
1409
 
1411
1410
  ---
1412
1411
 
1413
- ##### `srcdir`<sup>Required</sup> <a name="srcdir" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.srcdir"></a>
1412
+ ##### `srcdir`<sup>Required</sup> <a name="srcdir" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.srcdir"></a>
1414
1413
 
1415
1414
  ```typescript
1416
1415
  public readonly srcdir: string;
@@ -1422,7 +1421,7 @@ The directory in which the .ts sources reside.
1422
1421
 
1423
1422
  ---
1424
1423
 
1425
- ##### `testdir`<sup>Required</sup> <a name="testdir" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.testdir"></a>
1424
+ ##### `testdir`<sup>Required</sup> <a name="testdir" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.testdir"></a>
1426
1425
 
1427
1426
  ```typescript
1428
1427
  public readonly testdir: string;
@@ -1434,7 +1433,7 @@ The directory in which tests reside.
1434
1433
 
1435
1434
  ---
1436
1435
 
1437
- ##### `tsconfigDev`<sup>Required</sup> <a name="tsconfigDev" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.tsconfigDev"></a>
1436
+ ##### `tsconfigDev`<sup>Required</sup> <a name="tsconfigDev" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.tsconfigDev"></a>
1438
1437
 
1439
1438
  ```typescript
1440
1439
  public readonly tsconfigDev: TypescriptConfig;
@@ -1446,7 +1445,7 @@ A typescript configuration file which covers all files (sources, tests, projen).
1446
1445
 
1447
1446
  ---
1448
1447
 
1449
- ##### `watchTask`<sup>Required</sup> <a name="watchTask" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.watchTask"></a>
1448
+ ##### `watchTask`<sup>Required</sup> <a name="watchTask" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.watchTask"></a>
1450
1449
 
1451
1450
  ```typescript
1452
1451
  public readonly watchTask: Task;
@@ -1458,7 +1457,7 @@ The "watch" task.
1458
1457
 
1459
1458
  ---
1460
1459
 
1461
- ##### `docgen`<sup>Optional</sup> <a name="docgen" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.docgen"></a>
1460
+ ##### `docgen`<sup>Optional</sup> <a name="docgen" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.docgen"></a>
1462
1461
 
1463
1462
  ```typescript
1464
1463
  public readonly docgen: boolean;
@@ -1468,7 +1467,7 @@ public readonly docgen: boolean;
1468
1467
 
1469
1468
  ---
1470
1469
 
1471
- ##### `eslint`<sup>Optional</sup> <a name="eslint" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.eslint"></a>
1470
+ ##### `eslint`<sup>Optional</sup> <a name="eslint" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.eslint"></a>
1472
1471
 
1473
1472
  ```typescript
1474
1473
  public readonly eslint: Eslint;
@@ -1478,7 +1477,7 @@ public readonly eslint: Eslint;
1478
1477
 
1479
1478
  ---
1480
1479
 
1481
- ##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.tsconfig"></a>
1480
+ ##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.tsconfig"></a>
1482
1481
 
1483
1482
  ```typescript
1484
1483
  public readonly tsconfig: TypescriptConfig;
@@ -1488,7 +1487,7 @@ public readonly tsconfig: TypescriptConfig;
1488
1487
 
1489
1488
  ---
1490
1489
 
1491
- ##### `tsconfigEslint`<sup>Optional</sup> <a name="tsconfigEslint" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.tsconfigEslint"></a>
1490
+ ##### `tsconfigEslint`<sup>Optional</sup> <a name="tsconfigEslint" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.tsconfigEslint"></a>
1492
1491
 
1493
1492
  ```typescript
1494
1493
  public readonly tsconfigEslint: TypescriptConfig;
@@ -1498,7 +1497,7 @@ public readonly tsconfigEslint: TypescriptConfig;
1498
1497
 
1499
1498
  ---
1500
1499
 
1501
- ##### `appEntrypoint`<sup>Required</sup> <a name="appEntrypoint" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.appEntrypoint"></a>
1500
+ ##### `appEntrypoint`<sup>Required</sup> <a name="appEntrypoint" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.appEntrypoint"></a>
1502
1501
 
1503
1502
  ```typescript
1504
1503
  public readonly appEntrypoint: string;
@@ -1510,7 +1509,7 @@ The CDK app entrypoint.
1510
1509
 
1511
1510
  ---
1512
1511
 
1513
- ##### `cdkConfig`<sup>Required</sup> <a name="cdkConfig" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.cdkConfig"></a>
1512
+ ##### `cdkConfig`<sup>Required</sup> <a name="cdkConfig" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.cdkConfig"></a>
1514
1513
 
1515
1514
  ```typescript
1516
1515
  public readonly cdkConfig: CdkConfig;
@@ -1522,7 +1521,7 @@ cdk.json configuration.
1522
1521
 
1523
1522
  ---
1524
1523
 
1525
- ##### `cdkDeps`<sup>Required</sup> <a name="cdkDeps" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.cdkDeps"></a>
1524
+ ##### `cdkDeps`<sup>Required</sup> <a name="cdkDeps" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.cdkDeps"></a>
1526
1525
 
1527
1526
  ```typescript
1528
1527
  public readonly cdkDeps: AwsCdkDeps;
@@ -1532,7 +1531,7 @@ public readonly cdkDeps: AwsCdkDeps;
1532
1531
 
1533
1532
  ---
1534
1533
 
1535
- ##### `cdkTasks`<sup>Required</sup> <a name="cdkTasks" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.cdkTasks"></a>
1534
+ ##### `cdkTasks`<sup>Required</sup> <a name="cdkTasks" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.cdkTasks"></a>
1536
1535
 
1537
1536
  ```typescript
1538
1537
  public readonly cdkTasks: CdkTasks;
@@ -1544,7 +1543,7 @@ Common CDK tasks.
1544
1543
 
1545
1544
  ---
1546
1545
 
1547
- ##### `cdkVersion`<sup>Required</sup> <a name="cdkVersion" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.cdkVersion"></a>
1546
+ ##### `cdkVersion`<sup>Required</sup> <a name="cdkVersion" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.cdkVersion"></a>
1548
1547
 
1549
1548
  ```typescript
1550
1549
  public readonly cdkVersion: string;
@@ -1560,12 +1559,12 @@ The CDK version this app is using.
1560
1559
 
1561
1560
  | **Name** | **Type** | **Description** |
1562
1561
  | --- | --- | --- |
1563
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.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). |
1564
- | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
1562
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.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). |
1563
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
1565
1564
 
1566
1565
  ---
1567
1566
 
1568
- ##### `DEFAULT_TASK`<sup>Required</sup> <a name="DEFAULT_TASK" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.DEFAULT_TASK"></a>
1567
+ ##### `DEFAULT_TASK`<sup>Required</sup> <a name="DEFAULT_TASK" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.DEFAULT_TASK"></a>
1569
1568
 
1570
1569
  ```typescript
1571
1570
  public readonly DEFAULT_TASK: string;
@@ -1580,7 +1579,1594 @@ this task should synthesize the project files.
1580
1579
 
1581
1580
  ---
1582
1581
 
1583
- ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="@rocketleap/rocketleap-projen.RocketleapCdkProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
1582
+ ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
1583
+
1584
+ ```typescript
1585
+ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
1586
+ ```
1587
+
1588
+ - *Type:* string
1589
+
1590
+ ---
1591
+
1592
+ ### RocketleapWorkloadCdkProject <a name="RocketleapWorkloadCdkProject" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject"></a>
1593
+
1594
+ Projen project for customer workload CDK projects.
1595
+
1596
+ This is for customer-specific workload code that runs on the platform.
1597
+ Does NOT include the platform license.
1598
+
1599
+ #### Initializers <a name="Initializers" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.Initializer"></a>
1600
+
1601
+ ```typescript
1602
+ import { RocketleapWorkloadCdkProject } from '@rocketleap/rocketleap-projen'
1603
+
1604
+ new RocketleapWorkloadCdkProject(options: RocketleapCdkProjectOptions)
1605
+ ```
1606
+
1607
+ | **Name** | **Type** | **Description** |
1608
+ | --- | --- | --- |
1609
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.Initializer.parameter.options">options</a></code> | <code><a href="#@rocketleap/rocketleap-projen.RocketleapCdkProjectOptions">RocketleapCdkProjectOptions</a></code> | *No description.* |
1610
+
1611
+ ---
1612
+
1613
+ ##### `options`<sup>Required</sup> <a name="options" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.Initializer.parameter.options"></a>
1614
+
1615
+ - *Type:* <a href="#@rocketleap/rocketleap-projen.RocketleapCdkProjectOptions">RocketleapCdkProjectOptions</a>
1616
+
1617
+ ---
1618
+
1619
+ #### Methods <a name="Methods" id="Methods"></a>
1620
+
1621
+ | **Name** | **Description** |
1622
+ | --- | --- |
1623
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.toString">toString</a></code> | Returns a string representation of this construct. |
1624
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
1625
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
1626
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
1627
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addTask">addTask</a></code> | Adds a new task to this project. |
1628
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
1629
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
1630
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
1631
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
1632
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.removeTask">removeTask</a></code> | Removes a task from a project. |
1633
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
1634
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.synth">synth</a></code> | Synthesize all project files into `outdir`. |
1635
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
1636
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
1637
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
1638
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
1639
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addBins">addBins</a></code> | *No description.* |
1640
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
1641
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
1642
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addDeps">addDeps</a></code> | Defines normal dependencies. |
1643
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
1644
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
1645
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
1646
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
1647
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
1648
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
1649
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
1650
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
1651
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
1652
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
1653
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addCdkDependency">addCdkDependency</a></code> | Adds an AWS CDK module dependencies. |
1654
+
1655
+ ---
1656
+
1657
+ ##### `toString` <a name="toString" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.toString"></a>
1658
+
1659
+ ```typescript
1660
+ public toString(): string
1661
+ ```
1662
+
1663
+ Returns a string representation of this construct.
1664
+
1665
+ ##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addExcludeFromCleanup"></a>
1666
+
1667
+ ```typescript
1668
+ public addExcludeFromCleanup(globs: ...string[]): void
1669
+ ```
1670
+
1671
+ Exclude the matching files from pre-synth cleanup.
1672
+
1673
+ Can be used when, for example, some
1674
+ source files include the projen marker and we don't want them to be erased during synth.
1675
+
1676
+ ###### `globs`<sup>Required</sup> <a name="globs" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addExcludeFromCleanup.parameter.globs"></a>
1677
+
1678
+ - *Type:* ...string[]
1679
+
1680
+ The glob patterns to match.
1681
+
1682
+ ---
1683
+
1684
+ ##### `addGitIgnore` <a name="addGitIgnore" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addGitIgnore"></a>
1685
+
1686
+ ```typescript
1687
+ public addGitIgnore(pattern: string): void
1688
+ ```
1689
+
1690
+ Adds a .gitignore pattern.
1691
+
1692
+ ###### `pattern`<sup>Required</sup> <a name="pattern" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addGitIgnore.parameter.pattern"></a>
1693
+
1694
+ - *Type:* string
1695
+
1696
+ The glob pattern to ignore.
1697
+
1698
+ ---
1699
+
1700
+ ##### `addPackageIgnore` <a name="addPackageIgnore" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addPackageIgnore"></a>
1701
+
1702
+ ```typescript
1703
+ public addPackageIgnore(pattern: string): void
1704
+ ```
1705
+
1706
+ Adds patterns to be ignored by npm.
1707
+
1708
+ ###### `pattern`<sup>Required</sup> <a name="pattern" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addPackageIgnore.parameter.pattern"></a>
1709
+
1710
+ - *Type:* string
1711
+
1712
+ The pattern to ignore.
1713
+
1714
+ ---
1715
+
1716
+ ##### `addTask` <a name="addTask" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addTask"></a>
1717
+
1718
+ ```typescript
1719
+ public addTask(name: string, props?: TaskOptions): Task
1720
+ ```
1721
+
1722
+ Adds a new task to this project.
1723
+
1724
+ This will fail if the project already has
1725
+ a task with this name.
1726
+
1727
+ ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addTask.parameter.name"></a>
1728
+
1729
+ - *Type:* string
1730
+
1731
+ The task name to add.
1732
+
1733
+ ---
1734
+
1735
+ ###### `props`<sup>Optional</sup> <a name="props" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addTask.parameter.props"></a>
1736
+
1737
+ - *Type:* projen.TaskOptions
1738
+
1739
+ Task properties.
1740
+
1741
+ ---
1742
+
1743
+ ##### ~~`addTip`~~ <a name="addTip" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addTip"></a>
1744
+
1745
+ ```typescript
1746
+ public addTip(message: string): void
1747
+ ```
1748
+
1749
+ Prints a "tip" message during synthesis.
1750
+
1751
+ ###### `message`<sup>Required</sup> <a name="message" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addTip.parameter.message"></a>
1752
+
1753
+ - *Type:* string
1754
+
1755
+ The message.
1756
+
1757
+ ---
1758
+
1759
+ ##### `annotateGenerated` <a name="annotateGenerated" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.annotateGenerated"></a>
1760
+
1761
+ ```typescript
1762
+ public annotateGenerated(glob: string): void
1763
+ ```
1764
+
1765
+ Marks the provided file(s) as being generated.
1766
+
1767
+ This is achieved using the
1768
+ github-linguist attributes. Generated files do not count against the
1769
+ repository statistics and language breakdown.
1770
+
1771
+ > [https://github.com/github/linguist/blob/master/docs/overrides.md](https://github.com/github/linguist/blob/master/docs/overrides.md)
1772
+
1773
+ ###### `glob`<sup>Required</sup> <a name="glob" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.annotateGenerated.parameter.glob"></a>
1774
+
1775
+ - *Type:* string
1776
+
1777
+ the glob pattern to match (could be a file path).
1778
+
1779
+ ---
1780
+
1781
+ ##### `postSynthesize` <a name="postSynthesize" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.postSynthesize"></a>
1782
+
1783
+ ```typescript
1784
+ public postSynthesize(): void
1785
+ ```
1786
+
1787
+ Called after all components are synthesized.
1788
+
1789
+ Order is *not* guaranteed.
1790
+
1791
+ ##### `preSynthesize` <a name="preSynthesize" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.preSynthesize"></a>
1792
+
1793
+ ```typescript
1794
+ public preSynthesize(): void
1795
+ ```
1796
+
1797
+ Called before all components are synthesized.
1798
+
1799
+ ##### `removeTask` <a name="removeTask" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.removeTask"></a>
1800
+
1801
+ ```typescript
1802
+ public removeTask(name: string): Task
1803
+ ```
1804
+
1805
+ Removes a task from a project.
1806
+
1807
+ ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.removeTask.parameter.name"></a>
1808
+
1809
+ - *Type:* string
1810
+
1811
+ The name of the task to remove.
1812
+
1813
+ ---
1814
+
1815
+ ##### `runTaskCommand` <a name="runTaskCommand" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.runTaskCommand"></a>
1816
+
1817
+ ```typescript
1818
+ public runTaskCommand(task: Task): string
1819
+ ```
1820
+
1821
+ Returns the shell command to execute in order to run a task.
1822
+
1823
+ This will
1824
+ typically be `npx projen TASK`.
1825
+
1826
+ ###### `task`<sup>Required</sup> <a name="task" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.runTaskCommand.parameter.task"></a>
1827
+
1828
+ - *Type:* projen.Task
1829
+
1830
+ The task for which the command is required.
1831
+
1832
+ ---
1833
+
1834
+ ##### `synth` <a name="synth" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.synth"></a>
1835
+
1836
+ ```typescript
1837
+ public synth(): void
1838
+ ```
1839
+
1840
+ Synthesize all project files into `outdir`.
1841
+
1842
+ 1. Call "this.preSynthesize()"
1843
+ 2. Delete all generated files
1844
+ 3. Synthesize all subprojects
1845
+ 4. Synthesize all components of this project
1846
+ 5. Call "postSynthesize()" for all components of this project
1847
+ 6. Call "this.postSynthesize()"
1848
+
1849
+ ##### `tryFindFile` <a name="tryFindFile" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.tryFindFile"></a>
1850
+
1851
+ ```typescript
1852
+ public tryFindFile(filePath: string): FileBase
1853
+ ```
1854
+
1855
+ Finds a file at the specified relative path within this project and all its subprojects.
1856
+
1857
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.tryFindFile.parameter.filePath"></a>
1858
+
1859
+ - *Type:* string
1860
+
1861
+ The file path.
1862
+
1863
+ If this path is relative, it will be resolved
1864
+ from the root of _this_ project.
1865
+
1866
+ ---
1867
+
1868
+ ##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.tryFindJsonFile"></a>
1869
+
1870
+ ```typescript
1871
+ public tryFindJsonFile(filePath: string): JsonFile
1872
+ ```
1873
+
1874
+ Finds a json file by name.
1875
+
1876
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.tryFindJsonFile.parameter.filePath"></a>
1877
+
1878
+ - *Type:* string
1879
+
1880
+ The file path.
1881
+
1882
+ ---
1883
+
1884
+ ##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.tryFindObjectFile"></a>
1885
+
1886
+ ```typescript
1887
+ public tryFindObjectFile(filePath: string): ObjectFile
1888
+ ```
1889
+
1890
+ Finds an object file (like JsonFile, YamlFile, etc.) by name.
1891
+
1892
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.tryFindObjectFile.parameter.filePath"></a>
1893
+
1894
+ - *Type:* string
1895
+
1896
+ The file path.
1897
+
1898
+ ---
1899
+
1900
+ ##### `tryRemoveFile` <a name="tryRemoveFile" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.tryRemoveFile"></a>
1901
+
1902
+ ```typescript
1903
+ public tryRemoveFile(filePath: string): FileBase
1904
+ ```
1905
+
1906
+ Finds a file at the specified relative path within this project and removes it.
1907
+
1908
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.tryRemoveFile.parameter.filePath"></a>
1909
+
1910
+ - *Type:* string
1911
+
1912
+ The file path.
1913
+
1914
+ If this path is relative, it will be
1915
+ resolved from the root of _this_ project.
1916
+
1917
+ ---
1918
+
1919
+ ##### `addBins` <a name="addBins" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addBins"></a>
1920
+
1921
+ ```typescript
1922
+ public addBins(bins: {[ key: string ]: string}): void
1923
+ ```
1924
+
1925
+ ###### `bins`<sup>Required</sup> <a name="bins" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addBins.parameter.bins"></a>
1926
+
1927
+ - *Type:* {[ key: string ]: string}
1928
+
1929
+ ---
1930
+
1931
+ ##### `addBundledDeps` <a name="addBundledDeps" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addBundledDeps"></a>
1932
+
1933
+ ```typescript
1934
+ public addBundledDeps(deps: ...string[]): void
1935
+ ```
1936
+
1937
+ Defines bundled dependencies.
1938
+
1939
+ Bundled dependencies will be added as normal dependencies as well as to the
1940
+ `bundledDependencies` section of your `package.json`.
1941
+
1942
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addBundledDeps.parameter.deps"></a>
1943
+
1944
+ - *Type:* ...string[]
1945
+
1946
+ Names modules to install.
1947
+
1948
+ By default, the the dependency will
1949
+ be installed in the next `npx projen` run and the version will be recorded
1950
+ in your `package.json` file. You can upgrade manually or using `yarn
1951
+ add/upgrade`. If you wish to specify a version range use this syntax:
1952
+ `module@^7`.
1953
+
1954
+ ---
1955
+
1956
+ ##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addCompileCommand"></a>
1957
+
1958
+ ```typescript
1959
+ public addCompileCommand(commands: ...string[]): void
1960
+ ```
1961
+
1962
+ DEPRECATED.
1963
+
1964
+ ###### `commands`<sup>Required</sup> <a name="commands" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addCompileCommand.parameter.commands"></a>
1965
+
1966
+ - *Type:* ...string[]
1967
+
1968
+ ---
1969
+
1970
+ ##### `addDeps` <a name="addDeps" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addDeps"></a>
1971
+
1972
+ ```typescript
1973
+ public addDeps(deps: ...string[]): void
1974
+ ```
1975
+
1976
+ Defines normal dependencies.
1977
+
1978
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addDeps.parameter.deps"></a>
1979
+
1980
+ - *Type:* ...string[]
1981
+
1982
+ Names modules to install.
1983
+
1984
+ By default, the the dependency will
1985
+ be installed in the next `npx projen` run and the version will be recorded
1986
+ in your `package.json` file. You can upgrade manually or using `yarn
1987
+ add/upgrade`. If you wish to specify a version range use this syntax:
1988
+ `module@^7`.
1989
+
1990
+ ---
1991
+
1992
+ ##### `addDevDeps` <a name="addDevDeps" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addDevDeps"></a>
1993
+
1994
+ ```typescript
1995
+ public addDevDeps(deps: ...string[]): void
1996
+ ```
1997
+
1998
+ Defines development/test dependencies.
1999
+
2000
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addDevDeps.parameter.deps"></a>
2001
+
2002
+ - *Type:* ...string[]
2003
+
2004
+ Names modules to install.
2005
+
2006
+ By default, the the dependency will
2007
+ be installed in the next `npx projen` run and the version will be recorded
2008
+ in your `package.json` file. You can upgrade manually or using `yarn
2009
+ add/upgrade`. If you wish to specify a version range use this syntax:
2010
+ `module@^7`.
2011
+
2012
+ ---
2013
+
2014
+ ##### `addFields` <a name="addFields" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addFields"></a>
2015
+
2016
+ ```typescript
2017
+ public addFields(fields: {[ key: string ]: any}): void
2018
+ ```
2019
+
2020
+ Directly set fields in `package.json`.
2021
+
2022
+ ###### `fields`<sup>Required</sup> <a name="fields" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addFields.parameter.fields"></a>
2023
+
2024
+ - *Type:* {[ key: string ]: any}
2025
+
2026
+ The fields to set.
2027
+
2028
+ ---
2029
+
2030
+ ##### `addKeywords` <a name="addKeywords" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addKeywords"></a>
2031
+
2032
+ ```typescript
2033
+ public addKeywords(keywords: ...string[]): void
2034
+ ```
2035
+
2036
+ Adds keywords to package.json (deduplicated).
2037
+
2038
+ ###### `keywords`<sup>Required</sup> <a name="keywords" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addKeywords.parameter.keywords"></a>
2039
+
2040
+ - *Type:* ...string[]
2041
+
2042
+ The keywords to add.
2043
+
2044
+ ---
2045
+
2046
+ ##### `addPeerDeps` <a name="addPeerDeps" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addPeerDeps"></a>
2047
+
2048
+ ```typescript
2049
+ public addPeerDeps(deps: ...string[]): void
2050
+ ```
2051
+
2052
+ Defines peer dependencies.
2053
+
2054
+ When adding peer dependencies, a devDependency will also be added on the
2055
+ pinned version of the declared peer. This will ensure that you are testing
2056
+ your code against the minimum version required from your consumers.
2057
+
2058
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addPeerDeps.parameter.deps"></a>
2059
+
2060
+ - *Type:* ...string[]
2061
+
2062
+ Names modules to install.
2063
+
2064
+ By default, the the dependency will
2065
+ be installed in the next `npx projen` run and the version will be recorded
2066
+ in your `package.json` file. You can upgrade manually or using `yarn
2067
+ add/upgrade`. If you wish to specify a version range use this syntax:
2068
+ `module@^7`.
2069
+
2070
+ ---
2071
+
2072
+ ##### `addScripts` <a name="addScripts" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addScripts"></a>
2073
+
2074
+ ```typescript
2075
+ public addScripts(scripts: {[ key: string ]: string}): void
2076
+ ```
2077
+
2078
+ Replaces the contents of multiple npm package.json scripts.
2079
+
2080
+ ###### `scripts`<sup>Required</sup> <a name="scripts" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addScripts.parameter.scripts"></a>
2081
+
2082
+ - *Type:* {[ key: string ]: string}
2083
+
2084
+ The scripts to set.
2085
+
2086
+ ---
2087
+
2088
+ ##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addTestCommand"></a>
2089
+
2090
+ ```typescript
2091
+ public addTestCommand(commands: ...string[]): void
2092
+ ```
2093
+
2094
+ DEPRECATED.
2095
+
2096
+ ###### `commands`<sup>Required</sup> <a name="commands" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addTestCommand.parameter.commands"></a>
2097
+
2098
+ - *Type:* ...string[]
2099
+
2100
+ ---
2101
+
2102
+ ##### ~~`hasScript`~~ <a name="hasScript" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.hasScript"></a>
2103
+
2104
+ ```typescript
2105
+ public hasScript(name: string): boolean
2106
+ ```
2107
+
2108
+ Indicates if a script by the name name is defined.
2109
+
2110
+ ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.hasScript.parameter.name"></a>
2111
+
2112
+ - *Type:* string
2113
+
2114
+ The name of the script.
2115
+
2116
+ ---
2117
+
2118
+ ##### `removeScript` <a name="removeScript" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.removeScript"></a>
2119
+
2120
+ ```typescript
2121
+ public removeScript(name: string): void
2122
+ ```
2123
+
2124
+ Removes the npm script (always successful).
2125
+
2126
+ ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.removeScript.parameter.name"></a>
2127
+
2128
+ - *Type:* string
2129
+
2130
+ The name of the script.
2131
+
2132
+ ---
2133
+
2134
+ ##### `renderWorkflowSetup` <a name="renderWorkflowSetup" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.renderWorkflowSetup"></a>
2135
+
2136
+ ```typescript
2137
+ public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]
2138
+ ```
2139
+
2140
+ Returns the set of workflow steps which should be executed to bootstrap a workflow.
2141
+
2142
+ ###### `options`<sup>Optional</sup> <a name="options" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.renderWorkflowSetup.parameter.options"></a>
2143
+
2144
+ - *Type:* projen.javascript.RenderWorkflowSetupOptions
2145
+
2146
+ Options.
2147
+
2148
+ ---
2149
+
2150
+ ##### `setScript` <a name="setScript" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.setScript"></a>
2151
+
2152
+ ```typescript
2153
+ public setScript(name: string, command: string): void
2154
+ ```
2155
+
2156
+ Replaces the contents of an npm package.json script.
2157
+
2158
+ ###### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.setScript.parameter.name"></a>
2159
+
2160
+ - *Type:* string
2161
+
2162
+ The script name.
2163
+
2164
+ ---
2165
+
2166
+ ###### `command`<sup>Required</sup> <a name="command" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.setScript.parameter.command"></a>
2167
+
2168
+ - *Type:* string
2169
+
2170
+ The command to execute.
2171
+
2172
+ ---
2173
+
2174
+ ##### `addCdkDependency` <a name="addCdkDependency" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addCdkDependency"></a>
2175
+
2176
+ ```typescript
2177
+ public addCdkDependency(modules: ...string[]): void
2178
+ ```
2179
+
2180
+ Adds an AWS CDK module dependencies.
2181
+
2182
+ ###### `modules`<sup>Required</sup> <a name="modules" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.addCdkDependency.parameter.modules"></a>
2183
+
2184
+ - *Type:* ...string[]
2185
+
2186
+ The list of modules to depend on.
2187
+
2188
+ ---
2189
+
2190
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
2191
+
2192
+ | **Name** | **Description** |
2193
+ | --- | --- |
2194
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
2195
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.isProject">isProject</a></code> | Test whether the given construct is a project. |
2196
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.of">of</a></code> | Find the closest ancestor project for given construct. |
2197
+
2198
+ ---
2199
+
2200
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.isConstruct"></a>
2201
+
2202
+ ```typescript
2203
+ import { RocketleapWorkloadCdkProject } from '@rocketleap/rocketleap-projen'
2204
+
2205
+ RocketleapWorkloadCdkProject.isConstruct(x: any)
2206
+ ```
2207
+
2208
+ Checks if `x` is a construct.
2209
+
2210
+ ###### `x`<sup>Required</sup> <a name="x" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.isConstruct.parameter.x"></a>
2211
+
2212
+ - *Type:* any
2213
+
2214
+ Any object.
2215
+
2216
+ ---
2217
+
2218
+ ##### `isProject` <a name="isProject" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.isProject"></a>
2219
+
2220
+ ```typescript
2221
+ import { RocketleapWorkloadCdkProject } from '@rocketleap/rocketleap-projen'
2222
+
2223
+ RocketleapWorkloadCdkProject.isProject(x: any)
2224
+ ```
2225
+
2226
+ Test whether the given construct is a project.
2227
+
2228
+ ###### `x`<sup>Required</sup> <a name="x" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.isProject.parameter.x"></a>
2229
+
2230
+ - *Type:* any
2231
+
2232
+ ---
2233
+
2234
+ ##### `of` <a name="of" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.of"></a>
2235
+
2236
+ ```typescript
2237
+ import { RocketleapWorkloadCdkProject } from '@rocketleap/rocketleap-projen'
2238
+
2239
+ RocketleapWorkloadCdkProject.of(construct: IConstruct)
2240
+ ```
2241
+
2242
+ Find the closest ancestor project for given construct.
2243
+
2244
+ When given a project, this it the project itself.
2245
+
2246
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.of.parameter.construct"></a>
2247
+
2248
+ - *Type:* constructs.IConstruct
2249
+
2250
+ ---
2251
+
2252
+ #### Properties <a name="Properties" id="Properties"></a>
2253
+
2254
+ | **Name** | **Type** | **Description** |
2255
+ | --- | --- | --- |
2256
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
2257
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.buildTask">buildTask</a></code> | <code>projen.Task</code> | *No description.* |
2258
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
2259
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.compileTask">compileTask</a></code> | <code>projen.Task</code> | *No description.* |
2260
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.components">components</a></code> | <code>projen.Component[]</code> | Returns all the components within this project. |
2261
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.deps">deps</a></code> | <code>projen.Dependencies</code> | Project dependencies. |
2262
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.ejected">ejected</a></code> | <code>boolean</code> | Whether or not the project is being ejected. |
2263
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.files">files</a></code> | <code>projen.FileBase[]</code> | All files in this project. |
2264
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.gitattributes">gitattributes</a></code> | <code>projen.GitAttributesFile</code> | The .gitattributes file for this repository. |
2265
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.gitignore">gitignore</a></code> | <code>projen.IgnoreFile</code> | .gitignore. |
2266
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.logger">logger</a></code> | <code>projen.Logger</code> | Logging utilities. |
2267
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.name">name</a></code> | <code>string</code> | Project name. |
2268
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.outdir">outdir</a></code> | <code>string</code> | Absolute output directory of this project. |
2269
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.packageTask">packageTask</a></code> | <code>projen.Task</code> | *No description.* |
2270
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.postCompileTask">postCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
2271
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.preCompileTask">preCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
2272
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
2273
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.projenCommand">projenCommand</a></code> | <code>string</code> | The command to use in order to run the projen CLI. |
2274
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
2275
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.subprojects">subprojects</a></code> | <code>projen.Project[]</code> | Returns all the subprojects within this project. |
2276
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
2277
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
2278
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
2279
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
2280
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
2281
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
2282
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
2283
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
2284
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
2285
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
2286
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
2287
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
2288
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
2289
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
2290
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
2291
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
2292
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
2293
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
2294
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
2295
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
2296
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.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). |
2297
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
2298
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
2299
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
2300
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
2301
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
2302
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version supported by this package. |
2303
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
2304
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
2305
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
2306
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
2307
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
2308
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
2309
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
2310
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
2311
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
2312
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
2313
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
2314
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.watchTask">watchTask</a></code> | <code>projen.Task</code> | The "watch" task. |
2315
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.docgen">docgen</a></code> | <code>boolean</code> | *No description.* |
2316
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.eslint">eslint</a></code> | <code>projen.javascript.Eslint</code> | *No description.* |
2317
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
2318
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.tsconfigEslint">tsconfigEslint</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
2319
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.appEntrypoint">appEntrypoint</a></code> | <code>string</code> | The CDK app entrypoint. |
2320
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.cdkConfig">cdkConfig</a></code> | <code>projen.awscdk.CdkConfig</code> | cdk.json configuration. |
2321
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.cdkDeps">cdkDeps</a></code> | <code>projen.awscdk.AwsCdkDeps</code> | *No description.* |
2322
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.cdkTasks">cdkTasks</a></code> | <code>projen.awscdk.CdkTasks</code> | Common CDK tasks. |
2323
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | The CDK version this app is using. |
2324
+
2325
+ ---
2326
+
2327
+ ##### `node`<sup>Required</sup> <a name="node" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.node"></a>
2328
+
2329
+ ```typescript
2330
+ public readonly node: Node;
2331
+ ```
2332
+
2333
+ - *Type:* constructs.Node
2334
+
2335
+ The tree node.
2336
+
2337
+ ---
2338
+
2339
+ ##### `buildTask`<sup>Required</sup> <a name="buildTask" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.buildTask"></a>
2340
+
2341
+ ```typescript
2342
+ public readonly buildTask: Task;
2343
+ ```
2344
+
2345
+ - *Type:* projen.Task
2346
+
2347
+ ---
2348
+
2349
+ ##### `commitGenerated`<sup>Required</sup> <a name="commitGenerated" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.commitGenerated"></a>
2350
+
2351
+ ```typescript
2352
+ public readonly commitGenerated: boolean;
2353
+ ```
2354
+
2355
+ - *Type:* boolean
2356
+
2357
+ Whether to commit the managed files by default.
2358
+
2359
+ ---
2360
+
2361
+ ##### `compileTask`<sup>Required</sup> <a name="compileTask" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.compileTask"></a>
2362
+
2363
+ ```typescript
2364
+ public readonly compileTask: Task;
2365
+ ```
2366
+
2367
+ - *Type:* projen.Task
2368
+
2369
+ ---
2370
+
2371
+ ##### `components`<sup>Required</sup> <a name="components" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.components"></a>
2372
+
2373
+ ```typescript
2374
+ public readonly components: Component[];
2375
+ ```
2376
+
2377
+ - *Type:* projen.Component[]
2378
+
2379
+ Returns all the components within this project.
2380
+
2381
+ ---
2382
+
2383
+ ##### `deps`<sup>Required</sup> <a name="deps" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.deps"></a>
2384
+
2385
+ ```typescript
2386
+ public readonly deps: Dependencies;
2387
+ ```
2388
+
2389
+ - *Type:* projen.Dependencies
2390
+
2391
+ Project dependencies.
2392
+
2393
+ ---
2394
+
2395
+ ##### `ejected`<sup>Required</sup> <a name="ejected" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.ejected"></a>
2396
+
2397
+ ```typescript
2398
+ public readonly ejected: boolean;
2399
+ ```
2400
+
2401
+ - *Type:* boolean
2402
+
2403
+ Whether or not the project is being ejected.
2404
+
2405
+ ---
2406
+
2407
+ ##### `files`<sup>Required</sup> <a name="files" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.files"></a>
2408
+
2409
+ ```typescript
2410
+ public readonly files: FileBase[];
2411
+ ```
2412
+
2413
+ - *Type:* projen.FileBase[]
2414
+
2415
+ All files in this project.
2416
+
2417
+ ---
2418
+
2419
+ ##### `gitattributes`<sup>Required</sup> <a name="gitattributes" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.gitattributes"></a>
2420
+
2421
+ ```typescript
2422
+ public readonly gitattributes: GitAttributesFile;
2423
+ ```
2424
+
2425
+ - *Type:* projen.GitAttributesFile
2426
+
2427
+ The .gitattributes file for this repository.
2428
+
2429
+ ---
2430
+
2431
+ ##### `gitignore`<sup>Required</sup> <a name="gitignore" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.gitignore"></a>
2432
+
2433
+ ```typescript
2434
+ public readonly gitignore: IgnoreFile;
2435
+ ```
2436
+
2437
+ - *Type:* projen.IgnoreFile
2438
+
2439
+ .gitignore.
2440
+
2441
+ ---
2442
+
2443
+ ##### `logger`<sup>Required</sup> <a name="logger" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.logger"></a>
2444
+
2445
+ ```typescript
2446
+ public readonly logger: Logger;
2447
+ ```
2448
+
2449
+ - *Type:* projen.Logger
2450
+
2451
+ Logging utilities.
2452
+
2453
+ ---
2454
+
2455
+ ##### `name`<sup>Required</sup> <a name="name" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.name"></a>
2456
+
2457
+ ```typescript
2458
+ public readonly name: string;
2459
+ ```
2460
+
2461
+ - *Type:* string
2462
+
2463
+ Project name.
2464
+
2465
+ ---
2466
+
2467
+ ##### `outdir`<sup>Required</sup> <a name="outdir" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.outdir"></a>
2468
+
2469
+ ```typescript
2470
+ public readonly outdir: string;
2471
+ ```
2472
+
2473
+ - *Type:* string
2474
+
2475
+ Absolute output directory of this project.
2476
+
2477
+ ---
2478
+
2479
+ ##### `packageTask`<sup>Required</sup> <a name="packageTask" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.packageTask"></a>
2480
+
2481
+ ```typescript
2482
+ public readonly packageTask: Task;
2483
+ ```
2484
+
2485
+ - *Type:* projen.Task
2486
+
2487
+ ---
2488
+
2489
+ ##### `postCompileTask`<sup>Required</sup> <a name="postCompileTask" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.postCompileTask"></a>
2490
+
2491
+ ```typescript
2492
+ public readonly postCompileTask: Task;
2493
+ ```
2494
+
2495
+ - *Type:* projen.Task
2496
+
2497
+ ---
2498
+
2499
+ ##### `preCompileTask`<sup>Required</sup> <a name="preCompileTask" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.preCompileTask"></a>
2500
+
2501
+ ```typescript
2502
+ public readonly preCompileTask: Task;
2503
+ ```
2504
+
2505
+ - *Type:* projen.Task
2506
+
2507
+ ---
2508
+
2509
+ ##### `projectBuild`<sup>Required</sup> <a name="projectBuild" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.projectBuild"></a>
2510
+
2511
+ ```typescript
2512
+ public readonly projectBuild: ProjectBuild;
2513
+ ```
2514
+
2515
+ - *Type:* projen.ProjectBuild
2516
+
2517
+ Manages the build process of the project.
2518
+
2519
+ ---
2520
+
2521
+ ##### `projenCommand`<sup>Required</sup> <a name="projenCommand" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.projenCommand"></a>
2522
+
2523
+ ```typescript
2524
+ public readonly projenCommand: string;
2525
+ ```
2526
+
2527
+ - *Type:* string
2528
+
2529
+ The command to use in order to run the projen CLI.
2530
+
2531
+ ---
2532
+
2533
+ ##### `root`<sup>Required</sup> <a name="root" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.root"></a>
2534
+
2535
+ ```typescript
2536
+ public readonly root: Project;
2537
+ ```
2538
+
2539
+ - *Type:* projen.Project
2540
+
2541
+ The root project.
2542
+
2543
+ ---
2544
+
2545
+ ##### `subprojects`<sup>Required</sup> <a name="subprojects" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.subprojects"></a>
2546
+
2547
+ ```typescript
2548
+ public readonly subprojects: Project[];
2549
+ ```
2550
+
2551
+ - *Type:* projen.Project[]
2552
+
2553
+ Returns all the subprojects within this project.
2554
+
2555
+ ---
2556
+
2557
+ ##### `tasks`<sup>Required</sup> <a name="tasks" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.tasks"></a>
2558
+
2559
+ ```typescript
2560
+ public readonly tasks: Tasks;
2561
+ ```
2562
+
2563
+ - *Type:* projen.Tasks
2564
+
2565
+ Project tasks.
2566
+
2567
+ ---
2568
+
2569
+ ##### `testTask`<sup>Required</sup> <a name="testTask" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.testTask"></a>
2570
+
2571
+ ```typescript
2572
+ public readonly testTask: Task;
2573
+ ```
2574
+
2575
+ - *Type:* projen.Task
2576
+
2577
+ ---
2578
+
2579
+ ##### `defaultTask`<sup>Optional</sup> <a name="defaultTask" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.defaultTask"></a>
2580
+
2581
+ ```typescript
2582
+ public readonly defaultTask: Task;
2583
+ ```
2584
+
2585
+ - *Type:* projen.Task
2586
+
2587
+ This is the "default" task, the one that executes "projen".
2588
+
2589
+ Undefined if
2590
+ the project is being ejected.
2591
+
2592
+ ---
2593
+
2594
+ ##### `initProject`<sup>Optional</sup> <a name="initProject" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.initProject"></a>
2595
+
2596
+ ```typescript
2597
+ public readonly initProject: InitProject;
2598
+ ```
2599
+
2600
+ - *Type:* projen.InitProject
2601
+
2602
+ The options used when this project is bootstrapped via `projen new`.
2603
+
2604
+ It
2605
+ includes the original set of options passed to the CLI and also the JSII
2606
+ FQN of the project type.
2607
+
2608
+ ---
2609
+
2610
+ ##### `parent`<sup>Optional</sup> <a name="parent" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.parent"></a>
2611
+
2612
+ ```typescript
2613
+ public readonly parent: Project;
2614
+ ```
2615
+
2616
+ - *Type:* projen.Project
2617
+
2618
+ A parent project.
2619
+
2620
+ If undefined, this is the root project.
2621
+
2622
+ ---
2623
+
2624
+ ##### `projectType`<sup>Required</sup> <a name="projectType" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.projectType"></a>
2625
+
2626
+ ```typescript
2627
+ public readonly projectType: ProjectType;
2628
+ ```
2629
+
2630
+ - *Type:* projen.ProjectType
2631
+
2632
+ ---
2633
+
2634
+ ##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.autoApprove"></a>
2635
+
2636
+ ```typescript
2637
+ public readonly autoApprove: AutoApprove;
2638
+ ```
2639
+
2640
+ - *Type:* projen.github.AutoApprove
2641
+
2642
+ Auto approve set up for this project.
2643
+
2644
+ ---
2645
+
2646
+ ##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.devContainer"></a>
2647
+
2648
+ ```typescript
2649
+ public readonly devContainer: DevContainer;
2650
+ ```
2651
+
2652
+ - *Type:* projen.vscode.DevContainer
2653
+
2654
+ Access for .devcontainer.json (used for GitHub Codespaces).
2655
+
2656
+ This will be `undefined` if devContainer boolean is false
2657
+
2658
+ ---
2659
+
2660
+ ##### `github`<sup>Optional</sup> <a name="github" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.github"></a>
2661
+
2662
+ ```typescript
2663
+ public readonly github: GitHub;
2664
+ ```
2665
+
2666
+ - *Type:* projen.github.GitHub
2667
+
2668
+ Access all github components.
2669
+
2670
+ This will be `undefined` for subprojects.
2671
+
2672
+ ---
2673
+
2674
+ ##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.gitpod"></a>
2675
+
2676
+ ```typescript
2677
+ public readonly gitpod: Gitpod;
2678
+ ```
2679
+
2680
+ - *Type:* projen.Gitpod
2681
+
2682
+ Access for Gitpod.
2683
+
2684
+ This will be `undefined` if gitpod boolean is false
2685
+
2686
+ ---
2687
+
2688
+ ##### `vscode`<sup>Optional</sup> <a name="vscode" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.vscode"></a>
2689
+
2690
+ ```typescript
2691
+ public readonly vscode: VsCode;
2692
+ ```
2693
+
2694
+ - *Type:* projen.vscode.VsCode
2695
+
2696
+ Access all VSCode components.
2697
+
2698
+ This will be `undefined` for subprojects.
2699
+
2700
+ ---
2701
+
2702
+ ##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.allowLibraryDependencies"></a>
2703
+
2704
+ - *Deprecated:* use `package.allowLibraryDependencies`
2705
+
2706
+ ```typescript
2707
+ public readonly allowLibraryDependencies: boolean;
2708
+ ```
2709
+
2710
+ - *Type:* boolean
2711
+
2712
+ ---
2713
+
2714
+ ##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.artifactsDirectory"></a>
2715
+
2716
+ ```typescript
2717
+ public readonly artifactsDirectory: string;
2718
+ ```
2719
+
2720
+ - *Type:* string
2721
+
2722
+ The build output directory.
2723
+
2724
+ An npm tarball will be created under the `js`
2725
+ subdirectory. For example, if this is set to `dist` (the default), the npm
2726
+ tarball will be placed under `dist/js/boom-boom-1.2.3.tg`.
2727
+
2728
+ ---
2729
+
2730
+ ##### `artifactsJavascriptDirectory`<sup>Required</sup> <a name="artifactsJavascriptDirectory" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.artifactsJavascriptDirectory"></a>
2731
+
2732
+ ```typescript
2733
+ public readonly artifactsJavascriptDirectory: string;
2734
+ ```
2735
+
2736
+ - *Type:* string
2737
+
2738
+ The location of the npm tarball after build (`${artifactsDirectory}/js`).
2739
+
2740
+ ---
2741
+
2742
+ ##### `bundler`<sup>Required</sup> <a name="bundler" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.bundler"></a>
2743
+
2744
+ ```typescript
2745
+ public readonly bundler: Bundler;
2746
+ ```
2747
+
2748
+ - *Type:* projen.javascript.Bundler
2749
+
2750
+ ---
2751
+
2752
+ ##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.entrypoint"></a>
2753
+
2754
+ - *Deprecated:* use `package.entrypoint`
2755
+
2756
+ ```typescript
2757
+ public readonly entrypoint: string;
2758
+ ```
2759
+
2760
+ - *Type:* string
2761
+
2762
+ ---
2763
+
2764
+ ##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.manifest"></a>
2765
+
2766
+ - *Deprecated:* use `package.addField(x, y)`
2767
+
2768
+ ```typescript
2769
+ public readonly manifest: any;
2770
+ ```
2771
+
2772
+ - *Type:* any
2773
+
2774
+ ---
2775
+
2776
+ ##### `npmrc`<sup>Required</sup> <a name="npmrc" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.npmrc"></a>
2777
+
2778
+ ```typescript
2779
+ public readonly npmrc: NpmConfig;
2780
+ ```
2781
+
2782
+ - *Type:* projen.javascript.NpmConfig
2783
+
2784
+ The .npmrc file.
2785
+
2786
+ ---
2787
+
2788
+ ##### `package`<sup>Required</sup> <a name="package" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.package"></a>
2789
+
2790
+ ```typescript
2791
+ public readonly package: NodePackage;
2792
+ ```
2793
+
2794
+ - *Type:* projen.javascript.NodePackage
2795
+
2796
+ API for managing the node package.
2797
+
2798
+ ---
2799
+
2800
+ ##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.packageManager"></a>
2801
+
2802
+ - *Deprecated:* use `package.packageManager`
2803
+
2804
+ ```typescript
2805
+ public readonly packageManager: NodePackageManager;
2806
+ ```
2807
+
2808
+ - *Type:* projen.javascript.NodePackageManager
2809
+
2810
+ The package manager to use.
2811
+
2812
+ ---
2813
+
2814
+ ##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.runScriptCommand"></a>
2815
+
2816
+ ```typescript
2817
+ public readonly runScriptCommand: string;
2818
+ ```
2819
+
2820
+ - *Type:* string
2821
+
2822
+ The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager).
2823
+
2824
+ ---
2825
+
2826
+ ##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.autoMerge"></a>
2827
+
2828
+ ```typescript
2829
+ public readonly autoMerge: AutoMerge;
2830
+ ```
2831
+
2832
+ - *Type:* projen.github.AutoMerge
2833
+
2834
+ Component that sets up mergify for merging approved pull requests.
2835
+
2836
+ ---
2837
+
2838
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.biome"></a>
2839
+
2840
+ ```typescript
2841
+ public readonly biome: Biome;
2842
+ ```
2843
+
2844
+ - *Type:* projen.javascript.Biome
2845
+
2846
+ ---
2847
+
2848
+ ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.buildWorkflow"></a>
2849
+
2850
+ ```typescript
2851
+ public readonly buildWorkflow: BuildWorkflow;
2852
+ ```
2853
+
2854
+ - *Type:* projen.build.BuildWorkflow
2855
+
2856
+ The PR build GitHub workflow.
2857
+
2858
+ `undefined` if `buildWorkflow` is disabled.
2859
+
2860
+ ---
2861
+
2862
+ ##### `buildWorkflowJobId`<sup>Optional</sup> <a name="buildWorkflowJobId" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.buildWorkflowJobId"></a>
2863
+
2864
+ ```typescript
2865
+ public readonly buildWorkflowJobId: string;
2866
+ ```
2867
+
2868
+ - *Type:* string
2869
+
2870
+ The job ID of the build workflow.
2871
+
2872
+ ---
2873
+
2874
+ ##### `jest`<sup>Optional</sup> <a name="jest" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.jest"></a>
2875
+
2876
+ ```typescript
2877
+ public readonly jest: Jest;
2878
+ ```
2879
+
2880
+ - *Type:* projen.javascript.Jest
2881
+
2882
+ The Jest configuration (if enabled).
2883
+
2884
+ ---
2885
+
2886
+ ##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.maxNodeVersion"></a>
2887
+
2888
+ ```typescript
2889
+ public readonly maxNodeVersion: string;
2890
+ ```
2891
+
2892
+ - *Type:* string
2893
+
2894
+ Maximum node version supported by this package.
2895
+
2896
+ The value indicates the package is incompatible with newer versions.
2897
+
2898
+ ---
2899
+
2900
+ ##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.minNodeVersion"></a>
2901
+
2902
+ ```typescript
2903
+ public readonly minNodeVersion: string;
2904
+ ```
2905
+
2906
+ - *Type:* string
2907
+
2908
+ The minimum node version required by this package to function.
2909
+
2910
+ This value indicates the package is incompatible with older versions.
2911
+
2912
+ ---
2913
+
2914
+ ##### `npmignore`<sup>Optional</sup> <a name="npmignore" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.npmignore"></a>
2915
+
2916
+ ```typescript
2917
+ public readonly npmignore: IgnoreFile;
2918
+ ```
2919
+
2920
+ - *Type:* projen.IgnoreFile
2921
+
2922
+ The .npmignore file.
2923
+
2924
+ ---
2925
+
2926
+ ##### `prettier`<sup>Optional</sup> <a name="prettier" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.prettier"></a>
2927
+
2928
+ ```typescript
2929
+ public readonly prettier: Prettier;
2930
+ ```
2931
+
2932
+ - *Type:* projen.javascript.Prettier
2933
+
2934
+ ---
2935
+
2936
+ ##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.publisher"></a>
2937
+
2938
+ - *Deprecated:* use `release.publisher`.
2939
+
2940
+ ```typescript
2941
+ public readonly publisher: Publisher;
2942
+ ```
2943
+
2944
+ - *Type:* projen.release.Publisher
2945
+
2946
+ Package publisher.
2947
+
2948
+ This will be `undefined` if the project does not have a
2949
+ release workflow.
2950
+
2951
+ ---
2952
+
2953
+ ##### `release`<sup>Optional</sup> <a name="release" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.release"></a>
2954
+
2955
+ ```typescript
2956
+ public readonly release: Release;
2957
+ ```
2958
+
2959
+ - *Type:* projen.release.Release
2960
+
2961
+ Release management.
2962
+
2963
+ ---
2964
+
2965
+ ##### `upgradeWorkflow`<sup>Optional</sup> <a name="upgradeWorkflow" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.upgradeWorkflow"></a>
2966
+
2967
+ ```typescript
2968
+ public readonly upgradeWorkflow: UpgradeDependencies;
2969
+ ```
2970
+
2971
+ - *Type:* projen.javascript.UpgradeDependencies
2972
+
2973
+ The upgrade workflow.
2974
+
2975
+ ---
2976
+
2977
+ ##### `docsDirectory`<sup>Required</sup> <a name="docsDirectory" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.docsDirectory"></a>
2978
+
2979
+ ```typescript
2980
+ public readonly docsDirectory: string;
2981
+ ```
2982
+
2983
+ - *Type:* string
2984
+
2985
+ ---
2986
+
2987
+ ##### `libdir`<sup>Required</sup> <a name="libdir" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.libdir"></a>
2988
+
2989
+ ```typescript
2990
+ public readonly libdir: string;
2991
+ ```
2992
+
2993
+ - *Type:* string
2994
+
2995
+ The directory in which compiled .js files reside.
2996
+
2997
+ ---
2998
+
2999
+ ##### `srcdir`<sup>Required</sup> <a name="srcdir" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.srcdir"></a>
3000
+
3001
+ ```typescript
3002
+ public readonly srcdir: string;
3003
+ ```
3004
+
3005
+ - *Type:* string
3006
+
3007
+ The directory in which the .ts sources reside.
3008
+
3009
+ ---
3010
+
3011
+ ##### `testdir`<sup>Required</sup> <a name="testdir" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.testdir"></a>
3012
+
3013
+ ```typescript
3014
+ public readonly testdir: string;
3015
+ ```
3016
+
3017
+ - *Type:* string
3018
+
3019
+ The directory in which tests reside.
3020
+
3021
+ ---
3022
+
3023
+ ##### `tsconfigDev`<sup>Required</sup> <a name="tsconfigDev" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.tsconfigDev"></a>
3024
+
3025
+ ```typescript
3026
+ public readonly tsconfigDev: TypescriptConfig;
3027
+ ```
3028
+
3029
+ - *Type:* projen.javascript.TypescriptConfig
3030
+
3031
+ A typescript configuration file which covers all files (sources, tests, projen).
3032
+
3033
+ ---
3034
+
3035
+ ##### `watchTask`<sup>Required</sup> <a name="watchTask" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.watchTask"></a>
3036
+
3037
+ ```typescript
3038
+ public readonly watchTask: Task;
3039
+ ```
3040
+
3041
+ - *Type:* projen.Task
3042
+
3043
+ The "watch" task.
3044
+
3045
+ ---
3046
+
3047
+ ##### `docgen`<sup>Optional</sup> <a name="docgen" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.docgen"></a>
3048
+
3049
+ ```typescript
3050
+ public readonly docgen: boolean;
3051
+ ```
3052
+
3053
+ - *Type:* boolean
3054
+
3055
+ ---
3056
+
3057
+ ##### `eslint`<sup>Optional</sup> <a name="eslint" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.eslint"></a>
3058
+
3059
+ ```typescript
3060
+ public readonly eslint: Eslint;
3061
+ ```
3062
+
3063
+ - *Type:* projen.javascript.Eslint
3064
+
3065
+ ---
3066
+
3067
+ ##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.tsconfig"></a>
3068
+
3069
+ ```typescript
3070
+ public readonly tsconfig: TypescriptConfig;
3071
+ ```
3072
+
3073
+ - *Type:* projen.javascript.TypescriptConfig
3074
+
3075
+ ---
3076
+
3077
+ ##### `tsconfigEslint`<sup>Optional</sup> <a name="tsconfigEslint" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.tsconfigEslint"></a>
3078
+
3079
+ ```typescript
3080
+ public readonly tsconfigEslint: TypescriptConfig;
3081
+ ```
3082
+
3083
+ - *Type:* projen.javascript.TypescriptConfig
3084
+
3085
+ ---
3086
+
3087
+ ##### `appEntrypoint`<sup>Required</sup> <a name="appEntrypoint" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.appEntrypoint"></a>
3088
+
3089
+ ```typescript
3090
+ public readonly appEntrypoint: string;
3091
+ ```
3092
+
3093
+ - *Type:* string
3094
+
3095
+ The CDK app entrypoint.
3096
+
3097
+ ---
3098
+
3099
+ ##### `cdkConfig`<sup>Required</sup> <a name="cdkConfig" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.cdkConfig"></a>
3100
+
3101
+ ```typescript
3102
+ public readonly cdkConfig: CdkConfig;
3103
+ ```
3104
+
3105
+ - *Type:* projen.awscdk.CdkConfig
3106
+
3107
+ cdk.json configuration.
3108
+
3109
+ ---
3110
+
3111
+ ##### `cdkDeps`<sup>Required</sup> <a name="cdkDeps" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.cdkDeps"></a>
3112
+
3113
+ ```typescript
3114
+ public readonly cdkDeps: AwsCdkDeps;
3115
+ ```
3116
+
3117
+ - *Type:* projen.awscdk.AwsCdkDeps
3118
+
3119
+ ---
3120
+
3121
+ ##### `cdkTasks`<sup>Required</sup> <a name="cdkTasks" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.cdkTasks"></a>
3122
+
3123
+ ```typescript
3124
+ public readonly cdkTasks: CdkTasks;
3125
+ ```
3126
+
3127
+ - *Type:* projen.awscdk.CdkTasks
3128
+
3129
+ Common CDK tasks.
3130
+
3131
+ ---
3132
+
3133
+ ##### `cdkVersion`<sup>Required</sup> <a name="cdkVersion" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.cdkVersion"></a>
3134
+
3135
+ ```typescript
3136
+ public readonly cdkVersion: string;
3137
+ ```
3138
+
3139
+ - *Type:* string
3140
+
3141
+ The CDK version this app is using.
3142
+
3143
+ ---
3144
+
3145
+ #### Constants <a name="Constants" id="Constants"></a>
3146
+
3147
+ | **Name** | **Type** | **Description** |
3148
+ | --- | --- | --- |
3149
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.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). |
3150
+ | <code><a href="#@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
3151
+
3152
+ ---
3153
+
3154
+ ##### `DEFAULT_TASK`<sup>Required</sup> <a name="DEFAULT_TASK" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.DEFAULT_TASK"></a>
3155
+
3156
+ ```typescript
3157
+ public readonly DEFAULT_TASK: string;
3158
+ ```
3159
+
3160
+ - *Type:* string
3161
+
3162
+ The name of the default task (the task executed when `projen` is run without arguments).
3163
+
3164
+ Normally
3165
+ this task should synthesize the project files.
3166
+
3167
+ ---
3168
+
3169
+ ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
1584
3170
 
1585
3171
  ```typescript
1586
3172
  public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;