npm link和npm unlink

在本地开发 Node.js 项目时，当需要调试本地开发的 npm 模块（或包）时，npm link 和 npm unlink 是非常有用的工具。

---

一、npm link 的作用

用于将本地开发的 npm 模块临时链接到全局，从而在其他项目中直接引用本地修改的代码，而无需发布到 npm 仓库或手动复制文件。

---

二、具体使用步骤

1. 创建模块的全局链接

假设你有一个本地开发的模块 my-module，需要将它链接到全局：

# 进入模块目录
cd path/to/my-module

# 在模块目录下执行
npm link

此时，my-module 会被链接到全局的 node_modules 目录（路径通常是 /usr/local/lib/node_modules）。

2. 在项目中引用链接的模块

假设你要在项目 my-project 中使用这个本地模块：

# 进入项目目录
cd path/to/my-project

# 链接全局的 my-module
npm link my-module

此时，项目中的 node_modules 目录下会生成一个符号链接指向你的本地模块。

---

3. 验证链接

在项目中检查模块路径：

# 查看模块的实际路径
npm ls my-module
# 或
ls -l node_modules/my-module

如果显示的是本地模块路径（如 ../../../my-module），说明链接成功。

---

三、npm unlink 的使用

用于解除模块的链接关系，恢复使用 npm 仓库中的版本。

1. 在项目中解除链接

# 进入项目目录
cd path/to/my-project

# 解除对 my-module 的链接
npm unlink my-module

# 重新安装原始依赖
npm install my-module

2. 全局移除模块链接

# 进入模块目录
cd path/to/my-module

# 移除全局链接
npm unlink

---

四、注意事项

1. 实时同步修改

   • 在本地模块中修改代码后，依赖它的项目会立即生效（无需重新构建或重启）。

2. 符号链接行为

   • npm link 创建的是符号链接（Symlink），操作系统级生效。

3. 依赖安装问题

   • 如果链接的模块依赖其他包，需要确保在模块目录中运行 npm install。

4. 多版本冲突

   • 如果全局已存在同名包，npm link 会覆盖它，需谨慎操作。

---

五、常见问题解决

1. 模块未找到（Module Not Found）

• 原因: 未在模块目录运行 npm link 或模块名称不匹配。
• 解决:

  # 确保模块的 package.json 中 name 字段正确
  # 重新执行链接操作
  

2. 修改未生效

• 原因: 可能缓存问题或路径错误。
• 解决:

  # 在项目中删除 node_modules 并重新链接
  rm -rf node_modules
  npm link my-module
  

3. 权限问题

• 原因: 全局安装需要管理员权限。
• 解决:

  # 使用 sudo（Linux/Mac）
  sudo npm link
  

---

六、替代方案

1. yarn link
   Yarn 的类似命令，行为与 npm link 一致。
2. npm install <path>
   直接通过路径安装本地模块：

   npm install ../my-module
   

---

八、总结

操作	命令	作用
创建全局链接	npm link（在模块目录）	将模块链接到全局
引用链接模块	npm link <package-name>	在项目中引用本地模块
解除项目链接	npm unlink <package-name>	恢复使用 npm 仓库的版本
移除全局链接	npm unlink（在模块目录）	删除全局链接

通过 npm link，你可以高效地在本地调试多个相互依赖的模块，提升开发效率。