1.背景:
在大型项目中,随着功能迭代,代码越来越重,需要抽离公用的组件作为子仓库来引用(git submodules),在项目中拥有多个包,每个包的package.json较难维护,使用npm workspace可以解决这个问题。
2.npm workspace的作用
Workspaces 指的是 npm cli 中的一组功能,这些功能支持在一个顶级根包中管理本地文件系统中的多个包。
这组功能弥补了处理来自本地文件系统的链接包的更精简的工作流程。在npm安装过程中自动链接,避免手动使用 npm link 来引用需要符号链接到当前node_modules文件夹中的包。
3.如何使用workspace
1.在根目录中新建package.json文件,里面写顶部包的配置项,workspace中的地址可以自定义
{
"name": "root-project",
"workspaces": [ "packages/*" ]
}
2.新建packages文件夹,这个是workspace规定的文件夹名称,将项目代码包和组件代码包放在packages文件夹下,目录结构:(项目a和common组件的package.json中name名称不能重复)common组件也可以放在项目a中引用,同时顶部包package.json workspaces属性路径也要功更改
.
+-- package.json
`-- packages
+-- a
| `-- package.json
+-- common
| `-- package.json
3.在根目录中执行npm install 安装依赖,安装的依赖是a的依赖加上common的依赖,a和common都可以使用根目录下的node_modules