projen-modules 1.2.74 → 1.2.75
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 +603 -1454
- package/API.md +199 -1387
- package/lib/components/readme/elements/section.js +3 -4
- package/lib/components/readme/index.js +4 -5
- package/lib/projects/cdk-ts/cdk-typescript-app-options.d.ts +23 -146
- package/lib/projects/cdk-ts/cdk-typescript-app-options.js +1 -1
- package/lib/projects/cdk-ts/index.js +3 -4
- package/lib/projects/jsii/index.js +3 -4
- package/lib/projects/jsii/jsii-project-options.d.ts +32 -115
- package/lib/projects/jsii/jsii-project-options.js +1 -1
- package/lib/projects/npm/index.js +3 -4
- package/lib/projects/npm/npm-package-options.d.ts +23 -104
- package/lib/projects/npm/npm-package-options.js +1 -1
- package/lib/projects/python/index.js +3 -4
- package/lib/projects/python/python-package-options.d.ts +2 -32
- package/lib/projects/python/python-package-options.js +1 -1
- package/package.json +31 -33
package/API.md
CHANGED
|
@@ -36,7 +36,6 @@ new CdkTypeScriptApp(options: CdkTypeScriptAppOptions)
|
|
|
36
36
|
| <code><a href="#projen-modules.CdkTypeScriptApp.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
37
37
|
| <code><a href="#projen-modules.CdkTypeScriptApp.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
38
38
|
| <code><a href="#projen-modules.CdkTypeScriptApp.addTask">addTask</a></code> | Adds a new task to this project. |
|
|
39
|
-
| <code><a href="#projen-modules.CdkTypeScriptApp.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
|
|
40
39
|
| <code><a href="#projen-modules.CdkTypeScriptApp.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
|
|
41
40
|
| <code><a href="#projen-modules.CdkTypeScriptApp.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
|
|
42
41
|
| <code><a href="#projen-modules.CdkTypeScriptApp.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
|
|
@@ -44,24 +43,19 @@ new CdkTypeScriptApp(options: CdkTypeScriptAppOptions)
|
|
|
44
43
|
| <code><a href="#projen-modules.CdkTypeScriptApp.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
|
|
45
44
|
| <code><a href="#projen-modules.CdkTypeScriptApp.synth">synth</a></code> | Synthesize all project files into `outdir`. |
|
|
46
45
|
| <code><a href="#projen-modules.CdkTypeScriptApp.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
|
|
47
|
-
| <code><a href="#projen-modules.CdkTypeScriptApp.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
|
|
48
46
|
| <code><a href="#projen-modules.CdkTypeScriptApp.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
|
|
49
47
|
| <code><a href="#projen-modules.CdkTypeScriptApp.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
|
|
50
48
|
| <code><a href="#projen-modules.CdkTypeScriptApp.addBins">addBins</a></code> | *No description.* |
|
|
51
49
|
| <code><a href="#projen-modules.CdkTypeScriptApp.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
|
|
52
|
-
| <code><a href="#projen-modules.CdkTypeScriptApp.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
|
|
53
50
|
| <code><a href="#projen-modules.CdkTypeScriptApp.addDeps">addDeps</a></code> | Defines normal dependencies. |
|
|
54
51
|
| <code><a href="#projen-modules.CdkTypeScriptApp.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
|
|
55
52
|
| <code><a href="#projen-modules.CdkTypeScriptApp.addFields">addFields</a></code> | Directly set fields in `package.json`. |
|
|
56
53
|
| <code><a href="#projen-modules.CdkTypeScriptApp.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
|
|
57
54
|
| <code><a href="#projen-modules.CdkTypeScriptApp.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
|
|
58
55
|
| <code><a href="#projen-modules.CdkTypeScriptApp.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
|
|
59
|
-
| <code><a href="#projen-modules.CdkTypeScriptApp.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
|
|
60
|
-
| <code><a href="#projen-modules.CdkTypeScriptApp.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
|
|
61
56
|
| <code><a href="#projen-modules.CdkTypeScriptApp.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
|
62
57
|
| <code><a href="#projen-modules.CdkTypeScriptApp.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
|
|
63
58
|
| <code><a href="#projen-modules.CdkTypeScriptApp.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
|
|
64
|
-
| <code><a href="#projen-modules.CdkTypeScriptApp.addCdkDependency">addCdkDependency</a></code> | Adds an AWS CDK module dependencies. |
|
|
65
59
|
|
|
66
60
|
---
|
|
67
61
|
|
|
@@ -172,22 +166,6 @@ Task properties.
|
|
|
172
166
|
|
|
173
167
|
---
|
|
174
168
|
|
|
175
|
-
##### ~~`addTip`~~ <a name="addTip" id="projen-modules.CdkTypeScriptApp.addTip"></a>
|
|
176
|
-
|
|
177
|
-
```typescript
|
|
178
|
-
public addTip(message: string): void
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
Prints a "tip" message during synthesis.
|
|
182
|
-
|
|
183
|
-
###### `message`<sup>Required</sup> <a name="message" id="projen-modules.CdkTypeScriptApp.addTip.parameter.message"></a>
|
|
184
|
-
|
|
185
|
-
- *Type:* string
|
|
186
|
-
|
|
187
|
-
The message.
|
|
188
|
-
|
|
189
|
-
---
|
|
190
|
-
|
|
191
169
|
##### `annotateGenerated` <a name="annotateGenerated" id="projen-modules.CdkTypeScriptApp.annotateGenerated"></a>
|
|
192
170
|
|
|
193
171
|
```typescript
|
|
@@ -297,22 +275,6 @@ from the root of _this_ project.
|
|
|
297
275
|
|
|
298
276
|
---
|
|
299
277
|
|
|
300
|
-
##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="projen-modules.CdkTypeScriptApp.tryFindJsonFile"></a>
|
|
301
|
-
|
|
302
|
-
```typescript
|
|
303
|
-
public tryFindJsonFile(filePath: string): JsonFile
|
|
304
|
-
```
|
|
305
|
-
|
|
306
|
-
Finds a json file by name.
|
|
307
|
-
|
|
308
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="projen-modules.CdkTypeScriptApp.tryFindJsonFile.parameter.filePath"></a>
|
|
309
|
-
|
|
310
|
-
- *Type:* string
|
|
311
|
-
|
|
312
|
-
The file path.
|
|
313
|
-
|
|
314
|
-
---
|
|
315
|
-
|
|
316
278
|
##### `tryFindObjectFile` <a name="tryFindObjectFile" id="projen-modules.CdkTypeScriptApp.tryFindObjectFile"></a>
|
|
317
279
|
|
|
318
280
|
```typescript
|
|
@@ -385,20 +347,6 @@ add/update`. If you wish to specify a version range use this syntax:
|
|
|
385
347
|
|
|
386
348
|
---
|
|
387
349
|
|
|
388
|
-
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="projen-modules.CdkTypeScriptApp.addCompileCommand"></a>
|
|
389
|
-
|
|
390
|
-
```typescript
|
|
391
|
-
public addCompileCommand(commands: ...string[]): void
|
|
392
|
-
```
|
|
393
|
-
|
|
394
|
-
DEPRECATED.
|
|
395
|
-
|
|
396
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="projen-modules.CdkTypeScriptApp.addCompileCommand.parameter.commands"></a>
|
|
397
|
-
|
|
398
|
-
- *Type:* ...string[]
|
|
399
|
-
|
|
400
|
-
---
|
|
401
|
-
|
|
402
350
|
##### `addDeps` <a name="addDeps" id="projen-modules.CdkTypeScriptApp.addDeps"></a>
|
|
403
351
|
|
|
404
352
|
```typescript
|
|
@@ -517,36 +465,6 @@ The scripts to set.
|
|
|
517
465
|
|
|
518
466
|
---
|
|
519
467
|
|
|
520
|
-
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="projen-modules.CdkTypeScriptApp.addTestCommand"></a>
|
|
521
|
-
|
|
522
|
-
```typescript
|
|
523
|
-
public addTestCommand(commands: ...string[]): void
|
|
524
|
-
```
|
|
525
|
-
|
|
526
|
-
DEPRECATED.
|
|
527
|
-
|
|
528
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="projen-modules.CdkTypeScriptApp.addTestCommand.parameter.commands"></a>
|
|
529
|
-
|
|
530
|
-
- *Type:* ...string[]
|
|
531
|
-
|
|
532
|
-
---
|
|
533
|
-
|
|
534
|
-
##### ~~`hasScript`~~ <a name="hasScript" id="projen-modules.CdkTypeScriptApp.hasScript"></a>
|
|
535
|
-
|
|
536
|
-
```typescript
|
|
537
|
-
public hasScript(name: string): boolean
|
|
538
|
-
```
|
|
539
|
-
|
|
540
|
-
Indicates if a script by the name name is defined.
|
|
541
|
-
|
|
542
|
-
###### `name`<sup>Required</sup> <a name="name" id="projen-modules.CdkTypeScriptApp.hasScript.parameter.name"></a>
|
|
543
|
-
|
|
544
|
-
- *Type:* string
|
|
545
|
-
|
|
546
|
-
The name of the script.
|
|
547
|
-
|
|
548
|
-
---
|
|
549
|
-
|
|
550
468
|
##### `removeScript` <a name="removeScript" id="projen-modules.CdkTypeScriptApp.removeScript"></a>
|
|
551
469
|
|
|
552
470
|
```typescript
|
|
@@ -603,22 +521,6 @@ The command to execute.
|
|
|
603
521
|
|
|
604
522
|
---
|
|
605
523
|
|
|
606
|
-
##### `addCdkDependency` <a name="addCdkDependency" id="projen-modules.CdkTypeScriptApp.addCdkDependency"></a>
|
|
607
|
-
|
|
608
|
-
```typescript
|
|
609
|
-
public addCdkDependency(modules: ...string[]): void
|
|
610
|
-
```
|
|
611
|
-
|
|
612
|
-
Adds an AWS CDK module dependencies.
|
|
613
|
-
|
|
614
|
-
###### `modules`<sup>Required</sup> <a name="modules" id="projen-modules.CdkTypeScriptApp.addCdkDependency.parameter.modules"></a>
|
|
615
|
-
|
|
616
|
-
- *Type:* ...string[]
|
|
617
|
-
|
|
618
|
-
The list of modules to depend on.
|
|
619
|
-
|
|
620
|
-
---
|
|
621
|
-
|
|
622
524
|
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
623
525
|
|
|
624
526
|
| **Name** | **Description** |
|
|
@@ -724,21 +626,16 @@ When given a project, this it the project itself.
|
|
|
724
626
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
725
627
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
|
|
726
628
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
|
|
727
|
-
| <code><a href="#projen-modules.CdkTypeScriptApp.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
|
|
728
629
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
|
|
729
630
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
|
|
730
631
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
|
|
731
632
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
|
|
732
633
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
|
|
733
|
-
| <code><a href="#projen-modules.CdkTypeScriptApp.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
|
|
734
634
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
|
|
735
635
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
|
|
736
636
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
|
|
737
|
-
| <code><a href="#projen-modules.CdkTypeScriptApp.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
|
|
738
|
-
| <code><a href="#projen-modules.CdkTypeScriptApp.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
|
|
739
637
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
|
|
740
638
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
|
|
741
|
-
| <code><a href="#projen-modules.CdkTypeScriptApp.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
|
|
742
639
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
|
|
743
640
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
|
|
744
641
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
|
|
@@ -749,11 +646,11 @@ When given a project, this it the project itself.
|
|
|
749
646
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
750
647
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
751
648
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
752
|
-
| <code><a href="#projen-modules.CdkTypeScriptApp.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
753
649
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
|
|
754
650
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
755
651
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
756
652
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
653
|
+
| <code><a href="#projen-modules.CdkTypeScriptApp.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner used for executing TypeScript files. |
|
|
757
654
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
758
655
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
759
656
|
| <code><a href="#projen-modules.CdkTypeScriptApp.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
@@ -1068,16 +965,6 @@ If undefined, this is the root project.
|
|
|
1068
965
|
|
|
1069
966
|
---
|
|
1070
967
|
|
|
1071
|
-
##### `projectType`<sup>Required</sup> <a name="projectType" id="projen-modules.CdkTypeScriptApp.property.projectType"></a>
|
|
1072
|
-
|
|
1073
|
-
```typescript
|
|
1074
|
-
public readonly projectType: ProjectType;
|
|
1075
|
-
```
|
|
1076
|
-
|
|
1077
|
-
- *Type:* projen.ProjectType
|
|
1078
|
-
|
|
1079
|
-
---
|
|
1080
|
-
|
|
1081
968
|
##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="projen-modules.CdkTypeScriptApp.property.autoApprove"></a>
|
|
1082
969
|
|
|
1083
970
|
```typescript
|
|
@@ -1146,18 +1033,6 @@ This will be `undefined` for subprojects.
|
|
|
1146
1033
|
|
|
1147
1034
|
---
|
|
1148
1035
|
|
|
1149
|
-
##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="projen-modules.CdkTypeScriptApp.property.allowLibraryDependencies"></a>
|
|
1150
|
-
|
|
1151
|
-
- *Deprecated:* use `package.allowLibraryDependencies`
|
|
1152
|
-
|
|
1153
|
-
```typescript
|
|
1154
|
-
public readonly allowLibraryDependencies: boolean;
|
|
1155
|
-
```
|
|
1156
|
-
|
|
1157
|
-
- *Type:* boolean
|
|
1158
|
-
|
|
1159
|
-
---
|
|
1160
|
-
|
|
1161
1036
|
##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="projen-modules.CdkTypeScriptApp.property.artifactsDirectory"></a>
|
|
1162
1037
|
|
|
1163
1038
|
```typescript
|
|
@@ -1196,30 +1071,6 @@ public readonly bundler: Bundler;
|
|
|
1196
1071
|
|
|
1197
1072
|
---
|
|
1198
1073
|
|
|
1199
|
-
##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="projen-modules.CdkTypeScriptApp.property.entrypoint"></a>
|
|
1200
|
-
|
|
1201
|
-
- *Deprecated:* use `package.entrypoint`
|
|
1202
|
-
|
|
1203
|
-
```typescript
|
|
1204
|
-
public readonly entrypoint: string;
|
|
1205
|
-
```
|
|
1206
|
-
|
|
1207
|
-
- *Type:* string
|
|
1208
|
-
|
|
1209
|
-
---
|
|
1210
|
-
|
|
1211
|
-
##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="projen-modules.CdkTypeScriptApp.property.manifest"></a>
|
|
1212
|
-
|
|
1213
|
-
- *Deprecated:* use `package.addField(x, y)`
|
|
1214
|
-
|
|
1215
|
-
```typescript
|
|
1216
|
-
public readonly manifest: any;
|
|
1217
|
-
```
|
|
1218
|
-
|
|
1219
|
-
- *Type:* any
|
|
1220
|
-
|
|
1221
|
-
---
|
|
1222
|
-
|
|
1223
1074
|
##### `npmrc`<sup>Required</sup> <a name="npmrc" id="projen-modules.CdkTypeScriptApp.property.npmrc"></a>
|
|
1224
1075
|
|
|
1225
1076
|
```typescript
|
|
@@ -1244,20 +1095,6 @@ API for managing the node package.
|
|
|
1244
1095
|
|
|
1245
1096
|
---
|
|
1246
1097
|
|
|
1247
|
-
##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="projen-modules.CdkTypeScriptApp.property.packageManager"></a>
|
|
1248
|
-
|
|
1249
|
-
- *Deprecated:* use `package.packageManager`
|
|
1250
|
-
|
|
1251
|
-
```typescript
|
|
1252
|
-
public readonly packageManager: NodePackageManager;
|
|
1253
|
-
```
|
|
1254
|
-
|
|
1255
|
-
- *Type:* projen.javascript.NodePackageManager
|
|
1256
|
-
|
|
1257
|
-
The package manager to use.
|
|
1258
|
-
|
|
1259
|
-
---
|
|
1260
|
-
|
|
1261
1098
|
##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="projen-modules.CdkTypeScriptApp.property.runScriptCommand"></a>
|
|
1262
1099
|
|
|
1263
1100
|
```typescript
|
|
@@ -1380,23 +1217,6 @@ public readonly prettier: Prettier;
|
|
|
1380
1217
|
|
|
1381
1218
|
---
|
|
1382
1219
|
|
|
1383
|
-
##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="projen-modules.CdkTypeScriptApp.property.publisher"></a>
|
|
1384
|
-
|
|
1385
|
-
- *Deprecated:* use `release.publisher`.
|
|
1386
|
-
|
|
1387
|
-
```typescript
|
|
1388
|
-
public readonly publisher: Publisher;
|
|
1389
|
-
```
|
|
1390
|
-
|
|
1391
|
-
- *Type:* projen.release.Publisher
|
|
1392
|
-
|
|
1393
|
-
Package publisher.
|
|
1394
|
-
|
|
1395
|
-
This will be `undefined` if the project does not have a
|
|
1396
|
-
release workflow.
|
|
1397
|
-
|
|
1398
|
-
---
|
|
1399
|
-
|
|
1400
1220
|
##### `release`<sup>Optional</sup> <a name="release" id="projen-modules.CdkTypeScriptApp.property.release"></a>
|
|
1401
1221
|
|
|
1402
1222
|
```typescript
|
|
@@ -1443,6 +1263,18 @@ The directory in which compiled .js files reside.
|
|
|
1443
1263
|
|
|
1444
1264
|
---
|
|
1445
1265
|
|
|
1266
|
+
##### `runner`<sup>Required</sup> <a name="runner" id="projen-modules.CdkTypeScriptApp.property.runner"></a>
|
|
1267
|
+
|
|
1268
|
+
```typescript
|
|
1269
|
+
public readonly runner: TypeScriptRunner;
|
|
1270
|
+
```
|
|
1271
|
+
|
|
1272
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
1273
|
+
|
|
1274
|
+
The TypeScript runner used for executing TypeScript files.
|
|
1275
|
+
|
|
1276
|
+
---
|
|
1277
|
+
|
|
1446
1278
|
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="projen-modules.CdkTypeScriptApp.property.srcdir"></a>
|
|
1447
1279
|
|
|
1448
1280
|
```typescript
|
|
@@ -1667,7 +1499,6 @@ new JsiiProject(options: JsiiProjectOptions)
|
|
|
1667
1499
|
| <code><a href="#projen-modules.JsiiProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
1668
1500
|
| <code><a href="#projen-modules.JsiiProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
1669
1501
|
| <code><a href="#projen-modules.JsiiProject.addTask">addTask</a></code> | Adds a new task to this project. |
|
|
1670
|
-
| <code><a href="#projen-modules.JsiiProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
|
|
1671
1502
|
| <code><a href="#projen-modules.JsiiProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
|
|
1672
1503
|
| <code><a href="#projen-modules.JsiiProject.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
|
|
1673
1504
|
| <code><a href="#projen-modules.JsiiProject.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
|
|
@@ -1675,20 +1506,16 @@ new JsiiProject(options: JsiiProjectOptions)
|
|
|
1675
1506
|
| <code><a href="#projen-modules.JsiiProject.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
|
|
1676
1507
|
| <code><a href="#projen-modules.JsiiProject.synth">synth</a></code> | Synthesize all project files into `outdir`. |
|
|
1677
1508
|
| <code><a href="#projen-modules.JsiiProject.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
|
|
1678
|
-
| <code><a href="#projen-modules.JsiiProject.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
|
|
1679
1509
|
| <code><a href="#projen-modules.JsiiProject.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
|
|
1680
1510
|
| <code><a href="#projen-modules.JsiiProject.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
|
|
1681
1511
|
| <code><a href="#projen-modules.JsiiProject.addBins">addBins</a></code> | *No description.* |
|
|
1682
1512
|
| <code><a href="#projen-modules.JsiiProject.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
|
|
1683
|
-
| <code><a href="#projen-modules.JsiiProject.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
|
|
1684
1513
|
| <code><a href="#projen-modules.JsiiProject.addDeps">addDeps</a></code> | Defines normal dependencies. |
|
|
1685
1514
|
| <code><a href="#projen-modules.JsiiProject.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
|
|
1686
1515
|
| <code><a href="#projen-modules.JsiiProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
|
|
1687
1516
|
| <code><a href="#projen-modules.JsiiProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
|
|
1688
1517
|
| <code><a href="#projen-modules.JsiiProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
|
|
1689
1518
|
| <code><a href="#projen-modules.JsiiProject.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
|
|
1690
|
-
| <code><a href="#projen-modules.JsiiProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
|
|
1691
|
-
| <code><a href="#projen-modules.JsiiProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
|
|
1692
1519
|
| <code><a href="#projen-modules.JsiiProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
|
1693
1520
|
| <code><a href="#projen-modules.JsiiProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
|
|
1694
1521
|
| <code><a href="#projen-modules.JsiiProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
|
|
@@ -1802,22 +1629,6 @@ Task properties.
|
|
|
1802
1629
|
|
|
1803
1630
|
---
|
|
1804
1631
|
|
|
1805
|
-
##### ~~`addTip`~~ <a name="addTip" id="projen-modules.JsiiProject.addTip"></a>
|
|
1806
|
-
|
|
1807
|
-
```typescript
|
|
1808
|
-
public addTip(message: string): void
|
|
1809
|
-
```
|
|
1810
|
-
|
|
1811
|
-
Prints a "tip" message during synthesis.
|
|
1812
|
-
|
|
1813
|
-
###### `message`<sup>Required</sup> <a name="message" id="projen-modules.JsiiProject.addTip.parameter.message"></a>
|
|
1814
|
-
|
|
1815
|
-
- *Type:* string
|
|
1816
|
-
|
|
1817
|
-
The message.
|
|
1818
|
-
|
|
1819
|
-
---
|
|
1820
|
-
|
|
1821
1632
|
##### `annotateGenerated` <a name="annotateGenerated" id="projen-modules.JsiiProject.annotateGenerated"></a>
|
|
1822
1633
|
|
|
1823
1634
|
```typescript
|
|
@@ -1927,22 +1738,6 @@ from the root of _this_ project.
|
|
|
1927
1738
|
|
|
1928
1739
|
---
|
|
1929
1740
|
|
|
1930
|
-
##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="projen-modules.JsiiProject.tryFindJsonFile"></a>
|
|
1931
|
-
|
|
1932
|
-
```typescript
|
|
1933
|
-
public tryFindJsonFile(filePath: string): JsonFile
|
|
1934
|
-
```
|
|
1935
|
-
|
|
1936
|
-
Finds a json file by name.
|
|
1937
|
-
|
|
1938
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="projen-modules.JsiiProject.tryFindJsonFile.parameter.filePath"></a>
|
|
1939
|
-
|
|
1940
|
-
- *Type:* string
|
|
1941
|
-
|
|
1942
|
-
The file path.
|
|
1943
|
-
|
|
1944
|
-
---
|
|
1945
|
-
|
|
1946
1741
|
##### `tryFindObjectFile` <a name="tryFindObjectFile" id="projen-modules.JsiiProject.tryFindObjectFile"></a>
|
|
1947
1742
|
|
|
1948
1743
|
```typescript
|
|
@@ -2015,20 +1810,6 @@ add/update`. If you wish to specify a version range use this syntax:
|
|
|
2015
1810
|
|
|
2016
1811
|
---
|
|
2017
1812
|
|
|
2018
|
-
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="projen-modules.JsiiProject.addCompileCommand"></a>
|
|
2019
|
-
|
|
2020
|
-
```typescript
|
|
2021
|
-
public addCompileCommand(commands: ...string[]): void
|
|
2022
|
-
```
|
|
2023
|
-
|
|
2024
|
-
DEPRECATED.
|
|
2025
|
-
|
|
2026
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="projen-modules.JsiiProject.addCompileCommand.parameter.commands"></a>
|
|
2027
|
-
|
|
2028
|
-
- *Type:* ...string[]
|
|
2029
|
-
|
|
2030
|
-
---
|
|
2031
|
-
|
|
2032
1813
|
##### `addDeps` <a name="addDeps" id="projen-modules.JsiiProject.addDeps"></a>
|
|
2033
1814
|
|
|
2034
1815
|
```typescript
|
|
@@ -2147,36 +1928,6 @@ The scripts to set.
|
|
|
2147
1928
|
|
|
2148
1929
|
---
|
|
2149
1930
|
|
|
2150
|
-
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="projen-modules.JsiiProject.addTestCommand"></a>
|
|
2151
|
-
|
|
2152
|
-
```typescript
|
|
2153
|
-
public addTestCommand(commands: ...string[]): void
|
|
2154
|
-
```
|
|
2155
|
-
|
|
2156
|
-
DEPRECATED.
|
|
2157
|
-
|
|
2158
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="projen-modules.JsiiProject.addTestCommand.parameter.commands"></a>
|
|
2159
|
-
|
|
2160
|
-
- *Type:* ...string[]
|
|
2161
|
-
|
|
2162
|
-
---
|
|
2163
|
-
|
|
2164
|
-
##### ~~`hasScript`~~ <a name="hasScript" id="projen-modules.JsiiProject.hasScript"></a>
|
|
2165
|
-
|
|
2166
|
-
```typescript
|
|
2167
|
-
public hasScript(name: string): boolean
|
|
2168
|
-
```
|
|
2169
|
-
|
|
2170
|
-
Indicates if a script by the name name is defined.
|
|
2171
|
-
|
|
2172
|
-
###### `name`<sup>Required</sup> <a name="name" id="projen-modules.JsiiProject.hasScript.parameter.name"></a>
|
|
2173
|
-
|
|
2174
|
-
- *Type:* string
|
|
2175
|
-
|
|
2176
|
-
The name of the script.
|
|
2177
|
-
|
|
2178
|
-
---
|
|
2179
|
-
|
|
2180
1931
|
##### `removeScript` <a name="removeScript" id="projen-modules.JsiiProject.removeScript"></a>
|
|
2181
1932
|
|
|
2182
1933
|
```typescript
|
|
@@ -2338,21 +2089,16 @@ When given a project, this it the project itself.
|
|
|
2338
2089
|
| <code><a href="#projen-modules.JsiiProject.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
2339
2090
|
| <code><a href="#projen-modules.JsiiProject.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
|
|
2340
2091
|
| <code><a href="#projen-modules.JsiiProject.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
|
|
2341
|
-
| <code><a href="#projen-modules.JsiiProject.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
|
|
2342
2092
|
| <code><a href="#projen-modules.JsiiProject.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
|
|
2343
2093
|
| <code><a href="#projen-modules.JsiiProject.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
|
|
2344
2094
|
| <code><a href="#projen-modules.JsiiProject.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
|
|
2345
2095
|
| <code><a href="#projen-modules.JsiiProject.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
|
|
2346
2096
|
| <code><a href="#projen-modules.JsiiProject.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
|
|
2347
|
-
| <code><a href="#projen-modules.JsiiProject.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
|
|
2348
2097
|
| <code><a href="#projen-modules.JsiiProject.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
|
|
2349
2098
|
| <code><a href="#projen-modules.JsiiProject.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
|
|
2350
2099
|
| <code><a href="#projen-modules.JsiiProject.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
|
|
2351
|
-
| <code><a href="#projen-modules.JsiiProject.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
|
|
2352
|
-
| <code><a href="#projen-modules.JsiiProject.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
|
|
2353
2100
|
| <code><a href="#projen-modules.JsiiProject.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
|
|
2354
2101
|
| <code><a href="#projen-modules.JsiiProject.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
|
|
2355
|
-
| <code><a href="#projen-modules.JsiiProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
|
|
2356
2102
|
| <code><a href="#projen-modules.JsiiProject.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
|
|
2357
2103
|
| <code><a href="#projen-modules.JsiiProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
|
|
2358
2104
|
| <code><a href="#projen-modules.JsiiProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
|
|
@@ -2363,11 +2109,11 @@ When given a project, this it the project itself.
|
|
|
2363
2109
|
| <code><a href="#projen-modules.JsiiProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
2364
2110
|
| <code><a href="#projen-modules.JsiiProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
2365
2111
|
| <code><a href="#projen-modules.JsiiProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
2366
|
-
| <code><a href="#projen-modules.JsiiProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
2367
2112
|
| <code><a href="#projen-modules.JsiiProject.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
|
|
2368
2113
|
| <code><a href="#projen-modules.JsiiProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
2369
2114
|
| <code><a href="#projen-modules.JsiiProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
2370
2115
|
| <code><a href="#projen-modules.JsiiProject.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
2116
|
+
| <code><a href="#projen-modules.JsiiProject.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner used for executing TypeScript files. |
|
|
2371
2117
|
| <code><a href="#projen-modules.JsiiProject.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
2372
2118
|
| <code><a href="#projen-modules.JsiiProject.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
2373
2119
|
| <code><a href="#projen-modules.JsiiProject.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
@@ -2677,16 +2423,6 @@ If undefined, this is the root project.
|
|
|
2677
2423
|
|
|
2678
2424
|
---
|
|
2679
2425
|
|
|
2680
|
-
##### `projectType`<sup>Required</sup> <a name="projectType" id="projen-modules.JsiiProject.property.projectType"></a>
|
|
2681
|
-
|
|
2682
|
-
```typescript
|
|
2683
|
-
public readonly projectType: ProjectType;
|
|
2684
|
-
```
|
|
2685
|
-
|
|
2686
|
-
- *Type:* projen.ProjectType
|
|
2687
|
-
|
|
2688
|
-
---
|
|
2689
|
-
|
|
2690
2426
|
##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="projen-modules.JsiiProject.property.autoApprove"></a>
|
|
2691
2427
|
|
|
2692
2428
|
```typescript
|
|
@@ -2755,18 +2491,6 @@ This will be `undefined` for subprojects.
|
|
|
2755
2491
|
|
|
2756
2492
|
---
|
|
2757
2493
|
|
|
2758
|
-
##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="projen-modules.JsiiProject.property.allowLibraryDependencies"></a>
|
|
2759
|
-
|
|
2760
|
-
- *Deprecated:* use `package.allowLibraryDependencies`
|
|
2761
|
-
|
|
2762
|
-
```typescript
|
|
2763
|
-
public readonly allowLibraryDependencies: boolean;
|
|
2764
|
-
```
|
|
2765
|
-
|
|
2766
|
-
- *Type:* boolean
|
|
2767
|
-
|
|
2768
|
-
---
|
|
2769
|
-
|
|
2770
2494
|
##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="projen-modules.JsiiProject.property.artifactsDirectory"></a>
|
|
2771
2495
|
|
|
2772
2496
|
```typescript
|
|
@@ -2805,30 +2529,6 @@ public readonly bundler: Bundler;
|
|
|
2805
2529
|
|
|
2806
2530
|
---
|
|
2807
2531
|
|
|
2808
|
-
##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="projen-modules.JsiiProject.property.entrypoint"></a>
|
|
2809
|
-
|
|
2810
|
-
- *Deprecated:* use `package.entrypoint`
|
|
2811
|
-
|
|
2812
|
-
```typescript
|
|
2813
|
-
public readonly entrypoint: string;
|
|
2814
|
-
```
|
|
2815
|
-
|
|
2816
|
-
- *Type:* string
|
|
2817
|
-
|
|
2818
|
-
---
|
|
2819
|
-
|
|
2820
|
-
##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="projen-modules.JsiiProject.property.manifest"></a>
|
|
2821
|
-
|
|
2822
|
-
- *Deprecated:* use `package.addField(x, y)`
|
|
2823
|
-
|
|
2824
|
-
```typescript
|
|
2825
|
-
public readonly manifest: any;
|
|
2826
|
-
```
|
|
2827
|
-
|
|
2828
|
-
- *Type:* any
|
|
2829
|
-
|
|
2830
|
-
---
|
|
2831
|
-
|
|
2832
2532
|
##### `npmrc`<sup>Required</sup> <a name="npmrc" id="projen-modules.JsiiProject.property.npmrc"></a>
|
|
2833
2533
|
|
|
2834
2534
|
```typescript
|
|
@@ -2853,20 +2553,6 @@ API for managing the node package.
|
|
|
2853
2553
|
|
|
2854
2554
|
---
|
|
2855
2555
|
|
|
2856
|
-
##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="projen-modules.JsiiProject.property.packageManager"></a>
|
|
2857
|
-
|
|
2858
|
-
- *Deprecated:* use `package.packageManager`
|
|
2859
|
-
|
|
2860
|
-
```typescript
|
|
2861
|
-
public readonly packageManager: NodePackageManager;
|
|
2862
|
-
```
|
|
2863
|
-
|
|
2864
|
-
- *Type:* projen.javascript.NodePackageManager
|
|
2865
|
-
|
|
2866
|
-
The package manager to use.
|
|
2867
|
-
|
|
2868
|
-
---
|
|
2869
|
-
|
|
2870
2556
|
##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="projen-modules.JsiiProject.property.runScriptCommand"></a>
|
|
2871
2557
|
|
|
2872
2558
|
```typescript
|
|
@@ -2989,23 +2675,6 @@ public readonly prettier: Prettier;
|
|
|
2989
2675
|
|
|
2990
2676
|
---
|
|
2991
2677
|
|
|
2992
|
-
##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="projen-modules.JsiiProject.property.publisher"></a>
|
|
2993
|
-
|
|
2994
|
-
- *Deprecated:* use `release.publisher`.
|
|
2995
|
-
|
|
2996
|
-
```typescript
|
|
2997
|
-
public readonly publisher: Publisher;
|
|
2998
|
-
```
|
|
2999
|
-
|
|
3000
|
-
- *Type:* projen.release.Publisher
|
|
3001
|
-
|
|
3002
|
-
Package publisher.
|
|
3003
|
-
|
|
3004
|
-
This will be `undefined` if the project does not have a
|
|
3005
|
-
release workflow.
|
|
3006
|
-
|
|
3007
|
-
---
|
|
3008
|
-
|
|
3009
2678
|
##### `release`<sup>Optional</sup> <a name="release" id="projen-modules.JsiiProject.property.release"></a>
|
|
3010
2679
|
|
|
3011
2680
|
```typescript
|
|
@@ -3052,6 +2721,18 @@ The directory in which compiled .js files reside.
|
|
|
3052
2721
|
|
|
3053
2722
|
---
|
|
3054
2723
|
|
|
2724
|
+
##### `runner`<sup>Required</sup> <a name="runner" id="projen-modules.JsiiProject.property.runner"></a>
|
|
2725
|
+
|
|
2726
|
+
```typescript
|
|
2727
|
+
public readonly runner: TypeScriptRunner;
|
|
2728
|
+
```
|
|
2729
|
+
|
|
2730
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
2731
|
+
|
|
2732
|
+
The TypeScript runner used for executing TypeScript files.
|
|
2733
|
+
|
|
2734
|
+
---
|
|
2735
|
+
|
|
3055
2736
|
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="projen-modules.JsiiProject.property.srcdir"></a>
|
|
3056
2737
|
|
|
3057
2738
|
```typescript
|
|
@@ -3218,7 +2899,6 @@ new NpmPackage(options: NpmPackageOptions)
|
|
|
3218
2899
|
| <code><a href="#projen-modules.NpmPackage.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
3219
2900
|
| <code><a href="#projen-modules.NpmPackage.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
3220
2901
|
| <code><a href="#projen-modules.NpmPackage.addTask">addTask</a></code> | Adds a new task to this project. |
|
|
3221
|
-
| <code><a href="#projen-modules.NpmPackage.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
|
|
3222
2902
|
| <code><a href="#projen-modules.NpmPackage.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
|
|
3223
2903
|
| <code><a href="#projen-modules.NpmPackage.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
|
|
3224
2904
|
| <code><a href="#projen-modules.NpmPackage.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
|
|
@@ -3226,20 +2906,16 @@ new NpmPackage(options: NpmPackageOptions)
|
|
|
3226
2906
|
| <code><a href="#projen-modules.NpmPackage.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
|
|
3227
2907
|
| <code><a href="#projen-modules.NpmPackage.synth">synth</a></code> | Synthesize all project files into `outdir`. |
|
|
3228
2908
|
| <code><a href="#projen-modules.NpmPackage.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
|
|
3229
|
-
| <code><a href="#projen-modules.NpmPackage.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
|
|
3230
2909
|
| <code><a href="#projen-modules.NpmPackage.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
|
|
3231
2910
|
| <code><a href="#projen-modules.NpmPackage.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
|
|
3232
2911
|
| <code><a href="#projen-modules.NpmPackage.addBins">addBins</a></code> | *No description.* |
|
|
3233
2912
|
| <code><a href="#projen-modules.NpmPackage.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
|
|
3234
|
-
| <code><a href="#projen-modules.NpmPackage.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
|
|
3235
2913
|
| <code><a href="#projen-modules.NpmPackage.addDeps">addDeps</a></code> | Defines normal dependencies. |
|
|
3236
2914
|
| <code><a href="#projen-modules.NpmPackage.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
|
|
3237
2915
|
| <code><a href="#projen-modules.NpmPackage.addFields">addFields</a></code> | Directly set fields in `package.json`. |
|
|
3238
2916
|
| <code><a href="#projen-modules.NpmPackage.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
|
|
3239
2917
|
| <code><a href="#projen-modules.NpmPackage.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
|
|
3240
2918
|
| <code><a href="#projen-modules.NpmPackage.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
|
|
3241
|
-
| <code><a href="#projen-modules.NpmPackage.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
|
|
3242
|
-
| <code><a href="#projen-modules.NpmPackage.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
|
|
3243
2919
|
| <code><a href="#projen-modules.NpmPackage.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
|
3244
2920
|
| <code><a href="#projen-modules.NpmPackage.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
|
|
3245
2921
|
| <code><a href="#projen-modules.NpmPackage.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
|
|
@@ -3353,22 +3029,6 @@ Task properties.
|
|
|
3353
3029
|
|
|
3354
3030
|
---
|
|
3355
3031
|
|
|
3356
|
-
##### ~~`addTip`~~ <a name="addTip" id="projen-modules.NpmPackage.addTip"></a>
|
|
3357
|
-
|
|
3358
|
-
```typescript
|
|
3359
|
-
public addTip(message: string): void
|
|
3360
|
-
```
|
|
3361
|
-
|
|
3362
|
-
Prints a "tip" message during synthesis.
|
|
3363
|
-
|
|
3364
|
-
###### `message`<sup>Required</sup> <a name="message" id="projen-modules.NpmPackage.addTip.parameter.message"></a>
|
|
3365
|
-
|
|
3366
|
-
- *Type:* string
|
|
3367
|
-
|
|
3368
|
-
The message.
|
|
3369
|
-
|
|
3370
|
-
---
|
|
3371
|
-
|
|
3372
3032
|
##### `annotateGenerated` <a name="annotateGenerated" id="projen-modules.NpmPackage.annotateGenerated"></a>
|
|
3373
3033
|
|
|
3374
3034
|
```typescript
|
|
@@ -3478,22 +3138,6 @@ from the root of _this_ project.
|
|
|
3478
3138
|
|
|
3479
3139
|
---
|
|
3480
3140
|
|
|
3481
|
-
##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="projen-modules.NpmPackage.tryFindJsonFile"></a>
|
|
3482
|
-
|
|
3483
|
-
```typescript
|
|
3484
|
-
public tryFindJsonFile(filePath: string): JsonFile
|
|
3485
|
-
```
|
|
3486
|
-
|
|
3487
|
-
Finds a json file by name.
|
|
3488
|
-
|
|
3489
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="projen-modules.NpmPackage.tryFindJsonFile.parameter.filePath"></a>
|
|
3490
|
-
|
|
3491
|
-
- *Type:* string
|
|
3492
|
-
|
|
3493
|
-
The file path.
|
|
3494
|
-
|
|
3495
|
-
---
|
|
3496
|
-
|
|
3497
3141
|
##### `tryFindObjectFile` <a name="tryFindObjectFile" id="projen-modules.NpmPackage.tryFindObjectFile"></a>
|
|
3498
3142
|
|
|
3499
3143
|
```typescript
|
|
@@ -3566,20 +3210,6 @@ add/update`. If you wish to specify a version range use this syntax:
|
|
|
3566
3210
|
|
|
3567
3211
|
---
|
|
3568
3212
|
|
|
3569
|
-
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="projen-modules.NpmPackage.addCompileCommand"></a>
|
|
3570
|
-
|
|
3571
|
-
```typescript
|
|
3572
|
-
public addCompileCommand(commands: ...string[]): void
|
|
3573
|
-
```
|
|
3574
|
-
|
|
3575
|
-
DEPRECATED.
|
|
3576
|
-
|
|
3577
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="projen-modules.NpmPackage.addCompileCommand.parameter.commands"></a>
|
|
3578
|
-
|
|
3579
|
-
- *Type:* ...string[]
|
|
3580
|
-
|
|
3581
|
-
---
|
|
3582
|
-
|
|
3583
3213
|
##### `addDeps` <a name="addDeps" id="projen-modules.NpmPackage.addDeps"></a>
|
|
3584
3214
|
|
|
3585
3215
|
```typescript
|
|
@@ -3698,36 +3328,6 @@ The scripts to set.
|
|
|
3698
3328
|
|
|
3699
3329
|
---
|
|
3700
3330
|
|
|
3701
|
-
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="projen-modules.NpmPackage.addTestCommand"></a>
|
|
3702
|
-
|
|
3703
|
-
```typescript
|
|
3704
|
-
public addTestCommand(commands: ...string[]): void
|
|
3705
|
-
```
|
|
3706
|
-
|
|
3707
|
-
DEPRECATED.
|
|
3708
|
-
|
|
3709
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="projen-modules.NpmPackage.addTestCommand.parameter.commands"></a>
|
|
3710
|
-
|
|
3711
|
-
- *Type:* ...string[]
|
|
3712
|
-
|
|
3713
|
-
---
|
|
3714
|
-
|
|
3715
|
-
##### ~~`hasScript`~~ <a name="hasScript" id="projen-modules.NpmPackage.hasScript"></a>
|
|
3716
|
-
|
|
3717
|
-
```typescript
|
|
3718
|
-
public hasScript(name: string): boolean
|
|
3719
|
-
```
|
|
3720
|
-
|
|
3721
|
-
Indicates if a script by the name name is defined.
|
|
3722
|
-
|
|
3723
|
-
###### `name`<sup>Required</sup> <a name="name" id="projen-modules.NpmPackage.hasScript.parameter.name"></a>
|
|
3724
|
-
|
|
3725
|
-
- *Type:* string
|
|
3726
|
-
|
|
3727
|
-
The name of the script.
|
|
3728
|
-
|
|
3729
|
-
---
|
|
3730
|
-
|
|
3731
3331
|
##### `removeScript` <a name="removeScript" id="projen-modules.NpmPackage.removeScript"></a>
|
|
3732
3332
|
|
|
3733
3333
|
```typescript
|
|
@@ -3889,21 +3489,16 @@ When given a project, this it the project itself.
|
|
|
3889
3489
|
| <code><a href="#projen-modules.NpmPackage.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
3890
3490
|
| <code><a href="#projen-modules.NpmPackage.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
|
|
3891
3491
|
| <code><a href="#projen-modules.NpmPackage.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
|
|
3892
|
-
| <code><a href="#projen-modules.NpmPackage.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
|
|
3893
3492
|
| <code><a href="#projen-modules.NpmPackage.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
|
|
3894
3493
|
| <code><a href="#projen-modules.NpmPackage.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
|
|
3895
3494
|
| <code><a href="#projen-modules.NpmPackage.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
|
|
3896
3495
|
| <code><a href="#projen-modules.NpmPackage.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
|
|
3897
3496
|
| <code><a href="#projen-modules.NpmPackage.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
|
|
3898
|
-
| <code><a href="#projen-modules.NpmPackage.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
|
|
3899
3497
|
| <code><a href="#projen-modules.NpmPackage.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
|
|
3900
3498
|
| <code><a href="#projen-modules.NpmPackage.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
|
|
3901
3499
|
| <code><a href="#projen-modules.NpmPackage.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
|
|
3902
|
-
| <code><a href="#projen-modules.NpmPackage.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
|
|
3903
|
-
| <code><a href="#projen-modules.NpmPackage.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
|
|
3904
3500
|
| <code><a href="#projen-modules.NpmPackage.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
|
|
3905
3501
|
| <code><a href="#projen-modules.NpmPackage.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
|
|
3906
|
-
| <code><a href="#projen-modules.NpmPackage.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
|
|
3907
3502
|
| <code><a href="#projen-modules.NpmPackage.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
|
|
3908
3503
|
| <code><a href="#projen-modules.NpmPackage.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
|
|
3909
3504
|
| <code><a href="#projen-modules.NpmPackage.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
|
|
@@ -3914,11 +3509,11 @@ When given a project, this it the project itself.
|
|
|
3914
3509
|
| <code><a href="#projen-modules.NpmPackage.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
3915
3510
|
| <code><a href="#projen-modules.NpmPackage.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
3916
3511
|
| <code><a href="#projen-modules.NpmPackage.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
3917
|
-
| <code><a href="#projen-modules.NpmPackage.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
3918
3512
|
| <code><a href="#projen-modules.NpmPackage.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
|
|
3919
3513
|
| <code><a href="#projen-modules.NpmPackage.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
3920
3514
|
| <code><a href="#projen-modules.NpmPackage.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
3921
3515
|
| <code><a href="#projen-modules.NpmPackage.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
3516
|
+
| <code><a href="#projen-modules.NpmPackage.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner used for executing TypeScript files. |
|
|
3922
3517
|
| <code><a href="#projen-modules.NpmPackage.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
3923
3518
|
| <code><a href="#projen-modules.NpmPackage.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
3924
3519
|
| <code><a href="#projen-modules.NpmPackage.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
@@ -4228,16 +3823,6 @@ If undefined, this is the root project.
|
|
|
4228
3823
|
|
|
4229
3824
|
---
|
|
4230
3825
|
|
|
4231
|
-
##### `projectType`<sup>Required</sup> <a name="projectType" id="projen-modules.NpmPackage.property.projectType"></a>
|
|
4232
|
-
|
|
4233
|
-
```typescript
|
|
4234
|
-
public readonly projectType: ProjectType;
|
|
4235
|
-
```
|
|
4236
|
-
|
|
4237
|
-
- *Type:* projen.ProjectType
|
|
4238
|
-
|
|
4239
|
-
---
|
|
4240
|
-
|
|
4241
3826
|
##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="projen-modules.NpmPackage.property.autoApprove"></a>
|
|
4242
3827
|
|
|
4243
3828
|
```typescript
|
|
@@ -4306,18 +3891,6 @@ This will be `undefined` for subprojects.
|
|
|
4306
3891
|
|
|
4307
3892
|
---
|
|
4308
3893
|
|
|
4309
|
-
##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="projen-modules.NpmPackage.property.allowLibraryDependencies"></a>
|
|
4310
|
-
|
|
4311
|
-
- *Deprecated:* use `package.allowLibraryDependencies`
|
|
4312
|
-
|
|
4313
|
-
```typescript
|
|
4314
|
-
public readonly allowLibraryDependencies: boolean;
|
|
4315
|
-
```
|
|
4316
|
-
|
|
4317
|
-
- *Type:* boolean
|
|
4318
|
-
|
|
4319
|
-
---
|
|
4320
|
-
|
|
4321
3894
|
##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="projen-modules.NpmPackage.property.artifactsDirectory"></a>
|
|
4322
3895
|
|
|
4323
3896
|
```typescript
|
|
@@ -4356,30 +3929,6 @@ public readonly bundler: Bundler;
|
|
|
4356
3929
|
|
|
4357
3930
|
---
|
|
4358
3931
|
|
|
4359
|
-
##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="projen-modules.NpmPackage.property.entrypoint"></a>
|
|
4360
|
-
|
|
4361
|
-
- *Deprecated:* use `package.entrypoint`
|
|
4362
|
-
|
|
4363
|
-
```typescript
|
|
4364
|
-
public readonly entrypoint: string;
|
|
4365
|
-
```
|
|
4366
|
-
|
|
4367
|
-
- *Type:* string
|
|
4368
|
-
|
|
4369
|
-
---
|
|
4370
|
-
|
|
4371
|
-
##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="projen-modules.NpmPackage.property.manifest"></a>
|
|
4372
|
-
|
|
4373
|
-
- *Deprecated:* use `package.addField(x, y)`
|
|
4374
|
-
|
|
4375
|
-
```typescript
|
|
4376
|
-
public readonly manifest: any;
|
|
4377
|
-
```
|
|
4378
|
-
|
|
4379
|
-
- *Type:* any
|
|
4380
|
-
|
|
4381
|
-
---
|
|
4382
|
-
|
|
4383
3932
|
##### `npmrc`<sup>Required</sup> <a name="npmrc" id="projen-modules.NpmPackage.property.npmrc"></a>
|
|
4384
3933
|
|
|
4385
3934
|
```typescript
|
|
@@ -4404,20 +3953,6 @@ API for managing the node package.
|
|
|
4404
3953
|
|
|
4405
3954
|
---
|
|
4406
3955
|
|
|
4407
|
-
##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="projen-modules.NpmPackage.property.packageManager"></a>
|
|
4408
|
-
|
|
4409
|
-
- *Deprecated:* use `package.packageManager`
|
|
4410
|
-
|
|
4411
|
-
```typescript
|
|
4412
|
-
public readonly packageManager: NodePackageManager;
|
|
4413
|
-
```
|
|
4414
|
-
|
|
4415
|
-
- *Type:* projen.javascript.NodePackageManager
|
|
4416
|
-
|
|
4417
|
-
The package manager to use.
|
|
4418
|
-
|
|
4419
|
-
---
|
|
4420
|
-
|
|
4421
3956
|
##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="projen-modules.NpmPackage.property.runScriptCommand"></a>
|
|
4422
3957
|
|
|
4423
3958
|
```typescript
|
|
@@ -4540,23 +4075,6 @@ public readonly prettier: Prettier;
|
|
|
4540
4075
|
|
|
4541
4076
|
---
|
|
4542
4077
|
|
|
4543
|
-
##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="projen-modules.NpmPackage.property.publisher"></a>
|
|
4544
|
-
|
|
4545
|
-
- *Deprecated:* use `release.publisher`.
|
|
4546
|
-
|
|
4547
|
-
```typescript
|
|
4548
|
-
public readonly publisher: Publisher;
|
|
4549
|
-
```
|
|
4550
|
-
|
|
4551
|
-
- *Type:* projen.release.Publisher
|
|
4552
|
-
|
|
4553
|
-
Package publisher.
|
|
4554
|
-
|
|
4555
|
-
This will be `undefined` if the project does not have a
|
|
4556
|
-
release workflow.
|
|
4557
|
-
|
|
4558
|
-
---
|
|
4559
|
-
|
|
4560
4078
|
##### `release`<sup>Optional</sup> <a name="release" id="projen-modules.NpmPackage.property.release"></a>
|
|
4561
4079
|
|
|
4562
4080
|
```typescript
|
|
@@ -4603,6 +4121,18 @@ The directory in which compiled .js files reside.
|
|
|
4603
4121
|
|
|
4604
4122
|
---
|
|
4605
4123
|
|
|
4124
|
+
##### `runner`<sup>Required</sup> <a name="runner" id="projen-modules.NpmPackage.property.runner"></a>
|
|
4125
|
+
|
|
4126
|
+
```typescript
|
|
4127
|
+
public readonly runner: TypeScriptRunner;
|
|
4128
|
+
```
|
|
4129
|
+
|
|
4130
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
4131
|
+
|
|
4132
|
+
The TypeScript runner used for executing TypeScript files.
|
|
4133
|
+
|
|
4134
|
+
---
|
|
4135
|
+
|
|
4606
4136
|
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="projen-modules.NpmPackage.property.srcdir"></a>
|
|
4607
4137
|
|
|
4608
4138
|
```typescript
|
|
@@ -4769,7 +4299,6 @@ new PythonPackage(options: PythonPackageOptions)
|
|
|
4769
4299
|
| <code><a href="#projen-modules.PythonPackage.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
4770
4300
|
| <code><a href="#projen-modules.PythonPackage.addPackageIgnore">addPackageIgnore</a></code> | Exclude these files from the bundled package. |
|
|
4771
4301
|
| <code><a href="#projen-modules.PythonPackage.addTask">addTask</a></code> | Adds a new task to this project. |
|
|
4772
|
-
| <code><a href="#projen-modules.PythonPackage.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
|
|
4773
4302
|
| <code><a href="#projen-modules.PythonPackage.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
|
|
4774
4303
|
| <code><a href="#projen-modules.PythonPackage.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
|
|
4775
4304
|
| <code><a href="#projen-modules.PythonPackage.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
|
|
@@ -4777,7 +4306,6 @@ new PythonPackage(options: PythonPackageOptions)
|
|
|
4777
4306
|
| <code><a href="#projen-modules.PythonPackage.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
|
|
4778
4307
|
| <code><a href="#projen-modules.PythonPackage.synth">synth</a></code> | Synthesize all project files into `outdir`. |
|
|
4779
4308
|
| <code><a href="#projen-modules.PythonPackage.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
|
|
4780
|
-
| <code><a href="#projen-modules.PythonPackage.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
|
|
4781
4309
|
| <code><a href="#projen-modules.PythonPackage.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
|
|
4782
4310
|
| <code><a href="#projen-modules.PythonPackage.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
|
|
4783
4311
|
| <code><a href="#projen-modules.PythonPackage.addDependency">addDependency</a></code> | Adds a runtime dependency. |
|
|
@@ -4895,22 +4423,6 @@ Task properties.
|
|
|
4895
4423
|
|
|
4896
4424
|
---
|
|
4897
4425
|
|
|
4898
|
-
##### ~~`addTip`~~ <a name="addTip" id="projen-modules.PythonPackage.addTip"></a>
|
|
4899
|
-
|
|
4900
|
-
```typescript
|
|
4901
|
-
public addTip(message: string): void
|
|
4902
|
-
```
|
|
4903
|
-
|
|
4904
|
-
Prints a "tip" message during synthesis.
|
|
4905
|
-
|
|
4906
|
-
###### `message`<sup>Required</sup> <a name="message" id="projen-modules.PythonPackage.addTip.parameter.message"></a>
|
|
4907
|
-
|
|
4908
|
-
- *Type:* string
|
|
4909
|
-
|
|
4910
|
-
The message.
|
|
4911
|
-
|
|
4912
|
-
---
|
|
4913
|
-
|
|
4914
4426
|
##### `annotateGenerated` <a name="annotateGenerated" id="projen-modules.PythonPackage.annotateGenerated"></a>
|
|
4915
4427
|
|
|
4916
4428
|
```typescript
|
|
@@ -5019,22 +4531,6 @@ from the root of _this_ project.
|
|
|
5019
4531
|
|
|
5020
4532
|
---
|
|
5021
4533
|
|
|
5022
|
-
##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="projen-modules.PythonPackage.tryFindJsonFile"></a>
|
|
5023
|
-
|
|
5024
|
-
```typescript
|
|
5025
|
-
public tryFindJsonFile(filePath: string): JsonFile
|
|
5026
|
-
```
|
|
5027
|
-
|
|
5028
|
-
Finds a json file by name.
|
|
5029
|
-
|
|
5030
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="projen-modules.PythonPackage.tryFindJsonFile.parameter.filePath"></a>
|
|
5031
|
-
|
|
5032
|
-
- *Type:* string
|
|
5033
|
-
|
|
5034
|
-
The file path.
|
|
5035
|
-
|
|
5036
|
-
---
|
|
5037
|
-
|
|
5038
4534
|
##### `tryFindObjectFile` <a name="tryFindObjectFile" id="projen-modules.PythonPackage.tryFindObjectFile"></a>
|
|
5039
4535
|
|
|
5040
4536
|
```typescript
|
|
@@ -5207,7 +4703,6 @@ When given a project, this it the project itself.
|
|
|
5207
4703
|
| <code><a href="#projen-modules.PythonPackage.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
5208
4704
|
| <code><a href="#projen-modules.PythonPackage.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
|
|
5209
4705
|
| <code><a href="#projen-modules.PythonPackage.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
|
|
5210
|
-
| <code><a href="#projen-modules.PythonPackage.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
|
|
5211
4706
|
| <code><a href="#projen-modules.PythonPackage.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
|
|
5212
4707
|
| <code><a href="#projen-modules.PythonPackage.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
|
|
5213
4708
|
| <code><a href="#projen-modules.PythonPackage.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
|
|
@@ -5521,16 +5016,6 @@ If undefined, this is the root project.
|
|
|
5521
5016
|
|
|
5522
5017
|
---
|
|
5523
5018
|
|
|
5524
|
-
##### `projectType`<sup>Required</sup> <a name="projectType" id="projen-modules.PythonPackage.property.projectType"></a>
|
|
5525
|
-
|
|
5526
|
-
```typescript
|
|
5527
|
-
public readonly projectType: ProjectType;
|
|
5528
|
-
```
|
|
5529
|
-
|
|
5530
|
-
- *Type:* projen.ProjectType
|
|
5531
|
-
|
|
5532
|
-
---
|
|
5533
|
-
|
|
5534
5019
|
##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="projen-modules.PythonPackage.property.autoApprove"></a>
|
|
5535
5020
|
|
|
5536
5021
|
```typescript
|
|
@@ -5757,6 +5242,7 @@ new Readme(project: Project, options?: ReadmeOptions)
|
|
|
5757
5242
|
| <code><a href="#projen-modules.Readme.postSynthesize">postSynthesize</a></code> | Called after synthesis. |
|
|
5758
5243
|
| <code><a href="#projen-modules.Readme.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
|
|
5759
5244
|
| <code><a href="#projen-modules.Readme.synthesize">synthesize</a></code> | Writes the file to the project's output directory. |
|
|
5245
|
+
| <code><a href="#projen-modules.Readme.diff">diff</a></code> | Returns a unified diff of the old and new file contents with context lines and hunk headers. |
|
|
5760
5246
|
| <code><a href="#projen-modules.Readme.addSection">addSection</a></code> | *No description.* |
|
|
5761
5247
|
|
|
5762
5248
|
---
|
|
@@ -5816,6 +5302,35 @@ public synthesize(): void
|
|
|
5816
5302
|
|
|
5817
5303
|
Writes the file to the project's output directory.
|
|
5818
5304
|
|
|
5305
|
+
##### `diff` <a name="diff" id="projen-modules.Readme.diff"></a>
|
|
5306
|
+
|
|
5307
|
+
```typescript
|
|
5308
|
+
public diff(colorize?: boolean, contextLines?: number): string[]
|
|
5309
|
+
```
|
|
5310
|
+
|
|
5311
|
+
Returns a unified diff of the old and new file contents with context lines and hunk headers.
|
|
5312
|
+
|
|
5313
|
+
Only available after synthesis.
|
|
5314
|
+
|
|
5315
|
+
This is an expensive operation and should only be used on non time-critical
|
|
5316
|
+
code paths, like debug output.
|
|
5317
|
+
|
|
5318
|
+
###### `colorize`<sup>Optional</sup> <a name="colorize" id="projen-modules.Readme.diff.parameter.colorize"></a>
|
|
5319
|
+
|
|
5320
|
+
- *Type:* boolean
|
|
5321
|
+
|
|
5322
|
+
Whether to colorize the diff output.
|
|
5323
|
+
|
|
5324
|
+
---
|
|
5325
|
+
|
|
5326
|
+
###### `contextLines`<sup>Optional</sup> <a name="contextLines" id="projen-modules.Readme.diff.parameter.contextLines"></a>
|
|
5327
|
+
|
|
5328
|
+
- *Type:* number
|
|
5329
|
+
|
|
5330
|
+
Number of context lines around changes.
|
|
5331
|
+
|
|
5332
|
+
---
|
|
5333
|
+
|
|
5819
5334
|
##### `addSection` <a name="addSection" id="projen-modules.Readme.addSection"></a>
|
|
5820
5335
|
|
|
5821
5336
|
```typescript
|
|
@@ -5898,6 +5413,7 @@ Test whether the given construct is a component.
|
|
|
5898
5413
|
| <code><a href="#projen-modules.Readme.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
5899
5414
|
| <code><a href="#projen-modules.Readme.property.project">project</a></code> | <code>projen.Project</code> | *No description.* |
|
|
5900
5415
|
| <code><a href="#projen-modules.Readme.property.absolutePath">absolutePath</a></code> | <code>string</code> | The absolute path of this file. |
|
|
5416
|
+
| <code><a href="#projen-modules.Readme.property.committed">committed</a></code> | <code>boolean</code> | Indicates if the file will be committed. |
|
|
5901
5417
|
| <code><a href="#projen-modules.Readme.property.path">path</a></code> | <code>string</code> | The file path, relative to the project's outdir. |
|
|
5902
5418
|
| <code><a href="#projen-modules.Readme.property.changed">changed</a></code> | <code>boolean</code> | Indicates if the file has been changed during synthesis. |
|
|
5903
5419
|
| <code><a href="#projen-modules.Readme.property.marker">marker</a></code> | <code>string</code> | The projen marker, used to identify files as projen-generated. |
|
|
@@ -5942,6 +5458,18 @@ The absolute path of this file.
|
|
|
5942
5458
|
|
|
5943
5459
|
---
|
|
5944
5460
|
|
|
5461
|
+
##### `committed`<sup>Required</sup> <a name="committed" id="projen-modules.Readme.property.committed"></a>
|
|
5462
|
+
|
|
5463
|
+
```typescript
|
|
5464
|
+
public readonly committed: boolean;
|
|
5465
|
+
```
|
|
5466
|
+
|
|
5467
|
+
- *Type:* boolean
|
|
5468
|
+
|
|
5469
|
+
Indicates if the file will be committed.
|
|
5470
|
+
|
|
5471
|
+
---
|
|
5472
|
+
|
|
5945
5473
|
##### `path`<sup>Required</sup> <a name="path" id="projen-modules.Readme.property.path"></a>
|
|
5946
5474
|
|
|
5947
5475
|
```typescript
|
|
@@ -6074,18 +5602,12 @@ const cdkTypeScriptAppOptions: CdkTypeScriptAppOptions = { ... }
|
|
|
6074
5602
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.buildCommand">buildCommand</a></code> | <code>string</code> | A command to execute before synthesis. |
|
|
6075
5603
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
|
|
6076
5604
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
6077
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
|
6078
5605
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.bumpPackage">bumpPackage</a></code> | <code>string</code> | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. |
|
|
6079
5606
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
6080
5607
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
6081
5608
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
6082
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.cdkAssert">cdkAssert</a></code> | <code>boolean</code> | Warning: NodeJS only. |
|
|
6083
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.cdkAssertions">cdkAssertions</a></code> | <code>boolean</code> | Install the assertions library? |
|
|
6084
5609
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.cdkCliVersion">cdkCliVersion</a></code> | <code>string</code> | Version range of the AWS CDK CLI to depend on. |
|
|
6085
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.cdkDependencies">cdkDependencies</a></code> | <code>string[]</code> | Which AWS CDKv1 modules this project requires. |
|
|
6086
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.cdkDependenciesAsDeps">cdkDependenciesAsDeps</a></code> | <code>boolean</code> | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). |
|
|
6087
5610
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.cdkout">cdkout</a></code> | <code>string</code> | cdk.out directory. |
|
|
6088
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.cdkTestDependencies">cdkTestDependencies</a></code> | <code>string[]</code> | AWS CDK modules required for testing. |
|
|
6089
5611
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.cdkVersionPinning">cdkVersionPinning</a></code> | <code>boolean</code> | Use pinned version instead of caret version for CDK. |
|
|
6090
5612
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
6091
5613
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
@@ -6109,7 +5631,7 @@ const cdkTypeScriptAppOptions: CdkTypeScriptAppOptions = { ... }
|
|
|
6109
5631
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
|
|
6110
5632
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.devEngines">devEngines</a></code> | <code>projen.javascript.DevEngines</code> | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. |
|
|
6111
5633
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
6112
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a
|
|
5634
|
+
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
|
|
6113
5635
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
6114
5636
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
|
|
6115
5637
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.edgeLambdaAutoDiscover">edgeLambdaAutoDiscover</a></code> | <code>boolean</code> | Automatically adds an `cloudfront.experimental.EdgeFunction` for each `.edge-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. |
|
|
@@ -6140,19 +5662,14 @@ const cdkTypeScriptAppOptions: CdkTypeScriptAppOptions = { ... }
|
|
|
6140
5662
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
|
|
6141
5663
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
6142
5664
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | The maximum node version supported by this package. |
|
|
6143
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.mergify">mergify</a></code> | <code>boolean</code> | Whether mergify should be enabled on this repository or not. |
|
|
6144
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.mergifyOptions">mergifyOptions</a></code> | <code>projen.github.MergifyOptions</code> | Options for mergify. |
|
|
6145
5665
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
6146
5666
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
6147
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
|
|
6148
5667
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.nextVersionCommand">nextVersionCommand</a></code> | <code>string</code> | A shell command to control the next version to release. |
|
|
6149
5668
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
|
|
6150
5669
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.npmDistTag">npmDistTag</a></code> | <code>string</code> | The npmDistTag to use when publishing from the default branch. |
|
|
6151
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
|
|
6152
5670
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
|
|
6153
5671
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
|
|
6154
5672
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
|
|
6155
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
6156
5673
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
6157
5674
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
6158
5675
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
|
|
@@ -6169,7 +5686,6 @@ const cdkTypeScriptAppOptions: CdkTypeScriptAppOptions = { ... }
|
|
|
6169
5686
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
|
|
6170
5687
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
|
|
6171
5688
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.projectTree">projectTree</a></code> | <code>boolean</code> | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. |
|
|
6172
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
6173
5689
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
6174
5690
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
6175
5691
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.projenDevDependency">projenDevDependency</a></code> | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency. |
|
|
@@ -6179,7 +5695,6 @@ const cdkTypeScriptAppOptions: CdkTypeScriptAppOptions = { ... }
|
|
|
6179
5695
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.projenrcJsOptions">projenrcJsOptions</a></code> | <code>projen.javascript.ProjenrcOptions</code> | Options for .projenrc.js. |
|
|
6180
5696
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.projenrcTs">projenrcTs</a></code> | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`). |
|
|
6181
5697
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.projenrcTsOptions">projenrcTsOptions</a></code> | <code>projen.typescript.ProjenrcOptions</code> | Options for .projenrc.ts. |
|
|
6182
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.projenTokenSecret">projenTokenSecret</a></code> | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
|
|
6183
5698
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.projenVersion">projenVersion</a></code> | <code>string</code> | Version of projen to install. |
|
|
6184
5699
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.publishDryRun">publishDryRun</a></code> | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command. |
|
|
6185
5700
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
|
|
@@ -6190,14 +5705,11 @@ const cdkTypeScriptAppOptions: CdkTypeScriptAppOptions = { ... }
|
|
|
6190
5705
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
|
|
6191
5706
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
6192
5707
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
6193
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
6194
5708
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
6195
5709
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
6196
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
6197
5710
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. |
|
|
6198
5711
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
6199
5712
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
6200
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
6201
5713
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
6202
5714
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
6203
5715
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
@@ -6206,9 +5718,9 @@ const cdkTypeScriptAppOptions: CdkTypeScriptAppOptions = { ... }
|
|
|
6206
5718
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
|
|
6207
5719
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
|
|
6208
5720
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.requireApproval">requireApproval</a></code> | <code>projen.awscdk.ApprovalLevel</code> | 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. |
|
|
5721
|
+
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner to use for executing TypeScript files. |
|
|
6209
5722
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.sampleCode">sampleCode</a></code> | <code>boolean</code> | Generate one-time sample in `src/` and `test/` if there are no files there. |
|
|
6210
5723
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
6211
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.scripts">scripts</a></code> | <code>{[ key: string ]: string}</code> | npm scripts to include. |
|
|
6212
5724
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.singletonLambdaAutoDiscover">singletonLambdaAutoDiscover</a></code> | <code>boolean</code> | Automatically adds an `awscdk.SingletonFunction` for each `.singleton-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. |
|
|
6213
5725
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.srcdir">srcdir</a></code> | <code>string</code> | Typescript sources directory. |
|
|
6214
5726
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
@@ -6217,7 +5729,7 @@ const cdkTypeScriptAppOptions: CdkTypeScriptAppOptions = { ... }
|
|
|
6217
5729
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.testdir">testdir</a></code> | <code>string</code> | Jest tests directory. |
|
|
6218
5730
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
|
|
6219
5731
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
6220
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig
|
|
5732
|
+
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
6221
5733
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
6222
5734
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
6223
5735
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
@@ -6599,21 +6111,6 @@ Options for PR build workflow.
|
|
|
6599
6111
|
|
|
6600
6112
|
---
|
|
6601
6113
|
|
|
6602
|
-
##### ~~`buildWorkflowTriggers`~~<sup>Optional</sup> <a name="buildWorkflowTriggers" id="projen-modules.CdkTypeScriptAppOptions.property.buildWorkflowTriggers"></a>
|
|
6603
|
-
|
|
6604
|
-
- *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers`
|
|
6605
|
-
|
|
6606
|
-
```typescript
|
|
6607
|
-
public readonly buildWorkflowTriggers: Triggers;
|
|
6608
|
-
```
|
|
6609
|
-
|
|
6610
|
-
- *Type:* projen.github.workflows.Triggers
|
|
6611
|
-
- *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
|
|
6612
|
-
|
|
6613
|
-
Build workflow triggers.
|
|
6614
|
-
|
|
6615
|
-
---
|
|
6616
|
-
|
|
6617
6114
|
##### `bumpPackage`<sup>Optional</sup> <a name="bumpPackage" id="projen-modules.CdkTypeScriptAppOptions.property.bumpPackage"></a>
|
|
6618
6115
|
|
|
6619
6116
|
```typescript
|
|
@@ -6658,109 +6155,40 @@ this will be what your `package.json` will eventually include.
|
|
|
6658
6155
|
public readonly bundlerOptions: BundlerOptions;
|
|
6659
6156
|
```
|
|
6660
6157
|
|
|
6661
|
-
- *Type:* projen.javascript.BundlerOptions
|
|
6662
|
-
|
|
6663
|
-
Options for `Bundler`.
|
|
6664
|
-
|
|
6665
|
-
---
|
|
6666
|
-
|
|
6667
|
-
##### `bunVersion`<sup>Optional</sup> <a name="bunVersion" id="projen-modules.CdkTypeScriptAppOptions.property.bunVersion"></a>
|
|
6668
|
-
|
|
6669
|
-
```typescript
|
|
6670
|
-
public readonly bunVersion: string;
|
|
6671
|
-
```
|
|
6672
|
-
|
|
6673
|
-
- *Type:* string
|
|
6674
|
-
- *Default:* "latest"
|
|
6675
|
-
|
|
6676
|
-
The version of Bun to use if using Bun as a package manager.
|
|
6677
|
-
|
|
6678
|
-
---
|
|
6679
|
-
|
|
6680
|
-
##### ~~`cdkAssert`~~<sup>Optional</sup> <a name="cdkAssert" id="projen-modules.CdkTypeScriptAppOptions.property.cdkAssert"></a>
|
|
6681
|
-
|
|
6682
|
-
- *Deprecated:* The
|
|
6683
|
-
|
|
6684
|
-
```typescript
|
|
6685
|
-
public readonly cdkAssert: boolean;
|
|
6686
|
-
```
|
|
6687
|
-
|
|
6688
|
-
- *Type:* boolean
|
|
6689
|
-
- *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0
|
|
6690
|
-
|
|
6691
|
-
Warning: NodeJS only.
|
|
6692
|
-
|
|
6693
|
-
Install the
|
|
6694
|
-
|
|
6695
|
-
---
|
|
6696
|
-
|
|
6697
|
-
##### `cdkAssertions`<sup>Optional</sup> <a name="cdkAssertions" id="projen-modules.CdkTypeScriptAppOptions.property.cdkAssertions"></a>
|
|
6698
|
-
|
|
6699
|
-
```typescript
|
|
6700
|
-
public readonly cdkAssertions: boolean;
|
|
6701
|
-
```
|
|
6702
|
-
|
|
6703
|
-
- *Type:* boolean
|
|
6704
|
-
- *Default:* will be included by default for AWS CDK >= 1.111.0 < 2.0.0
|
|
6705
|
-
|
|
6706
|
-
Install the assertions library?
|
|
6707
|
-
|
|
6708
|
-
Only needed for CDK 1.x. If using CDK 2.x then
|
|
6709
|
-
assertions is already included in 'aws-cdk-lib'
|
|
6710
|
-
|
|
6711
|
-
---
|
|
6712
|
-
|
|
6713
|
-
##### `cdkCliVersion`<sup>Optional</sup> <a name="cdkCliVersion" id="projen-modules.CdkTypeScriptAppOptions.property.cdkCliVersion"></a>
|
|
6714
|
-
|
|
6715
|
-
```typescript
|
|
6716
|
-
public readonly cdkCliVersion: string;
|
|
6717
|
-
```
|
|
6718
|
-
|
|
6719
|
-
- *Type:* string
|
|
6720
|
-
- *Default:* "^2"
|
|
6721
|
-
|
|
6722
|
-
Version range of the AWS CDK CLI to depend on.
|
|
6723
|
-
|
|
6724
|
-
Can be either a specific version, or an NPM version range.
|
|
6158
|
+
- *Type:* projen.javascript.BundlerOptions
|
|
6725
6159
|
|
|
6726
|
-
|
|
6727
|
-
option to restrict it to a specific version or version range.
|
|
6160
|
+
Options for `Bundler`.
|
|
6728
6161
|
|
|
6729
6162
|
---
|
|
6730
6163
|
|
|
6731
|
-
#####
|
|
6732
|
-
|
|
6733
|
-
- *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)
|
|
6164
|
+
##### `bunVersion`<sup>Optional</sup> <a name="bunVersion" id="projen-modules.CdkTypeScriptAppOptions.property.bunVersion"></a>
|
|
6734
6165
|
|
|
6735
6166
|
```typescript
|
|
6736
|
-
public readonly
|
|
6167
|
+
public readonly bunVersion: string;
|
|
6737
6168
|
```
|
|
6738
6169
|
|
|
6739
|
-
- *Type:* string
|
|
6170
|
+
- *Type:* string
|
|
6171
|
+
- *Default:* "latest"
|
|
6740
6172
|
|
|
6741
|
-
|
|
6173
|
+
The version of Bun to use if using Bun as a package manager.
|
|
6742
6174
|
|
|
6743
6175
|
---
|
|
6744
6176
|
|
|
6745
|
-
#####
|
|
6746
|
-
|
|
6747
|
-
- *Deprecated:* Not supported in CDK v2.
|
|
6177
|
+
##### `cdkCliVersion`<sup>Optional</sup> <a name="cdkCliVersion" id="projen-modules.CdkTypeScriptAppOptions.property.cdkCliVersion"></a>
|
|
6748
6178
|
|
|
6749
6179
|
```typescript
|
|
6750
|
-
public readonly
|
|
6180
|
+
public readonly cdkCliVersion: string;
|
|
6751
6181
|
```
|
|
6752
6182
|
|
|
6753
|
-
- *Type:*
|
|
6754
|
-
- *Default:*
|
|
6183
|
+
- *Type:* string
|
|
6184
|
+
- *Default:* "^2"
|
|
6755
6185
|
|
|
6756
|
-
|
|
6186
|
+
Version range of the AWS CDK CLI to depend on.
|
|
6757
6187
|
|
|
6758
|
-
|
|
6759
|
-
when using npm < 7 or yarn, where peer dependencies are not automatically installed.
|
|
6760
|
-
If this is disabled, `cdkDependencies` will be added to `devDependencies` to ensure
|
|
6761
|
-
they are present during development.
|
|
6188
|
+
Can be either a specific version, or an NPM version range.
|
|
6762
6189
|
|
|
6763
|
-
|
|
6190
|
+
By default, the latest 2.x version will be installed; you can use this
|
|
6191
|
+
option to restrict it to a specific version or version range.
|
|
6764
6192
|
|
|
6765
6193
|
---
|
|
6766
6194
|
|
|
@@ -6777,20 +6205,6 @@ cdk.out directory.
|
|
|
6777
6205
|
|
|
6778
6206
|
---
|
|
6779
6207
|
|
|
6780
|
-
##### ~~`cdkTestDependencies`~~<sup>Optional</sup> <a name="cdkTestDependencies" id="projen-modules.CdkTypeScriptAppOptions.property.cdkTestDependencies"></a>
|
|
6781
|
-
|
|
6782
|
-
- *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead
|
|
6783
|
-
|
|
6784
|
-
```typescript
|
|
6785
|
-
public readonly cdkTestDependencies: string[];
|
|
6786
|
-
```
|
|
6787
|
-
|
|
6788
|
-
- *Type:* string[]
|
|
6789
|
-
|
|
6790
|
-
AWS CDK modules required for testing.
|
|
6791
|
-
|
|
6792
|
-
---
|
|
6793
|
-
|
|
6794
6208
|
##### `cdkVersionPinning`<sup>Optional</sup> <a name="cdkVersionPinning" id="projen-modules.CdkTypeScriptAppOptions.property.cdkVersionPinning"></a>
|
|
6795
6209
|
|
|
6796
6210
|
```typescript
|
|
@@ -7133,7 +6547,7 @@ public readonly disableTsconfigDev: boolean;
|
|
|
7133
6547
|
- *Type:* boolean
|
|
7134
6548
|
- *Default:* false
|
|
7135
6549
|
|
|
7136
|
-
Do not generate a
|
|
6550
|
+
Do not generate a development tsconfig file.
|
|
7137
6551
|
|
|
7138
6552
|
---
|
|
7139
6553
|
|
|
@@ -7537,36 +6951,6 @@ Consider this option only if your package is known to not function with newer ve
|
|
|
7537
6951
|
|
|
7538
6952
|
---
|
|
7539
6953
|
|
|
7540
|
-
##### ~~`mergify`~~<sup>Optional</sup> <a name="mergify" id="projen-modules.CdkTypeScriptAppOptions.property.mergify"></a>
|
|
7541
|
-
|
|
7542
|
-
- *Deprecated:* use `githubOptions.mergify` instead
|
|
7543
|
-
|
|
7544
|
-
```typescript
|
|
7545
|
-
public readonly mergify: boolean;
|
|
7546
|
-
```
|
|
7547
|
-
|
|
7548
|
-
- *Type:* boolean
|
|
7549
|
-
- *Default:* true
|
|
7550
|
-
|
|
7551
|
-
Whether mergify should be enabled on this repository or not.
|
|
7552
|
-
|
|
7553
|
-
---
|
|
7554
|
-
|
|
7555
|
-
##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="mergifyOptions" id="projen-modules.CdkTypeScriptAppOptions.property.mergifyOptions"></a>
|
|
7556
|
-
|
|
7557
|
-
- *Deprecated:* use `githubOptions.mergifyOptions` instead
|
|
7558
|
-
|
|
7559
|
-
```typescript
|
|
7560
|
-
public readonly mergifyOptions: MergifyOptions;
|
|
7561
|
-
```
|
|
7562
|
-
|
|
7563
|
-
- *Type:* projen.github.MergifyOptions
|
|
7564
|
-
- *Default:* default options
|
|
7565
|
-
|
|
7566
|
-
Options for mergify.
|
|
7567
|
-
|
|
7568
|
-
---
|
|
7569
|
-
|
|
7570
6954
|
##### `minMajorVersion`<sup>Optional</sup> <a name="minMajorVersion" id="projen-modules.CdkTypeScriptAppOptions.property.minMajorVersion"></a>
|
|
7571
6955
|
|
|
7572
6956
|
```typescript
|
|
@@ -7609,27 +6993,6 @@ To change the node version of your CI/CD workflows, use `workflowNodeVersion`.
|
|
|
7609
6993
|
|
|
7610
6994
|
---
|
|
7611
6995
|
|
|
7612
|
-
##### ~~`mutableBuild`~~<sup>Optional</sup> <a name="mutableBuild" id="projen-modules.CdkTypeScriptAppOptions.property.mutableBuild"></a>
|
|
7613
|
-
|
|
7614
|
-
- *Deprecated:* - Use `buildWorkflowOptions.mutableBuild`
|
|
7615
|
-
|
|
7616
|
-
```typescript
|
|
7617
|
-
public readonly mutableBuild: boolean;
|
|
7618
|
-
```
|
|
7619
|
-
|
|
7620
|
-
- *Type:* boolean
|
|
7621
|
-
- *Default:* true
|
|
7622
|
-
|
|
7623
|
-
Automatically update files modified during builds to pull-request branches.
|
|
7624
|
-
|
|
7625
|
-
This means
|
|
7626
|
-
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
|
7627
|
-
before a PR is merged.
|
|
7628
|
-
|
|
7629
|
-
Implies that PR builds do not have anti-tamper checks.
|
|
7630
|
-
|
|
7631
|
-
---
|
|
7632
|
-
|
|
7633
6996
|
##### `nextVersionCommand`<sup>Optional</sup> <a name="nextVersionCommand" id="projen-modules.CdkTypeScriptAppOptions.property.nextVersionCommand"></a>
|
|
7634
6997
|
|
|
7635
6998
|
```typescript
|
|
@@ -7691,20 +7054,6 @@ for each branch.
|
|
|
7691
7054
|
|
|
7692
7055
|
---
|
|
7693
7056
|
|
|
7694
|
-
##### ~~`npmignore`~~<sup>Optional</sup> <a name="npmignore" id="projen-modules.CdkTypeScriptAppOptions.property.npmignore"></a>
|
|
7695
|
-
|
|
7696
|
-
- *Deprecated:* - use `project.addPackageIgnore`
|
|
7697
|
-
|
|
7698
|
-
```typescript
|
|
7699
|
-
public readonly npmignore: string[];
|
|
7700
|
-
```
|
|
7701
|
-
|
|
7702
|
-
- *Type:* string[]
|
|
7703
|
-
|
|
7704
|
-
Additional entries to .npmignore.
|
|
7705
|
-
|
|
7706
|
-
---
|
|
7707
|
-
|
|
7708
7057
|
##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="projen-modules.CdkTypeScriptAppOptions.property.npmignoreEnabled"></a>
|
|
7709
7058
|
|
|
7710
7059
|
```typescript
|
|
@@ -7749,22 +7098,6 @@ which is using npm internally and supports provenance statements independently o
|
|
|
7749
7098
|
|
|
7750
7099
|
---
|
|
7751
7100
|
|
|
7752
|
-
##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="npmRegistry" id="projen-modules.CdkTypeScriptAppOptions.property.npmRegistry"></a>
|
|
7753
|
-
|
|
7754
|
-
- *Deprecated:* use `npmRegistryUrl` instead
|
|
7755
|
-
|
|
7756
|
-
```typescript
|
|
7757
|
-
public readonly npmRegistry: string;
|
|
7758
|
-
```
|
|
7759
|
-
|
|
7760
|
-
- *Type:* string
|
|
7761
|
-
|
|
7762
|
-
The host name of the npm registry to publish to.
|
|
7763
|
-
|
|
7764
|
-
Cannot be set together with `npmRegistryUrl`.
|
|
7765
|
-
|
|
7766
|
-
---
|
|
7767
|
-
|
|
7768
7101
|
##### `npmRegistryUrl`<sup>Optional</sup> <a name="npmRegistryUrl" id="projen-modules.CdkTypeScriptAppOptions.property.npmRegistryUrl"></a>
|
|
7769
7102
|
|
|
7770
7103
|
```typescript
|
|
@@ -7920,7 +7253,7 @@ public readonly pnpmVersion: string;
|
|
|
7920
7253
|
```
|
|
7921
7254
|
|
|
7922
7255
|
- *Type:* string
|
|
7923
|
-
- *Default:* "
|
|
7256
|
+
- *Default:* "10.33.0"
|
|
7924
7257
|
|
|
7925
7258
|
The version of PNPM to use if using PNPM as a package manager.
|
|
7926
7259
|
|
|
@@ -7991,21 +7324,6 @@ Generate a project tree file (`.projen/tree.json`) that shows all components and
|
|
|
7991
7324
|
|
|
7992
7325
|
---
|
|
7993
7326
|
|
|
7994
|
-
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="projen-modules.CdkTypeScriptAppOptions.property.projectType"></a>
|
|
7995
|
-
|
|
7996
|
-
- *Deprecated:* no longer supported at the base project level
|
|
7997
|
-
|
|
7998
|
-
```typescript
|
|
7999
|
-
public readonly projectType: ProjectType;
|
|
8000
|
-
```
|
|
8001
|
-
|
|
8002
|
-
- *Type:* projen.ProjectType
|
|
8003
|
-
- *Default:* ProjectType.UNKNOWN
|
|
8004
|
-
|
|
8005
|
-
Which type of project this is (library/app).
|
|
8006
|
-
|
|
8007
|
-
---
|
|
8008
|
-
|
|
8009
7327
|
##### `projenCommand`<sup>Optional</sup> <a name="projenCommand" id="projen-modules.CdkTypeScriptAppOptions.property.projenCommand"></a>
|
|
8010
7328
|
|
|
8011
7329
|
```typescript
|
|
@@ -8124,24 +7442,6 @@ Options for .projenrc.ts.
|
|
|
8124
7442
|
|
|
8125
7443
|
---
|
|
8126
7444
|
|
|
8127
|
-
##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="projenTokenSecret" id="projen-modules.CdkTypeScriptAppOptions.property.projenTokenSecret"></a>
|
|
8128
|
-
|
|
8129
|
-
- *Deprecated:* use `projenCredentials`
|
|
8130
|
-
|
|
8131
|
-
```typescript
|
|
8132
|
-
public readonly projenTokenSecret: string;
|
|
8133
|
-
```
|
|
8134
|
-
|
|
8135
|
-
- *Type:* string
|
|
8136
|
-
- *Default:* "PROJEN_GITHUB_TOKEN"
|
|
8137
|
-
|
|
8138
|
-
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
|
|
8139
|
-
|
|
8140
|
-
This token needs to have the `repo`, `workflows`
|
|
8141
|
-
and `packages` scope.
|
|
8142
|
-
|
|
8143
|
-
---
|
|
8144
|
-
|
|
8145
7445
|
##### `projenVersion`<sup>Optional</sup> <a name="projenVersion" id="projen-modules.CdkTypeScriptAppOptions.property.projenVersion"></a>
|
|
8146
7446
|
|
|
8147
7447
|
```typescript
|
|
@@ -8287,21 +7587,6 @@ on a per artifact basis.
|
|
|
8287
7587
|
|
|
8288
7588
|
---
|
|
8289
7589
|
|
|
8290
|
-
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="projen-modules.CdkTypeScriptAppOptions.property.releaseEveryCommit"></a>
|
|
8291
|
-
|
|
8292
|
-
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
8293
|
-
|
|
8294
|
-
```typescript
|
|
8295
|
-
public readonly releaseEveryCommit: boolean;
|
|
8296
|
-
```
|
|
8297
|
-
|
|
8298
|
-
- *Type:* boolean
|
|
8299
|
-
- *Default:* true
|
|
8300
|
-
|
|
8301
|
-
Automatically release new versions every commit to one of branches in `releaseBranches`.
|
|
8302
|
-
|
|
8303
|
-
---
|
|
8304
|
-
|
|
8305
7590
|
##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="projen-modules.CdkTypeScriptAppOptions.property.releaseFailureIssue"></a>
|
|
8306
7591
|
|
|
8307
7592
|
```typescript
|
|
@@ -8330,21 +7615,6 @@ Only applies if `releaseFailureIssue` is true.
|
|
|
8330
7615
|
|
|
8331
7616
|
---
|
|
8332
7617
|
|
|
8333
|
-
##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="releaseSchedule" id="projen-modules.CdkTypeScriptAppOptions.property.releaseSchedule"></a>
|
|
8334
|
-
|
|
8335
|
-
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
|
|
8336
|
-
|
|
8337
|
-
```typescript
|
|
8338
|
-
public readonly releaseSchedule: string;
|
|
8339
|
-
```
|
|
8340
|
-
|
|
8341
|
-
- *Type:* string
|
|
8342
|
-
- *Default:* no scheduled releases
|
|
8343
|
-
|
|
8344
|
-
CRON schedule to trigger new releases.
|
|
8345
|
-
|
|
8346
|
-
---
|
|
8347
|
-
|
|
8348
7618
|
##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="projen-modules.CdkTypeScriptAppOptions.property.releaseTagPrefix"></a>
|
|
8349
7619
|
|
|
8350
7620
|
```typescript
|
|
@@ -8390,21 +7660,6 @@ The release trigger to use.
|
|
|
8390
7660
|
|
|
8391
7661
|
---
|
|
8392
7662
|
|
|
8393
|
-
##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="releaseWorkflow" id="projen-modules.CdkTypeScriptAppOptions.property.releaseWorkflow"></a>
|
|
8394
|
-
|
|
8395
|
-
- *Deprecated:* see `release`.
|
|
8396
|
-
|
|
8397
|
-
```typescript
|
|
8398
|
-
public readonly releaseWorkflow: boolean;
|
|
8399
|
-
```
|
|
8400
|
-
|
|
8401
|
-
- *Type:* boolean
|
|
8402
|
-
- *Default:* true if not a subproject
|
|
8403
|
-
|
|
8404
|
-
DEPRECATED: renamed to `release`.
|
|
8405
|
-
|
|
8406
|
-
---
|
|
8407
|
-
|
|
8408
7663
|
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="projen-modules.CdkTypeScriptAppOptions.property.releaseWorkflowEnv"></a>
|
|
8409
7664
|
|
|
8410
7665
|
```typescript
|
|
@@ -8508,6 +7763,22 @@ To protect you against unintended changes that affect your security posture, the
|
|
|
8508
7763
|
|
|
8509
7764
|
---
|
|
8510
7765
|
|
|
7766
|
+
##### `runner`<sup>Optional</sup> <a name="runner" id="projen-modules.CdkTypeScriptAppOptions.property.runner"></a>
|
|
7767
|
+
|
|
7768
|
+
```typescript
|
|
7769
|
+
public readonly runner: TypeScriptRunner;
|
|
7770
|
+
```
|
|
7771
|
+
|
|
7772
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
7773
|
+
- *Default:* TypeScriptRunner.tsNode()
|
|
7774
|
+
|
|
7775
|
+
The TypeScript runner to use for executing TypeScript files.
|
|
7776
|
+
|
|
7777
|
+
This is a project-level setting that components (e.g. projenrc) will
|
|
7778
|
+
use as their default runner.
|
|
7779
|
+
|
|
7780
|
+
---
|
|
7781
|
+
|
|
8511
7782
|
##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="projen-modules.CdkTypeScriptAppOptions.property.sampleCode"></a>
|
|
8512
7783
|
|
|
8513
7784
|
```typescript
|
|
@@ -8534,25 +7805,6 @@ Options for privately hosted scoped packages.
|
|
|
8534
7805
|
|
|
8535
7806
|
---
|
|
8536
7807
|
|
|
8537
|
-
##### ~~`scripts`~~<sup>Optional</sup> <a name="scripts" id="projen-modules.CdkTypeScriptAppOptions.property.scripts"></a>
|
|
8538
|
-
|
|
8539
|
-
- *Deprecated:* use `project.addTask()` or `package.setScript()`
|
|
8540
|
-
|
|
8541
|
-
```typescript
|
|
8542
|
-
public readonly scripts: {[ key: string ]: string};
|
|
8543
|
-
```
|
|
8544
|
-
|
|
8545
|
-
- *Type:* {[ key: string ]: string}
|
|
8546
|
-
- *Default:* {}
|
|
8547
|
-
|
|
8548
|
-
npm scripts to include.
|
|
8549
|
-
|
|
8550
|
-
If a script has the same name as a standard script,
|
|
8551
|
-
the standard script will be overwritten.
|
|
8552
|
-
Also adds the script as a task.
|
|
8553
|
-
|
|
8554
|
-
---
|
|
8555
|
-
|
|
8556
7808
|
##### `singletonLambdaAutoDiscover`<sup>Optional</sup> <a name="singletonLambdaAutoDiscover" id="projen-modules.CdkTypeScriptAppOptions.property.singletonLambdaAutoDiscover"></a>
|
|
8557
7809
|
|
|
8558
7810
|
```typescript
|
|
@@ -8673,9 +7925,13 @@ public readonly tsconfigDevFile: string;
|
|
|
8673
7925
|
```
|
|
8674
7926
|
|
|
8675
7927
|
- *Type:* string
|
|
8676
|
-
- *Default:* "tsconfig.
|
|
7928
|
+
- *Default:* "{testdir}/tsconfig.json"
|
|
7929
|
+
|
|
7930
|
+
The name (and path) of the development tsconfig file.
|
|
8677
7931
|
|
|
8678
|
-
|
|
7932
|
+
By default this lives inside the test directory (e.g. `test/tsconfig.json`)
|
|
7933
|
+
so that the TypeScript language service resolves it as the nearest config
|
|
7934
|
+
for test files.
|
|
8679
7935
|
|
|
8680
7936
|
---
|
|
8681
7937
|
|
|
@@ -8910,7 +8166,6 @@ const jsiiProjectOptions: JsiiProjectOptions = { ... }
|
|
|
8910
8166
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
|
|
8911
8167
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
|
|
8912
8168
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
8913
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
|
8914
8169
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.bumpPackage">bumpPackage</a></code> | <code>string</code> | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. |
|
|
8915
8170
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
8916
8171
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
@@ -8938,11 +8193,10 @@ const jsiiProjectOptions: JsiiProjectOptions = { ... }
|
|
|
8938
8193
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
|
|
8939
8194
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.devEngines">devEngines</a></code> | <code>projen.javascript.DevEngines</code> | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. |
|
|
8940
8195
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
8941
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a
|
|
8196
|
+
| <code><a href="#projen-modules.JsiiProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
|
|
8942
8197
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
8943
8198
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.docgenFilePath">docgenFilePath</a></code> | <code>string</code> | File path for generated docs. |
|
|
8944
8199
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
|
|
8945
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.dotnet">dotnet</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | *No description.* |
|
|
8946
8200
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.entrypoint">entrypoint</a></code> | <code>string</code> | Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json. |
|
|
8947
8201
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.entrypointTypes">entrypointTypes</a></code> | <code>string</code> | The .d.ts file that includes the type declarations for this module. |
|
|
8948
8202
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.eslint">eslint</a></code> | <code>boolean</code> | Setup eslint. |
|
|
@@ -8966,19 +8220,14 @@ const jsiiProjectOptions: JsiiProjectOptions = { ... }
|
|
|
8966
8220
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
|
|
8967
8221
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
8968
8222
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | The maximum node version supported by this package. |
|
|
8969
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.mergify">mergify</a></code> | <code>boolean</code> | Whether mergify should be enabled on this repository or not. |
|
|
8970
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.mergifyOptions">mergifyOptions</a></code> | <code>projen.github.MergifyOptions</code> | Options for mergify. |
|
|
8971
8223
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
8972
8224
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
8973
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
|
|
8974
8225
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.nextVersionCommand">nextVersionCommand</a></code> | <code>string</code> | A shell command to control the next version to release. |
|
|
8975
8226
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
|
|
8976
8227
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.npmDistTag">npmDistTag</a></code> | <code>string</code> | The npmDistTag to use when publishing from the default branch. |
|
|
8977
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
|
|
8978
8228
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
|
|
8979
8229
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
|
|
8980
8230
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
|
|
8981
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
8982
8231
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
8983
8232
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
8984
8233
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
|
|
@@ -8995,7 +8244,6 @@ const jsiiProjectOptions: JsiiProjectOptions = { ... }
|
|
|
8995
8244
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
|
|
8996
8245
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
|
|
8997
8246
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.projectTree">projectTree</a></code> | <code>boolean</code> | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. |
|
|
8998
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
8999
8247
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
9000
8248
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
9001
8249
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.projenDevDependency">projenDevDependency</a></code> | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency. |
|
|
@@ -9005,7 +8253,6 @@ const jsiiProjectOptions: JsiiProjectOptions = { ... }
|
|
|
9005
8253
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.projenrcJsOptions">projenrcJsOptions</a></code> | <code>projen.javascript.ProjenrcOptions</code> | Options for .projenrc.js. |
|
|
9006
8254
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.projenrcTs">projenrcTs</a></code> | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`). |
|
|
9007
8255
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.projenrcTsOptions">projenrcTsOptions</a></code> | <code>projen.typescript.ProjenrcOptions</code> | Options for .projenrc.ts. |
|
|
9008
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.projenTokenSecret">projenTokenSecret</a></code> | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
|
|
9009
8256
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.projenVersion">projenVersion</a></code> | <code>string</code> | Version of projen to install. |
|
|
9010
8257
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.publishDryRun">publishDryRun</a></code> | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command. |
|
|
9011
8258
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
|
|
@@ -9015,20 +8262,16 @@ const jsiiProjectOptions: JsiiProjectOptions = { ... }
|
|
|
9015
8262
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.publishToPypi">publishToPypi</a></code> | <code>projen.cdk.JsiiPythonTarget</code> | Publish to pypi. |
|
|
9016
8263
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.pullRequestTemplate">pullRequestTemplate</a></code> | <code>boolean</code> | Include a GitHub pull request template. |
|
|
9017
8264
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.pullRequestTemplateContents">pullRequestTemplateContents</a></code> | <code>string[]</code> | The contents of the pull request template. |
|
|
9018
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.python">python</a></code> | <code>projen.cdk.JsiiPythonTarget</code> | *No description.* |
|
|
9019
8265
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.readme">readme</a></code> | <code><a href="#projen-modules.ReadmeOptions">ReadmeOptions</a></code> | Configuration of the README.md file. |
|
|
9020
8266
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
9021
8267
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
|
|
9022
8268
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
9023
8269
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
9024
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
9025
8270
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
9026
8271
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
9027
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
9028
8272
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. |
|
|
9029
8273
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
9030
8274
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
9031
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
9032
8275
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
9033
8276
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
9034
8277
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
@@ -9037,9 +8280,9 @@ const jsiiProjectOptions: JsiiProjectOptions = { ... }
|
|
|
9037
8280
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
|
|
9038
8281
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
|
|
9039
8282
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.rootdir">rootdir</a></code> | <code>string</code> | *No description.* |
|
|
8283
|
+
| <code><a href="#projen-modules.JsiiProjectOptions.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner to use for executing TypeScript files. |
|
|
9040
8284
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.sampleCode">sampleCode</a></code> | <code>boolean</code> | Generate one-time sample in `src/` and `test/` if there are no files there. |
|
|
9041
8285
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
9042
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.scripts">scripts</a></code> | <code>{[ key: string ]: string}</code> | npm scripts to include. |
|
|
9043
8286
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.srcdir">srcdir</a></code> | <code>string</code> | Typescript sources directory. |
|
|
9044
8287
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
9045
8288
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
|
|
@@ -9047,9 +8290,10 @@ const jsiiProjectOptions: JsiiProjectOptions = { ... }
|
|
|
9047
8290
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.testdir">testdir</a></code> | <code>string</code> | Jest tests directory. |
|
|
9048
8291
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
|
|
9049
8292
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
9050
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig
|
|
8293
|
+
| <code><a href="#projen-modules.JsiiProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
9051
8294
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
9052
8295
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
8296
|
+
| <code><a href="#projen-modules.JsiiProjectOptions.property.validateTsconfig">validateTsconfig</a></code> | <code>projen.cdk.ValidateTsconfig</code> | Level of tsconfig validation jsii should perform on the user-provided tsconfig. |
|
|
9053
8297
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
9054
8298
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
|
|
9055
8299
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
|
|
@@ -9411,21 +8655,6 @@ Options for PR build workflow.
|
|
|
9411
8655
|
|
|
9412
8656
|
---
|
|
9413
8657
|
|
|
9414
|
-
##### ~~`buildWorkflowTriggers`~~<sup>Optional</sup> <a name="buildWorkflowTriggers" id="projen-modules.JsiiProjectOptions.property.buildWorkflowTriggers"></a>
|
|
9415
|
-
|
|
9416
|
-
- *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers`
|
|
9417
|
-
|
|
9418
|
-
```typescript
|
|
9419
|
-
public readonly buildWorkflowTriggers: Triggers;
|
|
9420
|
-
```
|
|
9421
|
-
|
|
9422
|
-
- *Type:* projen.github.workflows.Triggers
|
|
9423
|
-
- *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
|
|
9424
|
-
|
|
9425
|
-
Build workflow triggers.
|
|
9426
|
-
|
|
9427
|
-
---
|
|
9428
|
-
|
|
9429
8658
|
##### `bumpPackage`<sup>Optional</sup> <a name="bumpPackage" id="projen-modules.JsiiProjectOptions.property.bumpPackage"></a>
|
|
9430
8659
|
|
|
9431
8660
|
```typescript
|
|
@@ -9832,7 +9061,7 @@ public readonly disableTsconfigDev: boolean;
|
|
|
9832
9061
|
- *Type:* boolean
|
|
9833
9062
|
- *Default:* false
|
|
9834
9063
|
|
|
9835
|
-
Do not generate a
|
|
9064
|
+
Do not generate a development tsconfig file.
|
|
9836
9065
|
|
|
9837
9066
|
---
|
|
9838
9067
|
|
|
@@ -9875,18 +9104,6 @@ Docs directory.
|
|
|
9875
9104
|
|
|
9876
9105
|
---
|
|
9877
9106
|
|
|
9878
|
-
##### ~~`dotnet`~~<sup>Optional</sup> <a name="dotnet" id="projen-modules.JsiiProjectOptions.property.dotnet"></a>
|
|
9879
|
-
|
|
9880
|
-
- *Deprecated:* use `publishToNuget`
|
|
9881
|
-
|
|
9882
|
-
```typescript
|
|
9883
|
-
public readonly dotnet: JsiiDotNetTarget;
|
|
9884
|
-
```
|
|
9885
|
-
|
|
9886
|
-
- *Type:* projen.cdk.JsiiDotNetTarget
|
|
9887
|
-
|
|
9888
|
-
---
|
|
9889
|
-
|
|
9890
9107
|
##### `entrypoint`<sup>Optional</sup> <a name="entrypoint" id="projen-modules.JsiiProjectOptions.property.entrypoint"></a>
|
|
9891
9108
|
|
|
9892
9109
|
```typescript
|
|
@@ -10206,36 +9423,6 @@ Consider this option only if your package is known to not function with newer ve
|
|
|
10206
9423
|
|
|
10207
9424
|
---
|
|
10208
9425
|
|
|
10209
|
-
##### ~~`mergify`~~<sup>Optional</sup> <a name="mergify" id="projen-modules.JsiiProjectOptions.property.mergify"></a>
|
|
10210
|
-
|
|
10211
|
-
- *Deprecated:* use `githubOptions.mergify` instead
|
|
10212
|
-
|
|
10213
|
-
```typescript
|
|
10214
|
-
public readonly mergify: boolean;
|
|
10215
|
-
```
|
|
10216
|
-
|
|
10217
|
-
- *Type:* boolean
|
|
10218
|
-
- *Default:* true
|
|
10219
|
-
|
|
10220
|
-
Whether mergify should be enabled on this repository or not.
|
|
10221
|
-
|
|
10222
|
-
---
|
|
10223
|
-
|
|
10224
|
-
##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="mergifyOptions" id="projen-modules.JsiiProjectOptions.property.mergifyOptions"></a>
|
|
10225
|
-
|
|
10226
|
-
- *Deprecated:* use `githubOptions.mergifyOptions` instead
|
|
10227
|
-
|
|
10228
|
-
```typescript
|
|
10229
|
-
public readonly mergifyOptions: MergifyOptions;
|
|
10230
|
-
```
|
|
10231
|
-
|
|
10232
|
-
- *Type:* projen.github.MergifyOptions
|
|
10233
|
-
- *Default:* default options
|
|
10234
|
-
|
|
10235
|
-
Options for mergify.
|
|
10236
|
-
|
|
10237
|
-
---
|
|
10238
|
-
|
|
10239
9426
|
##### `minMajorVersion`<sup>Optional</sup> <a name="minMajorVersion" id="projen-modules.JsiiProjectOptions.property.minMajorVersion"></a>
|
|
10240
9427
|
|
|
10241
9428
|
```typescript
|
|
@@ -10278,27 +9465,6 @@ To change the node version of your CI/CD workflows, use `workflowNodeVersion`.
|
|
|
10278
9465
|
|
|
10279
9466
|
---
|
|
10280
9467
|
|
|
10281
|
-
##### ~~`mutableBuild`~~<sup>Optional</sup> <a name="mutableBuild" id="projen-modules.JsiiProjectOptions.property.mutableBuild"></a>
|
|
10282
|
-
|
|
10283
|
-
- *Deprecated:* - Use `buildWorkflowOptions.mutableBuild`
|
|
10284
|
-
|
|
10285
|
-
```typescript
|
|
10286
|
-
public readonly mutableBuild: boolean;
|
|
10287
|
-
```
|
|
10288
|
-
|
|
10289
|
-
- *Type:* boolean
|
|
10290
|
-
- *Default:* true
|
|
10291
|
-
|
|
10292
|
-
Automatically update files modified during builds to pull-request branches.
|
|
10293
|
-
|
|
10294
|
-
This means
|
|
10295
|
-
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
|
10296
|
-
before a PR is merged.
|
|
10297
|
-
|
|
10298
|
-
Implies that PR builds do not have anti-tamper checks.
|
|
10299
|
-
|
|
10300
|
-
---
|
|
10301
|
-
|
|
10302
9468
|
##### `nextVersionCommand`<sup>Optional</sup> <a name="nextVersionCommand" id="projen-modules.JsiiProjectOptions.property.nextVersionCommand"></a>
|
|
10303
9469
|
|
|
10304
9470
|
```typescript
|
|
@@ -10360,20 +9526,6 @@ for each branch.
|
|
|
10360
9526
|
|
|
10361
9527
|
---
|
|
10362
9528
|
|
|
10363
|
-
##### ~~`npmignore`~~<sup>Optional</sup> <a name="npmignore" id="projen-modules.JsiiProjectOptions.property.npmignore"></a>
|
|
10364
|
-
|
|
10365
|
-
- *Deprecated:* - use `project.addPackageIgnore`
|
|
10366
|
-
|
|
10367
|
-
```typescript
|
|
10368
|
-
public readonly npmignore: string[];
|
|
10369
|
-
```
|
|
10370
|
-
|
|
10371
|
-
- *Type:* string[]
|
|
10372
|
-
|
|
10373
|
-
Additional entries to .npmignore.
|
|
10374
|
-
|
|
10375
|
-
---
|
|
10376
|
-
|
|
10377
9529
|
##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="projen-modules.JsiiProjectOptions.property.npmignoreEnabled"></a>
|
|
10378
9530
|
|
|
10379
9531
|
```typescript
|
|
@@ -10418,22 +9570,6 @@ which is using npm internally and supports provenance statements independently o
|
|
|
10418
9570
|
|
|
10419
9571
|
---
|
|
10420
9572
|
|
|
10421
|
-
##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="npmRegistry" id="projen-modules.JsiiProjectOptions.property.npmRegistry"></a>
|
|
10422
|
-
|
|
10423
|
-
- *Deprecated:* use `npmRegistryUrl` instead
|
|
10424
|
-
|
|
10425
|
-
```typescript
|
|
10426
|
-
public readonly npmRegistry: string;
|
|
10427
|
-
```
|
|
10428
|
-
|
|
10429
|
-
- *Type:* string
|
|
10430
|
-
|
|
10431
|
-
The host name of the npm registry to publish to.
|
|
10432
|
-
|
|
10433
|
-
Cannot be set together with `npmRegistryUrl`.
|
|
10434
|
-
|
|
10435
|
-
---
|
|
10436
|
-
|
|
10437
9573
|
##### `npmRegistryUrl`<sup>Optional</sup> <a name="npmRegistryUrl" id="projen-modules.JsiiProjectOptions.property.npmRegistryUrl"></a>
|
|
10438
9574
|
|
|
10439
9575
|
```typescript
|
|
@@ -10589,7 +9725,7 @@ public readonly pnpmVersion: string;
|
|
|
10589
9725
|
```
|
|
10590
9726
|
|
|
10591
9727
|
- *Type:* string
|
|
10592
|
-
- *Default:* "
|
|
9728
|
+
- *Default:* "10.33.0"
|
|
10593
9729
|
|
|
10594
9730
|
The version of PNPM to use if using PNPM as a package manager.
|
|
10595
9731
|
|
|
@@ -10660,21 +9796,6 @@ Generate a project tree file (`.projen/tree.json`) that shows all components and
|
|
|
10660
9796
|
|
|
10661
9797
|
---
|
|
10662
9798
|
|
|
10663
|
-
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="projen-modules.JsiiProjectOptions.property.projectType"></a>
|
|
10664
|
-
|
|
10665
|
-
- *Deprecated:* no longer supported at the base project level
|
|
10666
|
-
|
|
10667
|
-
```typescript
|
|
10668
|
-
public readonly projectType: ProjectType;
|
|
10669
|
-
```
|
|
10670
|
-
|
|
10671
|
-
- *Type:* projen.ProjectType
|
|
10672
|
-
- *Default:* ProjectType.UNKNOWN
|
|
10673
|
-
|
|
10674
|
-
Which type of project this is (library/app).
|
|
10675
|
-
|
|
10676
|
-
---
|
|
10677
|
-
|
|
10678
9799
|
##### `projenCommand`<sup>Optional</sup> <a name="projenCommand" id="projen-modules.JsiiProjectOptions.property.projenCommand"></a>
|
|
10679
9800
|
|
|
10680
9801
|
```typescript
|
|
@@ -10784,30 +9905,12 @@ Use TypeScript for your projenrc file (`.projenrc.ts`).
|
|
|
10784
9905
|
##### `projenrcTsOptions`<sup>Optional</sup> <a name="projenrcTsOptions" id="projen-modules.JsiiProjectOptions.property.projenrcTsOptions"></a>
|
|
10785
9906
|
|
|
10786
9907
|
```typescript
|
|
10787
|
-
public readonly projenrcTsOptions: ProjenrcOptions;
|
|
10788
|
-
```
|
|
10789
|
-
|
|
10790
|
-
- *Type:* projen.typescript.ProjenrcOptions
|
|
10791
|
-
|
|
10792
|
-
Options for .projenrc.ts.
|
|
10793
|
-
|
|
10794
|
-
---
|
|
10795
|
-
|
|
10796
|
-
##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="projenTokenSecret" id="projen-modules.JsiiProjectOptions.property.projenTokenSecret"></a>
|
|
10797
|
-
|
|
10798
|
-
- *Deprecated:* use `projenCredentials`
|
|
10799
|
-
|
|
10800
|
-
```typescript
|
|
10801
|
-
public readonly projenTokenSecret: string;
|
|
9908
|
+
public readonly projenrcTsOptions: ProjenrcOptions;
|
|
10802
9909
|
```
|
|
10803
9910
|
|
|
10804
|
-
- *Type:*
|
|
10805
|
-
- *Default:* "PROJEN_GITHUB_TOKEN"
|
|
10806
|
-
|
|
10807
|
-
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
|
|
9911
|
+
- *Type:* projen.typescript.ProjenrcOptions
|
|
10808
9912
|
|
|
10809
|
-
|
|
10810
|
-
and `packages` scope.
|
|
9913
|
+
Options for .projenrc.ts.
|
|
10811
9914
|
|
|
10812
9915
|
---
|
|
10813
9916
|
|
|
@@ -10931,18 +10034,6 @@ The contents of the pull request template.
|
|
|
10931
10034
|
|
|
10932
10035
|
---
|
|
10933
10036
|
|
|
10934
|
-
##### ~~`python`~~<sup>Optional</sup> <a name="python" id="projen-modules.JsiiProjectOptions.property.python"></a>
|
|
10935
|
-
|
|
10936
|
-
- *Deprecated:* use `publishToPyPi`
|
|
10937
|
-
|
|
10938
|
-
```typescript
|
|
10939
|
-
public readonly python: JsiiPythonTarget;
|
|
10940
|
-
```
|
|
10941
|
-
|
|
10942
|
-
- *Type:* projen.cdk.JsiiPythonTarget
|
|
10943
|
-
|
|
10944
|
-
---
|
|
10945
|
-
|
|
10946
10037
|
##### `readme`<sup>Optional</sup> <a name="readme" id="projen-modules.JsiiProjectOptions.property.readme"></a>
|
|
10947
10038
|
|
|
10948
10039
|
```typescript
|
|
@@ -11020,21 +10111,6 @@ on a per artifact basis.
|
|
|
11020
10111
|
|
|
11021
10112
|
---
|
|
11022
10113
|
|
|
11023
|
-
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="projen-modules.JsiiProjectOptions.property.releaseEveryCommit"></a>
|
|
11024
|
-
|
|
11025
|
-
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
11026
|
-
|
|
11027
|
-
```typescript
|
|
11028
|
-
public readonly releaseEveryCommit: boolean;
|
|
11029
|
-
```
|
|
11030
|
-
|
|
11031
|
-
- *Type:* boolean
|
|
11032
|
-
- *Default:* true
|
|
11033
|
-
|
|
11034
|
-
Automatically release new versions every commit to one of branches in `releaseBranches`.
|
|
11035
|
-
|
|
11036
|
-
---
|
|
11037
|
-
|
|
11038
10114
|
##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="projen-modules.JsiiProjectOptions.property.releaseFailureIssue"></a>
|
|
11039
10115
|
|
|
11040
10116
|
```typescript
|
|
@@ -11063,21 +10139,6 @@ Only applies if `releaseFailureIssue` is true.
|
|
|
11063
10139
|
|
|
11064
10140
|
---
|
|
11065
10141
|
|
|
11066
|
-
##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="releaseSchedule" id="projen-modules.JsiiProjectOptions.property.releaseSchedule"></a>
|
|
11067
|
-
|
|
11068
|
-
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
|
|
11069
|
-
|
|
11070
|
-
```typescript
|
|
11071
|
-
public readonly releaseSchedule: string;
|
|
11072
|
-
```
|
|
11073
|
-
|
|
11074
|
-
- *Type:* string
|
|
11075
|
-
- *Default:* no scheduled releases
|
|
11076
|
-
|
|
11077
|
-
CRON schedule to trigger new releases.
|
|
11078
|
-
|
|
11079
|
-
---
|
|
11080
|
-
|
|
11081
10142
|
##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="projen-modules.JsiiProjectOptions.property.releaseTagPrefix"></a>
|
|
11082
10143
|
|
|
11083
10144
|
```typescript
|
|
@@ -11123,21 +10184,6 @@ The release trigger to use.
|
|
|
11123
10184
|
|
|
11124
10185
|
---
|
|
11125
10186
|
|
|
11126
|
-
##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="releaseWorkflow" id="projen-modules.JsiiProjectOptions.property.releaseWorkflow"></a>
|
|
11127
|
-
|
|
11128
|
-
- *Deprecated:* see `release`.
|
|
11129
|
-
|
|
11130
|
-
```typescript
|
|
11131
|
-
public readonly releaseWorkflow: boolean;
|
|
11132
|
-
```
|
|
11133
|
-
|
|
11134
|
-
- *Type:* boolean
|
|
11135
|
-
- *Default:* true if not a subproject
|
|
11136
|
-
|
|
11137
|
-
DEPRECATED: renamed to `release`.
|
|
11138
|
-
|
|
11139
|
-
---
|
|
11140
|
-
|
|
11141
10187
|
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="projen-modules.JsiiProjectOptions.property.releaseWorkflowEnv"></a>
|
|
11142
10188
|
|
|
11143
10189
|
```typescript
|
|
@@ -11239,6 +10285,22 @@ public readonly rootdir: string;
|
|
|
11239
10285
|
|
|
11240
10286
|
---
|
|
11241
10287
|
|
|
10288
|
+
##### `runner`<sup>Optional</sup> <a name="runner" id="projen-modules.JsiiProjectOptions.property.runner"></a>
|
|
10289
|
+
|
|
10290
|
+
```typescript
|
|
10291
|
+
public readonly runner: TypeScriptRunner;
|
|
10292
|
+
```
|
|
10293
|
+
|
|
10294
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
10295
|
+
- *Default:* TypeScriptRunner.tsNode()
|
|
10296
|
+
|
|
10297
|
+
The TypeScript runner to use for executing TypeScript files.
|
|
10298
|
+
|
|
10299
|
+
This is a project-level setting that components (e.g. projenrc) will
|
|
10300
|
+
use as their default runner.
|
|
10301
|
+
|
|
10302
|
+
---
|
|
10303
|
+
|
|
11242
10304
|
##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="projen-modules.JsiiProjectOptions.property.sampleCode"></a>
|
|
11243
10305
|
|
|
11244
10306
|
```typescript
|
|
@@ -11265,25 +10327,6 @@ Options for privately hosted scoped packages.
|
|
|
11265
10327
|
|
|
11266
10328
|
---
|
|
11267
10329
|
|
|
11268
|
-
##### ~~`scripts`~~<sup>Optional</sup> <a name="scripts" id="projen-modules.JsiiProjectOptions.property.scripts"></a>
|
|
11269
|
-
|
|
11270
|
-
- *Deprecated:* use `project.addTask()` or `package.setScript()`
|
|
11271
|
-
|
|
11272
|
-
```typescript
|
|
11273
|
-
public readonly scripts: {[ key: string ]: string};
|
|
11274
|
-
```
|
|
11275
|
-
|
|
11276
|
-
- *Type:* {[ key: string ]: string}
|
|
11277
|
-
- *Default:* {}
|
|
11278
|
-
|
|
11279
|
-
npm scripts to include.
|
|
11280
|
-
|
|
11281
|
-
If a script has the same name as a standard script,
|
|
11282
|
-
the standard script will be overwritten.
|
|
11283
|
-
Also adds the script as a task.
|
|
11284
|
-
|
|
11285
|
-
---
|
|
11286
|
-
|
|
11287
10330
|
##### `srcdir`<sup>Optional</sup> <a name="srcdir" id="projen-modules.JsiiProjectOptions.property.srcdir"></a>
|
|
11288
10331
|
|
|
11289
10332
|
```typescript
|
|
@@ -11391,9 +10434,13 @@ public readonly tsconfigDevFile: string;
|
|
|
11391
10434
|
```
|
|
11392
10435
|
|
|
11393
10436
|
- *Type:* string
|
|
11394
|
-
- *Default:* "tsconfig.
|
|
10437
|
+
- *Default:* "{testdir}/tsconfig.json"
|
|
10438
|
+
|
|
10439
|
+
The name (and path) of the development tsconfig file.
|
|
11395
10440
|
|
|
11396
|
-
|
|
10441
|
+
By default this lives inside the test directory (e.g. `test/tsconfig.json`)
|
|
10442
|
+
so that the TypeScript language service resolves it as the nearest config
|
|
10443
|
+
for test files.
|
|
11397
10444
|
|
|
11398
10445
|
---
|
|
11399
10446
|
|
|
@@ -11425,6 +10472,22 @@ same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
|
|
|
11425
10472
|
|
|
11426
10473
|
---
|
|
11427
10474
|
|
|
10475
|
+
##### `validateTsconfig`<sup>Optional</sup> <a name="validateTsconfig" id="projen-modules.JsiiProjectOptions.property.validateTsconfig"></a>
|
|
10476
|
+
|
|
10477
|
+
```typescript
|
|
10478
|
+
public readonly validateTsconfig: ValidateTsconfig;
|
|
10479
|
+
```
|
|
10480
|
+
|
|
10481
|
+
- *Type:* projen.cdk.ValidateTsconfig
|
|
10482
|
+
- *Default:* ValidateTsconfig.STRICT
|
|
10483
|
+
|
|
10484
|
+
Level of tsconfig validation jsii should perform on the user-provided tsconfig.
|
|
10485
|
+
|
|
10486
|
+
Only relevant when the project synthesizes its own tsconfig
|
|
10487
|
+
(i.e. `disableTsconfig` is not set on the TypeScriptProject).
|
|
10488
|
+
|
|
10489
|
+
---
|
|
10490
|
+
|
|
11428
10491
|
##### `versionrcOptions`<sup>Optional</sup> <a name="versionrcOptions" id="projen-modules.JsiiProjectOptions.property.versionrcOptions"></a>
|
|
11429
10492
|
|
|
11430
10493
|
```typescript
|
|
@@ -11599,7 +10662,6 @@ const npmPackageOptions: NpmPackageOptions = { ... }
|
|
|
11599
10662
|
| <code><a href="#projen-modules.NpmPackageOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
|
|
11600
10663
|
| <code><a href="#projen-modules.NpmPackageOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
|
|
11601
10664
|
| <code><a href="#projen-modules.NpmPackageOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
11602
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
|
11603
10665
|
| <code><a href="#projen-modules.NpmPackageOptions.property.bumpPackage">bumpPackage</a></code> | <code>string</code> | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. |
|
|
11604
10666
|
| <code><a href="#projen-modules.NpmPackageOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
11605
10667
|
| <code><a href="#projen-modules.NpmPackageOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
@@ -11624,7 +10686,7 @@ const npmPackageOptions: NpmPackageOptions = { ... }
|
|
|
11624
10686
|
| <code><a href="#projen-modules.NpmPackageOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
|
|
11625
10687
|
| <code><a href="#projen-modules.NpmPackageOptions.property.devEngines">devEngines</a></code> | <code>projen.javascript.DevEngines</code> | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. |
|
|
11626
10688
|
| <code><a href="#projen-modules.NpmPackageOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
11627
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a
|
|
10689
|
+
| <code><a href="#projen-modules.NpmPackageOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
|
|
11628
10690
|
| <code><a href="#projen-modules.NpmPackageOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
11629
10691
|
| <code><a href="#projen-modules.NpmPackageOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
|
|
11630
10692
|
| <code><a href="#projen-modules.NpmPackageOptions.property.entrypoint">entrypoint</a></code> | <code>string</code> | Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json. |
|
|
@@ -11648,19 +10710,14 @@ const npmPackageOptions: NpmPackageOptions = { ... }
|
|
|
11648
10710
|
| <code><a href="#projen-modules.NpmPackageOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
|
|
11649
10711
|
| <code><a href="#projen-modules.NpmPackageOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
11650
10712
|
| <code><a href="#projen-modules.NpmPackageOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | The maximum node version supported by this package. |
|
|
11651
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.mergify">mergify</a></code> | <code>boolean</code> | Whether mergify should be enabled on this repository or not. |
|
|
11652
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.mergifyOptions">mergifyOptions</a></code> | <code>projen.github.MergifyOptions</code> | Options for mergify. |
|
|
11653
10713
|
| <code><a href="#projen-modules.NpmPackageOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
11654
10714
|
| <code><a href="#projen-modules.NpmPackageOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
11655
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
|
|
11656
10715
|
| <code><a href="#projen-modules.NpmPackageOptions.property.nextVersionCommand">nextVersionCommand</a></code> | <code>string</code> | A shell command to control the next version to release. |
|
|
11657
10716
|
| <code><a href="#projen-modules.NpmPackageOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
|
|
11658
10717
|
| <code><a href="#projen-modules.NpmPackageOptions.property.npmDistTag">npmDistTag</a></code> | <code>string</code> | The npmDistTag to use when publishing from the default branch. |
|
|
11659
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
|
|
11660
10718
|
| <code><a href="#projen-modules.NpmPackageOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
|
|
11661
10719
|
| <code><a href="#projen-modules.NpmPackageOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
|
|
11662
10720
|
| <code><a href="#projen-modules.NpmPackageOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
|
|
11663
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
11664
10721
|
| <code><a href="#projen-modules.NpmPackageOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
11665
10722
|
| <code><a href="#projen-modules.NpmPackageOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
11666
10723
|
| <code><a href="#projen-modules.NpmPackageOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
|
|
@@ -11677,7 +10734,6 @@ const npmPackageOptions: NpmPackageOptions = { ... }
|
|
|
11677
10734
|
| <code><a href="#projen-modules.NpmPackageOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
|
|
11678
10735
|
| <code><a href="#projen-modules.NpmPackageOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
|
|
11679
10736
|
| <code><a href="#projen-modules.NpmPackageOptions.property.projectTree">projectTree</a></code> | <code>boolean</code> | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. |
|
|
11680
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
11681
10737
|
| <code><a href="#projen-modules.NpmPackageOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
11682
10738
|
| <code><a href="#projen-modules.NpmPackageOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
11683
10739
|
| <code><a href="#projen-modules.NpmPackageOptions.property.projenDevDependency">projenDevDependency</a></code> | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency. |
|
|
@@ -11687,7 +10743,6 @@ const npmPackageOptions: NpmPackageOptions = { ... }
|
|
|
11687
10743
|
| <code><a href="#projen-modules.NpmPackageOptions.property.projenrcJsOptions">projenrcJsOptions</a></code> | <code>projen.javascript.ProjenrcOptions</code> | Options for .projenrc.js. |
|
|
11688
10744
|
| <code><a href="#projen-modules.NpmPackageOptions.property.projenrcTs">projenrcTs</a></code> | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`). |
|
|
11689
10745
|
| <code><a href="#projen-modules.NpmPackageOptions.property.projenrcTsOptions">projenrcTsOptions</a></code> | <code>projen.typescript.ProjenrcOptions</code> | Options for .projenrc.ts. |
|
|
11690
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.projenTokenSecret">projenTokenSecret</a></code> | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
|
|
11691
10746
|
| <code><a href="#projen-modules.NpmPackageOptions.property.projenVersion">projenVersion</a></code> | <code>string</code> | Version of projen to install. |
|
|
11692
10747
|
| <code><a href="#projen-modules.NpmPackageOptions.property.publishDryRun">publishDryRun</a></code> | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command. |
|
|
11693
10748
|
| <code><a href="#projen-modules.NpmPackageOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
|
|
@@ -11698,14 +10753,11 @@ const npmPackageOptions: NpmPackageOptions = { ... }
|
|
|
11698
10753
|
| <code><a href="#projen-modules.NpmPackageOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
|
|
11699
10754
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
11700
10755
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
11701
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
11702
10756
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
11703
10757
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
11704
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
11705
10758
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. |
|
|
11706
10759
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
11707
10760
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
11708
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
11709
10761
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
11710
10762
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
11711
10763
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
@@ -11713,9 +10765,9 @@ const npmPackageOptions: NpmPackageOptions = { ... }
|
|
|
11713
10765
|
| <code><a href="#projen-modules.NpmPackageOptions.property.renovatebotOptions">renovatebotOptions</a></code> | <code>projen.RenovatebotOptions</code> | Options for renovatebot. |
|
|
11714
10766
|
| <code><a href="#projen-modules.NpmPackageOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
|
|
11715
10767
|
| <code><a href="#projen-modules.NpmPackageOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
|
|
10768
|
+
| <code><a href="#projen-modules.NpmPackageOptions.property.runner">runner</a></code> | <code>projen.typescript.TypeScriptRunner</code> | The TypeScript runner to use for executing TypeScript files. |
|
|
11716
10769
|
| <code><a href="#projen-modules.NpmPackageOptions.property.sampleCode">sampleCode</a></code> | <code>boolean</code> | Generate one-time sample in `src/` and `test/` if there are no files there. |
|
|
11717
10770
|
| <code><a href="#projen-modules.NpmPackageOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
11718
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.scripts">scripts</a></code> | <code>{[ key: string ]: string}</code> | npm scripts to include. |
|
|
11719
10771
|
| <code><a href="#projen-modules.NpmPackageOptions.property.srcdir">srcdir</a></code> | <code>string</code> | Typescript sources directory. |
|
|
11720
10772
|
| <code><a href="#projen-modules.NpmPackageOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
11721
10773
|
| <code><a href="#projen-modules.NpmPackageOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
|
|
@@ -11723,7 +10775,7 @@ const npmPackageOptions: NpmPackageOptions = { ... }
|
|
|
11723
10775
|
| <code><a href="#projen-modules.NpmPackageOptions.property.testdir">testdir</a></code> | <code>string</code> | Jest tests directory. |
|
|
11724
10776
|
| <code><a href="#projen-modules.NpmPackageOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
|
|
11725
10777
|
| <code><a href="#projen-modules.NpmPackageOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
11726
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig
|
|
10778
|
+
| <code><a href="#projen-modules.NpmPackageOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
11727
10779
|
| <code><a href="#projen-modules.NpmPackageOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
11728
10780
|
| <code><a href="#projen-modules.NpmPackageOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
11729
10781
|
| <code><a href="#projen-modules.NpmPackageOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
@@ -12048,21 +11100,6 @@ Options for PR build workflow.
|
|
|
12048
11100
|
|
|
12049
11101
|
---
|
|
12050
11102
|
|
|
12051
|
-
##### ~~`buildWorkflowTriggers`~~<sup>Optional</sup> <a name="buildWorkflowTriggers" id="projen-modules.NpmPackageOptions.property.buildWorkflowTriggers"></a>
|
|
12052
|
-
|
|
12053
|
-
- *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers`
|
|
12054
|
-
|
|
12055
|
-
```typescript
|
|
12056
|
-
public readonly buildWorkflowTriggers: Triggers;
|
|
12057
|
-
```
|
|
12058
|
-
|
|
12059
|
-
- *Type:* projen.github.workflows.Triggers
|
|
12060
|
-
- *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
|
|
12061
|
-
|
|
12062
|
-
Build workflow triggers.
|
|
12063
|
-
|
|
12064
|
-
---
|
|
12065
|
-
|
|
12066
11103
|
##### `bumpPackage`<sup>Optional</sup> <a name="bumpPackage" id="projen-modules.NpmPackageOptions.property.bumpPackage"></a>
|
|
12067
11104
|
|
|
12068
11105
|
```typescript
|
|
@@ -12427,7 +11464,7 @@ public readonly disableTsconfigDev: boolean;
|
|
|
12427
11464
|
- *Type:* boolean
|
|
12428
11465
|
- *Default:* false
|
|
12429
11466
|
|
|
12430
|
-
Do not generate a
|
|
11467
|
+
Do not generate a development tsconfig file.
|
|
12431
11468
|
|
|
12432
11469
|
---
|
|
12433
11470
|
|
|
@@ -12740,36 +11777,6 @@ Consider this option only if your package is known to not function with newer ve
|
|
|
12740
11777
|
|
|
12741
11778
|
---
|
|
12742
11779
|
|
|
12743
|
-
##### ~~`mergify`~~<sup>Optional</sup> <a name="mergify" id="projen-modules.NpmPackageOptions.property.mergify"></a>
|
|
12744
|
-
|
|
12745
|
-
- *Deprecated:* use `githubOptions.mergify` instead
|
|
12746
|
-
|
|
12747
|
-
```typescript
|
|
12748
|
-
public readonly mergify: boolean;
|
|
12749
|
-
```
|
|
12750
|
-
|
|
12751
|
-
- *Type:* boolean
|
|
12752
|
-
- *Default:* true
|
|
12753
|
-
|
|
12754
|
-
Whether mergify should be enabled on this repository or not.
|
|
12755
|
-
|
|
12756
|
-
---
|
|
12757
|
-
|
|
12758
|
-
##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="mergifyOptions" id="projen-modules.NpmPackageOptions.property.mergifyOptions"></a>
|
|
12759
|
-
|
|
12760
|
-
- *Deprecated:* use `githubOptions.mergifyOptions` instead
|
|
12761
|
-
|
|
12762
|
-
```typescript
|
|
12763
|
-
public readonly mergifyOptions: MergifyOptions;
|
|
12764
|
-
```
|
|
12765
|
-
|
|
12766
|
-
- *Type:* projen.github.MergifyOptions
|
|
12767
|
-
- *Default:* default options
|
|
12768
|
-
|
|
12769
|
-
Options for mergify.
|
|
12770
|
-
|
|
12771
|
-
---
|
|
12772
|
-
|
|
12773
11780
|
##### `minMajorVersion`<sup>Optional</sup> <a name="minMajorVersion" id="projen-modules.NpmPackageOptions.property.minMajorVersion"></a>
|
|
12774
11781
|
|
|
12775
11782
|
```typescript
|
|
@@ -12812,27 +11819,6 @@ To change the node version of your CI/CD workflows, use `workflowNodeVersion`.
|
|
|
12812
11819
|
|
|
12813
11820
|
---
|
|
12814
11821
|
|
|
12815
|
-
##### ~~`mutableBuild`~~<sup>Optional</sup> <a name="mutableBuild" id="projen-modules.NpmPackageOptions.property.mutableBuild"></a>
|
|
12816
|
-
|
|
12817
|
-
- *Deprecated:* - Use `buildWorkflowOptions.mutableBuild`
|
|
12818
|
-
|
|
12819
|
-
```typescript
|
|
12820
|
-
public readonly mutableBuild: boolean;
|
|
12821
|
-
```
|
|
12822
|
-
|
|
12823
|
-
- *Type:* boolean
|
|
12824
|
-
- *Default:* true
|
|
12825
|
-
|
|
12826
|
-
Automatically update files modified during builds to pull-request branches.
|
|
12827
|
-
|
|
12828
|
-
This means
|
|
12829
|
-
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
|
12830
|
-
before a PR is merged.
|
|
12831
|
-
|
|
12832
|
-
Implies that PR builds do not have anti-tamper checks.
|
|
12833
|
-
|
|
12834
|
-
---
|
|
12835
|
-
|
|
12836
11822
|
##### `nextVersionCommand`<sup>Optional</sup> <a name="nextVersionCommand" id="projen-modules.NpmPackageOptions.property.nextVersionCommand"></a>
|
|
12837
11823
|
|
|
12838
11824
|
```typescript
|
|
@@ -12894,20 +11880,6 @@ for each branch.
|
|
|
12894
11880
|
|
|
12895
11881
|
---
|
|
12896
11882
|
|
|
12897
|
-
##### ~~`npmignore`~~<sup>Optional</sup> <a name="npmignore" id="projen-modules.NpmPackageOptions.property.npmignore"></a>
|
|
12898
|
-
|
|
12899
|
-
- *Deprecated:* - use `project.addPackageIgnore`
|
|
12900
|
-
|
|
12901
|
-
```typescript
|
|
12902
|
-
public readonly npmignore: string[];
|
|
12903
|
-
```
|
|
12904
|
-
|
|
12905
|
-
- *Type:* string[]
|
|
12906
|
-
|
|
12907
|
-
Additional entries to .npmignore.
|
|
12908
|
-
|
|
12909
|
-
---
|
|
12910
|
-
|
|
12911
11883
|
##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="projen-modules.NpmPackageOptions.property.npmignoreEnabled"></a>
|
|
12912
11884
|
|
|
12913
11885
|
```typescript
|
|
@@ -12952,22 +11924,6 @@ which is using npm internally and supports provenance statements independently o
|
|
|
12952
11924
|
|
|
12953
11925
|
---
|
|
12954
11926
|
|
|
12955
|
-
##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="npmRegistry" id="projen-modules.NpmPackageOptions.property.npmRegistry"></a>
|
|
12956
|
-
|
|
12957
|
-
- *Deprecated:* use `npmRegistryUrl` instead
|
|
12958
|
-
|
|
12959
|
-
```typescript
|
|
12960
|
-
public readonly npmRegistry: string;
|
|
12961
|
-
```
|
|
12962
|
-
|
|
12963
|
-
- *Type:* string
|
|
12964
|
-
|
|
12965
|
-
The host name of the npm registry to publish to.
|
|
12966
|
-
|
|
12967
|
-
Cannot be set together with `npmRegistryUrl`.
|
|
12968
|
-
|
|
12969
|
-
---
|
|
12970
|
-
|
|
12971
11927
|
##### `npmRegistryUrl`<sup>Optional</sup> <a name="npmRegistryUrl" id="projen-modules.NpmPackageOptions.property.npmRegistryUrl"></a>
|
|
12972
11928
|
|
|
12973
11929
|
```typescript
|
|
@@ -13123,7 +12079,7 @@ public readonly pnpmVersion: string;
|
|
|
13123
12079
|
```
|
|
13124
12080
|
|
|
13125
12081
|
- *Type:* string
|
|
13126
|
-
- *Default:* "
|
|
12082
|
+
- *Default:* "10.33.0"
|
|
13127
12083
|
|
|
13128
12084
|
The version of PNPM to use if using PNPM as a package manager.
|
|
13129
12085
|
|
|
@@ -13194,21 +12150,6 @@ Generate a project tree file (`.projen/tree.json`) that shows all components and
|
|
|
13194
12150
|
|
|
13195
12151
|
---
|
|
13196
12152
|
|
|
13197
|
-
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="projen-modules.NpmPackageOptions.property.projectType"></a>
|
|
13198
|
-
|
|
13199
|
-
- *Deprecated:* no longer supported at the base project level
|
|
13200
|
-
|
|
13201
|
-
```typescript
|
|
13202
|
-
public readonly projectType: ProjectType;
|
|
13203
|
-
```
|
|
13204
|
-
|
|
13205
|
-
- *Type:* projen.ProjectType
|
|
13206
|
-
- *Default:* ProjectType.UNKNOWN
|
|
13207
|
-
|
|
13208
|
-
Which type of project this is (library/app).
|
|
13209
|
-
|
|
13210
|
-
---
|
|
13211
|
-
|
|
13212
12153
|
##### `projenCommand`<sup>Optional</sup> <a name="projenCommand" id="projen-modules.NpmPackageOptions.property.projenCommand"></a>
|
|
13213
12154
|
|
|
13214
12155
|
```typescript
|
|
@@ -13327,24 +12268,6 @@ Options for .projenrc.ts.
|
|
|
13327
12268
|
|
|
13328
12269
|
---
|
|
13329
12270
|
|
|
13330
|
-
##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="projenTokenSecret" id="projen-modules.NpmPackageOptions.property.projenTokenSecret"></a>
|
|
13331
|
-
|
|
13332
|
-
- *Deprecated:* use `projenCredentials`
|
|
13333
|
-
|
|
13334
|
-
```typescript
|
|
13335
|
-
public readonly projenTokenSecret: string;
|
|
13336
|
-
```
|
|
13337
|
-
|
|
13338
|
-
- *Type:* string
|
|
13339
|
-
- *Default:* "PROJEN_GITHUB_TOKEN"
|
|
13340
|
-
|
|
13341
|
-
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
|
|
13342
|
-
|
|
13343
|
-
This token needs to have the `repo`, `workflows`
|
|
13344
|
-
and `packages` scope.
|
|
13345
|
-
|
|
13346
|
-
---
|
|
13347
|
-
|
|
13348
12271
|
##### `projenVersion`<sup>Optional</sup> <a name="projenVersion" id="projen-modules.NpmPackageOptions.property.projenVersion"></a>
|
|
13349
12272
|
|
|
13350
12273
|
```typescript
|
|
@@ -13490,21 +12413,6 @@ on a per artifact basis.
|
|
|
13490
12413
|
|
|
13491
12414
|
---
|
|
13492
12415
|
|
|
13493
|
-
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="projen-modules.NpmPackageOptions.property.releaseEveryCommit"></a>
|
|
13494
|
-
|
|
13495
|
-
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
13496
|
-
|
|
13497
|
-
```typescript
|
|
13498
|
-
public readonly releaseEveryCommit: boolean;
|
|
13499
|
-
```
|
|
13500
|
-
|
|
13501
|
-
- *Type:* boolean
|
|
13502
|
-
- *Default:* true
|
|
13503
|
-
|
|
13504
|
-
Automatically release new versions every commit to one of branches in `releaseBranches`.
|
|
13505
|
-
|
|
13506
|
-
---
|
|
13507
|
-
|
|
13508
12416
|
##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="projen-modules.NpmPackageOptions.property.releaseFailureIssue"></a>
|
|
13509
12417
|
|
|
13510
12418
|
```typescript
|
|
@@ -13533,21 +12441,6 @@ Only applies if `releaseFailureIssue` is true.
|
|
|
13533
12441
|
|
|
13534
12442
|
---
|
|
13535
12443
|
|
|
13536
|
-
##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="releaseSchedule" id="projen-modules.NpmPackageOptions.property.releaseSchedule"></a>
|
|
13537
|
-
|
|
13538
|
-
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
|
|
13539
|
-
|
|
13540
|
-
```typescript
|
|
13541
|
-
public readonly releaseSchedule: string;
|
|
13542
|
-
```
|
|
13543
|
-
|
|
13544
|
-
- *Type:* string
|
|
13545
|
-
- *Default:* no scheduled releases
|
|
13546
|
-
|
|
13547
|
-
CRON schedule to trigger new releases.
|
|
13548
|
-
|
|
13549
|
-
---
|
|
13550
|
-
|
|
13551
12444
|
##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="projen-modules.NpmPackageOptions.property.releaseTagPrefix"></a>
|
|
13552
12445
|
|
|
13553
12446
|
```typescript
|
|
@@ -13593,21 +12486,6 @@ The release trigger to use.
|
|
|
13593
12486
|
|
|
13594
12487
|
---
|
|
13595
12488
|
|
|
13596
|
-
##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="releaseWorkflow" id="projen-modules.NpmPackageOptions.property.releaseWorkflow"></a>
|
|
13597
|
-
|
|
13598
|
-
- *Deprecated:* see `release`.
|
|
13599
|
-
|
|
13600
|
-
```typescript
|
|
13601
|
-
public readonly releaseWorkflow: boolean;
|
|
13602
|
-
```
|
|
13603
|
-
|
|
13604
|
-
- *Type:* boolean
|
|
13605
|
-
- *Default:* true if not a subproject
|
|
13606
|
-
|
|
13607
|
-
DEPRECATED: renamed to `release`.
|
|
13608
|
-
|
|
13609
|
-
---
|
|
13610
|
-
|
|
13611
12489
|
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="projen-modules.NpmPackageOptions.property.releaseWorkflowEnv"></a>
|
|
13612
12490
|
|
|
13613
12491
|
```typescript
|
|
@@ -13698,6 +12576,22 @@ If the package.json for your package is not in the root directory (for example i
|
|
|
13698
12576
|
|
|
13699
12577
|
---
|
|
13700
12578
|
|
|
12579
|
+
##### `runner`<sup>Optional</sup> <a name="runner" id="projen-modules.NpmPackageOptions.property.runner"></a>
|
|
12580
|
+
|
|
12581
|
+
```typescript
|
|
12582
|
+
public readonly runner: TypeScriptRunner;
|
|
12583
|
+
```
|
|
12584
|
+
|
|
12585
|
+
- *Type:* projen.typescript.TypeScriptRunner
|
|
12586
|
+
- *Default:* TypeScriptRunner.tsNode()
|
|
12587
|
+
|
|
12588
|
+
The TypeScript runner to use for executing TypeScript files.
|
|
12589
|
+
|
|
12590
|
+
This is a project-level setting that components (e.g. projenrc) will
|
|
12591
|
+
use as their default runner.
|
|
12592
|
+
|
|
12593
|
+
---
|
|
12594
|
+
|
|
13701
12595
|
##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="projen-modules.NpmPackageOptions.property.sampleCode"></a>
|
|
13702
12596
|
|
|
13703
12597
|
```typescript
|
|
@@ -13724,25 +12618,6 @@ Options for privately hosted scoped packages.
|
|
|
13724
12618
|
|
|
13725
12619
|
---
|
|
13726
12620
|
|
|
13727
|
-
##### ~~`scripts`~~<sup>Optional</sup> <a name="scripts" id="projen-modules.NpmPackageOptions.property.scripts"></a>
|
|
13728
|
-
|
|
13729
|
-
- *Deprecated:* use `project.addTask()` or `package.setScript()`
|
|
13730
|
-
|
|
13731
|
-
```typescript
|
|
13732
|
-
public readonly scripts: {[ key: string ]: string};
|
|
13733
|
-
```
|
|
13734
|
-
|
|
13735
|
-
- *Type:* {[ key: string ]: string}
|
|
13736
|
-
- *Default:* {}
|
|
13737
|
-
|
|
13738
|
-
npm scripts to include.
|
|
13739
|
-
|
|
13740
|
-
If a script has the same name as a standard script,
|
|
13741
|
-
the standard script will be overwritten.
|
|
13742
|
-
Also adds the script as a task.
|
|
13743
|
-
|
|
13744
|
-
---
|
|
13745
|
-
|
|
13746
12621
|
##### `srcdir`<sup>Optional</sup> <a name="srcdir" id="projen-modules.NpmPackageOptions.property.srcdir"></a>
|
|
13747
12622
|
|
|
13748
12623
|
```typescript
|
|
@@ -13850,9 +12725,13 @@ public readonly tsconfigDevFile: string;
|
|
|
13850
12725
|
```
|
|
13851
12726
|
|
|
13852
12727
|
- *Type:* string
|
|
13853
|
-
- *Default:* "tsconfig.
|
|
12728
|
+
- *Default:* "{testdir}/tsconfig.json"
|
|
13854
12729
|
|
|
13855
|
-
The name of the development tsconfig
|
|
12730
|
+
The name (and path) of the development tsconfig file.
|
|
12731
|
+
|
|
12732
|
+
By default this lives inside the test directory (e.g. `test/tsconfig.json`)
|
|
12733
|
+
so that the TypeScript language service resolves it as the nearest config
|
|
12734
|
+
for test files.
|
|
13856
12735
|
|
|
13857
12736
|
---
|
|
13858
12737
|
|
|
@@ -14059,8 +12938,6 @@ const pythonPackageOptions: PythonPackageOptions = { ... }
|
|
|
14059
12938
|
| <code><a href="#projen-modules.PythonPackageOptions.property.homepage">homepage</a></code> | <code>string</code> | A URL to the website of the project. |
|
|
14060
12939
|
| <code><a href="#projen-modules.PythonPackageOptions.property.license">license</a></code> | <code>string</code> | License of this package as an SPDX identifier. |
|
|
14061
12940
|
| <code><a href="#projen-modules.PythonPackageOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
|
|
14062
|
-
| <code><a href="#projen-modules.PythonPackageOptions.property.mergify">mergify</a></code> | <code>boolean</code> | Whether mergify should be enabled on this repository or not. |
|
|
14063
|
-
| <code><a href="#projen-modules.PythonPackageOptions.property.mergifyOptions">mergifyOptions</a></code> | <code>projen.github.MergifyOptions</code> | Options for mergify. |
|
|
14064
12941
|
| <code><a href="#projen-modules.PythonPackageOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
|
|
14065
12942
|
| <code><a href="#projen-modules.PythonPackageOptions.property.packageName">packageName</a></code> | <code>string</code> | Package name. |
|
|
14066
12943
|
| <code><a href="#projen-modules.PythonPackageOptions.property.parent">parent</a></code> | <code>projen.Project</code> | The parent project, if this project is part of a bigger project. |
|
|
@@ -14068,7 +12945,6 @@ const pythonPackageOptions: PythonPackageOptions = { ... }
|
|
|
14068
12945
|
| <code><a href="#projen-modules.PythonPackageOptions.property.poetry">poetry</a></code> | <code>boolean</code> | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. |
|
|
14069
12946
|
| <code><a href="#projen-modules.PythonPackageOptions.property.poetryOptions">poetryOptions</a></code> | <code>projen.python.PoetryPyprojectOptionsWithoutDeps</code> | Additional options to set for poetry if using poetry. |
|
|
14070
12947
|
| <code><a href="#projen-modules.PythonPackageOptions.property.projectTree">projectTree</a></code> | <code>boolean</code> | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. |
|
|
14071
|
-
| <code><a href="#projen-modules.PythonPackageOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
14072
12948
|
| <code><a href="#projen-modules.PythonPackageOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
14073
12949
|
| <code><a href="#projen-modules.PythonPackageOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
14074
12950
|
| <code><a href="#projen-modules.PythonPackageOptions.property.projenrcJs">projenrcJs</a></code> | <code>boolean</code> | Use projenrc in javascript. |
|
|
@@ -14079,7 +12955,6 @@ const pythonPackageOptions: PythonPackageOptions = { ... }
|
|
|
14079
12955
|
| <code><a href="#projen-modules.PythonPackageOptions.property.projenrcPythonOptions">projenrcPythonOptions</a></code> | <code>projen.python.ProjenrcOptions</code> | Options related to projenrc in python. |
|
|
14080
12956
|
| <code><a href="#projen-modules.PythonPackageOptions.property.projenrcTs">projenrcTs</a></code> | <code>boolean</code> | Use projenrc in TypeScript. |
|
|
14081
12957
|
| <code><a href="#projen-modules.PythonPackageOptions.property.projenrcTsOptions">projenrcTsOptions</a></code> | <code>projen.typescript.ProjenrcTsOptions</code> | Options related to projenrc in TypeScript. |
|
|
14082
|
-
| <code><a href="#projen-modules.PythonPackageOptions.property.projenTokenSecret">projenTokenSecret</a></code> | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
|
|
14083
12958
|
| <code><a href="#projen-modules.PythonPackageOptions.property.pullRequestTemplate">pullRequestTemplate</a></code> | <code>boolean</code> | Include a GitHub pull request template. |
|
|
14084
12959
|
| <code><a href="#projen-modules.PythonPackageOptions.property.pullRequestTemplateContents">pullRequestTemplateContents</a></code> | <code>string[]</code> | The contents of the pull request template. |
|
|
14085
12960
|
| <code><a href="#projen-modules.PythonPackageOptions.property.pytest">pytest</a></code> | <code>boolean</code> | Include pytest tests. |
|
|
@@ -14421,36 +13296,6 @@ Configure logging options such as verbosity.
|
|
|
14421
13296
|
|
|
14422
13297
|
---
|
|
14423
13298
|
|
|
14424
|
-
##### ~~`mergify`~~<sup>Optional</sup> <a name="mergify" id="projen-modules.PythonPackageOptions.property.mergify"></a>
|
|
14425
|
-
|
|
14426
|
-
- *Deprecated:* use `githubOptions.mergify` instead
|
|
14427
|
-
|
|
14428
|
-
```typescript
|
|
14429
|
-
public readonly mergify: boolean;
|
|
14430
|
-
```
|
|
14431
|
-
|
|
14432
|
-
- *Type:* boolean
|
|
14433
|
-
- *Default:* true
|
|
14434
|
-
|
|
14435
|
-
Whether mergify should be enabled on this repository or not.
|
|
14436
|
-
|
|
14437
|
-
---
|
|
14438
|
-
|
|
14439
|
-
##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="mergifyOptions" id="projen-modules.PythonPackageOptions.property.mergifyOptions"></a>
|
|
14440
|
-
|
|
14441
|
-
- *Deprecated:* use `githubOptions.mergifyOptions` instead
|
|
14442
|
-
|
|
14443
|
-
```typescript
|
|
14444
|
-
public readonly mergifyOptions: MergifyOptions;
|
|
14445
|
-
```
|
|
14446
|
-
|
|
14447
|
-
- *Type:* projen.github.MergifyOptions
|
|
14448
|
-
- *Default:* default options
|
|
14449
|
-
|
|
14450
|
-
Options for mergify.
|
|
14451
|
-
|
|
14452
|
-
---
|
|
14453
|
-
|
|
14454
13299
|
##### `outdir`<sup>Optional</sup> <a name="outdir" id="projen-modules.PythonPackageOptions.property.outdir"></a>
|
|
14455
13300
|
|
|
14456
13301
|
```typescript
|
|
@@ -14546,21 +13391,6 @@ Generate a project tree file (`.projen/tree.json`) that shows all components and
|
|
|
14546
13391
|
|
|
14547
13392
|
---
|
|
14548
13393
|
|
|
14549
|
-
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="projen-modules.PythonPackageOptions.property.projectType"></a>
|
|
14550
|
-
|
|
14551
|
-
- *Deprecated:* no longer supported at the base project level
|
|
14552
|
-
|
|
14553
|
-
```typescript
|
|
14554
|
-
public readonly projectType: ProjectType;
|
|
14555
|
-
```
|
|
14556
|
-
|
|
14557
|
-
- *Type:* projen.ProjectType
|
|
14558
|
-
- *Default:* ProjectType.UNKNOWN
|
|
14559
|
-
|
|
14560
|
-
Which type of project this is (library/app).
|
|
14561
|
-
|
|
14562
|
-
---
|
|
14563
|
-
|
|
14564
13394
|
##### `projenCommand`<sup>Optional</sup> <a name="projenCommand" id="projen-modules.PythonPackageOptions.property.projenCommand"></a>
|
|
14565
13395
|
|
|
14566
13396
|
```typescript
|
|
@@ -14685,7 +13515,7 @@ public readonly projenrcTs: boolean;
|
|
|
14685
13515
|
Use projenrc in TypeScript.
|
|
14686
13516
|
|
|
14687
13517
|
This will create a tsconfig file (default: `tsconfig.projen.json`)
|
|
14688
|
-
and use
|
|
13518
|
+
and use a typescript runner in the default task to parse the project source files.
|
|
14689
13519
|
|
|
14690
13520
|
---
|
|
14691
13521
|
|
|
@@ -14702,24 +13532,6 @@ Options related to projenrc in TypeScript.
|
|
|
14702
13532
|
|
|
14703
13533
|
---
|
|
14704
13534
|
|
|
14705
|
-
##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="projenTokenSecret" id="projen-modules.PythonPackageOptions.property.projenTokenSecret"></a>
|
|
14706
|
-
|
|
14707
|
-
- *Deprecated:* use `projenCredentials`
|
|
14708
|
-
|
|
14709
|
-
```typescript
|
|
14710
|
-
public readonly projenTokenSecret: string;
|
|
14711
|
-
```
|
|
14712
|
-
|
|
14713
|
-
- *Type:* string
|
|
14714
|
-
- *Default:* "PROJEN_GITHUB_TOKEN"
|
|
14715
|
-
|
|
14716
|
-
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
|
|
14717
|
-
|
|
14718
|
-
This token needs to have the `repo`, `workflows`
|
|
14719
|
-
and `packages` scope.
|
|
14720
|
-
|
|
14721
|
-
---
|
|
14722
|
-
|
|
14723
13535
|
##### `pullRequestTemplate`<sup>Optional</sup> <a name="pullRequestTemplate" id="projen-modules.PythonPackageOptions.property.pullRequestTemplate"></a>
|
|
14724
13536
|
|
|
14725
13537
|
```typescript
|