lerna -- 多包管理工具

刺骨的言语ヽ痛彻心扉 2022-05-31 07:42 268阅读 0赞

## 什么是 lerna ? ##

Lerna 它是基于 Monorepo 理念在工具端的实现。

## lerna 出现的历史背景 ##

Lerna 出现的历史背景，其实就是 Monorepos 和 Multirepos 在进行项目管理时优与劣。

说说我个人的感触：

Multirepos

**缺点：**

在 Multirepos 方案中我们通常一个项目会有一个 repo 或者说是一个 module 一个 repo，事实上因为项目或者 module 因为功能或者属性或者历史的原因我们不得不拆分到不同的 organisation 中，这导致了后期如果涉及人员交接，或者自己项目管理时就会陷入到不知道哪里去找 repo 的境地。（这个问题对于涉及历史包袱的开发会特别痛苦）

版本管理带来的日常开销，首先不得不说采用 semver 后确实给版本管理带来了很多便利之处，但是其偏向于于 patch 版本，当 core module 需要 发布 minor 或者 Major 版本时这就会变成一场灾难。举个例子，dora （插件化 server）的 core 需要变更时，我们得同步所有官方插件，这涉及到了 20 多个仓库，这完全是体力劳动。于此同时，在日常开发中，可能我们一次迭代会涉及多个 repo，一方面需要用 npm link 的方式 hack 到本地仓库，另外一方面，每次都需要手动切换到对应的各个仓库进行 lint test 等操作，要完成这些我们不得不在 terminal 中开启多个 tab，这绝对是个眼力和体力活

changelog 梳理又是一场灾难，在 Multirepos 管理项目的情况下，我们需要人工同步所有变动的仓库最终列出一个 changelog。如果全部是由一个人开发还能理得清楚，但实际上一般正常迭代都是多人开发协同开发的模式，这个情况下我们很难统计到仓库依赖的 module 是否有更新，做了什么样的工作。

等等。

使用 monorepo 以上问题都可以迎刃而解。

但使用 monorepo 方案也有相应的缺陷

单个 repo 体积较大？？

以上只是个人的一些项目中的感触，也来看看 babel 为什么选择 monorepo Why is Babel

## 如何用 lerna 进行项目管理 ##

**step 1:**

$ npm install --global lerna

**step 2:**

$ git init monorepo-example
    $ cd monorepo-example

**step 3:**

$ lerna init

运行完后在 terminal 中执行 tree 后我们可以看到此时的目录结构为

$ monorepo-example git:(master) ✗ tree
    .
    ├── lerna.json
    └── package.json

**step 4:**

$ monorepo-example git:(master) ✗ mkdir packages && cd packages

创建 packages 目录，该目录内将会存放之后所有的官方维护的 module

**step 5:**

$  packages git:(master) ✗ mkdir monorepo-example-module-a && cd monorepo-example-module-a && npm init
    
    $  packages git:(master) ✗ mkdir monorepo-example-module-core && cd monorepo-example-module-core && npm init

新建两个 package，并通过 npm init 来初始化 package.json

此时我们的 packages 目录结构为

➜  packages git:(master) ✗ tree
    .
    ├── monorepo-example-module-a
    │   └── package.json
    └── monorepo-example-module-core
        └── package.json

假设 `module-a` 依赖 `module-core` 详细参考 monorepo-example 案例

**step 6:**

$ monorepo-example git:(master) ✗ lerna bootstrap
    Lerna v2.0.0-beta.31
    Bootstrapping 2 packages
    Preinstalling packages
    Installing external dependencies
    Symlinking packages and binaries
    Postinstalling packages
    Prepublishing packages
    Successfully bootstrapped 2 packages.

执行 lerna bootstrap 该操作会自动为 module-a 进行 npm install 和 npm link 操作

是不是非常方便呢！

**step 7:**

$  monorepo-example git:(master) lerna publish
    Lerna v2.0.0-beta.31
    Current version: 0.0.0
    Checking for updated packages...
    ? Select a new version (currently 0.0.0) Patch (0.0.1)

Changes:

- monorepo-example-module-a: 0.0.1 => 0.0.1
    - monorepo-example-module-core: 1.0.0 => 0.0.1
    
    ? Are you sure you want to publish the above changes? Yes
    
    Publishing packages to npm...
    npm WARN dist-tag add latest is already set to version 0.0.1
    monorepo-example-module-a                          
    npm WARN dist-tag add latest is already set to version 0.0.1
    Pushing tags to git...
    
    To git@github.com:pigcan/monorepo-example.git
       0f8674c..2ecb064  master -> master
    To git@github.com:pigcan/monorepo-example.git
     * [new tag] v0.0.1 -> v0.0.1 Successfully published: - monorepo-example-module-a@0.0.1 - monorepo-example-module-core@0.0.1

执行 lerna publish 回答几个问题便可以把自己的包推送到 npm.

当然实际情况使用中，会更复杂一些，更多的内容就留给大家看官方使用说明了，基本都是简单明了的内容，如果有不清楚的地方 官方文档 commands

利用 `lerna-changelog` 来进行 changelog 的生成  
在现实开发中我们经常碰到一个老大难的问题就是 changelog 的梳理，在 lerna 中提供了一个非常有用的 lerna-changelog 的库，在一定的规范开发下会使得这个问题解决起来非常方便，在这边以这个仓库为例我给大家大概讲解下如何使用。

**step 1:**

$ monorepo-example git:(master) npm install lerna-changelog --save-dev

安装 lerna-changelog 依赖

**step 2:**

修改 lerna.josn 需要新增相关 lerna-changelog 所需要的配置

+"changelog": {
    +  "repo": "pigcan/monorepo-example",
    +  "labels": {
    +    "tag: bugfix": "Bug fix",
    +    "tag: enhancement": "Enhancement"
    +  },
    +  "cacheDir": ".changelog"
    +}

在这边需要特别注意的是 labels 内的内容，labels 的 key 必须在 github 的仓库内定义好

可以通过以下链接 [https://github.com/pigcan/monorepo-example/labels][https_github.com_pigcan_monorepo-example_labels] 来进行 labels 的创建，接下来我在 github 上分别新增 tag: bugfix 和 tag: enhancement

**step 3:**

$ export GITHUB\_AUTH=”…”  
GITHUB\_AUTH 的 token 字段可以在github 申请 token 获得。

步骤到此结束了，但是这边要想要达到理想的效果必须要遵循一定的开发规则，其实就是需要有好的开发习惯，在此推荐个人的习惯。

如案例所示 [https://github.com/pigcan/monorepo-example/issues][https_github.com_pigcan_monorepo-example_issues] 把项目碰到的 bug、需要增强的地方等等内容都记入到 issue中，并标记好相应的 label 标签。

创建对应的分支，来解决对应 issue 中记入的内容。

$  monorepo-example git:(bugfix-core) git branch
    * bugfix-core
      enhance-module-a
      master

例如我们在此修复 core 的问题，最终 commit 的日志推荐为

在 commit 的 message 中要把解决了什么问题和相应的 issue 进行关联，然后一目了然，如果后续需要对该部分代码进行回滚也会变得非常轻松。

一旦 bugfix-core 分支被提交后，我们可以在 github 上以该分支创建一个 pr ，

在创建 pr 时需要注意 *\* 一定要选择对应的 label \** 在这个案例中我需要选择，tag: bugfix

具体可以参考 pigcan/monorepo-example\#3

一旦分支的代码合并到主干后本地运行

$  monorepo-example git:(master) node_modules/.bin/lerna-changelog

看是不是已经生成了绝妙的 changelog 日志。

在需要 publish 之前我们运行一次 lerna-changelog 以便拿到日志（publish 后之前的 commit 信息将会被清空）

一旦 publish 后我们便可以创建 release note [https://github.com/pigcan/monorepo-example/releases][https_github.com_pigcan_monorepo-example_releases]

[https_github.com_pigcan_monorepo-example_labels]: https://github.com/pigcan/monorepo-example/labels
[https_github.com_pigcan_monorepo-example_issues]: https://github.com/pigcan/monorepo-example/issues
[https_github.com_pigcan_monorepo-example_releases]: https://github.com/pigcan/monorepo-example/releases