npm link 使用指南

358 阅读1分钟

概述

npm link 是一个用于开发阶段的有力工具,使开发者能够在本地测试和调试正在开发的 npm 包,无需通过 npm 注册表发布。

使用步骤

1. 构建和链接包

# 进入包目录并构建
cd /path/to/sentry-collector
npm run build

# 创建全局链接
npm link

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

# 进入目标项目
cd /path/to/your-project

# 链接到全局包
npm link sentry-collector

完成上述步骤后,您可以在项目中正常导入并使用该包。

3. 更新链接包

当修改了包的源代码后:

# 在包目录中重新构建
cd /path/to/sentry-collector
npm run build

链接项目会自动使用新构建的版本,无需其他操作。

4. 解除链接

开发测试完成后,解除链接关系:

# 在目标项目中
npm unlink sentry-collector

# 在包目录中
npm unlink

注意事项

  • 确保在链接前已正确构建包
  • 包名需与 package.json 中定义的名称一致
  • 不同环境可能需要管理员/超级用户权限执行链接操作

适用场景

  • 本地开发和测试 npm 包
  • 在发布前验证包的功能
  • 多项目协同开发时快速测试依赖更新