@alma-cdk/construct-library 0.0.12 → 0.0.14

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