npm link——本地调试npm模块的利器

435 阅读1分钟

概述

在开发npm模块时,经常需要调试。每次发版调试,或者把代码复制到项目文件夹调试,效率较低,也很不优雅。

使用npm link命令可以在本地调试npm模块,大大提高了debug效率。

使用流程

为了方便阐述,我们先明确几个名词

  • project-a:项目a,使用npm模块的项目
  • module-b:模块b,待调试的npm模块

一、建立link

1、链接module-b
cd ~/projects/module-b
npm link

# output:{prefix}/node_modules/module-b -> ~/projects/module-b

执行成功后,会在npm的全局安装路径(可以通过npm prefix -g命令查看)下,创建一个软链,该软链指向module-b的本地路径

image.png
2、链接project-a
cd ~/projects/project-a
npm link module-b

# output: ~/projects/project-a/node_modules/module-b -> {prefix}/node_modules/module-b -> ~/projects/module-b

image.png

通过这两步建立链接,~/projects/module-b中的任何修改,都会映射在~/projects/project-a/node_modules/module-b/中。

二、解除link

1、
cd ~/project-a
npm unlink module-b
2、
cd ~/module-b
npm unlink

三、NOTE

  1. npm link <package-name>package-name取自package.json,而不是目录名称;