多包管理 lerna 学习

lerna

关于 lerna

将大型代码库拆分为独立版本的包对于代码共享来说十分有用。然而,跨许多存储库(across many repositories)进行更改是混乱的,并且很难跟踪,而且跨存储库进行测试会变得非常复杂。

为了解决这些(以及许多其他)问题,一些项目将把它们的代码库组织到多包存储库中(有时称为monorepos)。像Babel、React、Angular、Ember、Meteor、Jest等项目都在一个存储库中开发它们的所有包。

Lerna 是一个工具,它优化了使用 git 和 npm 管理多包存储库的工作流

个人理解:一个项目就是一个存储库,存储库(也叫仓库)是 git 里面的概念。所以我们就是为了实现的就是在一个存储库里面管理多个包,每个包都有自己的版本和域(scope),方便 版本控制 与 发布。lerna 这个工具帮我们优化了这些工作流方便我们使用。

Lerna 的 repo 看起来应该是什么样子的?

实际上这没什么。你有一个像这样的文件结构:

my-lerna-repo/
  package.json
  packages/
    package-1/
      package.json
    package-2/
      package.json
Lerna 可以做什么?

Lerna 有两个主要的命令是 lerna bootstraplerna publish
bootstrap 将链接 repo 的依赖到一起,publish 将帮助发布任何更新的包。

Lerna 不能做什么?

Lerna不是针对无服务器 monorepos 的部署工具。提升可能与传统的无服务器 monorepo 部署技术不兼容。


开始

下面的指令是适用于 Lerna 3.x 的。我们建议在新项目中使用它代替 2.x。

让我们使用 npm 安装 Lerna 并将其作为开发依赖在你的项目里。

$ npm install lerna -g  // npm 方式安装 lerna
$ yarn global add lerna  // yarn 方式安装 lerna
$ mkdir lerna-repo && cd $_  // 创建目录并切换到该目录
$ npx lerna init  // 使用 lerna 初始化该目录

这个将创建一个 lerna.json 配置文件和一个 packages目录,所以你的目录看起来应该是这样子的:

lerna-repo/
  packages/
  package.json
  lerna.json
// lerna.json
{
  "packages": [
    "packages/*"
  ],
  "version": "0.0.0"
}
// package.json
{
  "name": "root",
  "private": true,
  "devDependencies": {
    "lerna": "^3.6.0"
  }
}

lerna 是如何工作的

lerna 有两种模式让你去管理你的项目:固定(Fixed)或独立(Independent)。

Fixed/Locked 模式(默认)

固定模式。该模式为单版本号,在根目录中的lerna.json中设置。当使用lerna publish时,如果自从上次发布后有模块改动,那么将会更新到新发布的版本。

这也是目前Babel用的模式,当你想要自动整合不同包的版本时使用这个模式。它的特点是任何package的major change均会导致所有包都会进行major version的更新。

Independent 模式
lerna init --independent
// 独立模式的 lerna.json
{
  "packages": [
    "packages/*"
  ],
  "version": "independent"
}

独立模式。该模式中允许开发者独立管理多个包的版本更新。每次发布时,会得到针对每个包改动(patch, minor, major custom change)的提示。lerna会配合git,检查文件变动,只发布有改动的package。

独立模式允许你更具体地更新每个包的版本,并且对于一组组件是有意义的。将这种模式和 semantic-release 结合起来就不会那么痛苦了。

独立模式允许开发者更新指定package的版本。将lerna.json中的version键设为independent来启用独立模式。

概念

Lerna 将日志记录到 lerna-debug.log 文件中(类似于 npm-debug.log) 当运行命令发生错误的时候。

Lerna 也支持 scoped packages

运行 lerna --help 查看更多可用的命令和选项。

lerna.json
{
  "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: 一个选项执行客户端使用哪种命令运行。npmyarn
  • packages: 要用作包位置的全局变量数组。

lerna.json 中的 packages 配置的数组值是用来匹配包含 package.json 文件的目录,这也是 lerna 被认为是 ‘叶子’ 包。

默认情况下,lerna 初始化 packages 值为 ["packages/"],但是你也可以使用另一个目录例如["modules/"], 或 ["package1", "package2"]。这个数组值定义的值都是相对于 lerna.json 文件所在的目录,一般是存储库的根( the repository root)。唯一的限制是不能直接嵌套包位置,但这也是“普通” npm 包共享的限制。

例如,["packages/", "src/*"] 匹配这样的树:

packages/
├── foo-pkg
│   └── package.json
├── bar-pkg
│   └── package.json
├── baz-pkg
│   └── package.json
└── qux-pkg
    └── package.json
src/
├── admin
│   ├── my-app
│   │   └── package.json
│   ├── stuff
│   │   └── package.json
│   └── things
│       └── package.json
├── profile
│   └── more-things
│       └── package.json
├── property
│   ├── more-stuff
│   │   └── package.json
│   └── other-things
│       └── package.json
└── upload
    └── other-stuff
        └── package.json

在packages/*下定位叶子包(每个包看起来像片叶子)被认为是一种“最佳实践”,但不是使用Lerna的必要条件。

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

推荐阅读更多精彩内容

  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey阅读 6,252评论 2 36
  • 概要 64学时 3.5学分 章节安排 电子商务网站概况 HTML5+CSS3 JavaScript Node 电子...
    阿啊阿吖丁阅读 9,221评论 0 3
  • 免责声明:此文章是转载文章,这里给出原链接,以示尊重。原作者名称:knqiufan原作者博客:https://bl...
    振礼硕晨阅读 22,570评论 0 20
  • NPM NPM 是随同 Node 一起安装的包管理工具,能解决 Node 代码部署上的很多问题,常见的使用场景有以...
    heyi_let阅读 2,587评论 0 2
  • #幸福是需要修出来的~每天进步1%~幸福实修08班~11贾春芬-杭州# 20170716(28/99) 【幸福三朵...
    chfenj阅读 124评论 0 2