JavaScript monorepo 中用 workspaces 配置多包,需在根 package.json 设 workspaces 字段指定子包路径,各子包须有含 name 和 version 的 package.json,执行 npm install 后自动软链,支持跨包直接引用。

在 JavaScript 项目中,用 workspaces 配置多包单体仓库(monorepo)非常直接,核心是让 npm 或 yarn(v1+)识别子包目录,并自动处理依赖链接与发布逻辑。
1. 基础配置:在根 package.json 中声明 workspaces
只需在项目根目录的 package.json 中添加 workspaces 字段,指定包含独立 package.json 的子目录路径:
{
"name": "my-monorepo",
"private": true,
"workspaces": [
"packages/*",
"apps/*",
"libs/utils"
]
}
说明:
-
"packages/*"匹配packages/下所有含package.json的子目录(如packages/ui、packages/api-client) -
"libs/utils"可精确匹配单个包(适合结构不规则时) -
"private": true强烈建议加上——防止误发布根包
2. 子包要求:每个 workspace 必须有独立的 package.json
每个被引用的目录(如 packages/button)必须包含合法的 package.json,至少含 name 和 version:
// packages/button/package.json
{
"name": "@my-org/button",
"version": "0.1.0",
"main": "dist/index.js"
}
注意:
DMap GL地图JSAPI(dmapgl)开发指南。用于编写、审查、调试 DMap 地图 API 代码,涵盖地图初始化、覆盖物渲染、图层管理、事件处理、控件交互等任务。当用户提及 dmap、dmapgl、jsapi‑gl 或相关地图开发需求时自动触发。
- 包名建议用作用域(
@scope/name),避免命名冲突 - 版本可设为
0.0.0或占位符,实际发布时再更新(工具如changesets或lerna可辅助)
3. 安装与链接:运行一次 install 即自动软链
执行 npm install(或 yarn install)后,npm 会:
- 把所有 workspace 包安装到根
node_modules中 - 自动创建符号链接(symlink),使
@my-org/button在其他 workspace 中可直接import或require - 跨包依赖无需手动
npm link,也不用发布到 registry
例如:packages/form 中写 import Button from '@my-org/button',运行时能正确解析。
4. 实用技巧与常见注意点
让 workspaces 更好用的关键细节:
-
避免循环依赖:npm 不报错但运行时可能出问题,可用
madge --circular .检查 -
脚本透传:在根
package.json中定义"scripts": { "build": "npm run build --workspaces" },即可批量执行所有 workspace 的build脚本 -
选择性运行:用
--workspace=xxx指定单个包,如npm run dev --workspace=@my-org/app-web -
Node.js 版本兼容:workspaces 是 npm v7+ 原生支持,yarn v1 需开启
workspaces: true(.yarnrc),yarn berry(v3+)默认启用
不复杂但容易忽略:确保所有 workspace 目录下都有 package.json,且没有语法错误;否则 npm install 会静默跳过该包,导致链接失败。

















