.npmrc

.npmrc

pnpm 从命令行、环境变量和 .npmrc 文件中获取其配置。

pnpm config 命令可用于更新和编辑用户和全局 .npmrc 文件的内容。

四个相关文件分别为：

每个项目的配置文件（/path/to/my/project/.npmrc）
每个工作区的配置文件（包含 pnpm-workspace.yaml 文件的目录）
每位用户的配置文件（ ~/.npmrc ）
全局配置文件（ /etc/npmrc ）

所有 .npmrc 文件都遵循 INI-formatted 列表，包含 key = value 参数。

依赖提升设置

hoist

添加于：v4.0.0

默认值： true
类型： boolean

当 true，所有依赖项都被提升到 node_modules/.pnpm。这使得 node_modules所有包都可以访问未列出的依赖项。

hoist-pattern

添加于：v4.0.0

默认值： [‘*‘]
类型： string[]

告诉 pnpm 哪些包应该被提升到 node_modules/.pnpm。在默认情况下，所有的包都是被提升的，但是如果你知道只有一些有缺陷的包有幻影依赖关系，您可以使用此选项来只提升有幻影依赖关系的包(推荐)。

例如：

hoist-pattern[]=*eslint*
hoist-pattern[]=*babel*

public-hoist-pattern

添加于：v5.2.0

默认值： [‘*types*‘, ‘*eslint*‘, ‘@prettier/plugin-*‘, ‘*prettier-plugin-*‘]
类型： string[]

不同于 hoist-pattern 会把依赖提升到一个虚拟存储中的隐藏的模块目录中，public-hoist-pattern 将匹配的依赖提升至根模块目录中。提升至根模块目录中意味着应用代码可以访问到幻影依赖，即使他们对解析策略做了不当的修改。

当处理一些有缺陷的可插拔工具不能正确解析依赖关系时，此设置很有用。

例如：

public-hoist-pattern[]=*plugin*

注意：设置 shamefully-hoist 为 true 与设置 public-hoist-pattern 为 * 是一样的。

shamefully-hoist

添加于：v1.34.0 为 shamefully-flatten，在 v4.0.0 中重命名

默认值： false
类型：Boolean

默认情况下，pnpm 创建一个半严格的 node_modules，这意味着依赖项可以访问未声明的依赖项，但 node_modules 之外的模块不行。通过这种布局，生态系统中的大多数的包都可以正常工作。但是，如果某些工具仅在提升的依赖项位于根目录的 node_modules 时才有效，您可以将其设置为 true 来为您提升它们。

Node 模块设置

store-dir

添加于: v4.2.0 作为 store

默认值：~/.pnpm-store
类型：path

所有包被保存在磁盘上的位置。

该存储应始终位于进行安装的同一磁盘上，因此每个磁盘将有一个存储。如果磁盘上存在主目录，存储则会被创建在 <home dir>/.pnpm-store。如果磁盘上没有主目录，那么将在文件系统的根目录中创建该存储。例如，如果安装发生在挂载在 /mnt 的文件系统上，那么存储将在 /mnt/.pnpm-store 处创建。 Windows 系统上也是如此。

可以从不同的磁盘设置同一个存储，但在这种情况下，pnpm 将复制包而不是硬链接它们，因为硬链接只能发生在同一文件系统上。

modules-dir

添加于：v4.14.0

默认值：node_modules
类型：path

将安装依赖项的目录（而不是 node_modules）。

node-linker

添加于：v5.9.0

默认值：isolated
类型: isolated, hoisted, pnp

定义应该使用什么链接器来安装 Node 包。

isolated - 依赖项从虚拟存储 node_modules/.pnpm 中建立符号链接
hoisted - 创建一个没有符号链接的扁平的 node_modules。与 npm 或 Yarn Classic 创建 node_modules 一致。使用此设置的正当理由：
1. 您的工具不适用于符号链接。 React Native 项目很可能只有在你使用提升的 node_modules 才能工作。
2. 您的项目会被部署到 serverless 服务提供商。一些 serverless 提供商（例如 AWS Lambda）不支持符号链接。此问题的另一种解决方案是在部署之前打包您的应用程序。
3. 如果你想用 “bundledDependencies” 发布你的包。
4. 如果您使用 --preserve-symlinks 标志运行 Node.js。
pnp - 没有 node_modules。 Plug’n’Play 是一种 Yarn Berry 使用的创新的 Node 依赖策略。当使用 pnp 作为您的链接器时，建议同时将 symlink 设置为 false。

symlink

添加于：v5.9.0

默认值： true
类型：Boolean

当 symlink 设置为 false 时，pnpm 创建一个没有任何符号链接的虚拟存储目录。与 node-linker=pnp 一起是一个有用的设置。

enable-modules-dir

添加于：v5.15.0

默认值： true
类型：Boolean

当 false 时，pnpm 不会将任何文件写入模块目录（node_modules）。这对于在用户空间的文件系统 (FUSE) 中挂载模块目录时很有用。有一个实验性 CLI 允许您在 FUSE 中挂载模块目录：@pnpm/mount-modules。

virtual-store-dir

添加于：v4.1.0

默认值：node_modules/.pnpm
类型：path

带有指向存储的链接的目录。所有直接和间接依赖项都链接到此目录中。

这是一个有用的设置，可以解决 Windows 上长路径的问题。如果您有一些路径很长的依赖项，您可以选择将虚拟存储放在驱动器的根目录中（例如 C:\my-project-store）。

或者您可以将虚拟存储设置为 .pnpm 并将其添加到 .gitignore。这将使堆栈跟踪更清晰，因为依赖项的路径将会提高一个目录层级。

注意： 虚拟存储不能在多个项目之间共享。每个项目都应该有自己的虚拟存储（除了在工作空间中被共享的根目录）。

package-import-method

添加于: v1.25.0

默认值：auto
类型：auto, hardlink, copy, clone

控制从存储导入包的方式。

auto - 尝试从存储克隆包。如果不支持克隆则从存储硬链接包。如果克隆和链接都不支持，则回退到复制
hardlink - 从存储硬链接包
copy - 从存储复制包
clone - 从商店克隆（也称为 copy-on-write 或参考链接）包

modules-cache-max-age

添加于：v6.0.0

默认值： 10080 （以分钟为单位的 7 天）
类型：number

孤立包应该从模块目录中被删除的时间（以分钟为单位）。 pnpm 在模块目录中保存了一个包的缓存。切换分支或降级依赖项时，这会提高安装速度。

Lockfile 设置

lockfile

添加于：v1.32.0 作为 shrinkwrap

默认值： true
类型：Boolean

当设置为 false 时，pnpm 不会读取或生成 pnpm-lock.yaml 文件。

prefer-frozen-lockfile

添加于：v1.37.1 作为 prefer-frozen-shrinkwrap

默认值：true（自 v1.38.0 起）
类型：Boolean

当设置为 true 并且存在 pnpm-lock.yaml 满足 package.json 中的依赖关系时，执行无头安装。因此无头安装会直接跳过解析依赖项，并且不会修改lockfile

注册源 & 身份验证设置

registry

默认值：https://registry.npmjs.org/
类型：url

npm包注册源地址 (包括末尾斜杠) 。

<scope>:registry

用于指定包的注册源范围例如，设置 @babel:registry=https://example.com/packages/npm/ 将在您使用 pnpm add @babel/core 或任何 @babel 范围内的包时，该包将强制从 https://example.com/packages/npm 获取而不是默认注册源。

<URL>:_authToken

访问指定注册源时要使用的身份验证承载令牌。示例：

//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

您也可以使用环境变量。示例：

//registry.npmjs.org/:_authToken=${NPM_TOKEN}

<URL>:tokenHelper

添加于：v6.25.0

令牌助手是输出身份验证令牌的可执行文件。这可以用于 authToken 不是常量值而是定期刷新值的情况，其中脚本或其他工具可以使用现有的刷新令牌来获取新的访问令牌。

助手路径的配置必须是绝对路径，没有参数。为了安全起见，只允许在用户 .npmrc设置此值。否则，项目可以在项目的本地 .npmrc 放置一个值并运行任意可执行文件。

为默认注册表设置令牌助手：

tokenHelper=/home/ivan/token-generator

为指定注册源设置令牌助手：

//registry.corp.com:tokenHelper=/home/ivan/token-generator

请求设置

ca

默认值：The npm CA certificate
类型：String，Array 或 null

为与源服务器进行可信的 SSL 链接颁发的 CA 证书。值应采用 PEM 格式(也称 “Base-64 encoded X.509 (.CER)”)。示例：

ca="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"

设置为 null 时仅允许已知注册商，若指定 CA 证书将只信任指定的证书颁发机构。

通过指定一个证书数组，可以信任多个 CA：

ca[]="..."
ca[]="..."

更多信息可见 strict-ssl 设置

cafile

默认值：null
类型：path

包含一个或多个 CA 证书的文件路径。类似于 ca 设置，但允许将一个或多个 CA 信息存储在文件中，而不是通过命令行指定。

cert

默认值：null
类型：String

访问注册源时传递的客户端证书。值应为 PEM 格式(也称 “Base-64 encoded X.509 (.CER)”)。示例：

cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"

它不是证书文件的路径(也没有 certfile 选项)。

https-proxy

默认值：null
类型：url

用于传出 HTTPS 请求的代理。如果设置了 HTTPS_PROXY、 https_proxy、HTTP_PROXY 或 http_proxy 环境变量，将使用环境变量的值。

key

默认值：null
类型：String

访问注册源时传递的客户端密钥。值应采用 PEM 格式(也称 “Base-64 encoded X.509 (.CER)”)。示例：

key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"

它不是密钥文件的路径(也没有 keyfile 选项)。

local-address

Default: undefined
Type: IP Address

The IP address of the local interface to use when making connections to the npm registry.

proxy

默认值：null
类型：url

A proxy to use for outgoing http requests. If the HTTP_PROXY or http_proxy environment variables are set, proxy settings will be honored by the underlying request library.

maxsockets

Added in: v6.18.0

默认值：network-concurrency x 3
类型：Number

The maximum number of connections to use per origin (protocol/host/port combination).

noproxy

Added in: v5.18.8

默认值：null
类型：String

A comma-separated string of domain extensions that a proxy should not be used for.

strict-ssl

默认值： true
类型：Boolean

Whether or not to do SSL key validation when making requests to the registry via HTTPS.

network-concurrency

Default: 16
类型：Number

Controls the maximum number of HTTP(S) requests to process simultaneously.

fetch-retries

Default: 2
类型：Number

How many times to retry if pnpm fails to fetch from the registry.

fetch-retry-factor

Default: 10
类型：Number

The exponential factor for retry backoff.

fetch-retry-mintimeout

Default: 10000 (10 seconds)
类型：Number

The minimum (base) timeout for retrying requests.

fetch-retry-maxtimeout

默认值：60000（1 分钟）
类型：Number

The maximum fallback timeout to ensure the retry factor does not make requests too long.

fetch-timeout

添加于：v6.2.0

默认值：60000（1 分钟）
类型：Number

The maximum amount of time to wait for HTTP requests to complete.

Peer Dependency 设置

auto-install-peers

添加于：v6.26.0

默认值： false
类型：Boolean

When true, any missing non-optional peer dependencies are automatically installed.

strict-peer-dependencies

添加于：v2.15.0

默认值： false
类型：Boolean

If this is enabled, commands will fail if there is a missing or invalid peer dependency in the tree.

命令行设置

[no-]color

添加于：v4.1.0

默认值：auto
Type: auto, always, never

Controls colors in the output.

auto - output uses colors when the standard output is a terminal or TTY.
always - ignore the difference between terminals and pipes. You’ll rarely want this; in most scenarios, if you want color codes in your redirected output, you can instead pass a --color flag to the pnpm command to force it to use color codes. The default setting is almost always what you’ll want.
never - turns off colors. This is the setting used by --no-color.

loglevel

Added in: v4.13.0

Default: info
Type: debug, info, warn, error

Any logs at or higher than the given level will be shown. You can instead pass --silent to turn off all output logs.

use-beta-cli

Added in: v3.6.0

默认值： false
类型：Boolean

Experimental option that enables beta features of the CLI. This means that you may get some changes to the CLI functionality that are breaking changes, or potentially bugs.

recursive-install

Added in: v5.4.0

默认值： true
类型：Boolean

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.

Else, pnpm install will exclusively build the package in the current directory.

engine-strict

默认值： false
类型：Boolean

If this is enabled, pnpm will not install any package that claims to not be compatible with the current Node version.

Regardless of this configuration, installation will always fail if a project (not a dependency) specifies an incompatible version in its engines field.

npm-path

添加于：v4.8.0

类型：path

The location of the npm binary that pnpm uses for some actions, like publishing.

构建设置

child-concurrency

Default: 5
类型：Number

The maximum number of child processes to allocate simultaneously to build node_modules.

side-effects-cache

Added in: v1.31.0

默认值： false
类型：Boolean

Use and cache the results of (pre/post)install hooks.

side-effects-cache-readonly

Added in: v1.31.0

默认值： false
类型：Boolean

Only use the side effects cache if present, do not create it for new packages.

unsafe-perm

默认值：true, 如果以 root 身份运行则为 false
类型：Boolean

Set to true to enable UID/GID switching when running package scripts. If set explicitly to false, then installing as a non-root user will fail.

Node.js 设置

use-node-version

添加于：v6.5.0

Default: undefined
Type: semver

Specifies which exact Node.js version should be used for the project’s runtime. pnpm will automatically install the specified version of Node.js and use it for running pnpm run commands or the pnpm node command.

node-mirror:<releaseDir>

添加于：v6.24.0

Default: https://nodejs.org/download/<releaseDir>/
Type: URL

Sets the base URL for downloading Node.js. The <releaseDir> portion of this setting can be any directory from https://nodejs.org/download: release, rc, nightly, v8-canary, etc.

Here is how pnpm may be configured to download Node.js from Node.js mirror in China:

node-mirror:release=https://npmmirror.com/mirrors/node/
node-mirror:rc=https://npmmirror.com/mirrors/node-rc/
node-mirror:nightly=https://npmmirror.com/mirrors/node-nightly/

其它设置

use-running-store-server

Added in: v2.5.0

默认值： false
类型：Boolean

Only allows installation with a store server. If no store server is running, installation will fail.

save-prefix

Default: ‘^’
类型：String

Configure how versions of packages installed to a package.json file get prefixed.

For example, if a package has version 1.2.3, by default its version is set to ^1.2.3 which allows minor upgrades for that package, but after pnpm config set save-prefix='~' it would be set to ~1.2.3 which only allows patch upgrades.

This setting is ignored when the added package has a range specified. For instance, pnpm add foo@2 will set the version of foo in package.json to 2, regardless of the value of save-prefix.

global-dir

Added in: v4.2.0

Default: <path to node>/pnpm-global
类型：path

Specify a custom directory to store global packages.

global-bin-dir

添加于：v6.15.0

Allows to set the target directory for the bin files of globally installed packages.

state-dir

添加于：v6.10.0

Default: $XDG_STATE_HOME/pnpm
类型：path

The directory where pnpm creates the pnpm-state.json file that is currently used only by the update checker.

cache-dir

添加于：v6.10.0

Default: $XDG_CACHE_HOME/pnpm
类型：path

The location of the package metadata cache.

use-stderr

添加于：v6.5.0

默认值： false
类型：Boolean

When true, all the output is written to stderr.

extend-node-path

添加于：v6.16.0

默认值： true
类型：Boolean

When false, the NODE_PATH environment variable is not set in the command shims. It is recommended to set this setting to false if you are getting the next error, when running commands:

The input line is too long. The syntax of the command is incorrect.

update-notifier

Added in: v6.29.0

默认值： true
类型：Boolean

Set to false to suppress the update notification when using an older version of pnpm than the latest.

.npmrc

.npmrc

依赖提升设置

hoist

hoist-pattern

public-hoist-pattern

shamefully-hoist

Node 模块设置

store-dir

modules-dir

node-linker

symlink

enable-modules-dir

virtual-store-dir

package-import-method

modules-cache-max-age

Lockfile 设置

lockfile

prefer-frozen-lockfile

注册源 & 身份验证设置

registry

<scope>:registry

<URL>:_authToken

<URL>:tokenHelper

请求设置

ca

cafile

cert

https-proxy

key

local-address

proxy

maxsockets

noproxy

strict-ssl

network-concurrency

fetch-retries

fetch-retry-factor

fetch-retry-mintimeout

fetch-retry-maxtimeout

fetch-timeout

Peer Dependency 设置

auto-install-peers

strict-peer-dependencies

命令行设置

[no-]color

loglevel

use-beta-cli

recursive-install

engine-strict

npm-path

构建设置

child-concurrency

side-effects-cache

side-effects-cache-readonly

unsafe-perm

Node.js 设置

use-node-version

node-mirror:<releaseDir>

其它设置

use-running-store-server

save-prefix

tag

global-dir

global-bin-dir

state-dir

cache-dir

use-stderr

extend-node-path

update-notifier