projen-modules 0.2.49 → 0.2.51
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 +3341 -3
- package/API.md +5179 -940
- package/README.md +6 -5
- package/lib/components/readme/elements/section.js +1 -1
- package/lib/components/readme/index.js +1 -1
- package/lib/projects/cdk-ts/cdk-typescript-app-options.d.ts +1200 -0
- package/lib/projects/cdk-ts/cdk-typescript-app-options.js +3 -0
- package/lib/projects/cdk-ts/index.d.ts +14 -0
- package/lib/projects/cdk-ts/index.js +86 -0
- package/lib/projects/index.d.ts +1 -0
- package/lib/projects/index.js +2 -1
- package/lib/projects/jsii/index.js +11 -2
- package/lib/projects/npm/index.js +11 -2
- package/lib/projects/python/index.js +1 -1
- package/package.json +1 -1
package/.jsii
CHANGED
|
@@ -93,7 +93,7 @@
|
|
|
93
93
|
},
|
|
94
94
|
"name": "projen-modules",
|
|
95
95
|
"readme": {
|
|
96
|
-
"markdown": "# projen-modules\n\nA collection of custom projen modules, that can be used to bootstrap and maintain consistent project configuration, tooling, dependencies, and builds.\n\n## Getting Started\n\n```sh\nyarn install\nnpx projen build\n```\n\nThis will:\n* Install the dependencies\n* Apply any projen changes\n* Run tests\n* Package project locally\n\nAny files changed by projen should be committed to git.\n\nRunning the tests like this will update any snapshot files, this should be reviewed and committed to git.\n\n## Testing\n\nTypes of testing:\n* Snapshot - projen project outputs are stored as a snapshot in the corresponding `__snapshots__` directory. When the project changes then it is expected that these snapshots change too and should be reviewed committed alongside the project.\n* Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.\n\n\n## Creating a New Project\n\n\n```\nnpx projen new {project} --from projen-modules\n```\n\nSome projects may have required fields that need to be specified as part of this command, review any errors for details what needs to be specified.\n\n### Project Types\n\n| Project type
|
|
96
|
+
"markdown": "# projen-modules\n\nA collection of custom projen modules, that can be used to bootstrap and maintain consistent project configuration, tooling, dependencies, and builds.\n\n## Getting Started\n\n```sh\nyarn install\nnpx projen build\n```\n\nThis will:\n* Install the dependencies\n* Apply any projen changes\n* Run tests\n* Package project locally\n\nAny files changed by projen should be committed to git.\n\nRunning the tests like this will update any snapshot files, this should be reviewed and committed to git.\n\n## Testing\n\nTypes of testing:\n* Snapshot - projen project outputs are stored as a snapshot in the corresponding `__snapshots__` directory. When the project changes then it is expected that these snapshots change too and should be reviewed committed alongside the project.\n* Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.\n\n\n## Creating a New Project\n\n\n```\nnpx projen new {project} --from projen-modules\n```\n\nSome projects may have required fields that need to be specified as part of this command, review any errors for details what needs to be specified.\n\n### Project Types\n\n| Project type | Description |\n| ---------------------------------------------- | -------------------------- |\n| [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |\n| [npm-package](API.md#npmpackage-) | A typescript npm package |\n| [python-package](API.md#pythonpackage-) | A python package |\n| [jsii-package](API.md#jsiiproject-) | A typescript JSII package |\n\n## Project Structure\n\nAll source is located in `src` and is grouped by:\n* `components` - these are common building blocks that can be used by projects to implement specific project functionality.\n* `projects` - these are projects that can be built from this project (see #something)\n* `utils` - these are helper functions that are often reused\n\n`test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section)."
|
|
97
97
|
},
|
|
98
98
|
"repository": {
|
|
99
99
|
"type": "git",
|
|
@@ -110,6 +110,3344 @@
|
|
|
110
110
|
}
|
|
111
111
|
},
|
|
112
112
|
"types": {
|
|
113
|
+
"projen-modules.CdkTypeScriptApp": {
|
|
114
|
+
"assembly": "projen-modules",
|
|
115
|
+
"base": "projen.awscdk.AwsCdkTypeScriptApp",
|
|
116
|
+
"docs": {
|
|
117
|
+
"custom": {
|
|
118
|
+
"pjid": "cdk-typescript-app"
|
|
119
|
+
},
|
|
120
|
+
"stability": "stable",
|
|
121
|
+
"summary": "A CDK application in TypeScript."
|
|
122
|
+
},
|
|
123
|
+
"fqn": "projen-modules.CdkTypeScriptApp",
|
|
124
|
+
"initializer": {
|
|
125
|
+
"docs": {
|
|
126
|
+
"stability": "stable"
|
|
127
|
+
},
|
|
128
|
+
"locationInModule": {
|
|
129
|
+
"filename": "src/projects/cdk-ts/index.ts",
|
|
130
|
+
"line": 37
|
|
131
|
+
},
|
|
132
|
+
"parameters": [
|
|
133
|
+
{
|
|
134
|
+
"name": "options",
|
|
135
|
+
"type": {
|
|
136
|
+
"fqn": "projen-modules.CdkTypeScriptAppOptions"
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
]
|
|
140
|
+
},
|
|
141
|
+
"kind": "class",
|
|
142
|
+
"locationInModule": {
|
|
143
|
+
"filename": "src/projects/cdk-ts/index.ts",
|
|
144
|
+
"line": 34
|
|
145
|
+
},
|
|
146
|
+
"name": "CdkTypeScriptApp",
|
|
147
|
+
"properties": [
|
|
148
|
+
{
|
|
149
|
+
"docs": {
|
|
150
|
+
"stability": "stable"
|
|
151
|
+
},
|
|
152
|
+
"locationInModule": {
|
|
153
|
+
"filename": "src/projects/cdk-ts/index.ts",
|
|
154
|
+
"line": 35
|
|
155
|
+
},
|
|
156
|
+
"name": "readme",
|
|
157
|
+
"type": {
|
|
158
|
+
"fqn": "projen-modules.Readme"
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
],
|
|
162
|
+
"symbolId": "src/projects/cdk-ts/index:CdkTypeScriptApp"
|
|
163
|
+
},
|
|
164
|
+
"projen-modules.CdkTypeScriptAppOptions": {
|
|
165
|
+
"assembly": "projen-modules",
|
|
166
|
+
"datatype": true,
|
|
167
|
+
"docs": {
|
|
168
|
+
"stability": "stable",
|
|
169
|
+
"summary": "CdkTypeScriptAppOptions."
|
|
170
|
+
},
|
|
171
|
+
"fqn": "projen-modules.CdkTypeScriptAppOptions",
|
|
172
|
+
"kind": "interface",
|
|
173
|
+
"locationInModule": {
|
|
174
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
175
|
+
"line": 8
|
|
176
|
+
},
|
|
177
|
+
"name": "CdkTypeScriptAppOptions",
|
|
178
|
+
"properties": [
|
|
179
|
+
{
|
|
180
|
+
"abstract": true,
|
|
181
|
+
"docs": {
|
|
182
|
+
"default": "\"2.1.0\"",
|
|
183
|
+
"stability": "experimental",
|
|
184
|
+
"summary": "Minimum version of the AWS CDK to depend on."
|
|
185
|
+
},
|
|
186
|
+
"immutable": true,
|
|
187
|
+
"locationInModule": {
|
|
188
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
189
|
+
"line": 122
|
|
190
|
+
},
|
|
191
|
+
"name": "cdkVersion",
|
|
192
|
+
"type": {
|
|
193
|
+
"primitive": "string"
|
|
194
|
+
}
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"abstract": true,
|
|
198
|
+
"docs": {
|
|
199
|
+
"stability": "stable",
|
|
200
|
+
"summary": "List of teams used to generate the CODEOWNERS file."
|
|
201
|
+
},
|
|
202
|
+
"immutable": true,
|
|
203
|
+
"locationInModule": {
|
|
204
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
205
|
+
"line": 1201
|
|
206
|
+
},
|
|
207
|
+
"name": "codeOwners",
|
|
208
|
+
"type": {
|
|
209
|
+
"collection": {
|
|
210
|
+
"elementtype": {
|
|
211
|
+
"primitive": "string"
|
|
212
|
+
},
|
|
213
|
+
"kind": "array"
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
},
|
|
217
|
+
{
|
|
218
|
+
"abstract": true,
|
|
219
|
+
"docs": {
|
|
220
|
+
"custom": {
|
|
221
|
+
"featured": "true"
|
|
222
|
+
},
|
|
223
|
+
"default": "$BASEDIR",
|
|
224
|
+
"stability": "experimental",
|
|
225
|
+
"summary": "This is the name of your project."
|
|
226
|
+
},
|
|
227
|
+
"immutable": true,
|
|
228
|
+
"locationInModule": {
|
|
229
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
230
|
+
"line": 1197
|
|
231
|
+
},
|
|
232
|
+
"name": "name",
|
|
233
|
+
"type": {
|
|
234
|
+
"primitive": "string"
|
|
235
|
+
}
|
|
236
|
+
},
|
|
237
|
+
{
|
|
238
|
+
"abstract": true,
|
|
239
|
+
"docs": {
|
|
240
|
+
"default": "true",
|
|
241
|
+
"remarks": "This is normally only allowed for libraries. For apps, there's no meaning\nfor specifying these.",
|
|
242
|
+
"stability": "experimental",
|
|
243
|
+
"summary": "Allow the project to include `peerDependencies` and `bundledDependencies`."
|
|
244
|
+
},
|
|
245
|
+
"immutable": true,
|
|
246
|
+
"locationInModule": {
|
|
247
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
248
|
+
"line": 1007
|
|
249
|
+
},
|
|
250
|
+
"name": "allowLibraryDependencies",
|
|
251
|
+
"optional": true,
|
|
252
|
+
"type": {
|
|
253
|
+
"primitive": "boolean"
|
|
254
|
+
}
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
"abstract": true,
|
|
258
|
+
"docs": {
|
|
259
|
+
"default": "\"main.ts\"",
|
|
260
|
+
"stability": "experimental",
|
|
261
|
+
"summary": "The CDK app's entrypoint (relative to the source directory, which is \"src\" by default)."
|
|
262
|
+
},
|
|
263
|
+
"immutable": true,
|
|
264
|
+
"locationInModule": {
|
|
265
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
266
|
+
"line": 50
|
|
267
|
+
},
|
|
268
|
+
"name": "appEntrypoint",
|
|
269
|
+
"optional": true,
|
|
270
|
+
"type": {
|
|
271
|
+
"primitive": "string"
|
|
272
|
+
}
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
"abstract": true,
|
|
276
|
+
"docs": {
|
|
277
|
+
"default": "\"dist\"",
|
|
278
|
+
"stability": "experimental",
|
|
279
|
+
"summary": "A directory which will contain build artifacts."
|
|
280
|
+
},
|
|
281
|
+
"immutable": true,
|
|
282
|
+
"locationInModule": {
|
|
283
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
284
|
+
"line": 517
|
|
285
|
+
},
|
|
286
|
+
"name": "artifactsDirectory",
|
|
287
|
+
"optional": true,
|
|
288
|
+
"type": {
|
|
289
|
+
"primitive": "string"
|
|
290
|
+
}
|
|
291
|
+
},
|
|
292
|
+
{
|
|
293
|
+
"abstract": true,
|
|
294
|
+
"docs": {
|
|
295
|
+
"stability": "experimental",
|
|
296
|
+
"summary": "Author's e-mail."
|
|
297
|
+
},
|
|
298
|
+
"immutable": true,
|
|
299
|
+
"locationInModule": {
|
|
300
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
301
|
+
"line": 999
|
|
302
|
+
},
|
|
303
|
+
"name": "authorEmail",
|
|
304
|
+
"optional": true,
|
|
305
|
+
"type": {
|
|
306
|
+
"primitive": "string"
|
|
307
|
+
}
|
|
308
|
+
},
|
|
309
|
+
{
|
|
310
|
+
"abstract": true,
|
|
311
|
+
"docs": {
|
|
312
|
+
"stability": "experimental",
|
|
313
|
+
"summary": "Author's name."
|
|
314
|
+
},
|
|
315
|
+
"immutable": true,
|
|
316
|
+
"locationInModule": {
|
|
317
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
318
|
+
"line": 994
|
|
319
|
+
},
|
|
320
|
+
"name": "authorName",
|
|
321
|
+
"optional": true,
|
|
322
|
+
"type": {
|
|
323
|
+
"primitive": "string"
|
|
324
|
+
}
|
|
325
|
+
},
|
|
326
|
+
{
|
|
327
|
+
"abstract": true,
|
|
328
|
+
"docs": {
|
|
329
|
+
"stability": "experimental",
|
|
330
|
+
"summary": "Is the author an organization."
|
|
331
|
+
},
|
|
332
|
+
"immutable": true,
|
|
333
|
+
"locationInModule": {
|
|
334
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
335
|
+
"line": 989
|
|
336
|
+
},
|
|
337
|
+
"name": "authorOrganization",
|
|
338
|
+
"optional": true,
|
|
339
|
+
"type": {
|
|
340
|
+
"primitive": "boolean"
|
|
341
|
+
}
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
"abstract": true,
|
|
345
|
+
"docs": {
|
|
346
|
+
"stability": "experimental",
|
|
347
|
+
"summary": "Author's URL / Website."
|
|
348
|
+
},
|
|
349
|
+
"immutable": true,
|
|
350
|
+
"locationInModule": {
|
|
351
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
352
|
+
"line": 984
|
|
353
|
+
},
|
|
354
|
+
"name": "authorUrl",
|
|
355
|
+
"optional": true,
|
|
356
|
+
"type": {
|
|
357
|
+
"primitive": "string"
|
|
358
|
+
}
|
|
359
|
+
},
|
|
360
|
+
{
|
|
361
|
+
"abstract": true,
|
|
362
|
+
"docs": {
|
|
363
|
+
"default": "- auto approve is disabled",
|
|
364
|
+
"stability": "experimental",
|
|
365
|
+
"summary": "Enable and configure the 'auto approve' workflow."
|
|
366
|
+
},
|
|
367
|
+
"immutable": true,
|
|
368
|
+
"locationInModule": {
|
|
369
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
370
|
+
"line": 1121
|
|
371
|
+
},
|
|
372
|
+
"name": "autoApproveOptions",
|
|
373
|
+
"optional": true,
|
|
374
|
+
"type": {
|
|
375
|
+
"fqn": "projen.github.AutoApproveOptions"
|
|
376
|
+
}
|
|
377
|
+
},
|
|
378
|
+
{
|
|
379
|
+
"abstract": true,
|
|
380
|
+
"docs": {
|
|
381
|
+
"default": "- true",
|
|
382
|
+
"remarks": "Throw if set to true but `autoApproveOptions` are not defined.",
|
|
383
|
+
"stability": "experimental",
|
|
384
|
+
"summary": "Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued)."
|
|
385
|
+
},
|
|
386
|
+
"immutable": true,
|
|
387
|
+
"locationInModule": {
|
|
388
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
389
|
+
"line": 511
|
|
390
|
+
},
|
|
391
|
+
"name": "autoApproveUpgrades",
|
|
392
|
+
"optional": true,
|
|
393
|
+
"type": {
|
|
394
|
+
"primitive": "boolean"
|
|
395
|
+
}
|
|
396
|
+
},
|
|
397
|
+
{
|
|
398
|
+
"abstract": true,
|
|
399
|
+
"docs": {
|
|
400
|
+
"default": "true",
|
|
401
|
+
"stability": "experimental",
|
|
402
|
+
"summary": "Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section."
|
|
403
|
+
},
|
|
404
|
+
"immutable": true,
|
|
405
|
+
"locationInModule": {
|
|
406
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
407
|
+
"line": 979
|
|
408
|
+
},
|
|
409
|
+
"name": "autoDetectBin",
|
|
410
|
+
"optional": true,
|
|
411
|
+
"type": {
|
|
412
|
+
"primitive": "boolean"
|
|
413
|
+
}
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
"abstract": true,
|
|
417
|
+
"docs": {
|
|
418
|
+
"default": "true",
|
|
419
|
+
"remarks": "Has no effect if `github.mergify`\nis set to false.",
|
|
420
|
+
"stability": "experimental",
|
|
421
|
+
"summary": "Enable automatic merging on GitHub."
|
|
422
|
+
},
|
|
423
|
+
"immutable": true,
|
|
424
|
+
"locationInModule": {
|
|
425
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
426
|
+
"line": 1115
|
|
427
|
+
},
|
|
428
|
+
"name": "autoMerge",
|
|
429
|
+
"optional": true,
|
|
430
|
+
"type": {
|
|
431
|
+
"primitive": "boolean"
|
|
432
|
+
}
|
|
433
|
+
},
|
|
434
|
+
{
|
|
435
|
+
"abstract": true,
|
|
436
|
+
"docs": {
|
|
437
|
+
"default": "- see defaults in `AutoMergeOptions`",
|
|
438
|
+
"remarks": "Has no effect if\n`github.mergify` or `autoMerge` is set to false.",
|
|
439
|
+
"stability": "experimental",
|
|
440
|
+
"summary": "Configure options for automatic merging on GitHub."
|
|
441
|
+
},
|
|
442
|
+
"immutable": true,
|
|
443
|
+
"locationInModule": {
|
|
444
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
445
|
+
"line": 1107
|
|
446
|
+
},
|
|
447
|
+
"name": "autoMergeOptions",
|
|
448
|
+
"optional": true,
|
|
449
|
+
"type": {
|
|
450
|
+
"fqn": "projen.github.AutoMergeOptions"
|
|
451
|
+
}
|
|
452
|
+
},
|
|
453
|
+
{
|
|
454
|
+
"abstract": true,
|
|
455
|
+
"docs": {
|
|
456
|
+
"remarks": "You can use this option to add/customize how binaries are represented in\nyour `package.json`, but unless `autoDetectBin` is `false`, every\nexecutable file under `bin` will automatically be added to this section.",
|
|
457
|
+
"stability": "experimental",
|
|
458
|
+
"summary": "Binary programs vended with your module."
|
|
459
|
+
},
|
|
460
|
+
"immutable": true,
|
|
461
|
+
"locationInModule": {
|
|
462
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
463
|
+
"line": 973
|
|
464
|
+
},
|
|
465
|
+
"name": "bin",
|
|
466
|
+
"optional": true,
|
|
467
|
+
"type": {
|
|
468
|
+
"collection": {
|
|
469
|
+
"elementtype": {
|
|
470
|
+
"primitive": "string"
|
|
471
|
+
},
|
|
472
|
+
"kind": "map"
|
|
473
|
+
}
|
|
474
|
+
}
|
|
475
|
+
},
|
|
476
|
+
{
|
|
477
|
+
"abstract": true,
|
|
478
|
+
"docs": {
|
|
479
|
+
"stability": "experimental",
|
|
480
|
+
"summary": "The email address to which issues should be reported."
|
|
481
|
+
},
|
|
482
|
+
"immutable": true,
|
|
483
|
+
"locationInModule": {
|
|
484
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
485
|
+
"line": 965
|
|
486
|
+
},
|
|
487
|
+
"name": "bugsEmail",
|
|
488
|
+
"optional": true,
|
|
489
|
+
"type": {
|
|
490
|
+
"primitive": "string"
|
|
491
|
+
}
|
|
492
|
+
},
|
|
493
|
+
{
|
|
494
|
+
"abstract": true,
|
|
495
|
+
"docs": {
|
|
496
|
+
"stability": "experimental",
|
|
497
|
+
"summary": "The url to your project's issue tracker."
|
|
498
|
+
},
|
|
499
|
+
"immutable": true,
|
|
500
|
+
"locationInModule": {
|
|
501
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
502
|
+
"line": 960
|
|
503
|
+
},
|
|
504
|
+
"name": "bugsUrl",
|
|
505
|
+
"optional": true,
|
|
506
|
+
"type": {
|
|
507
|
+
"primitive": "string"
|
|
508
|
+
}
|
|
509
|
+
},
|
|
510
|
+
{
|
|
511
|
+
"abstract": true,
|
|
512
|
+
"docs": {
|
|
513
|
+
"default": "- no build command",
|
|
514
|
+
"remarks": "This command will be called when\nrunning `cdk synth` or when `cdk watch` identifies a change in your source\ncode before redeployment.",
|
|
515
|
+
"stability": "experimental",
|
|
516
|
+
"summary": "A command to execute before synthesis."
|
|
517
|
+
},
|
|
518
|
+
"immutable": true,
|
|
519
|
+
"locationInModule": {
|
|
520
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
521
|
+
"line": 167
|
|
522
|
+
},
|
|
523
|
+
"name": "buildCommand",
|
|
524
|
+
"optional": true,
|
|
525
|
+
"type": {
|
|
526
|
+
"primitive": "string"
|
|
527
|
+
}
|
|
528
|
+
},
|
|
529
|
+
{
|
|
530
|
+
"abstract": true,
|
|
531
|
+
"docs": {
|
|
532
|
+
"default": "- true if not a subproject",
|
|
533
|
+
"stability": "experimental",
|
|
534
|
+
"summary": "Define a GitHub workflow for building PRs."
|
|
535
|
+
},
|
|
536
|
+
"immutable": true,
|
|
537
|
+
"locationInModule": {
|
|
538
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
539
|
+
"line": 504
|
|
540
|
+
},
|
|
541
|
+
"name": "buildWorkflow",
|
|
542
|
+
"optional": true,
|
|
543
|
+
"type": {
|
|
544
|
+
"primitive": "boolean"
|
|
545
|
+
}
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
"abstract": true,
|
|
549
|
+
"docs": {
|
|
550
|
+
"stability": "experimental",
|
|
551
|
+
"summary": "Options for PR build workflow."
|
|
552
|
+
},
|
|
553
|
+
"immutable": true,
|
|
554
|
+
"locationInModule": {
|
|
555
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
556
|
+
"line": 498
|
|
557
|
+
},
|
|
558
|
+
"name": "buildWorkflowOptions",
|
|
559
|
+
"optional": true,
|
|
560
|
+
"type": {
|
|
561
|
+
"fqn": "projen.javascript.BuildWorkflowOptions"
|
|
562
|
+
}
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"abstract": true,
|
|
566
|
+
"docs": {
|
|
567
|
+
"default": "\"{ pullRequest: {}, workflowDispatch: {} }\"",
|
|
568
|
+
"deprecated": "- Use `buildWorkflowOptions.workflowTriggers`",
|
|
569
|
+
"stability": "deprecated",
|
|
570
|
+
"summary": "Build workflow triggers."
|
|
571
|
+
},
|
|
572
|
+
"immutable": true,
|
|
573
|
+
"locationInModule": {
|
|
574
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
575
|
+
"line": 493
|
|
576
|
+
},
|
|
577
|
+
"name": "buildWorkflowTriggers",
|
|
578
|
+
"optional": true,
|
|
579
|
+
"type": {
|
|
580
|
+
"fqn": "projen.github.workflows.Triggers"
|
|
581
|
+
}
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
"abstract": true,
|
|
585
|
+
"docs": {
|
|
586
|
+
"default": "- A recent version of \"commit-and-tag-version\"",
|
|
587
|
+
"remarks": "This can be any compatible package version, including the deprecated `standard-version@9`.",
|
|
588
|
+
"stability": "experimental",
|
|
589
|
+
"summary": "The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string."
|
|
590
|
+
},
|
|
591
|
+
"immutable": true,
|
|
592
|
+
"locationInModule": {
|
|
593
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
594
|
+
"line": 712
|
|
595
|
+
},
|
|
596
|
+
"name": "bumpPackage",
|
|
597
|
+
"optional": true,
|
|
598
|
+
"type": {
|
|
599
|
+
"primitive": "string"
|
|
600
|
+
}
|
|
601
|
+
},
|
|
602
|
+
{
|
|
603
|
+
"abstract": true,
|
|
604
|
+
"docs": {
|
|
605
|
+
"remarks": "These modules will be\nadded both to the `dependencies` section and `bundledDependencies` section of\nyour `package.json`.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `yarn add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and\nthis will be what you `package.json` will eventually include.",
|
|
606
|
+
"stability": "experimental",
|
|
607
|
+
"summary": "List of dependencies to bundle into this module."
|
|
608
|
+
},
|
|
609
|
+
"immutable": true,
|
|
610
|
+
"locationInModule": {
|
|
611
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
612
|
+
"line": 955
|
|
613
|
+
},
|
|
614
|
+
"name": "bundledDeps",
|
|
615
|
+
"optional": true,
|
|
616
|
+
"type": {
|
|
617
|
+
"collection": {
|
|
618
|
+
"elementtype": {
|
|
619
|
+
"primitive": "string"
|
|
620
|
+
},
|
|
621
|
+
"kind": "array"
|
|
622
|
+
}
|
|
623
|
+
}
|
|
624
|
+
},
|
|
625
|
+
{
|
|
626
|
+
"abstract": true,
|
|
627
|
+
"docs": {
|
|
628
|
+
"stability": "experimental",
|
|
629
|
+
"summary": "Options for `Bundler`."
|
|
630
|
+
},
|
|
631
|
+
"immutable": true,
|
|
632
|
+
"locationInModule": {
|
|
633
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
634
|
+
"line": 486
|
|
635
|
+
},
|
|
636
|
+
"name": "bundlerOptions",
|
|
637
|
+
"optional": true,
|
|
638
|
+
"type": {
|
|
639
|
+
"fqn": "projen.javascript.BundlerOptions"
|
|
640
|
+
}
|
|
641
|
+
},
|
|
642
|
+
{
|
|
643
|
+
"abstract": true,
|
|
644
|
+
"docs": {
|
|
645
|
+
"default": "\"latest\"",
|
|
646
|
+
"stability": "experimental",
|
|
647
|
+
"summary": "The version of Bun to use if using Bun as a package manager."
|
|
648
|
+
},
|
|
649
|
+
"immutable": true,
|
|
650
|
+
"locationInModule": {
|
|
651
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
652
|
+
"line": 940
|
|
653
|
+
},
|
|
654
|
+
"name": "bunVersion",
|
|
655
|
+
"optional": true,
|
|
656
|
+
"type": {
|
|
657
|
+
"primitive": "string"
|
|
658
|
+
}
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
"abstract": true,
|
|
662
|
+
"docs": {
|
|
663
|
+
"custom": {
|
|
664
|
+
"aws-cdk": "/assertions (in V1) and included in `aws-cdk-lib` for V2."
|
|
665
|
+
},
|
|
666
|
+
"default": "- will be included by default for AWS CDK >= 1.0.0 < 2.0.0",
|
|
667
|
+
"deprecated": "The",
|
|
668
|
+
"remarks": "Install the",
|
|
669
|
+
"stability": "deprecated",
|
|
670
|
+
"summary": "Warning: NodeJS only."
|
|
671
|
+
},
|
|
672
|
+
"immutable": true,
|
|
673
|
+
"locationInModule": {
|
|
674
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
675
|
+
"line": 116
|
|
676
|
+
},
|
|
677
|
+
"name": "cdkAssert",
|
|
678
|
+
"optional": true,
|
|
679
|
+
"type": {
|
|
680
|
+
"primitive": "boolean"
|
|
681
|
+
}
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
"abstract": true,
|
|
685
|
+
"docs": {
|
|
686
|
+
"default": "- will be included by default for AWS CDK >= 1.111.0 < 2.0.0",
|
|
687
|
+
"remarks": "Only needed for CDK 1.x. If using CDK 2.x then\nassertions is already included in 'aws-cdk-lib'",
|
|
688
|
+
"stability": "experimental",
|
|
689
|
+
"summary": "Install the assertions library?"
|
|
690
|
+
},
|
|
691
|
+
"immutable": true,
|
|
692
|
+
"locationInModule": {
|
|
693
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
694
|
+
"line": 107
|
|
695
|
+
},
|
|
696
|
+
"name": "cdkAssertions",
|
|
697
|
+
"optional": true,
|
|
698
|
+
"type": {
|
|
699
|
+
"primitive": "boolean"
|
|
700
|
+
}
|
|
701
|
+
},
|
|
702
|
+
{
|
|
703
|
+
"abstract": true,
|
|
704
|
+
"docs": {
|
|
705
|
+
"default": "\"^2\"",
|
|
706
|
+
"remarks": "Can be either a specific version, or an NPM version range.\n\nBy default, the latest 2.x version will be installed; you can use this\noption to restrict it to a specific version or version range.",
|
|
707
|
+
"stability": "experimental",
|
|
708
|
+
"summary": "Version range of the AWS CDK CLI to depend on."
|
|
709
|
+
},
|
|
710
|
+
"immutable": true,
|
|
711
|
+
"locationInModule": {
|
|
712
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
713
|
+
"line": 99
|
|
714
|
+
},
|
|
715
|
+
"name": "cdkCliVersion",
|
|
716
|
+
"optional": true,
|
|
717
|
+
"type": {
|
|
718
|
+
"primitive": "string"
|
|
719
|
+
}
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
"abstract": true,
|
|
723
|
+
"docs": {
|
|
724
|
+
"deprecated": "For CDK 2.x use \"deps\" instead. (or \"peerDeps\" if you're building a library)",
|
|
725
|
+
"stability": "deprecated",
|
|
726
|
+
"summary": "Which AWS CDKv1 modules this project requires."
|
|
727
|
+
},
|
|
728
|
+
"immutable": true,
|
|
729
|
+
"locationInModule": {
|
|
730
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
731
|
+
"line": 89
|
|
732
|
+
},
|
|
733
|
+
"name": "cdkDependencies",
|
|
734
|
+
"optional": true,
|
|
735
|
+
"type": {
|
|
736
|
+
"collection": {
|
|
737
|
+
"elementtype": {
|
|
738
|
+
"primitive": "string"
|
|
739
|
+
},
|
|
740
|
+
"kind": "array"
|
|
741
|
+
}
|
|
742
|
+
}
|
|
743
|
+
},
|
|
744
|
+
{
|
|
745
|
+
"abstract": true,
|
|
746
|
+
"docs": {
|
|
747
|
+
"default": "true",
|
|
748
|
+
"deprecated": "Not supported in CDK v2.",
|
|
749
|
+
"remarks": "This is to ensure that downstream consumers actually have your CDK dependencies installed\nwhen using npm < 7 or yarn, where peer dependencies are not automatically installed.\nIf this is disabled, `cdkDependencies` will be added to `devDependencies` to ensure\nthey are present during development.\n\nNote: this setting only applies to construct library projects",
|
|
750
|
+
"stability": "deprecated",
|
|
751
|
+
"summary": "If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`)."
|
|
752
|
+
},
|
|
753
|
+
"immutable": true,
|
|
754
|
+
"locationInModule": {
|
|
755
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
756
|
+
"line": 83
|
|
757
|
+
},
|
|
758
|
+
"name": "cdkDependenciesAsDeps",
|
|
759
|
+
"optional": true,
|
|
760
|
+
"type": {
|
|
761
|
+
"primitive": "boolean"
|
|
762
|
+
}
|
|
763
|
+
},
|
|
764
|
+
{
|
|
765
|
+
"abstract": true,
|
|
766
|
+
"docs": {
|
|
767
|
+
"default": "\"cdk.out\"",
|
|
768
|
+
"stability": "experimental",
|
|
769
|
+
"summary": "cdk.out directory."
|
|
770
|
+
},
|
|
771
|
+
"immutable": true,
|
|
772
|
+
"locationInModule": {
|
|
773
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
774
|
+
"line": 158
|
|
775
|
+
},
|
|
776
|
+
"name": "cdkout",
|
|
777
|
+
"optional": true,
|
|
778
|
+
"type": {
|
|
779
|
+
"primitive": "string"
|
|
780
|
+
}
|
|
781
|
+
},
|
|
782
|
+
{
|
|
783
|
+
"abstract": true,
|
|
784
|
+
"docs": {
|
|
785
|
+
"deprecated": "For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead",
|
|
786
|
+
"stability": "deprecated",
|
|
787
|
+
"summary": "AWS CDK modules required for testing."
|
|
788
|
+
},
|
|
789
|
+
"immutable": true,
|
|
790
|
+
"locationInModule": {
|
|
791
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
792
|
+
"line": 70
|
|
793
|
+
},
|
|
794
|
+
"name": "cdkTestDependencies",
|
|
795
|
+
"optional": true,
|
|
796
|
+
"type": {
|
|
797
|
+
"collection": {
|
|
798
|
+
"elementtype": {
|
|
799
|
+
"primitive": "string"
|
|
800
|
+
},
|
|
801
|
+
"kind": "array"
|
|
802
|
+
}
|
|
803
|
+
}
|
|
804
|
+
},
|
|
805
|
+
{
|
|
806
|
+
"abstract": true,
|
|
807
|
+
"docs": {
|
|
808
|
+
"remarks": "You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates.\nIf you use experimental features this will let you define the moment you include breaking changes.",
|
|
809
|
+
"stability": "experimental",
|
|
810
|
+
"summary": "Use pinned version instead of caret version for CDK."
|
|
811
|
+
},
|
|
812
|
+
"immutable": true,
|
|
813
|
+
"locationInModule": {
|
|
814
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
815
|
+
"line": 64
|
|
816
|
+
},
|
|
817
|
+
"name": "cdkVersionPinning",
|
|
818
|
+
"optional": true,
|
|
819
|
+
"type": {
|
|
820
|
+
"primitive": "boolean"
|
|
821
|
+
}
|
|
822
|
+
},
|
|
823
|
+
{
|
|
824
|
+
"abstract": true,
|
|
825
|
+
"docs": {
|
|
826
|
+
"default": "- no license checks are run during the build and all licenses will be accepted",
|
|
827
|
+
"remarks": "This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.",
|
|
828
|
+
"stability": "experimental",
|
|
829
|
+
"summary": "Configure which licenses should be deemed acceptable for use by dependencies."
|
|
830
|
+
},
|
|
831
|
+
"immutable": true,
|
|
832
|
+
"locationInModule": {
|
|
833
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
834
|
+
"line": 481
|
|
835
|
+
},
|
|
836
|
+
"name": "checkLicenses",
|
|
837
|
+
"optional": true,
|
|
838
|
+
"type": {
|
|
839
|
+
"fqn": "projen.javascript.LicenseCheckerOptions"
|
|
840
|
+
}
|
|
841
|
+
},
|
|
842
|
+
{
|
|
843
|
+
"abstract": true,
|
|
844
|
+
"docs": {
|
|
845
|
+
"default": "- true, but false for subprojects",
|
|
846
|
+
"stability": "experimental",
|
|
847
|
+
"summary": "Add a `clobber` task which resets the repo to origin."
|
|
848
|
+
},
|
|
849
|
+
"immutable": true,
|
|
850
|
+
"locationInModule": {
|
|
851
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
852
|
+
"line": 1099
|
|
853
|
+
},
|
|
854
|
+
"name": "clobber",
|
|
855
|
+
"optional": true,
|
|
856
|
+
"type": {
|
|
857
|
+
"primitive": "boolean"
|
|
858
|
+
}
|
|
859
|
+
},
|
|
860
|
+
{
|
|
861
|
+
"abstract": true,
|
|
862
|
+
"docs": {
|
|
863
|
+
"default": "- undefined",
|
|
864
|
+
"remarks": "This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact",
|
|
865
|
+
"stability": "experimental",
|
|
866
|
+
"summary": "Options for npm packages using AWS CodeArtifact."
|
|
867
|
+
},
|
|
868
|
+
"immutable": true,
|
|
869
|
+
"locationInModule": {
|
|
870
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
871
|
+
"line": 934
|
|
872
|
+
},
|
|
873
|
+
"name": "codeArtifactOptions",
|
|
874
|
+
"optional": true,
|
|
875
|
+
"type": {
|
|
876
|
+
"fqn": "projen.javascript.CodeArtifactOptions"
|
|
877
|
+
}
|
|
878
|
+
},
|
|
879
|
+
{
|
|
880
|
+
"abstract": true,
|
|
881
|
+
"docs": {
|
|
882
|
+
"default": "false",
|
|
883
|
+
"stability": "experimental",
|
|
884
|
+
"summary": "Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`."
|
|
885
|
+
},
|
|
886
|
+
"immutable": true,
|
|
887
|
+
"locationInModule": {
|
|
888
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
889
|
+
"line": 474
|
|
890
|
+
},
|
|
891
|
+
"name": "codeCov",
|
|
892
|
+
"optional": true,
|
|
893
|
+
"type": {
|
|
894
|
+
"primitive": "boolean"
|
|
895
|
+
}
|
|
896
|
+
},
|
|
897
|
+
{
|
|
898
|
+
"abstract": true,
|
|
899
|
+
"docs": {
|
|
900
|
+
"default": "- if this option is not specified, only public repositories are supported",
|
|
901
|
+
"stability": "experimental",
|
|
902
|
+
"summary": "Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories."
|
|
903
|
+
},
|
|
904
|
+
"immutable": true,
|
|
905
|
+
"locationInModule": {
|
|
906
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
907
|
+
"line": 468
|
|
908
|
+
},
|
|
909
|
+
"name": "codeCovTokenSecret",
|
|
910
|
+
"optional": true,
|
|
911
|
+
"type": {
|
|
912
|
+
"primitive": "string"
|
|
913
|
+
}
|
|
914
|
+
},
|
|
915
|
+
{
|
|
916
|
+
"abstract": true,
|
|
917
|
+
"docs": {
|
|
918
|
+
"default": "true",
|
|
919
|
+
"stability": "experimental",
|
|
920
|
+
"summary": "Whether to commit the managed files by default."
|
|
921
|
+
},
|
|
922
|
+
"immutable": true,
|
|
923
|
+
"locationInModule": {
|
|
924
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
925
|
+
"line": 1190
|
|
926
|
+
},
|
|
927
|
+
"name": "commitGenerated",
|
|
928
|
+
"optional": true,
|
|
929
|
+
"type": {
|
|
930
|
+
"primitive": "boolean"
|
|
931
|
+
}
|
|
932
|
+
},
|
|
933
|
+
{
|
|
934
|
+
"abstract": true,
|
|
935
|
+
"docs": {
|
|
936
|
+
"default": "- for CDK 1.x the default is \"3.2.27\", for CDK 2.x the default is\n\"10.0.5\".",
|
|
937
|
+
"stability": "experimental",
|
|
938
|
+
"summary": "Minimum version of the `constructs` library to depend on."
|
|
939
|
+
},
|
|
940
|
+
"immutable": true,
|
|
941
|
+
"locationInModule": {
|
|
942
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
943
|
+
"line": 57
|
|
944
|
+
},
|
|
945
|
+
"name": "constructsVersion",
|
|
946
|
+
"optional": true,
|
|
947
|
+
"type": {
|
|
948
|
+
"primitive": "string"
|
|
949
|
+
}
|
|
950
|
+
},
|
|
951
|
+
{
|
|
952
|
+
"abstract": true,
|
|
953
|
+
"docs": {
|
|
954
|
+
"default": "- no additional context",
|
|
955
|
+
"stability": "experimental",
|
|
956
|
+
"summary": "Additional context to include in `cdk.json`."
|
|
957
|
+
},
|
|
958
|
+
"immutable": true,
|
|
959
|
+
"locationInModule": {
|
|
960
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
961
|
+
"line": 152
|
|
962
|
+
},
|
|
963
|
+
"name": "context",
|
|
964
|
+
"optional": true,
|
|
965
|
+
"type": {
|
|
966
|
+
"collection": {
|
|
967
|
+
"elementtype": {
|
|
968
|
+
"primitive": "any"
|
|
969
|
+
},
|
|
970
|
+
"kind": "map"
|
|
971
|
+
}
|
|
972
|
+
}
|
|
973
|
+
},
|
|
974
|
+
{
|
|
975
|
+
"abstract": true,
|
|
976
|
+
"docs": {
|
|
977
|
+
"default": "- defaults to the value of authorName or \"\" if `authorName` is undefined.",
|
|
978
|
+
"stability": "experimental",
|
|
979
|
+
"summary": "License copyright owner."
|
|
980
|
+
},
|
|
981
|
+
"immutable": true,
|
|
982
|
+
"locationInModule": {
|
|
983
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
984
|
+
"line": 462
|
|
985
|
+
},
|
|
986
|
+
"name": "copyrightOwner",
|
|
987
|
+
"optional": true,
|
|
988
|
+
"type": {
|
|
989
|
+
"primitive": "string"
|
|
990
|
+
}
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
"abstract": true,
|
|
994
|
+
"docs": {
|
|
995
|
+
"default": "- current year",
|
|
996
|
+
"stability": "experimental",
|
|
997
|
+
"summary": "The copyright years to put in the LICENSE file."
|
|
998
|
+
},
|
|
999
|
+
"immutable": true,
|
|
1000
|
+
"locationInModule": {
|
|
1001
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1002
|
+
"line": 456
|
|
1003
|
+
},
|
|
1004
|
+
"name": "copyrightPeriod",
|
|
1005
|
+
"optional": true,
|
|
1006
|
+
"type": {
|
|
1007
|
+
"primitive": "string"
|
|
1008
|
+
}
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
"abstract": true,
|
|
1012
|
+
"docs": {
|
|
1013
|
+
"default": "\"main\"",
|
|
1014
|
+
"stability": "experimental",
|
|
1015
|
+
"summary": "The name of the main release branch."
|
|
1016
|
+
},
|
|
1017
|
+
"immutable": true,
|
|
1018
|
+
"locationInModule": {
|
|
1019
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1020
|
+
"line": 523
|
|
1021
|
+
},
|
|
1022
|
+
"name": "defaultReleaseBranch",
|
|
1023
|
+
"optional": true,
|
|
1024
|
+
"type": {
|
|
1025
|
+
"primitive": "string"
|
|
1026
|
+
}
|
|
1027
|
+
},
|
|
1028
|
+
{
|
|
1029
|
+
"abstract": true,
|
|
1030
|
+
"docs": {
|
|
1031
|
+
"default": "false",
|
|
1032
|
+
"remarks": "Cannot be used in conjunction with `depsUpgrade`.",
|
|
1033
|
+
"stability": "experimental",
|
|
1034
|
+
"summary": "Use dependabot to handle dependency upgrades."
|
|
1035
|
+
},
|
|
1036
|
+
"immutable": true,
|
|
1037
|
+
"locationInModule": {
|
|
1038
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1039
|
+
"line": 450
|
|
1040
|
+
},
|
|
1041
|
+
"name": "dependabot",
|
|
1042
|
+
"optional": true,
|
|
1043
|
+
"type": {
|
|
1044
|
+
"primitive": "boolean"
|
|
1045
|
+
}
|
|
1046
|
+
},
|
|
1047
|
+
{
|
|
1048
|
+
"abstract": true,
|
|
1049
|
+
"docs": {
|
|
1050
|
+
"default": "- default options",
|
|
1051
|
+
"stability": "experimental",
|
|
1052
|
+
"summary": "Options for dependabot."
|
|
1053
|
+
},
|
|
1054
|
+
"immutable": true,
|
|
1055
|
+
"locationInModule": {
|
|
1056
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1057
|
+
"line": 443
|
|
1058
|
+
},
|
|
1059
|
+
"name": "dependabotOptions",
|
|
1060
|
+
"optional": true,
|
|
1061
|
+
"type": {
|
|
1062
|
+
"fqn": "projen.github.DependabotOptions"
|
|
1063
|
+
}
|
|
1064
|
+
},
|
|
1065
|
+
{
|
|
1066
|
+
"abstract": true,
|
|
1067
|
+
"docs": {
|
|
1068
|
+
"custom": {
|
|
1069
|
+
"featured": "true"
|
|
1070
|
+
},
|
|
1071
|
+
"default": "[]",
|
|
1072
|
+
"remarks": "The recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `yarn add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and\nthis will be what you `package.json` will eventually include.",
|
|
1073
|
+
"stability": "experimental",
|
|
1074
|
+
"summary": "Runtime dependencies of this module."
|
|
1075
|
+
},
|
|
1076
|
+
"immutable": true,
|
|
1077
|
+
"locationInModule": {
|
|
1078
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1079
|
+
"line": 927
|
|
1080
|
+
},
|
|
1081
|
+
"name": "deps",
|
|
1082
|
+
"optional": true,
|
|
1083
|
+
"type": {
|
|
1084
|
+
"collection": {
|
|
1085
|
+
"elementtype": {
|
|
1086
|
+
"primitive": "string"
|
|
1087
|
+
},
|
|
1088
|
+
"kind": "array"
|
|
1089
|
+
}
|
|
1090
|
+
}
|
|
1091
|
+
},
|
|
1092
|
+
{
|
|
1093
|
+
"abstract": true,
|
|
1094
|
+
"docs": {
|
|
1095
|
+
"default": "true",
|
|
1096
|
+
"remarks": "Cannot be used in conjunction with `dependabot`.",
|
|
1097
|
+
"stability": "experimental",
|
|
1098
|
+
"summary": "Use tasks and github workflows to handle dependency upgrades."
|
|
1099
|
+
},
|
|
1100
|
+
"immutable": true,
|
|
1101
|
+
"locationInModule": {
|
|
1102
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1103
|
+
"line": 437
|
|
1104
|
+
},
|
|
1105
|
+
"name": "depsUpgrade",
|
|
1106
|
+
"optional": true,
|
|
1107
|
+
"type": {
|
|
1108
|
+
"primitive": "boolean"
|
|
1109
|
+
}
|
|
1110
|
+
},
|
|
1111
|
+
{
|
|
1112
|
+
"abstract": true,
|
|
1113
|
+
"docs": {
|
|
1114
|
+
"default": "- default options",
|
|
1115
|
+
"stability": "experimental",
|
|
1116
|
+
"summary": "Options for `UpgradeDependencies`."
|
|
1117
|
+
},
|
|
1118
|
+
"immutable": true,
|
|
1119
|
+
"locationInModule": {
|
|
1120
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1121
|
+
"line": 430
|
|
1122
|
+
},
|
|
1123
|
+
"name": "depsUpgradeOptions",
|
|
1124
|
+
"optional": true,
|
|
1125
|
+
"type": {
|
|
1126
|
+
"fqn": "projen.javascript.UpgradeDependenciesOptions"
|
|
1127
|
+
}
|
|
1128
|
+
},
|
|
1129
|
+
{
|
|
1130
|
+
"abstract": true,
|
|
1131
|
+
"docs": {
|
|
1132
|
+
"custom": {
|
|
1133
|
+
"featured": "true"
|
|
1134
|
+
},
|
|
1135
|
+
"remarks": "It can be used when searching for packages in a package manager as well.\nSee https://classic.yarnpkg.com/en/docs/package-json/#toc-description",
|
|
1136
|
+
"stability": "experimental",
|
|
1137
|
+
"summary": "The description is just a string that helps people understand the purpose of the package."
|
|
1138
|
+
},
|
|
1139
|
+
"immutable": true,
|
|
1140
|
+
"locationInModule": {
|
|
1141
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1142
|
+
"line": 914
|
|
1143
|
+
},
|
|
1144
|
+
"name": "description",
|
|
1145
|
+
"optional": true,
|
|
1146
|
+
"type": {
|
|
1147
|
+
"primitive": "string"
|
|
1148
|
+
}
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"abstract": true,
|
|
1152
|
+
"docs": {
|
|
1153
|
+
"default": "false",
|
|
1154
|
+
"stability": "experimental",
|
|
1155
|
+
"summary": "Add a VSCode development environment (used for GitHub Codespaces)."
|
|
1156
|
+
},
|
|
1157
|
+
"immutable": true,
|
|
1158
|
+
"locationInModule": {
|
|
1159
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1160
|
+
"line": 1093
|
|
1161
|
+
},
|
|
1162
|
+
"name": "devContainer",
|
|
1163
|
+
"optional": true,
|
|
1164
|
+
"type": {
|
|
1165
|
+
"primitive": "boolean"
|
|
1166
|
+
}
|
|
1167
|
+
},
|
|
1168
|
+
{
|
|
1169
|
+
"abstract": true,
|
|
1170
|
+
"docs": {
|
|
1171
|
+
"custom": {
|
|
1172
|
+
"featured": "true"
|
|
1173
|
+
},
|
|
1174
|
+
"default": "[]",
|
|
1175
|
+
"remarks": "These dependencies will only be\navailable in your build environment but will not be fetched when this\nmodule is consumed.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `yarn add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and\nthis will be what you `package.json` will eventually include.",
|
|
1176
|
+
"stability": "experimental",
|
|
1177
|
+
"summary": "Build dependencies for this module."
|
|
1178
|
+
},
|
|
1179
|
+
"immutable": true,
|
|
1180
|
+
"locationInModule": {
|
|
1181
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1182
|
+
"line": 906
|
|
1183
|
+
},
|
|
1184
|
+
"name": "devDeps",
|
|
1185
|
+
"optional": true,
|
|
1186
|
+
"type": {
|
|
1187
|
+
"collection": {
|
|
1188
|
+
"elementtype": {
|
|
1189
|
+
"primitive": "string"
|
|
1190
|
+
},
|
|
1191
|
+
"kind": "array"
|
|
1192
|
+
}
|
|
1193
|
+
}
|
|
1194
|
+
},
|
|
1195
|
+
{
|
|
1196
|
+
"abstract": true,
|
|
1197
|
+
"docs": {
|
|
1198
|
+
"default": "false",
|
|
1199
|
+
"stability": "experimental",
|
|
1200
|
+
"summary": "Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler)."
|
|
1201
|
+
},
|
|
1202
|
+
"immutable": true,
|
|
1203
|
+
"locationInModule": {
|
|
1204
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1205
|
+
"line": 280
|
|
1206
|
+
},
|
|
1207
|
+
"name": "disableTsconfig",
|
|
1208
|
+
"optional": true,
|
|
1209
|
+
"type": {
|
|
1210
|
+
"primitive": "boolean"
|
|
1211
|
+
}
|
|
1212
|
+
},
|
|
1213
|
+
{
|
|
1214
|
+
"abstract": true,
|
|
1215
|
+
"docs": {
|
|
1216
|
+
"default": "false",
|
|
1217
|
+
"stability": "experimental",
|
|
1218
|
+
"summary": "Do not generate a `tsconfig.dev.json` file."
|
|
1219
|
+
},
|
|
1220
|
+
"immutable": true,
|
|
1221
|
+
"locationInModule": {
|
|
1222
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1223
|
+
"line": 274
|
|
1224
|
+
},
|
|
1225
|
+
"name": "disableTsconfigDev",
|
|
1226
|
+
"optional": true,
|
|
1227
|
+
"type": {
|
|
1228
|
+
"primitive": "boolean"
|
|
1229
|
+
}
|
|
1230
|
+
},
|
|
1231
|
+
{
|
|
1232
|
+
"abstract": true,
|
|
1233
|
+
"docs": {
|
|
1234
|
+
"default": "false",
|
|
1235
|
+
"stability": "experimental",
|
|
1236
|
+
"summary": "Docgen by Typedoc."
|
|
1237
|
+
},
|
|
1238
|
+
"immutable": true,
|
|
1239
|
+
"locationInModule": {
|
|
1240
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1241
|
+
"line": 268
|
|
1242
|
+
},
|
|
1243
|
+
"name": "docgen",
|
|
1244
|
+
"optional": true,
|
|
1245
|
+
"type": {
|
|
1246
|
+
"primitive": "boolean"
|
|
1247
|
+
}
|
|
1248
|
+
},
|
|
1249
|
+
{
|
|
1250
|
+
"abstract": true,
|
|
1251
|
+
"docs": {
|
|
1252
|
+
"default": "\"docs\"",
|
|
1253
|
+
"stability": "experimental",
|
|
1254
|
+
"summary": "Docs directory."
|
|
1255
|
+
},
|
|
1256
|
+
"immutable": true,
|
|
1257
|
+
"locationInModule": {
|
|
1258
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1259
|
+
"line": 262
|
|
1260
|
+
},
|
|
1261
|
+
"name": "docsDirectory",
|
|
1262
|
+
"optional": true,
|
|
1263
|
+
"type": {
|
|
1264
|
+
"primitive": "string"
|
|
1265
|
+
}
|
|
1266
|
+
},
|
|
1267
|
+
{
|
|
1268
|
+
"abstract": true,
|
|
1269
|
+
"docs": {
|
|
1270
|
+
"default": "true",
|
|
1271
|
+
"stability": "experimental",
|
|
1272
|
+
"summary": "Automatically adds an `cloudfront.experimental.EdgeFunction` for each `.edge-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project."
|
|
1273
|
+
},
|
|
1274
|
+
"immutable": true,
|
|
1275
|
+
"locationInModule": {
|
|
1276
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1277
|
+
"line": 44
|
|
1278
|
+
},
|
|
1279
|
+
"name": "edgeLambdaAutoDiscover",
|
|
1280
|
+
"optional": true,
|
|
1281
|
+
"type": {
|
|
1282
|
+
"primitive": "boolean"
|
|
1283
|
+
}
|
|
1284
|
+
},
|
|
1285
|
+
{
|
|
1286
|
+
"abstract": true,
|
|
1287
|
+
"docs": {
|
|
1288
|
+
"default": "\"lib/index.js\"",
|
|
1289
|
+
"stability": "experimental",
|
|
1290
|
+
"summary": "Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json."
|
|
1291
|
+
},
|
|
1292
|
+
"immutable": true,
|
|
1293
|
+
"locationInModule": {
|
|
1294
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1295
|
+
"line": 889
|
|
1296
|
+
},
|
|
1297
|
+
"name": "entrypoint",
|
|
1298
|
+
"optional": true,
|
|
1299
|
+
"type": {
|
|
1300
|
+
"primitive": "string"
|
|
1301
|
+
}
|
|
1302
|
+
},
|
|
1303
|
+
{
|
|
1304
|
+
"abstract": true,
|
|
1305
|
+
"docs": {
|
|
1306
|
+
"default": "- .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)",
|
|
1307
|
+
"stability": "experimental",
|
|
1308
|
+
"summary": "The .d.ts file that includes the type declarations for this module."
|
|
1309
|
+
},
|
|
1310
|
+
"immutable": true,
|
|
1311
|
+
"locationInModule": {
|
|
1312
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1313
|
+
"line": 256
|
|
1314
|
+
},
|
|
1315
|
+
"name": "entrypointTypes",
|
|
1316
|
+
"optional": true,
|
|
1317
|
+
"type": {
|
|
1318
|
+
"primitive": "string"
|
|
1319
|
+
}
|
|
1320
|
+
},
|
|
1321
|
+
{
|
|
1322
|
+
"abstract": true,
|
|
1323
|
+
"docs": {
|
|
1324
|
+
"default": "true",
|
|
1325
|
+
"stability": "experimental",
|
|
1326
|
+
"summary": "Setup eslint."
|
|
1327
|
+
},
|
|
1328
|
+
"immutable": true,
|
|
1329
|
+
"locationInModule": {
|
|
1330
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1331
|
+
"line": 250
|
|
1332
|
+
},
|
|
1333
|
+
"name": "eslint",
|
|
1334
|
+
"optional": true,
|
|
1335
|
+
"type": {
|
|
1336
|
+
"primitive": "boolean"
|
|
1337
|
+
}
|
|
1338
|
+
},
|
|
1339
|
+
{
|
|
1340
|
+
"abstract": true,
|
|
1341
|
+
"docs": {
|
|
1342
|
+
"default": "- opinionated default options",
|
|
1343
|
+
"stability": "experimental",
|
|
1344
|
+
"summary": "Eslint options."
|
|
1345
|
+
},
|
|
1346
|
+
"immutable": true,
|
|
1347
|
+
"locationInModule": {
|
|
1348
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1349
|
+
"line": 244
|
|
1350
|
+
},
|
|
1351
|
+
"name": "eslintOptions",
|
|
1352
|
+
"optional": true,
|
|
1353
|
+
"type": {
|
|
1354
|
+
"fqn": "projen.javascript.EslintOptions"
|
|
1355
|
+
}
|
|
1356
|
+
},
|
|
1357
|
+
{
|
|
1358
|
+
"abstract": true,
|
|
1359
|
+
"docs": {
|
|
1360
|
+
"default": "false",
|
|
1361
|
+
"stability": "experimental",
|
|
1362
|
+
"summary": "Enable experimental support for the AWS CDK integ-runner."
|
|
1363
|
+
},
|
|
1364
|
+
"immutable": true,
|
|
1365
|
+
"locationInModule": {
|
|
1366
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1367
|
+
"line": 38
|
|
1368
|
+
},
|
|
1369
|
+
"name": "experimentalIntegRunner",
|
|
1370
|
+
"optional": true,
|
|
1371
|
+
"type": {
|
|
1372
|
+
"primitive": "boolean"
|
|
1373
|
+
}
|
|
1374
|
+
},
|
|
1375
|
+
{
|
|
1376
|
+
"abstract": true,
|
|
1377
|
+
"docs": {
|
|
1378
|
+
"default": "true",
|
|
1379
|
+
"stability": "experimental",
|
|
1380
|
+
"summary": "Include all feature flags in cdk.json."
|
|
1381
|
+
},
|
|
1382
|
+
"immutable": true,
|
|
1383
|
+
"locationInModule": {
|
|
1384
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1385
|
+
"line": 146
|
|
1386
|
+
},
|
|
1387
|
+
"name": "featureFlags",
|
|
1388
|
+
"optional": true,
|
|
1389
|
+
"type": {
|
|
1390
|
+
"primitive": "boolean"
|
|
1391
|
+
}
|
|
1392
|
+
},
|
|
1393
|
+
{
|
|
1394
|
+
"abstract": true,
|
|
1395
|
+
"docs": {
|
|
1396
|
+
"default": "true",
|
|
1397
|
+
"remarks": "Enabled by default for root projects. Disabled for non-root projects.",
|
|
1398
|
+
"stability": "experimental",
|
|
1399
|
+
"summary": "Enable GitHub integration."
|
|
1400
|
+
},
|
|
1401
|
+
"immutable": true,
|
|
1402
|
+
"locationInModule": {
|
|
1403
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1404
|
+
"line": 1087
|
|
1405
|
+
},
|
|
1406
|
+
"name": "github",
|
|
1407
|
+
"optional": true,
|
|
1408
|
+
"type": {
|
|
1409
|
+
"primitive": "boolean"
|
|
1410
|
+
}
|
|
1411
|
+
},
|
|
1412
|
+
{
|
|
1413
|
+
"abstract": true,
|
|
1414
|
+
"docs": {
|
|
1415
|
+
"default": "- see GitHubOptions",
|
|
1416
|
+
"stability": "experimental",
|
|
1417
|
+
"summary": "Options for GitHub integration."
|
|
1418
|
+
},
|
|
1419
|
+
"immutable": true,
|
|
1420
|
+
"locationInModule": {
|
|
1421
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1422
|
+
"line": 1080
|
|
1423
|
+
},
|
|
1424
|
+
"name": "githubOptions",
|
|
1425
|
+
"optional": true,
|
|
1426
|
+
"type": {
|
|
1427
|
+
"fqn": "projen.github.GitHubOptions"
|
|
1428
|
+
}
|
|
1429
|
+
},
|
|
1430
|
+
{
|
|
1431
|
+
"abstract": true,
|
|
1432
|
+
"docs": {
|
|
1433
|
+
"stability": "experimental",
|
|
1434
|
+
"summary": "Additional entries to .gitignore."
|
|
1435
|
+
},
|
|
1436
|
+
"immutable": true,
|
|
1437
|
+
"locationInModule": {
|
|
1438
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1439
|
+
"line": 424
|
|
1440
|
+
},
|
|
1441
|
+
"name": "gitignore",
|
|
1442
|
+
"optional": true,
|
|
1443
|
+
"type": {
|
|
1444
|
+
"collection": {
|
|
1445
|
+
"elementtype": {
|
|
1446
|
+
"primitive": "string"
|
|
1447
|
+
},
|
|
1448
|
+
"kind": "array"
|
|
1449
|
+
}
|
|
1450
|
+
}
|
|
1451
|
+
},
|
|
1452
|
+
{
|
|
1453
|
+
"abstract": true,
|
|
1454
|
+
"docs": {
|
|
1455
|
+
"stability": "experimental",
|
|
1456
|
+
"summary": "Configuration options for .gitignore file."
|
|
1457
|
+
},
|
|
1458
|
+
"immutable": true,
|
|
1459
|
+
"locationInModule": {
|
|
1460
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1461
|
+
"line": 1184
|
|
1462
|
+
},
|
|
1463
|
+
"name": "gitIgnoreOptions",
|
|
1464
|
+
"optional": true,
|
|
1465
|
+
"type": {
|
|
1466
|
+
"fqn": "projen.IgnoreFileOptions"
|
|
1467
|
+
}
|
|
1468
|
+
},
|
|
1469
|
+
{
|
|
1470
|
+
"abstract": true,
|
|
1471
|
+
"docs": {
|
|
1472
|
+
"stability": "experimental",
|
|
1473
|
+
"summary": "Configuration options for git."
|
|
1474
|
+
},
|
|
1475
|
+
"immutable": true,
|
|
1476
|
+
"locationInModule": {
|
|
1477
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1478
|
+
"line": 1179
|
|
1479
|
+
},
|
|
1480
|
+
"name": "gitOptions",
|
|
1481
|
+
"optional": true,
|
|
1482
|
+
"type": {
|
|
1483
|
+
"fqn": "projen.GitOptions"
|
|
1484
|
+
}
|
|
1485
|
+
},
|
|
1486
|
+
{
|
|
1487
|
+
"abstract": true,
|
|
1488
|
+
"docs": {
|
|
1489
|
+
"default": "false",
|
|
1490
|
+
"stability": "experimental",
|
|
1491
|
+
"summary": "Add a Gitpod development environment."
|
|
1492
|
+
},
|
|
1493
|
+
"immutable": true,
|
|
1494
|
+
"locationInModule": {
|
|
1495
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1496
|
+
"line": 1074
|
|
1497
|
+
},
|
|
1498
|
+
"name": "gitpod",
|
|
1499
|
+
"optional": true,
|
|
1500
|
+
"type": {
|
|
1501
|
+
"primitive": "boolean"
|
|
1502
|
+
}
|
|
1503
|
+
},
|
|
1504
|
+
{
|
|
1505
|
+
"abstract": true,
|
|
1506
|
+
"docs": {
|
|
1507
|
+
"stability": "experimental",
|
|
1508
|
+
"summary": "Package's Homepage / Website."
|
|
1509
|
+
},
|
|
1510
|
+
"immutable": true,
|
|
1511
|
+
"locationInModule": {
|
|
1512
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1513
|
+
"line": 882
|
|
1514
|
+
},
|
|
1515
|
+
"name": "homepage",
|
|
1516
|
+
"optional": true,
|
|
1517
|
+
"type": {
|
|
1518
|
+
"primitive": "string"
|
|
1519
|
+
}
|
|
1520
|
+
},
|
|
1521
|
+
{
|
|
1522
|
+
"abstract": true,
|
|
1523
|
+
"docs": {
|
|
1524
|
+
"default": "true",
|
|
1525
|
+
"stability": "experimental",
|
|
1526
|
+
"summary": "Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory."
|
|
1527
|
+
},
|
|
1528
|
+
"immutable": true,
|
|
1529
|
+
"locationInModule": {
|
|
1530
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1531
|
+
"line": 32
|
|
1532
|
+
},
|
|
1533
|
+
"name": "integrationTestAutoDiscover",
|
|
1534
|
+
"optional": true,
|
|
1535
|
+
"type": {
|
|
1536
|
+
"primitive": "boolean"
|
|
1537
|
+
}
|
|
1538
|
+
},
|
|
1539
|
+
{
|
|
1540
|
+
"abstract": true,
|
|
1541
|
+
"docs": {
|
|
1542
|
+
"default": "true",
|
|
1543
|
+
"stability": "experimental",
|
|
1544
|
+
"summary": "Setup jest unit tests."
|
|
1545
|
+
},
|
|
1546
|
+
"immutable": true,
|
|
1547
|
+
"locationInModule": {
|
|
1548
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1549
|
+
"line": 419
|
|
1550
|
+
},
|
|
1551
|
+
"name": "jest",
|
|
1552
|
+
"optional": true,
|
|
1553
|
+
"type": {
|
|
1554
|
+
"primitive": "boolean"
|
|
1555
|
+
}
|
|
1556
|
+
},
|
|
1557
|
+
{
|
|
1558
|
+
"abstract": true,
|
|
1559
|
+
"docs": {
|
|
1560
|
+
"default": "- default options",
|
|
1561
|
+
"stability": "experimental",
|
|
1562
|
+
"summary": "Jest options."
|
|
1563
|
+
},
|
|
1564
|
+
"immutable": true,
|
|
1565
|
+
"locationInModule": {
|
|
1566
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1567
|
+
"line": 413
|
|
1568
|
+
},
|
|
1569
|
+
"name": "jestOptions",
|
|
1570
|
+
"optional": true,
|
|
1571
|
+
"type": {
|
|
1572
|
+
"fqn": "projen.javascript.JestOptions"
|
|
1573
|
+
}
|
|
1574
|
+
},
|
|
1575
|
+
{
|
|
1576
|
+
"abstract": true,
|
|
1577
|
+
"docs": {
|
|
1578
|
+
"default": "\"latest\"",
|
|
1579
|
+
"stability": "experimental",
|
|
1580
|
+
"summary": "Version requirement of `publib` which is used to publish modules to npm."
|
|
1581
|
+
},
|
|
1582
|
+
"immutable": true,
|
|
1583
|
+
"locationInModule": {
|
|
1584
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1585
|
+
"line": 705
|
|
1586
|
+
},
|
|
1587
|
+
"name": "jsiiReleaseVersion",
|
|
1588
|
+
"optional": true,
|
|
1589
|
+
"type": {
|
|
1590
|
+
"primitive": "string"
|
|
1591
|
+
}
|
|
1592
|
+
},
|
|
1593
|
+
{
|
|
1594
|
+
"abstract": true,
|
|
1595
|
+
"docs": {
|
|
1596
|
+
"stability": "experimental",
|
|
1597
|
+
"summary": "Keywords to include in `package.json`."
|
|
1598
|
+
},
|
|
1599
|
+
"immutable": true,
|
|
1600
|
+
"locationInModule": {
|
|
1601
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1602
|
+
"line": 877
|
|
1603
|
+
},
|
|
1604
|
+
"name": "keywords",
|
|
1605
|
+
"optional": true,
|
|
1606
|
+
"type": {
|
|
1607
|
+
"collection": {
|
|
1608
|
+
"elementtype": {
|
|
1609
|
+
"primitive": "string"
|
|
1610
|
+
},
|
|
1611
|
+
"kind": "array"
|
|
1612
|
+
}
|
|
1613
|
+
}
|
|
1614
|
+
},
|
|
1615
|
+
{
|
|
1616
|
+
"abstract": true,
|
|
1617
|
+
"docs": {
|
|
1618
|
+
"default": "true",
|
|
1619
|
+
"stability": "experimental",
|
|
1620
|
+
"summary": "Automatically adds an `awscdk.LambdaFunction` for each `.lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project."
|
|
1621
|
+
},
|
|
1622
|
+
"immutable": true,
|
|
1623
|
+
"locationInModule": {
|
|
1624
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1625
|
+
"line": 26
|
|
1626
|
+
},
|
|
1627
|
+
"name": "lambdaAutoDiscover",
|
|
1628
|
+
"optional": true,
|
|
1629
|
+
"type": {
|
|
1630
|
+
"primitive": "boolean"
|
|
1631
|
+
}
|
|
1632
|
+
},
|
|
1633
|
+
{
|
|
1634
|
+
"abstract": true,
|
|
1635
|
+
"docs": {
|
|
1636
|
+
"default": "true",
|
|
1637
|
+
"stability": "experimental",
|
|
1638
|
+
"summary": "Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project."
|
|
1639
|
+
},
|
|
1640
|
+
"immutable": true,
|
|
1641
|
+
"locationInModule": {
|
|
1642
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1643
|
+
"line": 20
|
|
1644
|
+
},
|
|
1645
|
+
"name": "lambdaExtensionAutoDiscover",
|
|
1646
|
+
"optional": true,
|
|
1647
|
+
"type": {
|
|
1648
|
+
"primitive": "boolean"
|
|
1649
|
+
}
|
|
1650
|
+
},
|
|
1651
|
+
{
|
|
1652
|
+
"abstract": true,
|
|
1653
|
+
"docs": {
|
|
1654
|
+
"default": "- default options",
|
|
1655
|
+
"stability": "experimental",
|
|
1656
|
+
"summary": "Common options for all AWS Lambda functions."
|
|
1657
|
+
},
|
|
1658
|
+
"immutable": true,
|
|
1659
|
+
"locationInModule": {
|
|
1660
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1661
|
+
"line": 14
|
|
1662
|
+
},
|
|
1663
|
+
"name": "lambdaOptions",
|
|
1664
|
+
"optional": true,
|
|
1665
|
+
"type": {
|
|
1666
|
+
"fqn": "projen.awscdk.LambdaFunctionCommonOptions"
|
|
1667
|
+
}
|
|
1668
|
+
},
|
|
1669
|
+
{
|
|
1670
|
+
"abstract": true,
|
|
1671
|
+
"docs": {
|
|
1672
|
+
"default": "\"lib\"",
|
|
1673
|
+
"stability": "experimental",
|
|
1674
|
+
"summary": "Typescript artifacts output directory."
|
|
1675
|
+
},
|
|
1676
|
+
"immutable": true,
|
|
1677
|
+
"locationInModule": {
|
|
1678
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1679
|
+
"line": 238
|
|
1680
|
+
},
|
|
1681
|
+
"name": "libdir",
|
|
1682
|
+
"optional": true,
|
|
1683
|
+
"type": {
|
|
1684
|
+
"primitive": "string"
|
|
1685
|
+
}
|
|
1686
|
+
},
|
|
1687
|
+
{
|
|
1688
|
+
"abstract": true,
|
|
1689
|
+
"docs": {
|
|
1690
|
+
"default": "\"Apache-2.0\"",
|
|
1691
|
+
"remarks": "See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.\nUse the `licensed` option if you want to no license to be specified.",
|
|
1692
|
+
"stability": "experimental",
|
|
1693
|
+
"summary": "License's SPDX identifier."
|
|
1694
|
+
},
|
|
1695
|
+
"immutable": true,
|
|
1696
|
+
"locationInModule": {
|
|
1697
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1698
|
+
"line": 872
|
|
1699
|
+
},
|
|
1700
|
+
"name": "license",
|
|
1701
|
+
"optional": true,
|
|
1702
|
+
"type": {
|
|
1703
|
+
"primitive": "string"
|
|
1704
|
+
}
|
|
1705
|
+
},
|
|
1706
|
+
{
|
|
1707
|
+
"abstract": true,
|
|
1708
|
+
"docs": {
|
|
1709
|
+
"default": "true",
|
|
1710
|
+
"stability": "experimental",
|
|
1711
|
+
"summary": "Indicates if a license should be added."
|
|
1712
|
+
},
|
|
1713
|
+
"immutable": true,
|
|
1714
|
+
"locationInModule": {
|
|
1715
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1716
|
+
"line": 864
|
|
1717
|
+
},
|
|
1718
|
+
"name": "licensed",
|
|
1719
|
+
"optional": true,
|
|
1720
|
+
"type": {
|
|
1721
|
+
"primitive": "boolean"
|
|
1722
|
+
}
|
|
1723
|
+
},
|
|
1724
|
+
{
|
|
1725
|
+
"abstract": true,
|
|
1726
|
+
"docs": {
|
|
1727
|
+
"default": "{}",
|
|
1728
|
+
"stability": "experimental",
|
|
1729
|
+
"summary": "Configure logging options such as verbosity."
|
|
1730
|
+
},
|
|
1731
|
+
"immutable": true,
|
|
1732
|
+
"locationInModule": {
|
|
1733
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1734
|
+
"line": 1174
|
|
1735
|
+
},
|
|
1736
|
+
"name": "logging",
|
|
1737
|
+
"optional": true,
|
|
1738
|
+
"type": {
|
|
1739
|
+
"fqn": "projen.LoggerOptions"
|
|
1740
|
+
}
|
|
1741
|
+
},
|
|
1742
|
+
{
|
|
1743
|
+
"abstract": true,
|
|
1744
|
+
"docs": {
|
|
1745
|
+
"default": "- Major version is not enforced.",
|
|
1746
|
+
"remarks": "If this is specified, we bump the latest version of this major version line.\nIf not specified, we bump the global latest version.",
|
|
1747
|
+
"stability": "experimental",
|
|
1748
|
+
"summary": "Major version to release from the default branch."
|
|
1749
|
+
},
|
|
1750
|
+
"immutable": true,
|
|
1751
|
+
"locationInModule": {
|
|
1752
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1753
|
+
"line": 699
|
|
1754
|
+
},
|
|
1755
|
+
"name": "majorVersion",
|
|
1756
|
+
"optional": true,
|
|
1757
|
+
"type": {
|
|
1758
|
+
"primitive": "number"
|
|
1759
|
+
}
|
|
1760
|
+
},
|
|
1761
|
+
{
|
|
1762
|
+
"abstract": true,
|
|
1763
|
+
"docs": {
|
|
1764
|
+
"default": "- no maximum version is enforced",
|
|
1765
|
+
"remarks": "Most projects should not use this option.\nThe value indicates that the package is incompatible with any newer versions of node.\nThis requirement is enforced via the engines field.\n\nYou will normally not need to set this option.\nConsider this option only if your package is known to not function with newer versions of node.",
|
|
1766
|
+
"stability": "experimental",
|
|
1767
|
+
"summary": "The maximum node version supported by this package."
|
|
1768
|
+
},
|
|
1769
|
+
"immutable": true,
|
|
1770
|
+
"locationInModule": {
|
|
1771
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1772
|
+
"line": 858
|
|
1773
|
+
},
|
|
1774
|
+
"name": "maxNodeVersion",
|
|
1775
|
+
"optional": true,
|
|
1776
|
+
"type": {
|
|
1777
|
+
"primitive": "string"
|
|
1778
|
+
}
|
|
1779
|
+
},
|
|
1780
|
+
{
|
|
1781
|
+
"abstract": true,
|
|
1782
|
+
"docs": {
|
|
1783
|
+
"default": "true",
|
|
1784
|
+
"deprecated": "use `githubOptions.mergify` instead",
|
|
1785
|
+
"stability": "deprecated",
|
|
1786
|
+
"summary": "Whether mergify should be enabled on this repository or not."
|
|
1787
|
+
},
|
|
1788
|
+
"immutable": true,
|
|
1789
|
+
"locationInModule": {
|
|
1790
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1791
|
+
"line": 1068
|
|
1792
|
+
},
|
|
1793
|
+
"name": "mergify",
|
|
1794
|
+
"optional": true,
|
|
1795
|
+
"type": {
|
|
1796
|
+
"primitive": "boolean"
|
|
1797
|
+
}
|
|
1798
|
+
},
|
|
1799
|
+
{
|
|
1800
|
+
"abstract": true,
|
|
1801
|
+
"docs": {
|
|
1802
|
+
"default": "- default options",
|
|
1803
|
+
"deprecated": "use `githubOptions.mergifyOptions` instead",
|
|
1804
|
+
"stability": "deprecated",
|
|
1805
|
+
"summary": "Options for mergify."
|
|
1806
|
+
},
|
|
1807
|
+
"immutable": true,
|
|
1808
|
+
"locationInModule": {
|
|
1809
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1810
|
+
"line": 1061
|
|
1811
|
+
},
|
|
1812
|
+
"name": "mergifyOptions",
|
|
1813
|
+
"optional": true,
|
|
1814
|
+
"type": {
|
|
1815
|
+
"fqn": "projen.github.MergifyOptions"
|
|
1816
|
+
}
|
|
1817
|
+
},
|
|
1818
|
+
{
|
|
1819
|
+
"abstract": true,
|
|
1820
|
+
"docs": {
|
|
1821
|
+
"default": "- No minimum version is being enforced",
|
|
1822
|
+
"remarks": "This can be useful to set to 1, as breaking changes before the 1.x major\nrelease are not incrementing the major version number.\n\nCan not be set together with `majorVersion`.",
|
|
1823
|
+
"stability": "experimental",
|
|
1824
|
+
"summary": "Minimal Major version to release."
|
|
1825
|
+
},
|
|
1826
|
+
"immutable": true,
|
|
1827
|
+
"locationInModule": {
|
|
1828
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1829
|
+
"line": 691
|
|
1830
|
+
},
|
|
1831
|
+
"name": "minMajorVersion",
|
|
1832
|
+
"optional": true,
|
|
1833
|
+
"type": {
|
|
1834
|
+
"primitive": "number"
|
|
1835
|
+
}
|
|
1836
|
+
},
|
|
1837
|
+
{
|
|
1838
|
+
"abstract": true,
|
|
1839
|
+
"docs": {
|
|
1840
|
+
"default": "- no minimum version is enforced",
|
|
1841
|
+
"remarks": "Most projects should not use this option.\nThe value indicates that the package is incompatible with any older versions of node.\nThis requirement is enforced via the engines field.\n\nYou will normally not need to set this option, even if your package is incompatible with EOL versions of node.\nConsider this option only if your package depends on a specific feature, that is not available in other LTS versions.\nSetting this option has very high impact on the consumers of your package,\nas package managers will actively prevent usage with node versions you have marked as incompatible.\n\nTo change the node version of your CI/CD workflows, use `workflowNodeVersion`.",
|
|
1842
|
+
"stability": "experimental",
|
|
1843
|
+
"summary": "The minimum node version required by this package to function."
|
|
1844
|
+
},
|
|
1845
|
+
"immutable": true,
|
|
1846
|
+
"locationInModule": {
|
|
1847
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1848
|
+
"line": 847
|
|
1849
|
+
},
|
|
1850
|
+
"name": "minNodeVersion",
|
|
1851
|
+
"optional": true,
|
|
1852
|
+
"type": {
|
|
1853
|
+
"primitive": "string"
|
|
1854
|
+
}
|
|
1855
|
+
},
|
|
1856
|
+
{
|
|
1857
|
+
"abstract": true,
|
|
1858
|
+
"docs": {
|
|
1859
|
+
"default": "true",
|
|
1860
|
+
"deprecated": "- Use `buildWorkflowOptions.mutableBuild`",
|
|
1861
|
+
"remarks": "This means\nthat any files synthesized by projen or e.g. test snapshots will always be up-to-date\nbefore a PR is merged.\n\nImplies that PR builds do not have anti-tamper checks.",
|
|
1862
|
+
"stability": "deprecated",
|
|
1863
|
+
"summary": "Automatically update files modified during builds to pull-request branches."
|
|
1864
|
+
},
|
|
1865
|
+
"immutable": true,
|
|
1866
|
+
"locationInModule": {
|
|
1867
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1868
|
+
"line": 407
|
|
1869
|
+
},
|
|
1870
|
+
"name": "mutableBuild",
|
|
1871
|
+
"optional": true,
|
|
1872
|
+
"type": {
|
|
1873
|
+
"primitive": "boolean"
|
|
1874
|
+
}
|
|
1875
|
+
},
|
|
1876
|
+
{
|
|
1877
|
+
"abstract": true,
|
|
1878
|
+
"docs": {
|
|
1879
|
+
"default": "- The next version will be determined based on the commit history and project settings.",
|
|
1880
|
+
"remarks": "If present, this shell command will be run before the bump is executed, and\nit determines what version to release. It will be executed in the following\nenvironment:\n\n- Working directory: the project directory.\n- `$VERSION`: the current version. Looks like `1.2.3`.\n- `$LATEST_TAG`: the most recent tag. Looks like `prefix-v1.2.3`, or may be unset.\n\nThe command should print one of the following to `stdout`:\n\n- Nothing: the next version number will be determined based on commit history.\n- `x.y.z`: the next version number will be `x.y.z`.\n- `major|minor|patch`: the next version number will be the current version number\n with the indicated component bumped.\n\nThis setting cannot be specified together with `minMajorVersion`; the invoked\nscript can be used to achieve the effects of `minMajorVersion`.",
|
|
1881
|
+
"stability": "experimental",
|
|
1882
|
+
"summary": "A shell command to control the next version to release."
|
|
1883
|
+
},
|
|
1884
|
+
"immutable": true,
|
|
1885
|
+
"locationInModule": {
|
|
1886
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1887
|
+
"line": 681
|
|
1888
|
+
},
|
|
1889
|
+
"name": "nextVersionCommand",
|
|
1890
|
+
"optional": true,
|
|
1891
|
+
"type": {
|
|
1892
|
+
"primitive": "string"
|
|
1893
|
+
}
|
|
1894
|
+
},
|
|
1895
|
+
{
|
|
1896
|
+
"abstract": true,
|
|
1897
|
+
"docs": {
|
|
1898
|
+
"default": "- for scoped packages (e.g. `foo@bar`), the default is\n`NpmAccess.RESTRICTED`, for non-scoped packages, the default is\n`NpmAccess.PUBLIC`.",
|
|
1899
|
+
"stability": "experimental",
|
|
1900
|
+
"summary": "Access level of the npm package."
|
|
1901
|
+
},
|
|
1902
|
+
"immutable": true,
|
|
1903
|
+
"locationInModule": {
|
|
1904
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1905
|
+
"line": 832
|
|
1906
|
+
},
|
|
1907
|
+
"name": "npmAccess",
|
|
1908
|
+
"optional": true,
|
|
1909
|
+
"type": {
|
|
1910
|
+
"fqn": "projen.javascript.NpmAccess"
|
|
1911
|
+
}
|
|
1912
|
+
},
|
|
1913
|
+
{
|
|
1914
|
+
"abstract": true,
|
|
1915
|
+
"docs": {
|
|
1916
|
+
"default": "\"latest\"",
|
|
1917
|
+
"remarks": "To set the npm dist-tag for release branches, set the `npmDistTag` property\nfor each branch.",
|
|
1918
|
+
"stability": "experimental",
|
|
1919
|
+
"summary": "The npmDistTag to use when publishing from the default branch."
|
|
1920
|
+
},
|
|
1921
|
+
"immutable": true,
|
|
1922
|
+
"locationInModule": {
|
|
1923
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1924
|
+
"line": 658
|
|
1925
|
+
},
|
|
1926
|
+
"name": "npmDistTag",
|
|
1927
|
+
"optional": true,
|
|
1928
|
+
"type": {
|
|
1929
|
+
"primitive": "string"
|
|
1930
|
+
}
|
|
1931
|
+
},
|
|
1932
|
+
{
|
|
1933
|
+
"abstract": true,
|
|
1934
|
+
"docs": {
|
|
1935
|
+
"deprecated": "- use `project.addPackageIgnore`",
|
|
1936
|
+
"stability": "deprecated",
|
|
1937
|
+
"summary": "Additional entries to .npmignore."
|
|
1938
|
+
},
|
|
1939
|
+
"immutable": true,
|
|
1940
|
+
"locationInModule": {
|
|
1941
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1942
|
+
"line": 395
|
|
1943
|
+
},
|
|
1944
|
+
"name": "npmignore",
|
|
1945
|
+
"optional": true,
|
|
1946
|
+
"type": {
|
|
1947
|
+
"collection": {
|
|
1948
|
+
"elementtype": {
|
|
1949
|
+
"primitive": "string"
|
|
1950
|
+
},
|
|
1951
|
+
"kind": "array"
|
|
1952
|
+
}
|
|
1953
|
+
}
|
|
1954
|
+
},
|
|
1955
|
+
{
|
|
1956
|
+
"abstract": true,
|
|
1957
|
+
"docs": {
|
|
1958
|
+
"default": "true",
|
|
1959
|
+
"stability": "experimental",
|
|
1960
|
+
"summary": "Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs."
|
|
1961
|
+
},
|
|
1962
|
+
"immutable": true,
|
|
1963
|
+
"locationInModule": {
|
|
1964
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1965
|
+
"line": 389
|
|
1966
|
+
},
|
|
1967
|
+
"name": "npmignoreEnabled",
|
|
1968
|
+
"optional": true,
|
|
1969
|
+
"type": {
|
|
1970
|
+
"primitive": "boolean"
|
|
1971
|
+
}
|
|
1972
|
+
},
|
|
1973
|
+
{
|
|
1974
|
+
"abstract": true,
|
|
1975
|
+
"docs": {
|
|
1976
|
+
"stability": "experimental",
|
|
1977
|
+
"summary": "Configuration options for .npmignore file."
|
|
1978
|
+
},
|
|
1979
|
+
"immutable": true,
|
|
1980
|
+
"locationInModule": {
|
|
1981
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
1982
|
+
"line": 383
|
|
1983
|
+
},
|
|
1984
|
+
"name": "npmIgnoreOptions",
|
|
1985
|
+
"optional": true,
|
|
1986
|
+
"type": {
|
|
1987
|
+
"fqn": "projen.IgnoreFileOptions"
|
|
1988
|
+
}
|
|
1989
|
+
},
|
|
1990
|
+
{
|
|
1991
|
+
"abstract": true,
|
|
1992
|
+
"docs": {
|
|
1993
|
+
"default": "- true for public packages, false otherwise",
|
|
1994
|
+
"remarks": "A supported package manager is required to publish a package with npm provenance statements and\nyou will need to use a supported CI/CD provider.\n\nNote that the projen `Release` and `Publisher` components are using `publib` to publish packages,\nwhich is using npm internally and supports provenance statements independently of the package manager used.",
|
|
1995
|
+
"stability": "experimental",
|
|
1996
|
+
"summary": "Should provenance statements be generated when the package is published."
|
|
1997
|
+
},
|
|
1998
|
+
"immutable": true,
|
|
1999
|
+
"locationInModule": {
|
|
2000
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2001
|
+
"line": 824
|
|
2002
|
+
},
|
|
2003
|
+
"name": "npmProvenance",
|
|
2004
|
+
"optional": true,
|
|
2005
|
+
"type": {
|
|
2006
|
+
"primitive": "boolean"
|
|
2007
|
+
}
|
|
2008
|
+
},
|
|
2009
|
+
{
|
|
2010
|
+
"abstract": true,
|
|
2011
|
+
"docs": {
|
|
2012
|
+
"deprecated": "use `npmRegistryUrl` instead",
|
|
2013
|
+
"remarks": "Cannot be set together with `npmRegistryUrl`.",
|
|
2014
|
+
"stability": "deprecated",
|
|
2015
|
+
"summary": "The host name of the npm registry to publish to."
|
|
2016
|
+
},
|
|
2017
|
+
"immutable": true,
|
|
2018
|
+
"locationInModule": {
|
|
2019
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2020
|
+
"line": 813
|
|
2021
|
+
},
|
|
2022
|
+
"name": "npmRegistry",
|
|
2023
|
+
"optional": true,
|
|
2024
|
+
"type": {
|
|
2025
|
+
"primitive": "string"
|
|
2026
|
+
}
|
|
2027
|
+
},
|
|
2028
|
+
{
|
|
2029
|
+
"abstract": true,
|
|
2030
|
+
"docs": {
|
|
2031
|
+
"default": "\"https://registry.npmjs.org\"",
|
|
2032
|
+
"remarks": "Must be a URL (e.g. start with \"https://\" or \"http://\")",
|
|
2033
|
+
"stability": "experimental",
|
|
2034
|
+
"summary": "The base URL of the npm package registry."
|
|
2035
|
+
},
|
|
2036
|
+
"immutable": true,
|
|
2037
|
+
"locationInModule": {
|
|
2038
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2039
|
+
"line": 806
|
|
2040
|
+
},
|
|
2041
|
+
"name": "npmRegistryUrl",
|
|
2042
|
+
"optional": true,
|
|
2043
|
+
"type": {
|
|
2044
|
+
"primitive": "string"
|
|
2045
|
+
}
|
|
2046
|
+
},
|
|
2047
|
+
{
|
|
2048
|
+
"abstract": true,
|
|
2049
|
+
"docs": {
|
|
2050
|
+
"default": "\"NPM_TOKEN\"",
|
|
2051
|
+
"stability": "experimental",
|
|
2052
|
+
"summary": "GitHub secret which contains the NPM token to use when publishing packages."
|
|
2053
|
+
},
|
|
2054
|
+
"immutable": true,
|
|
2055
|
+
"locationInModule": {
|
|
2056
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2057
|
+
"line": 799
|
|
2058
|
+
},
|
|
2059
|
+
"name": "npmTokenSecret",
|
|
2060
|
+
"optional": true,
|
|
2061
|
+
"type": {
|
|
2062
|
+
"primitive": "string"
|
|
2063
|
+
}
|
|
2064
|
+
},
|
|
2065
|
+
{
|
|
2066
|
+
"abstract": true,
|
|
2067
|
+
"docs": {
|
|
2068
|
+
"default": "\".\"",
|
|
2069
|
+
"remarks": "If this project has a parent, this directory is relative to the parent\ndirectory and it cannot be the same as the parent or any of it's other\nsubprojects.",
|
|
2070
|
+
"stability": "experimental",
|
|
2071
|
+
"summary": "The root directory of the project. Relative to this directory, all files are synthesized."
|
|
2072
|
+
},
|
|
2073
|
+
"immutable": true,
|
|
2074
|
+
"locationInModule": {
|
|
2075
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2076
|
+
"line": 1168
|
|
2077
|
+
},
|
|
2078
|
+
"name": "outdir",
|
|
2079
|
+
"optional": true,
|
|
2080
|
+
"type": {
|
|
2081
|
+
"primitive": "string"
|
|
2082
|
+
}
|
|
2083
|
+
},
|
|
2084
|
+
{
|
|
2085
|
+
"abstract": true,
|
|
2086
|
+
"docs": {
|
|
2087
|
+
"default": "true",
|
|
2088
|
+
"stability": "experimental",
|
|
2089
|
+
"summary": "Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`)."
|
|
2090
|
+
},
|
|
2091
|
+
"immutable": true,
|
|
2092
|
+
"locationInModule": {
|
|
2093
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2094
|
+
"line": 378
|
|
2095
|
+
},
|
|
2096
|
+
"name": "package",
|
|
2097
|
+
"optional": true,
|
|
2098
|
+
"type": {
|
|
2099
|
+
"primitive": "boolean"
|
|
2100
|
+
}
|
|
2101
|
+
},
|
|
2102
|
+
{
|
|
2103
|
+
"abstract": true,
|
|
2104
|
+
"docs": {
|
|
2105
|
+
"default": "NodePackageManager.YARN_CLASSIC",
|
|
2106
|
+
"stability": "experimental",
|
|
2107
|
+
"summary": "The Node Package Manager used to execute scripts."
|
|
2108
|
+
},
|
|
2109
|
+
"immutable": true,
|
|
2110
|
+
"locationInModule": {
|
|
2111
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2112
|
+
"line": 793
|
|
2113
|
+
},
|
|
2114
|
+
"name": "packageManager",
|
|
2115
|
+
"optional": true,
|
|
2116
|
+
"type": {
|
|
2117
|
+
"fqn": "projen.javascript.NodePackageManager"
|
|
2118
|
+
}
|
|
2119
|
+
},
|
|
2120
|
+
{
|
|
2121
|
+
"abstract": true,
|
|
2122
|
+
"docs": {
|
|
2123
|
+
"custom": {
|
|
2124
|
+
"featured": "true"
|
|
2125
|
+
},
|
|
2126
|
+
"default": "- defaults to project name",
|
|
2127
|
+
"stability": "experimental",
|
|
2128
|
+
"summary": "The \"name\" in package.json."
|
|
2129
|
+
},
|
|
2130
|
+
"immutable": true,
|
|
2131
|
+
"locationInModule": {
|
|
2132
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2133
|
+
"line": 787
|
|
2134
|
+
},
|
|
2135
|
+
"name": "packageName",
|
|
2136
|
+
"optional": true,
|
|
2137
|
+
"type": {
|
|
2138
|
+
"primitive": "string"
|
|
2139
|
+
}
|
|
2140
|
+
},
|
|
2141
|
+
{
|
|
2142
|
+
"abstract": true,
|
|
2143
|
+
"docs": {
|
|
2144
|
+
"stability": "experimental",
|
|
2145
|
+
"summary": "The parent project, if this project is part of a bigger project."
|
|
2146
|
+
},
|
|
2147
|
+
"immutable": true,
|
|
2148
|
+
"locationInModule": {
|
|
2149
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2150
|
+
"line": 1157
|
|
2151
|
+
},
|
|
2152
|
+
"name": "parent",
|
|
2153
|
+
"optional": true,
|
|
2154
|
+
"type": {
|
|
2155
|
+
"fqn": "projen.Project"
|
|
2156
|
+
}
|
|
2157
|
+
},
|
|
2158
|
+
{
|
|
2159
|
+
"abstract": true,
|
|
2160
|
+
"docs": {
|
|
2161
|
+
"stability": "experimental",
|
|
2162
|
+
"summary": "Options for `peerDeps`."
|
|
2163
|
+
},
|
|
2164
|
+
"immutable": true,
|
|
2165
|
+
"locationInModule": {
|
|
2166
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2167
|
+
"line": 780
|
|
2168
|
+
},
|
|
2169
|
+
"name": "peerDependencyOptions",
|
|
2170
|
+
"optional": true,
|
|
2171
|
+
"type": {
|
|
2172
|
+
"fqn": "projen.javascript.PeerDependencyOptions"
|
|
2173
|
+
}
|
|
2174
|
+
},
|
|
2175
|
+
{
|
|
2176
|
+
"abstract": true,
|
|
2177
|
+
"docs": {
|
|
2178
|
+
"default": "[]",
|
|
2179
|
+
"remarks": "Dependencies listed here are required to\nbe installed (and satisfied) by the _consumer_ of this library. Using peer\ndependencies allows you to ensure that only a single module of a certain\nlibrary exists in the `node_modules` tree of your consumers.\n\nNote that prior to npm@7, peer dependencies are _not_ automatically\ninstalled, which means that adding peer dependencies to a library will be a\nbreaking change for your customers.\n\nUnless `peerDependencyOptions.pinnedDevDependency` is disabled (it is\nenabled by default), projen will automatically add a dev dependency with a\npinned version for each peer dependency. This will ensure that you build &\ntest your module against the lowest peer version required.",
|
|
2180
|
+
"stability": "experimental",
|
|
2181
|
+
"summary": "Peer dependencies for this module."
|
|
2182
|
+
},
|
|
2183
|
+
"immutable": true,
|
|
2184
|
+
"locationInModule": {
|
|
2185
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2186
|
+
"line": 775
|
|
2187
|
+
},
|
|
2188
|
+
"name": "peerDeps",
|
|
2189
|
+
"optional": true,
|
|
2190
|
+
"type": {
|
|
2191
|
+
"collection": {
|
|
2192
|
+
"elementtype": {
|
|
2193
|
+
"primitive": "string"
|
|
2194
|
+
},
|
|
2195
|
+
"kind": "array"
|
|
2196
|
+
}
|
|
2197
|
+
}
|
|
2198
|
+
},
|
|
2199
|
+
{
|
|
2200
|
+
"abstract": true,
|
|
2201
|
+
"docs": {
|
|
2202
|
+
"default": "\"9\"",
|
|
2203
|
+
"stability": "experimental",
|
|
2204
|
+
"summary": "The version of PNPM to use if using PNPM as a package manager."
|
|
2205
|
+
},
|
|
2206
|
+
"immutable": true,
|
|
2207
|
+
"locationInModule": {
|
|
2208
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2209
|
+
"line": 756
|
|
2210
|
+
},
|
|
2211
|
+
"name": "pnpmVersion",
|
|
2212
|
+
"optional": true,
|
|
2213
|
+
"type": {
|
|
2214
|
+
"primitive": "string"
|
|
2215
|
+
}
|
|
2216
|
+
},
|
|
2217
|
+
{
|
|
2218
|
+
"abstract": true,
|
|
2219
|
+
"docs": {
|
|
2220
|
+
"default": "[]",
|
|
2221
|
+
"stability": "experimental",
|
|
2222
|
+
"summary": "Steps to execute after build as part of the release workflow."
|
|
2223
|
+
},
|
|
2224
|
+
"immutable": true,
|
|
2225
|
+
"locationInModule": {
|
|
2226
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2227
|
+
"line": 650
|
|
2228
|
+
},
|
|
2229
|
+
"name": "postBuildSteps",
|
|
2230
|
+
"optional": true,
|
|
2231
|
+
"type": {
|
|
2232
|
+
"collection": {
|
|
2233
|
+
"elementtype": {
|
|
2234
|
+
"fqn": "projen.github.workflows.JobStep"
|
|
2235
|
+
},
|
|
2236
|
+
"kind": "array"
|
|
2237
|
+
}
|
|
2238
|
+
}
|
|
2239
|
+
},
|
|
2240
|
+
{
|
|
2241
|
+
"abstract": true,
|
|
2242
|
+
"docs": {
|
|
2243
|
+
"default": "- normal semantic versions",
|
|
2244
|
+
"stability": "experimental",
|
|
2245
|
+
"summary": "Bump versions from the default branch as pre-releases (e.g. \"beta\", \"alpha\", \"pre\")."
|
|
2246
|
+
},
|
|
2247
|
+
"immutable": true,
|
|
2248
|
+
"locationInModule": {
|
|
2249
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2250
|
+
"line": 644
|
|
2251
|
+
},
|
|
2252
|
+
"name": "prerelease",
|
|
2253
|
+
"optional": true,
|
|
2254
|
+
"type": {
|
|
2255
|
+
"primitive": "string"
|
|
2256
|
+
}
|
|
2257
|
+
},
|
|
2258
|
+
{
|
|
2259
|
+
"abstract": true,
|
|
2260
|
+
"docs": {
|
|
2261
|
+
"default": "false",
|
|
2262
|
+
"stability": "experimental",
|
|
2263
|
+
"summary": "Setup prettier."
|
|
2264
|
+
},
|
|
2265
|
+
"immutable": true,
|
|
2266
|
+
"locationInModule": {
|
|
2267
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2268
|
+
"line": 372
|
|
2269
|
+
},
|
|
2270
|
+
"name": "prettier",
|
|
2271
|
+
"optional": true,
|
|
2272
|
+
"type": {
|
|
2273
|
+
"primitive": "boolean"
|
|
2274
|
+
}
|
|
2275
|
+
},
|
|
2276
|
+
{
|
|
2277
|
+
"abstract": true,
|
|
2278
|
+
"docs": {
|
|
2279
|
+
"default": "- default options",
|
|
2280
|
+
"stability": "experimental",
|
|
2281
|
+
"summary": "Prettier options."
|
|
2282
|
+
},
|
|
2283
|
+
"immutable": true,
|
|
2284
|
+
"locationInModule": {
|
|
2285
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2286
|
+
"line": 366
|
|
2287
|
+
},
|
|
2288
|
+
"name": "prettierOptions",
|
|
2289
|
+
"optional": true,
|
|
2290
|
+
"type": {
|
|
2291
|
+
"fqn": "projen.javascript.PrettierOptions"
|
|
2292
|
+
}
|
|
2293
|
+
},
|
|
2294
|
+
{
|
|
2295
|
+
"abstract": true,
|
|
2296
|
+
"docs": {
|
|
2297
|
+
"default": "ProjectType.UNKNOWN",
|
|
2298
|
+
"deprecated": "no longer supported at the base project level",
|
|
2299
|
+
"stability": "deprecated",
|
|
2300
|
+
"summary": "Which type of project this is (library/app)."
|
|
2301
|
+
},
|
|
2302
|
+
"immutable": true,
|
|
2303
|
+
"locationInModule": {
|
|
2304
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2305
|
+
"line": 1054
|
|
2306
|
+
},
|
|
2307
|
+
"name": "projectType",
|
|
2308
|
+
"optional": true,
|
|
2309
|
+
"type": {
|
|
2310
|
+
"fqn": "projen.ProjectType"
|
|
2311
|
+
}
|
|
2312
|
+
},
|
|
2313
|
+
{
|
|
2314
|
+
"abstract": true,
|
|
2315
|
+
"docs": {
|
|
2316
|
+
"default": "\"npx projen\"",
|
|
2317
|
+
"remarks": "Can be used to customize in special environments.",
|
|
2318
|
+
"stability": "experimental",
|
|
2319
|
+
"summary": "The shell command to use in order to run the projen CLI."
|
|
2320
|
+
},
|
|
2321
|
+
"immutable": true,
|
|
2322
|
+
"locationInModule": {
|
|
2323
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2324
|
+
"line": 1152
|
|
2325
|
+
},
|
|
2326
|
+
"name": "projenCommand",
|
|
2327
|
+
"optional": true,
|
|
2328
|
+
"type": {
|
|
2329
|
+
"primitive": "string"
|
|
2330
|
+
}
|
|
2331
|
+
},
|
|
2332
|
+
{
|
|
2333
|
+
"abstract": true,
|
|
2334
|
+
"docs": {
|
|
2335
|
+
"default": "- use a personal access token named PROJEN_GITHUB_TOKEN",
|
|
2336
|
+
"stability": "experimental",
|
|
2337
|
+
"summary": "Choose a method of providing GitHub API access for projen workflows."
|
|
2338
|
+
},
|
|
2339
|
+
"immutable": true,
|
|
2340
|
+
"locationInModule": {
|
|
2341
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2342
|
+
"line": 1047
|
|
2343
|
+
},
|
|
2344
|
+
"name": "projenCredentials",
|
|
2345
|
+
"optional": true,
|
|
2346
|
+
"type": {
|
|
2347
|
+
"fqn": "projen.github.GithubCredentials"
|
|
2348
|
+
}
|
|
2349
|
+
},
|
|
2350
|
+
{
|
|
2351
|
+
"abstract": true,
|
|
2352
|
+
"docs": {
|
|
2353
|
+
"default": "- true if not a subproject",
|
|
2354
|
+
"stability": "experimental",
|
|
2355
|
+
"summary": "Indicates of \"projen\" should be installed as a devDependency."
|
|
2356
|
+
},
|
|
2357
|
+
"immutable": true,
|
|
2358
|
+
"locationInModule": {
|
|
2359
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2360
|
+
"line": 360
|
|
2361
|
+
},
|
|
2362
|
+
"name": "projenDevDependency",
|
|
2363
|
+
"optional": true,
|
|
2364
|
+
"type": {
|
|
2365
|
+
"primitive": "boolean"
|
|
2366
|
+
}
|
|
2367
|
+
},
|
|
2368
|
+
{
|
|
2369
|
+
"abstract": true,
|
|
2370
|
+
"docs": {
|
|
2371
|
+
"default": "- true if projenrcJson is false",
|
|
2372
|
+
"stability": "experimental",
|
|
2373
|
+
"summary": "Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation."
|
|
2374
|
+
},
|
|
2375
|
+
"immutable": true,
|
|
2376
|
+
"locationInModule": {
|
|
2377
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2378
|
+
"line": 354
|
|
2379
|
+
},
|
|
2380
|
+
"name": "projenrcJs",
|
|
2381
|
+
"optional": true,
|
|
2382
|
+
"type": {
|
|
2383
|
+
"primitive": "boolean"
|
|
2384
|
+
}
|
|
2385
|
+
},
|
|
2386
|
+
{
|
|
2387
|
+
"abstract": true,
|
|
2388
|
+
"docs": {
|
|
2389
|
+
"default": "false",
|
|
2390
|
+
"stability": "experimental",
|
|
2391
|
+
"summary": "Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation."
|
|
2392
|
+
},
|
|
2393
|
+
"immutable": true,
|
|
2394
|
+
"locationInModule": {
|
|
2395
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2396
|
+
"line": 1145
|
|
2397
|
+
},
|
|
2398
|
+
"name": "projenrcJson",
|
|
2399
|
+
"optional": true,
|
|
2400
|
+
"type": {
|
|
2401
|
+
"primitive": "boolean"
|
|
2402
|
+
}
|
|
2403
|
+
},
|
|
2404
|
+
{
|
|
2405
|
+
"abstract": true,
|
|
2406
|
+
"docs": {
|
|
2407
|
+
"default": "- default options",
|
|
2408
|
+
"stability": "experimental",
|
|
2409
|
+
"summary": "Options for .projenrc.json."
|
|
2410
|
+
},
|
|
2411
|
+
"immutable": true,
|
|
2412
|
+
"locationInModule": {
|
|
2413
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2414
|
+
"line": 1139
|
|
2415
|
+
},
|
|
2416
|
+
"name": "projenrcJsonOptions",
|
|
2417
|
+
"optional": true,
|
|
2418
|
+
"type": {
|
|
2419
|
+
"fqn": "projen.ProjenrcJsonOptions"
|
|
2420
|
+
}
|
|
2421
|
+
},
|
|
2422
|
+
{
|
|
2423
|
+
"abstract": true,
|
|
2424
|
+
"docs": {
|
|
2425
|
+
"default": "- default options",
|
|
2426
|
+
"stability": "experimental",
|
|
2427
|
+
"summary": "Options for .projenrc.js."
|
|
2428
|
+
},
|
|
2429
|
+
"immutable": true,
|
|
2430
|
+
"locationInModule": {
|
|
2431
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2432
|
+
"line": 348
|
|
2433
|
+
},
|
|
2434
|
+
"name": "projenrcJsOptions",
|
|
2435
|
+
"optional": true,
|
|
2436
|
+
"type": {
|
|
2437
|
+
"fqn": "projen.javascript.ProjenrcOptions"
|
|
2438
|
+
}
|
|
2439
|
+
},
|
|
2440
|
+
{
|
|
2441
|
+
"abstract": true,
|
|
2442
|
+
"docs": {
|
|
2443
|
+
"custom": {
|
|
2444
|
+
"pjnew": "true"
|
|
2445
|
+
},
|
|
2446
|
+
"default": "false",
|
|
2447
|
+
"stability": "experimental",
|
|
2448
|
+
"summary": "Use TypeScript for your projenrc file (`.projenrc.ts`)."
|
|
2449
|
+
},
|
|
2450
|
+
"immutable": true,
|
|
2451
|
+
"locationInModule": {
|
|
2452
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2453
|
+
"line": 232
|
|
2454
|
+
},
|
|
2455
|
+
"name": "projenrcTs",
|
|
2456
|
+
"optional": true,
|
|
2457
|
+
"type": {
|
|
2458
|
+
"primitive": "boolean"
|
|
2459
|
+
}
|
|
2460
|
+
},
|
|
2461
|
+
{
|
|
2462
|
+
"abstract": true,
|
|
2463
|
+
"docs": {
|
|
2464
|
+
"stability": "experimental",
|
|
2465
|
+
"summary": "Options for .projenrc.ts."
|
|
2466
|
+
},
|
|
2467
|
+
"immutable": true,
|
|
2468
|
+
"locationInModule": {
|
|
2469
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2470
|
+
"line": 225
|
|
2471
|
+
},
|
|
2472
|
+
"name": "projenrcTsOptions",
|
|
2473
|
+
"optional": true,
|
|
2474
|
+
"type": {
|
|
2475
|
+
"fqn": "projen.typescript.ProjenrcOptions"
|
|
2476
|
+
}
|
|
2477
|
+
},
|
|
2478
|
+
{
|
|
2479
|
+
"abstract": true,
|
|
2480
|
+
"docs": {
|
|
2481
|
+
"default": "\"PROJEN_GITHUB_TOKEN\"",
|
|
2482
|
+
"deprecated": "use `projenCredentials`",
|
|
2483
|
+
"remarks": "This token needs to have the `repo`, `workflows`\nand `packages` scope.",
|
|
2484
|
+
"stability": "deprecated",
|
|
2485
|
+
"summary": "The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows."
|
|
2486
|
+
},
|
|
2487
|
+
"immutable": true,
|
|
2488
|
+
"locationInModule": {
|
|
2489
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2490
|
+
"line": 1041
|
|
2491
|
+
},
|
|
2492
|
+
"name": "projenTokenSecret",
|
|
2493
|
+
"optional": true,
|
|
2494
|
+
"type": {
|
|
2495
|
+
"primitive": "string"
|
|
2496
|
+
}
|
|
2497
|
+
},
|
|
2498
|
+
{
|
|
2499
|
+
"abstract": true,
|
|
2500
|
+
"docs": {
|
|
2501
|
+
"default": "- Defaults to the latest version.",
|
|
2502
|
+
"stability": "experimental",
|
|
2503
|
+
"summary": "Version of projen to install."
|
|
2504
|
+
},
|
|
2505
|
+
"immutable": true,
|
|
2506
|
+
"locationInModule": {
|
|
2507
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2508
|
+
"line": 342
|
|
2509
|
+
},
|
|
2510
|
+
"name": "projenVersion",
|
|
2511
|
+
"optional": true,
|
|
2512
|
+
"type": {
|
|
2513
|
+
"primitive": "string"
|
|
2514
|
+
}
|
|
2515
|
+
},
|
|
2516
|
+
{
|
|
2517
|
+
"abstract": true,
|
|
2518
|
+
"docs": {
|
|
2519
|
+
"default": "false",
|
|
2520
|
+
"stability": "experimental",
|
|
2521
|
+
"summary": "Instead of actually publishing to package managers, just print the publishing command."
|
|
2522
|
+
},
|
|
2523
|
+
"immutable": true,
|
|
2524
|
+
"locationInModule": {
|
|
2525
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2526
|
+
"line": 638
|
|
2527
|
+
},
|
|
2528
|
+
"name": "publishDryRun",
|
|
2529
|
+
"optional": true,
|
|
2530
|
+
"type": {
|
|
2531
|
+
"primitive": "boolean"
|
|
2532
|
+
}
|
|
2533
|
+
},
|
|
2534
|
+
{
|
|
2535
|
+
"abstract": true,
|
|
2536
|
+
"docs": {
|
|
2537
|
+
"default": "false",
|
|
2538
|
+
"remarks": "Normally, publishing only happens within automated workflows. Enable this\nin order to create a publishing task for each publishing activity.",
|
|
2539
|
+
"stability": "experimental",
|
|
2540
|
+
"summary": "Define publishing tasks that can be executed manually as well as workflows."
|
|
2541
|
+
},
|
|
2542
|
+
"immutable": true,
|
|
2543
|
+
"locationInModule": {
|
|
2544
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2545
|
+
"line": 632
|
|
2546
|
+
},
|
|
2547
|
+
"name": "publishTasks",
|
|
2548
|
+
"optional": true,
|
|
2549
|
+
"type": {
|
|
2550
|
+
"primitive": "boolean"
|
|
2551
|
+
}
|
|
2552
|
+
},
|
|
2553
|
+
{
|
|
2554
|
+
"abstract": true,
|
|
2555
|
+
"docs": {
|
|
2556
|
+
"default": "true",
|
|
2557
|
+
"stability": "experimental",
|
|
2558
|
+
"summary": "Include a GitHub pull request template."
|
|
2559
|
+
},
|
|
2560
|
+
"immutable": true,
|
|
2561
|
+
"locationInModule": {
|
|
2562
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2563
|
+
"line": 336
|
|
2564
|
+
},
|
|
2565
|
+
"name": "pullRequestTemplate",
|
|
2566
|
+
"optional": true,
|
|
2567
|
+
"type": {
|
|
2568
|
+
"primitive": "boolean"
|
|
2569
|
+
}
|
|
2570
|
+
},
|
|
2571
|
+
{
|
|
2572
|
+
"abstract": true,
|
|
2573
|
+
"docs": {
|
|
2574
|
+
"default": "- default content",
|
|
2575
|
+
"stability": "experimental",
|
|
2576
|
+
"summary": "The contents of the pull request template."
|
|
2577
|
+
},
|
|
2578
|
+
"immutable": true,
|
|
2579
|
+
"locationInModule": {
|
|
2580
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2581
|
+
"line": 330
|
|
2582
|
+
},
|
|
2583
|
+
"name": "pullRequestTemplateContents",
|
|
2584
|
+
"optional": true,
|
|
2585
|
+
"type": {
|
|
2586
|
+
"collection": {
|
|
2587
|
+
"elementtype": {
|
|
2588
|
+
"primitive": "string"
|
|
2589
|
+
},
|
|
2590
|
+
"kind": "array"
|
|
2591
|
+
}
|
|
2592
|
+
}
|
|
2593
|
+
},
|
|
2594
|
+
{
|
|
2595
|
+
"abstract": true,
|
|
2596
|
+
"docs": {
|
|
2597
|
+
"stability": "stable",
|
|
2598
|
+
"summary": "Configuration of the README.md file."
|
|
2599
|
+
},
|
|
2600
|
+
"immutable": true,
|
|
2601
|
+
"locationInModule": {
|
|
2602
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2603
|
+
"line": 1032
|
|
2604
|
+
},
|
|
2605
|
+
"name": "readme",
|
|
2606
|
+
"optional": true,
|
|
2607
|
+
"type": {
|
|
2608
|
+
"fqn": "projen-modules.ReadmeOptions"
|
|
2609
|
+
}
|
|
2610
|
+
},
|
|
2611
|
+
{
|
|
2612
|
+
"abstract": true,
|
|
2613
|
+
"docs": {
|
|
2614
|
+
"default": "ReleasableCommits.everyCommit()",
|
|
2615
|
+
"stability": "experimental",
|
|
2616
|
+
"summary": "Find commits that should be considered releasable Used to decide if a release is required."
|
|
2617
|
+
},
|
|
2618
|
+
"immutable": true,
|
|
2619
|
+
"locationInModule": {
|
|
2620
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2621
|
+
"line": 624
|
|
2622
|
+
},
|
|
2623
|
+
"name": "releasableCommits",
|
|
2624
|
+
"optional": true,
|
|
2625
|
+
"type": {
|
|
2626
|
+
"fqn": "projen.ReleasableCommits"
|
|
2627
|
+
}
|
|
2628
|
+
},
|
|
2629
|
+
{
|
|
2630
|
+
"abstract": true,
|
|
2631
|
+
"docs": {
|
|
2632
|
+
"default": "- true (false for subprojects)",
|
|
2633
|
+
"stability": "experimental",
|
|
2634
|
+
"summary": "Add release management to this project."
|
|
2635
|
+
},
|
|
2636
|
+
"immutable": true,
|
|
2637
|
+
"locationInModule": {
|
|
2638
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2639
|
+
"line": 324
|
|
2640
|
+
},
|
|
2641
|
+
"name": "release",
|
|
2642
|
+
"optional": true,
|
|
2643
|
+
"type": {
|
|
2644
|
+
"primitive": "boolean"
|
|
2645
|
+
}
|
|
2646
|
+
},
|
|
2647
|
+
{
|
|
2648
|
+
"abstract": true,
|
|
2649
|
+
"docs": {
|
|
2650
|
+
"default": "- no additional branches are used for release. you can use\n`addBranch()` to add additional branches.",
|
|
2651
|
+
"remarks": "A workflow will be created for each\nrelease branch which will publish releases from commits in this branch.\nEach release branch _must_ be assigned a major version number which is used\nto enforce that versions published from that branch always use that major\nversion. If multiple branches are used, the `majorVersion` field must also\nbe provided for the default branch.",
|
|
2652
|
+
"stability": "experimental",
|
|
2653
|
+
"summary": "Defines additional release branches."
|
|
2654
|
+
},
|
|
2655
|
+
"immutable": true,
|
|
2656
|
+
"locationInModule": {
|
|
2657
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2658
|
+
"line": 618
|
|
2659
|
+
},
|
|
2660
|
+
"name": "releaseBranches",
|
|
2661
|
+
"optional": true,
|
|
2662
|
+
"type": {
|
|
2663
|
+
"collection": {
|
|
2664
|
+
"elementtype": {
|
|
2665
|
+
"fqn": "projen.release.BranchOptions"
|
|
2666
|
+
},
|
|
2667
|
+
"kind": "map"
|
|
2668
|
+
}
|
|
2669
|
+
}
|
|
2670
|
+
},
|
|
2671
|
+
{
|
|
2672
|
+
"abstract": true,
|
|
2673
|
+
"docs": {
|
|
2674
|
+
"default": "true",
|
|
2675
|
+
"deprecated": "Use `releaseTrigger: ReleaseTrigger.continuous()` instead",
|
|
2676
|
+
"stability": "deprecated",
|
|
2677
|
+
"summary": "Automatically release new versions every commit to one of branches in `releaseBranches`."
|
|
2678
|
+
},
|
|
2679
|
+
"immutable": true,
|
|
2680
|
+
"locationInModule": {
|
|
2681
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2682
|
+
"line": 605
|
|
2683
|
+
},
|
|
2684
|
+
"name": "releaseEveryCommit",
|
|
2685
|
+
"optional": true,
|
|
2686
|
+
"type": {
|
|
2687
|
+
"primitive": "boolean"
|
|
2688
|
+
}
|
|
2689
|
+
},
|
|
2690
|
+
{
|
|
2691
|
+
"abstract": true,
|
|
2692
|
+
"docs": {
|
|
2693
|
+
"default": "false",
|
|
2694
|
+
"stability": "experimental",
|
|
2695
|
+
"summary": "Create a github issue on every failed publishing task."
|
|
2696
|
+
},
|
|
2697
|
+
"immutable": true,
|
|
2698
|
+
"locationInModule": {
|
|
2699
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2700
|
+
"line": 598
|
|
2701
|
+
},
|
|
2702
|
+
"name": "releaseFailureIssue",
|
|
2703
|
+
"optional": true,
|
|
2704
|
+
"type": {
|
|
2705
|
+
"primitive": "boolean"
|
|
2706
|
+
}
|
|
2707
|
+
},
|
|
2708
|
+
{
|
|
2709
|
+
"abstract": true,
|
|
2710
|
+
"docs": {
|
|
2711
|
+
"default": "\"failed-release\"",
|
|
2712
|
+
"remarks": "Only applies if `releaseFailureIssue` is true.",
|
|
2713
|
+
"stability": "experimental",
|
|
2714
|
+
"summary": "The label to apply to issues indicating publish failures."
|
|
2715
|
+
},
|
|
2716
|
+
"immutable": true,
|
|
2717
|
+
"locationInModule": {
|
|
2718
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2719
|
+
"line": 592
|
|
2720
|
+
},
|
|
2721
|
+
"name": "releaseFailureIssueLabel",
|
|
2722
|
+
"optional": true,
|
|
2723
|
+
"type": {
|
|
2724
|
+
"primitive": "string"
|
|
2725
|
+
}
|
|
2726
|
+
},
|
|
2727
|
+
{
|
|
2728
|
+
"abstract": true,
|
|
2729
|
+
"docs": {
|
|
2730
|
+
"default": "- no scheduled releases",
|
|
2731
|
+
"deprecated": "Use `releaseTrigger: ReleaseTrigger.scheduled()` instead",
|
|
2732
|
+
"stability": "deprecated",
|
|
2733
|
+
"summary": "CRON schedule to trigger new releases."
|
|
2734
|
+
},
|
|
2735
|
+
"immutable": true,
|
|
2736
|
+
"locationInModule": {
|
|
2737
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2738
|
+
"line": 585
|
|
2739
|
+
},
|
|
2740
|
+
"name": "releaseSchedule",
|
|
2741
|
+
"optional": true,
|
|
2742
|
+
"type": {
|
|
2743
|
+
"primitive": "string"
|
|
2744
|
+
}
|
|
2745
|
+
},
|
|
2746
|
+
{
|
|
2747
|
+
"abstract": true,
|
|
2748
|
+
"docs": {
|
|
2749
|
+
"default": "\"v\"",
|
|
2750
|
+
"remarks": "Useful if you are releasing on multiple branches with overlapping version numbers.\nNote: this prefix is used to detect the latest tagged version\nwhen bumping, so if you change this on a project with an existing version\nhistory, you may need to manually tag your latest release\nwith the new prefix.",
|
|
2751
|
+
"stability": "experimental",
|
|
2752
|
+
"summary": "Automatically add the given prefix to release tags."
|
|
2753
|
+
},
|
|
2754
|
+
"immutable": true,
|
|
2755
|
+
"locationInModule": {
|
|
2756
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2757
|
+
"line": 578
|
|
2758
|
+
},
|
|
2759
|
+
"name": "releaseTagPrefix",
|
|
2760
|
+
"optional": true,
|
|
2761
|
+
"type": {
|
|
2762
|
+
"primitive": "string"
|
|
2763
|
+
}
|
|
2764
|
+
},
|
|
2765
|
+
{
|
|
2766
|
+
"abstract": true,
|
|
2767
|
+
"docs": {
|
|
2768
|
+
"default": "false",
|
|
2769
|
+
"stability": "experimental",
|
|
2770
|
+
"summary": "Automatically release to npm when new versions are introduced."
|
|
2771
|
+
},
|
|
2772
|
+
"immutable": true,
|
|
2773
|
+
"locationInModule": {
|
|
2774
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2775
|
+
"line": 318
|
|
2776
|
+
},
|
|
2777
|
+
"name": "releaseToNpm",
|
|
2778
|
+
"optional": true,
|
|
2779
|
+
"type": {
|
|
2780
|
+
"primitive": "boolean"
|
|
2781
|
+
}
|
|
2782
|
+
},
|
|
2783
|
+
{
|
|
2784
|
+
"abstract": true,
|
|
2785
|
+
"docs": {
|
|
2786
|
+
"default": "- Continuous releases (`ReleaseTrigger.continuous()`)",
|
|
2787
|
+
"stability": "experimental",
|
|
2788
|
+
"summary": "The release trigger to use."
|
|
2789
|
+
},
|
|
2790
|
+
"immutable": true,
|
|
2791
|
+
"locationInModule": {
|
|
2792
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2793
|
+
"line": 568
|
|
2794
|
+
},
|
|
2795
|
+
"name": "releaseTrigger",
|
|
2796
|
+
"optional": true,
|
|
2797
|
+
"type": {
|
|
2798
|
+
"fqn": "projen.release.ReleaseTrigger"
|
|
2799
|
+
}
|
|
2800
|
+
},
|
|
2801
|
+
{
|
|
2802
|
+
"abstract": true,
|
|
2803
|
+
"docs": {
|
|
2804
|
+
"default": "- true if not a subproject",
|
|
2805
|
+
"deprecated": "see `release`.",
|
|
2806
|
+
"stability": "deprecated",
|
|
2807
|
+
"summary": "DEPRECATED: renamed to `release`."
|
|
2808
|
+
},
|
|
2809
|
+
"immutable": true,
|
|
2810
|
+
"locationInModule": {
|
|
2811
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2812
|
+
"line": 312
|
|
2813
|
+
},
|
|
2814
|
+
"name": "releaseWorkflow",
|
|
2815
|
+
"optional": true,
|
|
2816
|
+
"type": {
|
|
2817
|
+
"primitive": "boolean"
|
|
2818
|
+
}
|
|
2819
|
+
},
|
|
2820
|
+
{
|
|
2821
|
+
"abstract": true,
|
|
2822
|
+
"docs": {
|
|
2823
|
+
"default": "\"release\"",
|
|
2824
|
+
"stability": "experimental",
|
|
2825
|
+
"summary": "The name of the default release workflow."
|
|
2826
|
+
},
|
|
2827
|
+
"immutable": true,
|
|
2828
|
+
"locationInModule": {
|
|
2829
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2830
|
+
"line": 562
|
|
2831
|
+
},
|
|
2832
|
+
"name": "releaseWorkflowName",
|
|
2833
|
+
"optional": true,
|
|
2834
|
+
"type": {
|
|
2835
|
+
"primitive": "string"
|
|
2836
|
+
}
|
|
2837
|
+
},
|
|
2838
|
+
{
|
|
2839
|
+
"abstract": true,
|
|
2840
|
+
"docs": {
|
|
2841
|
+
"stability": "experimental",
|
|
2842
|
+
"summary": "A set of workflow steps to execute in order to setup the workflow container."
|
|
2843
|
+
},
|
|
2844
|
+
"immutable": true,
|
|
2845
|
+
"locationInModule": {
|
|
2846
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2847
|
+
"line": 556
|
|
2848
|
+
},
|
|
2849
|
+
"name": "releaseWorkflowSetupSteps",
|
|
2850
|
+
"optional": true,
|
|
2851
|
+
"type": {
|
|
2852
|
+
"collection": {
|
|
2853
|
+
"elementtype": {
|
|
2854
|
+
"fqn": "projen.github.workflows.JobStep"
|
|
2855
|
+
},
|
|
2856
|
+
"kind": "array"
|
|
2857
|
+
}
|
|
2858
|
+
}
|
|
2859
|
+
},
|
|
2860
|
+
{
|
|
2861
|
+
"abstract": true,
|
|
2862
|
+
"docs": {
|
|
2863
|
+
"default": "false",
|
|
2864
|
+
"stability": "experimental",
|
|
2865
|
+
"summary": "Use renovatebot to handle dependency upgrades."
|
|
2866
|
+
},
|
|
2867
|
+
"immutable": true,
|
|
2868
|
+
"locationInModule": {
|
|
2869
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2870
|
+
"line": 1133
|
|
2871
|
+
},
|
|
2872
|
+
"name": "renovatebot",
|
|
2873
|
+
"optional": true,
|
|
2874
|
+
"type": {
|
|
2875
|
+
"primitive": "boolean"
|
|
2876
|
+
}
|
|
2877
|
+
},
|
|
2878
|
+
{
|
|
2879
|
+
"abstract": true,
|
|
2880
|
+
"docs": {
|
|
2881
|
+
"default": "- default options",
|
|
2882
|
+
"stability": "experimental",
|
|
2883
|
+
"summary": "Options for renovatebot."
|
|
2884
|
+
},
|
|
2885
|
+
"immutable": true,
|
|
2886
|
+
"locationInModule": {
|
|
2887
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2888
|
+
"line": 1127
|
|
2889
|
+
},
|
|
2890
|
+
"name": "renovatebotOptions",
|
|
2891
|
+
"optional": true,
|
|
2892
|
+
"type": {
|
|
2893
|
+
"fqn": "projen.RenovatebotOptions"
|
|
2894
|
+
}
|
|
2895
|
+
},
|
|
2896
|
+
{
|
|
2897
|
+
"abstract": true,
|
|
2898
|
+
"docs": {
|
|
2899
|
+
"remarks": "See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository",
|
|
2900
|
+
"stability": "experimental",
|
|
2901
|
+
"summary": "The repository is the location where the actual code for your package lives."
|
|
2902
|
+
},
|
|
2903
|
+
"immutable": true,
|
|
2904
|
+
"locationInModule": {
|
|
2905
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2906
|
+
"line": 750
|
|
2907
|
+
},
|
|
2908
|
+
"name": "repository",
|
|
2909
|
+
"optional": true,
|
|
2910
|
+
"type": {
|
|
2911
|
+
"primitive": "string"
|
|
2912
|
+
}
|
|
2913
|
+
},
|
|
2914
|
+
{
|
|
2915
|
+
"abstract": true,
|
|
2916
|
+
"docs": {
|
|
2917
|
+
"stability": "experimental",
|
|
2918
|
+
"summary": "If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives."
|
|
2919
|
+
},
|
|
2920
|
+
"immutable": true,
|
|
2921
|
+
"locationInModule": {
|
|
2922
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2923
|
+
"line": 744
|
|
2924
|
+
},
|
|
2925
|
+
"name": "repositoryDirectory",
|
|
2926
|
+
"optional": true,
|
|
2927
|
+
"type": {
|
|
2928
|
+
"primitive": "string"
|
|
2929
|
+
}
|
|
2930
|
+
},
|
|
2931
|
+
{
|
|
2932
|
+
"abstract": true,
|
|
2933
|
+
"docs": {
|
|
2934
|
+
"default": "ApprovalLevel.BROADENING",
|
|
2935
|
+
"stability": "experimental",
|
|
2936
|
+
"summary": "To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them."
|
|
2937
|
+
},
|
|
2938
|
+
"immutable": true,
|
|
2939
|
+
"locationInModule": {
|
|
2940
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2941
|
+
"line": 140
|
|
2942
|
+
},
|
|
2943
|
+
"name": "requireApproval",
|
|
2944
|
+
"optional": true,
|
|
2945
|
+
"type": {
|
|
2946
|
+
"fqn": "projen.awscdk.ApprovalLevel"
|
|
2947
|
+
}
|
|
2948
|
+
},
|
|
2949
|
+
{
|
|
2950
|
+
"abstract": true,
|
|
2951
|
+
"docs": {
|
|
2952
|
+
"default": "true",
|
|
2953
|
+
"stability": "experimental",
|
|
2954
|
+
"summary": "Generate one-time sample in `src/` and `test/` if there are no files there."
|
|
2955
|
+
},
|
|
2956
|
+
"immutable": true,
|
|
2957
|
+
"locationInModule": {
|
|
2958
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2959
|
+
"line": 220
|
|
2960
|
+
},
|
|
2961
|
+
"name": "sampleCode",
|
|
2962
|
+
"optional": true,
|
|
2963
|
+
"type": {
|
|
2964
|
+
"primitive": "boolean"
|
|
2965
|
+
}
|
|
2966
|
+
},
|
|
2967
|
+
{
|
|
2968
|
+
"abstract": true,
|
|
2969
|
+
"docs": {
|
|
2970
|
+
"default": "- fetch all scoped packages from the public npm registry",
|
|
2971
|
+
"stability": "experimental",
|
|
2972
|
+
"summary": "Options for privately hosted scoped packages."
|
|
2973
|
+
},
|
|
2974
|
+
"immutable": true,
|
|
2975
|
+
"locationInModule": {
|
|
2976
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
2977
|
+
"line": 739
|
|
2978
|
+
},
|
|
2979
|
+
"name": "scopedPackagesOptions",
|
|
2980
|
+
"optional": true,
|
|
2981
|
+
"type": {
|
|
2982
|
+
"collection": {
|
|
2983
|
+
"elementtype": {
|
|
2984
|
+
"fqn": "projen.javascript.ScopedPackagesOptions"
|
|
2985
|
+
},
|
|
2986
|
+
"kind": "array"
|
|
2987
|
+
}
|
|
2988
|
+
}
|
|
2989
|
+
},
|
|
2990
|
+
{
|
|
2991
|
+
"abstract": true,
|
|
2992
|
+
"docs": {
|
|
2993
|
+
"default": "{}",
|
|
2994
|
+
"deprecated": "use `project.addTask()` or `package.setScript()`",
|
|
2995
|
+
"remarks": "If a script has the same name as a standard script,\nthe standard script will be overwritten.\nAlso adds the script as a task.",
|
|
2996
|
+
"stability": "deprecated",
|
|
2997
|
+
"summary": "npm scripts to include."
|
|
2998
|
+
},
|
|
2999
|
+
"immutable": true,
|
|
3000
|
+
"locationInModule": {
|
|
3001
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3002
|
+
"line": 733
|
|
3003
|
+
},
|
|
3004
|
+
"name": "scripts",
|
|
3005
|
+
"optional": true,
|
|
3006
|
+
"type": {
|
|
3007
|
+
"collection": {
|
|
3008
|
+
"elementtype": {
|
|
3009
|
+
"primitive": "string"
|
|
3010
|
+
},
|
|
3011
|
+
"kind": "map"
|
|
3012
|
+
}
|
|
3013
|
+
}
|
|
3014
|
+
},
|
|
3015
|
+
{
|
|
3016
|
+
"abstract": true,
|
|
3017
|
+
"docs": {
|
|
3018
|
+
"default": "\"src\"",
|
|
3019
|
+
"stability": "experimental",
|
|
3020
|
+
"summary": "Typescript sources directory."
|
|
3021
|
+
},
|
|
3022
|
+
"immutable": true,
|
|
3023
|
+
"locationInModule": {
|
|
3024
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3025
|
+
"line": 214
|
|
3026
|
+
},
|
|
3027
|
+
"name": "srcdir",
|
|
3028
|
+
"optional": true,
|
|
3029
|
+
"type": {
|
|
3030
|
+
"primitive": "string"
|
|
3031
|
+
}
|
|
3032
|
+
},
|
|
3033
|
+
{
|
|
3034
|
+
"abstract": true,
|
|
3035
|
+
"docs": {
|
|
3036
|
+
"stability": "experimental",
|
|
3037
|
+
"summary": "Package's Stability."
|
|
3038
|
+
},
|
|
3039
|
+
"immutable": true,
|
|
3040
|
+
"locationInModule": {
|
|
3041
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3042
|
+
"line": 723
|
|
3043
|
+
},
|
|
3044
|
+
"name": "stability",
|
|
3045
|
+
"optional": true,
|
|
3046
|
+
"type": {
|
|
3047
|
+
"primitive": "string"
|
|
3048
|
+
}
|
|
3049
|
+
},
|
|
3050
|
+
{
|
|
3051
|
+
"abstract": true,
|
|
3052
|
+
"docs": {
|
|
3053
|
+
"default": "false",
|
|
3054
|
+
"remarks": "See `staleOptions` for options.",
|
|
3055
|
+
"stability": "experimental",
|
|
3056
|
+
"summary": "Auto-close of stale issues and pull request."
|
|
3057
|
+
},
|
|
3058
|
+
"immutable": true,
|
|
3059
|
+
"locationInModule": {
|
|
3060
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3061
|
+
"line": 1028
|
|
3062
|
+
},
|
|
3063
|
+
"name": "stale",
|
|
3064
|
+
"optional": true,
|
|
3065
|
+
"type": {
|
|
3066
|
+
"primitive": "boolean"
|
|
3067
|
+
}
|
|
3068
|
+
},
|
|
3069
|
+
{
|
|
3070
|
+
"abstract": true,
|
|
3071
|
+
"docs": {
|
|
3072
|
+
"default": "- see defaults in `StaleOptions`",
|
|
3073
|
+
"remarks": "To disable set `stale` to `false`.",
|
|
3074
|
+
"stability": "experimental",
|
|
3075
|
+
"summary": "Auto-close stale issues and pull requests."
|
|
3076
|
+
},
|
|
3077
|
+
"immutable": true,
|
|
3078
|
+
"locationInModule": {
|
|
3079
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3080
|
+
"line": 1021
|
|
3081
|
+
},
|
|
3082
|
+
"name": "staleOptions",
|
|
3083
|
+
"optional": true,
|
|
3084
|
+
"type": {
|
|
3085
|
+
"fqn": "projen.github.StaleOptions"
|
|
3086
|
+
}
|
|
3087
|
+
},
|
|
3088
|
+
{
|
|
3089
|
+
"abstract": true,
|
|
3090
|
+
"docs": {
|
|
3091
|
+
"default": "\"test\"",
|
|
3092
|
+
"remarks": "Tests files should be named `xxx.test.ts`.\nIf this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),\nthen tests are going to be compiled into `lib/` and executed as javascript.\nIf the test directory is outside of `src`, then we configure jest to\ncompile the code in-memory.",
|
|
3093
|
+
"stability": "experimental",
|
|
3094
|
+
"summary": "Jest tests directory."
|
|
3095
|
+
},
|
|
3096
|
+
"immutable": true,
|
|
3097
|
+
"locationInModule": {
|
|
3098
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3099
|
+
"line": 208
|
|
3100
|
+
},
|
|
3101
|
+
"name": "testdir",
|
|
3102
|
+
"optional": true,
|
|
3103
|
+
"type": {
|
|
3104
|
+
"primitive": "string"
|
|
3105
|
+
}
|
|
3106
|
+
},
|
|
3107
|
+
{
|
|
3108
|
+
"abstract": true,
|
|
3109
|
+
"docs": {
|
|
3110
|
+
"default": "- default options",
|
|
3111
|
+
"stability": "experimental",
|
|
3112
|
+
"summary": "Custom TSConfig."
|
|
3113
|
+
},
|
|
3114
|
+
"immutable": true,
|
|
3115
|
+
"locationInModule": {
|
|
3116
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3117
|
+
"line": 198
|
|
3118
|
+
},
|
|
3119
|
+
"name": "tsconfig",
|
|
3120
|
+
"optional": true,
|
|
3121
|
+
"type": {
|
|
3122
|
+
"fqn": "projen.javascript.TypescriptConfigOptions"
|
|
3123
|
+
}
|
|
3124
|
+
},
|
|
3125
|
+
{
|
|
3126
|
+
"abstract": true,
|
|
3127
|
+
"docs": {
|
|
3128
|
+
"default": "- use the production tsconfig options",
|
|
3129
|
+
"stability": "experimental",
|
|
3130
|
+
"summary": "Custom tsconfig options for the development tsconfig.json file (used for testing)."
|
|
3131
|
+
},
|
|
3132
|
+
"immutable": true,
|
|
3133
|
+
"locationInModule": {
|
|
3134
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3135
|
+
"line": 192
|
|
3136
|
+
},
|
|
3137
|
+
"name": "tsconfigDev",
|
|
3138
|
+
"optional": true,
|
|
3139
|
+
"type": {
|
|
3140
|
+
"fqn": "projen.javascript.TypescriptConfigOptions"
|
|
3141
|
+
}
|
|
3142
|
+
},
|
|
3143
|
+
{
|
|
3144
|
+
"abstract": true,
|
|
3145
|
+
"docs": {
|
|
3146
|
+
"default": "\"tsconfig.dev.json\"",
|
|
3147
|
+
"stability": "experimental",
|
|
3148
|
+
"summary": "The name of the development tsconfig.json file."
|
|
3149
|
+
},
|
|
3150
|
+
"immutable": true,
|
|
3151
|
+
"locationInModule": {
|
|
3152
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3153
|
+
"line": 186
|
|
3154
|
+
},
|
|
3155
|
+
"name": "tsconfigDevFile",
|
|
3156
|
+
"optional": true,
|
|
3157
|
+
"type": {
|
|
3158
|
+
"primitive": "string"
|
|
3159
|
+
}
|
|
3160
|
+
},
|
|
3161
|
+
{
|
|
3162
|
+
"abstract": true,
|
|
3163
|
+
"docs": {
|
|
3164
|
+
"stability": "experimental",
|
|
3165
|
+
"summary": "Options for ts-jest."
|
|
3166
|
+
},
|
|
3167
|
+
"immutable": true,
|
|
3168
|
+
"locationInModule": {
|
|
3169
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3170
|
+
"line": 180
|
|
3171
|
+
},
|
|
3172
|
+
"name": "tsJestOptions",
|
|
3173
|
+
"optional": true,
|
|
3174
|
+
"type": {
|
|
3175
|
+
"fqn": "projen.typescript.TsJestOptions"
|
|
3176
|
+
}
|
|
3177
|
+
},
|
|
3178
|
+
{
|
|
3179
|
+
"abstract": true,
|
|
3180
|
+
"docs": {
|
|
3181
|
+
"default": "\"latest\"",
|
|
3182
|
+
"remarks": "NOTE: Typescript is not semantically versioned and should remain on the\nsame minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).",
|
|
3183
|
+
"stability": "experimental",
|
|
3184
|
+
"summary": "TypeScript version to use."
|
|
3185
|
+
},
|
|
3186
|
+
"immutable": true,
|
|
3187
|
+
"locationInModule": {
|
|
3188
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3189
|
+
"line": 175
|
|
3190
|
+
},
|
|
3191
|
+
"name": "typescriptVersion",
|
|
3192
|
+
"optional": true,
|
|
3193
|
+
"type": {
|
|
3194
|
+
"primitive": "string"
|
|
3195
|
+
}
|
|
3196
|
+
},
|
|
3197
|
+
{
|
|
3198
|
+
"abstract": true,
|
|
3199
|
+
"docs": {
|
|
3200
|
+
"default": "- standard configuration applicable for GitHub repositories",
|
|
3201
|
+
"remarks": "Given values either append to default configuration or overwrite values in it.",
|
|
3202
|
+
"stability": "experimental",
|
|
3203
|
+
"summary": "Custom configuration used when creating changelog with commit-and-tag-version package."
|
|
3204
|
+
},
|
|
3205
|
+
"immutable": true,
|
|
3206
|
+
"locationInModule": {
|
|
3207
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3208
|
+
"line": 551
|
|
3209
|
+
},
|
|
3210
|
+
"name": "versionrcOptions",
|
|
3211
|
+
"optional": true,
|
|
3212
|
+
"type": {
|
|
3213
|
+
"collection": {
|
|
3214
|
+
"elementtype": {
|
|
3215
|
+
"primitive": "any"
|
|
3216
|
+
},
|
|
3217
|
+
"kind": "map"
|
|
3218
|
+
}
|
|
3219
|
+
}
|
|
3220
|
+
},
|
|
3221
|
+
{
|
|
3222
|
+
"abstract": true,
|
|
3223
|
+
"docs": {
|
|
3224
|
+
"default": "true",
|
|
3225
|
+
"remarks": "Enabled by default for root projects. Disabled for non-root projects.",
|
|
3226
|
+
"stability": "experimental",
|
|
3227
|
+
"summary": "Enable VSCode integration."
|
|
3228
|
+
},
|
|
3229
|
+
"immutable": true,
|
|
3230
|
+
"locationInModule": {
|
|
3231
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3232
|
+
"line": 1014
|
|
3233
|
+
},
|
|
3234
|
+
"name": "vscode",
|
|
3235
|
+
"optional": true,
|
|
3236
|
+
"type": {
|
|
3237
|
+
"primitive": "boolean"
|
|
3238
|
+
}
|
|
3239
|
+
},
|
|
3240
|
+
{
|
|
3241
|
+
"abstract": true,
|
|
3242
|
+
"docs": {
|
|
3243
|
+
"default": "[]",
|
|
3244
|
+
"stability": "experimental",
|
|
3245
|
+
"summary": "Glob patterns to exclude from `cdk watch`."
|
|
3246
|
+
},
|
|
3247
|
+
"immutable": true,
|
|
3248
|
+
"locationInModule": {
|
|
3249
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3250
|
+
"line": 134
|
|
3251
|
+
},
|
|
3252
|
+
"name": "watchExcludes",
|
|
3253
|
+
"optional": true,
|
|
3254
|
+
"type": {
|
|
3255
|
+
"collection": {
|
|
3256
|
+
"elementtype": {
|
|
3257
|
+
"primitive": "string"
|
|
3258
|
+
},
|
|
3259
|
+
"kind": "array"
|
|
3260
|
+
}
|
|
3261
|
+
}
|
|
3262
|
+
},
|
|
3263
|
+
{
|
|
3264
|
+
"abstract": true,
|
|
3265
|
+
"docs": {
|
|
3266
|
+
"default": "[]",
|
|
3267
|
+
"stability": "experimental",
|
|
3268
|
+
"summary": "Glob patterns to include in `cdk watch`."
|
|
3269
|
+
},
|
|
3270
|
+
"immutable": true,
|
|
3271
|
+
"locationInModule": {
|
|
3272
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3273
|
+
"line": 128
|
|
3274
|
+
},
|
|
3275
|
+
"name": "watchIncludes",
|
|
3276
|
+
"optional": true,
|
|
3277
|
+
"type": {
|
|
3278
|
+
"collection": {
|
|
3279
|
+
"elementtype": {
|
|
3280
|
+
"primitive": "string"
|
|
3281
|
+
},
|
|
3282
|
+
"kind": "array"
|
|
3283
|
+
}
|
|
3284
|
+
}
|
|
3285
|
+
},
|
|
3286
|
+
{
|
|
3287
|
+
"abstract": true,
|
|
3288
|
+
"docs": {
|
|
3289
|
+
"default": "\"yarn install --frozen-lockfile && yarn projen\"",
|
|
3290
|
+
"stability": "experimental",
|
|
3291
|
+
"summary": "Workflow steps to use in order to bootstrap this repo."
|
|
3292
|
+
},
|
|
3293
|
+
"immutable": true,
|
|
3294
|
+
"locationInModule": {
|
|
3295
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3296
|
+
"line": 305
|
|
3297
|
+
},
|
|
3298
|
+
"name": "workflowBootstrapSteps",
|
|
3299
|
+
"optional": true,
|
|
3300
|
+
"type": {
|
|
3301
|
+
"collection": {
|
|
3302
|
+
"elementtype": {
|
|
3303
|
+
"fqn": "projen.github.workflows.JobStep"
|
|
3304
|
+
},
|
|
3305
|
+
"kind": "array"
|
|
3306
|
+
}
|
|
3307
|
+
}
|
|
3308
|
+
},
|
|
3309
|
+
{
|
|
3310
|
+
"abstract": true,
|
|
3311
|
+
"docs": {
|
|
3312
|
+
"default": "- default image",
|
|
3313
|
+
"stability": "experimental",
|
|
3314
|
+
"summary": "Container image to use for GitHub workflows."
|
|
3315
|
+
},
|
|
3316
|
+
"immutable": true,
|
|
3317
|
+
"locationInModule": {
|
|
3318
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3319
|
+
"line": 544
|
|
3320
|
+
},
|
|
3321
|
+
"name": "workflowContainerImage",
|
|
3322
|
+
"optional": true,
|
|
3323
|
+
"type": {
|
|
3324
|
+
"primitive": "string"
|
|
3325
|
+
}
|
|
3326
|
+
},
|
|
3327
|
+
{
|
|
3328
|
+
"abstract": true,
|
|
3329
|
+
"docs": {
|
|
3330
|
+
"default": "- GitHub Actions",
|
|
3331
|
+
"stability": "experimental",
|
|
3332
|
+
"summary": "The git identity to use in workflows."
|
|
3333
|
+
},
|
|
3334
|
+
"immutable": true,
|
|
3335
|
+
"locationInModule": {
|
|
3336
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3337
|
+
"line": 299
|
|
3338
|
+
},
|
|
3339
|
+
"name": "workflowGitIdentity",
|
|
3340
|
+
"optional": true,
|
|
3341
|
+
"type": {
|
|
3342
|
+
"fqn": "projen.github.GitIdentity"
|
|
3343
|
+
}
|
|
3344
|
+
},
|
|
3345
|
+
{
|
|
3346
|
+
"abstract": true,
|
|
3347
|
+
"docs": {
|
|
3348
|
+
"default": "- `minNodeVersion` if set, otherwise `lts/*`.",
|
|
3349
|
+
"remarks": "Always use this option if your GitHub Actions workflows require a specific to run.",
|
|
3350
|
+
"stability": "experimental",
|
|
3351
|
+
"summary": "The node version used in GitHub Actions workflows."
|
|
3352
|
+
},
|
|
3353
|
+
"immutable": true,
|
|
3354
|
+
"locationInModule": {
|
|
3355
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3356
|
+
"line": 293
|
|
3357
|
+
},
|
|
3358
|
+
"name": "workflowNodeVersion",
|
|
3359
|
+
"optional": true,
|
|
3360
|
+
"type": {
|
|
3361
|
+
"primitive": "string"
|
|
3362
|
+
}
|
|
3363
|
+
},
|
|
3364
|
+
{
|
|
3365
|
+
"abstract": true,
|
|
3366
|
+
"docs": {
|
|
3367
|
+
"default": "false",
|
|
3368
|
+
"stability": "experimental",
|
|
3369
|
+
"summary": "Enable Node.js package cache in GitHub workflows."
|
|
3370
|
+
},
|
|
3371
|
+
"immutable": true,
|
|
3372
|
+
"locationInModule": {
|
|
3373
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3374
|
+
"line": 286
|
|
3375
|
+
},
|
|
3376
|
+
"name": "workflowPackageCache",
|
|
3377
|
+
"optional": true,
|
|
3378
|
+
"type": {
|
|
3379
|
+
"primitive": "boolean"
|
|
3380
|
+
}
|
|
3381
|
+
},
|
|
3382
|
+
{
|
|
3383
|
+
"abstract": true,
|
|
3384
|
+
"docs": {
|
|
3385
|
+
"custom": {
|
|
3386
|
+
"description": "Defines a target Runner by labels",
|
|
3387
|
+
"throws": "{Error} if both `runsOn` and `runsOnGroup` are specified"
|
|
3388
|
+
},
|
|
3389
|
+
"default": "[\"ubuntu-latest\"]",
|
|
3390
|
+
"stability": "experimental",
|
|
3391
|
+
"summary": "Github Runner selection labels."
|
|
3392
|
+
},
|
|
3393
|
+
"immutable": true,
|
|
3394
|
+
"locationInModule": {
|
|
3395
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3396
|
+
"line": 538
|
|
3397
|
+
},
|
|
3398
|
+
"name": "workflowRunsOn",
|
|
3399
|
+
"optional": true,
|
|
3400
|
+
"type": {
|
|
3401
|
+
"collection": {
|
|
3402
|
+
"elementtype": {
|
|
3403
|
+
"primitive": "string"
|
|
3404
|
+
},
|
|
3405
|
+
"kind": "array"
|
|
3406
|
+
}
|
|
3407
|
+
}
|
|
3408
|
+
},
|
|
3409
|
+
{
|
|
3410
|
+
"abstract": true,
|
|
3411
|
+
"docs": {
|
|
3412
|
+
"custom": {
|
|
3413
|
+
"description": "Defines a target Runner Group by name and/or labels",
|
|
3414
|
+
"throws": "{Error} if both `runsOn` and `runsOnGroup` are specified"
|
|
3415
|
+
},
|
|
3416
|
+
"stability": "experimental",
|
|
3417
|
+
"summary": "Github Runner Group selection options."
|
|
3418
|
+
},
|
|
3419
|
+
"immutable": true,
|
|
3420
|
+
"locationInModule": {
|
|
3421
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3422
|
+
"line": 530
|
|
3423
|
+
},
|
|
3424
|
+
"name": "workflowRunsOnGroup",
|
|
3425
|
+
"optional": true,
|
|
3426
|
+
"type": {
|
|
3427
|
+
"fqn": "projen.GroupRunnerOptions"
|
|
3428
|
+
}
|
|
3429
|
+
},
|
|
3430
|
+
{
|
|
3431
|
+
"abstract": true,
|
|
3432
|
+
"docs": {
|
|
3433
|
+
"default": "- Yarn Berry v4 with all default options",
|
|
3434
|
+
"stability": "experimental",
|
|
3435
|
+
"summary": "Options for Yarn Berry."
|
|
3436
|
+
},
|
|
3437
|
+
"immutable": true,
|
|
3438
|
+
"locationInModule": {
|
|
3439
|
+
"filename": "src/projects/cdk-ts/cdk-typescript-app-options.ts",
|
|
3440
|
+
"line": 718
|
|
3441
|
+
},
|
|
3442
|
+
"name": "yarnBerryOptions",
|
|
3443
|
+
"optional": true,
|
|
3444
|
+
"type": {
|
|
3445
|
+
"fqn": "projen.javascript.YarnBerryOptions"
|
|
3446
|
+
}
|
|
3447
|
+
}
|
|
3448
|
+
],
|
|
3449
|
+
"symbolId": "src/projects/cdk-ts/cdk-typescript-app-options:CdkTypeScriptAppOptions"
|
|
3450
|
+
},
|
|
113
3451
|
"projen-modules.ISectionOptions": {
|
|
114
3452
|
"assembly": "projen-modules",
|
|
115
3453
|
"docs": {
|
|
@@ -7681,6 +11019,6 @@
|
|
|
7681
11019
|
"symbolId": "src/components/readme/elements/section:Section"
|
|
7682
11020
|
}
|
|
7683
11021
|
},
|
|
7684
|
-
"version": "0.2.
|
|
7685
|
-
"fingerprint": "
|
|
11022
|
+
"version": "0.2.51",
|
|
11023
|
+
"fingerprint": "yhXTmMwoJrMG+3J7DP+R5/Td3MKm5ilVsv2GcbjIEso="
|
|
7686
11024
|
}
|