cdklabs-projen-project-types 0.3.21 → 0.3.23
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 +320 -181
- package/API.md +465 -239
- package/lib/cdk-construct-library-options.d.ts +10 -10
- package/lib/cdk-construct-library-options.js +1 -1
- package/lib/cdk-jsii-options.d.ts +10 -10
- package/lib/cdk-jsii-options.js +1 -1
- package/lib/cdk.js +2 -2
- package/lib/cdklabs.js +3 -3
- package/lib/jsii.js +1 -1
- package/lib/rosetta.js +1 -1
- package/lib/yarn/constraints.d.ts +16 -0
- package/lib/yarn/constraints.js +69 -0
- package/lib/yarn/index.d.ts +1 -0
- package/lib/yarn/index.js +2 -1
- package/lib/yarn/monorepo-options.d.ts +17 -10
- package/lib/yarn/monorepo-options.js +1 -1
- package/lib/yarn/monorepo-release.js +3 -14
- package/lib/yarn/monorepo.d.ts +1 -2
- package/lib/yarn/monorepo.js +22 -14
- package/lib/yarn/nx.d.ts +1 -0
- package/lib/yarn/nx.js +5 -1
- package/lib/yarn/typescript-workspace-options.d.ts +10 -10
- package/lib/yarn/typescript-workspace-options.js +1 -1
- package/lib/yarn/typescript-workspace-release.js +1 -1
- package/lib/yarn/typescript-workspace.js +2 -3
- package/package.json +31 -24
package/API.md
CHANGED
|
@@ -254,7 +254,7 @@ public runTaskCommand(task: Task): string
|
|
|
254
254
|
Returns the shell command to execute in order to run a task.
|
|
255
255
|
|
|
256
256
|
This will
|
|
257
|
-
typically be `
|
|
257
|
+
typically be `pnpm projen TASK`.
|
|
258
258
|
|
|
259
259
|
###### `task`<sup>Required</sup> <a name="task" id="cdklabs-projen-project-types.CdkConstructLibrary.runTaskCommand.parameter.task"></a>
|
|
260
260
|
|
|
@@ -379,9 +379,9 @@ Bundled dependencies will be added as normal dependencies as well as to the
|
|
|
379
379
|
Names modules to install.
|
|
380
380
|
|
|
381
381
|
By default, the the dependency will
|
|
382
|
-
be installed in the next `
|
|
383
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
384
|
-
add/
|
|
382
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
383
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
384
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
385
385
|
`module@^7`.
|
|
386
386
|
|
|
387
387
|
---
|
|
@@ -415,9 +415,9 @@ Defines normal dependencies.
|
|
|
415
415
|
Names modules to install.
|
|
416
416
|
|
|
417
417
|
By default, the the dependency will
|
|
418
|
-
be installed in the next `
|
|
419
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
420
|
-
add/
|
|
418
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
419
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
420
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
421
421
|
`module@^7`.
|
|
422
422
|
|
|
423
423
|
---
|
|
@@ -437,9 +437,9 @@ Defines development/test dependencies.
|
|
|
437
437
|
Names modules to install.
|
|
438
438
|
|
|
439
439
|
By default, the the dependency will
|
|
440
|
-
be installed in the next `
|
|
441
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
442
|
-
add/
|
|
440
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
441
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
442
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
443
443
|
`module@^7`.
|
|
444
444
|
|
|
445
445
|
---
|
|
@@ -495,9 +495,9 @@ your code against the minimum version required from your consumers.
|
|
|
495
495
|
Names modules to install.
|
|
496
496
|
|
|
497
497
|
By default, the the dependency will
|
|
498
|
-
be installed in the next `
|
|
499
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
500
|
-
add/
|
|
498
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
499
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
500
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
501
501
|
`module@^7`.
|
|
502
502
|
|
|
503
503
|
---
|
|
@@ -1876,7 +1876,7 @@ public runTaskCommand(task: Task): string
|
|
|
1876
1876
|
Returns the shell command to execute in order to run a task.
|
|
1877
1877
|
|
|
1878
1878
|
This will
|
|
1879
|
-
typically be `
|
|
1879
|
+
typically be `pnpm projen TASK`.
|
|
1880
1880
|
|
|
1881
1881
|
###### `task`<sup>Required</sup> <a name="task" id="cdklabs-projen-project-types.CdkJsiiProject.runTaskCommand.parameter.task"></a>
|
|
1882
1882
|
|
|
@@ -2001,9 +2001,9 @@ Bundled dependencies will be added as normal dependencies as well as to the
|
|
|
2001
2001
|
Names modules to install.
|
|
2002
2002
|
|
|
2003
2003
|
By default, the the dependency will
|
|
2004
|
-
be installed in the next `
|
|
2005
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
2006
|
-
add/
|
|
2004
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
2005
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
2006
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
2007
2007
|
`module@^7`.
|
|
2008
2008
|
|
|
2009
2009
|
---
|
|
@@ -2037,9 +2037,9 @@ Defines normal dependencies.
|
|
|
2037
2037
|
Names modules to install.
|
|
2038
2038
|
|
|
2039
2039
|
By default, the the dependency will
|
|
2040
|
-
be installed in the next `
|
|
2041
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
2042
|
-
add/
|
|
2040
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
2041
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
2042
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
2043
2043
|
`module@^7`.
|
|
2044
2044
|
|
|
2045
2045
|
---
|
|
@@ -2059,9 +2059,9 @@ Defines development/test dependencies.
|
|
|
2059
2059
|
Names modules to install.
|
|
2060
2060
|
|
|
2061
2061
|
By default, the the dependency will
|
|
2062
|
-
be installed in the next `
|
|
2063
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
2064
|
-
add/
|
|
2062
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
2063
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
2064
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
2065
2065
|
`module@^7`.
|
|
2066
2066
|
|
|
2067
2067
|
---
|
|
@@ -2117,9 +2117,9 @@ your code against the minimum version required from your consumers.
|
|
|
2117
2117
|
Names modules to install.
|
|
2118
2118
|
|
|
2119
2119
|
By default, the the dependency will
|
|
2120
|
-
be installed in the next `
|
|
2121
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
2122
|
-
add/
|
|
2120
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
2121
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
2122
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
2123
2123
|
`module@^7`.
|
|
2124
2124
|
|
|
2125
2125
|
---
|
|
@@ -3429,7 +3429,7 @@ public runTaskCommand(task: Task): string
|
|
|
3429
3429
|
Returns the shell command to execute in order to run a task.
|
|
3430
3430
|
|
|
3431
3431
|
This will
|
|
3432
|
-
typically be `
|
|
3432
|
+
typically be `pnpm projen TASK`.
|
|
3433
3433
|
|
|
3434
3434
|
###### `task`<sup>Required</sup> <a name="task" id="cdklabs-projen-project-types.CdklabsConstructLibrary.runTaskCommand.parameter.task"></a>
|
|
3435
3435
|
|
|
@@ -3554,9 +3554,9 @@ Bundled dependencies will be added as normal dependencies as well as to the
|
|
|
3554
3554
|
Names modules to install.
|
|
3555
3555
|
|
|
3556
3556
|
By default, the the dependency will
|
|
3557
|
-
be installed in the next `
|
|
3558
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
3559
|
-
add/
|
|
3557
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
3558
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
3559
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
3560
3560
|
`module@^7`.
|
|
3561
3561
|
|
|
3562
3562
|
---
|
|
@@ -3590,9 +3590,9 @@ Defines normal dependencies.
|
|
|
3590
3590
|
Names modules to install.
|
|
3591
3591
|
|
|
3592
3592
|
By default, the the dependency will
|
|
3593
|
-
be installed in the next `
|
|
3594
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
3595
|
-
add/
|
|
3593
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
3594
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
3595
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
3596
3596
|
`module@^7`.
|
|
3597
3597
|
|
|
3598
3598
|
---
|
|
@@ -3612,9 +3612,9 @@ Defines development/test dependencies.
|
|
|
3612
3612
|
Names modules to install.
|
|
3613
3613
|
|
|
3614
3614
|
By default, the the dependency will
|
|
3615
|
-
be installed in the next `
|
|
3616
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
3617
|
-
add/
|
|
3615
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
3616
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
3617
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
3618
3618
|
`module@^7`.
|
|
3619
3619
|
|
|
3620
3620
|
---
|
|
@@ -3670,9 +3670,9 @@ your code against the minimum version required from your consumers.
|
|
|
3670
3670
|
Names modules to install.
|
|
3671
3671
|
|
|
3672
3672
|
By default, the the dependency will
|
|
3673
|
-
be installed in the next `
|
|
3674
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
3675
|
-
add/
|
|
3673
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
3674
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
3675
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
3676
3676
|
`module@^7`.
|
|
3677
3677
|
|
|
3678
3678
|
---
|
|
@@ -5051,7 +5051,7 @@ public runTaskCommand(task: Task): string
|
|
|
5051
5051
|
Returns the shell command to execute in order to run a task.
|
|
5052
5052
|
|
|
5053
5053
|
This will
|
|
5054
|
-
typically be `
|
|
5054
|
+
typically be `pnpm projen TASK`.
|
|
5055
5055
|
|
|
5056
5056
|
###### `task`<sup>Required</sup> <a name="task" id="cdklabs-projen-project-types.CdklabsJsiiProject.runTaskCommand.parameter.task"></a>
|
|
5057
5057
|
|
|
@@ -5176,9 +5176,9 @@ Bundled dependencies will be added as normal dependencies as well as to the
|
|
|
5176
5176
|
Names modules to install.
|
|
5177
5177
|
|
|
5178
5178
|
By default, the the dependency will
|
|
5179
|
-
be installed in the next `
|
|
5180
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
5181
|
-
add/
|
|
5179
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
5180
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
5181
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
5182
5182
|
`module@^7`.
|
|
5183
5183
|
|
|
5184
5184
|
---
|
|
@@ -5212,9 +5212,9 @@ Defines normal dependencies.
|
|
|
5212
5212
|
Names modules to install.
|
|
5213
5213
|
|
|
5214
5214
|
By default, the the dependency will
|
|
5215
|
-
be installed in the next `
|
|
5216
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
5217
|
-
add/
|
|
5215
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
5216
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
5217
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
5218
5218
|
`module@^7`.
|
|
5219
5219
|
|
|
5220
5220
|
---
|
|
@@ -5234,9 +5234,9 @@ Defines development/test dependencies.
|
|
|
5234
5234
|
Names modules to install.
|
|
5235
5235
|
|
|
5236
5236
|
By default, the the dependency will
|
|
5237
|
-
be installed in the next `
|
|
5238
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
5239
|
-
add/
|
|
5237
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
5238
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
5239
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
5240
5240
|
`module@^7`.
|
|
5241
5241
|
|
|
5242
5242
|
---
|
|
@@ -5292,9 +5292,9 @@ your code against the minimum version required from your consumers.
|
|
|
5292
5292
|
Names modules to install.
|
|
5293
5293
|
|
|
5294
5294
|
By default, the the dependency will
|
|
5295
|
-
be installed in the next `
|
|
5296
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
5297
|
-
add/
|
|
5295
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
5296
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
5297
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
5298
5298
|
`module@^7`.
|
|
5299
5299
|
|
|
5300
5300
|
---
|
|
@@ -6411,7 +6411,6 @@ new yarn.CdkLabsMonorepo(options: CdkLabsMonorepoOptions)
|
|
|
6411
6411
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
|
6412
6412
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
|
|
6413
6413
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
|
|
6414
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.register">register</a></code> | *No description.* |
|
|
6415
6414
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.requestInstallDependencies">requestInstallDependencies</a></code> | Allows a sub project to request installation of dependency at the Monorepo root They must provide a function that is executed after dependencies have been installed If this function returns true, the install command is run for a second time after all sub project requests have run. |
|
|
6416
6415
|
|
|
6417
6416
|
---
|
|
@@ -6602,7 +6601,7 @@ public runTaskCommand(task: Task): string
|
|
|
6602
6601
|
Returns the shell command to execute in order to run a task.
|
|
6603
6602
|
|
|
6604
6603
|
This will
|
|
6605
|
-
typically be `
|
|
6604
|
+
typically be `pnpm projen TASK`.
|
|
6606
6605
|
|
|
6607
6606
|
###### `task`<sup>Required</sup> <a name="task" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.runTaskCommand.parameter.task"></a>
|
|
6608
6607
|
|
|
@@ -6727,9 +6726,9 @@ Bundled dependencies will be added as normal dependencies as well as to the
|
|
|
6727
6726
|
Names modules to install.
|
|
6728
6727
|
|
|
6729
6728
|
By default, the the dependency will
|
|
6730
|
-
be installed in the next `
|
|
6731
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
6732
|
-
add/
|
|
6729
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
6730
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
6731
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
6733
6732
|
`module@^7`.
|
|
6734
6733
|
|
|
6735
6734
|
---
|
|
@@ -6763,9 +6762,9 @@ Defines normal dependencies.
|
|
|
6763
6762
|
Names modules to install.
|
|
6764
6763
|
|
|
6765
6764
|
By default, the the dependency will
|
|
6766
|
-
be installed in the next `
|
|
6767
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
6768
|
-
add/
|
|
6765
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
6766
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
6767
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
6769
6768
|
`module@^7`.
|
|
6770
6769
|
|
|
6771
6770
|
---
|
|
@@ -6785,9 +6784,9 @@ Defines development/test dependencies.
|
|
|
6785
6784
|
Names modules to install.
|
|
6786
6785
|
|
|
6787
6786
|
By default, the the dependency will
|
|
6788
|
-
be installed in the next `
|
|
6789
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
6790
|
-
add/
|
|
6787
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
6788
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
6789
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
6791
6790
|
`module@^7`.
|
|
6792
6791
|
|
|
6793
6792
|
---
|
|
@@ -6843,9 +6842,9 @@ your code against the minimum version required from your consumers.
|
|
|
6843
6842
|
Names modules to install.
|
|
6844
6843
|
|
|
6845
6844
|
By default, the the dependency will
|
|
6846
|
-
be installed in the next `
|
|
6847
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
6848
|
-
add/
|
|
6845
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
6846
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
6847
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
6849
6848
|
`module@^7`.
|
|
6850
6849
|
|
|
6851
6850
|
---
|
|
@@ -6952,18 +6951,6 @@ The command to execute.
|
|
|
6952
6951
|
|
|
6953
6952
|
---
|
|
6954
6953
|
|
|
6955
|
-
##### `register` <a name="register" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.register"></a>
|
|
6956
|
-
|
|
6957
|
-
```typescript
|
|
6958
|
-
public register(project: TypeScriptWorkspace): void
|
|
6959
|
-
```
|
|
6960
|
-
|
|
6961
|
-
###### `project`<sup>Required</sup> <a name="project" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.register.parameter.project"></a>
|
|
6962
|
-
|
|
6963
|
-
- *Type:* cdklabs-projen-project-types.yarn.TypeScriptWorkspace
|
|
6964
|
-
|
|
6965
|
-
---
|
|
6966
|
-
|
|
6967
6954
|
##### `requestInstallDependencies` <a name="requestInstallDependencies" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.requestInstallDependencies"></a>
|
|
6968
6955
|
|
|
6969
6956
|
```typescript
|
|
@@ -7094,7 +7081,7 @@ yarn.CdkLabsMonorepo.isMonorepo(x: Project)
|
|
|
7094
7081
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
|
|
7095
7082
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.projenCommand">projenCommand</a></code> | <code>string</code> | The command to use in order to run the projen CLI. |
|
|
7096
7083
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
|
|
7097
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.subprojects">subprojects</a></code> | <code>projen.
|
|
7084
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.subprojects">subprojects</a></code> | <code>cdklabs-projen-project-types.yarn.TypeScriptWorkspace[]</code> | Returns all the subprojects within this project. |
|
|
7098
7085
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
|
|
7099
7086
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
7100
7087
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
@@ -7365,10 +7352,10 @@ The root project.
|
|
|
7365
7352
|
##### `subprojects`<sup>Required</sup> <a name="subprojects" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.subprojects"></a>
|
|
7366
7353
|
|
|
7367
7354
|
```typescript
|
|
7368
|
-
public readonly subprojects:
|
|
7355
|
+
public readonly subprojects: TypeScriptWorkspace[];
|
|
7369
7356
|
```
|
|
7370
7357
|
|
|
7371
|
-
- *Type:* projen.
|
|
7358
|
+
- *Type:* cdklabs-projen-project-types.yarn.TypeScriptWorkspace[]
|
|
7372
7359
|
|
|
7373
7360
|
Returns all the subprojects within this project.
|
|
7374
7361
|
|
|
@@ -8222,7 +8209,7 @@ public runTaskCommand(task: Task): string
|
|
|
8222
8209
|
Returns the shell command to execute in order to run a task.
|
|
8223
8210
|
|
|
8224
8211
|
This will
|
|
8225
|
-
typically be `
|
|
8212
|
+
typically be `pnpm projen TASK`.
|
|
8226
8213
|
|
|
8227
8214
|
###### `task`<sup>Required</sup> <a name="task" id="cdklabs-projen-project-types.CdklabsTypeScriptProject.runTaskCommand.parameter.task"></a>
|
|
8228
8215
|
|
|
@@ -8347,9 +8334,9 @@ Bundled dependencies will be added as normal dependencies as well as to the
|
|
|
8347
8334
|
Names modules to install.
|
|
8348
8335
|
|
|
8349
8336
|
By default, the the dependency will
|
|
8350
|
-
be installed in the next `
|
|
8351
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
8352
|
-
add/
|
|
8337
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
8338
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
8339
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
8353
8340
|
`module@^7`.
|
|
8354
8341
|
|
|
8355
8342
|
---
|
|
@@ -8383,9 +8370,9 @@ Defines normal dependencies.
|
|
|
8383
8370
|
Names modules to install.
|
|
8384
8371
|
|
|
8385
8372
|
By default, the the dependency will
|
|
8386
|
-
be installed in the next `
|
|
8387
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
8388
|
-
add/
|
|
8373
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
8374
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
8375
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
8389
8376
|
`module@^7`.
|
|
8390
8377
|
|
|
8391
8378
|
---
|
|
@@ -8405,9 +8392,9 @@ Defines development/test dependencies.
|
|
|
8405
8392
|
Names modules to install.
|
|
8406
8393
|
|
|
8407
8394
|
By default, the the dependency will
|
|
8408
|
-
be installed in the next `
|
|
8409
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
8410
|
-
add/
|
|
8395
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
8396
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
8397
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
8411
8398
|
`module@^7`.
|
|
8412
8399
|
|
|
8413
8400
|
---
|
|
@@ -8463,9 +8450,9 @@ your code against the minimum version required from your consumers.
|
|
|
8463
8450
|
Names modules to install.
|
|
8464
8451
|
|
|
8465
8452
|
By default, the the dependency will
|
|
8466
|
-
be installed in the next `
|
|
8467
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
8468
|
-
add/
|
|
8453
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
8454
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
8455
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
8469
8456
|
`module@^7`.
|
|
8470
8457
|
|
|
8471
8458
|
---
|
|
@@ -9773,7 +9760,7 @@ public runTaskCommand(task: Task): string
|
|
|
9773
9760
|
Returns the shell command to execute in order to run a task.
|
|
9774
9761
|
|
|
9775
9762
|
This will
|
|
9776
|
-
typically be `
|
|
9763
|
+
typically be `pnpm projen TASK`.
|
|
9777
9764
|
|
|
9778
9765
|
###### `task`<sup>Required</sup> <a name="task" id="cdklabs-projen-project-types.CdkTypeScriptProject.runTaskCommand.parameter.task"></a>
|
|
9779
9766
|
|
|
@@ -9898,9 +9885,9 @@ Bundled dependencies will be added as normal dependencies as well as to the
|
|
|
9898
9885
|
Names modules to install.
|
|
9899
9886
|
|
|
9900
9887
|
By default, the the dependency will
|
|
9901
|
-
be installed in the next `
|
|
9902
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
9903
|
-
add/
|
|
9888
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
9889
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
9890
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
9904
9891
|
`module@^7`.
|
|
9905
9892
|
|
|
9906
9893
|
---
|
|
@@ -9934,9 +9921,9 @@ Defines normal dependencies.
|
|
|
9934
9921
|
Names modules to install.
|
|
9935
9922
|
|
|
9936
9923
|
By default, the the dependency will
|
|
9937
|
-
be installed in the next `
|
|
9938
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
9939
|
-
add/
|
|
9924
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
9925
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
9926
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
9940
9927
|
`module@^7`.
|
|
9941
9928
|
|
|
9942
9929
|
---
|
|
@@ -9956,9 +9943,9 @@ Defines development/test dependencies.
|
|
|
9956
9943
|
Names modules to install.
|
|
9957
9944
|
|
|
9958
9945
|
By default, the the dependency will
|
|
9959
|
-
be installed in the next `
|
|
9960
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
9961
|
-
add/
|
|
9946
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
9947
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
9948
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
9962
9949
|
`module@^7`.
|
|
9963
9950
|
|
|
9964
9951
|
---
|
|
@@ -10014,9 +10001,9 @@ your code against the minimum version required from your consumers.
|
|
|
10014
10001
|
Names modules to install.
|
|
10015
10002
|
|
|
10016
10003
|
By default, the the dependency will
|
|
10017
|
-
be installed in the next `
|
|
10018
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
10019
|
-
add/
|
|
10004
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
10005
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
10006
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
10020
10007
|
`module@^7`.
|
|
10021
10008
|
|
|
10022
10009
|
---
|
|
@@ -11074,6 +11061,191 @@ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
|
|
|
11074
11061
|
|
|
11075
11062
|
---
|
|
11076
11063
|
|
|
11064
|
+
### Constraints <a name="Constraints" id="cdklabs-projen-project-types.yarn.Constraints"></a>
|
|
11065
|
+
|
|
11066
|
+
#### Initializers <a name="Initializers" id="cdklabs-projen-project-types.yarn.Constraints.Initializer"></a>
|
|
11067
|
+
|
|
11068
|
+
```typescript
|
|
11069
|
+
import { yarn } from 'cdklabs-projen-project-types'
|
|
11070
|
+
|
|
11071
|
+
new yarn.Constraints(project: Monorepo, options: ConstraintsOptions)
|
|
11072
|
+
```
|
|
11073
|
+
|
|
11074
|
+
| **Name** | **Type** | **Description** |
|
|
11075
|
+
| --- | --- | --- |
|
|
11076
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Constraints.Initializer.parameter.project">project</a></code> | <code>cdklabs-projen-project-types.yarn.Monorepo</code> | *No description.* |
|
|
11077
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Constraints.Initializer.parameter.options">options</a></code> | <code>cdklabs-projen-project-types.yarn.ConstraintsOptions</code> | *No description.* |
|
|
11078
|
+
|
|
11079
|
+
---
|
|
11080
|
+
|
|
11081
|
+
##### `project`<sup>Required</sup> <a name="project" id="cdklabs-projen-project-types.yarn.Constraints.Initializer.parameter.project"></a>
|
|
11082
|
+
|
|
11083
|
+
- *Type:* cdklabs-projen-project-types.yarn.Monorepo
|
|
11084
|
+
|
|
11085
|
+
---
|
|
11086
|
+
|
|
11087
|
+
##### `options`<sup>Required</sup> <a name="options" id="cdklabs-projen-project-types.yarn.Constraints.Initializer.parameter.options"></a>
|
|
11088
|
+
|
|
11089
|
+
- *Type:* cdklabs-projen-project-types.yarn.ConstraintsOptions
|
|
11090
|
+
|
|
11091
|
+
---
|
|
11092
|
+
|
|
11093
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
11094
|
+
|
|
11095
|
+
| **Name** | **Description** |
|
|
11096
|
+
| --- | --- |
|
|
11097
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Constraints.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
11098
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Constraints.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
11099
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Constraints.postSynthesize">postSynthesize</a></code> | Called after synthesis. |
|
|
11100
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Constraints.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
|
|
11101
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Constraints.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
|
|
11102
|
+
|
|
11103
|
+
---
|
|
11104
|
+
|
|
11105
|
+
##### `toString` <a name="toString" id="cdklabs-projen-project-types.yarn.Constraints.toString"></a>
|
|
11106
|
+
|
|
11107
|
+
```typescript
|
|
11108
|
+
public toString(): string
|
|
11109
|
+
```
|
|
11110
|
+
|
|
11111
|
+
Returns a string representation of this construct.
|
|
11112
|
+
|
|
11113
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.yarn.Constraints.with"></a>
|
|
11114
|
+
|
|
11115
|
+
```typescript
|
|
11116
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
11117
|
+
```
|
|
11118
|
+
|
|
11119
|
+
Applies one or more mixins to this construct.
|
|
11120
|
+
|
|
11121
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
11122
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
11123
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
11124
|
+
constructs.
|
|
11125
|
+
|
|
11126
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.yarn.Constraints.with.parameter.mixins"></a>
|
|
11127
|
+
|
|
11128
|
+
- *Type:* ...constructs.IMixin[]
|
|
11129
|
+
|
|
11130
|
+
The mixins to apply.
|
|
11131
|
+
|
|
11132
|
+
---
|
|
11133
|
+
|
|
11134
|
+
##### `postSynthesize` <a name="postSynthesize" id="cdklabs-projen-project-types.yarn.Constraints.postSynthesize"></a>
|
|
11135
|
+
|
|
11136
|
+
```typescript
|
|
11137
|
+
public postSynthesize(): void
|
|
11138
|
+
```
|
|
11139
|
+
|
|
11140
|
+
Called after synthesis.
|
|
11141
|
+
|
|
11142
|
+
Order is *not* guaranteed.
|
|
11143
|
+
|
|
11144
|
+
##### `preSynthesize` <a name="preSynthesize" id="cdklabs-projen-project-types.yarn.Constraints.preSynthesize"></a>
|
|
11145
|
+
|
|
11146
|
+
```typescript
|
|
11147
|
+
public preSynthesize(): void
|
|
11148
|
+
```
|
|
11149
|
+
|
|
11150
|
+
Called before synthesis.
|
|
11151
|
+
|
|
11152
|
+
##### `synthesize` <a name="synthesize" id="cdklabs-projen-project-types.yarn.Constraints.synthesize"></a>
|
|
11153
|
+
|
|
11154
|
+
```typescript
|
|
11155
|
+
public synthesize(): void
|
|
11156
|
+
```
|
|
11157
|
+
|
|
11158
|
+
Synthesizes files to the project output directory.
|
|
11159
|
+
|
|
11160
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
11161
|
+
|
|
11162
|
+
| **Name** | **Description** |
|
|
11163
|
+
| --- | --- |
|
|
11164
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Constraints.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
11165
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Constraints.isComponent">isComponent</a></code> | Test whether the given construct is a component. |
|
|
11166
|
+
|
|
11167
|
+
---
|
|
11168
|
+
|
|
11169
|
+
##### `isConstruct` <a name="isConstruct" id="cdklabs-projen-project-types.yarn.Constraints.isConstruct"></a>
|
|
11170
|
+
|
|
11171
|
+
```typescript
|
|
11172
|
+
import { yarn } from 'cdklabs-projen-project-types'
|
|
11173
|
+
|
|
11174
|
+
yarn.Constraints.isConstruct(x: any)
|
|
11175
|
+
```
|
|
11176
|
+
|
|
11177
|
+
Checks if `x` is a construct.
|
|
11178
|
+
|
|
11179
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
11180
|
+
instances, even when the construct library is symlinked.
|
|
11181
|
+
|
|
11182
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
11183
|
+
disk are seen as independent, completely different libraries. As a
|
|
11184
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
11185
|
+
is seen as a different class, and an instance of one class will not test as
|
|
11186
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
11187
|
+
like this, but users may manually symlink construct libraries together or
|
|
11188
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
11189
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
11190
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
11191
|
+
this type-testing method instead.
|
|
11192
|
+
|
|
11193
|
+
###### `x`<sup>Required</sup> <a name="x" id="cdklabs-projen-project-types.yarn.Constraints.isConstruct.parameter.x"></a>
|
|
11194
|
+
|
|
11195
|
+
- *Type:* any
|
|
11196
|
+
|
|
11197
|
+
Any object.
|
|
11198
|
+
|
|
11199
|
+
---
|
|
11200
|
+
|
|
11201
|
+
##### `isComponent` <a name="isComponent" id="cdklabs-projen-project-types.yarn.Constraints.isComponent"></a>
|
|
11202
|
+
|
|
11203
|
+
```typescript
|
|
11204
|
+
import { yarn } from 'cdklabs-projen-project-types'
|
|
11205
|
+
|
|
11206
|
+
yarn.Constraints.isComponent(x: any)
|
|
11207
|
+
```
|
|
11208
|
+
|
|
11209
|
+
Test whether the given construct is a component.
|
|
11210
|
+
|
|
11211
|
+
###### `x`<sup>Required</sup> <a name="x" id="cdklabs-projen-project-types.yarn.Constraints.isComponent.parameter.x"></a>
|
|
11212
|
+
|
|
11213
|
+
- *Type:* any
|
|
11214
|
+
|
|
11215
|
+
---
|
|
11216
|
+
|
|
11217
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
11218
|
+
|
|
11219
|
+
| **Name** | **Type** | **Description** |
|
|
11220
|
+
| --- | --- | --- |
|
|
11221
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Constraints.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
11222
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Constraints.property.project">project</a></code> | <code>cdklabs-projen-project-types.yarn.Monorepo</code> | *No description.* |
|
|
11223
|
+
|
|
11224
|
+
---
|
|
11225
|
+
|
|
11226
|
+
##### `node`<sup>Required</sup> <a name="node" id="cdklabs-projen-project-types.yarn.Constraints.property.node"></a>
|
|
11227
|
+
|
|
11228
|
+
```typescript
|
|
11229
|
+
public readonly node: Node;
|
|
11230
|
+
```
|
|
11231
|
+
|
|
11232
|
+
- *Type:* constructs.Node
|
|
11233
|
+
|
|
11234
|
+
The tree node.
|
|
11235
|
+
|
|
11236
|
+
---
|
|
11237
|
+
|
|
11238
|
+
##### `project`<sup>Required</sup> <a name="project" id="cdklabs-projen-project-types.yarn.Constraints.property.project"></a>
|
|
11239
|
+
|
|
11240
|
+
```typescript
|
|
11241
|
+
public readonly project: Monorepo;
|
|
11242
|
+
```
|
|
11243
|
+
|
|
11244
|
+
- *Type:* cdklabs-projen-project-types.yarn.Monorepo
|
|
11245
|
+
|
|
11246
|
+
---
|
|
11247
|
+
|
|
11248
|
+
|
|
11077
11249
|
### Monorepo <a name="Monorepo" id="cdklabs-projen-project-types.yarn.Monorepo"></a>
|
|
11078
11250
|
|
|
11079
11251
|
A monorepo using yarn workspaces.
|
|
@@ -11133,7 +11305,6 @@ new yarn.Monorepo(options: MonorepoOptions)
|
|
|
11133
11305
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
|
11134
11306
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
|
|
11135
11307
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
|
|
11136
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.register">register</a></code> | *No description.* |
|
|
11137
11308
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.requestInstallDependencies">requestInstallDependencies</a></code> | Allows a sub project to request installation of dependency at the Monorepo root They must provide a function that is executed after dependencies have been installed If this function returns true, the install command is run for a second time after all sub project requests have run. |
|
|
11138
11309
|
|
|
11139
11310
|
---
|
|
@@ -11324,7 +11495,7 @@ public runTaskCommand(task: Task): string
|
|
|
11324
11495
|
Returns the shell command to execute in order to run a task.
|
|
11325
11496
|
|
|
11326
11497
|
This will
|
|
11327
|
-
typically be `
|
|
11498
|
+
typically be `pnpm projen TASK`.
|
|
11328
11499
|
|
|
11329
11500
|
###### `task`<sup>Required</sup> <a name="task" id="cdklabs-projen-project-types.yarn.Monorepo.runTaskCommand.parameter.task"></a>
|
|
11330
11501
|
|
|
@@ -11449,9 +11620,9 @@ Bundled dependencies will be added as normal dependencies as well as to the
|
|
|
11449
11620
|
Names modules to install.
|
|
11450
11621
|
|
|
11451
11622
|
By default, the the dependency will
|
|
11452
|
-
be installed in the next `
|
|
11453
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
11454
|
-
add/
|
|
11623
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
11624
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
11625
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
11455
11626
|
`module@^7`.
|
|
11456
11627
|
|
|
11457
11628
|
---
|
|
@@ -11485,9 +11656,9 @@ Defines normal dependencies.
|
|
|
11485
11656
|
Names modules to install.
|
|
11486
11657
|
|
|
11487
11658
|
By default, the the dependency will
|
|
11488
|
-
be installed in the next `
|
|
11489
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
11490
|
-
add/
|
|
11659
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
11660
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
11661
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
11491
11662
|
`module@^7`.
|
|
11492
11663
|
|
|
11493
11664
|
---
|
|
@@ -11507,9 +11678,9 @@ Defines development/test dependencies.
|
|
|
11507
11678
|
Names modules to install.
|
|
11508
11679
|
|
|
11509
11680
|
By default, the the dependency will
|
|
11510
|
-
be installed in the next `
|
|
11511
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
11512
|
-
add/
|
|
11681
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
11682
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
11683
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
11513
11684
|
`module@^7`.
|
|
11514
11685
|
|
|
11515
11686
|
---
|
|
@@ -11565,9 +11736,9 @@ your code against the minimum version required from your consumers.
|
|
|
11565
11736
|
Names modules to install.
|
|
11566
11737
|
|
|
11567
11738
|
By default, the the dependency will
|
|
11568
|
-
be installed in the next `
|
|
11569
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
11570
|
-
add/
|
|
11739
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
11740
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
11741
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
11571
11742
|
`module@^7`.
|
|
11572
11743
|
|
|
11573
11744
|
---
|
|
@@ -11674,18 +11845,6 @@ The command to execute.
|
|
|
11674
11845
|
|
|
11675
11846
|
---
|
|
11676
11847
|
|
|
11677
|
-
##### `register` <a name="register" id="cdklabs-projen-project-types.yarn.Monorepo.register"></a>
|
|
11678
|
-
|
|
11679
|
-
```typescript
|
|
11680
|
-
public register(project: TypeScriptWorkspace): void
|
|
11681
|
-
```
|
|
11682
|
-
|
|
11683
|
-
###### `project`<sup>Required</sup> <a name="project" id="cdklabs-projen-project-types.yarn.Monorepo.register.parameter.project"></a>
|
|
11684
|
-
|
|
11685
|
-
- *Type:* cdklabs-projen-project-types.yarn.TypeScriptWorkspace
|
|
11686
|
-
|
|
11687
|
-
---
|
|
11688
|
-
|
|
11689
11848
|
##### `requestInstallDependencies` <a name="requestInstallDependencies" id="cdklabs-projen-project-types.yarn.Monorepo.requestInstallDependencies"></a>
|
|
11690
11849
|
|
|
11691
11850
|
```typescript
|
|
@@ -11816,7 +11975,7 @@ yarn.Monorepo.isMonorepo(x: Project)
|
|
|
11816
11975
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
|
|
11817
11976
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.projenCommand">projenCommand</a></code> | <code>string</code> | The command to use in order to run the projen CLI. |
|
|
11818
11977
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
|
|
11819
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.subprojects">subprojects</a></code> | <code>projen.
|
|
11978
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.subprojects">subprojects</a></code> | <code>cdklabs-projen-project-types.yarn.TypeScriptWorkspace[]</code> | Returns all the subprojects within this project. |
|
|
11820
11979
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
|
|
11821
11980
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
11822
11981
|
| <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
@@ -12087,10 +12246,10 @@ The root project.
|
|
|
12087
12246
|
##### `subprojects`<sup>Required</sup> <a name="subprojects" id="cdklabs-projen-project-types.yarn.Monorepo.property.subprojects"></a>
|
|
12088
12247
|
|
|
12089
12248
|
```typescript
|
|
12090
|
-
public readonly subprojects:
|
|
12249
|
+
public readonly subprojects: TypeScriptWorkspace[];
|
|
12091
12250
|
```
|
|
12092
12251
|
|
|
12093
|
-
- *Type:* projen.
|
|
12252
|
+
- *Type:* cdklabs-projen-project-types.yarn.TypeScriptWorkspace[]
|
|
12094
12253
|
|
|
12095
12254
|
Returns all the subprojects within this project.
|
|
12096
12255
|
|
|
@@ -13373,7 +13532,7 @@ public runTaskCommand(task: Task): string
|
|
|
13373
13532
|
Returns the shell command to execute in order to run a task.
|
|
13374
13533
|
|
|
13375
13534
|
This will
|
|
13376
|
-
typically be `
|
|
13535
|
+
typically be `pnpm projen TASK`.
|
|
13377
13536
|
|
|
13378
13537
|
###### `task`<sup>Required</sup> <a name="task" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspace.runTaskCommand.parameter.task"></a>
|
|
13379
13538
|
|
|
@@ -13498,9 +13657,9 @@ Bundled dependencies will be added as normal dependencies as well as to the
|
|
|
13498
13657
|
Names modules to install.
|
|
13499
13658
|
|
|
13500
13659
|
By default, the the dependency will
|
|
13501
|
-
be installed in the next `
|
|
13502
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
13503
|
-
add/
|
|
13660
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
13661
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
13662
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
13504
13663
|
`module@^7`.
|
|
13505
13664
|
|
|
13506
13665
|
---
|
|
@@ -13534,9 +13693,9 @@ Defines normal dependencies.
|
|
|
13534
13693
|
Names modules to install.
|
|
13535
13694
|
|
|
13536
13695
|
By default, the the dependency will
|
|
13537
|
-
be installed in the next `
|
|
13538
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
13539
|
-
add/
|
|
13696
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
13697
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
13698
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
13540
13699
|
`module@^7`.
|
|
13541
13700
|
|
|
13542
13701
|
---
|
|
@@ -13556,9 +13715,9 @@ Defines development/test dependencies.
|
|
|
13556
13715
|
Names modules to install.
|
|
13557
13716
|
|
|
13558
13717
|
By default, the the dependency will
|
|
13559
|
-
be installed in the next `
|
|
13560
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
13561
|
-
add/
|
|
13718
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
13719
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
13720
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
13562
13721
|
`module@^7`.
|
|
13563
13722
|
|
|
13564
13723
|
---
|
|
@@ -13614,9 +13773,9 @@ your code against the minimum version required from your consumers.
|
|
|
13614
13773
|
Names modules to install.
|
|
13615
13774
|
|
|
13616
13775
|
By default, the the dependency will
|
|
13617
|
-
be installed in the next `
|
|
13618
|
-
in your `package.json` file. You can upgrade manually or using `
|
|
13619
|
-
add/
|
|
13776
|
+
be installed in the next `pnpm projen` run and the version will be recorded
|
|
13777
|
+
in your `package.json` file. You can upgrade manually or using `pnpm
|
|
13778
|
+
add/update`. If you wish to specify a version range use this syntax:
|
|
13620
13779
|
`module@^7`.
|
|
13621
13780
|
|
|
13622
13781
|
---
|
|
@@ -15697,11 +15856,11 @@ added both to the `dependencies` section and `bundledDependencies` section of
|
|
|
15697
15856
|
your `package.json`.
|
|
15698
15857
|
|
|
15699
15858
|
The recommendation is to only specify the module name here (e.g.
|
|
15700
|
-
`express`). This will behave similar to `
|
|
15859
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
15701
15860
|
sense that it will add the module as a dependency to your `package.json`
|
|
15702
15861
|
file with the latest version (`^`). You can specify semver requirements in
|
|
15703
|
-
the same syntax passed to `
|
|
15704
|
-
this will be what
|
|
15862
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
15863
|
+
this will be what your `package.json` will eventually include.
|
|
15705
15864
|
|
|
15706
15865
|
---
|
|
15707
15866
|
|
|
@@ -16089,11 +16248,11 @@ public readonly deps: string[];
|
|
|
16089
16248
|
Runtime dependencies of this module.
|
|
16090
16249
|
|
|
16091
16250
|
The recommendation is to only specify the module name here (e.g.
|
|
16092
|
-
`express`). This will behave similar to `
|
|
16251
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
16093
16252
|
sense that it will add the module as a dependency to your `package.json`
|
|
16094
16253
|
file with the latest version (`^`). You can specify semver requirements in
|
|
16095
|
-
the same syntax passed to `
|
|
16096
|
-
this will be what
|
|
16254
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
16255
|
+
this will be what your `package.json` will eventually include.
|
|
16097
16256
|
|
|
16098
16257
|
---
|
|
16099
16258
|
|
|
@@ -16169,11 +16328,11 @@ available in your build environment but will not be fetched when this
|
|
|
16169
16328
|
module is consumed.
|
|
16170
16329
|
|
|
16171
16330
|
The recommendation is to only specify the module name here (e.g.
|
|
16172
|
-
`express`). This will behave similar to `
|
|
16331
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
16173
16332
|
sense that it will add the module as a dependency to your `package.json`
|
|
16174
16333
|
file with the latest version (`^`). You can specify semver requirements in
|
|
16175
|
-
the same syntax passed to `
|
|
16176
|
-
this will be what
|
|
16334
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
16335
|
+
this will be what your `package.json` will eventually include.
|
|
16177
16336
|
|
|
16178
16337
|
---
|
|
16179
16338
|
|
|
@@ -17068,7 +17227,7 @@ public readonly pnpmVersion: string;
|
|
|
17068
17227
|
```
|
|
17069
17228
|
|
|
17070
17229
|
- *Type:* string
|
|
17071
|
-
- *Default:* "
|
|
17230
|
+
- *Default:* "10.33.0"
|
|
17072
17231
|
|
|
17073
17232
|
The version of PNPM to use if using PNPM as a package manager.
|
|
17074
17233
|
|
|
@@ -18722,11 +18881,11 @@ added both to the `dependencies` section and `bundledDependencies` section of
|
|
|
18722
18881
|
your `package.json`.
|
|
18723
18882
|
|
|
18724
18883
|
The recommendation is to only specify the module name here (e.g.
|
|
18725
|
-
`express`). This will behave similar to `
|
|
18884
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
18726
18885
|
sense that it will add the module as a dependency to your `package.json`
|
|
18727
18886
|
file with the latest version (`^`). You can specify semver requirements in
|
|
18728
|
-
the same syntax passed to `
|
|
18729
|
-
this will be what
|
|
18887
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
18888
|
+
this will be what your `package.json` will eventually include.
|
|
18730
18889
|
|
|
18731
18890
|
---
|
|
18732
18891
|
|
|
@@ -18963,11 +19122,11 @@ public readonly deps: string[];
|
|
|
18963
19122
|
Runtime dependencies of this module.
|
|
18964
19123
|
|
|
18965
19124
|
The recommendation is to only specify the module name here (e.g.
|
|
18966
|
-
`express`). This will behave similar to `
|
|
19125
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
18967
19126
|
sense that it will add the module as a dependency to your `package.json`
|
|
18968
19127
|
file with the latest version (`^`). You can specify semver requirements in
|
|
18969
|
-
the same syntax passed to `
|
|
18970
|
-
this will be what
|
|
19128
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
19129
|
+
this will be what your `package.json` will eventually include.
|
|
18971
19130
|
|
|
18972
19131
|
---
|
|
18973
19132
|
|
|
@@ -19043,11 +19202,11 @@ available in your build environment but will not be fetched when this
|
|
|
19043
19202
|
module is consumed.
|
|
19044
19203
|
|
|
19045
19204
|
The recommendation is to only specify the module name here (e.g.
|
|
19046
|
-
`express`). This will behave similar to `
|
|
19205
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
19047
19206
|
sense that it will add the module as a dependency to your `package.json`
|
|
19048
19207
|
file with the latest version (`^`). You can specify semver requirements in
|
|
19049
|
-
the same syntax passed to `
|
|
19050
|
-
this will be what
|
|
19208
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
19209
|
+
this will be what your `package.json` will eventually include.
|
|
19051
19210
|
|
|
19052
19211
|
---
|
|
19053
19212
|
|
|
@@ -19872,7 +20031,7 @@ public readonly pnpmVersion: string;
|
|
|
19872
20031
|
```
|
|
19873
20032
|
|
|
19874
20033
|
- *Type:* string
|
|
19875
|
-
- *Default:* "
|
|
20034
|
+
- *Default:* "10.33.0"
|
|
19876
20035
|
|
|
19877
20036
|
The version of PNPM to use if using PNPM as a package manager.
|
|
19878
20037
|
|
|
@@ -21534,11 +21693,11 @@ added both to the `dependencies` section and `bundledDependencies` section of
|
|
|
21534
21693
|
your `package.json`.
|
|
21535
21694
|
|
|
21536
21695
|
The recommendation is to only specify the module name here (e.g.
|
|
21537
|
-
`express`). This will behave similar to `
|
|
21696
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
21538
21697
|
sense that it will add the module as a dependency to your `package.json`
|
|
21539
21698
|
file with the latest version (`^`). You can specify semver requirements in
|
|
21540
|
-
the same syntax passed to `
|
|
21541
|
-
this will be what
|
|
21699
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
21700
|
+
this will be what your `package.json` will eventually include.
|
|
21542
21701
|
|
|
21543
21702
|
---
|
|
21544
21703
|
|
|
@@ -21926,11 +22085,11 @@ public readonly deps: string[];
|
|
|
21926
22085
|
Runtime dependencies of this module.
|
|
21927
22086
|
|
|
21928
22087
|
The recommendation is to only specify the module name here (e.g.
|
|
21929
|
-
`express`). This will behave similar to `
|
|
22088
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
21930
22089
|
sense that it will add the module as a dependency to your `package.json`
|
|
21931
22090
|
file with the latest version (`^`). You can specify semver requirements in
|
|
21932
|
-
the same syntax passed to `
|
|
21933
|
-
this will be what
|
|
22091
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
22092
|
+
this will be what your `package.json` will eventually include.
|
|
21934
22093
|
|
|
21935
22094
|
---
|
|
21936
22095
|
|
|
@@ -22006,11 +22165,11 @@ available in your build environment but will not be fetched when this
|
|
|
22006
22165
|
module is consumed.
|
|
22007
22166
|
|
|
22008
22167
|
The recommendation is to only specify the module name here (e.g.
|
|
22009
|
-
`express`). This will behave similar to `
|
|
22168
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
22010
22169
|
sense that it will add the module as a dependency to your `package.json`
|
|
22011
22170
|
file with the latest version (`^`). You can specify semver requirements in
|
|
22012
|
-
the same syntax passed to `
|
|
22013
|
-
this will be what
|
|
22171
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
22172
|
+
this will be what your `package.json` will eventually include.
|
|
22014
22173
|
|
|
22015
22174
|
---
|
|
22016
22175
|
|
|
@@ -22905,7 +23064,7 @@ public readonly pnpmVersion: string;
|
|
|
22905
23064
|
```
|
|
22906
23065
|
|
|
22907
23066
|
- *Type:* string
|
|
22908
|
-
- *Default:* "
|
|
23067
|
+
- *Default:* "10.33.0"
|
|
22909
23068
|
|
|
22910
23069
|
The version of PNPM to use if using PNPM as a package manager.
|
|
22911
23070
|
|
|
@@ -24598,11 +24757,11 @@ added both to the `dependencies` section and `bundledDependencies` section of
|
|
|
24598
24757
|
your `package.json`.
|
|
24599
24758
|
|
|
24600
24759
|
The recommendation is to only specify the module name here (e.g.
|
|
24601
|
-
`express`). This will behave similar to `
|
|
24760
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
24602
24761
|
sense that it will add the module as a dependency to your `package.json`
|
|
24603
24762
|
file with the latest version (`^`). You can specify semver requirements in
|
|
24604
|
-
the same syntax passed to `
|
|
24605
|
-
this will be what
|
|
24763
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
24764
|
+
this will be what your `package.json` will eventually include.
|
|
24606
24765
|
|
|
24607
24766
|
---
|
|
24608
24767
|
|
|
@@ -24839,11 +24998,11 @@ public readonly deps: string[];
|
|
|
24839
24998
|
Runtime dependencies of this module.
|
|
24840
24999
|
|
|
24841
25000
|
The recommendation is to only specify the module name here (e.g.
|
|
24842
|
-
`express`). This will behave similar to `
|
|
25001
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
24843
25002
|
sense that it will add the module as a dependency to your `package.json`
|
|
24844
25003
|
file with the latest version (`^`). You can specify semver requirements in
|
|
24845
|
-
the same syntax passed to `
|
|
24846
|
-
this will be what
|
|
25004
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
25005
|
+
this will be what your `package.json` will eventually include.
|
|
24847
25006
|
|
|
24848
25007
|
---
|
|
24849
25008
|
|
|
@@ -24919,11 +25078,11 @@ available in your build environment but will not be fetched when this
|
|
|
24919
25078
|
module is consumed.
|
|
24920
25079
|
|
|
24921
25080
|
The recommendation is to only specify the module name here (e.g.
|
|
24922
|
-
`express`). This will behave similar to `
|
|
25081
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
24923
25082
|
sense that it will add the module as a dependency to your `package.json`
|
|
24924
25083
|
file with the latest version (`^`). You can specify semver requirements in
|
|
24925
|
-
the same syntax passed to `
|
|
24926
|
-
this will be what
|
|
25084
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
25085
|
+
this will be what your `package.json` will eventually include.
|
|
24927
25086
|
|
|
24928
25087
|
---
|
|
24929
25088
|
|
|
@@ -25748,7 +25907,7 @@ public readonly pnpmVersion: string;
|
|
|
25748
25907
|
```
|
|
25749
25908
|
|
|
25750
25909
|
- *Type:* string
|
|
25751
|
-
- *Default:* "
|
|
25910
|
+
- *Default:* "10.33.0"
|
|
25752
25911
|
|
|
25753
25912
|
The version of PNPM to use if using PNPM as a package manager.
|
|
25754
25913
|
|
|
@@ -26888,6 +27047,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
26888
27047
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.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`. |
|
|
26889
27048
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
26890
27049
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
27050
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.consistentVersions">consistentVersions</a></code> | <code>string[]</code> | Package names that must use a consistent version across all workspaces. |
|
|
26891
27051
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
26892
27052
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
26893
27053
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
|
|
@@ -27401,11 +27561,11 @@ added both to the `dependencies` section and `bundledDependencies` section of
|
|
|
27401
27561
|
your `package.json`.
|
|
27402
27562
|
|
|
27403
27563
|
The recommendation is to only specify the module name here (e.g.
|
|
27404
|
-
`express`). This will behave similar to `
|
|
27564
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
27405
27565
|
sense that it will add the module as a dependency to your `package.json`
|
|
27406
27566
|
file with the latest version (`^`). You can specify semver requirements in
|
|
27407
|
-
the same syntax passed to `
|
|
27408
|
-
this will be what
|
|
27567
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
27568
|
+
this will be what your `package.json` will eventually include.
|
|
27409
27569
|
|
|
27410
27570
|
---
|
|
27411
27571
|
|
|
@@ -27516,6 +27676,22 @@ Whether to commit the managed files by default.
|
|
|
27516
27676
|
|
|
27517
27677
|
---
|
|
27518
27678
|
|
|
27679
|
+
##### `consistentVersions`<sup>Optional</sup> <a name="consistentVersions" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.consistentVersions"></a>
|
|
27680
|
+
|
|
27681
|
+
```typescript
|
|
27682
|
+
public readonly consistentVersions: string[];
|
|
27683
|
+
```
|
|
27684
|
+
|
|
27685
|
+
- *Type:* string[]
|
|
27686
|
+
|
|
27687
|
+
Package names that must use a consistent version across all workspaces.
|
|
27688
|
+
|
|
27689
|
+
Uses Yarn Berry constraints to enforce that all workspaces use the same version
|
|
27690
|
+
of the listed packages. The version is read from the root `devDependencies`.
|
|
27691
|
+
Only has an effect when the monorepo uses Yarn Berry.
|
|
27692
|
+
|
|
27693
|
+
---
|
|
27694
|
+
|
|
27519
27695
|
##### `copyrightOwner`<sup>Optional</sup> <a name="copyrightOwner" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.copyrightOwner"></a>
|
|
27520
27696
|
|
|
27521
27697
|
```typescript
|
|
@@ -27600,11 +27776,11 @@ public readonly deps: string[];
|
|
|
27600
27776
|
Runtime dependencies of this module.
|
|
27601
27777
|
|
|
27602
27778
|
The recommendation is to only specify the module name here (e.g.
|
|
27603
|
-
`express`). This will behave similar to `
|
|
27779
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
27604
27780
|
sense that it will add the module as a dependency to your `package.json`
|
|
27605
27781
|
file with the latest version (`^`). You can specify semver requirements in
|
|
27606
|
-
the same syntax passed to `
|
|
27607
|
-
this will be what
|
|
27782
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
27783
|
+
this will be what your `package.json` will eventually include.
|
|
27608
27784
|
|
|
27609
27785
|
---
|
|
27610
27786
|
|
|
@@ -27680,11 +27856,11 @@ available in your build environment but will not be fetched when this
|
|
|
27680
27856
|
module is consumed.
|
|
27681
27857
|
|
|
27682
27858
|
The recommendation is to only specify the module name here (e.g.
|
|
27683
|
-
`express`). This will behave similar to `
|
|
27859
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
27684
27860
|
sense that it will add the module as a dependency to your `package.json`
|
|
27685
27861
|
file with the latest version (`^`). You can specify semver requirements in
|
|
27686
|
-
the same syntax passed to `
|
|
27687
|
-
this will be what
|
|
27862
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
27863
|
+
this will be what your `package.json` will eventually include.
|
|
27688
27864
|
|
|
27689
27865
|
---
|
|
27690
27866
|
|
|
@@ -28371,7 +28547,7 @@ public readonly pnpmVersion: string;
|
|
|
28371
28547
|
```
|
|
28372
28548
|
|
|
28373
28549
|
- *Type:* string
|
|
28374
|
-
- *Default:* "
|
|
28550
|
+
- *Default:* "10.33.0"
|
|
28375
28551
|
|
|
28376
28552
|
The version of PNPM to use if using PNPM as a package manager.
|
|
28377
28553
|
|
|
@@ -30121,11 +30297,11 @@ added both to the `dependencies` section and `bundledDependencies` section of
|
|
|
30121
30297
|
your `package.json`.
|
|
30122
30298
|
|
|
30123
30299
|
The recommendation is to only specify the module name here (e.g.
|
|
30124
|
-
`express`). This will behave similar to `
|
|
30300
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
30125
30301
|
sense that it will add the module as a dependency to your `package.json`
|
|
30126
30302
|
file with the latest version (`^`). You can specify semver requirements in
|
|
30127
|
-
the same syntax passed to `
|
|
30128
|
-
this will be what
|
|
30303
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
30304
|
+
this will be what your `package.json` will eventually include.
|
|
30129
30305
|
|
|
30130
30306
|
---
|
|
30131
30307
|
|
|
@@ -30187,11 +30363,11 @@ public readonly deps: string[];
|
|
|
30187
30363
|
Runtime dependencies of this module.
|
|
30188
30364
|
|
|
30189
30365
|
The recommendation is to only specify the module name here (e.g.
|
|
30190
|
-
`express`). This will behave similar to `
|
|
30366
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
30191
30367
|
sense that it will add the module as a dependency to your `package.json`
|
|
30192
30368
|
file with the latest version (`^`). You can specify semver requirements in
|
|
30193
|
-
the same syntax passed to `
|
|
30194
|
-
this will be what
|
|
30369
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
30370
|
+
this will be what your `package.json` will eventually include.
|
|
30195
30371
|
|
|
30196
30372
|
---
|
|
30197
30373
|
|
|
@@ -30233,11 +30409,11 @@ available in your build environment but will not be fetched when this
|
|
|
30233
30409
|
module is consumed.
|
|
30234
30410
|
|
|
30235
30411
|
The recommendation is to only specify the module name here (e.g.
|
|
30236
|
-
`express`). This will behave similar to `
|
|
30412
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
30237
30413
|
sense that it will add the module as a dependency to your `package.json`
|
|
30238
30414
|
file with the latest version (`^`). You can specify semver requirements in
|
|
30239
|
-
the same syntax passed to `
|
|
30240
|
-
this will be what
|
|
30415
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
30416
|
+
this will be what your `package.json` will eventually include.
|
|
30241
30417
|
|
|
30242
30418
|
---
|
|
30243
30419
|
|
|
@@ -30539,7 +30715,7 @@ public readonly pnpmVersion: string;
|
|
|
30539
30715
|
```
|
|
30540
30716
|
|
|
30541
30717
|
- *Type:* string
|
|
30542
|
-
- *Default:* "
|
|
30718
|
+
- *Default:* "10.33.0"
|
|
30543
30719
|
|
|
30544
30720
|
The version of PNPM to use if using PNPM as a package manager.
|
|
30545
30721
|
|
|
@@ -32699,11 +32875,11 @@ added both to the `dependencies` section and `bundledDependencies` section of
|
|
|
32699
32875
|
your `package.json`.
|
|
32700
32876
|
|
|
32701
32877
|
The recommendation is to only specify the module name here (e.g.
|
|
32702
|
-
`express`). This will behave similar to `
|
|
32878
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
32703
32879
|
sense that it will add the module as a dependency to your `package.json`
|
|
32704
32880
|
file with the latest version (`^`). You can specify semver requirements in
|
|
32705
|
-
the same syntax passed to `
|
|
32706
|
-
this will be what
|
|
32881
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
32882
|
+
this will be what your `package.json` will eventually include.
|
|
32707
32883
|
|
|
32708
32884
|
---
|
|
32709
32885
|
|
|
@@ -32765,11 +32941,11 @@ public readonly deps: string[];
|
|
|
32765
32941
|
Runtime dependencies of this module.
|
|
32766
32942
|
|
|
32767
32943
|
The recommendation is to only specify the module name here (e.g.
|
|
32768
|
-
`express`). This will behave similar to `
|
|
32944
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
32769
32945
|
sense that it will add the module as a dependency to your `package.json`
|
|
32770
32946
|
file with the latest version (`^`). You can specify semver requirements in
|
|
32771
|
-
the same syntax passed to `
|
|
32772
|
-
this will be what
|
|
32947
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
32948
|
+
this will be what your `package.json` will eventually include.
|
|
32773
32949
|
|
|
32774
32950
|
---
|
|
32775
32951
|
|
|
@@ -32811,11 +32987,11 @@ available in your build environment but will not be fetched when this
|
|
|
32811
32987
|
module is consumed.
|
|
32812
32988
|
|
|
32813
32989
|
The recommendation is to only specify the module name here (e.g.
|
|
32814
|
-
`express`). This will behave similar to `
|
|
32990
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
32815
32991
|
sense that it will add the module as a dependency to your `package.json`
|
|
32816
32992
|
file with the latest version (`^`). You can specify semver requirements in
|
|
32817
|
-
the same syntax passed to `
|
|
32818
|
-
this will be what
|
|
32993
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
32994
|
+
this will be what your `package.json` will eventually include.
|
|
32819
32995
|
|
|
32820
32996
|
---
|
|
32821
32997
|
|
|
@@ -33117,7 +33293,7 @@ public readonly pnpmVersion: string;
|
|
|
33117
33293
|
```
|
|
33118
33294
|
|
|
33119
33295
|
- *Type:* string
|
|
33120
|
-
- *Default:* "
|
|
33296
|
+
- *Default:* "10.33.0"
|
|
33121
33297
|
|
|
33122
33298
|
The version of PNPM to use if using PNPM as a package manager.
|
|
33123
33299
|
|
|
@@ -34522,6 +34698,39 @@ Whether to have a separate workflow to upgrade runtime deps and mark this PR as
|
|
|
34522
34698
|
|
|
34523
34699
|
---
|
|
34524
34700
|
|
|
34701
|
+
### ConstraintsOptions <a name="ConstraintsOptions" id="cdklabs-projen-project-types.yarn.ConstraintsOptions"></a>
|
|
34702
|
+
|
|
34703
|
+
#### Initializer <a name="Initializer" id="cdklabs-projen-project-types.yarn.ConstraintsOptions.Initializer"></a>
|
|
34704
|
+
|
|
34705
|
+
```typescript
|
|
34706
|
+
import { yarn } from 'cdklabs-projen-project-types'
|
|
34707
|
+
|
|
34708
|
+
const constraintsOptions: yarn.ConstraintsOptions = { ... }
|
|
34709
|
+
```
|
|
34710
|
+
|
|
34711
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
34712
|
+
|
|
34713
|
+
| **Name** | **Type** | **Description** |
|
|
34714
|
+
| --- | --- | --- |
|
|
34715
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.ConstraintsOptions.property.consistentVersions">consistentVersions</a></code> | <code>string[]</code> | Package names that must use a consistent version across all workspaces. |
|
|
34716
|
+
|
|
34717
|
+
---
|
|
34718
|
+
|
|
34719
|
+
##### `consistentVersions`<sup>Required</sup> <a name="consistentVersions" id="cdklabs-projen-project-types.yarn.ConstraintsOptions.property.consistentVersions"></a>
|
|
34720
|
+
|
|
34721
|
+
```typescript
|
|
34722
|
+
public readonly consistentVersions: string[];
|
|
34723
|
+
```
|
|
34724
|
+
|
|
34725
|
+
- *Type:* string[]
|
|
34726
|
+
|
|
34727
|
+
Package names that must use a consistent version across all workspaces.
|
|
34728
|
+
|
|
34729
|
+
Each package must already be declared as a dev dependency on the monorepo root.
|
|
34730
|
+
The version is enforced across all workspaces using Yarn Berry constraints.
|
|
34731
|
+
|
|
34732
|
+
---
|
|
34733
|
+
|
|
34525
34734
|
### MonorepoOptions <a name="MonorepoOptions" id="cdklabs-projen-project-types.yarn.MonorepoOptions"></a>
|
|
34526
34735
|
|
|
34527
34736
|
MonorepoOptions.
|
|
@@ -34574,6 +34783,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
34574
34783
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.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`. |
|
|
34575
34784
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
34576
34785
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
34786
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.consistentVersions">consistentVersions</a></code> | <code>string[]</code> | Package names that must use a consistent version across all workspaces. |
|
|
34577
34787
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
34578
34788
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
34579
34789
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.deleteOrphanedLockFiles">deleteOrphanedLockFiles</a></code> | <code>boolean</code> | Automatically delete lockfiles from package managers that are not the active one. |
|
|
@@ -35087,11 +35297,11 @@ added both to the `dependencies` section and `bundledDependencies` section of
|
|
|
35087
35297
|
your `package.json`.
|
|
35088
35298
|
|
|
35089
35299
|
The recommendation is to only specify the module name here (e.g.
|
|
35090
|
-
`express`). This will behave similar to `
|
|
35300
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
35091
35301
|
sense that it will add the module as a dependency to your `package.json`
|
|
35092
35302
|
file with the latest version (`^`). You can specify semver requirements in
|
|
35093
|
-
the same syntax passed to `
|
|
35094
|
-
this will be what
|
|
35303
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
35304
|
+
this will be what your `package.json` will eventually include.
|
|
35095
35305
|
|
|
35096
35306
|
---
|
|
35097
35307
|
|
|
@@ -35202,6 +35412,22 @@ Whether to commit the managed files by default.
|
|
|
35202
35412
|
|
|
35203
35413
|
---
|
|
35204
35414
|
|
|
35415
|
+
##### `consistentVersions`<sup>Optional</sup> <a name="consistentVersions" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.consistentVersions"></a>
|
|
35416
|
+
|
|
35417
|
+
```typescript
|
|
35418
|
+
public readonly consistentVersions: string[];
|
|
35419
|
+
```
|
|
35420
|
+
|
|
35421
|
+
- *Type:* string[]
|
|
35422
|
+
|
|
35423
|
+
Package names that must use a consistent version across all workspaces.
|
|
35424
|
+
|
|
35425
|
+
Uses Yarn Berry constraints to enforce that all workspaces use the same version
|
|
35426
|
+
of the listed packages. The version is read from the root `devDependencies`.
|
|
35427
|
+
Only has an effect when the monorepo uses Yarn Berry.
|
|
35428
|
+
|
|
35429
|
+
---
|
|
35430
|
+
|
|
35205
35431
|
##### `copyrightOwner`<sup>Optional</sup> <a name="copyrightOwner" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.copyrightOwner"></a>
|
|
35206
35432
|
|
|
35207
35433
|
```typescript
|
|
@@ -35286,11 +35512,11 @@ public readonly deps: string[];
|
|
|
35286
35512
|
Runtime dependencies of this module.
|
|
35287
35513
|
|
|
35288
35514
|
The recommendation is to only specify the module name here (e.g.
|
|
35289
|
-
`express`). This will behave similar to `
|
|
35515
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
35290
35516
|
sense that it will add the module as a dependency to your `package.json`
|
|
35291
35517
|
file with the latest version (`^`). You can specify semver requirements in
|
|
35292
|
-
the same syntax passed to `
|
|
35293
|
-
this will be what
|
|
35518
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
35519
|
+
this will be what your `package.json` will eventually include.
|
|
35294
35520
|
|
|
35295
35521
|
---
|
|
35296
35522
|
|
|
@@ -35366,11 +35592,11 @@ available in your build environment but will not be fetched when this
|
|
|
35366
35592
|
module is consumed.
|
|
35367
35593
|
|
|
35368
35594
|
The recommendation is to only specify the module name here (e.g.
|
|
35369
|
-
`express`). This will behave similar to `
|
|
35595
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
35370
35596
|
sense that it will add the module as a dependency to your `package.json`
|
|
35371
35597
|
file with the latest version (`^`). You can specify semver requirements in
|
|
35372
|
-
the same syntax passed to `
|
|
35373
|
-
this will be what
|
|
35598
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
35599
|
+
this will be what your `package.json` will eventually include.
|
|
35374
35600
|
|
|
35375
35601
|
---
|
|
35376
35602
|
|
|
@@ -36057,7 +36283,7 @@ public readonly pnpmVersion: string;
|
|
|
36057
36283
|
```
|
|
36058
36284
|
|
|
36059
36285
|
- *Type:* string
|
|
36060
|
-
- *Default:* "
|
|
36286
|
+
- *Default:* "10.33.0"
|
|
36061
36287
|
|
|
36062
36288
|
The version of PNPM to use if using PNPM as a package manager.
|
|
36063
36289
|
|
|
@@ -37992,11 +38218,11 @@ added both to the `dependencies` section and `bundledDependencies` section of
|
|
|
37992
38218
|
your `package.json`.
|
|
37993
38219
|
|
|
37994
38220
|
The recommendation is to only specify the module name here (e.g.
|
|
37995
|
-
`express`). This will behave similar to `
|
|
38221
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
37996
38222
|
sense that it will add the module as a dependency to your `package.json`
|
|
37997
38223
|
file with the latest version (`^`). You can specify semver requirements in
|
|
37998
|
-
the same syntax passed to `
|
|
37999
|
-
this will be what
|
|
38224
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
38225
|
+
this will be what your `package.json` will eventually include.
|
|
38000
38226
|
|
|
38001
38227
|
---
|
|
38002
38228
|
|
|
@@ -38191,11 +38417,11 @@ public readonly deps: (string | IWorkspaceReference)[];
|
|
|
38191
38417
|
Runtime dependencies of this module.
|
|
38192
38418
|
|
|
38193
38419
|
The recommendation is to only specify the module name here (e.g.
|
|
38194
|
-
`express`). This will behave similar to `
|
|
38420
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
38195
38421
|
sense that it will add the module as a dependency to your `package.json`
|
|
38196
38422
|
file with the latest version (`^`). You can specify semver requirements in
|
|
38197
|
-
the same syntax passed to `
|
|
38198
|
-
this will be what
|
|
38423
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
38424
|
+
this will be what your `package.json` will eventually include.
|
|
38199
38425
|
|
|
38200
38426
|
---
|
|
38201
38427
|
|
|
@@ -38258,11 +38484,11 @@ available in your build environment but will not be fetched when this
|
|
|
38258
38484
|
module is consumed.
|
|
38259
38485
|
|
|
38260
38486
|
The recommendation is to only specify the module name here (e.g.
|
|
38261
|
-
`express`). This will behave similar to `
|
|
38487
|
+
`express`). This will behave similar to `pnpm add` or `npm install` in the
|
|
38262
38488
|
sense that it will add the module as a dependency to your `package.json`
|
|
38263
38489
|
file with the latest version (`^`). You can specify semver requirements in
|
|
38264
|
-
the same syntax passed to `
|
|
38265
|
-
this will be what
|
|
38490
|
+
the same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and
|
|
38491
|
+
this will be what your `package.json` will eventually include.
|
|
38266
38492
|
|
|
38267
38493
|
---
|
|
38268
38494
|
|
|
@@ -38984,7 +39210,7 @@ public readonly pnpmVersion: string;
|
|
|
38984
39210
|
```
|
|
38985
39211
|
|
|
38986
39212
|
- *Type:* string
|
|
38987
|
-
- *Default:* "
|
|
39213
|
+
- *Default:* "10.33.0"
|
|
38988
39214
|
|
|
38989
39215
|
The version of PNPM to use if using PNPM as a package manager.
|
|
38990
39216
|
|