lerna-projen 0.1.845 → 0.1.846

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/.jsii +4 -4
  2. package/.nvmrc +1 -1
  3. package/API.md +61 -795
  4. package/lib/index.js +47 -8
  5. package/package.json +10 -12
package/API.md CHANGED
@@ -34,7 +34,6 @@ new LernaProject(options: LernaProjectOptions)
34
34
  | <code><a href="#lerna-projen.LernaProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
35
35
  | <code><a href="#lerna-projen.LernaProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
36
36
  | <code><a href="#lerna-projen.LernaProject.addTask">addTask</a></code> | Adds a new task to this project. |
37
- | <code><a href="#lerna-projen.LernaProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
38
37
  | <code><a href="#lerna-projen.LernaProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
39
38
  | <code><a href="#lerna-projen.LernaProject.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
40
39
  | <code><a href="#lerna-projen.LernaProject.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
@@ -42,20 +41,16 @@ new LernaProject(options: LernaProjectOptions)
42
41
  | <code><a href="#lerna-projen.LernaProject.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
43
42
  | <code><a href="#lerna-projen.LernaProject.synth">synth</a></code> | Synthesize all project files into `outdir`. |
44
43
  | <code><a href="#lerna-projen.LernaProject.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
45
- | <code><a href="#lerna-projen.LernaProject.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
46
44
  | <code><a href="#lerna-projen.LernaProject.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
47
45
  | <code><a href="#lerna-projen.LernaProject.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
48
46
  | <code><a href="#lerna-projen.LernaProject.addBins">addBins</a></code> | *No description.* |
49
47
  | <code><a href="#lerna-projen.LernaProject.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
50
- | <code><a href="#lerna-projen.LernaProject.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
51
48
  | <code><a href="#lerna-projen.LernaProject.addDeps">addDeps</a></code> | Defines normal dependencies. |
52
49
  | <code><a href="#lerna-projen.LernaProject.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
53
50
  | <code><a href="#lerna-projen.LernaProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
54
51
  | <code><a href="#lerna-projen.LernaProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
55
52
  | <code><a href="#lerna-projen.LernaProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
56
53
  | <code><a href="#lerna-projen.LernaProject.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
57
- | <code><a href="#lerna-projen.LernaProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
58
- | <code><a href="#lerna-projen.LernaProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
59
54
  | <code><a href="#lerna-projen.LernaProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
60
55
  | <code><a href="#lerna-projen.LernaProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
61
56
  | <code><a href="#lerna-projen.LernaProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
@@ -170,22 +165,6 @@ Task properties.
170
165
 
171
166
  ---
172
167
 
173
- ##### ~~`addTip`~~ <a name="addTip" id="lerna-projen.LernaProject.addTip"></a>
174
-
175
- ```typescript
176
- public addTip(message: string): void
177
- ```
178
-
179
- Prints a "tip" message during synthesis.
180
-
181
- ###### `message`<sup>Required</sup> <a name="message" id="lerna-projen.LernaProject.addTip.parameter.message"></a>
182
-
183
- - *Type:* string
184
-
185
- The message.
186
-
187
- ---
188
-
189
168
  ##### `annotateGenerated` <a name="annotateGenerated" id="lerna-projen.LernaProject.annotateGenerated"></a>
190
169
 
191
170
  ```typescript
@@ -295,22 +274,6 @@ from the root of _this_ project.
295
274
 
296
275
  ---
297
276
 
298
- ##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="lerna-projen.LernaProject.tryFindJsonFile"></a>
299
-
300
- ```typescript
301
- public tryFindJsonFile(filePath: string): JsonFile
302
- ```
303
-
304
- Finds a json file by name.
305
-
306
- ###### `filePath`<sup>Required</sup> <a name="filePath" id="lerna-projen.LernaProject.tryFindJsonFile.parameter.filePath"></a>
307
-
308
- - *Type:* string
309
-
310
- The file path.
311
-
312
- ---
313
-
314
277
  ##### `tryFindObjectFile` <a name="tryFindObjectFile" id="lerna-projen.LernaProject.tryFindObjectFile"></a>
315
278
 
316
279
  ```typescript
@@ -383,20 +346,6 @@ add/update`. If you wish to specify a version range use this syntax:
383
346
 
384
347
  ---
385
348
 
386
- ##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="lerna-projen.LernaProject.addCompileCommand"></a>
387
-
388
- ```typescript
389
- public addCompileCommand(commands: ...string[]): void
390
- ```
391
-
392
- DEPRECATED.
393
-
394
- ###### `commands`<sup>Required</sup> <a name="commands" id="lerna-projen.LernaProject.addCompileCommand.parameter.commands"></a>
395
-
396
- - *Type:* ...string[]
397
-
398
- ---
399
-
400
349
  ##### `addDeps` <a name="addDeps" id="lerna-projen.LernaProject.addDeps"></a>
401
350
 
402
351
  ```typescript
@@ -515,36 +464,6 @@ The scripts to set.
515
464
 
516
465
  ---
517
466
 
518
- ##### ~~`addTestCommand`~~ <a name="addTestCommand" id="lerna-projen.LernaProject.addTestCommand"></a>
519
-
520
- ```typescript
521
- public addTestCommand(commands: ...string[]): void
522
- ```
523
-
524
- DEPRECATED.
525
-
526
- ###### `commands`<sup>Required</sup> <a name="commands" id="lerna-projen.LernaProject.addTestCommand.parameter.commands"></a>
527
-
528
- - *Type:* ...string[]
529
-
530
- ---
531
-
532
- ##### ~~`hasScript`~~ <a name="hasScript" id="lerna-projen.LernaProject.hasScript"></a>
533
-
534
- ```typescript
535
- public hasScript(name: string): boolean
536
- ```
537
-
538
- Indicates if a script by the name name is defined.
539
-
540
- ###### `name`<sup>Required</sup> <a name="name" id="lerna-projen.LernaProject.hasScript.parameter.name"></a>
541
-
542
- - *Type:* string
543
-
544
- The name of the script.
545
-
546
- ---
547
-
548
467
  ##### `removeScript` <a name="removeScript" id="lerna-projen.LernaProject.removeScript"></a>
549
468
 
550
469
  ```typescript
@@ -730,21 +649,16 @@ When given a project, this it the project itself.
730
649
  | <code><a href="#lerna-projen.LernaProject.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
731
650
  | <code><a href="#lerna-projen.LernaProject.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
732
651
  | <code><a href="#lerna-projen.LernaProject.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
733
- | <code><a href="#lerna-projen.LernaProject.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
734
652
  | <code><a href="#lerna-projen.LernaProject.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
735
653
  | <code><a href="#lerna-projen.LernaProject.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
736
654
  | <code><a href="#lerna-projen.LernaProject.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
737
655
  | <code><a href="#lerna-projen.LernaProject.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
738
656
  | <code><a href="#lerna-projen.LernaProject.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
739
- | <code><a href="#lerna-projen.LernaProject.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
740
657
  | <code><a href="#lerna-projen.LernaProject.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
741
658
  | <code><a href="#lerna-projen.LernaProject.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
742
659
  | <code><a href="#lerna-projen.LernaProject.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
743
- | <code><a href="#lerna-projen.LernaProject.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
744
- | <code><a href="#lerna-projen.LernaProject.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
745
660
  | <code><a href="#lerna-projen.LernaProject.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
746
661
  | <code><a href="#lerna-projen.LernaProject.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
747
- | <code><a href="#lerna-projen.LernaProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
748
662
  | <code><a href="#lerna-projen.LernaProject.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). |
749
663
  | <code><a href="#lerna-projen.LernaProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
750
664
  | <code><a href="#lerna-projen.LernaProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
@@ -755,7 +669,6 @@ When given a project, this it the project itself.
755
669
  | <code><a href="#lerna-projen.LernaProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
756
670
  | <code><a href="#lerna-projen.LernaProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
757
671
  | <code><a href="#lerna-projen.LernaProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
758
- | <code><a href="#lerna-projen.LernaProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
759
672
  | <code><a href="#lerna-projen.LernaProject.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
760
673
  | <code><a href="#lerna-projen.LernaProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
761
674
  | <code><a href="#lerna-projen.LernaProject.property.docgen">docgen</a></code> | <code>boolean</code> | *No description.* |
@@ -1067,16 +980,6 @@ If undefined, this is the root project.
1067
980
 
1068
981
  ---
1069
982
 
1070
- ##### `projectType`<sup>Required</sup> <a name="projectType" id="lerna-projen.LernaProject.property.projectType"></a>
1071
-
1072
- ```typescript
1073
- public readonly projectType: ProjectType;
1074
- ```
1075
-
1076
- - *Type:* projen.ProjectType
1077
-
1078
- ---
1079
-
1080
983
  ##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="lerna-projen.LernaProject.property.autoApprove"></a>
1081
984
 
1082
985
  ```typescript
@@ -1145,18 +1048,6 @@ This will be `undefined` for subprojects.
1145
1048
 
1146
1049
  ---
1147
1050
 
1148
- ##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="lerna-projen.LernaProject.property.allowLibraryDependencies"></a>
1149
-
1150
- - *Deprecated:* use `package.allowLibraryDependencies`
1151
-
1152
- ```typescript
1153
- public readonly allowLibraryDependencies: boolean;
1154
- ```
1155
-
1156
- - *Type:* boolean
1157
-
1158
- ---
1159
-
1160
1051
  ##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="lerna-projen.LernaProject.property.artifactsDirectory"></a>
1161
1052
 
1162
1053
  ```typescript
@@ -1195,30 +1086,6 @@ public readonly bundler: Bundler;
1195
1086
 
1196
1087
  ---
1197
1088
 
1198
- ##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="lerna-projen.LernaProject.property.entrypoint"></a>
1199
-
1200
- - *Deprecated:* use `package.entrypoint`
1201
-
1202
- ```typescript
1203
- public readonly entrypoint: string;
1204
- ```
1205
-
1206
- - *Type:* string
1207
-
1208
- ---
1209
-
1210
- ##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="lerna-projen.LernaProject.property.manifest"></a>
1211
-
1212
- - *Deprecated:* use `package.addField(x, y)`
1213
-
1214
- ```typescript
1215
- public readonly manifest: any;
1216
- ```
1217
-
1218
- - *Type:* any
1219
-
1220
- ---
1221
-
1222
1089
  ##### `npmrc`<sup>Required</sup> <a name="npmrc" id="lerna-projen.LernaProject.property.npmrc"></a>
1223
1090
 
1224
1091
  ```typescript
@@ -1243,20 +1110,6 @@ API for managing the node package.
1243
1110
 
1244
1111
  ---
1245
1112
 
1246
- ##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="lerna-projen.LernaProject.property.packageManager"></a>
1247
-
1248
- - *Deprecated:* use `package.packageManager`
1249
-
1250
- ```typescript
1251
- public readonly packageManager: NodePackageManager;
1252
- ```
1253
-
1254
- - *Type:* projen.javascript.NodePackageManager
1255
-
1256
- The package manager to use.
1257
-
1258
- ---
1259
-
1260
1113
  ##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="lerna-projen.LernaProject.property.runScriptCommand"></a>
1261
1114
 
1262
1115
  ```typescript
@@ -1379,23 +1232,6 @@ public readonly prettier: Prettier;
1379
1232
 
1380
1233
  ---
1381
1234
 
1382
- ##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="lerna-projen.LernaProject.property.publisher"></a>
1383
-
1384
- - *Deprecated:* use `release.publisher`.
1385
-
1386
- ```typescript
1387
- public readonly publisher: Publisher;
1388
- ```
1389
-
1390
- - *Type:* projen.release.Publisher
1391
-
1392
- Package publisher.
1393
-
1394
- This will be `undefined` if the project does not have a
1395
- release workflow.
1396
-
1397
- ---
1398
-
1399
1235
  ##### `release`<sup>Optional</sup> <a name="release" id="lerna-projen.LernaProject.property.release"></a>
1400
1236
 
1401
1237
  ```typescript
@@ -1565,7 +1401,6 @@ new LernaTypescriptProject(options: LernaTypescriptProjectOptions)
1565
1401
  | <code><a href="#lerna-projen.LernaTypescriptProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
1566
1402
  | <code><a href="#lerna-projen.LernaTypescriptProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
1567
1403
  | <code><a href="#lerna-projen.LernaTypescriptProject.addTask">addTask</a></code> | Adds a new task to this project. |
1568
- | <code><a href="#lerna-projen.LernaTypescriptProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
1569
1404
  | <code><a href="#lerna-projen.LernaTypescriptProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
1570
1405
  | <code><a href="#lerna-projen.LernaTypescriptProject.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
1571
1406
  | <code><a href="#lerna-projen.LernaTypescriptProject.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
@@ -1573,20 +1408,16 @@ new LernaTypescriptProject(options: LernaTypescriptProjectOptions)
1573
1408
  | <code><a href="#lerna-projen.LernaTypescriptProject.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
1574
1409
  | <code><a href="#lerna-projen.LernaTypescriptProject.synth">synth</a></code> | Synthesize all project files into `outdir`. |
1575
1410
  | <code><a href="#lerna-projen.LernaTypescriptProject.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
1576
- | <code><a href="#lerna-projen.LernaTypescriptProject.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
1577
1411
  | <code><a href="#lerna-projen.LernaTypescriptProject.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
1578
1412
  | <code><a href="#lerna-projen.LernaTypescriptProject.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
1579
1413
  | <code><a href="#lerna-projen.LernaTypescriptProject.addBins">addBins</a></code> | *No description.* |
1580
1414
  | <code><a href="#lerna-projen.LernaTypescriptProject.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
1581
- | <code><a href="#lerna-projen.LernaTypescriptProject.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
1582
1415
  | <code><a href="#lerna-projen.LernaTypescriptProject.addDeps">addDeps</a></code> | Defines normal dependencies. |
1583
1416
  | <code><a href="#lerna-projen.LernaTypescriptProject.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
1584
1417
  | <code><a href="#lerna-projen.LernaTypescriptProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
1585
1418
  | <code><a href="#lerna-projen.LernaTypescriptProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
1586
1419
  | <code><a href="#lerna-projen.LernaTypescriptProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
1587
1420
  | <code><a href="#lerna-projen.LernaTypescriptProject.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
1588
- | <code><a href="#lerna-projen.LernaTypescriptProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
1589
- | <code><a href="#lerna-projen.LernaTypescriptProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
1590
1421
  | <code><a href="#lerna-projen.LernaTypescriptProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
1591
1422
  | <code><a href="#lerna-projen.LernaTypescriptProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
1592
1423
  | <code><a href="#lerna-projen.LernaTypescriptProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
@@ -1701,22 +1532,6 @@ Task properties.
1701
1532
 
1702
1533
  ---
1703
1534
 
1704
- ##### ~~`addTip`~~ <a name="addTip" id="lerna-projen.LernaTypescriptProject.addTip"></a>
1705
-
1706
- ```typescript
1707
- public addTip(message: string): void
1708
- ```
1709
-
1710
- Prints a "tip" message during synthesis.
1711
-
1712
- ###### `message`<sup>Required</sup> <a name="message" id="lerna-projen.LernaTypescriptProject.addTip.parameter.message"></a>
1713
-
1714
- - *Type:* string
1715
-
1716
- The message.
1717
-
1718
- ---
1719
-
1720
1535
  ##### `annotateGenerated` <a name="annotateGenerated" id="lerna-projen.LernaTypescriptProject.annotateGenerated"></a>
1721
1536
 
1722
1537
  ```typescript
@@ -1826,22 +1641,6 @@ from the root of _this_ project.
1826
1641
 
1827
1642
  ---
1828
1643
 
1829
- ##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="lerna-projen.LernaTypescriptProject.tryFindJsonFile"></a>
1830
-
1831
- ```typescript
1832
- public tryFindJsonFile(filePath: string): JsonFile
1833
- ```
1834
-
1835
- Finds a json file by name.
1836
-
1837
- ###### `filePath`<sup>Required</sup> <a name="filePath" id="lerna-projen.LernaTypescriptProject.tryFindJsonFile.parameter.filePath"></a>
1838
-
1839
- - *Type:* string
1840
-
1841
- The file path.
1842
-
1843
- ---
1844
-
1845
1644
  ##### `tryFindObjectFile` <a name="tryFindObjectFile" id="lerna-projen.LernaTypescriptProject.tryFindObjectFile"></a>
1846
1645
 
1847
1646
  ```typescript
@@ -1914,20 +1713,6 @@ add/update`. If you wish to specify a version range use this syntax:
1914
1713
 
1915
1714
  ---
1916
1715
 
1917
- ##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="lerna-projen.LernaTypescriptProject.addCompileCommand"></a>
1918
-
1919
- ```typescript
1920
- public addCompileCommand(commands: ...string[]): void
1921
- ```
1922
-
1923
- DEPRECATED.
1924
-
1925
- ###### `commands`<sup>Required</sup> <a name="commands" id="lerna-projen.LernaTypescriptProject.addCompileCommand.parameter.commands"></a>
1926
-
1927
- - *Type:* ...string[]
1928
-
1929
- ---
1930
-
1931
1716
  ##### `addDeps` <a name="addDeps" id="lerna-projen.LernaTypescriptProject.addDeps"></a>
1932
1717
 
1933
1718
  ```typescript
@@ -2046,36 +1831,6 @@ The scripts to set.
2046
1831
 
2047
1832
  ---
2048
1833
 
2049
- ##### ~~`addTestCommand`~~ <a name="addTestCommand" id="lerna-projen.LernaTypescriptProject.addTestCommand"></a>
2050
-
2051
- ```typescript
2052
- public addTestCommand(commands: ...string[]): void
2053
- ```
2054
-
2055
- DEPRECATED.
2056
-
2057
- ###### `commands`<sup>Required</sup> <a name="commands" id="lerna-projen.LernaTypescriptProject.addTestCommand.parameter.commands"></a>
2058
-
2059
- - *Type:* ...string[]
2060
-
2061
- ---
2062
-
2063
- ##### ~~`hasScript`~~ <a name="hasScript" id="lerna-projen.LernaTypescriptProject.hasScript"></a>
2064
-
2065
- ```typescript
2066
- public hasScript(name: string): boolean
2067
- ```
2068
-
2069
- Indicates if a script by the name name is defined.
2070
-
2071
- ###### `name`<sup>Required</sup> <a name="name" id="lerna-projen.LernaTypescriptProject.hasScript.parameter.name"></a>
2072
-
2073
- - *Type:* string
2074
-
2075
- The name of the script.
2076
-
2077
- ---
2078
-
2079
1834
  ##### `removeScript` <a name="removeScript" id="lerna-projen.LernaTypescriptProject.removeScript"></a>
2080
1835
 
2081
1836
  ```typescript
@@ -2261,21 +2016,16 @@ When given a project, this it the project itself.
2261
2016
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
2262
2017
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
2263
2018
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
2264
- | <code><a href="#lerna-projen.LernaTypescriptProject.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
2265
2019
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
2266
2020
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
2267
2021
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
2268
2022
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
2269
2023
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
2270
- | <code><a href="#lerna-projen.LernaTypescriptProject.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
2271
2024
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
2272
2025
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
2273
2026
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
2274
- | <code><a href="#lerna-projen.LernaTypescriptProject.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
2275
- | <code><a href="#lerna-projen.LernaTypescriptProject.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
2276
2027
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
2277
2028
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
2278
- | <code><a href="#lerna-projen.LernaTypescriptProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
2279
2029
  | <code><a href="#lerna-projen.LernaTypescriptProject.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). |
2280
2030
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
2281
2031
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
@@ -2286,7 +2036,6 @@ When given a project, this it the project itself.
2286
2036
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
2287
2037
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
2288
2038
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
2289
- | <code><a href="#lerna-projen.LernaTypescriptProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
2290
2039
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
2291
2040
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
2292
2041
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
@@ -2606,16 +2355,6 @@ If undefined, this is the root project.
2606
2355
 
2607
2356
  ---
2608
2357
 
2609
- ##### `projectType`<sup>Required</sup> <a name="projectType" id="lerna-projen.LernaTypescriptProject.property.projectType"></a>
2610
-
2611
- ```typescript
2612
- public readonly projectType: ProjectType;
2613
- ```
2614
-
2615
- - *Type:* projen.ProjectType
2616
-
2617
- ---
2618
-
2619
2358
  ##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="lerna-projen.LernaTypescriptProject.property.autoApprove"></a>
2620
2359
 
2621
2360
  ```typescript
@@ -2684,18 +2423,6 @@ This will be `undefined` for subprojects.
2684
2423
 
2685
2424
  ---
2686
2425
 
2687
- ##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="lerna-projen.LernaTypescriptProject.property.allowLibraryDependencies"></a>
2688
-
2689
- - *Deprecated:* use `package.allowLibraryDependencies`
2690
-
2691
- ```typescript
2692
- public readonly allowLibraryDependencies: boolean;
2693
- ```
2694
-
2695
- - *Type:* boolean
2696
-
2697
- ---
2698
-
2699
2426
  ##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="lerna-projen.LernaTypescriptProject.property.artifactsDirectory"></a>
2700
2427
 
2701
2428
  ```typescript
@@ -2734,30 +2461,6 @@ public readonly bundler: Bundler;
2734
2461
 
2735
2462
  ---
2736
2463
 
2737
- ##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="lerna-projen.LernaTypescriptProject.property.entrypoint"></a>
2738
-
2739
- - *Deprecated:* use `package.entrypoint`
2740
-
2741
- ```typescript
2742
- public readonly entrypoint: string;
2743
- ```
2744
-
2745
- - *Type:* string
2746
-
2747
- ---
2748
-
2749
- ##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="lerna-projen.LernaTypescriptProject.property.manifest"></a>
2750
-
2751
- - *Deprecated:* use `package.addField(x, y)`
2752
-
2753
- ```typescript
2754
- public readonly manifest: any;
2755
- ```
2756
-
2757
- - *Type:* any
2758
-
2759
- ---
2760
-
2761
2464
  ##### `npmrc`<sup>Required</sup> <a name="npmrc" id="lerna-projen.LernaTypescriptProject.property.npmrc"></a>
2762
2465
 
2763
2466
  ```typescript
@@ -2782,20 +2485,6 @@ API for managing the node package.
2782
2485
 
2783
2486
  ---
2784
2487
 
2785
- ##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="lerna-projen.LernaTypescriptProject.property.packageManager"></a>
2786
-
2787
- - *Deprecated:* use `package.packageManager`
2788
-
2789
- ```typescript
2790
- public readonly packageManager: NodePackageManager;
2791
- ```
2792
-
2793
- - *Type:* projen.javascript.NodePackageManager
2794
-
2795
- The package manager to use.
2796
-
2797
- ---
2798
-
2799
2488
  ##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="lerna-projen.LernaTypescriptProject.property.runScriptCommand"></a>
2800
2489
 
2801
2490
  ```typescript
@@ -2918,23 +2607,6 @@ public readonly prettier: Prettier;
2918
2607
 
2919
2608
  ---
2920
2609
 
2921
- ##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="lerna-projen.LernaTypescriptProject.property.publisher"></a>
2922
-
2923
- - *Deprecated:* use `release.publisher`.
2924
-
2925
- ```typescript
2926
- public readonly publisher: Publisher;
2927
- ```
2928
-
2929
- - *Type:* projen.release.Publisher
2930
-
2931
- Package publisher.
2932
-
2933
- This will be `undefined` if the project does not have a
2934
- release workflow.
2935
-
2936
- ---
2937
-
2938
2610
  ##### `release`<sup>Optional</sup> <a name="release" id="lerna-projen.LernaTypescriptProject.property.release"></a>
2939
2611
 
2940
2612
  ```typescript
@@ -3498,11 +3170,7 @@ const lernaProjectOptions: LernaProjectOptions = { ... }
3498
3170
  | <code><a href="#lerna-projen.LernaProjectOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
3499
3171
  | <code><a href="#lerna-projen.LernaProjectOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
3500
3172
  | <code><a href="#lerna-projen.LernaProjectOptions.property.gitpod">gitpod</a></code> | <code>boolean</code> | Add a Gitpod development environment. |
3501
- | <code><a href="#lerna-projen.LernaProjectOptions.property.mergify">mergify</a></code> | <code>boolean</code> | Whether mergify should be enabled on this repository or not. |
3502
- | <code><a href="#lerna-projen.LernaProjectOptions.property.mergifyOptions">mergifyOptions</a></code> | <code>projen.github.MergifyOptions</code> | Options for mergify. |
3503
- | <code><a href="#lerna-projen.LernaProjectOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
3504
3173
  | <code><a href="#lerna-projen.LernaProjectOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
3505
- | <code><a href="#lerna-projen.LernaProjectOptions.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. |
3506
3174
  | <code><a href="#lerna-projen.LernaProjectOptions.property.readme">readme</a></code> | <code>projen.SampleReadmeProps</code> | The README setup. |
3507
3175
  | <code><a href="#lerna-projen.LernaProjectOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
3508
3176
  | <code><a href="#lerna-projen.LernaProjectOptions.property.staleOptions">staleOptions</a></code> | <code>projen.github.StaleOptions</code> | Auto-close stale issues and pull requests. |
@@ -3534,7 +3202,6 @@ const lernaProjectOptions: LernaProjectOptions = { ... }
3534
3202
  | <code><a href="#lerna-projen.LernaProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. Most projects should not use this option. |
3535
3203
  | <code><a href="#lerna-projen.LernaProjectOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
3536
3204
  | <code><a href="#lerna-projen.LernaProjectOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
3537
- | <code><a href="#lerna-projen.LernaProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
3538
3205
  | <code><a href="#lerna-projen.LernaProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
3539
3206
  | <code><a href="#lerna-projen.LernaProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
3540
3207
  | <code><a href="#lerna-projen.LernaProjectOptions.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. |
@@ -3546,7 +3213,6 @@ const lernaProjectOptions: LernaProjectOptions = { ... }
3546
3213
  | <code><a href="#lerna-projen.LernaProjectOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
3547
3214
  | <code><a href="#lerna-projen.LernaProjectOptions.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. |
3548
3215
  | <code><a href="#lerna-projen.LernaProjectOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
3549
- | <code><a href="#lerna-projen.LernaProjectOptions.property.scripts">scripts</a></code> | <code>{[ key: string ]: string}</code> | npm scripts to include. |
3550
3216
  | <code><a href="#lerna-projen.LernaProjectOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
3551
3217
  | <code><a href="#lerna-projen.LernaProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
3552
3218
  | <code><a href="#lerna-projen.LernaProjectOptions.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. |
@@ -3562,10 +3228,8 @@ const lernaProjectOptions: LernaProjectOptions = { ... }
3562
3228
  | <code><a href="#lerna-projen.LernaProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
3563
3229
  | <code><a href="#lerna-projen.LernaProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
3564
3230
  | <code><a href="#lerna-projen.LernaProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
3565
- | <code><a href="#lerna-projen.LernaProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
3566
3231
  | <code><a href="#lerna-projen.LernaProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
3567
3232
  | <code><a href="#lerna-projen.LernaProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
3568
- | <code><a href="#lerna-projen.LernaProjectOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
3569
3233
  | <code><a href="#lerna-projen.LernaProjectOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
3570
3234
  | <code><a href="#lerna-projen.LernaProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
3571
3235
  | <code><a href="#lerna-projen.LernaProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
@@ -3575,7 +3239,6 @@ const lernaProjectOptions: LernaProjectOptions = { ... }
3575
3239
  | <code><a href="#lerna-projen.LernaProjectOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
3576
3240
  | <code><a href="#lerna-projen.LernaProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
3577
3241
  | <code><a href="#lerna-projen.LernaProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
3578
- | <code><a href="#lerna-projen.LernaProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
3579
3242
  | <code><a href="#lerna-projen.LernaProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
3580
3243
  | <code><a href="#lerna-projen.LernaProjectOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
3581
3244
  | <code><a href="#lerna-projen.LernaProjectOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
@@ -3584,13 +3247,13 @@ const lernaProjectOptions: LernaProjectOptions = { ... }
3584
3247
  | <code><a href="#lerna-projen.LernaProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
3585
3248
  | <code><a href="#lerna-projen.LernaProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
3586
3249
  | <code><a href="#lerna-projen.LernaProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
3587
- | <code><a href="#lerna-projen.LernaProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
3588
3250
  | <code><a href="#lerna-projen.LernaProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
3589
3251
  | <code><a href="#lerna-projen.LernaProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
3590
3252
  | <code><a href="#lerna-projen.LernaProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
3591
3253
  | <code><a href="#lerna-projen.LernaProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
3592
3254
  | <code><a href="#lerna-projen.LernaProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
3593
3255
  | <code><a href="#lerna-projen.LernaProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
3256
+ | <code><a href="#lerna-projen.LernaProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
3594
3257
  | <code><a href="#lerna-projen.LernaProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
3595
3258
  | <code><a href="#lerna-projen.LernaProjectOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
3596
3259
  | <code><a href="#lerna-projen.LernaProjectOptions.property.depsUpgrade">depsUpgrade</a></code> | <code>boolean</code> | Use tasks and github workflows to handle dependency upgrades. |
@@ -3598,8 +3261,6 @@ const lernaProjectOptions: LernaProjectOptions = { ... }
3598
3261
  | <code><a href="#lerna-projen.LernaProjectOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
3599
3262
  | <code><a href="#lerna-projen.LernaProjectOptions.property.jest">jest</a></code> | <code>boolean</code> | Setup jest unit tests. |
3600
3263
  | <code><a href="#lerna-projen.LernaProjectOptions.property.jestOptions">jestOptions</a></code> | <code>projen.javascript.JestOptions</code> | Jest options. |
3601
- | <code><a href="#lerna-projen.LernaProjectOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
3602
- | <code><a href="#lerna-projen.LernaProjectOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
3603
3264
  | <code><a href="#lerna-projen.LernaProjectOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
3604
3265
  | <code><a href="#lerna-projen.LernaProjectOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
3605
3266
  | <code><a href="#lerna-projen.LernaProjectOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
@@ -3613,7 +3274,6 @@ const lernaProjectOptions: LernaProjectOptions = { ... }
3613
3274
  | <code><a href="#lerna-projen.LernaProjectOptions.property.pullRequestTemplateContents">pullRequestTemplateContents</a></code> | <code>string[]</code> | The contents of the pull request template. |
3614
3275
  | <code><a href="#lerna-projen.LernaProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
3615
3276
  | <code><a href="#lerna-projen.LernaProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
3616
- | <code><a href="#lerna-projen.LernaProjectOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
3617
3277
  | <code><a href="#lerna-projen.LernaProjectOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
3618
3278
  | <code><a href="#lerna-projen.LernaProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
3619
3279
  | <code><a href="#lerna-projen.LernaProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
@@ -3916,118 +3576,55 @@ Add a Gitpod development environment.
3916
3576
 
3917
3577
  ---
3918
3578
 
3919
- ##### ~~`mergify`~~<sup>Optional</sup> <a name="mergify" id="lerna-projen.LernaProjectOptions.property.mergify"></a>
3920
-
3921
- - *Deprecated:* use `githubOptions.mergify` instead
3579
+ ##### `projenCredentials`<sup>Optional</sup> <a name="projenCredentials" id="lerna-projen.LernaProjectOptions.property.projenCredentials"></a>
3922
3580
 
3923
3581
  ```typescript
3924
- public readonly mergify: boolean;
3582
+ public readonly projenCredentials: GithubCredentials;
3925
3583
  ```
3926
3584
 
3927
- - *Type:* boolean
3928
- - *Default:* true
3585
+ - *Type:* projen.github.GithubCredentials
3586
+ - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
3929
3587
 
3930
- Whether mergify should be enabled on this repository or not.
3588
+ Choose a method of providing GitHub API access for projen workflows.
3931
3589
 
3932
3590
  ---
3933
3591
 
3934
- ##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="mergifyOptions" id="lerna-projen.LernaProjectOptions.property.mergifyOptions"></a>
3935
-
3936
- - *Deprecated:* use `githubOptions.mergifyOptions` instead
3592
+ ##### `readme`<sup>Optional</sup> <a name="readme" id="lerna-projen.LernaProjectOptions.property.readme"></a>
3937
3593
 
3938
3594
  ```typescript
3939
- public readonly mergifyOptions: MergifyOptions;
3595
+ public readonly readme: SampleReadmeProps;
3940
3596
  ```
3941
3597
 
3942
- - *Type:* projen.github.MergifyOptions
3943
- - *Default:* default options
3598
+ - *Type:* projen.SampleReadmeProps
3599
+ - *Default:* { filename: 'README.md', contents: '# replace this' }
3944
3600
 
3945
- Options for mergify.
3601
+ The README setup.
3946
3602
 
3947
3603
  ---
3948
3604
 
3949
- ##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="lerna-projen.LernaProjectOptions.property.projectType"></a>
3605
+ *Example*
3606
+
3607
+ ```typescript
3608
+ "{ filename: 'readme.md', contents: '# title' }"
3609
+ ```
3610
+
3950
3611
 
3951
- - *Deprecated:* no longer supported at the base project level
3612
+ ##### `stale`<sup>Optional</sup> <a name="stale" id="lerna-projen.LernaProjectOptions.property.stale"></a>
3952
3613
 
3953
3614
  ```typescript
3954
- public readonly projectType: ProjectType;
3615
+ public readonly stale: boolean;
3955
3616
  ```
3956
3617
 
3957
- - *Type:* projen.ProjectType
3958
- - *Default:* ProjectType.UNKNOWN
3618
+ - *Type:* boolean
3619
+ - *Default:* false
3620
+
3621
+ Auto-close of stale issues and pull request.
3959
3622
 
3960
- Which type of project this is (library/app).
3623
+ See `staleOptions` for options.
3961
3624
 
3962
3625
  ---
3963
3626
 
3964
- ##### `projenCredentials`<sup>Optional</sup> <a name="projenCredentials" id="lerna-projen.LernaProjectOptions.property.projenCredentials"></a>
3965
-
3966
- ```typescript
3967
- public readonly projenCredentials: GithubCredentials;
3968
- ```
3969
-
3970
- - *Type:* projen.github.GithubCredentials
3971
- - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
3972
-
3973
- Choose a method of providing GitHub API access for projen workflows.
3974
-
3975
- ---
3976
-
3977
- ##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="projenTokenSecret" id="lerna-projen.LernaProjectOptions.property.projenTokenSecret"></a>
3978
-
3979
- - *Deprecated:* use `projenCredentials`
3980
-
3981
- ```typescript
3982
- public readonly projenTokenSecret: string;
3983
- ```
3984
-
3985
- - *Type:* string
3986
- - *Default:* "PROJEN_GITHUB_TOKEN"
3987
-
3988
- The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
3989
-
3990
- This token needs to have the `repo`, `workflows`
3991
- and `packages` scope.
3992
-
3993
- ---
3994
-
3995
- ##### `readme`<sup>Optional</sup> <a name="readme" id="lerna-projen.LernaProjectOptions.property.readme"></a>
3996
-
3997
- ```typescript
3998
- public readonly readme: SampleReadmeProps;
3999
- ```
4000
-
4001
- - *Type:* projen.SampleReadmeProps
4002
- - *Default:* { filename: 'README.md', contents: '# replace this' }
4003
-
4004
- The README setup.
4005
-
4006
- ---
4007
-
4008
- *Example*
4009
-
4010
- ```typescript
4011
- "{ filename: 'readme.md', contents: '# title' }"
4012
- ```
4013
-
4014
-
4015
- ##### `stale`<sup>Optional</sup> <a name="stale" id="lerna-projen.LernaProjectOptions.property.stale"></a>
4016
-
4017
- ```typescript
4018
- public readonly stale: boolean;
4019
- ```
4020
-
4021
- - *Type:* boolean
4022
- - *Default:* false
4023
-
4024
- Auto-close of stale issues and pull request.
4025
-
4026
- See `staleOptions` for options.
4027
-
4028
- ---
4029
-
4030
- ##### `staleOptions`<sup>Optional</sup> <a name="staleOptions" id="lerna-projen.LernaProjectOptions.property.staleOptions"></a>
3627
+ ##### `staleOptions`<sup>Optional</sup> <a name="staleOptions" id="lerna-projen.LernaProjectOptions.property.staleOptions"></a>
4031
3628
 
4032
3629
  ```typescript
4033
3630
  public readonly staleOptions: StaleOptions;
@@ -4491,22 +4088,6 @@ which is using npm internally and supports provenance statements independently o
4491
4088
 
4492
4089
  ---
4493
4090
 
4494
- ##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="npmRegistry" id="lerna-projen.LernaProjectOptions.property.npmRegistry"></a>
4495
-
4496
- - *Deprecated:* use `npmRegistryUrl` instead
4497
-
4498
- ```typescript
4499
- public readonly npmRegistry: string;
4500
- ```
4501
-
4502
- - *Type:* string
4503
-
4504
- The host name of the npm registry to publish to.
4505
-
4506
- Cannot be set together with `npmRegistryUrl`.
4507
-
4508
- ---
4509
-
4510
4091
  ##### `npmRegistryUrl`<sup>Optional</sup> <a name="npmRegistryUrl" id="lerna-projen.LernaProjectOptions.property.npmRegistryUrl"></a>
4511
4092
 
4512
4093
  ```typescript
@@ -4665,25 +4246,6 @@ Options for privately hosted scoped packages.
4665
4246
 
4666
4247
  ---
4667
4248
 
4668
- ##### ~~`scripts`~~<sup>Optional</sup> <a name="scripts" id="lerna-projen.LernaProjectOptions.property.scripts"></a>
4669
-
4670
- - *Deprecated:* use `project.addTask()` or `package.setScript()`
4671
-
4672
- ```typescript
4673
- public readonly scripts: {[ key: string ]: string};
4674
- ```
4675
-
4676
- - *Type:* {[ key: string ]: string}
4677
- - *Default:* {}
4678
-
4679
- npm scripts to include.
4680
-
4681
- If a script has the same name as a standard script,
4682
- the standard script will be overwritten.
4683
- Also adds the script as a task.
4684
-
4685
- ---
4686
-
4687
4249
  ##### `stability`<sup>Optional</sup> <a name="stability" id="lerna-projen.LernaProjectOptions.property.stability"></a>
4688
4250
 
4689
4251
  ```typescript
@@ -4926,21 +4488,6 @@ on a per artifact basis.
4926
4488
 
4927
4489
  ---
4928
4490
 
4929
- ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="lerna-projen.LernaProjectOptions.property.releaseEveryCommit"></a>
4930
-
4931
- - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
4932
-
4933
- ```typescript
4934
- public readonly releaseEveryCommit: boolean;
4935
- ```
4936
-
4937
- - *Type:* boolean
4938
- - *Default:* true
4939
-
4940
- Automatically release new versions every commit to one of branches in `releaseBranches`.
4941
-
4942
- ---
4943
-
4944
4491
  ##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="lerna-projen.LernaProjectOptions.property.releaseFailureIssue"></a>
4945
4492
 
4946
4493
  ```typescript
@@ -4969,21 +4516,6 @@ Only applies if `releaseFailureIssue` is true.
4969
4516
 
4970
4517
  ---
4971
4518
 
4972
- ##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="releaseSchedule" id="lerna-projen.LernaProjectOptions.property.releaseSchedule"></a>
4973
-
4974
- - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
4975
-
4976
- ```typescript
4977
- public readonly releaseSchedule: string;
4978
- ```
4979
-
4980
- - *Type:* string
4981
- - *Default:* no scheduled releases
4982
-
4983
- CRON schedule to trigger new releases.
4984
-
4985
- ---
4986
-
4987
4519
  ##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="lerna-projen.LernaProjectOptions.property.releaseTagPrefix"></a>
4988
4520
 
4989
4521
  ```typescript
@@ -5106,19 +4638,6 @@ Github Runner Group selection options.
5106
4638
 
5107
4639
  ---
5108
4640
 
5109
- ##### `defaultReleaseBranch`<sup>Required</sup> <a name="defaultReleaseBranch" id="lerna-projen.LernaProjectOptions.property.defaultReleaseBranch"></a>
5110
-
5111
- ```typescript
5112
- public readonly defaultReleaseBranch: string;
5113
- ```
5114
-
5115
- - *Type:* string
5116
- - *Default:* "main"
5117
-
5118
- The name of the main release branch.
5119
-
5120
- ---
5121
-
5122
4641
  ##### `artifactsDirectory`<sup>Optional</sup> <a name="artifactsDirectory" id="lerna-projen.LernaProjectOptions.property.artifactsDirectory"></a>
5123
4642
 
5124
4643
  ```typescript
@@ -5228,21 +4747,6 @@ Options for PR build workflow.
5228
4747
 
5229
4748
  ---
5230
4749
 
5231
- ##### ~~`buildWorkflowTriggers`~~<sup>Optional</sup> <a name="buildWorkflowTriggers" id="lerna-projen.LernaProjectOptions.property.buildWorkflowTriggers"></a>
5232
-
5233
- - *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers`
5234
-
5235
- ```typescript
5236
- public readonly buildWorkflowTriggers: Triggers;
5237
- ```
5238
-
5239
- - *Type:* projen.github.workflows.Triggers
5240
- - *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
5241
-
5242
- Build workflow triggers.
5243
-
5244
- ---
5245
-
5246
4750
  ##### `bundlerOptions`<sup>Optional</sup> <a name="bundlerOptions" id="lerna-projen.LernaProjectOptions.property.bundlerOptions"></a>
5247
4751
 
5248
4752
  ```typescript
@@ -5322,6 +4826,19 @@ The copyright years to put in the LICENSE file.
5322
4826
 
5323
4827
  ---
5324
4828
 
4829
+ ##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="lerna-projen.LernaProjectOptions.property.defaultReleaseBranch"></a>
4830
+
4831
+ ```typescript
4832
+ public readonly defaultReleaseBranch: string;
4833
+ ```
4834
+
4835
+ - *Type:* string
4836
+ - *Default:* "main"
4837
+
4838
+ The name of the main release branch.
4839
+
4840
+ ---
4841
+
5325
4842
  ##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="lerna-projen.LernaProjectOptions.property.dependabot"></a>
5326
4843
 
5327
4844
  ```typescript
@@ -5416,41 +4933,6 @@ Jest options.
5416
4933
 
5417
4934
  ---
5418
4935
 
5419
- ##### ~~`mutableBuild`~~<sup>Optional</sup> <a name="mutableBuild" id="lerna-projen.LernaProjectOptions.property.mutableBuild"></a>
5420
-
5421
- - *Deprecated:* - Use `buildWorkflowOptions.mutableBuild`
5422
-
5423
- ```typescript
5424
- public readonly mutableBuild: boolean;
5425
- ```
5426
-
5427
- - *Type:* boolean
5428
- - *Default:* true
5429
-
5430
- Automatically update files modified during builds to pull-request branches.
5431
-
5432
- This means
5433
- that any files synthesized by projen or e.g. test snapshots will always be up-to-date
5434
- before a PR is merged.
5435
-
5436
- Implies that PR builds do not have anti-tamper checks.
5437
-
5438
- ---
5439
-
5440
- ##### ~~`npmignore`~~<sup>Optional</sup> <a name="npmignore" id="lerna-projen.LernaProjectOptions.property.npmignore"></a>
5441
-
5442
- - *Deprecated:* - use `project.addPackageIgnore`
5443
-
5444
- ```typescript
5445
- public readonly npmignore: string[];
5446
- ```
5447
-
5448
- - *Type:* string[]
5449
-
5450
- Additional entries to .npmignore.
5451
-
5452
- ---
5453
-
5454
4936
  ##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="lerna-projen.LernaProjectOptions.property.npmignoreEnabled"></a>
5455
4937
 
5456
4938
  ```typescript
@@ -5619,21 +5101,6 @@ Automatically release to npm when new versions are introduced.
5619
5101
 
5620
5102
  ---
5621
5103
 
5622
- ##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="releaseWorkflow" id="lerna-projen.LernaProjectOptions.property.releaseWorkflow"></a>
5623
-
5624
- - *Deprecated:* see `release`.
5625
-
5626
- ```typescript
5627
- public readonly releaseWorkflow: boolean;
5628
- ```
5629
-
5630
- - *Type:* boolean
5631
- - *Default:* true if not a subproject
5632
-
5633
- DEPRECATED: renamed to `release`.
5634
-
5635
- ---
5636
-
5637
5104
  ##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="workflowBootstrapSteps" id="lerna-projen.LernaProjectOptions.property.workflowBootstrapSteps"></a>
5638
5105
 
5639
5106
  ```typescript
@@ -5843,11 +5310,7 @@ const lernaTypescriptProjectOptions: LernaTypescriptProjectOptions = { ... }
5843
5310
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
5844
5311
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
5845
5312
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.gitpod">gitpod</a></code> | <code>boolean</code> | Add a Gitpod development environment. |
5846
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.mergify">mergify</a></code> | <code>boolean</code> | Whether mergify should be enabled on this repository or not. |
5847
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.mergifyOptions">mergifyOptions</a></code> | <code>projen.github.MergifyOptions</code> | Options for mergify. |
5848
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
5849
5313
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
5850
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.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. |
5851
5314
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.readme">readme</a></code> | <code>projen.SampleReadmeProps</code> | The README setup. |
5852
5315
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
5853
5316
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.staleOptions">staleOptions</a></code> | <code>projen.github.StaleOptions</code> | Auto-close stale issues and pull requests. |
@@ -5879,7 +5342,6 @@ const lernaTypescriptProjectOptions: LernaTypescriptProjectOptions = { ... }
5879
5342
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. Most projects should not use this option. |
5880
5343
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
5881
5344
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
5882
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
5883
5345
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
5884
5346
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
5885
5347
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.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. |
@@ -5891,7 +5353,6 @@ const lernaTypescriptProjectOptions: LernaTypescriptProjectOptions = { ... }
5891
5353
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
5892
5354
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.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. |
5893
5355
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
5894
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.scripts">scripts</a></code> | <code>{[ key: string ]: string}</code> | npm scripts to include. |
5895
5356
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
5896
5357
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
5897
5358
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.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. |
@@ -5907,10 +5368,8 @@ const lernaTypescriptProjectOptions: LernaTypescriptProjectOptions = { ... }
5907
5368
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
5908
5369
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
5909
5370
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
5910
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
5911
5371
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
5912
5372
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
5913
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
5914
5373
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
5915
5374
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
5916
5375
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
@@ -5920,7 +5379,6 @@ const lernaTypescriptProjectOptions: LernaTypescriptProjectOptions = { ... }
5920
5379
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
5921
5380
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
5922
5381
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
5923
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
5924
5382
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
5925
5383
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
5926
5384
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
@@ -5929,13 +5387,13 @@ const lernaTypescriptProjectOptions: LernaTypescriptProjectOptions = { ... }
5929
5387
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
5930
5388
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
5931
5389
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
5932
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
5933
5390
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
5934
5391
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
5935
5392
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
5936
5393
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
5937
5394
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
5938
5395
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
5396
+ | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
5939
5397
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
5940
5398
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
5941
5399
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.depsUpgrade">depsUpgrade</a></code> | <code>boolean</code> | Use tasks and github workflows to handle dependency upgrades. |
@@ -5943,8 +5401,6 @@ const lernaTypescriptProjectOptions: LernaTypescriptProjectOptions = { ... }
5943
5401
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
5944
5402
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.jest">jest</a></code> | <code>boolean</code> | Setup jest unit tests. |
5945
5403
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.jestOptions">jestOptions</a></code> | <code>projen.javascript.JestOptions</code> | Jest options. |
5946
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
5947
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
5948
5404
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
5949
5405
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
5950
5406
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
@@ -5958,13 +5414,12 @@ const lernaTypescriptProjectOptions: LernaTypescriptProjectOptions = { ... }
5958
5414
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.pullRequestTemplateContents">pullRequestTemplateContents</a></code> | <code>string[]</code> | The contents of the pull request template. |
5959
5415
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
5960
5416
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
5961
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
5962
5417
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
5963
5418
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
5964
5419
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
5965
5420
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
5966
5421
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.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). |
5967
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
5422
+ | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
5968
5423
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
5969
5424
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
5970
5425
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.entrypointTypes">entrypointTypes</a></code> | <code>string</code> | The .d.ts file that includes the type declarations for this module. |
@@ -5978,7 +5433,7 @@ const lernaTypescriptProjectOptions: LernaTypescriptProjectOptions = { ... }
5978
5433
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.testdir">testdir</a></code> | <code>string</code> | Jest tests directory. Tests files should be named `xxx.test.ts`. |
5979
5434
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
5980
5435
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
5981
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
5436
+ | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
5982
5437
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
5983
5438
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
5984
5439
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.independentMode">independentMode</a></code> | <code>boolean</code> | Whether or not to use independent versioning for sub-projects https://lerna.js.org/docs/features/version-and-publish#independent-mode. |
@@ -6277,51 +5732,6 @@ Add a Gitpod development environment.
6277
5732
 
6278
5733
  ---
6279
5734
 
6280
- ##### ~~`mergify`~~<sup>Optional</sup> <a name="mergify" id="lerna-projen.LernaTypescriptProjectOptions.property.mergify"></a>
6281
-
6282
- - *Deprecated:* use `githubOptions.mergify` instead
6283
-
6284
- ```typescript
6285
- public readonly mergify: boolean;
6286
- ```
6287
-
6288
- - *Type:* boolean
6289
- - *Default:* true
6290
-
6291
- Whether mergify should be enabled on this repository or not.
6292
-
6293
- ---
6294
-
6295
- ##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="mergifyOptions" id="lerna-projen.LernaTypescriptProjectOptions.property.mergifyOptions"></a>
6296
-
6297
- - *Deprecated:* use `githubOptions.mergifyOptions` instead
6298
-
6299
- ```typescript
6300
- public readonly mergifyOptions: MergifyOptions;
6301
- ```
6302
-
6303
- - *Type:* projen.github.MergifyOptions
6304
- - *Default:* default options
6305
-
6306
- Options for mergify.
6307
-
6308
- ---
6309
-
6310
- ##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="lerna-projen.LernaTypescriptProjectOptions.property.projectType"></a>
6311
-
6312
- - *Deprecated:* no longer supported at the base project level
6313
-
6314
- ```typescript
6315
- public readonly projectType: ProjectType;
6316
- ```
6317
-
6318
- - *Type:* projen.ProjectType
6319
- - *Default:* ProjectType.UNKNOWN
6320
-
6321
- Which type of project this is (library/app).
6322
-
6323
- ---
6324
-
6325
5735
  ##### `projenCredentials`<sup>Optional</sup> <a name="projenCredentials" id="lerna-projen.LernaTypescriptProjectOptions.property.projenCredentials"></a>
6326
5736
 
6327
5737
  ```typescript
@@ -6335,24 +5745,6 @@ Choose a method of providing GitHub API access for projen workflows.
6335
5745
 
6336
5746
  ---
6337
5747
 
6338
- ##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="projenTokenSecret" id="lerna-projen.LernaTypescriptProjectOptions.property.projenTokenSecret"></a>
6339
-
6340
- - *Deprecated:* use `projenCredentials`
6341
-
6342
- ```typescript
6343
- public readonly projenTokenSecret: string;
6344
- ```
6345
-
6346
- - *Type:* string
6347
- - *Default:* "PROJEN_GITHUB_TOKEN"
6348
-
6349
- The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
6350
-
6351
- This token needs to have the `repo`, `workflows`
6352
- and `packages` scope.
6353
-
6354
- ---
6355
-
6356
5748
  ##### `readme`<sup>Optional</sup> <a name="readme" id="lerna-projen.LernaTypescriptProjectOptions.property.readme"></a>
6357
5749
 
6358
5750
  ```typescript
@@ -6852,22 +6244,6 @@ which is using npm internally and supports provenance statements independently o
6852
6244
 
6853
6245
  ---
6854
6246
 
6855
- ##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="npmRegistry" id="lerna-projen.LernaTypescriptProjectOptions.property.npmRegistry"></a>
6856
-
6857
- - *Deprecated:* use `npmRegistryUrl` instead
6858
-
6859
- ```typescript
6860
- public readonly npmRegistry: string;
6861
- ```
6862
-
6863
- - *Type:* string
6864
-
6865
- The host name of the npm registry to publish to.
6866
-
6867
- Cannot be set together with `npmRegistryUrl`.
6868
-
6869
- ---
6870
-
6871
6247
  ##### `npmRegistryUrl`<sup>Optional</sup> <a name="npmRegistryUrl" id="lerna-projen.LernaTypescriptProjectOptions.property.npmRegistryUrl"></a>
6872
6248
 
6873
6249
  ```typescript
@@ -7026,25 +6402,6 @@ Options for privately hosted scoped packages.
7026
6402
 
7027
6403
  ---
7028
6404
 
7029
- ##### ~~`scripts`~~<sup>Optional</sup> <a name="scripts" id="lerna-projen.LernaTypescriptProjectOptions.property.scripts"></a>
7030
-
7031
- - *Deprecated:* use `project.addTask()` or `package.setScript()`
7032
-
7033
- ```typescript
7034
- public readonly scripts: {[ key: string ]: string};
7035
- ```
7036
-
7037
- - *Type:* {[ key: string ]: string}
7038
- - *Default:* {}
7039
-
7040
- npm scripts to include.
7041
-
7042
- If a script has the same name as a standard script,
7043
- the standard script will be overwritten.
7044
- Also adds the script as a task.
7045
-
7046
- ---
7047
-
7048
6405
  ##### `stability`<sup>Optional</sup> <a name="stability" id="lerna-projen.LernaTypescriptProjectOptions.property.stability"></a>
7049
6406
 
7050
6407
  ```typescript
@@ -7287,21 +6644,6 @@ on a per artifact basis.
7287
6644
 
7288
6645
  ---
7289
6646
 
7290
- ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="lerna-projen.LernaTypescriptProjectOptions.property.releaseEveryCommit"></a>
7291
-
7292
- - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
7293
-
7294
- ```typescript
7295
- public readonly releaseEveryCommit: boolean;
7296
- ```
7297
-
7298
- - *Type:* boolean
7299
- - *Default:* true
7300
-
7301
- Automatically release new versions every commit to one of branches in `releaseBranches`.
7302
-
7303
- ---
7304
-
7305
6647
  ##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="lerna-projen.LernaTypescriptProjectOptions.property.releaseFailureIssue"></a>
7306
6648
 
7307
6649
  ```typescript
@@ -7330,21 +6672,6 @@ Only applies if `releaseFailureIssue` is true.
7330
6672
 
7331
6673
  ---
7332
6674
 
7333
- ##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="releaseSchedule" id="lerna-projen.LernaTypescriptProjectOptions.property.releaseSchedule"></a>
7334
-
7335
- - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
7336
-
7337
- ```typescript
7338
- public readonly releaseSchedule: string;
7339
- ```
7340
-
7341
- - *Type:* string
7342
- - *Default:* no scheduled releases
7343
-
7344
- CRON schedule to trigger new releases.
7345
-
7346
- ---
7347
-
7348
6675
  ##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="lerna-projen.LernaTypescriptProjectOptions.property.releaseTagPrefix"></a>
7349
6676
 
7350
6677
  ```typescript
@@ -7467,19 +6794,6 @@ Github Runner Group selection options.
7467
6794
 
7468
6795
  ---
7469
6796
 
7470
- ##### `defaultReleaseBranch`<sup>Required</sup> <a name="defaultReleaseBranch" id="lerna-projen.LernaTypescriptProjectOptions.property.defaultReleaseBranch"></a>
7471
-
7472
- ```typescript
7473
- public readonly defaultReleaseBranch: string;
7474
- ```
7475
-
7476
- - *Type:* string
7477
- - *Default:* "main"
7478
-
7479
- The name of the main release branch.
7480
-
7481
- ---
7482
-
7483
6797
  ##### `artifactsDirectory`<sup>Optional</sup> <a name="artifactsDirectory" id="lerna-projen.LernaTypescriptProjectOptions.property.artifactsDirectory"></a>
7484
6798
 
7485
6799
  ```typescript
@@ -7589,21 +6903,6 @@ Options for PR build workflow.
7589
6903
 
7590
6904
  ---
7591
6905
 
7592
- ##### ~~`buildWorkflowTriggers`~~<sup>Optional</sup> <a name="buildWorkflowTriggers" id="lerna-projen.LernaTypescriptProjectOptions.property.buildWorkflowTriggers"></a>
7593
-
7594
- - *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers`
7595
-
7596
- ```typescript
7597
- public readonly buildWorkflowTriggers: Triggers;
7598
- ```
7599
-
7600
- - *Type:* projen.github.workflows.Triggers
7601
- - *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
7602
-
7603
- Build workflow triggers.
7604
-
7605
- ---
7606
-
7607
6906
  ##### `bundlerOptions`<sup>Optional</sup> <a name="bundlerOptions" id="lerna-projen.LernaTypescriptProjectOptions.property.bundlerOptions"></a>
7608
6907
 
7609
6908
  ```typescript
@@ -7683,6 +6982,19 @@ The copyright years to put in the LICENSE file.
7683
6982
 
7684
6983
  ---
7685
6984
 
6985
+ ##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="lerna-projen.LernaTypescriptProjectOptions.property.defaultReleaseBranch"></a>
6986
+
6987
+ ```typescript
6988
+ public readonly defaultReleaseBranch: string;
6989
+ ```
6990
+
6991
+ - *Type:* string
6992
+ - *Default:* "main"
6993
+
6994
+ The name of the main release branch.
6995
+
6996
+ ---
6997
+
7686
6998
  ##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="lerna-projen.LernaTypescriptProjectOptions.property.dependabot"></a>
7687
6999
 
7688
7000
  ```typescript
@@ -7777,41 +7089,6 @@ Jest options.
7777
7089
 
7778
7090
  ---
7779
7091
 
7780
- ##### ~~`mutableBuild`~~<sup>Optional</sup> <a name="mutableBuild" id="lerna-projen.LernaTypescriptProjectOptions.property.mutableBuild"></a>
7781
-
7782
- - *Deprecated:* - Use `buildWorkflowOptions.mutableBuild`
7783
-
7784
- ```typescript
7785
- public readonly mutableBuild: boolean;
7786
- ```
7787
-
7788
- - *Type:* boolean
7789
- - *Default:* true
7790
-
7791
- Automatically update files modified during builds to pull-request branches.
7792
-
7793
- This means
7794
- that any files synthesized by projen or e.g. test snapshots will always be up-to-date
7795
- before a PR is merged.
7796
-
7797
- Implies that PR builds do not have anti-tamper checks.
7798
-
7799
- ---
7800
-
7801
- ##### ~~`npmignore`~~<sup>Optional</sup> <a name="npmignore" id="lerna-projen.LernaTypescriptProjectOptions.property.npmignore"></a>
7802
-
7803
- - *Deprecated:* - use `project.addPackageIgnore`
7804
-
7805
- ```typescript
7806
- public readonly npmignore: string[];
7807
- ```
7808
-
7809
- - *Type:* string[]
7810
-
7811
- Additional entries to .npmignore.
7812
-
7813
- ---
7814
-
7815
7092
  ##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="lerna-projen.LernaTypescriptProjectOptions.property.npmignoreEnabled"></a>
7816
7093
 
7817
7094
  ```typescript
@@ -7980,21 +7257,6 @@ Automatically release to npm when new versions are introduced.
7980
7257
 
7981
7258
  ---
7982
7259
 
7983
- ##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="releaseWorkflow" id="lerna-projen.LernaTypescriptProjectOptions.property.releaseWorkflow"></a>
7984
-
7985
- - *Deprecated:* see `release`.
7986
-
7987
- ```typescript
7988
- public readonly releaseWorkflow: boolean;
7989
- ```
7990
-
7991
- - *Type:* boolean
7992
- - *Default:* true if not a subproject
7993
-
7994
- DEPRECATED: renamed to `release`.
7995
-
7996
- ---
7997
-
7998
7260
  ##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="workflowBootstrapSteps" id="lerna-projen.LernaTypescriptProjectOptions.property.workflowBootstrapSteps"></a>
7999
7261
 
8000
7262
  ```typescript
@@ -8071,7 +7333,7 @@ public readonly disableTsconfigDev: boolean;
8071
7333
  - *Type:* boolean
8072
7334
  - *Default:* false
8073
7335
 
8074
- Do not generate a `tsconfig.dev.json` file.
7336
+ Do not generate a development tsconfig file.
8075
7337
 
8076
7338
  ---
8077
7339
 
@@ -8255,9 +7517,13 @@ public readonly tsconfigDevFile: string;
8255
7517
  ```
8256
7518
 
8257
7519
  - *Type:* string
8258
- - *Default:* "tsconfig.dev.json"
7520
+ - *Default:* "{testdir}/tsconfig.json"
7521
+
7522
+ The name (and path) of the development tsconfig file.
8259
7523
 
8260
- The name of the development tsconfig.json file.
7524
+ By default this lives inside the test directory (e.g. `test/tsconfig.json`)
7525
+ so that the TypeScript language service resolves it as the nearest config
7526
+ for test files.
8261
7527
 
8262
7528
  ---
8263
7529