pnpm link
别名:ln
使当前本地包在系统范围内或另一个位置可访问。
pnpm link <dir|pkg name>
pnpm link
选项
pnpm link <dir>
将 <dir> 目录中的包链接到执行此命令的包的 node_modules 中。
例如,如果你在
~/projects/foo目录中并执行pnpm link ../bar,则会在foo/node_modules/bar中创建一个指向bar的链接。
pnpm link
将包从执行此命令的位置链接到全局 node_modules,这样就可以通过 pnpm link <pkg> 在其他包中引用它。如果该包有 bin 字段,则包的二进制文件将在系统范围内可用。
pnpm link <pkg>
将指定包(<pkg>)从全局 node_modules 链接到执行此命令的包的 node_modules 中。
使用场景
用本地版本替换已安装的包
假设你有一个项目使用了 foo 包。你想对 foo 进行修改并在项目中测试它们。在这种情况下,你可以使用 pnpm link 将 foo 的本地版本链接到你的项目。
cd ~/projects/foo
pnpm install # 安装 foo 的依赖项
pnpm link # 全局链接 foo
cd ~/projects/my-project
pnpm link foo # 将 foo 链接到 my-project
你也可以直接将一个目录中的包链接到另一个目录,而无需使用全局 node_modules 目录:
cd ~/projects/foo
pnpm install # 安装 foo 的依赖项
cd ~/projects/my-project
pnpm link ~/projects/foo # 将 foo 链接到 my-project
添加全局二进制文件
如果你正在开发一个包含二进制文件的包,例如 CLI 工具,你可以使用 pnpm link 使该二进制文件在系统范围内可用。
这与使用 pnpm install -g foo 相同,但会使用 foo 的本地版本而非从注册表下载。
请注意,只有当包在其 package.json 中有 bin 字段时,二进制文件才可用。
cd ~/projects/foo
pnpm install # 安装 foo 的依赖项
pnpm link # 全局链接 foo
pnpm link 与 file: 协议的区别?
当你使用 pnpm link 时,链接的包是从源代码进行符号链接的。你可以修改链接包的源代码,更改将在你的项目中反映出来。通过这种方法,pnpm 不会安装链接包的依赖项,你需要手动在源代码中安装它们。这在你必须为链接包使用特定包管理器时可能很有用,例如如果你想为链接包使用 npm,但为你的项目使用 pnpm。
当你在 dependencies 中使用 file: 协议时,链接的包会被硬链接到你的项目 node_modules 中,你可以修改链接包的源代码,更改将在你的项目中反映出来。通过这种方法,pnpm 也会安装链接包的依赖项,覆盖链接包的 node_modules。
在处理 peer dependencies 时,建议使用 file: 协议。它能更好地从项目依赖项解析 peer dependencies,确保链接的依赖项正确使用主项目中指定的依赖项版本,从而导致更一致和预期的行为。
| 特性 | pnpm link | file: 协议 |
|---|---|---|
| 符号链接/硬链接 | 符号链接 | 硬链接 |
| 反映源代码修改 | 是 | 是 |
| 安装链接包的依赖项 | 否(需要手动安装) | 是(覆盖链接包的 node_modules) |
| 对依赖项使用不同包管理器 | 可能(例如,为链接包使用 npm) | 否,它将使用 pnpm |