如何在NPM工作区外的项目中使用工作区内的库

问题背景 #

我有个单仓项目Green，里面的calculator库要用到独立仓库Yellow项目里，想知道怎么实现，是不是必须把库发布到注册表才能用？

Green项目结构 #

+-- Green
+-- package.json
`-- app
   +-- HelloWorld
   |   `-- package.json
`-- library
   `-- calculator
   |   `-- package.json

Yellow项目结构 #

.
+-- Yellow
+-- package.json
`-- app

实现方案 #

不用非得发布到注册表，有三种常用方式：

1. npm link 本地链接 #

这是本地调试最常用的方式，能实时同步代码修改：

• 进入Green项目的calculator目录，执行：
  npm link
  这会把calculator库注册到npm全局包目录。
• 切换到Yellow项目根目录，执行：
  npm link @your-scope/calculator
  （把@your-scope/calculator换成calculator的package.json里的name字段）
  之后Yellow项目就会直接引用本地的calculator库，改完calculator代码后，重启Yellow项目就能看到效果（如果calculator需要构建，要先重新构建）。

2. 本地文件路径直接引用 #

直接在Yellow的package.json里指定依赖的本地路径：

{
  "dependencies": {
    "@your-scope/calculator": "file:../Green/library/calculator"
  }
}

然后执行npm install，npm会自动把calculator关联到Yellow的node_modules里。

• 优点：配置简单，无需全局操作
• 缺点：calculator更新后，得重新执行npm install才能同步；路径要确保正确，换机器或环境可能需要调整。

3. 发布到注册表（适合团队共享/生产环境） #

如果要给团队协作使用或者部署到生产环境，就把calculator发布到npm官方注册表或者私有注册表（比如Verdaccio、Nexus）：

• 先确认calculator的package.json里name、version、main等核心配置正确
• 进入calculator目录执行npm publish（私有包需添加--access restricted或配置好私有scope）
• 之后在Yellow项目里执行npm install @your-scope/calculator即可安装使用。

补充：NPM工作区说明 #

NPM工作区是用于管理单仓多包项目的功能，它允许你在一个根目录下管理多个关联包，实现依赖共享、批量执行脚本等操作。工作区内的包可以直接通过相对路径互相引用，但外部项目需要通过上述方法来关联使用。

内容的提问来源于stack exchange，提问作者Navin Leon