npm-link 基本用法
介绍
npm link
是一个非常有用的命令,用于在开发过程中将本地 npm 包链接到全局 npm 目录,从而可以在其他项目中使用这个本地包,而不需要发布到 npm 仓库。
使用教程
- 创建链接
进入你要链接的本地包的根目录,执行命令:
npm link
这个命令会在全局 npm
目录中创建一个符号链接,指向你当前的本地包。
有时候 npm 缓存问题会导致创建失败,可尝试执行
npm cache clean --force
来清除缓存并重新创建符号链接。
- 使用链接
在自己的项目中使用已链接的包,执行命令:
npm link <package_name>
其中 <package_name>
是你本地包的名称(通常在 package.json
文件中的 name
字段定义)。这个命令会在项目的 node_modules
目录中创建一个符号链接,指向全局 npm 目录中的本地包。
- 取消链接
i. 在项目目录中运行以下命令,取消项目中的链接:
npm unlink <package_name>
ii. 在本地包目录中运行以下命令,取消全局链接:
npm unlink
通过这些步骤,你可以在本地开发过程中方便地测试和调试 npm
包,而不需要每次都发布到 npm
仓库。
FAQ
如何确定包是否链接成功
- 检查全局
node_modules
目录,查看是否存在指向你本地包的符号链接。
通常情况下,它通常位于以下路径:
Linux/macOS:/usr/local/lib/node_modules
Windows:C:\Users\<USER_NAME>\AppData\Roaming\npm\node_modules
- 检查项目中
node_modules
目录,查看是否存在指向你本地包的符号链接。
使用
npm ls --link
查看当前项目引入的链接
- 尝试导入和使用包