在JavaScript库开发中，经常需要在实际项目中测试库的功能。pnpm link 是一个强大的工具，它允许开发者将本地开发的包加入到其他项目中，以便于测试和调试。本文将详细介绍 pnpm link 的使用，包括两种主要的链接模式，并对一些潜在问题进行解析。

全局链接允许你将库发布到本地全局环境中，从而可以轻松地在任何其他本地项目中使用它。

步骤 1: 在全局环境中发布库

首先，在库的根目录下执行 pnpm link 命令，这将创建一个全局的符号链接。

步骤 2: 将全局链接的包加入到项目

在目标项目中，使用 pnpm link <package-name> 命令，将全局环境中的包链接到项目中。

取消全局链接

  • 全局取消: 在任何位置执行 pnpm remove --global <package-name> 来取消所有项目与该包的链接。
  • 个别项目取消: 如果项目 package.json 中已包含该依赖，使用 pnpm unlink <package-name> 命令取消链接。如果 package.json 中没有包含，需要手动从 node_modules 移除相关文件。

注意事项

pnpm link -g 支持含有 bin 文件的包，允许在任何地方执行包的二进制文件。但自2022年5月起，有报告指出该功能在 pnpm 7 中存在问题，且在 8.12.1 版本中问题依旧。如果你的包包含 bin 部分，可能无法通过 link -g 指令在系统各处直接运行它的二进制文件。

目录链接允许你直接将一个本地包链接到另一个项目，而无需通过全局环境。

方法一：在目标项目中链接库

在目标项目的根目录下执行 pnpm link <path-to-library> 命令。

方法二：从库中链接目标项目

在库的根目录下执行 pnpm link <path-to-target-project> 命令。

取消目录链接

无论使用哪种方法进行目录链接，取消链接的操作都在目标项目中进行，使用 pnpm unlink <package-name> 命令。

总结

pnpm link 提供了一种在本地环境中链接包的便捷方式，类似于 npm link 和 yarn link。尽管 pnpm 的官方文档提供了基本的使用说明，但在实际应用中，可能需要更多的细节和特定情境的处理。本文旨在提供更全面的使用细节，帮助 pnpm 开发者实现更高效的开发流程。

请注意，pnpm link 的某些功能，如全局二进制，可能存在问题。随着 pnpm 的不断更新和改进，我们期待这些问题在未来版本中得到解决。本文将适时更新，以提供最新信息。