使用本地构建的npm包进行调试

Npm Link使用方法

简介

npm link可以用于替换包的路径，让项目以为包就安装在node_modules中

原理

1. 在my-package项目的根目录执行npm link会在全局目录下创建一个指向项目文件夹的符号链接(Symbolic Link)
2. 在my-app中执行npm link my-package会在my-app/mudule_modules/目录中将my-package的路径指向本地的my-package

使用方法

链接

cd */my-packages
npm link

cd */my-app
npm link my-packages

取消链接

cd */my-app
npm --no-save unlink my-packages
npm install

# 任意目录下
npm unlink my-packages -g

查看当前的全局链接

npm ls -g --link

注意事项

• 链接后，在my-app中执行npm install会使链接失效。更安全的做法是npm unlink my-package && npm install && npm link my-package

pnpm

推荐使用pnpm的overrides配置，在package.json中添加pnpm属性

{
  "pnpm": {
    "overrides": {
      "pkg": "link:../local-pkg"
    }
  }
}

扩展

• NPM Workspaces