lerna-projen 0.1.488 → 0.1.489

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 (4) hide show
  1. package/.jsii +3 -3
  2. package/API.md +70 -26
  3. package/lib/index.js +2 -2
  4. package/package.json +3 -3
package/.jsii CHANGED
@@ -15,7 +15,7 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "constructs": "^10.3.0",
18
- "projen": "^0.87.4"
18
+ "projen": "^0.88.0"
19
19
  },
20
20
  "dependencyClosure": {
21
21
  "constructs": {
@@ -1001,6 +1001,6 @@
1001
1001
  "symbolId": "src/utils:AddNxTaskDependencyOptions"
1002
1002
  }
1003
1003
  },
1004
- "version": "0.1.488",
1005
- "fingerprint": "I/U4gSBMuaWxBJ5q8pQmMBCanlidUzdSnHtTFZK/1bI="
1004
+ "version": "0.1.489",
1005
+ "fingerprint": "K5Atryn8NpNQTsbPDvwfY0UIVCfu6MIUpqhNuwvF4T0="
1006
1006
  }
package/API.md CHANGED
@@ -728,8 +728,8 @@ When given a project, this it the project itself.
728
728
  | <code><a href="#lerna-projen.LernaProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
729
729
  | <code><a href="#lerna-projen.LernaProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
730
730
  | <code><a href="#lerna-projen.LernaProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
731
- | <code><a href="#lerna-projen.LernaProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version required by this package. |
732
- | <code><a href="#lerna-projen.LernaProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | Minimum node.js version required by this package. |
731
+ | <code><a href="#lerna-projen.LernaProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version supported by this package. |
732
+ | <code><a href="#lerna-projen.LernaProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
733
733
  | <code><a href="#lerna-projen.LernaProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
734
734
  | <code><a href="#lerna-projen.LernaProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
735
735
  | <code><a href="#lerna-projen.LernaProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
@@ -1302,7 +1302,9 @@ public readonly maxNodeVersion: string;
1302
1302
 
1303
1303
  - *Type:* string
1304
1304
 
1305
- Maximum node version required by this package.
1305
+ Maximum node version supported by this package.
1306
+
1307
+ The value indicates the package is incompatible with newer versions.
1306
1308
 
1307
1309
  ---
1308
1310
 
@@ -1314,7 +1316,9 @@ public readonly minNodeVersion: string;
1314
1316
 
1315
1317
  - *Type:* string
1316
1318
 
1317
- Minimum node.js version required by this package.
1319
+ The minimum node version required by this package to function.
1320
+
1321
+ This value indicates the package is incompatible with older versions.
1318
1322
 
1319
1323
  ---
1320
1324
 
@@ -2200,8 +2204,8 @@ When given a project, this it the project itself.
2200
2204
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
2201
2205
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
2202
2206
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
2203
- | <code><a href="#lerna-projen.LernaTypescriptProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version required by this package. |
2204
- | <code><a href="#lerna-projen.LernaTypescriptProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | Minimum node.js version required by this package. |
2207
+ | <code><a href="#lerna-projen.LernaTypescriptProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version supported by this package. |
2208
+ | <code><a href="#lerna-projen.LernaTypescriptProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
2205
2209
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
2206
2210
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
2207
2211
  | <code><a href="#lerna-projen.LernaTypescriptProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
@@ -2782,7 +2786,9 @@ public readonly maxNodeVersion: string;
2782
2786
 
2783
2787
  - *Type:* string
2784
2788
 
2785
- Maximum node version required by this package.
2789
+ Maximum node version supported by this package.
2790
+
2791
+ The value indicates the package is incompatible with newer versions.
2786
2792
 
2787
2793
  ---
2788
2794
 
@@ -2794,7 +2800,9 @@ public readonly minNodeVersion: string;
2794
2800
 
2795
2801
  - *Type:* string
2796
2802
 
2797
- Minimum node.js version required by this package.
2803
+ The minimum node version required by this package to function.
2804
+
2805
+ This value indicates the package is incompatible with older versions.
2798
2806
 
2799
2807
  ---
2800
2808
 
@@ -3364,8 +3372,8 @@ const lernaProjectOptions: LernaProjectOptions = { ... }
3364
3372
  | <code><a href="#lerna-projen.LernaProjectOptions.property.keywords">keywords</a></code> | <code>string[]</code> | Keywords to include in `package.json`. |
3365
3373
  | <code><a href="#lerna-projen.LernaProjectOptions.property.license">license</a></code> | <code>string</code> | License's SPDX identifier. |
3366
3374
  | <code><a href="#lerna-projen.LernaProjectOptions.property.licensed">licensed</a></code> | <code>boolean</code> | Indicates if a license should be added. |
3367
- | <code><a href="#lerna-projen.LernaProjectOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Minimum node.js version to require via `engines` (inclusive). |
3368
- | <code><a href="#lerna-projen.LernaProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive). |
3375
+ | <code><a href="#lerna-projen.LernaProjectOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | The maximum node version supported by this package. Most projects should not use this option. |
3376
+ | <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. |
3369
3377
  | <code><a href="#lerna-projen.LernaProjectOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
3370
3378
  | <code><a href="#lerna-projen.LernaProjectOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
3371
3379
  | <code><a href="#lerna-projen.LernaProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
@@ -3441,7 +3449,7 @@ const lernaProjectOptions: LernaProjectOptions = { ... }
3441
3449
  | <code><a href="#lerna-projen.LernaProjectOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
3442
3450
  | <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. |
3443
3451
  | <code><a href="#lerna-projen.LernaProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
3444
- | <code><a href="#lerna-projen.LernaProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in GitHub workflows. |
3452
+ | <code><a href="#lerna-projen.LernaProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
3445
3453
  | <code><a href="#lerna-projen.LernaProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
3446
3454
  | <code><a href="#lerna-projen.LernaProjectOptions.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. |
3447
3455
  | <code><a href="#lerna-projen.LernaProjectOptions.property.sinceLastRelease">sinceLastRelease</a></code> | <code>boolean</code> | (experimental) Flag to run tasks only for the packages that has changes since last release. |
@@ -4171,9 +4179,15 @@ public readonly maxNodeVersion: string;
4171
4179
  ```
4172
4180
 
4173
4181
  - *Type:* string
4174
- - *Default:* no max
4182
+ - *Default:* no maximum version is enforced
4175
4183
 
4176
- Minimum node.js version to require via `engines` (inclusive).
4184
+ The maximum node version supported by this package. Most projects should not use this option.
4185
+
4186
+ The value indicates that the package is incompatible with any newer versions of node.
4187
+ This requirement is enforced via the engines field.
4188
+
4189
+ You will normally not need to set this option.
4190
+ Consider this option only if your package is known to not function with newer versions of node.
4177
4191
 
4178
4192
  ---
4179
4193
 
@@ -4184,9 +4198,19 @@ public readonly minNodeVersion: string;
4184
4198
  ```
4185
4199
 
4186
4200
  - *Type:* string
4187
- - *Default:* no "engines" specified
4201
+ - *Default:* no minimum version is enforced
4202
+
4203
+ The minimum node version required by this package to function. Most projects should not use this option.
4204
+
4205
+ The value indicates that the package is incompatible with any older versions of node.
4206
+ This requirement is enforced via the engines field.
4188
4207
 
4189
- Minimum Node.js version to require via package.json `engines` (inclusive).
4208
+ You will normally not need to set this option, even if your package is incompatible with EOL versions of node.
4209
+ Consider this option only if your package depends on a specific feature, that is not available in other LTS versions.
4210
+ Setting this option has very high impact on the consumers of your package,
4211
+ as package managers will actively prevent usage with node versions you have marked as incompatible.
4212
+
4213
+ To change the node version of your CI/CD workflows, use `workflowNodeVersion`.
4190
4214
 
4191
4215
  ---
4192
4216
 
@@ -5252,9 +5276,11 @@ public readonly workflowNodeVersion: string;
5252
5276
  ```
5253
5277
 
5254
5278
  - *Type:* string
5255
- - *Default:* same as `minNodeVersion`
5279
+ - *Default:* `minNodeVersion` if set, otherwise `lts/*`.
5280
+
5281
+ The node version used in GitHub Actions workflows.
5256
5282
 
5257
- The node version to use in GitHub workflows.
5283
+ Always use this option if your GitHub Actions workflows require a specific to run.
5258
5284
 
5259
5285
  ---
5260
5286
 
@@ -5437,8 +5463,8 @@ const lernaTypescriptProjectOptions: LernaTypescriptProjectOptions = { ... }
5437
5463
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.keywords">keywords</a></code> | <code>string[]</code> | Keywords to include in `package.json`. |
5438
5464
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.license">license</a></code> | <code>string</code> | License's SPDX identifier. |
5439
5465
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.licensed">licensed</a></code> | <code>boolean</code> | Indicates if a license should be added. |
5440
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Minimum node.js version to require via `engines` (inclusive). |
5441
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive). |
5466
+ | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | The maximum node version supported by this package. Most projects should not use this option. |
5467
+ | <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. |
5442
5468
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
5443
5469
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
5444
5470
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
@@ -5514,7 +5540,7 @@ const lernaTypescriptProjectOptions: LernaTypescriptProjectOptions = { ... }
5514
5540
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
5515
5541
  | <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. |
5516
5542
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
5517
- | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in GitHub workflows. |
5543
+ | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
5518
5544
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
5519
5545
  | <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). |
5520
5546
  | <code><a href="#lerna-projen.LernaTypescriptProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
@@ -6260,9 +6286,15 @@ public readonly maxNodeVersion: string;
6260
6286
  ```
6261
6287
 
6262
6288
  - *Type:* string
6263
- - *Default:* no max
6289
+ - *Default:* no maximum version is enforced
6290
+
6291
+ The maximum node version supported by this package. Most projects should not use this option.
6292
+
6293
+ The value indicates that the package is incompatible with any newer versions of node.
6294
+ This requirement is enforced via the engines field.
6264
6295
 
6265
- Minimum node.js version to require via `engines` (inclusive).
6296
+ You will normally not need to set this option.
6297
+ Consider this option only if your package is known to not function with newer versions of node.
6266
6298
 
6267
6299
  ---
6268
6300
 
@@ -6273,9 +6305,19 @@ public readonly minNodeVersion: string;
6273
6305
  ```
6274
6306
 
6275
6307
  - *Type:* string
6276
- - *Default:* no "engines" specified
6308
+ - *Default:* no minimum version is enforced
6277
6309
 
6278
- Minimum Node.js version to require via package.json `engines` (inclusive).
6310
+ The minimum node version required by this package to function. Most projects should not use this option.
6311
+
6312
+ The value indicates that the package is incompatible with any older versions of node.
6313
+ This requirement is enforced via the engines field.
6314
+
6315
+ You will normally not need to set this option, even if your package is incompatible with EOL versions of node.
6316
+ Consider this option only if your package depends on a specific feature, that is not available in other LTS versions.
6317
+ Setting this option has very high impact on the consumers of your package,
6318
+ as package managers will actively prevent usage with node versions you have marked as incompatible.
6319
+
6320
+ To change the node version of your CI/CD workflows, use `workflowNodeVersion`.
6279
6321
 
6280
6322
  ---
6281
6323
 
@@ -7341,9 +7383,11 @@ public readonly workflowNodeVersion: string;
7341
7383
  ```
7342
7384
 
7343
7385
  - *Type:* string
7344
- - *Default:* same as `minNodeVersion`
7386
+ - *Default:* `minNodeVersion` if set, otherwise `lts/*`.
7387
+
7388
+ The node version used in GitHub Actions workflows.
7345
7389
 
7346
- The node version to use in GitHub workflows.
7390
+ Always use this option if your GitHub Actions workflows require a specific to run.
7347
7391
 
7348
7392
  ---
7349
7393
 
package/lib/index.js CHANGED
@@ -92,7 +92,7 @@ class LernaProject extends projen_1.javascript.NodeProject {
92
92
  }
93
93
  exports.LernaProject = LernaProject;
94
94
  _a = JSII_RTTI_SYMBOL_1;
95
- LernaProject[_a] = { fqn: "lerna-projen.LernaProject", version: "0.1.488" };
95
+ LernaProject[_a] = { fqn: "lerna-projen.LernaProject", version: "0.1.489" };
96
96
  /**
97
97
  * @pjid lerna-ts-project
98
98
  */
@@ -125,7 +125,7 @@ class LernaTypescriptProject extends projen_1.typescript.TypeScriptProject {
125
125
  }
126
126
  exports.LernaTypescriptProject = LernaTypescriptProject;
127
127
  _b = JSII_RTTI_SYMBOL_1;
128
- LernaTypescriptProject[_b] = { fqn: "lerna-projen.LernaTypescriptProject", version: "0.1.488" };
128
+ LernaTypescriptProject[_b] = { fqn: "lerna-projen.LernaTypescriptProject", version: "0.1.489" };
129
129
  class LernaProjectFactory {
130
130
  constructor(project) {
131
131
  this.project = project;
package/package.json CHANGED
@@ -58,14 +58,14 @@
58
58
  "jsii-docgen": "^10.5.0",
59
59
  "jsii-pacmak": "^1.103.1",
60
60
  "jsii-rosetta": "5.4.x",
61
- "projen": "^0.87.4",
61
+ "projen": "^0.88.0",
62
62
  "ts-jest": "^29.2.5",
63
63
  "ts-node": "^10.9.2",
64
64
  "typescript": "^5.6.2"
65
65
  },
66
66
  "peerDependencies": {
67
67
  "constructs": "^10.3.0",
68
- "projen": "^0.87.4"
68
+ "projen": "^0.88.0"
69
69
  },
70
70
  "dependencies": {
71
71
  "commander": "^11.1.0",
@@ -89,7 +89,7 @@
89
89
  "publishConfig": {
90
90
  "access": "public"
91
91
  },
92
- "version": "0.1.488",
92
+ "version": "0.1.489",
93
93
  "jest": {
94
94
  "coverageProvider": "v8",
95
95
  "testMatch": [