@flocoder93/base-project 0.0.3 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +96 -9
- package/API.md +290 -221
- package/LICENSE +19 -202
- package/lib/monorepo_project.d.ts +8 -2
- package/lib/monorepo_project.js +27 -12
- package/package.json +2 -2
- package/.yarn/install-state.gz +0 -0
- package/.yarn/releases/yarn-4.12.0.cjs +0 -942
package/API.md
CHANGED
|
@@ -2,18 +2,25 @@
|
|
|
2
2
|
|
|
3
3
|
## Constructs <a name="Constructs" id="Constructs"></a>
|
|
4
4
|
|
|
5
|
-
###
|
|
5
|
+
### MonorepoProject <a name="MonorepoProject" id="@flocoder93/base-project.MonorepoProject"></a>
|
|
6
6
|
|
|
7
|
-
#### Initializers <a name="Initializers" id="@flocoder93/base-project.
|
|
7
|
+
#### Initializers <a name="Initializers" id="@flocoder93/base-project.MonorepoProject.Initializer"></a>
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
import {
|
|
10
|
+
import { MonorepoProject } from '@flocoder93/base-project'
|
|
11
11
|
|
|
12
|
-
new
|
|
12
|
+
new MonorepoProject(options: MonorepoProjectOptions)
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
| **Name** | **Type** | **Description** |
|
|
16
16
|
| --- | --- | --- |
|
|
17
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.Initializer.parameter.options">options</a></code> | <code><a href="#@flocoder93/base-project.MonorepoProjectOptions">MonorepoProjectOptions</a></code> | *No description.* |
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
##### `options`<sup>Required</sup> <a name="options" id="@flocoder93/base-project.MonorepoProject.Initializer.parameter.options"></a>
|
|
22
|
+
|
|
23
|
+
- *Type:* <a href="#@flocoder93/base-project.MonorepoProjectOptions">MonorepoProjectOptions</a>
|
|
17
24
|
|
|
18
25
|
---
|
|
19
26
|
|
|
@@ -21,40 +28,40 @@ new MyMonorepoProject()
|
|
|
21
28
|
|
|
22
29
|
| **Name** | **Description** |
|
|
23
30
|
| --- | --- |
|
|
24
|
-
| <code><a href="#@flocoder93/base-project.
|
|
25
|
-
| <code><a href="#@flocoder93/base-project.
|
|
26
|
-
| <code><a href="#@flocoder93/base-project.
|
|
27
|
-
| <code><a href="#@flocoder93/base-project.
|
|
28
|
-
| <code><a href="#@flocoder93/base-project.
|
|
29
|
-
| <code><a href="#@flocoder93/base-project.
|
|
30
|
-
| <code><a href="#@flocoder93/base-project.
|
|
31
|
-
| <code><a href="#@flocoder93/base-project.
|
|
32
|
-
| <code><a href="#@flocoder93/base-project.
|
|
33
|
-
| <code><a href="#@flocoder93/base-project.
|
|
34
|
-
| <code><a href="#@flocoder93/base-project.
|
|
35
|
-
| <code><a href="#@flocoder93/base-project.
|
|
36
|
-
| <code><a href="#@flocoder93/base-project.
|
|
37
|
-
| <code><a href="#@flocoder93/base-project.
|
|
38
|
-
| <code><a href="#@flocoder93/base-project.
|
|
39
|
-
| <code><a href="#@flocoder93/base-project.
|
|
40
|
-
| <code><a href="#@flocoder93/base-project.
|
|
41
|
-
| <code><a href="#@flocoder93/base-project.
|
|
42
|
-
| <code><a href="#@flocoder93/base-project.
|
|
43
|
-
| <code><a href="#@flocoder93/base-project.
|
|
44
|
-
| <code><a href="#@flocoder93/base-project.
|
|
45
|
-
| <code><a href="#@flocoder93/base-project.
|
|
46
|
-
| <code><a href="#@flocoder93/base-project.
|
|
47
|
-
| <code><a href="#@flocoder93/base-project.
|
|
48
|
-
| <code><a href="#@flocoder93/base-project.
|
|
49
|
-
| <code><a href="#@flocoder93/base-project.
|
|
50
|
-
| <code><a href="#@flocoder93/base-project.
|
|
51
|
-
| <code><a href="#@flocoder93/base-project.
|
|
52
|
-
| <code><a href="#@flocoder93/base-project.
|
|
53
|
-
| <code><a href="#@flocoder93/base-project.
|
|
54
|
-
|
|
55
|
-
---
|
|
56
|
-
|
|
57
|
-
##### `toString` <a name="toString" id="@flocoder93/base-project.
|
|
31
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
32
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
33
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
34
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
35
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addTask">addTask</a></code> | Adds a new task to this project. |
|
|
36
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
|
|
37
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
|
|
38
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
|
|
39
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
|
|
40
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.removeTask">removeTask</a></code> | Removes a task from a project. |
|
|
41
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
|
|
42
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.synth">synth</a></code> | Synthesize all project files into `outdir`. |
|
|
43
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
|
|
44
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
|
|
45
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
|
|
46
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
|
|
47
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addBins">addBins</a></code> | *No description.* |
|
|
48
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
|
|
49
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
|
|
50
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addDeps">addDeps</a></code> | Defines normal dependencies. |
|
|
51
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
|
|
52
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
|
|
53
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
|
|
54
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
|
|
55
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
|
|
56
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
|
|
57
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
|
|
58
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
|
59
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
|
|
60
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
##### `toString` <a name="toString" id="@flocoder93/base-project.MonorepoProject.toString"></a>
|
|
58
65
|
|
|
59
66
|
```typescript
|
|
60
67
|
public toString(): string
|
|
@@ -62,7 +69,7 @@ public toString(): string
|
|
|
62
69
|
|
|
63
70
|
Returns a string representation of this construct.
|
|
64
71
|
|
|
65
|
-
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="@flocoder93/base-project.
|
|
72
|
+
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="@flocoder93/base-project.MonorepoProject.addExcludeFromCleanup"></a>
|
|
66
73
|
|
|
67
74
|
```typescript
|
|
68
75
|
public addExcludeFromCleanup(globs: ...string[]): void
|
|
@@ -73,7 +80,7 @@ Exclude the matching files from pre-synth cleanup.
|
|
|
73
80
|
Can be used when, for example, some
|
|
74
81
|
source files include the projen marker and we don't want them to be erased during synth.
|
|
75
82
|
|
|
76
|
-
###### `globs`<sup>Required</sup> <a name="globs" id="@flocoder93/base-project.
|
|
83
|
+
###### `globs`<sup>Required</sup> <a name="globs" id="@flocoder93/base-project.MonorepoProject.addExcludeFromCleanup.parameter.globs"></a>
|
|
77
84
|
|
|
78
85
|
- *Type:* ...string[]
|
|
79
86
|
|
|
@@ -81,7 +88,7 @@ The glob patterns to match.
|
|
|
81
88
|
|
|
82
89
|
---
|
|
83
90
|
|
|
84
|
-
##### `addGitIgnore` <a name="addGitIgnore" id="@flocoder93/base-project.
|
|
91
|
+
##### `addGitIgnore` <a name="addGitIgnore" id="@flocoder93/base-project.MonorepoProject.addGitIgnore"></a>
|
|
85
92
|
|
|
86
93
|
```typescript
|
|
87
94
|
public addGitIgnore(pattern: string): void
|
|
@@ -89,7 +96,7 @@ public addGitIgnore(pattern: string): void
|
|
|
89
96
|
|
|
90
97
|
Adds a .gitignore pattern.
|
|
91
98
|
|
|
92
|
-
###### `pattern`<sup>Required</sup> <a name="pattern" id="@flocoder93/base-project.
|
|
99
|
+
###### `pattern`<sup>Required</sup> <a name="pattern" id="@flocoder93/base-project.MonorepoProject.addGitIgnore.parameter.pattern"></a>
|
|
93
100
|
|
|
94
101
|
- *Type:* string
|
|
95
102
|
|
|
@@ -97,7 +104,7 @@ The glob pattern to ignore.
|
|
|
97
104
|
|
|
98
105
|
---
|
|
99
106
|
|
|
100
|
-
##### `addPackageIgnore` <a name="addPackageIgnore" id="@flocoder93/base-project.
|
|
107
|
+
##### `addPackageIgnore` <a name="addPackageIgnore" id="@flocoder93/base-project.MonorepoProject.addPackageIgnore"></a>
|
|
101
108
|
|
|
102
109
|
```typescript
|
|
103
110
|
public addPackageIgnore(pattern: string): void
|
|
@@ -105,7 +112,7 @@ public addPackageIgnore(pattern: string): void
|
|
|
105
112
|
|
|
106
113
|
Adds patterns to be ignored by npm.
|
|
107
114
|
|
|
108
|
-
###### `pattern`<sup>Required</sup> <a name="pattern" id="@flocoder93/base-project.
|
|
115
|
+
###### `pattern`<sup>Required</sup> <a name="pattern" id="@flocoder93/base-project.MonorepoProject.addPackageIgnore.parameter.pattern"></a>
|
|
109
116
|
|
|
110
117
|
- *Type:* string
|
|
111
118
|
|
|
@@ -113,7 +120,7 @@ The pattern to ignore.
|
|
|
113
120
|
|
|
114
121
|
---
|
|
115
122
|
|
|
116
|
-
##### `addTask` <a name="addTask" id="@flocoder93/base-project.
|
|
123
|
+
##### `addTask` <a name="addTask" id="@flocoder93/base-project.MonorepoProject.addTask"></a>
|
|
117
124
|
|
|
118
125
|
```typescript
|
|
119
126
|
public addTask(name: string, props?: TaskOptions): Task
|
|
@@ -124,7 +131,7 @@ Adds a new task to this project.
|
|
|
124
131
|
This will fail if the project already has
|
|
125
132
|
a task with this name.
|
|
126
133
|
|
|
127
|
-
###### `name`<sup>Required</sup> <a name="name" id="@flocoder93/base-project.
|
|
134
|
+
###### `name`<sup>Required</sup> <a name="name" id="@flocoder93/base-project.MonorepoProject.addTask.parameter.name"></a>
|
|
128
135
|
|
|
129
136
|
- *Type:* string
|
|
130
137
|
|
|
@@ -132,7 +139,7 @@ The task name to add.
|
|
|
132
139
|
|
|
133
140
|
---
|
|
134
141
|
|
|
135
|
-
###### `props`<sup>Optional</sup> <a name="props" id="@flocoder93/base-project.
|
|
142
|
+
###### `props`<sup>Optional</sup> <a name="props" id="@flocoder93/base-project.MonorepoProject.addTask.parameter.props"></a>
|
|
136
143
|
|
|
137
144
|
- *Type:* projen.TaskOptions
|
|
138
145
|
|
|
@@ -140,7 +147,7 @@ Task properties.
|
|
|
140
147
|
|
|
141
148
|
---
|
|
142
149
|
|
|
143
|
-
##### ~~`addTip`~~ <a name="addTip" id="@flocoder93/base-project.
|
|
150
|
+
##### ~~`addTip`~~ <a name="addTip" id="@flocoder93/base-project.MonorepoProject.addTip"></a>
|
|
144
151
|
|
|
145
152
|
```typescript
|
|
146
153
|
public addTip(message: string): void
|
|
@@ -148,7 +155,7 @@ public addTip(message: string): void
|
|
|
148
155
|
|
|
149
156
|
Prints a "tip" message during synthesis.
|
|
150
157
|
|
|
151
|
-
###### `message`<sup>Required</sup> <a name="message" id="@flocoder93/base-project.
|
|
158
|
+
###### `message`<sup>Required</sup> <a name="message" id="@flocoder93/base-project.MonorepoProject.addTip.parameter.message"></a>
|
|
152
159
|
|
|
153
160
|
- *Type:* string
|
|
154
161
|
|
|
@@ -156,7 +163,7 @@ The message.
|
|
|
156
163
|
|
|
157
164
|
---
|
|
158
165
|
|
|
159
|
-
##### `annotateGenerated` <a name="annotateGenerated" id="@flocoder93/base-project.
|
|
166
|
+
##### `annotateGenerated` <a name="annotateGenerated" id="@flocoder93/base-project.MonorepoProject.annotateGenerated"></a>
|
|
160
167
|
|
|
161
168
|
```typescript
|
|
162
169
|
public annotateGenerated(glob: string): void
|
|
@@ -170,7 +177,7 @@ repository statistics and language breakdown.
|
|
|
170
177
|
|
|
171
178
|
> [https://github.com/github/linguist/blob/master/docs/overrides.md](https://github.com/github/linguist/blob/master/docs/overrides.md)
|
|
172
179
|
|
|
173
|
-
###### `glob`<sup>Required</sup> <a name="glob" id="@flocoder93/base-project.
|
|
180
|
+
###### `glob`<sup>Required</sup> <a name="glob" id="@flocoder93/base-project.MonorepoProject.annotateGenerated.parameter.glob"></a>
|
|
174
181
|
|
|
175
182
|
- *Type:* string
|
|
176
183
|
|
|
@@ -178,7 +185,7 @@ the glob pattern to match (could be a file path).
|
|
|
178
185
|
|
|
179
186
|
---
|
|
180
187
|
|
|
181
|
-
##### `postSynthesize` <a name="postSynthesize" id="@flocoder93/base-project.
|
|
188
|
+
##### `postSynthesize` <a name="postSynthesize" id="@flocoder93/base-project.MonorepoProject.postSynthesize"></a>
|
|
182
189
|
|
|
183
190
|
```typescript
|
|
184
191
|
public postSynthesize(): void
|
|
@@ -188,7 +195,7 @@ Called after all components are synthesized.
|
|
|
188
195
|
|
|
189
196
|
Order is *not* guaranteed.
|
|
190
197
|
|
|
191
|
-
##### `preSynthesize` <a name="preSynthesize" id="@flocoder93/base-project.
|
|
198
|
+
##### `preSynthesize` <a name="preSynthesize" id="@flocoder93/base-project.MonorepoProject.preSynthesize"></a>
|
|
192
199
|
|
|
193
200
|
```typescript
|
|
194
201
|
public preSynthesize(): void
|
|
@@ -196,7 +203,7 @@ public preSynthesize(): void
|
|
|
196
203
|
|
|
197
204
|
Called before all components are synthesized.
|
|
198
205
|
|
|
199
|
-
##### `removeTask` <a name="removeTask" id="@flocoder93/base-project.
|
|
206
|
+
##### `removeTask` <a name="removeTask" id="@flocoder93/base-project.MonorepoProject.removeTask"></a>
|
|
200
207
|
|
|
201
208
|
```typescript
|
|
202
209
|
public removeTask(name: string): Task
|
|
@@ -204,7 +211,7 @@ public removeTask(name: string): Task
|
|
|
204
211
|
|
|
205
212
|
Removes a task from a project.
|
|
206
213
|
|
|
207
|
-
###### `name`<sup>Required</sup> <a name="name" id="@flocoder93/base-project.
|
|
214
|
+
###### `name`<sup>Required</sup> <a name="name" id="@flocoder93/base-project.MonorepoProject.removeTask.parameter.name"></a>
|
|
208
215
|
|
|
209
216
|
- *Type:* string
|
|
210
217
|
|
|
@@ -212,7 +219,7 @@ The name of the task to remove.
|
|
|
212
219
|
|
|
213
220
|
---
|
|
214
221
|
|
|
215
|
-
##### `runTaskCommand` <a name="runTaskCommand" id="@flocoder93/base-project.
|
|
222
|
+
##### `runTaskCommand` <a name="runTaskCommand" id="@flocoder93/base-project.MonorepoProject.runTaskCommand"></a>
|
|
216
223
|
|
|
217
224
|
```typescript
|
|
218
225
|
public runTaskCommand(task: Task): string
|
|
@@ -223,7 +230,7 @@ Returns the shell command to execute in order to run a task.
|
|
|
223
230
|
This will
|
|
224
231
|
typically be `npx projen TASK`.
|
|
225
232
|
|
|
226
|
-
###### `task`<sup>Required</sup> <a name="task" id="@flocoder93/base-project.
|
|
233
|
+
###### `task`<sup>Required</sup> <a name="task" id="@flocoder93/base-project.MonorepoProject.runTaskCommand.parameter.task"></a>
|
|
227
234
|
|
|
228
235
|
- *Type:* projen.Task
|
|
229
236
|
|
|
@@ -231,7 +238,7 @@ The task for which the command is required.
|
|
|
231
238
|
|
|
232
239
|
---
|
|
233
240
|
|
|
234
|
-
##### `synth` <a name="synth" id="@flocoder93/base-project.
|
|
241
|
+
##### `synth` <a name="synth" id="@flocoder93/base-project.MonorepoProject.synth"></a>
|
|
235
242
|
|
|
236
243
|
```typescript
|
|
237
244
|
public synth(): void
|
|
@@ -246,7 +253,7 @@ Synthesize all project files into `outdir`.
|
|
|
246
253
|
5. Call "postSynthesize()" for all components of this project
|
|
247
254
|
6. Call "this.postSynthesize()"
|
|
248
255
|
|
|
249
|
-
##### `tryFindFile` <a name="tryFindFile" id="@flocoder93/base-project.
|
|
256
|
+
##### `tryFindFile` <a name="tryFindFile" id="@flocoder93/base-project.MonorepoProject.tryFindFile"></a>
|
|
250
257
|
|
|
251
258
|
```typescript
|
|
252
259
|
public tryFindFile(filePath: string): FileBase
|
|
@@ -254,7 +261,7 @@ public tryFindFile(filePath: string): FileBase
|
|
|
254
261
|
|
|
255
262
|
Finds a file at the specified relative path within this project and all its subprojects.
|
|
256
263
|
|
|
257
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="@flocoder93/base-project.
|
|
264
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="@flocoder93/base-project.MonorepoProject.tryFindFile.parameter.filePath"></a>
|
|
258
265
|
|
|
259
266
|
- *Type:* string
|
|
260
267
|
|
|
@@ -265,7 +272,7 @@ from the root of _this_ project.
|
|
|
265
272
|
|
|
266
273
|
---
|
|
267
274
|
|
|
268
|
-
##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@flocoder93/base-project.
|
|
275
|
+
##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@flocoder93/base-project.MonorepoProject.tryFindJsonFile"></a>
|
|
269
276
|
|
|
270
277
|
```typescript
|
|
271
278
|
public tryFindJsonFile(filePath: string): JsonFile
|
|
@@ -273,7 +280,7 @@ public tryFindJsonFile(filePath: string): JsonFile
|
|
|
273
280
|
|
|
274
281
|
Finds a json file by name.
|
|
275
282
|
|
|
276
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="@flocoder93/base-project.
|
|
283
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="@flocoder93/base-project.MonorepoProject.tryFindJsonFile.parameter.filePath"></a>
|
|
277
284
|
|
|
278
285
|
- *Type:* string
|
|
279
286
|
|
|
@@ -281,7 +288,7 @@ The file path.
|
|
|
281
288
|
|
|
282
289
|
---
|
|
283
290
|
|
|
284
|
-
##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@flocoder93/base-project.
|
|
291
|
+
##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@flocoder93/base-project.MonorepoProject.tryFindObjectFile"></a>
|
|
285
292
|
|
|
286
293
|
```typescript
|
|
287
294
|
public tryFindObjectFile(filePath: string): ObjectFile
|
|
@@ -289,7 +296,7 @@ public tryFindObjectFile(filePath: string): ObjectFile
|
|
|
289
296
|
|
|
290
297
|
Finds an object file (like JsonFile, YamlFile, etc.) by name.
|
|
291
298
|
|
|
292
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="@flocoder93/base-project.
|
|
299
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="@flocoder93/base-project.MonorepoProject.tryFindObjectFile.parameter.filePath"></a>
|
|
293
300
|
|
|
294
301
|
- *Type:* string
|
|
295
302
|
|
|
@@ -297,7 +304,7 @@ The file path.
|
|
|
297
304
|
|
|
298
305
|
---
|
|
299
306
|
|
|
300
|
-
##### `tryRemoveFile` <a name="tryRemoveFile" id="@flocoder93/base-project.
|
|
307
|
+
##### `tryRemoveFile` <a name="tryRemoveFile" id="@flocoder93/base-project.MonorepoProject.tryRemoveFile"></a>
|
|
301
308
|
|
|
302
309
|
```typescript
|
|
303
310
|
public tryRemoveFile(filePath: string): FileBase
|
|
@@ -305,7 +312,7 @@ public tryRemoveFile(filePath: string): FileBase
|
|
|
305
312
|
|
|
306
313
|
Finds a file at the specified relative path within this project and removes it.
|
|
307
314
|
|
|
308
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="@flocoder93/base-project.
|
|
315
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="@flocoder93/base-project.MonorepoProject.tryRemoveFile.parameter.filePath"></a>
|
|
309
316
|
|
|
310
317
|
- *Type:* string
|
|
311
318
|
|
|
@@ -316,19 +323,19 @@ resolved from the root of _this_ project.
|
|
|
316
323
|
|
|
317
324
|
---
|
|
318
325
|
|
|
319
|
-
##### `addBins` <a name="addBins" id="@flocoder93/base-project.
|
|
326
|
+
##### `addBins` <a name="addBins" id="@flocoder93/base-project.MonorepoProject.addBins"></a>
|
|
320
327
|
|
|
321
328
|
```typescript
|
|
322
329
|
public addBins(bins: {[ key: string ]: string}): void
|
|
323
330
|
```
|
|
324
331
|
|
|
325
|
-
###### `bins`<sup>Required</sup> <a name="bins" id="@flocoder93/base-project.
|
|
332
|
+
###### `bins`<sup>Required</sup> <a name="bins" id="@flocoder93/base-project.MonorepoProject.addBins.parameter.bins"></a>
|
|
326
333
|
|
|
327
334
|
- *Type:* {[ key: string ]: string}
|
|
328
335
|
|
|
329
336
|
---
|
|
330
337
|
|
|
331
|
-
##### `addBundledDeps` <a name="addBundledDeps" id="@flocoder93/base-project.
|
|
338
|
+
##### `addBundledDeps` <a name="addBundledDeps" id="@flocoder93/base-project.MonorepoProject.addBundledDeps"></a>
|
|
332
339
|
|
|
333
340
|
```typescript
|
|
334
341
|
public addBundledDeps(deps: ...string[]): void
|
|
@@ -339,7 +346,7 @@ Defines bundled dependencies.
|
|
|
339
346
|
Bundled dependencies will be added as normal dependencies as well as to the
|
|
340
347
|
`bundledDependencies` section of your `package.json`.
|
|
341
348
|
|
|
342
|
-
###### `deps`<sup>Required</sup> <a name="deps" id="@flocoder93/base-project.
|
|
349
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@flocoder93/base-project.MonorepoProject.addBundledDeps.parameter.deps"></a>
|
|
343
350
|
|
|
344
351
|
- *Type:* ...string[]
|
|
345
352
|
|
|
@@ -353,7 +360,7 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
353
360
|
|
|
354
361
|
---
|
|
355
362
|
|
|
356
|
-
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@flocoder93/base-project.
|
|
363
|
+
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@flocoder93/base-project.MonorepoProject.addCompileCommand"></a>
|
|
357
364
|
|
|
358
365
|
```typescript
|
|
359
366
|
public addCompileCommand(commands: ...string[]): void
|
|
@@ -361,13 +368,13 @@ public addCompileCommand(commands: ...string[]): void
|
|
|
361
368
|
|
|
362
369
|
DEPRECATED.
|
|
363
370
|
|
|
364
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="@flocoder93/base-project.
|
|
371
|
+
###### `commands`<sup>Required</sup> <a name="commands" id="@flocoder93/base-project.MonorepoProject.addCompileCommand.parameter.commands"></a>
|
|
365
372
|
|
|
366
373
|
- *Type:* ...string[]
|
|
367
374
|
|
|
368
375
|
---
|
|
369
376
|
|
|
370
|
-
##### `addDeps` <a name="addDeps" id="@flocoder93/base-project.
|
|
377
|
+
##### `addDeps` <a name="addDeps" id="@flocoder93/base-project.MonorepoProject.addDeps"></a>
|
|
371
378
|
|
|
372
379
|
```typescript
|
|
373
380
|
public addDeps(deps: ...string[]): void
|
|
@@ -375,7 +382,7 @@ public addDeps(deps: ...string[]): void
|
|
|
375
382
|
|
|
376
383
|
Defines normal dependencies.
|
|
377
384
|
|
|
378
|
-
###### `deps`<sup>Required</sup> <a name="deps" id="@flocoder93/base-project.
|
|
385
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@flocoder93/base-project.MonorepoProject.addDeps.parameter.deps"></a>
|
|
379
386
|
|
|
380
387
|
- *Type:* ...string[]
|
|
381
388
|
|
|
@@ -389,7 +396,7 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
389
396
|
|
|
390
397
|
---
|
|
391
398
|
|
|
392
|
-
##### `addDevDeps` <a name="addDevDeps" id="@flocoder93/base-project.
|
|
399
|
+
##### `addDevDeps` <a name="addDevDeps" id="@flocoder93/base-project.MonorepoProject.addDevDeps"></a>
|
|
393
400
|
|
|
394
401
|
```typescript
|
|
395
402
|
public addDevDeps(deps: ...string[]): void
|
|
@@ -397,7 +404,7 @@ public addDevDeps(deps: ...string[]): void
|
|
|
397
404
|
|
|
398
405
|
Defines development/test dependencies.
|
|
399
406
|
|
|
400
|
-
###### `deps`<sup>Required</sup> <a name="deps" id="@flocoder93/base-project.
|
|
407
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@flocoder93/base-project.MonorepoProject.addDevDeps.parameter.deps"></a>
|
|
401
408
|
|
|
402
409
|
- *Type:* ...string[]
|
|
403
410
|
|
|
@@ -411,7 +418,7 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
411
418
|
|
|
412
419
|
---
|
|
413
420
|
|
|
414
|
-
##### `addFields` <a name="addFields" id="@flocoder93/base-project.
|
|
421
|
+
##### `addFields` <a name="addFields" id="@flocoder93/base-project.MonorepoProject.addFields"></a>
|
|
415
422
|
|
|
416
423
|
```typescript
|
|
417
424
|
public addFields(fields: {[ key: string ]: any}): void
|
|
@@ -419,7 +426,7 @@ public addFields(fields: {[ key: string ]: any}): void
|
|
|
419
426
|
|
|
420
427
|
Directly set fields in `package.json`.
|
|
421
428
|
|
|
422
|
-
###### `fields`<sup>Required</sup> <a name="fields" id="@flocoder93/base-project.
|
|
429
|
+
###### `fields`<sup>Required</sup> <a name="fields" id="@flocoder93/base-project.MonorepoProject.addFields.parameter.fields"></a>
|
|
423
430
|
|
|
424
431
|
- *Type:* {[ key: string ]: any}
|
|
425
432
|
|
|
@@ -427,7 +434,7 @@ The fields to set.
|
|
|
427
434
|
|
|
428
435
|
---
|
|
429
436
|
|
|
430
|
-
##### `addKeywords` <a name="addKeywords" id="@flocoder93/base-project.
|
|
437
|
+
##### `addKeywords` <a name="addKeywords" id="@flocoder93/base-project.MonorepoProject.addKeywords"></a>
|
|
431
438
|
|
|
432
439
|
```typescript
|
|
433
440
|
public addKeywords(keywords: ...string[]): void
|
|
@@ -435,7 +442,7 @@ public addKeywords(keywords: ...string[]): void
|
|
|
435
442
|
|
|
436
443
|
Adds keywords to package.json (deduplicated).
|
|
437
444
|
|
|
438
|
-
###### `keywords`<sup>Required</sup> <a name="keywords" id="@flocoder93/base-project.
|
|
445
|
+
###### `keywords`<sup>Required</sup> <a name="keywords" id="@flocoder93/base-project.MonorepoProject.addKeywords.parameter.keywords"></a>
|
|
439
446
|
|
|
440
447
|
- *Type:* ...string[]
|
|
441
448
|
|
|
@@ -443,7 +450,7 @@ The keywords to add.
|
|
|
443
450
|
|
|
444
451
|
---
|
|
445
452
|
|
|
446
|
-
##### `addPeerDeps` <a name="addPeerDeps" id="@flocoder93/base-project.
|
|
453
|
+
##### `addPeerDeps` <a name="addPeerDeps" id="@flocoder93/base-project.MonorepoProject.addPeerDeps"></a>
|
|
447
454
|
|
|
448
455
|
```typescript
|
|
449
456
|
public addPeerDeps(deps: ...string[]): void
|
|
@@ -455,7 +462,7 @@ When adding peer dependencies, a devDependency will also be added on the
|
|
|
455
462
|
pinned version of the declared peer. This will ensure that you are testing
|
|
456
463
|
your code against the minimum version required from your consumers.
|
|
457
464
|
|
|
458
|
-
###### `deps`<sup>Required</sup> <a name="deps" id="@flocoder93/base-project.
|
|
465
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@flocoder93/base-project.MonorepoProject.addPeerDeps.parameter.deps"></a>
|
|
459
466
|
|
|
460
467
|
- *Type:* ...string[]
|
|
461
468
|
|
|
@@ -469,7 +476,7 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
469
476
|
|
|
470
477
|
---
|
|
471
478
|
|
|
472
|
-
##### `addScripts` <a name="addScripts" id="@flocoder93/base-project.
|
|
479
|
+
##### `addScripts` <a name="addScripts" id="@flocoder93/base-project.MonorepoProject.addScripts"></a>
|
|
473
480
|
|
|
474
481
|
```typescript
|
|
475
482
|
public addScripts(scripts: {[ key: string ]: string}): void
|
|
@@ -477,7 +484,7 @@ public addScripts(scripts: {[ key: string ]: string}): void
|
|
|
477
484
|
|
|
478
485
|
Replaces the contents of multiple npm package.json scripts.
|
|
479
486
|
|
|
480
|
-
###### `scripts`<sup>Required</sup> <a name="scripts" id="@flocoder93/base-project.
|
|
487
|
+
###### `scripts`<sup>Required</sup> <a name="scripts" id="@flocoder93/base-project.MonorepoProject.addScripts.parameter.scripts"></a>
|
|
481
488
|
|
|
482
489
|
- *Type:* {[ key: string ]: string}
|
|
483
490
|
|
|
@@ -485,7 +492,7 @@ The scripts to set.
|
|
|
485
492
|
|
|
486
493
|
---
|
|
487
494
|
|
|
488
|
-
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@flocoder93/base-project.
|
|
495
|
+
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@flocoder93/base-project.MonorepoProject.addTestCommand"></a>
|
|
489
496
|
|
|
490
497
|
```typescript
|
|
491
498
|
public addTestCommand(commands: ...string[]): void
|
|
@@ -493,13 +500,13 @@ public addTestCommand(commands: ...string[]): void
|
|
|
493
500
|
|
|
494
501
|
DEPRECATED.
|
|
495
502
|
|
|
496
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="@flocoder93/base-project.
|
|
503
|
+
###### `commands`<sup>Required</sup> <a name="commands" id="@flocoder93/base-project.MonorepoProject.addTestCommand.parameter.commands"></a>
|
|
497
504
|
|
|
498
505
|
- *Type:* ...string[]
|
|
499
506
|
|
|
500
507
|
---
|
|
501
508
|
|
|
502
|
-
##### ~~`hasScript`~~ <a name="hasScript" id="@flocoder93/base-project.
|
|
509
|
+
##### ~~`hasScript`~~ <a name="hasScript" id="@flocoder93/base-project.MonorepoProject.hasScript"></a>
|
|
503
510
|
|
|
504
511
|
```typescript
|
|
505
512
|
public hasScript(name: string): boolean
|
|
@@ -507,7 +514,7 @@ public hasScript(name: string): boolean
|
|
|
507
514
|
|
|
508
515
|
Indicates if a script by the name name is defined.
|
|
509
516
|
|
|
510
|
-
###### `name`<sup>Required</sup> <a name="name" id="@flocoder93/base-project.
|
|
517
|
+
###### `name`<sup>Required</sup> <a name="name" id="@flocoder93/base-project.MonorepoProject.hasScript.parameter.name"></a>
|
|
511
518
|
|
|
512
519
|
- *Type:* string
|
|
513
520
|
|
|
@@ -515,7 +522,7 @@ The name of the script.
|
|
|
515
522
|
|
|
516
523
|
---
|
|
517
524
|
|
|
518
|
-
##### `removeScript` <a name="removeScript" id="@flocoder93/base-project.
|
|
525
|
+
##### `removeScript` <a name="removeScript" id="@flocoder93/base-project.MonorepoProject.removeScript"></a>
|
|
519
526
|
|
|
520
527
|
```typescript
|
|
521
528
|
public removeScript(name: string): void
|
|
@@ -523,7 +530,7 @@ public removeScript(name: string): void
|
|
|
523
530
|
|
|
524
531
|
Removes the npm script (always successful).
|
|
525
532
|
|
|
526
|
-
###### `name`<sup>Required</sup> <a name="name" id="@flocoder93/base-project.
|
|
533
|
+
###### `name`<sup>Required</sup> <a name="name" id="@flocoder93/base-project.MonorepoProject.removeScript.parameter.name"></a>
|
|
527
534
|
|
|
528
535
|
- *Type:* string
|
|
529
536
|
|
|
@@ -531,7 +538,7 @@ The name of the script.
|
|
|
531
538
|
|
|
532
539
|
---
|
|
533
540
|
|
|
534
|
-
##### `renderWorkflowSetup` <a name="renderWorkflowSetup" id="@flocoder93/base-project.
|
|
541
|
+
##### `renderWorkflowSetup` <a name="renderWorkflowSetup" id="@flocoder93/base-project.MonorepoProject.renderWorkflowSetup"></a>
|
|
535
542
|
|
|
536
543
|
```typescript
|
|
537
544
|
public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]
|
|
@@ -539,7 +546,7 @@ public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]
|
|
|
539
546
|
|
|
540
547
|
Returns the set of workflow steps which should be executed to bootstrap a workflow.
|
|
541
548
|
|
|
542
|
-
###### `options`<sup>Optional</sup> <a name="options" id="@flocoder93/base-project.
|
|
549
|
+
###### `options`<sup>Optional</sup> <a name="options" id="@flocoder93/base-project.MonorepoProject.renderWorkflowSetup.parameter.options"></a>
|
|
543
550
|
|
|
544
551
|
- *Type:* projen.javascript.RenderWorkflowSetupOptions
|
|
545
552
|
|
|
@@ -547,7 +554,7 @@ Options.
|
|
|
547
554
|
|
|
548
555
|
---
|
|
549
556
|
|
|
550
|
-
##### `setScript` <a name="setScript" id="@flocoder93/base-project.
|
|
557
|
+
##### `setScript` <a name="setScript" id="@flocoder93/base-project.MonorepoProject.setScript"></a>
|
|
551
558
|
|
|
552
559
|
```typescript
|
|
553
560
|
public setScript(name: string, command: string): void
|
|
@@ -555,7 +562,7 @@ public setScript(name: string, command: string): void
|
|
|
555
562
|
|
|
556
563
|
Replaces the contents of an npm package.json script.
|
|
557
564
|
|
|
558
|
-
###### `name`<sup>Required</sup> <a name="name" id="@flocoder93/base-project.
|
|
565
|
+
###### `name`<sup>Required</sup> <a name="name" id="@flocoder93/base-project.MonorepoProject.setScript.parameter.name"></a>
|
|
559
566
|
|
|
560
567
|
- *Type:* string
|
|
561
568
|
|
|
@@ -563,7 +570,7 @@ The script name.
|
|
|
563
570
|
|
|
564
571
|
---
|
|
565
572
|
|
|
566
|
-
###### `command`<sup>Required</sup> <a name="command" id="@flocoder93/base-project.
|
|
573
|
+
###### `command`<sup>Required</sup> <a name="command" id="@flocoder93/base-project.MonorepoProject.setScript.parameter.command"></a>
|
|
567
574
|
|
|
568
575
|
- *Type:* string
|
|
569
576
|
|
|
@@ -575,18 +582,18 @@ The command to execute.
|
|
|
575
582
|
|
|
576
583
|
| **Name** | **Description** |
|
|
577
584
|
| --- | --- |
|
|
578
|
-
| <code><a href="#@flocoder93/base-project.
|
|
579
|
-
| <code><a href="#@flocoder93/base-project.
|
|
580
|
-
| <code><a href="#@flocoder93/base-project.
|
|
585
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
586
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.isProject">isProject</a></code> | Test whether the given construct is a project. |
|
|
587
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.of">of</a></code> | Find the closest ancestor project for given construct. |
|
|
581
588
|
|
|
582
589
|
---
|
|
583
590
|
|
|
584
|
-
##### `isConstruct` <a name="isConstruct" id="@flocoder93/base-project.
|
|
591
|
+
##### `isConstruct` <a name="isConstruct" id="@flocoder93/base-project.MonorepoProject.isConstruct"></a>
|
|
585
592
|
|
|
586
593
|
```typescript
|
|
587
|
-
import {
|
|
594
|
+
import { MonorepoProject } from '@flocoder93/base-project'
|
|
588
595
|
|
|
589
|
-
|
|
596
|
+
MonorepoProject.isConstruct(x: any)
|
|
590
597
|
```
|
|
591
598
|
|
|
592
599
|
Checks if `x` is a construct.
|
|
@@ -605,7 +612,7 @@ library can be accidentally installed, and `instanceof` will behave
|
|
|
605
612
|
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
606
613
|
this type-testing method instead.
|
|
607
614
|
|
|
608
|
-
###### `x`<sup>Required</sup> <a name="x" id="@flocoder93/base-project.
|
|
615
|
+
###### `x`<sup>Required</sup> <a name="x" id="@flocoder93/base-project.MonorepoProject.isConstruct.parameter.x"></a>
|
|
609
616
|
|
|
610
617
|
- *Type:* any
|
|
611
618
|
|
|
@@ -613,35 +620,35 @@ Any object.
|
|
|
613
620
|
|
|
614
621
|
---
|
|
615
622
|
|
|
616
|
-
##### `isProject` <a name="isProject" id="@flocoder93/base-project.
|
|
623
|
+
##### `isProject` <a name="isProject" id="@flocoder93/base-project.MonorepoProject.isProject"></a>
|
|
617
624
|
|
|
618
625
|
```typescript
|
|
619
|
-
import {
|
|
626
|
+
import { MonorepoProject } from '@flocoder93/base-project'
|
|
620
627
|
|
|
621
|
-
|
|
628
|
+
MonorepoProject.isProject(x: any)
|
|
622
629
|
```
|
|
623
630
|
|
|
624
631
|
Test whether the given construct is a project.
|
|
625
632
|
|
|
626
|
-
###### `x`<sup>Required</sup> <a name="x" id="@flocoder93/base-project.
|
|
633
|
+
###### `x`<sup>Required</sup> <a name="x" id="@flocoder93/base-project.MonorepoProject.isProject.parameter.x"></a>
|
|
627
634
|
|
|
628
635
|
- *Type:* any
|
|
629
636
|
|
|
630
637
|
---
|
|
631
638
|
|
|
632
|
-
##### `of` <a name="of" id="@flocoder93/base-project.
|
|
639
|
+
##### `of` <a name="of" id="@flocoder93/base-project.MonorepoProject.of"></a>
|
|
633
640
|
|
|
634
641
|
```typescript
|
|
635
|
-
import {
|
|
642
|
+
import { MonorepoProject } from '@flocoder93/base-project'
|
|
636
643
|
|
|
637
|
-
|
|
644
|
+
MonorepoProject.of(construct: IConstruct)
|
|
638
645
|
```
|
|
639
646
|
|
|
640
647
|
Find the closest ancestor project for given construct.
|
|
641
648
|
|
|
642
649
|
When given a project, this it the project itself.
|
|
643
650
|
|
|
644
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="@flocoder93/base-project.
|
|
651
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@flocoder93/base-project.MonorepoProject.of.parameter.construct"></a>
|
|
645
652
|
|
|
646
653
|
- *Type:* constructs.IConstruct
|
|
647
654
|
|
|
@@ -651,63 +658,63 @@ When given a project, this it the project itself.
|
|
|
651
658
|
|
|
652
659
|
| **Name** | **Type** | **Description** |
|
|
653
660
|
| --- | --- | --- |
|
|
654
|
-
| <code><a href="#@flocoder93/base-project.
|
|
655
|
-
| <code><a href="#@flocoder93/base-project.
|
|
656
|
-
| <code><a href="#@flocoder93/base-project.
|
|
657
|
-
| <code><a href="#@flocoder93/base-project.
|
|
658
|
-
| <code><a href="#@flocoder93/base-project.
|
|
659
|
-
| <code><a href="#@flocoder93/base-project.
|
|
660
|
-
| <code><a href="#@flocoder93/base-project.
|
|
661
|
-
| <code><a href="#@flocoder93/base-project.
|
|
662
|
-
| <code><a href="#@flocoder93/base-project.
|
|
663
|
-
| <code><a href="#@flocoder93/base-project.
|
|
664
|
-
| <code><a href="#@flocoder93/base-project.
|
|
665
|
-
| <code><a href="#@flocoder93/base-project.
|
|
666
|
-
| <code><a href="#@flocoder93/base-project.
|
|
667
|
-
| <code><a href="#@flocoder93/base-project.
|
|
668
|
-
| <code><a href="#@flocoder93/base-project.
|
|
669
|
-
| <code><a href="#@flocoder93/base-project.
|
|
670
|
-
| <code><a href="#@flocoder93/base-project.
|
|
671
|
-
| <code><a href="#@flocoder93/base-project.
|
|
672
|
-
| <code><a href="#@flocoder93/base-project.
|
|
673
|
-
| <code><a href="#@flocoder93/base-project.
|
|
674
|
-
| <code><a href="#@flocoder93/base-project.
|
|
675
|
-
| <code><a href="#@flocoder93/base-project.
|
|
676
|
-
| <code><a href="#@flocoder93/base-project.
|
|
677
|
-
| <code><a href="#@flocoder93/base-project.
|
|
678
|
-
| <code><a href="#@flocoder93/base-project.
|
|
679
|
-
| <code><a href="#@flocoder93/base-project.
|
|
680
|
-
| <code><a href="#@flocoder93/base-project.
|
|
681
|
-
| <code><a href="#@flocoder93/base-project.
|
|
682
|
-
| <code><a href="#@flocoder93/base-project.
|
|
683
|
-
| <code><a href="#@flocoder93/base-project.
|
|
684
|
-
| <code><a href="#@flocoder93/base-project.
|
|
685
|
-
| <code><a href="#@flocoder93/base-project.
|
|
686
|
-
| <code><a href="#@flocoder93/base-project.
|
|
687
|
-
| <code><a href="#@flocoder93/base-project.
|
|
688
|
-
| <code><a href="#@flocoder93/base-project.
|
|
689
|
-
| <code><a href="#@flocoder93/base-project.
|
|
690
|
-
| <code><a href="#@flocoder93/base-project.
|
|
691
|
-
| <code><a href="#@flocoder93/base-project.
|
|
692
|
-
| <code><a href="#@flocoder93/base-project.
|
|
693
|
-
| <code><a href="#@flocoder93/base-project.
|
|
694
|
-
| <code><a href="#@flocoder93/base-project.
|
|
695
|
-
| <code><a href="#@flocoder93/base-project.
|
|
696
|
-
| <code><a href="#@flocoder93/base-project.
|
|
697
|
-
| <code><a href="#@flocoder93/base-project.
|
|
698
|
-
| <code><a href="#@flocoder93/base-project.
|
|
699
|
-
| <code><a href="#@flocoder93/base-project.
|
|
700
|
-
| <code><a href="#@flocoder93/base-project.
|
|
701
|
-
| <code><a href="#@flocoder93/base-project.
|
|
702
|
-
| <code><a href="#@flocoder93/base-project.
|
|
703
|
-
| <code><a href="#@flocoder93/base-project.
|
|
704
|
-
| <code><a href="#@flocoder93/base-project.
|
|
705
|
-
| <code><a href="#@flocoder93/base-project.
|
|
706
|
-
| <code><a href="#@flocoder93/base-project.
|
|
707
|
-
|
|
708
|
-
---
|
|
709
|
-
|
|
710
|
-
##### `node`<sup>Required</sup> <a name="node" id="@flocoder93/base-project.
|
|
661
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
662
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.buildTask">buildTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
663
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
664
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.compileTask">compileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
665
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.components">components</a></code> | <code>projen.Component[]</code> | Returns all the components within this project. |
|
|
666
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.deps">deps</a></code> | <code>projen.Dependencies</code> | Project dependencies. |
|
|
667
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.ejected">ejected</a></code> | <code>boolean</code> | Whether or not the project is being ejected. |
|
|
668
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.files">files</a></code> | <code>projen.FileBase[]</code> | All files in this project. |
|
|
669
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.gitattributes">gitattributes</a></code> | <code>projen.GitAttributesFile</code> | The .gitattributes file for this repository. |
|
|
670
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.gitignore">gitignore</a></code> | <code>projen.IgnoreFile</code> | .gitignore. |
|
|
671
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.logger">logger</a></code> | <code>projen.Logger</code> | Logging utilities. |
|
|
672
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.name">name</a></code> | <code>string</code> | Project name. |
|
|
673
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.outdir">outdir</a></code> | <code>string</code> | Absolute output directory of this project. |
|
|
674
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.packageTask">packageTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
675
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.postCompileTask">postCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
676
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.preCompileTask">preCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
677
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
|
|
678
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.projenCommand">projenCommand</a></code> | <code>string</code> | The command to use in order to run the projen CLI. |
|
|
679
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
|
|
680
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.subprojects">subprojects</a></code> | <code>projen.Project[]</code> | Returns all the subprojects within this project. |
|
|
681
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
|
|
682
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
683
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
684
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
|
|
685
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
|
|
686
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
|
|
687
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
|
|
688
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
|
|
689
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
|
|
690
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
|
|
691
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
|
|
692
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
|
|
693
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
|
|
694
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
|
|
695
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
|
|
696
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
|
|
697
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
|
|
698
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
|
|
699
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
|
|
700
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
|
|
701
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.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). |
|
|
702
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
|
|
703
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
|
|
704
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
|
|
705
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
|
|
706
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
|
|
707
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version supported by this package. |
|
|
708
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
709
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
710
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
711
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
712
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
|
|
713
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
714
|
+
|
|
715
|
+
---
|
|
716
|
+
|
|
717
|
+
##### `node`<sup>Required</sup> <a name="node" id="@flocoder93/base-project.MonorepoProject.property.node"></a>
|
|
711
718
|
|
|
712
719
|
```typescript
|
|
713
720
|
public readonly node: Node;
|
|
@@ -719,7 +726,7 @@ The tree node.
|
|
|
719
726
|
|
|
720
727
|
---
|
|
721
728
|
|
|
722
|
-
##### `buildTask`<sup>Required</sup> <a name="buildTask" id="@flocoder93/base-project.
|
|
729
|
+
##### `buildTask`<sup>Required</sup> <a name="buildTask" id="@flocoder93/base-project.MonorepoProject.property.buildTask"></a>
|
|
723
730
|
|
|
724
731
|
```typescript
|
|
725
732
|
public readonly buildTask: Task;
|
|
@@ -729,7 +736,7 @@ public readonly buildTask: Task;
|
|
|
729
736
|
|
|
730
737
|
---
|
|
731
738
|
|
|
732
|
-
##### `commitGenerated`<sup>Required</sup> <a name="commitGenerated" id="@flocoder93/base-project.
|
|
739
|
+
##### `commitGenerated`<sup>Required</sup> <a name="commitGenerated" id="@flocoder93/base-project.MonorepoProject.property.commitGenerated"></a>
|
|
733
740
|
|
|
734
741
|
```typescript
|
|
735
742
|
public readonly commitGenerated: boolean;
|
|
@@ -741,7 +748,7 @@ Whether to commit the managed files by default.
|
|
|
741
748
|
|
|
742
749
|
---
|
|
743
750
|
|
|
744
|
-
##### `compileTask`<sup>Required</sup> <a name="compileTask" id="@flocoder93/base-project.
|
|
751
|
+
##### `compileTask`<sup>Required</sup> <a name="compileTask" id="@flocoder93/base-project.MonorepoProject.property.compileTask"></a>
|
|
745
752
|
|
|
746
753
|
```typescript
|
|
747
754
|
public readonly compileTask: Task;
|
|
@@ -751,7 +758,7 @@ public readonly compileTask: Task;
|
|
|
751
758
|
|
|
752
759
|
---
|
|
753
760
|
|
|
754
|
-
##### `components`<sup>Required</sup> <a name="components" id="@flocoder93/base-project.
|
|
761
|
+
##### `components`<sup>Required</sup> <a name="components" id="@flocoder93/base-project.MonorepoProject.property.components"></a>
|
|
755
762
|
|
|
756
763
|
```typescript
|
|
757
764
|
public readonly components: Component[];
|
|
@@ -763,7 +770,7 @@ Returns all the components within this project.
|
|
|
763
770
|
|
|
764
771
|
---
|
|
765
772
|
|
|
766
|
-
##### `deps`<sup>Required</sup> <a name="deps" id="@flocoder93/base-project.
|
|
773
|
+
##### `deps`<sup>Required</sup> <a name="deps" id="@flocoder93/base-project.MonorepoProject.property.deps"></a>
|
|
767
774
|
|
|
768
775
|
```typescript
|
|
769
776
|
public readonly deps: Dependencies;
|
|
@@ -775,7 +782,7 @@ Project dependencies.
|
|
|
775
782
|
|
|
776
783
|
---
|
|
777
784
|
|
|
778
|
-
##### `ejected`<sup>Required</sup> <a name="ejected" id="@flocoder93/base-project.
|
|
785
|
+
##### `ejected`<sup>Required</sup> <a name="ejected" id="@flocoder93/base-project.MonorepoProject.property.ejected"></a>
|
|
779
786
|
|
|
780
787
|
```typescript
|
|
781
788
|
public readonly ejected: boolean;
|
|
@@ -787,7 +794,7 @@ Whether or not the project is being ejected.
|
|
|
787
794
|
|
|
788
795
|
---
|
|
789
796
|
|
|
790
|
-
##### `files`<sup>Required</sup> <a name="files" id="@flocoder93/base-project.
|
|
797
|
+
##### `files`<sup>Required</sup> <a name="files" id="@flocoder93/base-project.MonorepoProject.property.files"></a>
|
|
791
798
|
|
|
792
799
|
```typescript
|
|
793
800
|
public readonly files: FileBase[];
|
|
@@ -799,7 +806,7 @@ All files in this project.
|
|
|
799
806
|
|
|
800
807
|
---
|
|
801
808
|
|
|
802
|
-
##### `gitattributes`<sup>Required</sup> <a name="gitattributes" id="@flocoder93/base-project.
|
|
809
|
+
##### `gitattributes`<sup>Required</sup> <a name="gitattributes" id="@flocoder93/base-project.MonorepoProject.property.gitattributes"></a>
|
|
803
810
|
|
|
804
811
|
```typescript
|
|
805
812
|
public readonly gitattributes: GitAttributesFile;
|
|
@@ -811,7 +818,7 @@ The .gitattributes file for this repository.
|
|
|
811
818
|
|
|
812
819
|
---
|
|
813
820
|
|
|
814
|
-
##### `gitignore`<sup>Required</sup> <a name="gitignore" id="@flocoder93/base-project.
|
|
821
|
+
##### `gitignore`<sup>Required</sup> <a name="gitignore" id="@flocoder93/base-project.MonorepoProject.property.gitignore"></a>
|
|
815
822
|
|
|
816
823
|
```typescript
|
|
817
824
|
public readonly gitignore: IgnoreFile;
|
|
@@ -823,7 +830,7 @@ public readonly gitignore: IgnoreFile;
|
|
|
823
830
|
|
|
824
831
|
---
|
|
825
832
|
|
|
826
|
-
##### `logger`<sup>Required</sup> <a name="logger" id="@flocoder93/base-project.
|
|
833
|
+
##### `logger`<sup>Required</sup> <a name="logger" id="@flocoder93/base-project.MonorepoProject.property.logger"></a>
|
|
827
834
|
|
|
828
835
|
```typescript
|
|
829
836
|
public readonly logger: Logger;
|
|
@@ -835,7 +842,7 @@ Logging utilities.
|
|
|
835
842
|
|
|
836
843
|
---
|
|
837
844
|
|
|
838
|
-
##### `name`<sup>Required</sup> <a name="name" id="@flocoder93/base-project.
|
|
845
|
+
##### `name`<sup>Required</sup> <a name="name" id="@flocoder93/base-project.MonorepoProject.property.name"></a>
|
|
839
846
|
|
|
840
847
|
```typescript
|
|
841
848
|
public readonly name: string;
|
|
@@ -847,7 +854,7 @@ Project name.
|
|
|
847
854
|
|
|
848
855
|
---
|
|
849
856
|
|
|
850
|
-
##### `outdir`<sup>Required</sup> <a name="outdir" id="@flocoder93/base-project.
|
|
857
|
+
##### `outdir`<sup>Required</sup> <a name="outdir" id="@flocoder93/base-project.MonorepoProject.property.outdir"></a>
|
|
851
858
|
|
|
852
859
|
```typescript
|
|
853
860
|
public readonly outdir: string;
|
|
@@ -859,7 +866,7 @@ Absolute output directory of this project.
|
|
|
859
866
|
|
|
860
867
|
---
|
|
861
868
|
|
|
862
|
-
##### `packageTask`<sup>Required</sup> <a name="packageTask" id="@flocoder93/base-project.
|
|
869
|
+
##### `packageTask`<sup>Required</sup> <a name="packageTask" id="@flocoder93/base-project.MonorepoProject.property.packageTask"></a>
|
|
863
870
|
|
|
864
871
|
```typescript
|
|
865
872
|
public readonly packageTask: Task;
|
|
@@ -869,7 +876,7 @@ public readonly packageTask: Task;
|
|
|
869
876
|
|
|
870
877
|
---
|
|
871
878
|
|
|
872
|
-
##### `postCompileTask`<sup>Required</sup> <a name="postCompileTask" id="@flocoder93/base-project.
|
|
879
|
+
##### `postCompileTask`<sup>Required</sup> <a name="postCompileTask" id="@flocoder93/base-project.MonorepoProject.property.postCompileTask"></a>
|
|
873
880
|
|
|
874
881
|
```typescript
|
|
875
882
|
public readonly postCompileTask: Task;
|
|
@@ -879,7 +886,7 @@ public readonly postCompileTask: Task;
|
|
|
879
886
|
|
|
880
887
|
---
|
|
881
888
|
|
|
882
|
-
##### `preCompileTask`<sup>Required</sup> <a name="preCompileTask" id="@flocoder93/base-project.
|
|
889
|
+
##### `preCompileTask`<sup>Required</sup> <a name="preCompileTask" id="@flocoder93/base-project.MonorepoProject.property.preCompileTask"></a>
|
|
883
890
|
|
|
884
891
|
```typescript
|
|
885
892
|
public readonly preCompileTask: Task;
|
|
@@ -889,7 +896,7 @@ public readonly preCompileTask: Task;
|
|
|
889
896
|
|
|
890
897
|
---
|
|
891
898
|
|
|
892
|
-
##### `projectBuild`<sup>Required</sup> <a name="projectBuild" id="@flocoder93/base-project.
|
|
899
|
+
##### `projectBuild`<sup>Required</sup> <a name="projectBuild" id="@flocoder93/base-project.MonorepoProject.property.projectBuild"></a>
|
|
893
900
|
|
|
894
901
|
```typescript
|
|
895
902
|
public readonly projectBuild: ProjectBuild;
|
|
@@ -901,7 +908,7 @@ Manages the build process of the project.
|
|
|
901
908
|
|
|
902
909
|
---
|
|
903
910
|
|
|
904
|
-
##### `projenCommand`<sup>Required</sup> <a name="projenCommand" id="@flocoder93/base-project.
|
|
911
|
+
##### `projenCommand`<sup>Required</sup> <a name="projenCommand" id="@flocoder93/base-project.MonorepoProject.property.projenCommand"></a>
|
|
905
912
|
|
|
906
913
|
```typescript
|
|
907
914
|
public readonly projenCommand: string;
|
|
@@ -913,7 +920,7 @@ The command to use in order to run the projen CLI.
|
|
|
913
920
|
|
|
914
921
|
---
|
|
915
922
|
|
|
916
|
-
##### `root`<sup>Required</sup> <a name="root" id="@flocoder93/base-project.
|
|
923
|
+
##### `root`<sup>Required</sup> <a name="root" id="@flocoder93/base-project.MonorepoProject.property.root"></a>
|
|
917
924
|
|
|
918
925
|
```typescript
|
|
919
926
|
public readonly root: Project;
|
|
@@ -925,7 +932,7 @@ The root project.
|
|
|
925
932
|
|
|
926
933
|
---
|
|
927
934
|
|
|
928
|
-
##### `subprojects`<sup>Required</sup> <a name="subprojects" id="@flocoder93/base-project.
|
|
935
|
+
##### `subprojects`<sup>Required</sup> <a name="subprojects" id="@flocoder93/base-project.MonorepoProject.property.subprojects"></a>
|
|
929
936
|
|
|
930
937
|
```typescript
|
|
931
938
|
public readonly subprojects: Project[];
|
|
@@ -937,7 +944,7 @@ Returns all the subprojects within this project.
|
|
|
937
944
|
|
|
938
945
|
---
|
|
939
946
|
|
|
940
|
-
##### `tasks`<sup>Required</sup> <a name="tasks" id="@flocoder93/base-project.
|
|
947
|
+
##### `tasks`<sup>Required</sup> <a name="tasks" id="@flocoder93/base-project.MonorepoProject.property.tasks"></a>
|
|
941
948
|
|
|
942
949
|
```typescript
|
|
943
950
|
public readonly tasks: Tasks;
|
|
@@ -949,7 +956,7 @@ Project tasks.
|
|
|
949
956
|
|
|
950
957
|
---
|
|
951
958
|
|
|
952
|
-
##### `testTask`<sup>Required</sup> <a name="testTask" id="@flocoder93/base-project.
|
|
959
|
+
##### `testTask`<sup>Required</sup> <a name="testTask" id="@flocoder93/base-project.MonorepoProject.property.testTask"></a>
|
|
953
960
|
|
|
954
961
|
```typescript
|
|
955
962
|
public readonly testTask: Task;
|
|
@@ -959,7 +966,7 @@ public readonly testTask: Task;
|
|
|
959
966
|
|
|
960
967
|
---
|
|
961
968
|
|
|
962
|
-
##### `defaultTask`<sup>Optional</sup> <a name="defaultTask" id="@flocoder93/base-project.
|
|
969
|
+
##### `defaultTask`<sup>Optional</sup> <a name="defaultTask" id="@flocoder93/base-project.MonorepoProject.property.defaultTask"></a>
|
|
963
970
|
|
|
964
971
|
```typescript
|
|
965
972
|
public readonly defaultTask: Task;
|
|
@@ -974,7 +981,7 @@ the project is being ejected.
|
|
|
974
981
|
|
|
975
982
|
---
|
|
976
983
|
|
|
977
|
-
##### `initProject`<sup>Optional</sup> <a name="initProject" id="@flocoder93/base-project.
|
|
984
|
+
##### `initProject`<sup>Optional</sup> <a name="initProject" id="@flocoder93/base-project.MonorepoProject.property.initProject"></a>
|
|
978
985
|
|
|
979
986
|
```typescript
|
|
980
987
|
public readonly initProject: InitProject;
|
|
@@ -990,7 +997,7 @@ FQN of the project type.
|
|
|
990
997
|
|
|
991
998
|
---
|
|
992
999
|
|
|
993
|
-
##### `parent`<sup>Optional</sup> <a name="parent" id="@flocoder93/base-project.
|
|
1000
|
+
##### `parent`<sup>Optional</sup> <a name="parent" id="@flocoder93/base-project.MonorepoProject.property.parent"></a>
|
|
994
1001
|
|
|
995
1002
|
```typescript
|
|
996
1003
|
public readonly parent: Project;
|
|
@@ -1004,7 +1011,7 @@ If undefined, this is the root project.
|
|
|
1004
1011
|
|
|
1005
1012
|
---
|
|
1006
1013
|
|
|
1007
|
-
##### `projectType`<sup>Required</sup> <a name="projectType" id="@flocoder93/base-project.
|
|
1014
|
+
##### `projectType`<sup>Required</sup> <a name="projectType" id="@flocoder93/base-project.MonorepoProject.property.projectType"></a>
|
|
1008
1015
|
|
|
1009
1016
|
```typescript
|
|
1010
1017
|
public readonly projectType: ProjectType;
|
|
@@ -1014,7 +1021,7 @@ public readonly projectType: ProjectType;
|
|
|
1014
1021
|
|
|
1015
1022
|
---
|
|
1016
1023
|
|
|
1017
|
-
##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@flocoder93/base-project.
|
|
1024
|
+
##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@flocoder93/base-project.MonorepoProject.property.autoApprove"></a>
|
|
1018
1025
|
|
|
1019
1026
|
```typescript
|
|
1020
1027
|
public readonly autoApprove: AutoApprove;
|
|
@@ -1026,7 +1033,7 @@ Auto approve set up for this project.
|
|
|
1026
1033
|
|
|
1027
1034
|
---
|
|
1028
1035
|
|
|
1029
|
-
##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@flocoder93/base-project.
|
|
1036
|
+
##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@flocoder93/base-project.MonorepoProject.property.devContainer"></a>
|
|
1030
1037
|
|
|
1031
1038
|
```typescript
|
|
1032
1039
|
public readonly devContainer: DevContainer;
|
|
@@ -1040,7 +1047,7 @@ This will be `undefined` if devContainer boolean is false
|
|
|
1040
1047
|
|
|
1041
1048
|
---
|
|
1042
1049
|
|
|
1043
|
-
##### `github`<sup>Optional</sup> <a name="github" id="@flocoder93/base-project.
|
|
1050
|
+
##### `github`<sup>Optional</sup> <a name="github" id="@flocoder93/base-project.MonorepoProject.property.github"></a>
|
|
1044
1051
|
|
|
1045
1052
|
```typescript
|
|
1046
1053
|
public readonly github: GitHub;
|
|
@@ -1054,7 +1061,7 @@ This will be `undefined` for subprojects.
|
|
|
1054
1061
|
|
|
1055
1062
|
---
|
|
1056
1063
|
|
|
1057
|
-
##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@flocoder93/base-project.
|
|
1064
|
+
##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@flocoder93/base-project.MonorepoProject.property.gitpod"></a>
|
|
1058
1065
|
|
|
1059
1066
|
```typescript
|
|
1060
1067
|
public readonly gitpod: Gitpod;
|
|
@@ -1068,7 +1075,7 @@ This will be `undefined` if gitpod boolean is false
|
|
|
1068
1075
|
|
|
1069
1076
|
---
|
|
1070
1077
|
|
|
1071
|
-
##### `vscode`<sup>Optional</sup> <a name="vscode" id="@flocoder93/base-project.
|
|
1078
|
+
##### `vscode`<sup>Optional</sup> <a name="vscode" id="@flocoder93/base-project.MonorepoProject.property.vscode"></a>
|
|
1072
1079
|
|
|
1073
1080
|
```typescript
|
|
1074
1081
|
public readonly vscode: VsCode;
|
|
@@ -1082,7 +1089,7 @@ This will be `undefined` for subprojects.
|
|
|
1082
1089
|
|
|
1083
1090
|
---
|
|
1084
1091
|
|
|
1085
|
-
##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@flocoder93/base-project.
|
|
1092
|
+
##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@flocoder93/base-project.MonorepoProject.property.allowLibraryDependencies"></a>
|
|
1086
1093
|
|
|
1087
1094
|
- *Deprecated:* use `package.allowLibraryDependencies`
|
|
1088
1095
|
|
|
@@ -1094,7 +1101,7 @@ public readonly allowLibraryDependencies: boolean;
|
|
|
1094
1101
|
|
|
1095
1102
|
---
|
|
1096
1103
|
|
|
1097
|
-
##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="@flocoder93/base-project.
|
|
1104
|
+
##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="@flocoder93/base-project.MonorepoProject.property.artifactsDirectory"></a>
|
|
1098
1105
|
|
|
1099
1106
|
```typescript
|
|
1100
1107
|
public readonly artifactsDirectory: string;
|
|
@@ -1110,7 +1117,7 @@ tarball will be placed under `dist/js/boom-boom-1.2.3.tg`.
|
|
|
1110
1117
|
|
|
1111
1118
|
---
|
|
1112
1119
|
|
|
1113
|
-
##### `artifactsJavascriptDirectory`<sup>Required</sup> <a name="artifactsJavascriptDirectory" id="@flocoder93/base-project.
|
|
1120
|
+
##### `artifactsJavascriptDirectory`<sup>Required</sup> <a name="artifactsJavascriptDirectory" id="@flocoder93/base-project.MonorepoProject.property.artifactsJavascriptDirectory"></a>
|
|
1114
1121
|
|
|
1115
1122
|
```typescript
|
|
1116
1123
|
public readonly artifactsJavascriptDirectory: string;
|
|
@@ -1122,7 +1129,7 @@ The location of the npm tarball after build (`${artifactsDirectory}/js`).
|
|
|
1122
1129
|
|
|
1123
1130
|
---
|
|
1124
1131
|
|
|
1125
|
-
##### `bundler`<sup>Required</sup> <a name="bundler" id="@flocoder93/base-project.
|
|
1132
|
+
##### `bundler`<sup>Required</sup> <a name="bundler" id="@flocoder93/base-project.MonorepoProject.property.bundler"></a>
|
|
1126
1133
|
|
|
1127
1134
|
```typescript
|
|
1128
1135
|
public readonly bundler: Bundler;
|
|
@@ -1132,7 +1139,7 @@ public readonly bundler: Bundler;
|
|
|
1132
1139
|
|
|
1133
1140
|
---
|
|
1134
1141
|
|
|
1135
|
-
##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@flocoder93/base-project.
|
|
1142
|
+
##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@flocoder93/base-project.MonorepoProject.property.entrypoint"></a>
|
|
1136
1143
|
|
|
1137
1144
|
- *Deprecated:* use `package.entrypoint`
|
|
1138
1145
|
|
|
@@ -1144,7 +1151,7 @@ public readonly entrypoint: string;
|
|
|
1144
1151
|
|
|
1145
1152
|
---
|
|
1146
1153
|
|
|
1147
|
-
##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@flocoder93/base-project.
|
|
1154
|
+
##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@flocoder93/base-project.MonorepoProject.property.manifest"></a>
|
|
1148
1155
|
|
|
1149
1156
|
- *Deprecated:* use `package.addField(x, y)`
|
|
1150
1157
|
|
|
@@ -1156,7 +1163,7 @@ public readonly manifest: any;
|
|
|
1156
1163
|
|
|
1157
1164
|
---
|
|
1158
1165
|
|
|
1159
|
-
##### `npmrc`<sup>Required</sup> <a name="npmrc" id="@flocoder93/base-project.
|
|
1166
|
+
##### `npmrc`<sup>Required</sup> <a name="npmrc" id="@flocoder93/base-project.MonorepoProject.property.npmrc"></a>
|
|
1160
1167
|
|
|
1161
1168
|
```typescript
|
|
1162
1169
|
public readonly npmrc: NpmConfig;
|
|
@@ -1168,7 +1175,7 @@ The .npmrc file.
|
|
|
1168
1175
|
|
|
1169
1176
|
---
|
|
1170
1177
|
|
|
1171
|
-
##### `package`<sup>Required</sup> <a name="package" id="@flocoder93/base-project.
|
|
1178
|
+
##### `package`<sup>Required</sup> <a name="package" id="@flocoder93/base-project.MonorepoProject.property.package"></a>
|
|
1172
1179
|
|
|
1173
1180
|
```typescript
|
|
1174
1181
|
public readonly package: NodePackage;
|
|
@@ -1180,7 +1187,7 @@ API for managing the node package.
|
|
|
1180
1187
|
|
|
1181
1188
|
---
|
|
1182
1189
|
|
|
1183
|
-
##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@flocoder93/base-project.
|
|
1190
|
+
##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@flocoder93/base-project.MonorepoProject.property.packageManager"></a>
|
|
1184
1191
|
|
|
1185
1192
|
- *Deprecated:* use `package.packageManager`
|
|
1186
1193
|
|
|
@@ -1194,7 +1201,7 @@ The package manager to use.
|
|
|
1194
1201
|
|
|
1195
1202
|
---
|
|
1196
1203
|
|
|
1197
|
-
##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@flocoder93/base-project.
|
|
1204
|
+
##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@flocoder93/base-project.MonorepoProject.property.runScriptCommand"></a>
|
|
1198
1205
|
|
|
1199
1206
|
```typescript
|
|
1200
1207
|
public readonly runScriptCommand: string;
|
|
@@ -1206,7 +1213,7 @@ The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the p
|
|
|
1206
1213
|
|
|
1207
1214
|
---
|
|
1208
1215
|
|
|
1209
|
-
##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@flocoder93/base-project.
|
|
1216
|
+
##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@flocoder93/base-project.MonorepoProject.property.autoMerge"></a>
|
|
1210
1217
|
|
|
1211
1218
|
```typescript
|
|
1212
1219
|
public readonly autoMerge: AutoMerge;
|
|
@@ -1218,7 +1225,7 @@ Component that sets up mergify for merging approved pull requests.
|
|
|
1218
1225
|
|
|
1219
1226
|
---
|
|
1220
1227
|
|
|
1221
|
-
##### `biome`<sup>Optional</sup> <a name="biome" id="@flocoder93/base-project.
|
|
1228
|
+
##### `biome`<sup>Optional</sup> <a name="biome" id="@flocoder93/base-project.MonorepoProject.property.biome"></a>
|
|
1222
1229
|
|
|
1223
1230
|
```typescript
|
|
1224
1231
|
public readonly biome: Biome;
|
|
@@ -1228,7 +1235,7 @@ public readonly biome: Biome;
|
|
|
1228
1235
|
|
|
1229
1236
|
---
|
|
1230
1237
|
|
|
1231
|
-
##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@flocoder93/base-project.
|
|
1238
|
+
##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@flocoder93/base-project.MonorepoProject.property.buildWorkflow"></a>
|
|
1232
1239
|
|
|
1233
1240
|
```typescript
|
|
1234
1241
|
public readonly buildWorkflow: BuildWorkflow;
|
|
@@ -1242,7 +1249,7 @@ The PR build GitHub workflow.
|
|
|
1242
1249
|
|
|
1243
1250
|
---
|
|
1244
1251
|
|
|
1245
|
-
##### `buildWorkflowJobId`<sup>Optional</sup> <a name="buildWorkflowJobId" id="@flocoder93/base-project.
|
|
1252
|
+
##### `buildWorkflowJobId`<sup>Optional</sup> <a name="buildWorkflowJobId" id="@flocoder93/base-project.MonorepoProject.property.buildWorkflowJobId"></a>
|
|
1246
1253
|
|
|
1247
1254
|
```typescript
|
|
1248
1255
|
public readonly buildWorkflowJobId: string;
|
|
@@ -1254,7 +1261,7 @@ The job ID of the build workflow.
|
|
|
1254
1261
|
|
|
1255
1262
|
---
|
|
1256
1263
|
|
|
1257
|
-
##### `jest`<sup>Optional</sup> <a name="jest" id="@flocoder93/base-project.
|
|
1264
|
+
##### `jest`<sup>Optional</sup> <a name="jest" id="@flocoder93/base-project.MonorepoProject.property.jest"></a>
|
|
1258
1265
|
|
|
1259
1266
|
```typescript
|
|
1260
1267
|
public readonly jest: Jest;
|
|
@@ -1266,7 +1273,7 @@ The Jest configuration (if enabled).
|
|
|
1266
1273
|
|
|
1267
1274
|
---
|
|
1268
1275
|
|
|
1269
|
-
##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@flocoder93/base-project.
|
|
1276
|
+
##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@flocoder93/base-project.MonorepoProject.property.maxNodeVersion"></a>
|
|
1270
1277
|
|
|
1271
1278
|
```typescript
|
|
1272
1279
|
public readonly maxNodeVersion: string;
|
|
@@ -1280,7 +1287,7 @@ The value indicates the package is incompatible with newer versions.
|
|
|
1280
1287
|
|
|
1281
1288
|
---
|
|
1282
1289
|
|
|
1283
|
-
##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@flocoder93/base-project.
|
|
1290
|
+
##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@flocoder93/base-project.MonorepoProject.property.minNodeVersion"></a>
|
|
1284
1291
|
|
|
1285
1292
|
```typescript
|
|
1286
1293
|
public readonly minNodeVersion: string;
|
|
@@ -1294,7 +1301,7 @@ This value indicates the package is incompatible with older versions.
|
|
|
1294
1301
|
|
|
1295
1302
|
---
|
|
1296
1303
|
|
|
1297
|
-
##### `npmignore`<sup>Optional</sup> <a name="npmignore" id="@flocoder93/base-project.
|
|
1304
|
+
##### `npmignore`<sup>Optional</sup> <a name="npmignore" id="@flocoder93/base-project.MonorepoProject.property.npmignore"></a>
|
|
1298
1305
|
|
|
1299
1306
|
```typescript
|
|
1300
1307
|
public readonly npmignore: IgnoreFile;
|
|
@@ -1306,7 +1313,7 @@ The .npmignore file.
|
|
|
1306
1313
|
|
|
1307
1314
|
---
|
|
1308
1315
|
|
|
1309
|
-
##### `prettier`<sup>Optional</sup> <a name="prettier" id="@flocoder93/base-project.
|
|
1316
|
+
##### `prettier`<sup>Optional</sup> <a name="prettier" id="@flocoder93/base-project.MonorepoProject.property.prettier"></a>
|
|
1310
1317
|
|
|
1311
1318
|
```typescript
|
|
1312
1319
|
public readonly prettier: Prettier;
|
|
@@ -1316,7 +1323,7 @@ public readonly prettier: Prettier;
|
|
|
1316
1323
|
|
|
1317
1324
|
---
|
|
1318
1325
|
|
|
1319
|
-
##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@flocoder93/base-project.
|
|
1326
|
+
##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@flocoder93/base-project.MonorepoProject.property.publisher"></a>
|
|
1320
1327
|
|
|
1321
1328
|
- *Deprecated:* use `release.publisher`.
|
|
1322
1329
|
|
|
@@ -1333,7 +1340,7 @@ release workflow.
|
|
|
1333
1340
|
|
|
1334
1341
|
---
|
|
1335
1342
|
|
|
1336
|
-
##### `release`<sup>Optional</sup> <a name="release" id="@flocoder93/base-project.
|
|
1343
|
+
##### `release`<sup>Optional</sup> <a name="release" id="@flocoder93/base-project.MonorepoProject.property.release"></a>
|
|
1337
1344
|
|
|
1338
1345
|
```typescript
|
|
1339
1346
|
public readonly release: Release;
|
|
@@ -1345,7 +1352,7 @@ Release management.
|
|
|
1345
1352
|
|
|
1346
1353
|
---
|
|
1347
1354
|
|
|
1348
|
-
##### `upgradeWorkflow`<sup>Optional</sup> <a name="upgradeWorkflow" id="@flocoder93/base-project.
|
|
1355
|
+
##### `upgradeWorkflow`<sup>Optional</sup> <a name="upgradeWorkflow" id="@flocoder93/base-project.MonorepoProject.property.upgradeWorkflow"></a>
|
|
1349
1356
|
|
|
1350
1357
|
```typescript
|
|
1351
1358
|
public readonly upgradeWorkflow: UpgradeDependencies;
|
|
@@ -1361,11 +1368,11 @@ The upgrade workflow.
|
|
|
1361
1368
|
|
|
1362
1369
|
| **Name** | **Type** | **Description** |
|
|
1363
1370
|
| --- | --- | --- |
|
|
1364
|
-
| <code><a href="#@flocoder93/base-project.
|
|
1371
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProject.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). |
|
|
1365
1372
|
|
|
1366
1373
|
---
|
|
1367
1374
|
|
|
1368
|
-
##### `DEFAULT_TASK`<sup>Required</sup> <a name="DEFAULT_TASK" id="@flocoder93/base-project.
|
|
1375
|
+
##### `DEFAULT_TASK`<sup>Required</sup> <a name="DEFAULT_TASK" id="@flocoder93/base-project.MonorepoProject.property.DEFAULT_TASK"></a>
|
|
1369
1376
|
|
|
1370
1377
|
```typescript
|
|
1371
1378
|
public readonly DEFAULT_TASK: string;
|
|
@@ -1380,6 +1387,68 @@ this task should synthesize the project files.
|
|
|
1380
1387
|
|
|
1381
1388
|
---
|
|
1382
1389
|
|
|
1390
|
+
## Structs <a name="Structs" id="Structs"></a>
|
|
1391
|
+
|
|
1392
|
+
### MonorepoProjectOptions <a name="MonorepoProjectOptions" id="@flocoder93/base-project.MonorepoProjectOptions"></a>
|
|
1393
|
+
|
|
1394
|
+
#### Initializer <a name="Initializer" id="@flocoder93/base-project.MonorepoProjectOptions.Initializer"></a>
|
|
1395
|
+
|
|
1396
|
+
```typescript
|
|
1397
|
+
import { MonorepoProjectOptions } from '@flocoder93/base-project'
|
|
1398
|
+
|
|
1399
|
+
const monorepoProjectOptions: MonorepoProjectOptions = { ... }
|
|
1400
|
+
```
|
|
1401
|
+
|
|
1402
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1403
|
+
|
|
1404
|
+
| **Name** | **Type** | **Description** |
|
|
1405
|
+
| --- | --- | --- |
|
|
1406
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProjectOptions.property.name">name</a></code> | <code>string</code> | *No description.* |
|
|
1407
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProjectOptions.property.repository">repository</a></code> | <code>string</code> | *No description.* |
|
|
1408
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | *No description.* |
|
|
1409
|
+
| <code><a href="#@flocoder93/base-project.MonorepoProjectOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | *No description.* |
|
|
1410
|
+
|
|
1411
|
+
---
|
|
1412
|
+
|
|
1413
|
+
##### `name`<sup>Required</sup> <a name="name" id="@flocoder93/base-project.MonorepoProjectOptions.property.name"></a>
|
|
1414
|
+
|
|
1415
|
+
```typescript
|
|
1416
|
+
public readonly name: string;
|
|
1417
|
+
```
|
|
1418
|
+
|
|
1419
|
+
- *Type:* string
|
|
1420
|
+
|
|
1421
|
+
---
|
|
1422
|
+
|
|
1423
|
+
##### `repository`<sup>Required</sup> <a name="repository" id="@flocoder93/base-project.MonorepoProjectOptions.property.repository"></a>
|
|
1424
|
+
|
|
1425
|
+
```typescript
|
|
1426
|
+
public readonly repository: string;
|
|
1427
|
+
```
|
|
1428
|
+
|
|
1429
|
+
- *Type:* string
|
|
1430
|
+
|
|
1431
|
+
---
|
|
1432
|
+
|
|
1433
|
+
##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="@flocoder93/base-project.MonorepoProjectOptions.property.defaultReleaseBranch"></a>
|
|
1434
|
+
|
|
1435
|
+
```typescript
|
|
1436
|
+
public readonly defaultReleaseBranch: string;
|
|
1437
|
+
```
|
|
1438
|
+
|
|
1439
|
+
- *Type:* string
|
|
1440
|
+
|
|
1441
|
+
---
|
|
1442
|
+
|
|
1443
|
+
##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@flocoder93/base-project.MonorepoProjectOptions.property.packageManager"></a>
|
|
1444
|
+
|
|
1445
|
+
```typescript
|
|
1446
|
+
public readonly packageManager: NodePackageManager;
|
|
1447
|
+
```
|
|
1448
|
+
|
|
1449
|
+
- *Type:* projen.javascript.NodePackageManager
|
|
1450
|
+
|
|
1451
|
+
---
|
|
1383
1452
|
|
|
1384
1453
|
|
|
1385
1454
|
|