pnpm link

别名: ln

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

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

配置项

--dir <dir>, -C

• 默认值：当前工作目录
• 类型：路径

将 link 位置改为 <dir>.

pnpm link <dir>

从执行此命令的路径或通过 <dir> 指定的文件夹，链接package到node_modules中。

例如，如果你正处于 ~/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 链接到 package 的 node_modules，从该 package 中执行或通过 --dir 选项指定。

pnpm link <dir> 与 pnpm link --dir <dir>的不同

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

# 当前目录是 foo
pnpm link ../bar

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

# 当前目录是 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

全局添加二进制文件

如果您正在开发一个包含二进制文件的软件包（例如命令行工具），则可以使用 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: protocol 有什么区别？

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

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

提示

When dealing with peer dependencies it is recommended to use the file: protocol. It better resolves the peer dependencies from the project dependencies, ensuring that the linked dependency correctly uses the versions of the dependencies specified in your main project, leading to more consistent and expected behaviors.

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