Monorepo 項目管理方案--lerna学习笔记及采坑总结

什麽是 Monorepo?

monorepo 的全称是 Monolithic Repository,是一种管理项目代码的方式,顾名思义就是只有一个仓库。

以往项目实践中,对于不同模块通常就是建多个各自的仓库,然后各自做维护等等。但这样的坏处就在于,对于维护不是特别方便,如果想去查看别的模块的代码或是逻辑,或是一个需求涉及到多个模块的改动,那我们就必须去不同仓库查找,修改,并且可能又要各自部署,过程中会出现很多的差错,追根究底就是因为这种传统管理代码的方式过于分散,模块之间的联系不够集中。

于是就诞生了 monorepo 的代码管理模式,就是在一个项目仓库(repo)中管理多个模块/包(package),不同于传统的每个模块建立一个repo。

monorepo 最主要的好处是 统一的工作流 和Code Sharing。比如我想看一个 package 的代码、了解某段逻辑,不需要找它的repo,直接就在当repo;当某个需求要修改多个 pacakge 时,不需要分别到各自的 repo 进行修改、测试、发版,直接在当前repo修改,统一测试、统一发版。只要搭建一套脚手架,就能管理(构建、测试、发布)多个 package。

项目的第一级目录的内容以脚手架为主,主要内容都会在 packages 目录中,分多个 package 进行管理。大致结构会像这样:

image.png

此时会出现一个问题,虽然这样该分成多个子 npm 包进行管理,但是当仓库内容相关联或是要进行复用时,调适开发就变得困难,可能存在依赖问题等等,也可能存在重複依赖安装的问题,导致项目变得太大。所以,理想的开发环境应该只需要关心业务代码,可以直接跨业务而不关心复用方式。

总的来说,monorepo 最主要的好处是 统一的工作流 和Code Sharing。比如我想看一个 package 的代码、了解某段逻辑,不需要找它的 repo,直接就在当前 repo;当某个需求要修改多个 pacakge 时,不需要分别到各自的 repo 进行修改、测试、发版或者 npm link,直接在当前 repo 修改,统一测试、统一发版。只要搭建一套脚手架,就能管理(构建、测试、发布)多个 package。

image.png

Lerna

Lerna 是一个 npm 模块管理工具,用于管理具有多个包的JavaScript项目的工具。为项目提供了集中管理包的目录模式,如统一的仓库依赖安装,package scripts 和发布等特性。

  1. 安装 npm i -g lerna

  2. 初始化 lerna init

初始化完成之后项目的目录如下:

image.png
//Lerna.json
{
 "packages": [
 "packages/*"
 ],
 "version": "0.0.0"
}

// Package.json

{
 "name": "root",
 "private": true,
 "devDependencies": {
 "lerna": "^4.0.0"
 }
}
  1. 导入子模块lerna import 本地项目路径
image.png

每个被导入的项目都会被存放在根路径的packages目录下。


image.png
  1. 安装依赖

在 lerna 中我们使用 lerna add 指令为模块增加依赖。

为所有模块安装依赖

lerna add xxxx

为@lerna-test/lerna-module-2 增加依赖

lerna add xxx --scope@lerna-test/ lerna-module-2

image.png

增加模块内部间的依赖 @lerna-test/lerna-module-1添加 @lerna-test/lerna-module-2依赖

lerna add @lerna-test/lerna-module-2 --scope @lerna-test/lerna-module-1

  1. 发布

1). 先看一下package文件里每个包的package.json里有一个 repository 字段是否已经配置该包对应的远程仓库,要注意的是,我们必须为每一个 package 的 package.json 都要加上相应的配置,不需要都是同一个仓库,但是都需要配置。

image.png

配置好之后把代码push到远程仓库。

2). 发布命令lerna publish

发布过程可能出现的问题:

第一个问题是401 Unauthorized - GET https://registry.npmjs.org/-/npm/v1/user lerna ERR! EWHOAMI Authentication error. Usenpm whoamito troubleshoot.

这个原因是因为还没有登录npm账号, npm login登录就可以了(没有账号的先去npm注册一下)。

第二个问题,登录上之后再次执行lerna publish,出现以下报错:

image.png

从错误提示可以看出是缺少许可证书。因为 npm 有一百多万的包,所以我们使用的名称会和别的包重名而无法发布。而有些私有包,你在 npm 上无法找到,但也确确实实存在。因此需要在每个包的 package.json 增加 "license": "MIT",然后在根目录增加 LICENSE 的文件,内容如下:

The MIT License (MIT)

Copyright (c) 2013-present, yourAccountName(*********@qq.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

然后再次git push提交代码到远程仓库,然后再执行lerna publish命令,又又出现报错了

image.png

查了资料之后发现是在package.json中登记的name已近被采用了。重名了,所以你得换一个。我们在发布一个包之前,最好拿着这个登记的name去搜一下,如果已经有了,那就要换一个,。。。真是路途多艰,那就去换名字吧。经过一番折腾,再次执行lerna publish命令,哈哈,终于成功啦!!!!

image.png

去npm搜一下,就可以查到了,至此大功告成!!!

image.png

依赖提升

lerna bootstrap --hoist

lerna可以通过lerna bootstrap 命令安装所有子项目的依赖包,而且在安装依赖时还有依赖提升功能,所谓“依赖提升”,就是把所有项目npm依赖文件都提升到根目录下,这样能避免相同依赖包在不同项目安装多次。比如多个项目都用了axios,通过依赖提升,只需要下载一次放到根目录的node_modules目录下,就可供其他所有项目来使用。不过,需要额外的参数--hoist让依赖提升生效。

为了省去每次都输入 --hoist 参数的麻烦,可以在 lerna.json 配置:

{
 "packages": [
  "packages/*"
 ],
 "command": {
  "bootstrap": {
   "hoist": true
  }
 },
 "version": "0.0.0"
}

配置好后,对于之前依赖包已经被安装到各个 package 下的情况,我们只需要清理一下安装的依赖即可:lerna clean 就可以清除安装包。

然后再执行lerna bootstrap 即可看到依赖都被安装到根目录下的 node_modules 中了(但是模块间的依赖不会被提升)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,013评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,205评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,370评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,168评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,153评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,954评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,271评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,916评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,382评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,877评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,989评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,624评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,209评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,199评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,418评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,401评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,700评论 2 345