跳到主内容
版本:6.x

.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-hoisttrue 与设置 public-hoist-pattern* 是一样的。

shamefully-hoist

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

  • Default: false
  • Type: 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

添加于:v5.9.0

  • 默认值: true
  • Type: Boolean

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

enable-modules-dir

添加于:v5.15.0

  • 默认值: true
  • Type: 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
  • Type: Boolean

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

prefer-frozen-lockfile

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

  • 默认值:true(自 v1.38.0 起)
  • Type: Boolean

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

注册源 & 身份验证设置

registry

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

<URL>:always-auth

  • Default: false
  • Type: Boolean

在访问指定的注册源时,强制 pnpm 验证身份(即使是 GET 请求)。 例如:

@babel:registry=https://gitlab.com/api/v4/packages/npm/
//gitlab.com/api/v4/packages/npm/:always-auth=true

registry=https://registry.npmjs.org/
//registry.npmjs.org/:always-auth=true

请求设置

ca

  • 默认值:npm CA 证书
  • 类型:字符串、数组或 null

设置通过 SSL 连接源服务器时所使用的 CA 证书 值应采用 PEM 格式(AKA “Base-64 encoded X.509 (.CER)”)。 例如:

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

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

通过指定 CA 数组来信任多个 CA:

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

另请参阅 strict-ssl 配置项。

cafile

  • 默认值:null
  • 类型:path

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

cert

  • 默认值:null
  • 类型:String

访问注册表时要传递的客户端证书。 值应为 PEM 格式(又被称作 “Base-64 编码的 X.509 (.CER)格式")。 例如:

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

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

https-proxy

  • 默认值:null
  • 类型:url

用于传出 HTTPS 请求的代理。 如果设置了 HTTPS_PROXYhttps_proxyHTTP_PROXYhttp_proxy 环境变量,将使用环境变量的值。

key

  • 默认值:null
  • 类型:String

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

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

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

local-address

  • 默认值:undefined
  • 类型:IP 地址

与注册源建立连接时要使用的本地接口的 IP 地址。

proxy

  • 默认值:null
  • 类型:url

用于传输 http 请求的代理。 如果设置了 HTTP_PROXY 或 http_proxy 环境变量,则底层请求库将遵循代理设置。

最大套接字

添加于:v6.18.0

  • 默认值:network-concurrency x 3
  • 类型:Number

每个源使用的最大连接数(协议/主机/端口组合)。

noproxy

添加于:v5.18.8

  • 默认值:null
  • 类型:String

不应该使用代理的以逗号分隔的域名扩展字符串。

strict-ssl

  • 默认值: true
  • Type: Boolean

通过 HTTPS 向注册源发出请求时是否进行 SSL 密钥验证。

另请参阅 ca 配置项。

network-concurrency

  • 默认值:16
  • 类型:Number

控制同时处理的最大 HTTP(S) 的网络请求数。

fetch-retries

  • 默认值:2
  • 类型:Number

如果 pnpm 无法从注册源中获取,重试多少次。

fetch-retry-factor

  • 默认值:10
  • 类型:Number

重试回退的指数因子。

fetch-retry-mintimeout

  • 默认值:10000(10 秒)
  • 类型:Number

重试请求的最小(基本)超时。

fetch-retry-maxtimeout

  • 默认值:60000(1 分钟)
  • 类型:Number

最大回退超时以确保重试因子不会使请求时间过长。

fetch-timeout

添加于:v6.2.0

  • 默认值:60000(1 分钟)
  • 类型:Number

等待 HTTP 请求完成的最长时间。

Peer Dependency 设置

auto-install-peers

添加于:v6.26.0

  • Default: false
  • Type: Boolean

当值为 true 时,将自动安装任何缺少的非可选同级依赖关系。

strict-peer-dependencies

添加于:v2.15.0

  • Default: false
  • Type: Boolean

如果启用了此选项,那么在依赖树中存在缺失或无效的 peer 依赖关系时,命令将执行失败。

命令行设置

[no-]color

添加于:v4.1.0

  • 默认值:auto
  • 类型:auto, always, never

设置输出的颜色.

  • 自动 - 当标准输出是终端或 TTY 时,输出使用颜色。
  • 总是 - 忽略终端和管道之间的区别。 你很少需要这个选项; 在大多数情况下,如果您想在重定向的输出中使用颜色代码,您可以将 --color 标志传递给 pnpm 命令以强制它输出颜色。 默认设置几乎总是您想要的。
  • never - 关闭颜色. 这是 --no-color 使用的设置。

loglevel

添加于:v4.13.0

  • 默认值:info
  • 类型:debug, info, warn, error

将显示等于或高于给定级别的任何日志。 您可以改为传递 --silent 来关闭所有输出日志。

use-beta-cli

添加于:v3.6.0

  • Default: false
  • Type: Boolean

启用 CLI 测试版功能的实验性选项。 这意味着您可能得到会对 CLI 功能进行一些不兼容的更改或潜在错误的更改。

recursive-install

添加于:v5.4.0

  • 默认值: true
  • Type: Boolean

如果启用此选项,则 pnpm install 的主要行为将变为 pnpm install -r,这意味着在所有工作区或子目录包上执行安装。

否则, pnpm install 将在当前目录中专门构建包。

engine-strict

  • Default: false
  • Type: Boolean

如果启用该选项,pnpm 将不安装任何声称不与当前 Node 版本兼容的包。

不管这种配置如何,如果项目(不是依赖项)在其 engines 字段中指定了不兼容的版本,则安装总是会失败。

npm-path

添加于:v4.8.0

  • 类型:path

pnpm 用于某些操作(例如发布)的 npm 的二进制文件的位置。

构建设置

child-concurrency

  • 默认值:5
  • 类型:Number

同时分配的最大子进程数以构建 node_modules。

side-effects-cache

添加于:v1.31.0

  • Default: false
  • Type: Boolean

使用和缓存 (pre/post)install 钩子的结果。

side-effects-cache-readonly

添加于:v1.31.0

  • Default: false
  • Type: Boolean

仅在副作用缓存存在时使用,不要为新包创建它。

unsafe-perm

  • 默认值:如果以 root 身份运行则为 false ,否则为 true
  • Type: Boolean

设置为 true 以便在运行包脚本时启用 UID/GID 切换。 如果显式设置为 false,则以非 root 用户身份安装将失败。

Node.js 设置

use-node-version

添加于:v6.5.0

  • 默认值:undefined
  • 类型:semver

指定应用于项目运行时的确切 Node.js 版本。 pnpm 将自动安装指定版本的 Node.js 并将其用于执行 pnpm run 命令或 pnpm node 命令。

node-mirror:<releaseDir>

添加于:v6.24.0

  • 默认值: https://nodejs.org/download/<releaseDir>/
  • 类型:URL

设置用于下载 Node.js 的基本 URL。 此设置的 <releaseDir> 部分可以是 https://nodejs.org/download: release, rc, nightly, v8-canary 等中的任何目录。

以下是如何配置 pnpm 从中国的 Node.js 镜像下载 Node.js:

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

添加于:v2.5.0

  • Default: false
  • Type: Boolean

只允许使用存储服务器进行安装。 如果存储服务器没有在运行,安装将失败。

save-prefix

  • 默认值:'^'
  • 类型:String

配置软件包在 package.json 文件中的版本前缀。

例如,如果一个包的版本为 1.2.3,默认情况下它的版本设置为 ^1.2.3 允许对该包进行小版本升级,但在 pnpm config set save-prefix='~' 之后,它将设置为 ~1.2.3 仅允许补丁版本升级。

当添加的程序包指定了范围时,将忽略此设置。 例如,pnpm add foo@2 将会把 package.jsonfoo 的版本设置为 2,而忽略 save-prefix的值。

tag

  • 默认值:latest
  • 类型:String

如果您 pnpm add 一个包并且您没有提供特定版本,那么它将安装这个包在设置中的标记下注册的版本。

如果 pnpm tag 命令没有给出明确的标签,这也会设置的标签添加到指定的 package@version

global-dir

添加于:v4.2.0

  • 默认值:<path to node>/pnpm-global
  • 类型:path

指定储存全局依赖的目录。

global-bin-dir

添加于:v6.15.0

允许设置全局安装包的 bin 文件的目标目录。

state-dir

添加于:v6.10.0

  • 默认值:$XDG_STATE_HOME/pnpm
  • 类型:path

pnpm 创建的当前仅由更新检查器使用的 pnpm-state.json 文件的目录。

cache-dir

添加于:v6.10.0

  • 默认值:$XDG_CACHE_HOME/pnpm
  • 类型:path

包元数据缓存的位置。

use-stderr

添加于:v6.5.0

  • Default: false
  • Type: Boolean

当为 true 时,所有输出都写入 stderr。

extend-node-path

添加于:v6.16.0

  • 默认值: true
  • Type: Boolean

false时,命令 shims 中不会设置 NODE_PATH 环境变量。 如果在运行命令时遇到如下错误,建议将此设置设置为 false

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

update-notifier

添加于:v6.29.0

  • 默认值: true
  • Type: Boolean

设置为 false 以便在使用较旧版本的 pnpm 时关闭更新通知。