跳至主要内容
版本: 9.x

pnpm link

别名: ln

使当前本地包在系统范围内或其他位置可用。

pnpm link <dir>
pnpm link --global
pnpm link --global <pkg>

选项​

--dir <dir>, -C​

  • 默认: 当前工作目录
  • 类型: 路径字符串

将链接位置更改为 <dir>。

pnpm link <dir>​

将 <dir> 文件夹中的包链接到执行此命令的包的 node_modules，或通过 --dir 选项指定的包。

例如，如果您在 ~/projects/foo 中，并且您执行 pnpm link --dir ../bar，那么 foo 将链接到 bar/node_modules/foo。

pnpm link --global​

将执行此命令的位置或通过 --dir 选项指定的包链接到全局 node_modules，以便可以通过 pnpm link --global <pkg> 从另一个包中引用它。此外，如果包具有 bin 字段，那么包的二进制文件将在系统范围内可用。

pnpm link --global <pkg>​

将指定的包 (<pkg>) 从全局 node_modules 链接到执行此命令的包的 node_modules，或通过 --dir 选项指定的包。

pnpm link <dir> 和 pnpm link --dir <dir> 之间的区别​

pnpm link <dir> 将 <dir> 中的包链接到执行命令的包的 node_modules。pnpm link --dir <dir> 将当前工作目录中的包链接到 <dir>。

# The current directory is foo
pnpm link ../bar

- foo
  - node_modules
    - bar -> ../../bar
- bar

# The current directory is bar
pnpm link --dir ../foo

- foo
  - node_modules
    - bar -> ../../bar
- bar

用例​

用本地版本替换已安装的包​

假设您有一个使用 foo 包的项目。您想更改 foo 并测试它们在您的项目中。在这种情况下，您可以使用 pnpm link 将 foo 的本地版本链接到您的项目，而 package.json 不会被修改。

cd ~/projects/foo
pnpm install # install dependencies of foo
pnpm link --global # link foo globally
cd ~/projects/my-project
pnpm link --global foo # link foo to my-project

您还可以将一个目录中的包链接到另一个目录，而无需使用全局 node_modules 文件夹。

cd ~/projects/foo
pnpm install # install dependencies of foo
cd ~/projects/my-project
pnpm link ~/projects/foo # link foo to my-project

全局添加二进制文件​

如果您正在开发一个具有二进制文件的包，例如 CLI 工具，您可以使用 pnpm link --global 使二进制文件在系统范围内可用。这与使用 pnpm install -g foo 相同，但它将使用 foo 的本地版本而不是从注册表下载它。

请记住，只有当包的 package.json 中有 bin 字段时，二进制文件才会可用。

cd ~/projects/foo
pnpm install # install dependencies of foo
pnpm link --global # link foo globally

pnpm link 和使用 file: 协议有什么区别？​

当您使用 pnpm link 时，链接的包将从源代码中进行符号链接。您可以修改链接包的源代码，并且更改将反映在您的项目中。使用此方法，pnpm 不会安装链接包的依赖项，您必须在源代码中手动安装它们。当您必须为链接包使用特定的包管理器时，这可能很有用，例如，如果您想为链接包使用 npm，但为您的项目使用 pnpm。

当您在 dependencies 中使用 file: 协议时，链接的包将硬链接到您的项目 node_modules，您可以修改链接包的源代码，并且更改将反映在您的项目中。使用此方法，pnpm 还会安装链接包的依赖项，覆盖链接包的 node_modules。

info

在处理对等依赖项时，建议使用 file: 协议。它可以更好地从项目依赖项中解析对等依赖项，确保链接的依赖项正确使用您的主项目中指定的依赖项版本，从而导致更一致和预期的行为。

特性pnpm linkfile: 协议
符号链接/硬链接符号链接硬链接
反映源代码修改是是
安装链接包的依赖项否（需要手动安装）是（覆盖链接包的 node_modules）
为依赖项使用不同的包管理器可能（例如，为链接的包使用 npm）否，它将使用 pnpm