如何利用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选项来固定一个版本号。既能够避免不少重复的代码，也能够解决不一样版本号所带来的冲突问题。

#参考资料

github.com/lerna/lerna

——本文首发于我的公众号，转载请注明出处———

最后，欢迎你们关注个人公众号，一块儿学习交流。