.npmrc
pnpm 从命令行、环境变量和 .npmrc
文件中获取其配置。
pnpm config
命令可用于更新和编辑 用户和全局 .npmrc
文件的内容。
四个相关文件分别为:
- 每个项目的配置文件(
/path/to/my/project/.npmrc
) - 每个工作区的配置文件(包含
pnpm-workspace.yaml
文件的目录) - 每位用户的配置文件(
~/.npmrc
) - 全局配置文件(
/etc/npmrc
)
所有 .npmrc
文件都遵循 INI-formatted 列表,包含 key = value
参数。
.npmrc
文件中的值可能包含使用 ${NAME}
语法的环境变量。 也可以使用默认值指定环境变量。 运行 ${NAME-fallback}
,如果 NAME
不存在,命令会输出 fallback
。 运行 ${NAME-fallback}
,如果 NAME
不存在或为空,命令会输出 fallback
。
依赖提升设置
hoist
- 默认值: true
- 类型: boolean
当 hoist 为 true
时,所有依赖项都会被提升到 node_modules/.pnpm/node_modules
。 这使得 node_modules
所有包都可以访问 未列出的依赖项。
hoist-workspace-packages
添加于:v8.14.0
- 默认值: false
- 类型: boolean
当 true
时,工作区中的包将符号链接到 <workspace_root>/node_modules/.pnpm/node_modules
或 <workspace_root>/node_modules
,具体取决于其他提升设置(hoist-pattern
和 public-hoist-pattern
) 。
hoist-pattern
- 默认值: ['*']
- 类型: string[]
告诉 pnpm 哪些包应该被提升到 node_modules/.pnpm/node_modules
。 默认情况下,所有包都被提升 — 但是,如果你知道只有某些有缺陷的包具有幻影依赖,你可以使用此选项专门提升幻影依赖(推荐做法)。
例如:
hoist-pattern[]=*eslint*
hoist-pattern[]=*babel*
从 v7. 开始, 您还可以在模式 pattern 前面添加 !
来避免提升。
例如:
hoist-pattern[]=*types*
hoist-pattern[]=!@types/react
public-hoist-pattern
- 默认值: ['*eslint*', '*prettier*']
- 类型: string[]
不同于 hoist-pattern
会把依赖提升到一个虚拟存储中的隐藏的模块目录中,public-hoist-pattern
将匹配的依赖提升至根模块目录中。 提升至根模块目录中意味着应用代码可以访问到幻影依赖,即使它们对解析策略做了不当的修改。
当处理一些不能正确解析依赖关系的有缺陷可插拔工具时,此设置很有用。
例如:
public-hoist-pattern[]=*plugin*
注意:设置 shamefully-hoist
为 true
与设置 public-hoist-pattern
为 *
是一样的。
从 v7. 开始, 您还可以在模式 pattern 前面添加 !
来避免提升。
例如:
public-hoist-pattern[]=*types*
public-hoist-pattern[]=!@types/react
shamefully-hoist
- 默认值: false
- 类型:Boolean
默认情况下,pnpm 创建一个半严格的 node_modules
,这意味着依赖项可以访问未声明的依赖项,但 node_modules
之外的模块不行。 通过这种布局,生态系统中的大多数的包都可以正常工作。 但是,如果某些工具仅在提升的依赖项位于根目录的 node_modules
时 才有效,你可以将其设置为 true
来提升它们。
Node 模块设置
store-dir
- 默认值:
- 如果设置了 $PNPM_HOME 环境变量,则为 $PNPM_HOME/store
- 如果设置了 $XDG_DATA_HOME 环境变量,则为 $XDG_DATA_HOME/pnpm/store
- 在 Windows 上: ~/AppData/Local/pnpm/store
- 在 macOS 上: ~/Library/pnpm/store
- 在 Linux 上: ~/.local/share/pnpm/store
- 类型:path
所有包被保存在磁盘上的位置。
该存储应始终位于进行安装的同一磁盘上,因此每个磁盘将有一个存储。 如果在使用磁盘中具有主目录,存储目录就会创建在这里。 如果磁盘上没有主目录,那么将在文件系统的根目录中创建该存储。 例如,如果安装发生在挂载在 /mnt
的文件系统上,那么存储将在 /mnt/.pnpm-store
处创建。 Windows 系统上也是如此。
可以从不同的磁盘设置同一个存储,但在这种情况下,pnpm 将复制包而不是硬链接它们,因为硬链接只能发生在同一文件系统上。
modules-dir
- 默认值:node_modules
- 类型:path
将安装依赖项的目录 (而不是 node_modules
)。
node-linker
- 默认值:isolated
- 类型: isolated, hoisted, pnp
定义应该使用什么链接器来安装 Node 包。
- isolated - 依赖项从虚拟存储
node_modules/.pnpm
中建立符号链接 - hoisted - 创建一个没有符号链接的扁平的
node_modules
。 与 npm 或 Yarn Classic 创建node_modules
一致。 当使用此设置时,Yarn 的一个库用于提升。 使用此设置的正当理由:- 你的工具无法很好地与符号链接配合使用。 React Native 项目很可能只有在你使用提升的
node_modules
才能工作。 - 你的项目会被部署到 serverless 服务提供商。 一些 serverless 提供商(例如 AWS Lambda)不支持符号链接。 此问题的另一种解决方案是在部署之前打包你的应用程序。
- 如果你想用
"bundledDependencies"
发布你的包。 - 如果你使用 --preserve-symlinks 标志运行 Node.js。
- 你的工具无法很好地与符号链接配合使用。 React Native 项目很可能只有在你使用提升的
- pnp - 没有
node_modules
。 Plug'n'Play 是一种 Yarn Berry 使用的创新的 Node 依赖策略。 当使用pnp
作为你的链接器时,建议同时将symlink
设置为false
。
symlink
- 默认值: true
- 类型:Boolean
当 symlink
设置为 false
时,pnpm 创建一个没有任何符号链接的虚拟存储目录。 与 node-linker=pnp
一起是一个有用的设置。
enable-modules-dir
- 默认值: true
- 类型:Boolean
当 false
时,pnpm 不会将任何文件写入模块目录(node_modules
)。 这对于在用户空间的文件系统 (FUSE) 中挂载模块目录时很有用。 有一个实验性 CLI 允许您在 FUSE 中挂载模块目录:@pnpm/mount-modules。
virtual-store-dir
- 默认值:node_modules/.pnpm
- 类型:path
带有指向存储的链接的目录。 所有直接和间接依赖项都链接到此目录中。
这是一个有用的设置,可以解决 Windows 上长路径的问题。 如果你有一些路径很长的依赖项,你可以选择将虚拟存储放在驱动器的根目录中(例如 C:\my-project-store
)。
或者你可以将虚拟存储设置为 .pnpm
并将其添加到 .gitignore
。 这将使堆栈跟踪更清晰,因为依赖项的路径将会提高一个目录层级。
注意: 虚拟存储不能在多个项目之间共享。 每个项目都应该有自己的虚拟存储(除了在工作空间中被共享的根目录)。
package-import-method
- 默认值:auto
- 类型:auto, hardlink, copy, clone, clone-or-copy
控制从存储中导入包的方式(如果要禁用 node_modules
中的符号链接,则需要更改 node-linker 设置,而不是此设置)。
- auto - 尝试从存储克隆包。 如果不支持克隆则从存储硬链接包。 如果克隆和链接都不支持,则回退到复制
- hardlink - 从存储硬链接包
- clone-or-copy - 尝试从存储中克隆包。 如果不支持克隆则回退到复制。
- copy - 从存储中复制包
- clone - 从存储中克隆(也称为 copy-on-write 或参考链接)包
克隆是将包写入 node_modules 的最佳方式。 这是最快的方式,也是最安全的方式。 当使用克隆时,你可以在 node_modules 中编辑文件,并且它们不会在中央内容可寻址存储中被修改。
不幸的是,并非所有文件系统都支持克隆。 我们建议使用写时复制 (CoW) 文件系统(例如,在 Linux 上使用 Btrfs 而不是 Ext4)以获得最佳的 pnpm 体验。
modules-cache-max-age
- 默认值: 10080 (以分钟为单位的 7 天)
- 类型:number
孤立包应该从模块目录中被删除的时间(以分钟为单位)。 pnpm 在模块目录中保存了一个包的缓存。 切换分支或降级依赖项时,这会提高安装速度。
锁文件设置
lockfile
- 默认值: true
- 类型:Boolean
当设置为 false
时,pnpm 不会读取或生成 pnpm-lock.yaml
文件。
prefer-frozen-lockfile
- 默认值: true
- 类型:Boolean
当设置为 true
并且存在 pnpm-lock.yaml
满足 package.json
中的依赖关系时,执行无头安装。 无头安装会跳过所有依赖项解析,因为它不需要修改锁文件。
lockfile-include-tarball-url
- 默认值: false
- 类型:Boolean
将包的 tarball 的完整 URL 添加到 pnpm-lock.yaml
中的每个条目。
git-branch-lockfile
- 默认值: false
- 类型:Boolean
如果设置为 true
,那么在安装后生成的 lockfile 名称将基于当前分支名称命名,以完全避免合并冲突。 例如,如果当前分支名称为 feature-foo
,则 对应的锁文件名称将为 pnpm-lock.feature-foo.yaml
而不是 pnpm-lock.yaml
。 它通常与命令行参数 --merge-git-branch-lockfiles
一起使用,或者通过在 .npmrc
文件中设置 merge-git-branch-lockfiles-branch-pattern
来使用。
merge-git-branch-lockfiles-branch-pattern
- 默认值:null
- 类型: Array or null
此配置匹配当前分支名称以确定是否合并所有 git 分支锁文件文件。 默认情况下,您需要手动传递 --merge-git-branch-lockfiles
命令行参数。 这项配置允许自动完成这个过程。
例如:
merge-git-branch-lockfiles-branch-pattern[]=main
merge-git-branch-lockfiles-branch-pattern[]=release*
你还可以使用 !
来排除模式。
注册源 & 身份验证设置
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}
或者,您可以直接使用环境变量,而不更改 .npmrc
:
npm_config_//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
<URL>:tokenHelper
令牌助手是输出身份验证令牌的可执行文件。 这可以用于 authToken 不是常量值而是定期刷新值的情况,其中脚本或其他工具可以使用现有的刷新令牌来获取新的访问令牌。
助手路径的配置必须是绝对路径,没有参数。 为了安全起见,只允许在用户 .npmrc
设置此值。 否则,项目可以在项目的本地 .npmrc
放置一个值并运行任意可执行文件。
为默认注册表设置令牌助手:
tokenHelper=/home/ivan/token-generator
为指定注册源设置令牌助手:
//registry.corp.com:tokenHelper=/home/ivan/token-generator
请求设置
ca
- 默认值:npm CA 证书
- 类型:String,Array 或 null
与注册源 SSL 连接时使用的受信任的证书颁发机构签名证书。 值应采用 PEM 格式(AKA “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 信息存储在文件中,而不是通过 CLI 指定。
cert
- 默认值:null
- 类型:String
访问注册源时要传递的客户端证书。 值应采用 PEM 格式(AKA “Base-64 encoded X.509 (.CER)”)。 示例:
cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
它不是证书文件的路径(并且没有 certfile
选项)。
key
- 默认值:null
- 类型:String
访问注册源时传递的客户端密钥。 值应采用 PEM 格式( 也称 “Base-64 encoded X.509 (.CER)”)。 示例:
key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"
它不是密钥文件的路径(也没有 keyfile
选项)。
这个设置含有敏感信息! 不要将其写入本地会提交到仓库的 .npmrc
文件。
git-shallow-hosts
- 默认值: ['github.com', 'gist.github.com', 'gitlab.com', 'bitbucket.com', 'bitbucket.org']
- 类型: string[]
当获取 Git 仓库中的依赖项时,如果域名在此设置中列出,pnpm 将使用浅克隆仅获取所需的提交,而不是所有历史记录。
https-proxy
- 默认值:null
- 类型:url
用于传出 HTTPS 请求的代理。 如果设置了 HTTPS_PROXY
、 https_proxy
、HTTP_PROXY
或 http_proxy
环境变量,将使用环境变量的值。
如果您的代理 URL 包含用户名和密码,请确保对它们进行 URL 编码。 例如:
https-proxy=https://use%21r:pas%2As@my.proxy:1234/foo
不要对用户名和密码之间的冒号 (:
) 进行编码。