@alma-cdk/construct-library 0.0.13 → 0.0.15
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 +3070 -24
- package/.nvmrc +1 -1
- package/API.md +2203 -0
- package/README.md +5 -1
- package/lib/AlmaCdkConstructLibrary.js +14 -6
- package/lib/NodeConfig.d.ts +6 -3
- package/lib/NodeConfig.js +41 -19
- package/lib/index.d.ts +1 -0
- package/lib/index.js +1 -1
- package/lib/schemas/almaCdkConstructLibraryOptions.d.ts +216 -0
- package/lib/schemas/almaCdkConstructLibraryOptions.js +8 -2
- package/lib/schemas/pnpmSettings.d.ts +209 -0
- package/lib/schemas/pnpmSettings.js +188 -0
- package/package.json +5 -2
- package/pnpm-workspace.yaml +1 -2
- package/scripts/generate-pnpm-workspace-types.ts +236 -7
package/API.md
CHANGED
|
@@ -1616,9 +1616,13 @@ const almaCdkConstructLibraryOptions: AlmaCdkConstructLibraryOptions = { ... }
|
|
|
1616
1616
|
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | *No description.* |
|
|
1617
1617
|
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.deps">deps</a></code> | <code>string[]</code> | *No description.* |
|
|
1618
1618
|
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | *No description.* |
|
|
1619
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.golang">golang</a></code> | <code>boolean</code> | *No description.* |
|
|
1619
1620
|
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.keywords">keywords</a></code> | <code>string[]</code> | *No description.* |
|
|
1620
1621
|
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | *No description.* |
|
|
1621
1622
|
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | *No description.* |
|
|
1623
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | *No description.* |
|
|
1624
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.pnpmSettings">pnpmSettings</a></code> | <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification">PnpmWorkspaceSpecification</a></code> | *No description.* |
|
|
1625
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.python">python</a></code> | <code>boolean</code> | *No description.* |
|
|
1622
1626
|
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | *No description.* |
|
|
1623
1627
|
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | *No description.* |
|
|
1624
1628
|
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.sonarProjectPropertiesExtraLines">sonarProjectPropertiesExtraLines</a></code> | <code>string[]</code> | Appended to generated `sonar-project.properties` after the default lines (e.g. Sonar multicriteria ignores). |
|
|
@@ -1726,6 +1730,16 @@ public readonly devDeps: string[];
|
|
|
1726
1730
|
|
|
1727
1731
|
---
|
|
1728
1732
|
|
|
1733
|
+
##### `golang`<sup>Optional</sup> <a name="golang" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.golang"></a>
|
|
1734
|
+
|
|
1735
|
+
```typescript
|
|
1736
|
+
public readonly golang: boolean;
|
|
1737
|
+
```
|
|
1738
|
+
|
|
1739
|
+
- *Type:* boolean
|
|
1740
|
+
|
|
1741
|
+
---
|
|
1742
|
+
|
|
1729
1743
|
##### `keywords`<sup>Optional</sup> <a name="keywords" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.keywords"></a>
|
|
1730
1744
|
|
|
1731
1745
|
```typescript
|
|
@@ -1756,6 +1770,36 @@ public readonly minNodeVersion: string;
|
|
|
1756
1770
|
|
|
1757
1771
|
---
|
|
1758
1772
|
|
|
1773
|
+
##### `peerDeps`<sup>Optional</sup> <a name="peerDeps" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.peerDeps"></a>
|
|
1774
|
+
|
|
1775
|
+
```typescript
|
|
1776
|
+
public readonly peerDeps: string[];
|
|
1777
|
+
```
|
|
1778
|
+
|
|
1779
|
+
- *Type:* string[]
|
|
1780
|
+
|
|
1781
|
+
---
|
|
1782
|
+
|
|
1783
|
+
##### `pnpmSettings`<sup>Optional</sup> <a name="pnpmSettings" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.pnpmSettings"></a>
|
|
1784
|
+
|
|
1785
|
+
```typescript
|
|
1786
|
+
public readonly pnpmSettings: PnpmWorkspaceSpecification;
|
|
1787
|
+
```
|
|
1788
|
+
|
|
1789
|
+
- *Type:* <a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification">PnpmWorkspaceSpecification</a>
|
|
1790
|
+
|
|
1791
|
+
---
|
|
1792
|
+
|
|
1793
|
+
##### `python`<sup>Optional</sup> <a name="python" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.python"></a>
|
|
1794
|
+
|
|
1795
|
+
```typescript
|
|
1796
|
+
public readonly python: boolean;
|
|
1797
|
+
```
|
|
1798
|
+
|
|
1799
|
+
- *Type:* boolean
|
|
1800
|
+
|
|
1801
|
+
---
|
|
1802
|
+
|
|
1759
1803
|
##### `releaseBranches`<sup>Optional</sup> <a name="releaseBranches" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.releaseBranches"></a>
|
|
1760
1804
|
|
|
1761
1805
|
```typescript
|
|
@@ -1798,5 +1842,2164 @@ public readonly workflowNodeVersion: string;
|
|
|
1798
1842
|
|
|
1799
1843
|
---
|
|
1800
1844
|
|
|
1845
|
+
### AuditConfig <a name="AuditConfig" id="@alma-cdk/construct-library.AuditConfig"></a>
|
|
1846
|
+
|
|
1847
|
+
#### Initializer <a name="Initializer" id="@alma-cdk/construct-library.AuditConfig.Initializer"></a>
|
|
1848
|
+
|
|
1849
|
+
```typescript
|
|
1850
|
+
import { AuditConfig } from '@alma-cdk/construct-library'
|
|
1851
|
+
|
|
1852
|
+
const auditConfig: AuditConfig = { ... }
|
|
1853
|
+
```
|
|
1854
|
+
|
|
1855
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1856
|
+
|
|
1857
|
+
| **Name** | **Type** | **Description** |
|
|
1858
|
+
| --- | --- | --- |
|
|
1859
|
+
| <code><a href="#@alma-cdk/construct-library.AuditConfig.property.ignoreCves">ignoreCves</a></code> | <code>string[]</code> | *No description.* |
|
|
1860
|
+
| <code><a href="#@alma-cdk/construct-library.AuditConfig.property.ignoreGhsas">ignoreGhsas</a></code> | <code>string[]</code> | *No description.* |
|
|
1861
|
+
|
|
1862
|
+
---
|
|
1863
|
+
|
|
1864
|
+
##### `ignoreCves`<sup>Optional</sup> <a name="ignoreCves" id="@alma-cdk/construct-library.AuditConfig.property.ignoreCves"></a>
|
|
1865
|
+
|
|
1866
|
+
```typescript
|
|
1867
|
+
public readonly ignoreCves: string[];
|
|
1868
|
+
```
|
|
1869
|
+
|
|
1870
|
+
- *Type:* string[]
|
|
1871
|
+
|
|
1872
|
+
---
|
|
1873
|
+
|
|
1874
|
+
##### `ignoreGhsas`<sup>Optional</sup> <a name="ignoreGhsas" id="@alma-cdk/construct-library.AuditConfig.property.ignoreGhsas"></a>
|
|
1875
|
+
|
|
1876
|
+
```typescript
|
|
1877
|
+
public readonly ignoreGhsas: string[];
|
|
1878
|
+
```
|
|
1879
|
+
|
|
1880
|
+
- *Type:* string[]
|
|
1881
|
+
|
|
1882
|
+
---
|
|
1883
|
+
|
|
1884
|
+
### ExecutionEnv <a name="ExecutionEnv" id="@alma-cdk/construct-library.ExecutionEnv"></a>
|
|
1885
|
+
|
|
1886
|
+
#### Initializer <a name="Initializer" id="@alma-cdk/construct-library.ExecutionEnv.Initializer"></a>
|
|
1887
|
+
|
|
1888
|
+
```typescript
|
|
1889
|
+
import { ExecutionEnv } from '@alma-cdk/construct-library'
|
|
1890
|
+
|
|
1891
|
+
const executionEnv: ExecutionEnv = { ... }
|
|
1892
|
+
```
|
|
1893
|
+
|
|
1894
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1895
|
+
|
|
1896
|
+
| **Name** | **Type** | **Description** |
|
|
1897
|
+
| --- | --- | --- |
|
|
1898
|
+
| <code><a href="#@alma-cdk/construct-library.ExecutionEnv.property.nodeVersion">nodeVersion</a></code> | <code>string</code> | *No description.* |
|
|
1899
|
+
|
|
1900
|
+
---
|
|
1901
|
+
|
|
1902
|
+
##### `nodeVersion`<sup>Optional</sup> <a name="nodeVersion" id="@alma-cdk/construct-library.ExecutionEnv.property.nodeVersion"></a>
|
|
1903
|
+
|
|
1904
|
+
```typescript
|
|
1905
|
+
public readonly nodeVersion: string;
|
|
1906
|
+
```
|
|
1907
|
+
|
|
1908
|
+
- *Type:* string
|
|
1909
|
+
|
|
1910
|
+
---
|
|
1911
|
+
|
|
1912
|
+
### PackageExtension <a name="PackageExtension" id="@alma-cdk/construct-library.PackageExtension"></a>
|
|
1913
|
+
|
|
1914
|
+
#### Initializer <a name="Initializer" id="@alma-cdk/construct-library.PackageExtension.Initializer"></a>
|
|
1915
|
+
|
|
1916
|
+
```typescript
|
|
1917
|
+
import { PackageExtension } from '@alma-cdk/construct-library'
|
|
1918
|
+
|
|
1919
|
+
const packageExtension: PackageExtension = { ... }
|
|
1920
|
+
```
|
|
1921
|
+
|
|
1922
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1923
|
+
|
|
1924
|
+
| **Name** | **Type** | **Description** |
|
|
1925
|
+
| --- | --- | --- |
|
|
1926
|
+
| <code><a href="#@alma-cdk/construct-library.PackageExtension.property.dependencies">dependencies</a></code> | <code>{[ key: string ]: string}</code> | *No description.* |
|
|
1927
|
+
| <code><a href="#@alma-cdk/construct-library.PackageExtension.property.optionalDependencies">optionalDependencies</a></code> | <code>{[ key: string ]: string}</code> | *No description.* |
|
|
1928
|
+
| <code><a href="#@alma-cdk/construct-library.PackageExtension.property.peerDependencies">peerDependencies</a></code> | <code>{[ key: string ]: string}</code> | *No description.* |
|
|
1929
|
+
| <code><a href="#@alma-cdk/construct-library.PackageExtension.property.peerDependenciesMeta">peerDependenciesMeta</a></code> | <code>{[ key: string ]: <a href="#@alma-cdk/construct-library.PeerDependencyMetaValue">PeerDependencyMetaValue</a>}</code> | *No description.* |
|
|
1930
|
+
|
|
1931
|
+
---
|
|
1932
|
+
|
|
1933
|
+
##### `dependencies`<sup>Optional</sup> <a name="dependencies" id="@alma-cdk/construct-library.PackageExtension.property.dependencies"></a>
|
|
1934
|
+
|
|
1935
|
+
```typescript
|
|
1936
|
+
public readonly dependencies: {[ key: string ]: string};
|
|
1937
|
+
```
|
|
1938
|
+
|
|
1939
|
+
- *Type:* {[ key: string ]: string}
|
|
1940
|
+
|
|
1941
|
+
---
|
|
1942
|
+
|
|
1943
|
+
##### `optionalDependencies`<sup>Optional</sup> <a name="optionalDependencies" id="@alma-cdk/construct-library.PackageExtension.property.optionalDependencies"></a>
|
|
1944
|
+
|
|
1945
|
+
```typescript
|
|
1946
|
+
public readonly optionalDependencies: {[ key: string ]: string};
|
|
1947
|
+
```
|
|
1948
|
+
|
|
1949
|
+
- *Type:* {[ key: string ]: string}
|
|
1950
|
+
|
|
1951
|
+
---
|
|
1952
|
+
|
|
1953
|
+
##### `peerDependencies`<sup>Optional</sup> <a name="peerDependencies" id="@alma-cdk/construct-library.PackageExtension.property.peerDependencies"></a>
|
|
1954
|
+
|
|
1955
|
+
```typescript
|
|
1956
|
+
public readonly peerDependencies: {[ key: string ]: string};
|
|
1957
|
+
```
|
|
1958
|
+
|
|
1959
|
+
- *Type:* {[ key: string ]: string}
|
|
1960
|
+
|
|
1961
|
+
---
|
|
1962
|
+
|
|
1963
|
+
##### `peerDependenciesMeta`<sup>Optional</sup> <a name="peerDependenciesMeta" id="@alma-cdk/construct-library.PackageExtension.property.peerDependenciesMeta"></a>
|
|
1964
|
+
|
|
1965
|
+
```typescript
|
|
1966
|
+
public readonly peerDependenciesMeta: {[ key: string ]: PeerDependencyMetaValue};
|
|
1967
|
+
```
|
|
1968
|
+
|
|
1969
|
+
- *Type:* {[ key: string ]: <a href="#@alma-cdk/construct-library.PeerDependencyMetaValue">PeerDependencyMetaValue</a>}
|
|
1970
|
+
|
|
1971
|
+
---
|
|
1972
|
+
|
|
1973
|
+
### PeerDependencyMetaValue <a name="PeerDependencyMetaValue" id="@alma-cdk/construct-library.PeerDependencyMetaValue"></a>
|
|
1974
|
+
|
|
1975
|
+
#### Initializer <a name="Initializer" id="@alma-cdk/construct-library.PeerDependencyMetaValue.Initializer"></a>
|
|
1976
|
+
|
|
1977
|
+
```typescript
|
|
1978
|
+
import { PeerDependencyMetaValue } from '@alma-cdk/construct-library'
|
|
1979
|
+
|
|
1980
|
+
const peerDependencyMetaValue: PeerDependencyMetaValue = { ... }
|
|
1981
|
+
```
|
|
1982
|
+
|
|
1983
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1984
|
+
|
|
1985
|
+
| **Name** | **Type** | **Description** |
|
|
1986
|
+
| --- | --- | --- |
|
|
1987
|
+
| <code><a href="#@alma-cdk/construct-library.PeerDependencyMetaValue.property.optional">optional</a></code> | <code>boolean</code> | *No description.* |
|
|
1988
|
+
|
|
1989
|
+
---
|
|
1990
|
+
|
|
1991
|
+
##### `optional`<sup>Optional</sup> <a name="optional" id="@alma-cdk/construct-library.PeerDependencyMetaValue.property.optional"></a>
|
|
1992
|
+
|
|
1993
|
+
```typescript
|
|
1994
|
+
public readonly optional: boolean;
|
|
1995
|
+
```
|
|
1996
|
+
|
|
1997
|
+
- *Type:* boolean
|
|
1998
|
+
|
|
1999
|
+
---
|
|
2000
|
+
|
|
2001
|
+
### PeerDependencyRules <a name="PeerDependencyRules" id="@alma-cdk/construct-library.PeerDependencyRules"></a>
|
|
2002
|
+
|
|
2003
|
+
#### Initializer <a name="Initializer" id="@alma-cdk/construct-library.PeerDependencyRules.Initializer"></a>
|
|
2004
|
+
|
|
2005
|
+
```typescript
|
|
2006
|
+
import { PeerDependencyRules } from '@alma-cdk/construct-library'
|
|
2007
|
+
|
|
2008
|
+
const peerDependencyRules: PeerDependencyRules = { ... }
|
|
2009
|
+
```
|
|
2010
|
+
|
|
2011
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2012
|
+
|
|
2013
|
+
| **Name** | **Type** | **Description** |
|
|
2014
|
+
| --- | --- | --- |
|
|
2015
|
+
| <code><a href="#@alma-cdk/construct-library.PeerDependencyRules.property.allowAny">allowAny</a></code> | <code>string[]</code> | *No description.* |
|
|
2016
|
+
| <code><a href="#@alma-cdk/construct-library.PeerDependencyRules.property.allowedVersions">allowedVersions</a></code> | <code>{[ key: string ]: string}</code> | *No description.* |
|
|
2017
|
+
| <code><a href="#@alma-cdk/construct-library.PeerDependencyRules.property.ignoreMissing">ignoreMissing</a></code> | <code>string[]</code> | *No description.* |
|
|
2018
|
+
|
|
2019
|
+
---
|
|
2020
|
+
|
|
2021
|
+
##### `allowAny`<sup>Optional</sup> <a name="allowAny" id="@alma-cdk/construct-library.PeerDependencyRules.property.allowAny"></a>
|
|
2022
|
+
|
|
2023
|
+
```typescript
|
|
2024
|
+
public readonly allowAny: string[];
|
|
2025
|
+
```
|
|
2026
|
+
|
|
2027
|
+
- *Type:* string[]
|
|
2028
|
+
|
|
2029
|
+
---
|
|
2030
|
+
|
|
2031
|
+
##### `allowedVersions`<sup>Optional</sup> <a name="allowedVersions" id="@alma-cdk/construct-library.PeerDependencyRules.property.allowedVersions"></a>
|
|
2032
|
+
|
|
2033
|
+
```typescript
|
|
2034
|
+
public readonly allowedVersions: {[ key: string ]: string};
|
|
2035
|
+
```
|
|
2036
|
+
|
|
2037
|
+
- *Type:* {[ key: string ]: string}
|
|
2038
|
+
|
|
2039
|
+
---
|
|
2040
|
+
|
|
2041
|
+
##### `ignoreMissing`<sup>Optional</sup> <a name="ignoreMissing" id="@alma-cdk/construct-library.PeerDependencyRules.property.ignoreMissing"></a>
|
|
2042
|
+
|
|
2043
|
+
```typescript
|
|
2044
|
+
public readonly ignoreMissing: string[];
|
|
2045
|
+
```
|
|
2046
|
+
|
|
2047
|
+
- *Type:* string[]
|
|
2048
|
+
|
|
2049
|
+
---
|
|
2050
|
+
|
|
2051
|
+
### PnpmWorkspaceSpecification <a name="PnpmWorkspaceSpecification" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification"></a>
|
|
2052
|
+
|
|
2053
|
+
JSON schema for pnpm-workspace.yaml files.
|
|
2054
|
+
|
|
2055
|
+
#### Initializer <a name="Initializer" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.Initializer"></a>
|
|
2056
|
+
|
|
2057
|
+
```typescript
|
|
2058
|
+
import { PnpmWorkspaceSpecification } from '@alma-cdk/construct-library'
|
|
2059
|
+
|
|
2060
|
+
const pnpmWorkspaceSpecification: PnpmWorkspaceSpecification = { ... }
|
|
2061
|
+
```
|
|
2062
|
+
|
|
2063
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2064
|
+
|
|
2065
|
+
| **Name** | **Type** | **Description** |
|
|
2066
|
+
| --- | --- | --- |
|
|
2067
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.allowBuilds">allowBuilds</a></code> | <code>{[ key: string ]: boolean}</code> | A map of package matchers to explicitly allow (`true`) or disallow (`false`) script execution. |
|
|
2068
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.allowedDeprecatedVersions">allowedDeprecatedVersions</a></code> | <code>{[ key: string ]: string}</code> | A list of deprecated versions that the warnings are suppressed. |
|
|
2069
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.allowNonAppliedPatches">allowNonAppliedPatches</a></code> | <code>boolean</code> | When true, installation won't fail if some of the patches from the "patchedDependencies" field were not applied. |
|
|
2070
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.allowUnusedPatches">allowUnusedPatches</a></code> | <code>boolean</code> | When true, installation won't fail if some of the patches from the "patchedDependencies" field were not applied. |
|
|
2071
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.auditConfig">auditConfig</a></code> | <code><a href="#@alma-cdk/construct-library.AuditConfig">AuditConfig</a></code> | *No description.* |
|
|
2072
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.auditLevel">auditLevel</a></code> | <code>string</code> | Controls the level of issues reported by `pnpm audit`. |
|
|
2073
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.autoInstallPeers">autoInstallPeers</a></code> | <code>boolean</code> | When true, any missing non-optional peer dependencies are automatically installed. |
|
|
2074
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.blockExoticSubdeps">blockExoticSubdeps</a></code> | <code>boolean</code> | When set to true, it prevents the resolution of exotic protocols (like git+ssh: or direct https: tarballs) in transitive dependencies. |
|
|
2075
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ca">ca</a></code> | <code>string</code> | The Certificate Authority signing certificate that is trusted for SSL connections to the registry. |
|
|
2076
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.cacheDir">cacheDir</a></code> | <code>string</code> | The location of the cache (package metadata and dlx). |
|
|
2077
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.cafile">cafile</a></code> | <code>string</code> | A path to a file containing one or multiple Certificate Authority signing certificates. |
|
|
2078
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.catalog">catalog</a></code> | <code>{[ key: string ]: string}</code> | *No description.* |
|
|
2079
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.catalogMode">catalogMode</a></code> | <code>string</code> | Controlling if and how dependencies are added to the default catalog. |
|
|
2080
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.catalogs">catalogs</a></code> | <code>{[ key: string ]: {[ key: string ]: string}}</code> | Define arbitrarily named catalogs. |
|
|
2081
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.cert">cert</a></code> | <code>string</code> | A client certificate to pass when accessing the registry. |
|
|
2082
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.childConcurrency">childConcurrency</a></code> | <code>number</code> | The maximum number of child processes to allocate simultaneously to build node_modules. |
|
|
2083
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.cleanupUnusedCatalogs">cleanupUnusedCatalogs</a></code> | <code>boolean</code> | When set to `true`, pnpm will remove unused catalog entries during installation. |
|
|
2084
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.color">color</a></code> | <code>string</code> | Controls colors in the output. |
|
|
2085
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.configDependencies">configDependencies</a></code> | <code>{[ key: string ]: string}</code> | Config dependencies allow you to share and centralize configuration files, settings, and hooks across multiple projects. |
|
|
2086
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.dangerouslyAllowAllBuilds">dangerouslyAllowAllBuilds</a></code> | <code>boolean</code> | If set to true, all build scripts (e.g. preinstall, install, postinstall) from dependencies will run automatically, without requiring approval. |
|
|
2087
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.dedupeDirectDeps">dedupeDirectDeps</a></code> | <code>boolean</code> | When set to true, dependencies that are already symlinked to the root node_modules directory of the workspace will not be symlinked to subproject node_modules directories. |
|
|
2088
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.dedupeInjectedDeps">dedupeInjectedDeps</a></code> | <code>boolean</code> | When this setting is enabled, dependencies that are injected will be symlinked from the workspace whenever possible. |
|
|
2089
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.dedupePeerDependents">dedupePeerDependents</a></code> | <code>boolean</code> | When this setting is set to true, packages with peer dependencies will be deduplicated after peers resolution. |
|
|
2090
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.deployAllFiles">deployAllFiles</a></code> | <code>boolean</code> | When deploying a package or installing a local package, all files of the package are copied. |
|
|
2091
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.disallowWorkspaceCycles">disallowWorkspaceCycles</a></code> | <code>boolean</code> | When set to true, installation will fail if the workspace has cycles. |
|
|
2092
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.dlxCacheMaxAge">dlxCacheMaxAge</a></code> | <code>number</code> | The time in minutes after which dlx cache expires. |
|
|
2093
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.enableGlobalVirtualStore">enableGlobalVirtualStore</a></code> | <code>boolean</code> | When enabled, node_modules contains only symlinks to a central virtual store, rather than to node_modules/.pnpm. |
|
|
2094
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.enableModulesDir">enableModulesDir</a></code> | <code>boolean</code> | When false, pnpm will not write any files to the modules directory (node_modules). |
|
|
2095
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.enablePrePostScripts">enablePrePostScripts</a></code> | <code>boolean</code> | When true, pnpm will run any pre/post scripts automatically. |
|
|
2096
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.engineStrict">engineStrict</a></code> | <code>boolean</code> | If this is enabled, pnpm will not install any package that claims to not be compatible with the current Node version. |
|
|
2097
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.executionEnv">executionEnv</a></code> | <code><a href="#@alma-cdk/construct-library.ExecutionEnv">ExecutionEnv</a></code> | *No description.* |
|
|
2098
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.extendNodePath">extendNodePath</a></code> | <code>boolean</code> | When false, the NODE_PATH environment variable is not set in the command shims. |
|
|
2099
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.failIfNoMatch">failIfNoMatch</a></code> | <code>boolean</code> | If true, pnpm will fail if no packages match the filter. |
|
|
2100
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.fetchRetries">fetchRetries</a></code> | <code>number</code> | How many times to retry if pnpm fails to fetch from the registry. |
|
|
2101
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.fetchRetryFactor">fetchRetryFactor</a></code> | <code>number</code> | The exponential factor for retry backoff. |
|
|
2102
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.fetchRetryMaxtimeout">fetchRetryMaxtimeout</a></code> | <code>number</code> | The maximum fallback timeout to ensure the retry factor does not make requests too long. |
|
|
2103
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.fetchRetryMintimeout">fetchRetryMintimeout</a></code> | <code>number</code> | The minimum (base) timeout for retrying requests. |
|
|
2104
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.fetchTimeout">fetchTimeout</a></code> | <code>number</code> | The maximum amount of time to wait for HTTP requests to complete. |
|
|
2105
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.forceLegacyDeploy">forceLegacyDeploy</a></code> | <code>boolean</code> | By default, pnpm deploy will try creating a dedicated lockfile from a shared lockfile for deployment. |
|
|
2106
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.gitBranchLockfile">gitBranchLockfile</a></code> | <code>boolean</code> | When set to true, the generated lockfile name after installation will be named based on the current branch name to completely avoid merge conflicts. |
|
|
2107
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.gitChecks">gitChecks</a></code> | <code>boolean</code> | Check if current branch is your publish branch, clean, and up-to-date with remote. |
|
|
2108
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.gitShallowHosts">gitShallowHosts</a></code> | <code>string[]</code> | When fetching dependencies that are Git repositories, if the host is listed in this setting, pnpm will use shallow cloning to fetch only the needed commit, not all the history. |
|
|
2109
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.globalBinDir">globalBinDir</a></code> | <code>string</code> | Allows to set the target directory for the bin files of globally installed packages. |
|
|
2110
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.globalDir">globalDir</a></code> | <code>string</code> | Specify a custom directory to store global packages. |
|
|
2111
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.globalPnpmfile">globalPnpmfile</a></code> | <code>string</code> | The location of a global pnpmfile. |
|
|
2112
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.hoist">hoist</a></code> | <code>boolean</code> | When true, all dependencies are hoisted to node_modules/.pnpm/node_modules. |
|
|
2113
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.hoistPattern">hoistPattern</a></code> | <code>string[]</code> | Tells pnpm which packages should be hoisted to node_modules/.pnpm/node_modules. |
|
|
2114
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.hoistWorkspacePackages">hoistWorkspacePackages</a></code> | <code>boolean</code> | When true, packages from the workspaces are symlinked to either <workspace_root>/node_modules/.pnpm/node_modules or to <workspace_root>/node_modules depending on other hoisting settings (hoistPattern and publicHoistPattern). |
|
|
2115
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.httpsProxy">httpsProxy</a></code> | <code>string</code> | A proxy to use for outgoing HTTPS requests. |
|
|
2116
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoreCompatibilityDb">ignoreCompatibilityDb</a></code> | <code>boolean</code> | During installation the dependencies of some packages are automatically patched. |
|
|
2117
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoredBuiltDependencies">ignoredBuiltDependencies</a></code> | <code>string[]</code> | A list of package names that should not be built during installation. |
|
|
2118
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoreDepScripts">ignoreDepScripts</a></code> | <code>boolean</code> | Do not execute any scripts of the installed packages. |
|
|
2119
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoredOptionalDependencies">ignoredOptionalDependencies</a></code> | <code>string[]</code> | A list of optional dependencies that the install should be skipped. |
|
|
2120
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignorePatchFailures">ignorePatchFailures</a></code> | <code>boolean</code> | Default is undefined. |
|
|
2121
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignorePnpmfile">ignorePnpmfile</a></code> | <code>boolean</code> | .pnpmfile.cjs will be ignored. Useful together with --ignore-scripts when you want to make sure that no script gets executed during install. |
|
|
2122
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoreScripts">ignoreScripts</a></code> | <code>boolean</code> | Do not execute any scripts defined in the project package.json and its dependencies. |
|
|
2123
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoreWorkspaceCycles">ignoreWorkspaceCycles</a></code> | <code>boolean</code> | When set to true, no workspace cycle warnings will be printed. |
|
|
2124
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoreWorkspaceRootCheck">ignoreWorkspaceRootCheck</a></code> | <code>boolean</code> | Adding a new dependency to the root workspace package fails, unless the --ignore-workspace-root-check or -w flag is used. |
|
|
2125
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.includeWorkspaceRoot">includeWorkspaceRoot</a></code> | <code>boolean</code> | When executing commands recursively in a workspace, execute them on the root workspace project as well. |
|
|
2126
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.injectWorkspacePackages">injectWorkspacePackages</a></code> | <code>boolean</code> | Enables hard-linking of all local workspace dependencies instead of symlinking them. |
|
|
2127
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.key">key</a></code> | <code>string</code> | A client key to pass when accessing the registry. |
|
|
2128
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.linkWorkspacePackages">linkWorkspacePackages</a></code> | <code>boolean \| string</code> | If this is enabled, locally available packages are linked to node_modules instead of being downloaded from the registry. |
|
|
2129
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.localAddress">localAddress</a></code> | <code>string</code> | The IP address of the local interface to use when making connections to the npm registry. |
|
|
2130
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.lockfile">lockfile</a></code> | <code>boolean</code> | When set to false, pnpm won't read or generate a pnpm-lock.yaml file. |
|
|
2131
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.lockfileIncludeTarballUrl">lockfileIncludeTarballUrl</a></code> | <code>boolean</code> | Add the full URL to the package's tarball to every entry in pnpm-lock.yaml. |
|
|
2132
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.loglevel">loglevel</a></code> | <code>string</code> | Any logs at or higher than the given level will be shown. |
|
|
2133
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.managePackageManagerVersions">managePackageManagerVersions</a></code> | <code>boolean</code> | When enabled, pnpm will automatically download and run the version of pnpm specified in the packageManager field of package.json. |
|
|
2134
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.maxsockets">maxsockets</a></code> | <code>number</code> | The maximum number of connections to use per origin (protocol/host/port combination). |
|
|
2135
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.mergeGitBranchLockfilesBranchPattern">mergeGitBranchLockfilesBranchPattern</a></code> | <code>string[]</code> | This configuration matches the current branch name to determine whether to merge all git branch lockfile files. |
|
|
2136
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.minimumReleaseAge">minimumReleaseAge</a></code> | <code>number</code> | minimumReleaseAge defines the minimum number of minutes that must pass after a version is published before pnpm will install it. |
|
|
2137
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.minimumReleaseAgeExclude">minimumReleaseAgeExclude</a></code> | <code>string[]</code> | If you set `minimumReleaseAge` but need certain dependencies to always install the newest version immediately, you can list them under `minimumReleaseAgeExclude`. |
|
|
2138
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.modulesCacheMaxAge">modulesCacheMaxAge</a></code> | <code>number</code> | The time in minutes after which orphan packages from the modules directory should be removed. |
|
|
2139
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.modulesDir">modulesDir</a></code> | <code>string</code> | The directory in which dependencies will be installed (instead of node_modules). |
|
|
2140
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.networkConcurrency">networkConcurrency</a></code> | <code>number</code> | Controls the maximum number of HTTP(S) requests to process simultaneously. |
|
|
2141
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.neverBuiltDependencies">neverBuiltDependencies</a></code> | <code>string[]</code> | A list of dependencies to run builds for. |
|
|
2142
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.nodeLinker">nodeLinker</a></code> | <code>string</code> | Defines what linker should be used for installing Node packages. |
|
|
2143
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.nodeOptions">nodeOptions</a></code> | <code>string</code> | Options to pass through to Node.js via the NODE_OPTIONS environment variable. |
|
|
2144
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.nodeVersion">nodeVersion</a></code> | <code>string</code> | The Node.js version to use when checking a package's engines setting. |
|
|
2145
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.noproxy">noproxy</a></code> | <code>string</code> | A comma-separated string of domain extensions that a proxy should not be used for. |
|
|
2146
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.npmPath">npmPath</a></code> | <code>string</code> | The location of the npm binary that pnpm uses for some actions, like publishing. |
|
|
2147
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.onlyBuiltDependencies">onlyBuiltDependencies</a></code> | <code>string[]</code> | A list of package names that are allowed to be executed during installation. |
|
|
2148
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.onlyBuiltDependenciesFile">onlyBuiltDependenciesFile</a></code> | <code>string</code> | Specifies a JSON file that lists the only packages permitted to run installation scripts during the pnpm install process. |
|
|
2149
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.optimisticRepeatInstall">optimisticRepeatInstall</a></code> | <code>boolean</code> | When enabled, a fast check will be performed before proceeding to installation. |
|
|
2150
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.overrides">overrides</a></code> | <code>{[ key: string ]: string}</code> | Used to override any dependency in the dependency graph. |
|
|
2151
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.packageExtensions">packageExtensions</a></code> | <code>{[ key: string ]: <a href="#@alma-cdk/construct-library.PackageExtension">PackageExtension</a>}</code> | Used to extend the existing package definitions with additional information. |
|
|
2152
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.packageImportMethod">packageImportMethod</a></code> | <code>string</code> | Controls the way packages are imported from the store (if you want to disable symlinks inside node_modules, then you need to change the nodeLinker setting, not this one). |
|
|
2153
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.packageManagerStrict">packageManagerStrict</a></code> | <code>boolean</code> | If this setting is disabled, pnpm will not fail if a different package manager is specified in the packageManager field of package.json. When enabled, only the package name is checked (since pnpm v9.2.0), so you can still run any version of pnpm regardless of the version specified in the packageManager field. |
|
|
2154
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.packageManagerStrictVersion">packageManagerStrictVersion</a></code> | <code>boolean</code> | When enabled, pnpm will fail if its version doesn't exactly match the version specified in the packageManager field of package.json. |
|
|
2155
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.packages">packages</a></code> | <code>string[]</code> | Workspace package paths. |
|
|
2156
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.patchedDependencies">patchedDependencies</a></code> | <code>{[ key: string ]: string}</code> | A list of dependencies that are patched. |
|
|
2157
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.patchesDir">patchesDir</a></code> | <code>string</code> | The generated patch file will be saved to this directory. |
|
|
2158
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.peerDependencyRules">peerDependencyRules</a></code> | <code><a href="#@alma-cdk/construct-library.PeerDependencyRules">PeerDependencyRules</a></code> | *No description.* |
|
|
2159
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.peersSuffixMaxLength">peersSuffixMaxLength</a></code> | <code>number</code> | Max length of the peer IDs suffix added to dependency keys in the lockfile. |
|
|
2160
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.pnpmfile">pnpmfile</a></code> | <code>string</code> | The location of the local pnpmfile. |
|
|
2161
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.preferFrozenLockfile">preferFrozenLockfile</a></code> | <code>boolean</code> | When set to true and the available pnpm-lock.yaml satisfies the package.json dependencies directive, a headless installation is performed. |
|
|
2162
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.preferOffline">preferOffline</a></code> | <code>boolean</code> | Bypass staleness checks for cached data. |
|
|
2163
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.preferSymlinkedExecutables">preferSymlinkedExecutables</a></code> | <code>boolean</code> | Create symlinks to executables in node_modules/.bin instead of command shims. This setting is ignored on Windows, where only command shims work. |
|
|
2164
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.preferWorkspacePackages">preferWorkspacePackages</a></code> | <code>boolean</code> | If this is enabled, local packages from the workspace are preferred over packages from the registry, even if there is a newer version of the package in the registry. |
|
|
2165
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.proxy">proxy</a></code> | <code>string</code> | A proxy to use for outgoing http requests. |
|
|
2166
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.publicHoistPattern">publicHoistPattern</a></code> | <code>string[]</code> | Unlike hoistPattern, which hoists dependencies to a hidden modules directory inside the virtual store, publicHoistPattern hoists dependencies matching the pattern to the root modules directory. |
|
|
2167
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.publishBranch">publishBranch</a></code> | <code>string</code> | The primary branch of the repository which is used for publishing the latest changes. |
|
|
2168
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.recursiveInstall">recursiveInstall</a></code> | <code>boolean</code> | If this is enabled, the primary behaviour of pnpm install becomes that of pnpm install -r, meaning the install is performed on all workspace or subdirectory packages. |
|
|
2169
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.registry">registry</a></code> | <code>string</code> | The base URL of the npm package registry (trailing slash included). |
|
|
2170
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.registrySupportsTimeField">registrySupportsTimeField</a></code> | <code>boolean</code> | Set this to true if the registry that you are using returns the "time" field in the abbreviated metadata. |
|
|
2171
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.requiredScripts">requiredScripts</a></code> | <code>string[]</code> | A list of scripts that must exist in each project. |
|
|
2172
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.resolutionMode">resolutionMode</a></code> | <code>string</code> | Determines how pnpm resolves dependencies, See https://pnpm.io/settings#resolutionmode. |
|
|
2173
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.resolvePeersFromWorkspaceRoot">resolvePeersFromWorkspaceRoot</a></code> | <code>boolean</code> | When enabled, dependencies of the root workspace project are used to resolve peer dependencies of any projects in the workspace. |
|
|
2174
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.saveExact">saveExact</a></code> | <code>boolean</code> | Saved dependencies will be configured with an exact version rather than using pnpm's default semver range operator. |
|
|
2175
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.savePrefix">savePrefix</a></code> | <code>string</code> | Configure how versions of packages installed to a package.json file get prefixed. |
|
|
2176
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.saveWorkspaceProtocol">saveWorkspaceProtocol</a></code> | <code>boolean \| string</code> | This setting controls how dependencies that are linked from the workspace are added to package.json. |
|
|
2177
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.scriptShell">scriptShell</a></code> | <code>string</code> | The shell to use for scripts run with the pnpm run command. |
|
|
2178
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.shamefullyHoist">shamefullyHoist</a></code> | <code>boolean</code> | By default, pnpm creates a semistrict node_modules, meaning dependencies have access to undeclared dependencies but modules outside of node_modules do not. |
|
|
2179
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.sharedWorkspaceLockfile">sharedWorkspaceLockfile</a></code> | <code>boolean</code> | If this is enabled, pnpm creates a single pnpm-lock.yaml file in the root of the workspace. |
|
|
2180
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.shellEmulator">shellEmulator</a></code> | <code>boolean</code> | When true, pnpm will use a JavaScript implementation of a bash-like shell to execute scripts. |
|
|
2181
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.sideEffectsCache">sideEffectsCache</a></code> | <code>boolean</code> | Use and cache the results of (pre/post)install hooks. |
|
|
2182
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.sideEffectsCacheReadonly">sideEffectsCacheReadonly</a></code> | <code>boolean</code> | Only use the side effects cache if present, do not create it for new packages. |
|
|
2183
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.stateDir">stateDir</a></code> | <code>string</code> | The location where all the packages are saved on the disk. |
|
|
2184
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.storeDir">storeDir</a></code> | <code>string</code> | The location where all the packages are saved on the disk. |
|
|
2185
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.strictDepBuilds">strictDepBuilds</a></code> | <code>boolean</code> | When strictDepBuilds is enabled, the installation will exit with a non-zero exit code if any dependencies have unreviewed build scripts (aka postinstall scripts). |
|
|
2186
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.strictPeerDependencies">strictPeerDependencies</a></code> | <code>boolean</code> | If this is enabled, commands will fail if there is a missing or invalid peer dependency in the tree. |
|
|
2187
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.strictSsl">strictSsl</a></code> | <code>boolean</code> | Whether or not to do SSL key validation when making requests to the registry via HTTPS. |
|
|
2188
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.strictStorePkgContentCheck">strictStorePkgContentCheck</a></code> | <code>boolean</code> | Some registries allow the exact same content to be published under different package names and/or versions. |
|
|
2189
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.supportedArchitectures">supportedArchitectures</a></code> | <code><a href="#@alma-cdk/construct-library.SupportedArchitectures">SupportedArchitectures</a></code> | Specifies architectures for which you'd like to install optional dependencies, even if they don't match the architecture of the system running the install. |
|
|
2190
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.symlink">symlink</a></code> | <code>boolean</code> | When symlink is set to false, pnpm creates a virtual store directory without any symlinks. |
|
|
2191
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.syncInjectedDepsAfterScripts">syncInjectedDepsAfterScripts</a></code> | <code>string[]</code> | Injected workspace dependencies are collections of hardlinks, which don't add or remove the files when their sources change. |
|
|
2192
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.tag">tag</a></code> | <code>string</code> | If you pnpm add a package and you don't provide a specific version, then it will install the package at the version registered under the tag from this setting. |
|
|
2193
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.trustPolicy">trustPolicy</a></code> | <code>string</code> | When set to no-downgrade, pnpm will fail if a package's trust level has decreased compared to previous releases. |
|
|
2194
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.trustPolicyExclude">trustPolicyExclude</a></code> | <code>string[]</code> | You can now list one or more specific packages or versions that pnpm should allow to install, even if those packages don't satisfy the trust policy requirement. |
|
|
2195
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.trustPolicyIgnoreAfter">trustPolicyIgnoreAfter</a></code> | <code>number</code> | Allows ignoring the trust policy check for packages published more than the specified number of minutes ago. |
|
|
2196
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.unsafePerm">unsafePerm</a></code> | <code>boolean</code> | Set to true to enable UID/GID switching when running package scripts. |
|
|
2197
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.updateConfig">updateConfig</a></code> | <code><a href="#@alma-cdk/construct-library.UpdateConfig">UpdateConfig</a></code> | *No description.* |
|
|
2198
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.updateNotifier">updateNotifier</a></code> | <code>boolean</code> | When true, pnpm will check for updates to the installed packages and notify the user. |
|
|
2199
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.useBetaCli">useBetaCli</a></code> | <code>boolean</code> | Experimental option that enables beta features of the CLI. |
|
|
2200
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.useNodeVersion">useNodeVersion</a></code> | <code>string</code> | Specifies which exact Node.js version should be used for the project's runtime. |
|
|
2201
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.useStderr">useStderr</a></code> | <code>boolean</code> | When true, all the output is written to stderr. |
|
|
2202
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.verifyDepsBeforeRun">verifyDepsBeforeRun</a></code> | <code>boolean \| string</code> | This setting allows the checking of the state of dependencies before running scripts. |
|
|
2203
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.verifyStoreIntegrity">verifyStoreIntegrity</a></code> | <code>boolean</code> | By default, if a file in the store has been modified, the content of this file is checked before linking it to a project's node_modules. |
|
|
2204
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.virtualStoreDir">virtualStoreDir</a></code> | <code>string</code> | The directory with links to the store. |
|
|
2205
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.virtualStoreDirMaxLength">virtualStoreDirMaxLength</a></code> | <code>number</code> | Sets the maximum allowed length of directory names inside the virtual store directory (node_modules/.pnpm). |
|
|
2206
|
+
| <code><a href="#@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.workspaceConcurrency">workspaceConcurrency</a></code> | <code>number</code> | Set the maximum number of tasks to run simultaneously. |
|
|
2207
|
+
|
|
2208
|
+
---
|
|
2209
|
+
|
|
2210
|
+
##### `allowBuilds`<sup>Optional</sup> <a name="allowBuilds" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.allowBuilds"></a>
|
|
2211
|
+
|
|
2212
|
+
```typescript
|
|
2213
|
+
public readonly allowBuilds: {[ key: string ]: boolean};
|
|
2214
|
+
```
|
|
2215
|
+
|
|
2216
|
+
- *Type:* {[ key: string ]: boolean}
|
|
2217
|
+
|
|
2218
|
+
A map of package matchers to explicitly allow (`true`) or disallow (`false`) script execution.
|
|
2219
|
+
|
|
2220
|
+
This field replaces `onlyBuiltDependencies` and `ignoredBuiltDependencies` (which are also deprecated by this new setting), providing a single source of truth.
|
|
2221
|
+
|
|
2222
|
+
---
|
|
2223
|
+
|
|
2224
|
+
##### `allowedDeprecatedVersions`<sup>Optional</sup> <a name="allowedDeprecatedVersions" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.allowedDeprecatedVersions"></a>
|
|
2225
|
+
|
|
2226
|
+
```typescript
|
|
2227
|
+
public readonly allowedDeprecatedVersions: {[ key: string ]: string};
|
|
2228
|
+
```
|
|
2229
|
+
|
|
2230
|
+
- *Type:* {[ key: string ]: string}
|
|
2231
|
+
|
|
2232
|
+
A list of deprecated versions that the warnings are suppressed.
|
|
2233
|
+
|
|
2234
|
+
---
|
|
2235
|
+
|
|
2236
|
+
##### `allowNonAppliedPatches`<sup>Optional</sup> <a name="allowNonAppliedPatches" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.allowNonAppliedPatches"></a>
|
|
2237
|
+
|
|
2238
|
+
```typescript
|
|
2239
|
+
public readonly allowNonAppliedPatches: boolean;
|
|
2240
|
+
```
|
|
2241
|
+
|
|
2242
|
+
- *Type:* boolean
|
|
2243
|
+
|
|
2244
|
+
When true, installation won't fail if some of the patches from the "patchedDependencies" field were not applied.
|
|
2245
|
+
|
|
2246
|
+
---
|
|
2247
|
+
|
|
2248
|
+
##### `allowUnusedPatches`<sup>Optional</sup> <a name="allowUnusedPatches" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.allowUnusedPatches"></a>
|
|
2249
|
+
|
|
2250
|
+
```typescript
|
|
2251
|
+
public readonly allowUnusedPatches: boolean;
|
|
2252
|
+
```
|
|
2253
|
+
|
|
2254
|
+
- *Type:* boolean
|
|
2255
|
+
|
|
2256
|
+
When true, installation won't fail if some of the patches from the "patchedDependencies" field were not applied.
|
|
2257
|
+
|
|
2258
|
+
(Previously named "allowNonAppliedPatches")
|
|
2259
|
+
|
|
2260
|
+
---
|
|
2261
|
+
|
|
2262
|
+
##### `auditConfig`<sup>Optional</sup> <a name="auditConfig" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.auditConfig"></a>
|
|
2263
|
+
|
|
2264
|
+
```typescript
|
|
2265
|
+
public readonly auditConfig: AuditConfig;
|
|
2266
|
+
```
|
|
2267
|
+
|
|
2268
|
+
- *Type:* <a href="#@alma-cdk/construct-library.AuditConfig">AuditConfig</a>
|
|
2269
|
+
|
|
2270
|
+
---
|
|
2271
|
+
|
|
2272
|
+
##### `auditLevel`<sup>Optional</sup> <a name="auditLevel" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.auditLevel"></a>
|
|
2273
|
+
|
|
2274
|
+
```typescript
|
|
2275
|
+
public readonly auditLevel: string;
|
|
2276
|
+
```
|
|
2277
|
+
|
|
2278
|
+
- *Type:* string
|
|
2279
|
+
|
|
2280
|
+
Controls the level of issues reported by `pnpm audit`.
|
|
2281
|
+
|
|
2282
|
+
When set to 'low', all vulnerabilities are reported. When set to 'moderate', 'high', or 'critical', only vulnerabilities with that severity or higher are reported.
|
|
2283
|
+
|
|
2284
|
+
---
|
|
2285
|
+
|
|
2286
|
+
##### `autoInstallPeers`<sup>Optional</sup> <a name="autoInstallPeers" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.autoInstallPeers"></a>
|
|
2287
|
+
|
|
2288
|
+
```typescript
|
|
2289
|
+
public readonly autoInstallPeers: boolean;
|
|
2290
|
+
```
|
|
2291
|
+
|
|
2292
|
+
- *Type:* boolean
|
|
2293
|
+
|
|
2294
|
+
When true, any missing non-optional peer dependencies are automatically installed.
|
|
2295
|
+
|
|
2296
|
+
---
|
|
2297
|
+
|
|
2298
|
+
##### `blockExoticSubdeps`<sup>Optional</sup> <a name="blockExoticSubdeps" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.blockExoticSubdeps"></a>
|
|
2299
|
+
|
|
2300
|
+
```typescript
|
|
2301
|
+
public readonly blockExoticSubdeps: boolean;
|
|
2302
|
+
```
|
|
2303
|
+
|
|
2304
|
+
- *Type:* boolean
|
|
2305
|
+
|
|
2306
|
+
When set to true, it prevents the resolution of exotic protocols (like git+ssh: or direct https: tarballs) in transitive dependencies.
|
|
2307
|
+
|
|
2308
|
+
Only direct dependencies are allowed to use exotic sources.
|
|
2309
|
+
|
|
2310
|
+
---
|
|
2311
|
+
|
|
2312
|
+
##### `ca`<sup>Optional</sup> <a name="ca" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ca"></a>
|
|
2313
|
+
|
|
2314
|
+
```typescript
|
|
2315
|
+
public readonly ca: string;
|
|
2316
|
+
```
|
|
2317
|
+
|
|
2318
|
+
- *Type:* string
|
|
2319
|
+
|
|
2320
|
+
The Certificate Authority signing certificate that is trusted for SSL connections to the registry.
|
|
2321
|
+
|
|
2322
|
+
---
|
|
2323
|
+
|
|
2324
|
+
##### `cacheDir`<sup>Optional</sup> <a name="cacheDir" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.cacheDir"></a>
|
|
2325
|
+
|
|
2326
|
+
```typescript
|
|
2327
|
+
public readonly cacheDir: string;
|
|
2328
|
+
```
|
|
2329
|
+
|
|
2330
|
+
- *Type:* string
|
|
2331
|
+
|
|
2332
|
+
The location of the cache (package metadata and dlx).
|
|
2333
|
+
|
|
2334
|
+
---
|
|
2335
|
+
|
|
2336
|
+
##### `cafile`<sup>Optional</sup> <a name="cafile" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.cafile"></a>
|
|
2337
|
+
|
|
2338
|
+
```typescript
|
|
2339
|
+
public readonly cafile: string;
|
|
2340
|
+
```
|
|
2341
|
+
|
|
2342
|
+
- *Type:* string
|
|
2343
|
+
|
|
2344
|
+
A path to a file containing one or multiple Certificate Authority signing certificates.
|
|
2345
|
+
|
|
2346
|
+
---
|
|
2347
|
+
|
|
2348
|
+
##### `catalog`<sup>Optional</sup> <a name="catalog" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.catalog"></a>
|
|
2349
|
+
|
|
2350
|
+
```typescript
|
|
2351
|
+
public readonly catalog: {[ key: string ]: string};
|
|
2352
|
+
```
|
|
2353
|
+
|
|
2354
|
+
- *Type:* {[ key: string ]: string}
|
|
2355
|
+
|
|
2356
|
+
---
|
|
2357
|
+
|
|
2358
|
+
##### `catalogMode`<sup>Optional</sup> <a name="catalogMode" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.catalogMode"></a>
|
|
2359
|
+
|
|
2360
|
+
```typescript
|
|
2361
|
+
public readonly catalogMode: string;
|
|
2362
|
+
```
|
|
2363
|
+
|
|
2364
|
+
- *Type:* string
|
|
2365
|
+
|
|
2366
|
+
Controlling if and how dependencies are added to the default catalog.
|
|
2367
|
+
|
|
2368
|
+
---
|
|
2369
|
+
|
|
2370
|
+
##### `catalogs`<sup>Optional</sup> <a name="catalogs" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.catalogs"></a>
|
|
2371
|
+
|
|
2372
|
+
```typescript
|
|
2373
|
+
public readonly catalogs: {[ key: string ]: {[ key: string ]: string}};
|
|
2374
|
+
```
|
|
2375
|
+
|
|
2376
|
+
- *Type:* {[ key: string ]: {[ key: string ]: string}}
|
|
2377
|
+
|
|
2378
|
+
Define arbitrarily named catalogs.
|
|
2379
|
+
|
|
2380
|
+
---
|
|
2381
|
+
|
|
2382
|
+
##### `cert`<sup>Optional</sup> <a name="cert" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.cert"></a>
|
|
2383
|
+
|
|
2384
|
+
```typescript
|
|
2385
|
+
public readonly cert: string;
|
|
2386
|
+
```
|
|
2387
|
+
|
|
2388
|
+
- *Type:* string
|
|
2389
|
+
|
|
2390
|
+
A client certificate to pass when accessing the registry.
|
|
2391
|
+
|
|
2392
|
+
---
|
|
2393
|
+
|
|
2394
|
+
##### `childConcurrency`<sup>Optional</sup> <a name="childConcurrency" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.childConcurrency"></a>
|
|
2395
|
+
|
|
2396
|
+
```typescript
|
|
2397
|
+
public readonly childConcurrency: number;
|
|
2398
|
+
```
|
|
2399
|
+
|
|
2400
|
+
- *Type:* number
|
|
2401
|
+
|
|
2402
|
+
The maximum number of child processes to allocate simultaneously to build node_modules.
|
|
2403
|
+
|
|
2404
|
+
---
|
|
2405
|
+
|
|
2406
|
+
##### `cleanupUnusedCatalogs`<sup>Optional</sup> <a name="cleanupUnusedCatalogs" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.cleanupUnusedCatalogs"></a>
|
|
2407
|
+
|
|
2408
|
+
```typescript
|
|
2409
|
+
public readonly cleanupUnusedCatalogs: boolean;
|
|
2410
|
+
```
|
|
2411
|
+
|
|
2412
|
+
- *Type:* boolean
|
|
2413
|
+
|
|
2414
|
+
When set to `true`, pnpm will remove unused catalog entries during installation.
|
|
2415
|
+
|
|
2416
|
+
---
|
|
2417
|
+
|
|
2418
|
+
##### `color`<sup>Optional</sup> <a name="color" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.color"></a>
|
|
2419
|
+
|
|
2420
|
+
```typescript
|
|
2421
|
+
public readonly color: string;
|
|
2422
|
+
```
|
|
2423
|
+
|
|
2424
|
+
- *Type:* string
|
|
2425
|
+
|
|
2426
|
+
Controls colors in the output.
|
|
2427
|
+
|
|
2428
|
+
---
|
|
2429
|
+
|
|
2430
|
+
##### `configDependencies`<sup>Optional</sup> <a name="configDependencies" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.configDependencies"></a>
|
|
2431
|
+
|
|
2432
|
+
```typescript
|
|
2433
|
+
public readonly configDependencies: {[ key: string ]: string};
|
|
2434
|
+
```
|
|
2435
|
+
|
|
2436
|
+
- *Type:* {[ key: string ]: string}
|
|
2437
|
+
|
|
2438
|
+
Config dependencies allow you to share and centralize configuration files, settings, and hooks across multiple projects.
|
|
2439
|
+
|
|
2440
|
+
They are installed before all regular dependencies ('dependencies', 'devDependencies', 'optionalDependencies'), making them ideal for setting up custom hooks, patches, and catalog entries.
|
|
2441
|
+
|
|
2442
|
+
---
|
|
2443
|
+
|
|
2444
|
+
##### `dangerouslyAllowAllBuilds`<sup>Optional</sup> <a name="dangerouslyAllowAllBuilds" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.dangerouslyAllowAllBuilds"></a>
|
|
2445
|
+
|
|
2446
|
+
```typescript
|
|
2447
|
+
public readonly dangerouslyAllowAllBuilds: boolean;
|
|
2448
|
+
```
|
|
2449
|
+
|
|
2450
|
+
- *Type:* boolean
|
|
2451
|
+
|
|
2452
|
+
If set to true, all build scripts (e.g. preinstall, install, postinstall) from dependencies will run automatically, without requiring approval.
|
|
2453
|
+
|
|
2454
|
+
---
|
|
2455
|
+
|
|
2456
|
+
##### `dedupeDirectDeps`<sup>Optional</sup> <a name="dedupeDirectDeps" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.dedupeDirectDeps"></a>
|
|
2457
|
+
|
|
2458
|
+
```typescript
|
|
2459
|
+
public readonly dedupeDirectDeps: boolean;
|
|
2460
|
+
```
|
|
2461
|
+
|
|
2462
|
+
- *Type:* boolean
|
|
2463
|
+
|
|
2464
|
+
When set to true, dependencies that are already symlinked to the root node_modules directory of the workspace will not be symlinked to subproject node_modules directories.
|
|
2465
|
+
|
|
2466
|
+
---
|
|
2467
|
+
|
|
2468
|
+
##### `dedupeInjectedDeps`<sup>Optional</sup> <a name="dedupeInjectedDeps" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.dedupeInjectedDeps"></a>
|
|
2469
|
+
|
|
2470
|
+
```typescript
|
|
2471
|
+
public readonly dedupeInjectedDeps: boolean;
|
|
2472
|
+
```
|
|
2473
|
+
|
|
2474
|
+
- *Type:* boolean
|
|
2475
|
+
|
|
2476
|
+
When this setting is enabled, dependencies that are injected will be symlinked from the workspace whenever possible.
|
|
2477
|
+
|
|
2478
|
+
---
|
|
2479
|
+
|
|
2480
|
+
##### `dedupePeerDependents`<sup>Optional</sup> <a name="dedupePeerDependents" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.dedupePeerDependents"></a>
|
|
2481
|
+
|
|
2482
|
+
```typescript
|
|
2483
|
+
public readonly dedupePeerDependents: boolean;
|
|
2484
|
+
```
|
|
2485
|
+
|
|
2486
|
+
- *Type:* boolean
|
|
2487
|
+
|
|
2488
|
+
When this setting is set to true, packages with peer dependencies will be deduplicated after peers resolution.
|
|
2489
|
+
|
|
2490
|
+
---
|
|
2491
|
+
|
|
2492
|
+
##### `deployAllFiles`<sup>Optional</sup> <a name="deployAllFiles" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.deployAllFiles"></a>
|
|
2493
|
+
|
|
2494
|
+
```typescript
|
|
2495
|
+
public readonly deployAllFiles: boolean;
|
|
2496
|
+
```
|
|
2497
|
+
|
|
2498
|
+
- *Type:* boolean
|
|
2499
|
+
|
|
2500
|
+
When deploying a package or installing a local package, all files of the package are copied.
|
|
2501
|
+
|
|
2502
|
+
---
|
|
2503
|
+
|
|
2504
|
+
##### `disallowWorkspaceCycles`<sup>Optional</sup> <a name="disallowWorkspaceCycles" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.disallowWorkspaceCycles"></a>
|
|
2505
|
+
|
|
2506
|
+
```typescript
|
|
2507
|
+
public readonly disallowWorkspaceCycles: boolean;
|
|
2508
|
+
```
|
|
2509
|
+
|
|
2510
|
+
- *Type:* boolean
|
|
2511
|
+
|
|
2512
|
+
When set to true, installation will fail if the workspace has cycles.
|
|
2513
|
+
|
|
2514
|
+
---
|
|
2515
|
+
|
|
2516
|
+
##### `dlxCacheMaxAge`<sup>Optional</sup> <a name="dlxCacheMaxAge" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.dlxCacheMaxAge"></a>
|
|
2517
|
+
|
|
2518
|
+
```typescript
|
|
2519
|
+
public readonly dlxCacheMaxAge: number;
|
|
2520
|
+
```
|
|
2521
|
+
|
|
2522
|
+
- *Type:* number
|
|
2523
|
+
|
|
2524
|
+
The time in minutes after which dlx cache expires.
|
|
2525
|
+
|
|
2526
|
+
---
|
|
2527
|
+
|
|
2528
|
+
##### `enableGlobalVirtualStore`<sup>Optional</sup> <a name="enableGlobalVirtualStore" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.enableGlobalVirtualStore"></a>
|
|
2529
|
+
|
|
2530
|
+
```typescript
|
|
2531
|
+
public readonly enableGlobalVirtualStore: boolean;
|
|
2532
|
+
```
|
|
2533
|
+
|
|
2534
|
+
- *Type:* boolean
|
|
2535
|
+
|
|
2536
|
+
When enabled, node_modules contains only symlinks to a central virtual store, rather than to node_modules/.pnpm.
|
|
2537
|
+
|
|
2538
|
+
---
|
|
2539
|
+
|
|
2540
|
+
##### `enableModulesDir`<sup>Optional</sup> <a name="enableModulesDir" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.enableModulesDir"></a>
|
|
2541
|
+
|
|
2542
|
+
```typescript
|
|
2543
|
+
public readonly enableModulesDir: boolean;
|
|
2544
|
+
```
|
|
2545
|
+
|
|
2546
|
+
- *Type:* boolean
|
|
2547
|
+
|
|
2548
|
+
When false, pnpm will not write any files to the modules directory (node_modules).
|
|
2549
|
+
|
|
2550
|
+
---
|
|
2551
|
+
|
|
2552
|
+
##### `enablePrePostScripts`<sup>Optional</sup> <a name="enablePrePostScripts" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.enablePrePostScripts"></a>
|
|
2553
|
+
|
|
2554
|
+
```typescript
|
|
2555
|
+
public readonly enablePrePostScripts: boolean;
|
|
2556
|
+
```
|
|
2557
|
+
|
|
2558
|
+
- *Type:* boolean
|
|
2559
|
+
|
|
2560
|
+
When true, pnpm will run any pre/post scripts automatically.
|
|
2561
|
+
|
|
2562
|
+
---
|
|
2563
|
+
|
|
2564
|
+
##### `engineStrict`<sup>Optional</sup> <a name="engineStrict" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.engineStrict"></a>
|
|
2565
|
+
|
|
2566
|
+
```typescript
|
|
2567
|
+
public readonly engineStrict: boolean;
|
|
2568
|
+
```
|
|
2569
|
+
|
|
2570
|
+
- *Type:* boolean
|
|
2571
|
+
|
|
2572
|
+
If this is enabled, pnpm will not install any package that claims to not be compatible with the current Node version.
|
|
2573
|
+
|
|
2574
|
+
---
|
|
2575
|
+
|
|
2576
|
+
##### `executionEnv`<sup>Optional</sup> <a name="executionEnv" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.executionEnv"></a>
|
|
2577
|
+
|
|
2578
|
+
```typescript
|
|
2579
|
+
public readonly executionEnv: ExecutionEnv;
|
|
2580
|
+
```
|
|
2581
|
+
|
|
2582
|
+
- *Type:* <a href="#@alma-cdk/construct-library.ExecutionEnv">ExecutionEnv</a>
|
|
2583
|
+
|
|
2584
|
+
---
|
|
2585
|
+
|
|
2586
|
+
##### `extendNodePath`<sup>Optional</sup> <a name="extendNodePath" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.extendNodePath"></a>
|
|
2587
|
+
|
|
2588
|
+
```typescript
|
|
2589
|
+
public readonly extendNodePath: boolean;
|
|
2590
|
+
```
|
|
2591
|
+
|
|
2592
|
+
- *Type:* boolean
|
|
2593
|
+
|
|
2594
|
+
When false, the NODE_PATH environment variable is not set in the command shims.
|
|
2595
|
+
|
|
2596
|
+
---
|
|
2597
|
+
|
|
2598
|
+
##### `failIfNoMatch`<sup>Optional</sup> <a name="failIfNoMatch" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.failIfNoMatch"></a>
|
|
2599
|
+
|
|
2600
|
+
```typescript
|
|
2601
|
+
public readonly failIfNoMatch: boolean;
|
|
2602
|
+
```
|
|
2603
|
+
|
|
2604
|
+
- *Type:* boolean
|
|
2605
|
+
|
|
2606
|
+
If true, pnpm will fail if no packages match the filter.
|
|
2607
|
+
|
|
2608
|
+
---
|
|
2609
|
+
|
|
2610
|
+
##### `fetchRetries`<sup>Optional</sup> <a name="fetchRetries" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.fetchRetries"></a>
|
|
2611
|
+
|
|
2612
|
+
```typescript
|
|
2613
|
+
public readonly fetchRetries: number;
|
|
2614
|
+
```
|
|
2615
|
+
|
|
2616
|
+
- *Type:* number
|
|
2617
|
+
|
|
2618
|
+
How many times to retry if pnpm fails to fetch from the registry.
|
|
2619
|
+
|
|
2620
|
+
---
|
|
2621
|
+
|
|
2622
|
+
##### `fetchRetryFactor`<sup>Optional</sup> <a name="fetchRetryFactor" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.fetchRetryFactor"></a>
|
|
2623
|
+
|
|
2624
|
+
```typescript
|
|
2625
|
+
public readonly fetchRetryFactor: number;
|
|
2626
|
+
```
|
|
2627
|
+
|
|
2628
|
+
- *Type:* number
|
|
2629
|
+
|
|
2630
|
+
The exponential factor for retry backoff.
|
|
2631
|
+
|
|
2632
|
+
---
|
|
2633
|
+
|
|
2634
|
+
##### `fetchRetryMaxtimeout`<sup>Optional</sup> <a name="fetchRetryMaxtimeout" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.fetchRetryMaxtimeout"></a>
|
|
2635
|
+
|
|
2636
|
+
```typescript
|
|
2637
|
+
public readonly fetchRetryMaxtimeout: number;
|
|
2638
|
+
```
|
|
2639
|
+
|
|
2640
|
+
- *Type:* number
|
|
2641
|
+
|
|
2642
|
+
The maximum fallback timeout to ensure the retry factor does not make requests too long.
|
|
2643
|
+
|
|
2644
|
+
---
|
|
2645
|
+
|
|
2646
|
+
##### `fetchRetryMintimeout`<sup>Optional</sup> <a name="fetchRetryMintimeout" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.fetchRetryMintimeout"></a>
|
|
2647
|
+
|
|
2648
|
+
```typescript
|
|
2649
|
+
public readonly fetchRetryMintimeout: number;
|
|
2650
|
+
```
|
|
2651
|
+
|
|
2652
|
+
- *Type:* number
|
|
2653
|
+
|
|
2654
|
+
The minimum (base) timeout for retrying requests.
|
|
2655
|
+
|
|
2656
|
+
---
|
|
2657
|
+
|
|
2658
|
+
##### `fetchTimeout`<sup>Optional</sup> <a name="fetchTimeout" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.fetchTimeout"></a>
|
|
2659
|
+
|
|
2660
|
+
```typescript
|
|
2661
|
+
public readonly fetchTimeout: number;
|
|
2662
|
+
```
|
|
2663
|
+
|
|
2664
|
+
- *Type:* number
|
|
2665
|
+
|
|
2666
|
+
The maximum amount of time to wait for HTTP requests to complete.
|
|
2667
|
+
|
|
2668
|
+
---
|
|
2669
|
+
|
|
2670
|
+
##### `forceLegacyDeploy`<sup>Optional</sup> <a name="forceLegacyDeploy" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.forceLegacyDeploy"></a>
|
|
2671
|
+
|
|
2672
|
+
```typescript
|
|
2673
|
+
public readonly forceLegacyDeploy: boolean;
|
|
2674
|
+
```
|
|
2675
|
+
|
|
2676
|
+
- *Type:* boolean
|
|
2677
|
+
|
|
2678
|
+
By default, pnpm deploy will try creating a dedicated lockfile from a shared lockfile for deployment.
|
|
2679
|
+
|
|
2680
|
+
If this setting is set to true, the legacy deploy behavior will be used.
|
|
2681
|
+
|
|
2682
|
+
---
|
|
2683
|
+
|
|
2684
|
+
##### `gitBranchLockfile`<sup>Optional</sup> <a name="gitBranchLockfile" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.gitBranchLockfile"></a>
|
|
2685
|
+
|
|
2686
|
+
```typescript
|
|
2687
|
+
public readonly gitBranchLockfile: boolean;
|
|
2688
|
+
```
|
|
2689
|
+
|
|
2690
|
+
- *Type:* boolean
|
|
2691
|
+
|
|
2692
|
+
When set to true, the generated lockfile name after installation will be named based on the current branch name to completely avoid merge conflicts.
|
|
2693
|
+
|
|
2694
|
+
---
|
|
2695
|
+
|
|
2696
|
+
##### `gitChecks`<sup>Optional</sup> <a name="gitChecks" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.gitChecks"></a>
|
|
2697
|
+
|
|
2698
|
+
```typescript
|
|
2699
|
+
public readonly gitChecks: boolean;
|
|
2700
|
+
```
|
|
2701
|
+
|
|
2702
|
+
- *Type:* boolean
|
|
2703
|
+
|
|
2704
|
+
Check if current branch is your publish branch, clean, and up-to-date with remote.
|
|
2705
|
+
|
|
2706
|
+
---
|
|
2707
|
+
|
|
2708
|
+
##### `gitShallowHosts`<sup>Optional</sup> <a name="gitShallowHosts" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.gitShallowHosts"></a>
|
|
2709
|
+
|
|
2710
|
+
```typescript
|
|
2711
|
+
public readonly gitShallowHosts: string[];
|
|
2712
|
+
```
|
|
2713
|
+
|
|
2714
|
+
- *Type:* string[]
|
|
2715
|
+
|
|
2716
|
+
When fetching dependencies that are Git repositories, if the host is listed in this setting, pnpm will use shallow cloning to fetch only the needed commit, not all the history.
|
|
2717
|
+
|
|
2718
|
+
---
|
|
2719
|
+
|
|
2720
|
+
##### `globalBinDir`<sup>Optional</sup> <a name="globalBinDir" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.globalBinDir"></a>
|
|
2721
|
+
|
|
2722
|
+
```typescript
|
|
2723
|
+
public readonly globalBinDir: string;
|
|
2724
|
+
```
|
|
2725
|
+
|
|
2726
|
+
- *Type:* string
|
|
2727
|
+
|
|
2728
|
+
Allows to set the target directory for the bin files of globally installed packages.
|
|
2729
|
+
|
|
2730
|
+
---
|
|
2731
|
+
|
|
2732
|
+
##### `globalDir`<sup>Optional</sup> <a name="globalDir" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.globalDir"></a>
|
|
2733
|
+
|
|
2734
|
+
```typescript
|
|
2735
|
+
public readonly globalDir: string;
|
|
2736
|
+
```
|
|
2737
|
+
|
|
2738
|
+
- *Type:* string
|
|
2739
|
+
|
|
2740
|
+
Specify a custom directory to store global packages.
|
|
2741
|
+
|
|
2742
|
+
---
|
|
2743
|
+
|
|
2744
|
+
##### `globalPnpmfile`<sup>Optional</sup> <a name="globalPnpmfile" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.globalPnpmfile"></a>
|
|
2745
|
+
|
|
2746
|
+
```typescript
|
|
2747
|
+
public readonly globalPnpmfile: string;
|
|
2748
|
+
```
|
|
2749
|
+
|
|
2750
|
+
- *Type:* string
|
|
2751
|
+
|
|
2752
|
+
The location of a global pnpmfile.
|
|
2753
|
+
|
|
2754
|
+
A global pnpmfile is used by all projects during installation.
|
|
2755
|
+
|
|
2756
|
+
---
|
|
2757
|
+
|
|
2758
|
+
##### `hoist`<sup>Optional</sup> <a name="hoist" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.hoist"></a>
|
|
2759
|
+
|
|
2760
|
+
```typescript
|
|
2761
|
+
public readonly hoist: boolean;
|
|
2762
|
+
```
|
|
2763
|
+
|
|
2764
|
+
- *Type:* boolean
|
|
2765
|
+
|
|
2766
|
+
When true, all dependencies are hoisted to node_modules/.pnpm/node_modules.
|
|
2767
|
+
|
|
2768
|
+
---
|
|
2769
|
+
|
|
2770
|
+
##### `hoistPattern`<sup>Optional</sup> <a name="hoistPattern" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.hoistPattern"></a>
|
|
2771
|
+
|
|
2772
|
+
```typescript
|
|
2773
|
+
public readonly hoistPattern: string[];
|
|
2774
|
+
```
|
|
2775
|
+
|
|
2776
|
+
- *Type:* string[]
|
|
2777
|
+
|
|
2778
|
+
Tells pnpm which packages should be hoisted to node_modules/.pnpm/node_modules.
|
|
2779
|
+
|
|
2780
|
+
---
|
|
2781
|
+
|
|
2782
|
+
##### `hoistWorkspacePackages`<sup>Optional</sup> <a name="hoistWorkspacePackages" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.hoistWorkspacePackages"></a>
|
|
2783
|
+
|
|
2784
|
+
```typescript
|
|
2785
|
+
public readonly hoistWorkspacePackages: boolean;
|
|
2786
|
+
```
|
|
2787
|
+
|
|
2788
|
+
- *Type:* boolean
|
|
2789
|
+
|
|
2790
|
+
When true, packages from the workspaces are symlinked to either <workspace_root>/node_modules/.pnpm/node_modules or to <workspace_root>/node_modules depending on other hoisting settings (hoistPattern and publicHoistPattern).
|
|
2791
|
+
|
|
2792
|
+
---
|
|
2793
|
+
|
|
2794
|
+
##### `httpsProxy`<sup>Optional</sup> <a name="httpsProxy" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.httpsProxy"></a>
|
|
2795
|
+
|
|
2796
|
+
```typescript
|
|
2797
|
+
public readonly httpsProxy: string;
|
|
2798
|
+
```
|
|
2799
|
+
|
|
2800
|
+
- *Type:* string
|
|
2801
|
+
|
|
2802
|
+
A proxy to use for outgoing HTTPS requests.
|
|
2803
|
+
|
|
2804
|
+
If the HTTPS_PROXY, https_proxy, HTTP_PROXY or http_proxy environment variables are set, their values will be used instead.
|
|
2805
|
+
|
|
2806
|
+
---
|
|
2807
|
+
|
|
2808
|
+
##### `ignoreCompatibilityDb`<sup>Optional</sup> <a name="ignoreCompatibilityDb" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoreCompatibilityDb"></a>
|
|
2809
|
+
|
|
2810
|
+
```typescript
|
|
2811
|
+
public readonly ignoreCompatibilityDb: boolean;
|
|
2812
|
+
```
|
|
2813
|
+
|
|
2814
|
+
- *Type:* boolean
|
|
2815
|
+
|
|
2816
|
+
During installation the dependencies of some packages are automatically patched.
|
|
2817
|
+
|
|
2818
|
+
If you want to disable this, set this config to false.
|
|
2819
|
+
|
|
2820
|
+
---
|
|
2821
|
+
|
|
2822
|
+
##### `ignoredBuiltDependencies`<sup>Optional</sup> <a name="ignoredBuiltDependencies" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoredBuiltDependencies"></a>
|
|
2823
|
+
|
|
2824
|
+
```typescript
|
|
2825
|
+
public readonly ignoredBuiltDependencies: string[];
|
|
2826
|
+
```
|
|
2827
|
+
|
|
2828
|
+
- *Type:* string[]
|
|
2829
|
+
|
|
2830
|
+
A list of package names that should not be built during installation.
|
|
2831
|
+
|
|
2832
|
+
---
|
|
2833
|
+
|
|
2834
|
+
##### `ignoreDepScripts`<sup>Optional</sup> <a name="ignoreDepScripts" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoreDepScripts"></a>
|
|
2835
|
+
|
|
2836
|
+
```typescript
|
|
2837
|
+
public readonly ignoreDepScripts: boolean;
|
|
2838
|
+
```
|
|
2839
|
+
|
|
2840
|
+
- *Type:* boolean
|
|
2841
|
+
|
|
2842
|
+
Do not execute any scripts of the installed packages.
|
|
2843
|
+
|
|
2844
|
+
Scripts of the projects are executed.
|
|
2845
|
+
|
|
2846
|
+
---
|
|
2847
|
+
|
|
2848
|
+
##### `ignoredOptionalDependencies`<sup>Optional</sup> <a name="ignoredOptionalDependencies" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoredOptionalDependencies"></a>
|
|
2849
|
+
|
|
2850
|
+
```typescript
|
|
2851
|
+
public readonly ignoredOptionalDependencies: string[];
|
|
2852
|
+
```
|
|
2853
|
+
|
|
2854
|
+
- *Type:* string[]
|
|
2855
|
+
|
|
2856
|
+
A list of optional dependencies that the install should be skipped.
|
|
2857
|
+
|
|
2858
|
+
---
|
|
2859
|
+
|
|
2860
|
+
##### `ignorePatchFailures`<sup>Optional</sup> <a name="ignorePatchFailures" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignorePatchFailures"></a>
|
|
2861
|
+
|
|
2862
|
+
```typescript
|
|
2863
|
+
public readonly ignorePatchFailures: boolean;
|
|
2864
|
+
```
|
|
2865
|
+
|
|
2866
|
+
- *Type:* boolean
|
|
2867
|
+
|
|
2868
|
+
Default is undefined.
|
|
2869
|
+
|
|
2870
|
+
Errors out when a patch with an exact version or version range fails. Ignores failures from name-only patches. When true, prints a warning instead of failing when any patch cannot be applied. When false, errors out for any patch failure.
|
|
2871
|
+
|
|
2872
|
+
---
|
|
2873
|
+
|
|
2874
|
+
##### `ignorePnpmfile`<sup>Optional</sup> <a name="ignorePnpmfile" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignorePnpmfile"></a>
|
|
2875
|
+
|
|
2876
|
+
```typescript
|
|
2877
|
+
public readonly ignorePnpmfile: boolean;
|
|
2878
|
+
```
|
|
2879
|
+
|
|
2880
|
+
- *Type:* boolean
|
|
2881
|
+
|
|
2882
|
+
.pnpmfile.cjs will be ignored. Useful together with --ignore-scripts when you want to make sure that no script gets executed during install.
|
|
2883
|
+
|
|
2884
|
+
---
|
|
2885
|
+
|
|
2886
|
+
##### `ignoreScripts`<sup>Optional</sup> <a name="ignoreScripts" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoreScripts"></a>
|
|
2887
|
+
|
|
2888
|
+
```typescript
|
|
2889
|
+
public readonly ignoreScripts: boolean;
|
|
2890
|
+
```
|
|
2891
|
+
|
|
2892
|
+
- *Type:* boolean
|
|
2893
|
+
|
|
2894
|
+
Do not execute any scripts defined in the project package.json and its dependencies.
|
|
2895
|
+
|
|
2896
|
+
---
|
|
2897
|
+
|
|
2898
|
+
##### `ignoreWorkspaceCycles`<sup>Optional</sup> <a name="ignoreWorkspaceCycles" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoreWorkspaceCycles"></a>
|
|
2899
|
+
|
|
2900
|
+
```typescript
|
|
2901
|
+
public readonly ignoreWorkspaceCycles: boolean;
|
|
2902
|
+
```
|
|
2903
|
+
|
|
2904
|
+
- *Type:* boolean
|
|
2905
|
+
|
|
2906
|
+
When set to true, no workspace cycle warnings will be printed.
|
|
2907
|
+
|
|
2908
|
+
---
|
|
2909
|
+
|
|
2910
|
+
##### `ignoreWorkspaceRootCheck`<sup>Optional</sup> <a name="ignoreWorkspaceRootCheck" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.ignoreWorkspaceRootCheck"></a>
|
|
2911
|
+
|
|
2912
|
+
```typescript
|
|
2913
|
+
public readonly ignoreWorkspaceRootCheck: boolean;
|
|
2914
|
+
```
|
|
2915
|
+
|
|
2916
|
+
- *Type:* boolean
|
|
2917
|
+
|
|
2918
|
+
Adding a new dependency to the root workspace package fails, unless the --ignore-workspace-root-check or -w flag is used.
|
|
2919
|
+
|
|
2920
|
+
---
|
|
2921
|
+
|
|
2922
|
+
##### `includeWorkspaceRoot`<sup>Optional</sup> <a name="includeWorkspaceRoot" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.includeWorkspaceRoot"></a>
|
|
2923
|
+
|
|
2924
|
+
```typescript
|
|
2925
|
+
public readonly includeWorkspaceRoot: boolean;
|
|
2926
|
+
```
|
|
2927
|
+
|
|
2928
|
+
- *Type:* boolean
|
|
2929
|
+
|
|
2930
|
+
When executing commands recursively in a workspace, execute them on the root workspace project as well.
|
|
2931
|
+
|
|
2932
|
+
---
|
|
2933
|
+
|
|
2934
|
+
##### `injectWorkspacePackages`<sup>Optional</sup> <a name="injectWorkspacePackages" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.injectWorkspacePackages"></a>
|
|
2935
|
+
|
|
2936
|
+
```typescript
|
|
2937
|
+
public readonly injectWorkspacePackages: boolean;
|
|
2938
|
+
```
|
|
2939
|
+
|
|
2940
|
+
- *Type:* boolean
|
|
2941
|
+
|
|
2942
|
+
Enables hard-linking of all local workspace dependencies instead of symlinking them.
|
|
2943
|
+
|
|
2944
|
+
---
|
|
2945
|
+
|
|
2946
|
+
##### `key`<sup>Optional</sup> <a name="key" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.key"></a>
|
|
2947
|
+
|
|
2948
|
+
```typescript
|
|
2949
|
+
public readonly key: string;
|
|
2950
|
+
```
|
|
2951
|
+
|
|
2952
|
+
- *Type:* string
|
|
2953
|
+
|
|
2954
|
+
A client key to pass when accessing the registry.
|
|
2955
|
+
|
|
2956
|
+
---
|
|
2957
|
+
|
|
2958
|
+
##### `linkWorkspacePackages`<sup>Optional</sup> <a name="linkWorkspacePackages" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.linkWorkspacePackages"></a>
|
|
2959
|
+
|
|
2960
|
+
```typescript
|
|
2961
|
+
public readonly linkWorkspacePackages: boolean | string;
|
|
2962
|
+
```
|
|
2963
|
+
|
|
2964
|
+
- *Type:* boolean | string
|
|
2965
|
+
|
|
2966
|
+
If this is enabled, locally available packages are linked to node_modules instead of being downloaded from the registry.
|
|
2967
|
+
|
|
2968
|
+
---
|
|
2969
|
+
|
|
2970
|
+
##### `localAddress`<sup>Optional</sup> <a name="localAddress" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.localAddress"></a>
|
|
2971
|
+
|
|
2972
|
+
```typescript
|
|
2973
|
+
public readonly localAddress: string;
|
|
2974
|
+
```
|
|
2975
|
+
|
|
2976
|
+
- *Type:* string
|
|
2977
|
+
|
|
2978
|
+
The IP address of the local interface to use when making connections to the npm registry.
|
|
2979
|
+
|
|
2980
|
+
---
|
|
2981
|
+
|
|
2982
|
+
##### `lockfile`<sup>Optional</sup> <a name="lockfile" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.lockfile"></a>
|
|
2983
|
+
|
|
2984
|
+
```typescript
|
|
2985
|
+
public readonly lockfile: boolean;
|
|
2986
|
+
```
|
|
2987
|
+
|
|
2988
|
+
- *Type:* boolean
|
|
2989
|
+
|
|
2990
|
+
When set to false, pnpm won't read or generate a pnpm-lock.yaml file.
|
|
2991
|
+
|
|
2992
|
+
---
|
|
2993
|
+
|
|
2994
|
+
##### `lockfileIncludeTarballUrl`<sup>Optional</sup> <a name="lockfileIncludeTarballUrl" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.lockfileIncludeTarballUrl"></a>
|
|
2995
|
+
|
|
2996
|
+
```typescript
|
|
2997
|
+
public readonly lockfileIncludeTarballUrl: boolean;
|
|
2998
|
+
```
|
|
2999
|
+
|
|
3000
|
+
- *Type:* boolean
|
|
3001
|
+
|
|
3002
|
+
Add the full URL to the package's tarball to every entry in pnpm-lock.yaml.
|
|
3003
|
+
|
|
3004
|
+
---
|
|
3005
|
+
|
|
3006
|
+
##### `loglevel`<sup>Optional</sup> <a name="loglevel" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.loglevel"></a>
|
|
3007
|
+
|
|
3008
|
+
```typescript
|
|
3009
|
+
public readonly loglevel: string;
|
|
3010
|
+
```
|
|
3011
|
+
|
|
3012
|
+
- *Type:* string
|
|
3013
|
+
|
|
3014
|
+
Any logs at or higher than the given level will be shown.
|
|
3015
|
+
|
|
3016
|
+
---
|
|
3017
|
+
|
|
3018
|
+
##### `managePackageManagerVersions`<sup>Optional</sup> <a name="managePackageManagerVersions" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.managePackageManagerVersions"></a>
|
|
3019
|
+
|
|
3020
|
+
```typescript
|
|
3021
|
+
public readonly managePackageManagerVersions: boolean;
|
|
3022
|
+
```
|
|
3023
|
+
|
|
3024
|
+
- *Type:* boolean
|
|
3025
|
+
|
|
3026
|
+
When enabled, pnpm will automatically download and run the version of pnpm specified in the packageManager field of package.json.
|
|
3027
|
+
|
|
3028
|
+
---
|
|
3029
|
+
|
|
3030
|
+
##### `maxsockets`<sup>Optional</sup> <a name="maxsockets" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.maxsockets"></a>
|
|
3031
|
+
|
|
3032
|
+
```typescript
|
|
3033
|
+
public readonly maxsockets: number;
|
|
3034
|
+
```
|
|
3035
|
+
|
|
3036
|
+
- *Type:* number
|
|
3037
|
+
|
|
3038
|
+
The maximum number of connections to use per origin (protocol/host/port combination).
|
|
3039
|
+
|
|
3040
|
+
---
|
|
3041
|
+
|
|
3042
|
+
##### `mergeGitBranchLockfilesBranchPattern`<sup>Optional</sup> <a name="mergeGitBranchLockfilesBranchPattern" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.mergeGitBranchLockfilesBranchPattern"></a>
|
|
3043
|
+
|
|
3044
|
+
```typescript
|
|
3045
|
+
public readonly mergeGitBranchLockfilesBranchPattern: string[];
|
|
3046
|
+
```
|
|
3047
|
+
|
|
3048
|
+
- *Type:* string[]
|
|
3049
|
+
|
|
3050
|
+
This configuration matches the current branch name to determine whether to merge all git branch lockfile files.
|
|
3051
|
+
|
|
3052
|
+
---
|
|
3053
|
+
|
|
3054
|
+
##### `minimumReleaseAge`<sup>Optional</sup> <a name="minimumReleaseAge" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.minimumReleaseAge"></a>
|
|
3055
|
+
|
|
3056
|
+
```typescript
|
|
3057
|
+
public readonly minimumReleaseAge: number;
|
|
3058
|
+
```
|
|
3059
|
+
|
|
3060
|
+
- *Type:* number
|
|
3061
|
+
|
|
3062
|
+
minimumReleaseAge defines the minimum number of minutes that must pass after a version is published before pnpm will install it.
|
|
3063
|
+
|
|
3064
|
+
This applies to all dependencies, including transitive ones.
|
|
3065
|
+
|
|
3066
|
+
---
|
|
3067
|
+
|
|
3068
|
+
##### `minimumReleaseAgeExclude`<sup>Optional</sup> <a name="minimumReleaseAgeExclude" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.minimumReleaseAgeExclude"></a>
|
|
3069
|
+
|
|
3070
|
+
```typescript
|
|
3071
|
+
public readonly minimumReleaseAgeExclude: string[];
|
|
3072
|
+
```
|
|
3073
|
+
|
|
3074
|
+
- *Type:* string[]
|
|
3075
|
+
|
|
3076
|
+
If you set `minimumReleaseAge` but need certain dependencies to always install the newest version immediately, you can list them under `minimumReleaseAgeExclude`.
|
|
3077
|
+
|
|
3078
|
+
The exclusion works by `package name` and applies to all versions of that package.
|
|
3079
|
+
|
|
3080
|
+
---
|
|
3081
|
+
|
|
3082
|
+
##### `modulesCacheMaxAge`<sup>Optional</sup> <a name="modulesCacheMaxAge" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.modulesCacheMaxAge"></a>
|
|
3083
|
+
|
|
3084
|
+
```typescript
|
|
3085
|
+
public readonly modulesCacheMaxAge: number;
|
|
3086
|
+
```
|
|
3087
|
+
|
|
3088
|
+
- *Type:* number
|
|
3089
|
+
|
|
3090
|
+
The time in minutes after which orphan packages from the modules directory should be removed.
|
|
3091
|
+
|
|
3092
|
+
---
|
|
3093
|
+
|
|
3094
|
+
##### `modulesDir`<sup>Optional</sup> <a name="modulesDir" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.modulesDir"></a>
|
|
3095
|
+
|
|
3096
|
+
```typescript
|
|
3097
|
+
public readonly modulesDir: string;
|
|
3098
|
+
```
|
|
3099
|
+
|
|
3100
|
+
- *Type:* string
|
|
3101
|
+
|
|
3102
|
+
The directory in which dependencies will be installed (instead of node_modules).
|
|
3103
|
+
|
|
3104
|
+
---
|
|
3105
|
+
|
|
3106
|
+
##### `networkConcurrency`<sup>Optional</sup> <a name="networkConcurrency" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.networkConcurrency"></a>
|
|
3107
|
+
|
|
3108
|
+
```typescript
|
|
3109
|
+
public readonly networkConcurrency: number;
|
|
3110
|
+
```
|
|
3111
|
+
|
|
3112
|
+
- *Type:* number
|
|
3113
|
+
|
|
3114
|
+
Controls the maximum number of HTTP(S) requests to process simultaneously.
|
|
3115
|
+
|
|
3116
|
+
---
|
|
3117
|
+
|
|
3118
|
+
##### `neverBuiltDependencies`<sup>Optional</sup> <a name="neverBuiltDependencies" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.neverBuiltDependencies"></a>
|
|
3119
|
+
|
|
3120
|
+
```typescript
|
|
3121
|
+
public readonly neverBuiltDependencies: string[];
|
|
3122
|
+
```
|
|
3123
|
+
|
|
3124
|
+
- *Type:* string[]
|
|
3125
|
+
|
|
3126
|
+
A list of dependencies to run builds for.
|
|
3127
|
+
|
|
3128
|
+
---
|
|
3129
|
+
|
|
3130
|
+
##### `nodeLinker`<sup>Optional</sup> <a name="nodeLinker" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.nodeLinker"></a>
|
|
3131
|
+
|
|
3132
|
+
```typescript
|
|
3133
|
+
public readonly nodeLinker: string;
|
|
3134
|
+
```
|
|
3135
|
+
|
|
3136
|
+
- *Type:* string
|
|
3137
|
+
|
|
3138
|
+
Defines what linker should be used for installing Node packages.
|
|
3139
|
+
|
|
3140
|
+
---
|
|
3141
|
+
|
|
3142
|
+
##### `nodeOptions`<sup>Optional</sup> <a name="nodeOptions" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.nodeOptions"></a>
|
|
3143
|
+
|
|
3144
|
+
```typescript
|
|
3145
|
+
public readonly nodeOptions: string;
|
|
3146
|
+
```
|
|
3147
|
+
|
|
3148
|
+
- *Type:* string
|
|
3149
|
+
|
|
3150
|
+
Options to pass through to Node.js via the NODE_OPTIONS environment variable.
|
|
3151
|
+
|
|
3152
|
+
---
|
|
3153
|
+
|
|
3154
|
+
##### `nodeVersion`<sup>Optional</sup> <a name="nodeVersion" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.nodeVersion"></a>
|
|
3155
|
+
|
|
3156
|
+
```typescript
|
|
3157
|
+
public readonly nodeVersion: string;
|
|
3158
|
+
```
|
|
3159
|
+
|
|
3160
|
+
- *Type:* string
|
|
3161
|
+
|
|
3162
|
+
The Node.js version to use when checking a package's engines setting.
|
|
3163
|
+
|
|
3164
|
+
---
|
|
3165
|
+
|
|
3166
|
+
##### `noproxy`<sup>Optional</sup> <a name="noproxy" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.noproxy"></a>
|
|
3167
|
+
|
|
3168
|
+
```typescript
|
|
3169
|
+
public readonly noproxy: string;
|
|
3170
|
+
```
|
|
3171
|
+
|
|
3172
|
+
- *Type:* string
|
|
3173
|
+
|
|
3174
|
+
A comma-separated string of domain extensions that a proxy should not be used for.
|
|
3175
|
+
|
|
3176
|
+
---
|
|
3177
|
+
|
|
3178
|
+
##### `npmPath`<sup>Optional</sup> <a name="npmPath" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.npmPath"></a>
|
|
3179
|
+
|
|
3180
|
+
```typescript
|
|
3181
|
+
public readonly npmPath: string;
|
|
3182
|
+
```
|
|
3183
|
+
|
|
3184
|
+
- *Type:* string
|
|
3185
|
+
|
|
3186
|
+
The location of the npm binary that pnpm uses for some actions, like publishing.
|
|
3187
|
+
|
|
3188
|
+
---
|
|
3189
|
+
|
|
3190
|
+
##### `onlyBuiltDependencies`<sup>Optional</sup> <a name="onlyBuiltDependencies" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.onlyBuiltDependencies"></a>
|
|
3191
|
+
|
|
3192
|
+
```typescript
|
|
3193
|
+
public readonly onlyBuiltDependencies: string[];
|
|
3194
|
+
```
|
|
3195
|
+
|
|
3196
|
+
- *Type:* string[]
|
|
3197
|
+
|
|
3198
|
+
A list of package names that are allowed to be executed during installation.
|
|
3199
|
+
|
|
3200
|
+
---
|
|
3201
|
+
|
|
3202
|
+
##### `onlyBuiltDependenciesFile`<sup>Optional</sup> <a name="onlyBuiltDependenciesFile" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.onlyBuiltDependenciesFile"></a>
|
|
3203
|
+
|
|
3204
|
+
```typescript
|
|
3205
|
+
public readonly onlyBuiltDependenciesFile: string;
|
|
3206
|
+
```
|
|
3207
|
+
|
|
3208
|
+
- *Type:* string
|
|
3209
|
+
|
|
3210
|
+
Specifies a JSON file that lists the only packages permitted to run installation scripts during the pnpm install process.
|
|
3211
|
+
|
|
3212
|
+
---
|
|
3213
|
+
|
|
3214
|
+
##### `optimisticRepeatInstall`<sup>Optional</sup> <a name="optimisticRepeatInstall" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.optimisticRepeatInstall"></a>
|
|
3215
|
+
|
|
3216
|
+
```typescript
|
|
3217
|
+
public readonly optimisticRepeatInstall: boolean;
|
|
3218
|
+
```
|
|
3219
|
+
|
|
3220
|
+
- *Type:* boolean
|
|
3221
|
+
|
|
3222
|
+
When enabled, a fast check will be performed before proceeding to installation.
|
|
3223
|
+
|
|
3224
|
+
This way a repeat install or an install on a project with everything up-to-date becomes a lot faster.
|
|
3225
|
+
|
|
3226
|
+
---
|
|
3227
|
+
|
|
3228
|
+
##### `overrides`<sup>Optional</sup> <a name="overrides" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.overrides"></a>
|
|
3229
|
+
|
|
3230
|
+
```typescript
|
|
3231
|
+
public readonly overrides: {[ key: string ]: string};
|
|
3232
|
+
```
|
|
3233
|
+
|
|
3234
|
+
- *Type:* {[ key: string ]: string}
|
|
3235
|
+
|
|
3236
|
+
Used to override any dependency in the dependency graph.
|
|
3237
|
+
|
|
3238
|
+
---
|
|
3239
|
+
|
|
3240
|
+
##### `packageExtensions`<sup>Optional</sup> <a name="packageExtensions" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.packageExtensions"></a>
|
|
3241
|
+
|
|
3242
|
+
```typescript
|
|
3243
|
+
public readonly packageExtensions: {[ key: string ]: PackageExtension};
|
|
3244
|
+
```
|
|
3245
|
+
|
|
3246
|
+
- *Type:* {[ key: string ]: <a href="#@alma-cdk/construct-library.PackageExtension">PackageExtension</a>}
|
|
3247
|
+
|
|
3248
|
+
Used to extend the existing package definitions with additional information.
|
|
3249
|
+
|
|
3250
|
+
---
|
|
3251
|
+
|
|
3252
|
+
##### `packageImportMethod`<sup>Optional</sup> <a name="packageImportMethod" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.packageImportMethod"></a>
|
|
3253
|
+
|
|
3254
|
+
```typescript
|
|
3255
|
+
public readonly packageImportMethod: string;
|
|
3256
|
+
```
|
|
3257
|
+
|
|
3258
|
+
- *Type:* string
|
|
3259
|
+
|
|
3260
|
+
Controls the way packages are imported from the store (if you want to disable symlinks inside node_modules, then you need to change the nodeLinker setting, not this one).
|
|
3261
|
+
|
|
3262
|
+
---
|
|
3263
|
+
|
|
3264
|
+
##### `packageManagerStrict`<sup>Optional</sup> <a name="packageManagerStrict" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.packageManagerStrict"></a>
|
|
3265
|
+
|
|
3266
|
+
```typescript
|
|
3267
|
+
public readonly packageManagerStrict: boolean;
|
|
3268
|
+
```
|
|
3269
|
+
|
|
3270
|
+
- *Type:* boolean
|
|
3271
|
+
|
|
3272
|
+
If this setting is disabled, pnpm will not fail if a different package manager is specified in the packageManager field of package.json. When enabled, only the package name is checked (since pnpm v9.2.0), so you can still run any version of pnpm regardless of the version specified in the packageManager field.
|
|
3273
|
+
|
|
3274
|
+
---
|
|
3275
|
+
|
|
3276
|
+
##### `packageManagerStrictVersion`<sup>Optional</sup> <a name="packageManagerStrictVersion" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.packageManagerStrictVersion"></a>
|
|
3277
|
+
|
|
3278
|
+
```typescript
|
|
3279
|
+
public readonly packageManagerStrictVersion: boolean;
|
|
3280
|
+
```
|
|
3281
|
+
|
|
3282
|
+
- *Type:* boolean
|
|
3283
|
+
|
|
3284
|
+
When enabled, pnpm will fail if its version doesn't exactly match the version specified in the packageManager field of package.json.
|
|
3285
|
+
|
|
3286
|
+
---
|
|
3287
|
+
|
|
3288
|
+
##### `packages`<sup>Optional</sup> <a name="packages" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.packages"></a>
|
|
3289
|
+
|
|
3290
|
+
```typescript
|
|
3291
|
+
public readonly packages: string[];
|
|
3292
|
+
```
|
|
3293
|
+
|
|
3294
|
+
- *Type:* string[]
|
|
3295
|
+
|
|
3296
|
+
Workspace package paths.
|
|
3297
|
+
|
|
3298
|
+
Glob patterns are supported
|
|
3299
|
+
|
|
3300
|
+
---
|
|
3301
|
+
|
|
3302
|
+
##### `patchedDependencies`<sup>Optional</sup> <a name="patchedDependencies" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.patchedDependencies"></a>
|
|
3303
|
+
|
|
3304
|
+
```typescript
|
|
3305
|
+
public readonly patchedDependencies: {[ key: string ]: string};
|
|
3306
|
+
```
|
|
3307
|
+
|
|
3308
|
+
- *Type:* {[ key: string ]: string}
|
|
3309
|
+
|
|
3310
|
+
A list of dependencies that are patched.
|
|
3311
|
+
|
|
3312
|
+
---
|
|
3313
|
+
|
|
3314
|
+
##### `patchesDir`<sup>Optional</sup> <a name="patchesDir" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.patchesDir"></a>
|
|
3315
|
+
|
|
3316
|
+
```typescript
|
|
3317
|
+
public readonly patchesDir: string;
|
|
3318
|
+
```
|
|
3319
|
+
|
|
3320
|
+
- *Type:* string
|
|
3321
|
+
|
|
3322
|
+
The generated patch file will be saved to this directory.
|
|
3323
|
+
|
|
3324
|
+
---
|
|
3325
|
+
|
|
3326
|
+
##### `peerDependencyRules`<sup>Optional</sup> <a name="peerDependencyRules" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.peerDependencyRules"></a>
|
|
3327
|
+
|
|
3328
|
+
```typescript
|
|
3329
|
+
public readonly peerDependencyRules: PeerDependencyRules;
|
|
3330
|
+
```
|
|
3331
|
+
|
|
3332
|
+
- *Type:* <a href="#@alma-cdk/construct-library.PeerDependencyRules">PeerDependencyRules</a>
|
|
3333
|
+
|
|
3334
|
+
---
|
|
3335
|
+
|
|
3336
|
+
##### `peersSuffixMaxLength`<sup>Optional</sup> <a name="peersSuffixMaxLength" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.peersSuffixMaxLength"></a>
|
|
3337
|
+
|
|
3338
|
+
```typescript
|
|
3339
|
+
public readonly peersSuffixMaxLength: number;
|
|
3340
|
+
```
|
|
3341
|
+
|
|
3342
|
+
- *Type:* number
|
|
3343
|
+
|
|
3344
|
+
Max length of the peer IDs suffix added to dependency keys in the lockfile.
|
|
3345
|
+
|
|
3346
|
+
If the suffix is longer, it is replaced with a hash.
|
|
3347
|
+
|
|
3348
|
+
---
|
|
3349
|
+
|
|
3350
|
+
##### `pnpmfile`<sup>Optional</sup> <a name="pnpmfile" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.pnpmfile"></a>
|
|
3351
|
+
|
|
3352
|
+
```typescript
|
|
3353
|
+
public readonly pnpmfile: string;
|
|
3354
|
+
```
|
|
3355
|
+
|
|
3356
|
+
- *Type:* string
|
|
3357
|
+
|
|
3358
|
+
The location of the local pnpmfile.
|
|
3359
|
+
|
|
3360
|
+
---
|
|
3361
|
+
|
|
3362
|
+
##### `preferFrozenLockfile`<sup>Optional</sup> <a name="preferFrozenLockfile" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.preferFrozenLockfile"></a>
|
|
3363
|
+
|
|
3364
|
+
```typescript
|
|
3365
|
+
public readonly preferFrozenLockfile: boolean;
|
|
3366
|
+
```
|
|
3367
|
+
|
|
3368
|
+
- *Type:* boolean
|
|
3369
|
+
|
|
3370
|
+
When set to true and the available pnpm-lock.yaml satisfies the package.json dependencies directive, a headless installation is performed.
|
|
3371
|
+
|
|
3372
|
+
---
|
|
3373
|
+
|
|
3374
|
+
##### `preferOffline`<sup>Optional</sup> <a name="preferOffline" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.preferOffline"></a>
|
|
3375
|
+
|
|
3376
|
+
```typescript
|
|
3377
|
+
public readonly preferOffline: boolean;
|
|
3378
|
+
```
|
|
3379
|
+
|
|
3380
|
+
- *Type:* boolean
|
|
3381
|
+
|
|
3382
|
+
Bypass staleness checks for cached data.
|
|
3383
|
+
|
|
3384
|
+
Missing data will still be requested from the server.
|
|
3385
|
+
|
|
3386
|
+
---
|
|
3387
|
+
|
|
3388
|
+
##### `preferSymlinkedExecutables`<sup>Optional</sup> <a name="preferSymlinkedExecutables" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.preferSymlinkedExecutables"></a>
|
|
3389
|
+
|
|
3390
|
+
```typescript
|
|
3391
|
+
public readonly preferSymlinkedExecutables: boolean;
|
|
3392
|
+
```
|
|
3393
|
+
|
|
3394
|
+
- *Type:* boolean
|
|
3395
|
+
|
|
3396
|
+
Create symlinks to executables in node_modules/.bin instead of command shims. This setting is ignored on Windows, where only command shims work.
|
|
3397
|
+
|
|
3398
|
+
---
|
|
3399
|
+
|
|
3400
|
+
##### `preferWorkspacePackages`<sup>Optional</sup> <a name="preferWorkspacePackages" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.preferWorkspacePackages"></a>
|
|
3401
|
+
|
|
3402
|
+
```typescript
|
|
3403
|
+
public readonly preferWorkspacePackages: boolean;
|
|
3404
|
+
```
|
|
3405
|
+
|
|
3406
|
+
- *Type:* boolean
|
|
3407
|
+
|
|
3408
|
+
If this is enabled, local packages from the workspace are preferred over packages from the registry, even if there is a newer version of the package in the registry.
|
|
3409
|
+
|
|
3410
|
+
---
|
|
3411
|
+
|
|
3412
|
+
##### `proxy`<sup>Optional</sup> <a name="proxy" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.proxy"></a>
|
|
3413
|
+
|
|
3414
|
+
```typescript
|
|
3415
|
+
public readonly proxy: string;
|
|
3416
|
+
```
|
|
3417
|
+
|
|
3418
|
+
- *Type:* string
|
|
3419
|
+
|
|
3420
|
+
A proxy to use for outgoing http requests.
|
|
3421
|
+
|
|
3422
|
+
If the HTTP_PROXY or http_proxy environment variables are set, proxy settings will be honored by the underlying request library.
|
|
3423
|
+
|
|
3424
|
+
---
|
|
3425
|
+
|
|
3426
|
+
##### `publicHoistPattern`<sup>Optional</sup> <a name="publicHoistPattern" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.publicHoistPattern"></a>
|
|
3427
|
+
|
|
3428
|
+
```typescript
|
|
3429
|
+
public readonly publicHoistPattern: string[];
|
|
3430
|
+
```
|
|
3431
|
+
|
|
3432
|
+
- *Type:* string[]
|
|
3433
|
+
|
|
3434
|
+
Unlike hoistPattern, which hoists dependencies to a hidden modules directory inside the virtual store, publicHoistPattern hoists dependencies matching the pattern to the root modules directory.
|
|
3435
|
+
|
|
3436
|
+
---
|
|
3437
|
+
|
|
3438
|
+
##### `publishBranch`<sup>Optional</sup> <a name="publishBranch" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.publishBranch"></a>
|
|
3439
|
+
|
|
3440
|
+
```typescript
|
|
3441
|
+
public readonly publishBranch: string;
|
|
3442
|
+
```
|
|
3443
|
+
|
|
3444
|
+
- *Type:* string
|
|
3445
|
+
|
|
3446
|
+
The primary branch of the repository which is used for publishing the latest changes.
|
|
3447
|
+
|
|
3448
|
+
---
|
|
3449
|
+
|
|
3450
|
+
##### `recursiveInstall`<sup>Optional</sup> <a name="recursiveInstall" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.recursiveInstall"></a>
|
|
3451
|
+
|
|
3452
|
+
```typescript
|
|
3453
|
+
public readonly recursiveInstall: boolean;
|
|
3454
|
+
```
|
|
3455
|
+
|
|
3456
|
+
- *Type:* boolean
|
|
3457
|
+
|
|
3458
|
+
If this is enabled, the primary behaviour of pnpm install becomes that of pnpm install -r, meaning the install is performed on all workspace or subdirectory packages.
|
|
3459
|
+
|
|
3460
|
+
---
|
|
3461
|
+
|
|
3462
|
+
##### `registry`<sup>Optional</sup> <a name="registry" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.registry"></a>
|
|
3463
|
+
|
|
3464
|
+
```typescript
|
|
3465
|
+
public readonly registry: string;
|
|
3466
|
+
```
|
|
3467
|
+
|
|
3468
|
+
- *Type:* string
|
|
3469
|
+
|
|
3470
|
+
The base URL of the npm package registry (trailing slash included).
|
|
3471
|
+
|
|
3472
|
+
---
|
|
3473
|
+
|
|
3474
|
+
##### `registrySupportsTimeField`<sup>Optional</sup> <a name="registrySupportsTimeField" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.registrySupportsTimeField"></a>
|
|
3475
|
+
|
|
3476
|
+
```typescript
|
|
3477
|
+
public readonly registrySupportsTimeField: boolean;
|
|
3478
|
+
```
|
|
3479
|
+
|
|
3480
|
+
- *Type:* boolean
|
|
3481
|
+
|
|
3482
|
+
Set this to true if the registry that you are using returns the "time" field in the abbreviated metadata.
|
|
3483
|
+
|
|
3484
|
+
---
|
|
3485
|
+
|
|
3486
|
+
##### `requiredScripts`<sup>Optional</sup> <a name="requiredScripts" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.requiredScripts"></a>
|
|
3487
|
+
|
|
3488
|
+
```typescript
|
|
3489
|
+
public readonly requiredScripts: string[];
|
|
3490
|
+
```
|
|
3491
|
+
|
|
3492
|
+
- *Type:* string[]
|
|
3493
|
+
|
|
3494
|
+
A list of scripts that must exist in each project.
|
|
3495
|
+
|
|
3496
|
+
---
|
|
3497
|
+
|
|
3498
|
+
##### `resolutionMode`<sup>Optional</sup> <a name="resolutionMode" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.resolutionMode"></a>
|
|
3499
|
+
|
|
3500
|
+
```typescript
|
|
3501
|
+
public readonly resolutionMode: string;
|
|
3502
|
+
```
|
|
3503
|
+
|
|
3504
|
+
- *Type:* string
|
|
3505
|
+
|
|
3506
|
+
Determines how pnpm resolves dependencies, See https://pnpm.io/settings#resolutionmode.
|
|
3507
|
+
|
|
3508
|
+
---
|
|
3509
|
+
|
|
3510
|
+
##### `resolvePeersFromWorkspaceRoot`<sup>Optional</sup> <a name="resolvePeersFromWorkspaceRoot" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.resolvePeersFromWorkspaceRoot"></a>
|
|
3511
|
+
|
|
3512
|
+
```typescript
|
|
3513
|
+
public readonly resolvePeersFromWorkspaceRoot: boolean;
|
|
3514
|
+
```
|
|
3515
|
+
|
|
3516
|
+
- *Type:* boolean
|
|
3517
|
+
|
|
3518
|
+
When enabled, dependencies of the root workspace project are used to resolve peer dependencies of any projects in the workspace.
|
|
3519
|
+
|
|
3520
|
+
---
|
|
3521
|
+
|
|
3522
|
+
##### `saveExact`<sup>Optional</sup> <a name="saveExact" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.saveExact"></a>
|
|
3523
|
+
|
|
3524
|
+
```typescript
|
|
3525
|
+
public readonly saveExact: boolean;
|
|
3526
|
+
```
|
|
3527
|
+
|
|
3528
|
+
- *Type:* boolean
|
|
3529
|
+
|
|
3530
|
+
Saved dependencies will be configured with an exact version rather than using pnpm's default semver range operator.
|
|
3531
|
+
|
|
3532
|
+
---
|
|
3533
|
+
|
|
3534
|
+
##### `savePrefix`<sup>Optional</sup> <a name="savePrefix" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.savePrefix"></a>
|
|
3535
|
+
|
|
3536
|
+
```typescript
|
|
3537
|
+
public readonly savePrefix: string;
|
|
3538
|
+
```
|
|
3539
|
+
|
|
3540
|
+
- *Type:* string
|
|
3541
|
+
|
|
3542
|
+
Configure how versions of packages installed to a package.json file get prefixed.
|
|
3543
|
+
|
|
3544
|
+
---
|
|
3545
|
+
|
|
3546
|
+
##### `saveWorkspaceProtocol`<sup>Optional</sup> <a name="saveWorkspaceProtocol" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.saveWorkspaceProtocol"></a>
|
|
3547
|
+
|
|
3548
|
+
```typescript
|
|
3549
|
+
public readonly saveWorkspaceProtocol: boolean | string;
|
|
3550
|
+
```
|
|
3551
|
+
|
|
3552
|
+
- *Type:* boolean | string
|
|
3553
|
+
|
|
3554
|
+
This setting controls how dependencies that are linked from the workspace are added to package.json.
|
|
3555
|
+
|
|
3556
|
+
---
|
|
3557
|
+
|
|
3558
|
+
##### `scriptShell`<sup>Optional</sup> <a name="scriptShell" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.scriptShell"></a>
|
|
3559
|
+
|
|
3560
|
+
```typescript
|
|
3561
|
+
public readonly scriptShell: string;
|
|
3562
|
+
```
|
|
3563
|
+
|
|
3564
|
+
- *Type:* string
|
|
3565
|
+
|
|
3566
|
+
The shell to use for scripts run with the pnpm run command.
|
|
3567
|
+
|
|
3568
|
+
---
|
|
3569
|
+
|
|
3570
|
+
##### `shamefullyHoist`<sup>Optional</sup> <a name="shamefullyHoist" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.shamefullyHoist"></a>
|
|
3571
|
+
|
|
3572
|
+
```typescript
|
|
3573
|
+
public readonly shamefullyHoist: boolean;
|
|
3574
|
+
```
|
|
3575
|
+
|
|
3576
|
+
- *Type:* boolean
|
|
3577
|
+
|
|
3578
|
+
By default, pnpm creates a semistrict node_modules, meaning dependencies have access to undeclared dependencies but modules outside of node_modules do not.
|
|
3579
|
+
|
|
3580
|
+
---
|
|
3581
|
+
|
|
3582
|
+
##### `sharedWorkspaceLockfile`<sup>Optional</sup> <a name="sharedWorkspaceLockfile" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.sharedWorkspaceLockfile"></a>
|
|
3583
|
+
|
|
3584
|
+
```typescript
|
|
3585
|
+
public readonly sharedWorkspaceLockfile: boolean;
|
|
3586
|
+
```
|
|
3587
|
+
|
|
3588
|
+
- *Type:* boolean
|
|
3589
|
+
|
|
3590
|
+
If this is enabled, pnpm creates a single pnpm-lock.yaml file in the root of the workspace.
|
|
3591
|
+
|
|
3592
|
+
---
|
|
3593
|
+
|
|
3594
|
+
##### `shellEmulator`<sup>Optional</sup> <a name="shellEmulator" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.shellEmulator"></a>
|
|
3595
|
+
|
|
3596
|
+
```typescript
|
|
3597
|
+
public readonly shellEmulator: boolean;
|
|
3598
|
+
```
|
|
3599
|
+
|
|
3600
|
+
- *Type:* boolean
|
|
3601
|
+
|
|
3602
|
+
When true, pnpm will use a JavaScript implementation of a bash-like shell to execute scripts.
|
|
3603
|
+
|
|
3604
|
+
---
|
|
3605
|
+
|
|
3606
|
+
##### `sideEffectsCache`<sup>Optional</sup> <a name="sideEffectsCache" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.sideEffectsCache"></a>
|
|
3607
|
+
|
|
3608
|
+
```typescript
|
|
3609
|
+
public readonly sideEffectsCache: boolean;
|
|
3610
|
+
```
|
|
3611
|
+
|
|
3612
|
+
- *Type:* boolean
|
|
3613
|
+
|
|
3614
|
+
Use and cache the results of (pre/post)install hooks.
|
|
3615
|
+
|
|
3616
|
+
---
|
|
3617
|
+
|
|
3618
|
+
##### `sideEffectsCacheReadonly`<sup>Optional</sup> <a name="sideEffectsCacheReadonly" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.sideEffectsCacheReadonly"></a>
|
|
3619
|
+
|
|
3620
|
+
```typescript
|
|
3621
|
+
public readonly sideEffectsCacheReadonly: boolean;
|
|
3622
|
+
```
|
|
3623
|
+
|
|
3624
|
+
- *Type:* boolean
|
|
3625
|
+
|
|
3626
|
+
Only use the side effects cache if present, do not create it for new packages.
|
|
3627
|
+
|
|
3628
|
+
---
|
|
3629
|
+
|
|
3630
|
+
##### `stateDir`<sup>Optional</sup> <a name="stateDir" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.stateDir"></a>
|
|
3631
|
+
|
|
3632
|
+
```typescript
|
|
3633
|
+
public readonly stateDir: string;
|
|
3634
|
+
```
|
|
3635
|
+
|
|
3636
|
+
- *Type:* string
|
|
3637
|
+
|
|
3638
|
+
The location where all the packages are saved on the disk.
|
|
3639
|
+
|
|
3640
|
+
---
|
|
3641
|
+
|
|
3642
|
+
##### `storeDir`<sup>Optional</sup> <a name="storeDir" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.storeDir"></a>
|
|
3643
|
+
|
|
3644
|
+
```typescript
|
|
3645
|
+
public readonly storeDir: string;
|
|
3646
|
+
```
|
|
3647
|
+
|
|
3648
|
+
- *Type:* string
|
|
3649
|
+
|
|
3650
|
+
The location where all the packages are saved on the disk.
|
|
3651
|
+
|
|
3652
|
+
---
|
|
3653
|
+
|
|
3654
|
+
##### `strictDepBuilds`<sup>Optional</sup> <a name="strictDepBuilds" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.strictDepBuilds"></a>
|
|
3655
|
+
|
|
3656
|
+
```typescript
|
|
3657
|
+
public readonly strictDepBuilds: boolean;
|
|
3658
|
+
```
|
|
3659
|
+
|
|
3660
|
+
- *Type:* boolean
|
|
3661
|
+
|
|
3662
|
+
When strictDepBuilds is enabled, the installation will exit with a non-zero exit code if any dependencies have unreviewed build scripts (aka postinstall scripts).
|
|
3663
|
+
|
|
3664
|
+
---
|
|
3665
|
+
|
|
3666
|
+
##### `strictPeerDependencies`<sup>Optional</sup> <a name="strictPeerDependencies" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.strictPeerDependencies"></a>
|
|
3667
|
+
|
|
3668
|
+
```typescript
|
|
3669
|
+
public readonly strictPeerDependencies: boolean;
|
|
3670
|
+
```
|
|
3671
|
+
|
|
3672
|
+
- *Type:* boolean
|
|
3673
|
+
|
|
3674
|
+
If this is enabled, commands will fail if there is a missing or invalid peer dependency in the tree.
|
|
3675
|
+
|
|
3676
|
+
---
|
|
3677
|
+
|
|
3678
|
+
##### `strictSsl`<sup>Optional</sup> <a name="strictSsl" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.strictSsl"></a>
|
|
3679
|
+
|
|
3680
|
+
```typescript
|
|
3681
|
+
public readonly strictSsl: boolean;
|
|
3682
|
+
```
|
|
3683
|
+
|
|
3684
|
+
- *Type:* boolean
|
|
3685
|
+
|
|
3686
|
+
Whether or not to do SSL key validation when making requests to the registry via HTTPS.
|
|
3687
|
+
|
|
3688
|
+
---
|
|
3689
|
+
|
|
3690
|
+
##### `strictStorePkgContentCheck`<sup>Optional</sup> <a name="strictStorePkgContentCheck" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.strictStorePkgContentCheck"></a>
|
|
3691
|
+
|
|
3692
|
+
```typescript
|
|
3693
|
+
public readonly strictStorePkgContentCheck: boolean;
|
|
3694
|
+
```
|
|
3695
|
+
|
|
3696
|
+
- *Type:* boolean
|
|
3697
|
+
|
|
3698
|
+
Some registries allow the exact same content to be published under different package names and/or versions.
|
|
3699
|
+
|
|
3700
|
+
---
|
|
3701
|
+
|
|
3702
|
+
##### `supportedArchitectures`<sup>Optional</sup> <a name="supportedArchitectures" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.supportedArchitectures"></a>
|
|
3703
|
+
|
|
3704
|
+
```typescript
|
|
3705
|
+
public readonly supportedArchitectures: SupportedArchitectures;
|
|
3706
|
+
```
|
|
3707
|
+
|
|
3708
|
+
- *Type:* <a href="#@alma-cdk/construct-library.SupportedArchitectures">SupportedArchitectures</a>
|
|
3709
|
+
|
|
3710
|
+
Specifies architectures for which you'd like to install optional dependencies, even if they don't match the architecture of the system running the install.
|
|
3711
|
+
|
|
3712
|
+
---
|
|
3713
|
+
|
|
3714
|
+
##### `symlink`<sup>Optional</sup> <a name="symlink" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.symlink"></a>
|
|
3715
|
+
|
|
3716
|
+
```typescript
|
|
3717
|
+
public readonly symlink: boolean;
|
|
3718
|
+
```
|
|
3719
|
+
|
|
3720
|
+
- *Type:* boolean
|
|
3721
|
+
|
|
3722
|
+
When symlink is set to false, pnpm creates a virtual store directory without any symlinks.
|
|
3723
|
+
|
|
3724
|
+
It is a useful setting together with nodeLinker=pnp.
|
|
3725
|
+
|
|
3726
|
+
---
|
|
3727
|
+
|
|
3728
|
+
##### `syncInjectedDepsAfterScripts`<sup>Optional</sup> <a name="syncInjectedDepsAfterScripts" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.syncInjectedDepsAfterScripts"></a>
|
|
3729
|
+
|
|
3730
|
+
```typescript
|
|
3731
|
+
public readonly syncInjectedDepsAfterScripts: string[];
|
|
3732
|
+
```
|
|
3733
|
+
|
|
3734
|
+
- *Type:* string[]
|
|
3735
|
+
|
|
3736
|
+
Injected workspace dependencies are collections of hardlinks, which don't add or remove the files when their sources change.
|
|
3737
|
+
|
|
3738
|
+
---
|
|
3739
|
+
|
|
3740
|
+
##### `tag`<sup>Optional</sup> <a name="tag" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.tag"></a>
|
|
3741
|
+
|
|
3742
|
+
```typescript
|
|
3743
|
+
public readonly tag: string;
|
|
3744
|
+
```
|
|
3745
|
+
|
|
3746
|
+
- *Type:* string
|
|
3747
|
+
|
|
3748
|
+
If you pnpm add a package and you don't provide a specific version, then it will install the package at the version registered under the tag from this setting.
|
|
3749
|
+
|
|
3750
|
+
---
|
|
3751
|
+
|
|
3752
|
+
##### `trustPolicy`<sup>Optional</sup> <a name="trustPolicy" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.trustPolicy"></a>
|
|
3753
|
+
|
|
3754
|
+
```typescript
|
|
3755
|
+
public readonly trustPolicy: string;
|
|
3756
|
+
```
|
|
3757
|
+
|
|
3758
|
+
- *Type:* string
|
|
3759
|
+
|
|
3760
|
+
When set to no-downgrade, pnpm will fail if a package's trust level has decreased compared to previous releases.
|
|
3761
|
+
|
|
3762
|
+
For example, if a package was previously published by a trusted publisher but now only has provenance or no trust evidence, installation will fail. This helps prevent installing potentially compromised versions.
|
|
3763
|
+
|
|
3764
|
+
---
|
|
3765
|
+
|
|
3766
|
+
##### `trustPolicyExclude`<sup>Optional</sup> <a name="trustPolicyExclude" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.trustPolicyExclude"></a>
|
|
3767
|
+
|
|
3768
|
+
```typescript
|
|
3769
|
+
public readonly trustPolicyExclude: string[];
|
|
3770
|
+
```
|
|
3771
|
+
|
|
3772
|
+
- *Type:* string[]
|
|
3773
|
+
|
|
3774
|
+
You can now list one or more specific packages or versions that pnpm should allow to install, even if those packages don't satisfy the trust policy requirement.
|
|
3775
|
+
|
|
3776
|
+
---
|
|
3777
|
+
|
|
3778
|
+
##### `trustPolicyIgnoreAfter`<sup>Optional</sup> <a name="trustPolicyIgnoreAfter" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.trustPolicyIgnoreAfter"></a>
|
|
3779
|
+
|
|
3780
|
+
```typescript
|
|
3781
|
+
public readonly trustPolicyIgnoreAfter: number;
|
|
3782
|
+
```
|
|
3783
|
+
|
|
3784
|
+
- *Type:* number
|
|
3785
|
+
|
|
3786
|
+
Allows ignoring the trust policy check for packages published more than the specified number of minutes ago.
|
|
3787
|
+
|
|
3788
|
+
This is useful when enabling strict trust policies, as it allows older versions of packages (which may lack a process for publishing with signatures or provenance) to be installed without manual exclusion, assuming they are safe due to their age.
|
|
3789
|
+
|
|
3790
|
+
---
|
|
3791
|
+
|
|
3792
|
+
##### `unsafePerm`<sup>Optional</sup> <a name="unsafePerm" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.unsafePerm"></a>
|
|
3793
|
+
|
|
3794
|
+
```typescript
|
|
3795
|
+
public readonly unsafePerm: boolean;
|
|
3796
|
+
```
|
|
3797
|
+
|
|
3798
|
+
- *Type:* boolean
|
|
3799
|
+
|
|
3800
|
+
Set to true to enable UID/GID switching when running package scripts.
|
|
3801
|
+
|
|
3802
|
+
If set explicitly to false, then installing as a non-root user will fail.
|
|
3803
|
+
|
|
3804
|
+
---
|
|
3805
|
+
|
|
3806
|
+
##### `updateConfig`<sup>Optional</sup> <a name="updateConfig" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.updateConfig"></a>
|
|
3807
|
+
|
|
3808
|
+
```typescript
|
|
3809
|
+
public readonly updateConfig: UpdateConfig;
|
|
3810
|
+
```
|
|
3811
|
+
|
|
3812
|
+
- *Type:* <a href="#@alma-cdk/construct-library.UpdateConfig">UpdateConfig</a>
|
|
3813
|
+
|
|
3814
|
+
---
|
|
3815
|
+
|
|
3816
|
+
##### `updateNotifier`<sup>Optional</sup> <a name="updateNotifier" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.updateNotifier"></a>
|
|
3817
|
+
|
|
3818
|
+
```typescript
|
|
3819
|
+
public readonly updateNotifier: boolean;
|
|
3820
|
+
```
|
|
3821
|
+
|
|
3822
|
+
- *Type:* boolean
|
|
3823
|
+
|
|
3824
|
+
When true, pnpm will check for updates to the installed packages and notify the user.
|
|
3825
|
+
|
|
3826
|
+
---
|
|
3827
|
+
|
|
3828
|
+
##### `useBetaCli`<sup>Optional</sup> <a name="useBetaCli" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.useBetaCli"></a>
|
|
3829
|
+
|
|
3830
|
+
```typescript
|
|
3831
|
+
public readonly useBetaCli: boolean;
|
|
3832
|
+
```
|
|
3833
|
+
|
|
3834
|
+
- *Type:* boolean
|
|
3835
|
+
|
|
3836
|
+
Experimental option that enables beta features of the CLI.
|
|
3837
|
+
|
|
3838
|
+
---
|
|
3839
|
+
|
|
3840
|
+
##### `useNodeVersion`<sup>Optional</sup> <a name="useNodeVersion" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.useNodeVersion"></a>
|
|
3841
|
+
|
|
3842
|
+
```typescript
|
|
3843
|
+
public readonly useNodeVersion: string;
|
|
3844
|
+
```
|
|
3845
|
+
|
|
3846
|
+
- *Type:* string
|
|
3847
|
+
|
|
3848
|
+
Specifies which exact Node.js version should be used for the project's runtime.
|
|
3849
|
+
|
|
3850
|
+
---
|
|
3851
|
+
|
|
3852
|
+
##### `useStderr`<sup>Optional</sup> <a name="useStderr" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.useStderr"></a>
|
|
3853
|
+
|
|
3854
|
+
```typescript
|
|
3855
|
+
public readonly useStderr: boolean;
|
|
3856
|
+
```
|
|
3857
|
+
|
|
3858
|
+
- *Type:* boolean
|
|
3859
|
+
|
|
3860
|
+
When true, all the output is written to stderr.
|
|
3861
|
+
|
|
3862
|
+
---
|
|
3863
|
+
|
|
3864
|
+
##### `verifyDepsBeforeRun`<sup>Optional</sup> <a name="verifyDepsBeforeRun" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.verifyDepsBeforeRun"></a>
|
|
3865
|
+
|
|
3866
|
+
```typescript
|
|
3867
|
+
public readonly verifyDepsBeforeRun: boolean | string;
|
|
3868
|
+
```
|
|
3869
|
+
|
|
3870
|
+
- *Type:* boolean | string
|
|
3871
|
+
|
|
3872
|
+
This setting allows the checking of the state of dependencies before running scripts.
|
|
3873
|
+
|
|
3874
|
+
---
|
|
3875
|
+
|
|
3876
|
+
##### `verifyStoreIntegrity`<sup>Optional</sup> <a name="verifyStoreIntegrity" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.verifyStoreIntegrity"></a>
|
|
3877
|
+
|
|
3878
|
+
```typescript
|
|
3879
|
+
public readonly verifyStoreIntegrity: boolean;
|
|
3880
|
+
```
|
|
3881
|
+
|
|
3882
|
+
- *Type:* boolean
|
|
3883
|
+
|
|
3884
|
+
By default, if a file in the store has been modified, the content of this file is checked before linking it to a project's node_modules.
|
|
3885
|
+
|
|
3886
|
+
---
|
|
3887
|
+
|
|
3888
|
+
##### `virtualStoreDir`<sup>Optional</sup> <a name="virtualStoreDir" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.virtualStoreDir"></a>
|
|
3889
|
+
|
|
3890
|
+
```typescript
|
|
3891
|
+
public readonly virtualStoreDir: string;
|
|
3892
|
+
```
|
|
3893
|
+
|
|
3894
|
+
- *Type:* string
|
|
3895
|
+
|
|
3896
|
+
The directory with links to the store.
|
|
3897
|
+
|
|
3898
|
+
---
|
|
3899
|
+
|
|
3900
|
+
##### `virtualStoreDirMaxLength`<sup>Optional</sup> <a name="virtualStoreDirMaxLength" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.virtualStoreDirMaxLength"></a>
|
|
3901
|
+
|
|
3902
|
+
```typescript
|
|
3903
|
+
public readonly virtualStoreDirMaxLength: number;
|
|
3904
|
+
```
|
|
3905
|
+
|
|
3906
|
+
- *Type:* number
|
|
3907
|
+
|
|
3908
|
+
Sets the maximum allowed length of directory names inside the virtual store directory (node_modules/.pnpm).
|
|
3909
|
+
|
|
3910
|
+
---
|
|
3911
|
+
|
|
3912
|
+
##### `workspaceConcurrency`<sup>Optional</sup> <a name="workspaceConcurrency" id="@alma-cdk/construct-library.PnpmWorkspaceSpecification.property.workspaceConcurrency"></a>
|
|
3913
|
+
|
|
3914
|
+
```typescript
|
|
3915
|
+
public readonly workspaceConcurrency: number;
|
|
3916
|
+
```
|
|
3917
|
+
|
|
3918
|
+
- *Type:* number
|
|
3919
|
+
|
|
3920
|
+
Set the maximum number of tasks to run simultaneously.
|
|
3921
|
+
|
|
3922
|
+
For unlimited concurrency use Infinity. You can set the value to <= 0 and it will use amount of CPU cores of the host minus the absolute value of the provided number as: max(1, (number of cores) - abs(workspaceConcurrency)).
|
|
3923
|
+
|
|
3924
|
+
---
|
|
3925
|
+
|
|
3926
|
+
### SupportedArchitectures <a name="SupportedArchitectures" id="@alma-cdk/construct-library.SupportedArchitectures"></a>
|
|
3927
|
+
|
|
3928
|
+
#### Initializer <a name="Initializer" id="@alma-cdk/construct-library.SupportedArchitectures.Initializer"></a>
|
|
3929
|
+
|
|
3930
|
+
```typescript
|
|
3931
|
+
import { SupportedArchitectures } from '@alma-cdk/construct-library'
|
|
3932
|
+
|
|
3933
|
+
const supportedArchitectures: SupportedArchitectures = { ... }
|
|
3934
|
+
```
|
|
3935
|
+
|
|
3936
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
3937
|
+
|
|
3938
|
+
| **Name** | **Type** | **Description** |
|
|
3939
|
+
| --- | --- | --- |
|
|
3940
|
+
| <code><a href="#@alma-cdk/construct-library.SupportedArchitectures.property.cpu">cpu</a></code> | <code>string[]</code> | *No description.* |
|
|
3941
|
+
| <code><a href="#@alma-cdk/construct-library.SupportedArchitectures.property.libc">libc</a></code> | <code>string[]</code> | *No description.* |
|
|
3942
|
+
| <code><a href="#@alma-cdk/construct-library.SupportedArchitectures.property.os">os</a></code> | <code>string[]</code> | *No description.* |
|
|
3943
|
+
|
|
3944
|
+
---
|
|
3945
|
+
|
|
3946
|
+
##### `cpu`<sup>Optional</sup> <a name="cpu" id="@alma-cdk/construct-library.SupportedArchitectures.property.cpu"></a>
|
|
3947
|
+
|
|
3948
|
+
```typescript
|
|
3949
|
+
public readonly cpu: string[];
|
|
3950
|
+
```
|
|
3951
|
+
|
|
3952
|
+
- *Type:* string[]
|
|
3953
|
+
|
|
3954
|
+
---
|
|
3955
|
+
|
|
3956
|
+
##### `libc`<sup>Optional</sup> <a name="libc" id="@alma-cdk/construct-library.SupportedArchitectures.property.libc"></a>
|
|
3957
|
+
|
|
3958
|
+
```typescript
|
|
3959
|
+
public readonly libc: string[];
|
|
3960
|
+
```
|
|
3961
|
+
|
|
3962
|
+
- *Type:* string[]
|
|
3963
|
+
|
|
3964
|
+
---
|
|
3965
|
+
|
|
3966
|
+
##### `os`<sup>Optional</sup> <a name="os" id="@alma-cdk/construct-library.SupportedArchitectures.property.os"></a>
|
|
3967
|
+
|
|
3968
|
+
```typescript
|
|
3969
|
+
public readonly os: string[];
|
|
3970
|
+
```
|
|
3971
|
+
|
|
3972
|
+
- *Type:* string[]
|
|
3973
|
+
|
|
3974
|
+
---
|
|
3975
|
+
|
|
3976
|
+
### UpdateConfig <a name="UpdateConfig" id="@alma-cdk/construct-library.UpdateConfig"></a>
|
|
3977
|
+
|
|
3978
|
+
#### Initializer <a name="Initializer" id="@alma-cdk/construct-library.UpdateConfig.Initializer"></a>
|
|
3979
|
+
|
|
3980
|
+
```typescript
|
|
3981
|
+
import { UpdateConfig } from '@alma-cdk/construct-library'
|
|
3982
|
+
|
|
3983
|
+
const updateConfig: UpdateConfig = { ... }
|
|
3984
|
+
```
|
|
3985
|
+
|
|
3986
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
3987
|
+
|
|
3988
|
+
| **Name** | **Type** | **Description** |
|
|
3989
|
+
| --- | --- | --- |
|
|
3990
|
+
| <code><a href="#@alma-cdk/construct-library.UpdateConfig.property.ignoreDependencies">ignoreDependencies</a></code> | <code>string[]</code> | *No description.* |
|
|
3991
|
+
|
|
3992
|
+
---
|
|
3993
|
+
|
|
3994
|
+
##### `ignoreDependencies`<sup>Optional</sup> <a name="ignoreDependencies" id="@alma-cdk/construct-library.UpdateConfig.property.ignoreDependencies"></a>
|
|
3995
|
+
|
|
3996
|
+
```typescript
|
|
3997
|
+
public readonly ignoreDependencies: string[];
|
|
3998
|
+
```
|
|
3999
|
+
|
|
4000
|
+
- *Type:* string[]
|
|
4001
|
+
|
|
4002
|
+
---
|
|
4003
|
+
|
|
1801
4004
|
|
|
1802
4005
|
|