mrpj 0.1.64 → 0.1.66
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 +387 -378
- package/API.md +163 -91
- package/lib/construct-project-options.d.ts +21 -6
- package/lib/construct-project-options.js +1 -1
- package/lib/construct-project.js +1 -1
- package/lib/logo/Logo.js +1 -1
- package/lib/logo/SvgFile.js +1 -1
- package/lib/logo/Wordmark.js +1 -1
- package/lib/projen-project-options.d.ts +21 -6
- package/lib/projen-project-options.js +1 -1
- package/lib/projen-project.js +1 -1
- package/lib/typescript-project-options.d.ts +21 -6
- package/lib/typescript-project-options.js +1 -1
- package/lib/typescript-project.js +1 -1
- package/package.json +9 -9
package/API.md
CHANGED
|
@@ -74,7 +74,7 @@ Returns a string representation of this construct.
|
|
|
74
74
|
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="mrpj.ConstructProject.addExcludeFromCleanup"></a>
|
|
75
75
|
|
|
76
76
|
```typescript
|
|
77
|
-
public addExcludeFromCleanup(globs: string): void
|
|
77
|
+
public addExcludeFromCleanup(globs: ...string[]): void
|
|
78
78
|
```
|
|
79
79
|
|
|
80
80
|
Exclude the matching files from pre-synth cleanup.
|
|
@@ -84,7 +84,7 @@ source files include the projen marker and we don't want them to be erased durin
|
|
|
84
84
|
|
|
85
85
|
###### `globs`<sup>Required</sup> <a name="globs" id="mrpj.ConstructProject.addExcludeFromCleanup.parameter.globs"></a>
|
|
86
86
|
|
|
87
|
-
- *Type:* string
|
|
87
|
+
- *Type:* ...string[]
|
|
88
88
|
|
|
89
89
|
The glob patterns to match.
|
|
90
90
|
|
|
@@ -340,7 +340,7 @@ public addBins(bins: {[ key: string ]: string}): void
|
|
|
340
340
|
##### `addBundledDeps` <a name="addBundledDeps" id="mrpj.ConstructProject.addBundledDeps"></a>
|
|
341
341
|
|
|
342
342
|
```typescript
|
|
343
|
-
public addBundledDeps(deps: string): void
|
|
343
|
+
public addBundledDeps(deps: ...string[]): void
|
|
344
344
|
```
|
|
345
345
|
|
|
346
346
|
Defines bundled dependencies.
|
|
@@ -350,7 +350,7 @@ Bundled dependencies will be added as normal dependencies as well as to the
|
|
|
350
350
|
|
|
351
351
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.ConstructProject.addBundledDeps.parameter.deps"></a>
|
|
352
352
|
|
|
353
|
-
- *Type:* string
|
|
353
|
+
- *Type:* ...string[]
|
|
354
354
|
|
|
355
355
|
Names modules to install.
|
|
356
356
|
|
|
@@ -365,28 +365,28 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
365
365
|
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="mrpj.ConstructProject.addCompileCommand"></a>
|
|
366
366
|
|
|
367
367
|
```typescript
|
|
368
|
-
public addCompileCommand(commands: string): void
|
|
368
|
+
public addCompileCommand(commands: ...string[]): void
|
|
369
369
|
```
|
|
370
370
|
|
|
371
371
|
DEPRECATED.
|
|
372
372
|
|
|
373
373
|
###### `commands`<sup>Required</sup> <a name="commands" id="mrpj.ConstructProject.addCompileCommand.parameter.commands"></a>
|
|
374
374
|
|
|
375
|
-
- *Type:* string
|
|
375
|
+
- *Type:* ...string[]
|
|
376
376
|
|
|
377
377
|
---
|
|
378
378
|
|
|
379
379
|
##### `addDeps` <a name="addDeps" id="mrpj.ConstructProject.addDeps"></a>
|
|
380
380
|
|
|
381
381
|
```typescript
|
|
382
|
-
public addDeps(deps: string): void
|
|
382
|
+
public addDeps(deps: ...string[]): void
|
|
383
383
|
```
|
|
384
384
|
|
|
385
385
|
Defines normal dependencies.
|
|
386
386
|
|
|
387
387
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.ConstructProject.addDeps.parameter.deps"></a>
|
|
388
388
|
|
|
389
|
-
- *Type:* string
|
|
389
|
+
- *Type:* ...string[]
|
|
390
390
|
|
|
391
391
|
Names modules to install.
|
|
392
392
|
|
|
@@ -401,14 +401,14 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
401
401
|
##### `addDevDeps` <a name="addDevDeps" id="mrpj.ConstructProject.addDevDeps"></a>
|
|
402
402
|
|
|
403
403
|
```typescript
|
|
404
|
-
public addDevDeps(deps: string): void
|
|
404
|
+
public addDevDeps(deps: ...string[]): void
|
|
405
405
|
```
|
|
406
406
|
|
|
407
407
|
Defines development/test dependencies.
|
|
408
408
|
|
|
409
409
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.ConstructProject.addDevDeps.parameter.deps"></a>
|
|
410
410
|
|
|
411
|
-
- *Type:* string
|
|
411
|
+
- *Type:* ...string[]
|
|
412
412
|
|
|
413
413
|
Names modules to install.
|
|
414
414
|
|
|
@@ -439,14 +439,14 @@ The fields to set.
|
|
|
439
439
|
##### `addKeywords` <a name="addKeywords" id="mrpj.ConstructProject.addKeywords"></a>
|
|
440
440
|
|
|
441
441
|
```typescript
|
|
442
|
-
public addKeywords(keywords: string): void
|
|
442
|
+
public addKeywords(keywords: ...string[]): void
|
|
443
443
|
```
|
|
444
444
|
|
|
445
445
|
Adds keywords to package.json (deduplicated).
|
|
446
446
|
|
|
447
447
|
###### `keywords`<sup>Required</sup> <a name="keywords" id="mrpj.ConstructProject.addKeywords.parameter.keywords"></a>
|
|
448
448
|
|
|
449
|
-
- *Type:* string
|
|
449
|
+
- *Type:* ...string[]
|
|
450
450
|
|
|
451
451
|
The keywords to add.
|
|
452
452
|
|
|
@@ -455,7 +455,7 @@ The keywords to add.
|
|
|
455
455
|
##### `addPeerDeps` <a name="addPeerDeps" id="mrpj.ConstructProject.addPeerDeps"></a>
|
|
456
456
|
|
|
457
457
|
```typescript
|
|
458
|
-
public addPeerDeps(deps: string): void
|
|
458
|
+
public addPeerDeps(deps: ...string[]): void
|
|
459
459
|
```
|
|
460
460
|
|
|
461
461
|
Defines peer dependencies.
|
|
@@ -466,7 +466,7 @@ your code against the minimum version required from your consumers.
|
|
|
466
466
|
|
|
467
467
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.ConstructProject.addPeerDeps.parameter.deps"></a>
|
|
468
468
|
|
|
469
|
-
- *Type:* string
|
|
469
|
+
- *Type:* ...string[]
|
|
470
470
|
|
|
471
471
|
Names modules to install.
|
|
472
472
|
|
|
@@ -497,14 +497,14 @@ The scripts to set.
|
|
|
497
497
|
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="mrpj.ConstructProject.addTestCommand"></a>
|
|
498
498
|
|
|
499
499
|
```typescript
|
|
500
|
-
public addTestCommand(commands: string): void
|
|
500
|
+
public addTestCommand(commands: ...string[]): void
|
|
501
501
|
```
|
|
502
502
|
|
|
503
503
|
DEPRECATED.
|
|
504
504
|
|
|
505
505
|
###### `commands`<sup>Required</sup> <a name="commands" id="mrpj.ConstructProject.addTestCommand.parameter.commands"></a>
|
|
506
506
|
|
|
507
|
-
- *Type:* string
|
|
507
|
+
- *Type:* ...string[]
|
|
508
508
|
|
|
509
509
|
---
|
|
510
510
|
|
|
@@ -583,7 +583,7 @@ The command to execute.
|
|
|
583
583
|
##### ~~`addCdkDependencies`~~ <a name="addCdkDependencies" id="mrpj.ConstructProject.addCdkDependencies"></a>
|
|
584
584
|
|
|
585
585
|
```typescript
|
|
586
|
-
public addCdkDependencies(deps: string): void
|
|
586
|
+
public addCdkDependencies(deps: ...string[]): void
|
|
587
587
|
```
|
|
588
588
|
|
|
589
589
|
Adds dependencies to AWS CDK modules.
|
|
@@ -592,7 +592,7 @@ Since this is a library project, dependencies will be added as peer dependencies
|
|
|
592
592
|
|
|
593
593
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.ConstructProject.addCdkDependencies.parameter.deps"></a>
|
|
594
594
|
|
|
595
|
-
- *Type:* string
|
|
595
|
+
- *Type:* ...string[]
|
|
596
596
|
|
|
597
597
|
names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
|
|
598
598
|
|
|
@@ -601,14 +601,14 @@ names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
|
|
|
601
601
|
##### ~~`addCdkTestDependencies`~~ <a name="addCdkTestDependencies" id="mrpj.ConstructProject.addCdkTestDependencies"></a>
|
|
602
602
|
|
|
603
603
|
```typescript
|
|
604
|
-
public addCdkTestDependencies(deps: string): void
|
|
604
|
+
public addCdkTestDependencies(deps: ...string[]): void
|
|
605
605
|
```
|
|
606
606
|
|
|
607
607
|
Adds AWS CDK modules as dev dependencies.
|
|
608
608
|
|
|
609
609
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.ConstructProject.addCdkTestDependencies.parameter.deps"></a>
|
|
610
610
|
|
|
611
|
-
- *Type:* string
|
|
611
|
+
- *Type:* ...string[]
|
|
612
612
|
|
|
613
613
|
names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
|
|
614
614
|
|
|
@@ -739,8 +739,8 @@ When given a project, this it the project itself.
|
|
|
739
739
|
| <code><a href="#mrpj.ConstructProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
|
|
740
740
|
| <code><a href="#mrpj.ConstructProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
|
|
741
741
|
| <code><a href="#mrpj.ConstructProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
|
|
742
|
-
| <code><a href="#mrpj.ConstructProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version
|
|
743
|
-
| <code><a href="#mrpj.ConstructProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> |
|
|
742
|
+
| <code><a href="#mrpj.ConstructProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version supported by this package. |
|
|
743
|
+
| <code><a href="#mrpj.ConstructProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
744
744
|
| <code><a href="#mrpj.ConstructProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
745
745
|
| <code><a href="#mrpj.ConstructProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
746
746
|
| <code><a href="#mrpj.ConstructProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
@@ -1319,7 +1319,9 @@ public readonly maxNodeVersion: string;
|
|
|
1319
1319
|
|
|
1320
1320
|
- *Type:* string
|
|
1321
1321
|
|
|
1322
|
-
Maximum node version
|
|
1322
|
+
Maximum node version supported by this package.
|
|
1323
|
+
|
|
1324
|
+
The value indicates the package is incompatible with newer versions.
|
|
1323
1325
|
|
|
1324
1326
|
---
|
|
1325
1327
|
|
|
@@ -1331,7 +1333,9 @@ public readonly minNodeVersion: string;
|
|
|
1331
1333
|
|
|
1332
1334
|
- *Type:* string
|
|
1333
1335
|
|
|
1334
|
-
|
|
1336
|
+
The minimum node version required by this package to function.
|
|
1337
|
+
|
|
1338
|
+
This value indicates the package is incompatible with older versions.
|
|
1335
1339
|
|
|
1336
1340
|
---
|
|
1337
1341
|
|
|
@@ -1648,7 +1652,7 @@ Returns a string representation of this construct.
|
|
|
1648
1652
|
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="mrpj.ProjenProject.addExcludeFromCleanup"></a>
|
|
1649
1653
|
|
|
1650
1654
|
```typescript
|
|
1651
|
-
public addExcludeFromCleanup(globs: string): void
|
|
1655
|
+
public addExcludeFromCleanup(globs: ...string[]): void
|
|
1652
1656
|
```
|
|
1653
1657
|
|
|
1654
1658
|
Exclude the matching files from pre-synth cleanup.
|
|
@@ -1658,7 +1662,7 @@ source files include the projen marker and we don't want them to be erased durin
|
|
|
1658
1662
|
|
|
1659
1663
|
###### `globs`<sup>Required</sup> <a name="globs" id="mrpj.ProjenProject.addExcludeFromCleanup.parameter.globs"></a>
|
|
1660
1664
|
|
|
1661
|
-
- *Type:* string
|
|
1665
|
+
- *Type:* ...string[]
|
|
1662
1666
|
|
|
1663
1667
|
The glob patterns to match.
|
|
1664
1668
|
|
|
@@ -1914,7 +1918,7 @@ public addBins(bins: {[ key: string ]: string}): void
|
|
|
1914
1918
|
##### `addBundledDeps` <a name="addBundledDeps" id="mrpj.ProjenProject.addBundledDeps"></a>
|
|
1915
1919
|
|
|
1916
1920
|
```typescript
|
|
1917
|
-
public addBundledDeps(deps: string): void
|
|
1921
|
+
public addBundledDeps(deps: ...string[]): void
|
|
1918
1922
|
```
|
|
1919
1923
|
|
|
1920
1924
|
Defines bundled dependencies.
|
|
@@ -1924,7 +1928,7 @@ Bundled dependencies will be added as normal dependencies as well as to the
|
|
|
1924
1928
|
|
|
1925
1929
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.ProjenProject.addBundledDeps.parameter.deps"></a>
|
|
1926
1930
|
|
|
1927
|
-
- *Type:* string
|
|
1931
|
+
- *Type:* ...string[]
|
|
1928
1932
|
|
|
1929
1933
|
Names modules to install.
|
|
1930
1934
|
|
|
@@ -1939,28 +1943,28 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
1939
1943
|
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="mrpj.ProjenProject.addCompileCommand"></a>
|
|
1940
1944
|
|
|
1941
1945
|
```typescript
|
|
1942
|
-
public addCompileCommand(commands: string): void
|
|
1946
|
+
public addCompileCommand(commands: ...string[]): void
|
|
1943
1947
|
```
|
|
1944
1948
|
|
|
1945
1949
|
DEPRECATED.
|
|
1946
1950
|
|
|
1947
1951
|
###### `commands`<sup>Required</sup> <a name="commands" id="mrpj.ProjenProject.addCompileCommand.parameter.commands"></a>
|
|
1948
1952
|
|
|
1949
|
-
- *Type:* string
|
|
1953
|
+
- *Type:* ...string[]
|
|
1950
1954
|
|
|
1951
1955
|
---
|
|
1952
1956
|
|
|
1953
1957
|
##### `addDeps` <a name="addDeps" id="mrpj.ProjenProject.addDeps"></a>
|
|
1954
1958
|
|
|
1955
1959
|
```typescript
|
|
1956
|
-
public addDeps(deps: string): void
|
|
1960
|
+
public addDeps(deps: ...string[]): void
|
|
1957
1961
|
```
|
|
1958
1962
|
|
|
1959
1963
|
Defines normal dependencies.
|
|
1960
1964
|
|
|
1961
1965
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.ProjenProject.addDeps.parameter.deps"></a>
|
|
1962
1966
|
|
|
1963
|
-
- *Type:* string
|
|
1967
|
+
- *Type:* ...string[]
|
|
1964
1968
|
|
|
1965
1969
|
Names modules to install.
|
|
1966
1970
|
|
|
@@ -1975,14 +1979,14 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
1975
1979
|
##### `addDevDeps` <a name="addDevDeps" id="mrpj.ProjenProject.addDevDeps"></a>
|
|
1976
1980
|
|
|
1977
1981
|
```typescript
|
|
1978
|
-
public addDevDeps(deps: string): void
|
|
1982
|
+
public addDevDeps(deps: ...string[]): void
|
|
1979
1983
|
```
|
|
1980
1984
|
|
|
1981
1985
|
Defines development/test dependencies.
|
|
1982
1986
|
|
|
1983
1987
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.ProjenProject.addDevDeps.parameter.deps"></a>
|
|
1984
1988
|
|
|
1985
|
-
- *Type:* string
|
|
1989
|
+
- *Type:* ...string[]
|
|
1986
1990
|
|
|
1987
1991
|
Names modules to install.
|
|
1988
1992
|
|
|
@@ -2013,14 +2017,14 @@ The fields to set.
|
|
|
2013
2017
|
##### `addKeywords` <a name="addKeywords" id="mrpj.ProjenProject.addKeywords"></a>
|
|
2014
2018
|
|
|
2015
2019
|
```typescript
|
|
2016
|
-
public addKeywords(keywords: string): void
|
|
2020
|
+
public addKeywords(keywords: ...string[]): void
|
|
2017
2021
|
```
|
|
2018
2022
|
|
|
2019
2023
|
Adds keywords to package.json (deduplicated).
|
|
2020
2024
|
|
|
2021
2025
|
###### `keywords`<sup>Required</sup> <a name="keywords" id="mrpj.ProjenProject.addKeywords.parameter.keywords"></a>
|
|
2022
2026
|
|
|
2023
|
-
- *Type:* string
|
|
2027
|
+
- *Type:* ...string[]
|
|
2024
2028
|
|
|
2025
2029
|
The keywords to add.
|
|
2026
2030
|
|
|
@@ -2029,7 +2033,7 @@ The keywords to add.
|
|
|
2029
2033
|
##### `addPeerDeps` <a name="addPeerDeps" id="mrpj.ProjenProject.addPeerDeps"></a>
|
|
2030
2034
|
|
|
2031
2035
|
```typescript
|
|
2032
|
-
public addPeerDeps(deps: string): void
|
|
2036
|
+
public addPeerDeps(deps: ...string[]): void
|
|
2033
2037
|
```
|
|
2034
2038
|
|
|
2035
2039
|
Defines peer dependencies.
|
|
@@ -2040,7 +2044,7 @@ your code against the minimum version required from your consumers.
|
|
|
2040
2044
|
|
|
2041
2045
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.ProjenProject.addPeerDeps.parameter.deps"></a>
|
|
2042
2046
|
|
|
2043
|
-
- *Type:* string
|
|
2047
|
+
- *Type:* ...string[]
|
|
2044
2048
|
|
|
2045
2049
|
Names modules to install.
|
|
2046
2050
|
|
|
@@ -2071,14 +2075,14 @@ The scripts to set.
|
|
|
2071
2075
|
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="mrpj.ProjenProject.addTestCommand"></a>
|
|
2072
2076
|
|
|
2073
2077
|
```typescript
|
|
2074
|
-
public addTestCommand(commands: string): void
|
|
2078
|
+
public addTestCommand(commands: ...string[]): void
|
|
2075
2079
|
```
|
|
2076
2080
|
|
|
2077
2081
|
DEPRECATED.
|
|
2078
2082
|
|
|
2079
2083
|
###### `commands`<sup>Required</sup> <a name="commands" id="mrpj.ProjenProject.addTestCommand.parameter.commands"></a>
|
|
2080
2084
|
|
|
2081
|
-
- *Type:* string
|
|
2085
|
+
- *Type:* ...string[]
|
|
2082
2086
|
|
|
2083
2087
|
---
|
|
2084
2088
|
|
|
@@ -2279,8 +2283,8 @@ When given a project, this it the project itself.
|
|
|
2279
2283
|
| <code><a href="#mrpj.ProjenProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
|
|
2280
2284
|
| <code><a href="#mrpj.ProjenProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
|
|
2281
2285
|
| <code><a href="#mrpj.ProjenProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
|
|
2282
|
-
| <code><a href="#mrpj.ProjenProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version
|
|
2283
|
-
| <code><a href="#mrpj.ProjenProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> |
|
|
2286
|
+
| <code><a href="#mrpj.ProjenProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version supported by this package. |
|
|
2287
|
+
| <code><a href="#mrpj.ProjenProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
2284
2288
|
| <code><a href="#mrpj.ProjenProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
2285
2289
|
| <code><a href="#mrpj.ProjenProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
2286
2290
|
| <code><a href="#mrpj.ProjenProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
@@ -2858,7 +2862,9 @@ public readonly maxNodeVersion: string;
|
|
|
2858
2862
|
|
|
2859
2863
|
- *Type:* string
|
|
2860
2864
|
|
|
2861
|
-
Maximum node version
|
|
2865
|
+
Maximum node version supported by this package.
|
|
2866
|
+
|
|
2867
|
+
The value indicates the package is incompatible with newer versions.
|
|
2862
2868
|
|
|
2863
2869
|
---
|
|
2864
2870
|
|
|
@@ -2870,7 +2876,9 @@ public readonly minNodeVersion: string;
|
|
|
2870
2876
|
|
|
2871
2877
|
- *Type:* string
|
|
2872
2878
|
|
|
2873
|
-
|
|
2879
|
+
The minimum node version required by this package to function.
|
|
2880
|
+
|
|
2881
|
+
This value indicates the package is incompatible with older versions.
|
|
2874
2882
|
|
|
2875
2883
|
---
|
|
2876
2884
|
|
|
@@ -3416,7 +3424,7 @@ Returns a string representation of this construct.
|
|
|
3416
3424
|
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="mrpj.TypeScriptProject.addExcludeFromCleanup"></a>
|
|
3417
3425
|
|
|
3418
3426
|
```typescript
|
|
3419
|
-
public addExcludeFromCleanup(globs: string): void
|
|
3427
|
+
public addExcludeFromCleanup(globs: ...string[]): void
|
|
3420
3428
|
```
|
|
3421
3429
|
|
|
3422
3430
|
Exclude the matching files from pre-synth cleanup.
|
|
@@ -3426,7 +3434,7 @@ source files include the projen marker and we don't want them to be erased durin
|
|
|
3426
3434
|
|
|
3427
3435
|
###### `globs`<sup>Required</sup> <a name="globs" id="mrpj.TypeScriptProject.addExcludeFromCleanup.parameter.globs"></a>
|
|
3428
3436
|
|
|
3429
|
-
- *Type:* string
|
|
3437
|
+
- *Type:* ...string[]
|
|
3430
3438
|
|
|
3431
3439
|
The glob patterns to match.
|
|
3432
3440
|
|
|
@@ -3682,7 +3690,7 @@ public addBins(bins: {[ key: string ]: string}): void
|
|
|
3682
3690
|
##### `addBundledDeps` <a name="addBundledDeps" id="mrpj.TypeScriptProject.addBundledDeps"></a>
|
|
3683
3691
|
|
|
3684
3692
|
```typescript
|
|
3685
|
-
public addBundledDeps(deps: string): void
|
|
3693
|
+
public addBundledDeps(deps: ...string[]): void
|
|
3686
3694
|
```
|
|
3687
3695
|
|
|
3688
3696
|
Defines bundled dependencies.
|
|
@@ -3692,7 +3700,7 @@ Bundled dependencies will be added as normal dependencies as well as to the
|
|
|
3692
3700
|
|
|
3693
3701
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.TypeScriptProject.addBundledDeps.parameter.deps"></a>
|
|
3694
3702
|
|
|
3695
|
-
- *Type:* string
|
|
3703
|
+
- *Type:* ...string[]
|
|
3696
3704
|
|
|
3697
3705
|
Names modules to install.
|
|
3698
3706
|
|
|
@@ -3707,28 +3715,28 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
3707
3715
|
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="mrpj.TypeScriptProject.addCompileCommand"></a>
|
|
3708
3716
|
|
|
3709
3717
|
```typescript
|
|
3710
|
-
public addCompileCommand(commands: string): void
|
|
3718
|
+
public addCompileCommand(commands: ...string[]): void
|
|
3711
3719
|
```
|
|
3712
3720
|
|
|
3713
3721
|
DEPRECATED.
|
|
3714
3722
|
|
|
3715
3723
|
###### `commands`<sup>Required</sup> <a name="commands" id="mrpj.TypeScriptProject.addCompileCommand.parameter.commands"></a>
|
|
3716
3724
|
|
|
3717
|
-
- *Type:* string
|
|
3725
|
+
- *Type:* ...string[]
|
|
3718
3726
|
|
|
3719
3727
|
---
|
|
3720
3728
|
|
|
3721
3729
|
##### `addDeps` <a name="addDeps" id="mrpj.TypeScriptProject.addDeps"></a>
|
|
3722
3730
|
|
|
3723
3731
|
```typescript
|
|
3724
|
-
public addDeps(deps: string): void
|
|
3732
|
+
public addDeps(deps: ...string[]): void
|
|
3725
3733
|
```
|
|
3726
3734
|
|
|
3727
3735
|
Defines normal dependencies.
|
|
3728
3736
|
|
|
3729
3737
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.TypeScriptProject.addDeps.parameter.deps"></a>
|
|
3730
3738
|
|
|
3731
|
-
- *Type:* string
|
|
3739
|
+
- *Type:* ...string[]
|
|
3732
3740
|
|
|
3733
3741
|
Names modules to install.
|
|
3734
3742
|
|
|
@@ -3743,14 +3751,14 @@ add/upgrade`. If you wish to specify a version range use this syntax:
|
|
|
3743
3751
|
##### `addDevDeps` <a name="addDevDeps" id="mrpj.TypeScriptProject.addDevDeps"></a>
|
|
3744
3752
|
|
|
3745
3753
|
```typescript
|
|
3746
|
-
public addDevDeps(deps: string): void
|
|
3754
|
+
public addDevDeps(deps: ...string[]): void
|
|
3747
3755
|
```
|
|
3748
3756
|
|
|
3749
3757
|
Defines development/test dependencies.
|
|
3750
3758
|
|
|
3751
3759
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.TypeScriptProject.addDevDeps.parameter.deps"></a>
|
|
3752
3760
|
|
|
3753
|
-
- *Type:* string
|
|
3761
|
+
- *Type:* ...string[]
|
|
3754
3762
|
|
|
3755
3763
|
Names modules to install.
|
|
3756
3764
|
|
|
@@ -3781,14 +3789,14 @@ The fields to set.
|
|
|
3781
3789
|
##### `addKeywords` <a name="addKeywords" id="mrpj.TypeScriptProject.addKeywords"></a>
|
|
3782
3790
|
|
|
3783
3791
|
```typescript
|
|
3784
|
-
public addKeywords(keywords: string): void
|
|
3792
|
+
public addKeywords(keywords: ...string[]): void
|
|
3785
3793
|
```
|
|
3786
3794
|
|
|
3787
3795
|
Adds keywords to package.json (deduplicated).
|
|
3788
3796
|
|
|
3789
3797
|
###### `keywords`<sup>Required</sup> <a name="keywords" id="mrpj.TypeScriptProject.addKeywords.parameter.keywords"></a>
|
|
3790
3798
|
|
|
3791
|
-
- *Type:* string
|
|
3799
|
+
- *Type:* ...string[]
|
|
3792
3800
|
|
|
3793
3801
|
The keywords to add.
|
|
3794
3802
|
|
|
@@ -3797,7 +3805,7 @@ The keywords to add.
|
|
|
3797
3805
|
##### `addPeerDeps` <a name="addPeerDeps" id="mrpj.TypeScriptProject.addPeerDeps"></a>
|
|
3798
3806
|
|
|
3799
3807
|
```typescript
|
|
3800
|
-
public addPeerDeps(deps: string): void
|
|
3808
|
+
public addPeerDeps(deps: ...string[]): void
|
|
3801
3809
|
```
|
|
3802
3810
|
|
|
3803
3811
|
Defines peer dependencies.
|
|
@@ -3808,7 +3816,7 @@ your code against the minimum version required from your consumers.
|
|
|
3808
3816
|
|
|
3809
3817
|
###### `deps`<sup>Required</sup> <a name="deps" id="mrpj.TypeScriptProject.addPeerDeps.parameter.deps"></a>
|
|
3810
3818
|
|
|
3811
|
-
- *Type:* string
|
|
3819
|
+
- *Type:* ...string[]
|
|
3812
3820
|
|
|
3813
3821
|
Names modules to install.
|
|
3814
3822
|
|
|
@@ -3839,14 +3847,14 @@ The scripts to set.
|
|
|
3839
3847
|
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="mrpj.TypeScriptProject.addTestCommand"></a>
|
|
3840
3848
|
|
|
3841
3849
|
```typescript
|
|
3842
|
-
public addTestCommand(commands: string): void
|
|
3850
|
+
public addTestCommand(commands: ...string[]): void
|
|
3843
3851
|
```
|
|
3844
3852
|
|
|
3845
3853
|
DEPRECATED.
|
|
3846
3854
|
|
|
3847
3855
|
###### `commands`<sup>Required</sup> <a name="commands" id="mrpj.TypeScriptProject.addTestCommand.parameter.commands"></a>
|
|
3848
3856
|
|
|
3849
|
-
- *Type:* string
|
|
3857
|
+
- *Type:* ...string[]
|
|
3850
3858
|
|
|
3851
3859
|
---
|
|
3852
3860
|
|
|
@@ -4047,8 +4055,8 @@ When given a project, this it the project itself.
|
|
|
4047
4055
|
| <code><a href="#mrpj.TypeScriptProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
|
|
4048
4056
|
| <code><a href="#mrpj.TypeScriptProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
|
|
4049
4057
|
| <code><a href="#mrpj.TypeScriptProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
|
|
4050
|
-
| <code><a href="#mrpj.TypeScriptProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version
|
|
4051
|
-
| <code><a href="#mrpj.TypeScriptProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> |
|
|
4058
|
+
| <code><a href="#mrpj.TypeScriptProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version supported by this package. |
|
|
4059
|
+
| <code><a href="#mrpj.TypeScriptProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
4052
4060
|
| <code><a href="#mrpj.TypeScriptProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
4053
4061
|
| <code><a href="#mrpj.TypeScriptProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
4054
4062
|
| <code><a href="#mrpj.TypeScriptProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
@@ -4626,7 +4634,9 @@ public readonly maxNodeVersion: string;
|
|
|
4626
4634
|
|
|
4627
4635
|
- *Type:* string
|
|
4628
4636
|
|
|
4629
|
-
Maximum node version
|
|
4637
|
+
Maximum node version supported by this package.
|
|
4638
|
+
|
|
4639
|
+
The value indicates the package is incompatible with newer versions.
|
|
4630
4640
|
|
|
4631
4641
|
---
|
|
4632
4642
|
|
|
@@ -4638,7 +4648,9 @@ public readonly minNodeVersion: string;
|
|
|
4638
4648
|
|
|
4639
4649
|
- *Type:* string
|
|
4640
4650
|
|
|
4641
|
-
|
|
4651
|
+
The minimum node version required by this package to function.
|
|
4652
|
+
|
|
4653
|
+
This value indicates the package is incompatible with older versions.
|
|
4642
4654
|
|
|
4643
4655
|
---
|
|
4644
4656
|
|
|
@@ -5169,9 +5181,9 @@ const constructProjectOptions: ConstructProjectOptions = { ... }
|
|
|
5169
5181
|
| <code><a href="#mrpj.ConstructProjectOptions.property.licensed">licensed</a></code> | <code>boolean</code> | Indicates if a license should be added. |
|
|
5170
5182
|
| <code><a href="#mrpj.ConstructProjectOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
|
|
5171
5183
|
| <code><a href="#mrpj.ConstructProjectOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
5172
|
-
| <code><a href="#mrpj.ConstructProjectOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> |
|
|
5184
|
+
| <code><a href="#mrpj.ConstructProjectOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | The maximum node version supported by this package. |
|
|
5173
5185
|
| <code><a href="#mrpj.ConstructProjectOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
5174
|
-
| <code><a href="#mrpj.ConstructProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> |
|
|
5186
|
+
| <code><a href="#mrpj.ConstructProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
5175
5187
|
| <code><a href="#mrpj.ConstructProjectOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
|
|
5176
5188
|
| <code><a href="#mrpj.ConstructProjectOptions.property.npmDistTag">npmDistTag</a></code> | <code>string</code> | The npmDistTag to use when publishing from the default branch. |
|
|
5177
5189
|
| <code><a href="#mrpj.ConstructProjectOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
|
|
@@ -5242,7 +5254,7 @@ const constructProjectOptions: ConstructProjectOptions = { ... }
|
|
|
5242
5254
|
| <code><a href="#mrpj.ConstructProjectOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
|
|
5243
5255
|
| <code><a href="#mrpj.ConstructProjectOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
|
|
5244
5256
|
| <code><a href="#mrpj.ConstructProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
5245
|
-
| <code><a href="#mrpj.ConstructProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version
|
|
5257
|
+
| <code><a href="#mrpj.ConstructProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
|
|
5246
5258
|
| <code><a href="#mrpj.ConstructProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
5247
5259
|
| <code><a href="#mrpj.ConstructProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
5248
5260
|
| <code><a href="#mrpj.ConstructProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
@@ -6371,9 +6383,16 @@ public readonly maxNodeVersion: string;
|
|
|
6371
6383
|
```
|
|
6372
6384
|
|
|
6373
6385
|
- *Type:* string
|
|
6374
|
-
- *Default:* no
|
|
6386
|
+
- *Default:* no maximum version is enforced
|
|
6375
6387
|
|
|
6376
|
-
|
|
6388
|
+
The maximum node version supported by this package.
|
|
6389
|
+
|
|
6390
|
+
Most projects should not use this option.
|
|
6391
|
+
The value indicates that the package is incompatible with any newer versions of node.
|
|
6392
|
+
This requirement is enforced via the engines field.
|
|
6393
|
+
|
|
6394
|
+
You will normally not need to set this option.
|
|
6395
|
+
Consider this option only if your package is known to not function with newer versions of node.
|
|
6377
6396
|
|
|
6378
6397
|
---
|
|
6379
6398
|
|
|
@@ -6402,9 +6421,20 @@ public readonly minNodeVersion: string;
|
|
|
6402
6421
|
```
|
|
6403
6422
|
|
|
6404
6423
|
- *Type:* string
|
|
6405
|
-
- *Default:* no
|
|
6424
|
+
- *Default:* no minimum version is enforced
|
|
6425
|
+
|
|
6426
|
+
The minimum node version required by this package to function.
|
|
6406
6427
|
|
|
6407
|
-
|
|
6428
|
+
Most projects should not use this option.
|
|
6429
|
+
The value indicates that the package is incompatible with any older versions of node.
|
|
6430
|
+
This requirement is enforced via the engines field.
|
|
6431
|
+
|
|
6432
|
+
You will normally not need to set this option, even if your package is incompatible with EOL versions of node.
|
|
6433
|
+
Consider this option only if your package depends on a specific feature, that is not available in other LTS versions.
|
|
6434
|
+
Setting this option has very high impact on the consumers of your package,
|
|
6435
|
+
as package managers will actively prevent usage with node versions you have marked as incompatible.
|
|
6436
|
+
|
|
6437
|
+
To change the node version of your CI/CD workflows, use `workflowNodeVersion`.
|
|
6408
6438
|
|
|
6409
6439
|
---
|
|
6410
6440
|
|
|
@@ -7382,9 +7412,11 @@ public readonly workflowNodeVersion: string;
|
|
|
7382
7412
|
```
|
|
7383
7413
|
|
|
7384
7414
|
- *Type:* string
|
|
7385
|
-
- *Default:*
|
|
7415
|
+
- *Default:* `minNodeVersion` if set, otherwise `lts/*`.
|
|
7416
|
+
|
|
7417
|
+
The node version used in GitHub Actions workflows.
|
|
7386
7418
|
|
|
7387
|
-
|
|
7419
|
+
Always use this option if your GitHub Actions workflows require a specific to run.
|
|
7388
7420
|
|
|
7389
7421
|
---
|
|
7390
7422
|
|
|
@@ -7905,9 +7937,9 @@ const projenProjectOptions: ProjenProjectOptions = { ... }
|
|
|
7905
7937
|
| <code><a href="#mrpj.ProjenProjectOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
|
|
7906
7938
|
| <code><a href="#mrpj.ProjenProjectOptions.property.logo">logo</a></code> | <code>mrpj.logo.ILogo</code> | Add a logo. |
|
|
7907
7939
|
| <code><a href="#mrpj.ProjenProjectOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
7908
|
-
| <code><a href="#mrpj.ProjenProjectOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> |
|
|
7940
|
+
| <code><a href="#mrpj.ProjenProjectOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | The maximum node version supported by this package. |
|
|
7909
7941
|
| <code><a href="#mrpj.ProjenProjectOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
7910
|
-
| <code><a href="#mrpj.ProjenProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> |
|
|
7942
|
+
| <code><a href="#mrpj.ProjenProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
7911
7943
|
| <code><a href="#mrpj.ProjenProjectOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
7912
7944
|
| <code><a href="#mrpj.ProjenProjectOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
|
|
7913
7945
|
| <code><a href="#mrpj.ProjenProjectOptions.property.npmDistTag">npmDistTag</a></code> | <code>string</code> | The npmDistTag to use when publishing from the default branch. |
|
|
@@ -7979,7 +8011,7 @@ const projenProjectOptions: ProjenProjectOptions = { ... }
|
|
|
7979
8011
|
| <code><a href="#mrpj.ProjenProjectOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
|
|
7980
8012
|
| <code><a href="#mrpj.ProjenProjectOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
|
|
7981
8013
|
| <code><a href="#mrpj.ProjenProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
7982
|
-
| <code><a href="#mrpj.ProjenProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version
|
|
8014
|
+
| <code><a href="#mrpj.ProjenProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
|
|
7983
8015
|
| <code><a href="#mrpj.ProjenProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
7984
8016
|
| <code><a href="#mrpj.ProjenProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
7985
8017
|
| <code><a href="#mrpj.ProjenProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
@@ -8944,9 +8976,16 @@ public readonly maxNodeVersion: string;
|
|
|
8944
8976
|
```
|
|
8945
8977
|
|
|
8946
8978
|
- *Type:* string
|
|
8947
|
-
- *Default:* no
|
|
8979
|
+
- *Default:* no maximum version is enforced
|
|
8948
8980
|
|
|
8949
|
-
|
|
8981
|
+
The maximum node version supported by this package.
|
|
8982
|
+
|
|
8983
|
+
Most projects should not use this option.
|
|
8984
|
+
The value indicates that the package is incompatible with any newer versions of node.
|
|
8985
|
+
This requirement is enforced via the engines field.
|
|
8986
|
+
|
|
8987
|
+
You will normally not need to set this option.
|
|
8988
|
+
Consider this option only if your package is known to not function with newer versions of node.
|
|
8950
8989
|
|
|
8951
8990
|
---
|
|
8952
8991
|
|
|
@@ -8975,9 +9014,20 @@ public readonly minNodeVersion: string;
|
|
|
8975
9014
|
```
|
|
8976
9015
|
|
|
8977
9016
|
- *Type:* string
|
|
8978
|
-
- *Default:* no
|
|
9017
|
+
- *Default:* no minimum version is enforced
|
|
9018
|
+
|
|
9019
|
+
The minimum node version required by this package to function.
|
|
8979
9020
|
|
|
8980
|
-
|
|
9021
|
+
Most projects should not use this option.
|
|
9022
|
+
The value indicates that the package is incompatible with any older versions of node.
|
|
9023
|
+
This requirement is enforced via the engines field.
|
|
9024
|
+
|
|
9025
|
+
You will normally not need to set this option, even if your package is incompatible with EOL versions of node.
|
|
9026
|
+
Consider this option only if your package depends on a specific feature, that is not available in other LTS versions.
|
|
9027
|
+
Setting this option has very high impact on the consumers of your package,
|
|
9028
|
+
as package managers will actively prevent usage with node versions you have marked as incompatible.
|
|
9029
|
+
|
|
9030
|
+
To change the node version of your CI/CD workflows, use `workflowNodeVersion`.
|
|
8981
9031
|
|
|
8982
9032
|
---
|
|
8983
9033
|
|
|
@@ -9965,9 +10015,11 @@ public readonly workflowNodeVersion: string;
|
|
|
9965
10015
|
```
|
|
9966
10016
|
|
|
9967
10017
|
- *Type:* string
|
|
9968
|
-
- *Default:*
|
|
10018
|
+
- *Default:* `minNodeVersion` if set, otherwise `lts/*`.
|
|
10019
|
+
|
|
10020
|
+
The node version used in GitHub Actions workflows.
|
|
9969
10021
|
|
|
9970
|
-
|
|
10022
|
+
Always use this option if your GitHub Actions workflows require a specific to run.
|
|
9971
10023
|
|
|
9972
10024
|
---
|
|
9973
10025
|
|
|
@@ -10292,9 +10344,9 @@ const typeScriptProjectOptions: TypeScriptProjectOptions = { ... }
|
|
|
10292
10344
|
| <code><a href="#mrpj.TypeScriptProjectOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
|
|
10293
10345
|
| <code><a href="#mrpj.TypeScriptProjectOptions.property.logo">logo</a></code> | <code>mrpj.logo.ILogo</code> | Add a logo. |
|
|
10294
10346
|
| <code><a href="#mrpj.TypeScriptProjectOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
10295
|
-
| <code><a href="#mrpj.TypeScriptProjectOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> |
|
|
10347
|
+
| <code><a href="#mrpj.TypeScriptProjectOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | The maximum node version supported by this package. |
|
|
10296
10348
|
| <code><a href="#mrpj.TypeScriptProjectOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
10297
|
-
| <code><a href="#mrpj.TypeScriptProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> |
|
|
10349
|
+
| <code><a href="#mrpj.TypeScriptProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
10298
10350
|
| <code><a href="#mrpj.TypeScriptProjectOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
10299
10351
|
| <code><a href="#mrpj.TypeScriptProjectOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
|
|
10300
10352
|
| <code><a href="#mrpj.TypeScriptProjectOptions.property.npmDistTag">npmDistTag</a></code> | <code>string</code> | The npmDistTag to use when publishing from the default branch. |
|
|
@@ -10362,7 +10414,7 @@ const typeScriptProjectOptions: TypeScriptProjectOptions = { ... }
|
|
|
10362
10414
|
| <code><a href="#mrpj.TypeScriptProjectOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
|
|
10363
10415
|
| <code><a href="#mrpj.TypeScriptProjectOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
|
|
10364
10416
|
| <code><a href="#mrpj.TypeScriptProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
10365
|
-
| <code><a href="#mrpj.TypeScriptProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version
|
|
10417
|
+
| <code><a href="#mrpj.TypeScriptProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
|
|
10366
10418
|
| <code><a href="#mrpj.TypeScriptProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
10367
10419
|
| <code><a href="#mrpj.TypeScriptProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
10368
10420
|
| <code><a href="#mrpj.TypeScriptProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
@@ -11243,9 +11295,16 @@ public readonly maxNodeVersion: string;
|
|
|
11243
11295
|
```
|
|
11244
11296
|
|
|
11245
11297
|
- *Type:* string
|
|
11246
|
-
- *Default:* no
|
|
11298
|
+
- *Default:* no maximum version is enforced
|
|
11247
11299
|
|
|
11248
|
-
|
|
11300
|
+
The maximum node version supported by this package.
|
|
11301
|
+
|
|
11302
|
+
Most projects should not use this option.
|
|
11303
|
+
The value indicates that the package is incompatible with any newer versions of node.
|
|
11304
|
+
This requirement is enforced via the engines field.
|
|
11305
|
+
|
|
11306
|
+
You will normally not need to set this option.
|
|
11307
|
+
Consider this option only if your package is known to not function with newer versions of node.
|
|
11249
11308
|
|
|
11250
11309
|
---
|
|
11251
11310
|
|
|
@@ -11274,9 +11333,20 @@ public readonly minNodeVersion: string;
|
|
|
11274
11333
|
```
|
|
11275
11334
|
|
|
11276
11335
|
- *Type:* string
|
|
11277
|
-
- *Default:* no
|
|
11336
|
+
- *Default:* no minimum version is enforced
|
|
11337
|
+
|
|
11338
|
+
The minimum node version required by this package to function.
|
|
11278
11339
|
|
|
11279
|
-
|
|
11340
|
+
Most projects should not use this option.
|
|
11341
|
+
The value indicates that the package is incompatible with any older versions of node.
|
|
11342
|
+
This requirement is enforced via the engines field.
|
|
11343
|
+
|
|
11344
|
+
You will normally not need to set this option, even if your package is incompatible with EOL versions of node.
|
|
11345
|
+
Consider this option only if your package depends on a specific feature, that is not available in other LTS versions.
|
|
11346
|
+
Setting this option has very high impact on the consumers of your package,
|
|
11347
|
+
as package managers will actively prevent usage with node versions you have marked as incompatible.
|
|
11348
|
+
|
|
11349
|
+
To change the node version of your CI/CD workflows, use `workflowNodeVersion`.
|
|
11280
11350
|
|
|
11281
11351
|
---
|
|
11282
11352
|
|
|
@@ -12217,9 +12287,11 @@ public readonly workflowNodeVersion: string;
|
|
|
12217
12287
|
```
|
|
12218
12288
|
|
|
12219
12289
|
- *Type:* string
|
|
12220
|
-
- *Default:*
|
|
12290
|
+
- *Default:* `minNodeVersion` if set, otherwise `lts/*`.
|
|
12291
|
+
|
|
12292
|
+
The node version used in GitHub Actions workflows.
|
|
12221
12293
|
|
|
12222
|
-
|
|
12294
|
+
Always use this option if your GitHub Actions workflows require a specific to run.
|
|
12223
12295
|
|
|
12224
12296
|
---
|
|
12225
12297
|
|