NodeJS脚本如何导入Monorepo中的本地@packages/utils包？

问题分析 #

• Node.js默认无法识别@packages/utils这类自定义包名指向本地子包，必须通过Monorepo工具配置包链接，或手动指定模块解析路径。
• 单独在scripts目录执行yarn install会触发npm registry拉取@packages包，不符合本地包使用场景，必然失败。
• 使用相对路径导入时，模块解析路径变为从当前脚本目录向上查找，导致utils依赖的aws-resource-library无法在正确的node_modules路径中找到。

解决方案 #

方案1：使用Yarn Workspaces（推荐，标准Monorepo管理方式） #

1. 在项目根目录创建package.json，配置Workspaces：

{
  "name": "referral-domain",
  "private": true,
  "workspaces": [
    "packages/*"
  ]
}

2. 在根目录执行yarn install，Yarn会自动将所有packages/*下的本地包链接到根目录的node_modules中，同时统一安装所有子包的依赖到根目录，实现依赖共享。
3. 此时scripts中require('@packages/utils')可正常解析，且aws-resource-library这类依赖会被所有子包共享调用，不会出现找不到的问题。

方案2：手动指定模块解析路径（无Monorepo工具时临时方案） #

修改scripts包的package.json中的启动脚本，添加--module-path参数指定本地包根目录：

{
  "scripts": {
    "myScript": "node -r dotenv/config --max-old-space-size=8192 --module-path ../../ ./data/myScript.js"
  }
}

或在myScript.js最顶部添加环境变量配置：

process.env.NODE_PATH = '../../';
require('module').Module._initPaths();

注意：NODE_PATH是Node.js不推荐的旧特性，存在兼容性和维护性问题，仅作为临时方案使用。

关键说明 #

• 不要单独在子包目录执行yarn install，Monorepo应通过根目录统一安装依赖，避免重复安装和本地包解析错误。
• 使用Monorepo工具（Yarn Workspaces/npm workspaces/Lerna）是解决这类问题的标准方案，能自动处理本地包链接、依赖共享和版本管理。

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