如何利用lerna来管理模块

当前端项目变得越来越大的时候,我们通常会将公共代码拆分出来,成为一个个独立的npm包进行维护。但是这样一来,各种包之间的依赖管理就十分让人头疼。为了解决这种问题,我们可以将不同的npm包项目都放在同一个项目来管理。这样的项目开发策略也称作monorepo。Lerna就是这样一个你更好地进行这项工作的工具。本文将详细介绍如何使用Lerna来辅助我们的包依赖管理。

什么是Lerna

根据官网上的定义,Lerna是一个使用git和npm来处理多包依赖管理的工具,利用它能够自动帮助我们管理各种模块包之间的版本依赖关系。目前,已经有很多公共库都使用Lerna作为它们的模块依赖管理工具了,如:babel, create-react-app, react-router, jest等。

常用命令

bootstrap

使用bootstrap命令,会下载所有定义在package.json中的依赖包。相当于执行npm install,并且链接所有依赖包。

publish

当你完成某个包的更新后,就可以使用lerna publish命令来发布新版本的包。执行这条命令的时候,你可以指定版本号,然后lerna就会自动给你加更新版本号,加tag并提交到git仓库上去。

add

假设你想往你的开发项目中特定包中加入依赖,你就可以使用add命令轻松实现:

# 给a, b 包中加入Lodash,会同时改变a,b模块中packages.json文件
lerna add lodash packages/a packages/b 
# 给a 包中加入jquery, 使用--dev参数是使依赖加入到devDependencies中
lerna add jquery packages/a --dev
# 你也可以使用通配符, 下面这命令,会往所有re开头的模块包中加入依赖
lerna add jquery packages/re-* 
# 指定特定的范围,要使用--scope参数,如下:给b包安装a模块
lerna add a --scope=b

clean

执行clean命令,用来删除所有模块下node_modules中的npm包。

import

你可以使用import命令导入已有的模块,并且会保留所有的git commit记录。

list

列出项目中所有的模块。

run

在每个包含该脚本的模块中运行npm脚本。

动手实战

说了那么多,我们写个例子实操一下。

初始化项目

首先,先建一个新项目,接着我们全局安装lerna,并执行初始化操作,再上传到git仓库上。:

npm intall lerna -g
mkdir lerna-demo && cd $_
lerna init
git init
git add .
git commit -m "Initial Commit"
git remote add origin http://github.com/scq000/lerna-demo.git
git push -u origin master
ls

执行完上述命令后,就会在当前目录下生成以下几个文件:

packages/
package.json
lerna.json

其中: packages目录用来存放我们需要拆分的各种公共代码库。lerna.json文件里面记录了lerna的相关配置信息:

{
  "version": "1.1.3",
  "npmClient": "npm",
  "command": {
    "publish": {
      "ignoreChanges": ["ignored-file", "*.md"],
      "message": "chore(release): publish"
    },
    "bootstrap": {
      "ignore": "component-*",
      "npmClientArgs": ["--no-package-lock"]
    }
  },
  "packages": ["packages/*"]
}

分别介绍每个配置项的功能:

  • version: 记录当前项目的版本号
  • npmClient: 你可以指定使用npm, cnpm或yarn来执行命令
  • command.publish.ignoreChanges: 忽略特定的项
  • command.publish.npmClientArgs: 当执行lerna bootstrap命令时,传给npm install的参数
  • command.publish.message: 发布模块的时候,填写的commit信息
  • packages: 模块包默认所在的地址

你可以根据需要自己更改相应的配置。

新建两个模块

为了演示方便,我们新建两个模块, moduleA和moduleB, 并让moduleA依赖moduleB:

lerna create module-a
lerna create module-b
# 将本地包链接起来,可以直接引用
lerna link

修改module-b 的入口文件:

export const sayHello() {
    return "hello world";
};

修改module-a 的入口文件:

const moduleB = require('module-b');

const moduleA = function() {
    console.log(moduleB.sayHello());
}

export default moduleA;

发布新模块

完成修改后,我们可以直接发布新的模块

lerna publish

然后,根据提示输入版本号等,lerna就会自动帮我们给包加上tag,并上传到对应的仓库中去。

希望这个简单的例子可以能让大家熟悉简单的操作流程。

两种模式

lerna允许我们使用两种模块来管理我们的模块:Fixed 模式和Independent模式。

Fixed/Locked mode

这个模式也是我们初始化项目的时候默认采用的模式。在这种模式下, 你可以理解为"全量发布"。也就是当我们一旦有某个模块的主版本更新了,那么所有包都会拥有一个新的版本号。而主版本号,是管理在项目根目录的lerna.json文件中。

Independent mode

如果你不喜欢上面这种模式,你也可以使用Independent模式来管理项目中的模块。你只需要在初始化项目的使用指定--independent参数就可以了:

lerna init --independent

在这种模式下,我们可以独立地更新某个包的版本号,你可以理解为"增量发布"。

可能遇到的问题及解决方案

打包太慢

在使用过程中,最经常遇到的问题是,执行lerna bootstrap的时候奇慢无比。这种情况通常是因为在每个独立包中都重复安装了公共依赖。在这时候,我们可以将所有公共使用的包,如react,lodash之类的移到根目录的package.json中去,并使用lerna bootstrap --hoist命令进行安装。使用hoist选项后,所有公共的依赖都只会安装在根目录的node_modules目录中去,而不会在每个包目录下的node_modules中都保留各自的依赖包。

这样一来,lerna bootstrap的执行效率就大大增加了。

多个包版本依赖不一致

另一个可能常遇到的问题就是多个安装包之间版本不一致,比如,A包需要依赖1.0的lodash, 而B包则需要依赖2.0的lodash。这样就会导致在打包过程中多了许多重复代码。而且在同一项目下保留不同版本的npm包也难以管理。对于这个问题,在大多数情况下,我们可以尝试使用npm包管理器提供的peerDependencies选项来固定一个版本号。既可以避免很多重复的代码,也可以解决不同版本号所带来的冲突问题。

参考资料

https://github.com/lerna/lerna

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

推荐阅读更多精彩内容

  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey阅读 6,247评论 2 36
  • 大家好,我是IT修真院深圳分院第3期的学员,一枚正直纯洁善良的前端程序员,今天给大家分享一下,修真院官网前端工程师...
    大大头大阅读 2,933评论 0 1
  • Node.js第一天 1. 初识Node.js 1.1 Node.js是什么 Node.js® is a Java...
    再见天才阅读 4,710评论 1 24
  • 我捋下一片叶子,交与同行的路人。告诉他们,这就是春的味道。 ——题记 从悉索人群...
    纳兰苏浅阅读 251评论 0 0
  • 亲爱的朋友们,老师们,大家好,我是Jin 王锦。 易效能PPT营销力课程第15期悉尼班学员。 很高兴在这里与你分享...
    JinWang阅读 196评论 0 1