npm link 使用指南

npm link 使用指南

npm link 是一个非常有用的命令，主要用于在开发过程中将本地 npm 包链接到全局 npm 目录，从而可以在其他项目中使用这个本地包，而不需要发布到 npm 仓库。

基本用法

1. 创建全局链接

进入你要链接的本地包的根目录，执行以下命令：

npm link

这个命令会在全局 npm 目录中创建一个符号链接，指向你当前的本地包。

2. 在项目中使用链接的包

接下来，进入你希望使用这个本地包的项目目录，然后运行以下命令：

npm link <package-name>

其中 <package-name> 是你本地包的名称（通常在 package.json 文件中的 name 字段定义）。这个命令会在项目的 node_modules 目录中创建一个符号链接，指向全局 npm 目录中的本地包。

3. 取消链接

如果你需要取消链接，可以按照以下步骤操作：

• 在项目目录中运行以下命令，取消项目中的链接：

  npm unlink <package-name>
  

• 在本地包目录中运行以下命令，取消全局链接：

  npm unlink
  

工作原理

• npm link 在全局 node_modules 目录中创建一个符号链接，指向本地包的目录。
• 在项目中使用 npm link <package-name> 时，会在项目的 node_modules 目录中创建一个符号链接，指向全局 node_modules 中的本地包。

如何确定包是否链接成功

1. 检查全局 node_modules 目录：

   • Linux/macOS: /usr/local/lib/node_modules
   • Windows: C:\Users\<YourUsername>\AppData\Roaming\npm\node_modules
     查看是否存在指向你本地包的符号链接。

2. 检查项目中的 node_modules 目录：

   • 查看是否存在指向你本地包的符号链接。
   • 使用 npm ls --link 查看当前项目引入的链接。

3. 尝试导入和使用包：

   • 在你的项目中尝试导入和使用链接的包，看看是否能够成功加载和使用。

注意事项

• 如果在全局 node_modules 目录下没有看到符号链接，可以尝试以下步骤：

  1. 确认全局 node_modules 目录位置：运行 npm config get prefix 查看全局 npm 目录的前缀路径。
  2. 检查权限：确保你有权限在全局 node_modules 目录中创建符号链接。
  3. 清除缓存：运行 npm cache clean --force，然后重新创建符号链接。

• 如果开发的是命令行工具，npm link 会在全局目录生成一个可执行文件，你可以直接在终端中使用。

---

通过这些步骤，你可以在本地开发过程中方便地测试和调试 npm 包，而无需每次都发布到 npm 仓库。