lerna简易入门

你是否在开发项目的时候遇到了以下的一些问题

  1. 多个项目开发的过程中使用到了很多的工具类的函数、因此一遍遍的复制粘贴
  2. 多个项目中同时使用了某个npm库,但是各个项目中的依赖库的版本都不一致
  3. 自己拥有多个npm包,各个npm包直接存在依赖,每次发布都需要手动修改版本号依赖版本等
  4. 每个npm包都有自己的git地址,issue维护起来很麻烦

如果你遇到了以上的一些问题,或许可以看一下lerna,通过lerna来解决一些问题。接下来我们会通过实战,分别解决以上的问题,来帮助你实现lerna的入门

什么是lerna

lerna是一个多包管理工具,通过lerna我们可以很方便管理多个JavaScript包,只需要使用一个git地址。

基本使用

首先我们在git上创建一个项目并且克隆到本地来,我的命名是 l-lerna-learn,进入该目录
执行

yarn init -y
没有yarn也可以使用npm代替
随后我们安装lerna
yarn add lerna -D

随后我们使用npx 初始化一个lerna项目

npx lerna init

随后我们的目录结构会多出
packages目录
lerna.json
两个内容
packages里面用来放我们的项目
而lerna.json里面就是一些相关的配置

接下来我们就可以来创建项目了
执行

lerna create base
lerna create package-1

这样我们就在packages下面创建了两个项目,注意默认的package.json里面的入门文件设置的是lib/index.js
这里我们可以在创建的时候修改一下为index.js
并且在项目下创建好。

修改base/index.js的内容

module.exports = {
  test () {
    console.log('base-test');
  }
}

最终目录结构如下


image

虽然我们需要在package-1的index.js中使用这个base这个包,怎么办呢?
假如你现在直接在它的index.js中引入包的话是找不到的,因为并没有在package-1的package.json里面注册。所以我们需要进行引如。执行

lerna add base --scope=package-1

再进行引入允许就发现可以使用base了,假如我们add的包不是我们的本地包,那么就会从npm仓库上进行下载,并且只给package-1安装


image

这样我们就解决了第一个问题,怎么处理多个项目依赖一个包的问题。

处理多个项目依赖npm包版本不同的问题

我们在仓库根目录下执行

yarn add lodash

虽然我们修改base/index.js以及package-1/index.js的内容为
base/index.js

const _ = require('lodash')
console.log(_.VERSION);
module.exports = {
  test () {
    console.log('base-test');
  }
}

package-1/index.js

const base = require('base')
const _ = require('lodash')
base.test()
console.log(_.VERSION);

分别运行可以发现打印出来的版本是一致的
或者我们也可以使用lerna add进行添加,这样我们的对应的package的package.json文件下也会进行更新了

lerna add vue

就可以统一给所有的package.json添加一个依赖

这样我们就解决了依赖版本不一致的问题

解决发布版本问题

首先我们需要搜索一下npm,看看自己打算发布的包的名称是否被占用了,而我们前面用到的两个包都被占用了,所以我们需要新创建一个包,确保没有被用过。
并且修改前面两个包的package.json

"private":true,

确保他们是私有的不会被发布上去
我自己创建了两个包

  1. l-lerna-test-base
  2. l-lerna-test

注意我们设置成了private的包就不会被发布到npm上去了,如果我们里面引用这些包以后clone下来进行安装的时候就会有问题,因为他可能找错包了。

然后我们修改index.js的代码为

const base = require('l-lerna-test-base')
module.exports = {
  test () {
    console.log('lerna-test');
    base.test()
  }
}

提交代码,然后进行

lerna publish

当然首先你要登陆自己的npm账号

然后就会提醒我们进行当前的版本选择,是升级一个小版本还是一个大版本
虽然就会进行统一的处理,发布到npm上去,并且统一所有包的版本,并且会将代码进行提交

最后我们就可以在npm上搜索到我们的包了
也可以进行下载了

当然lerna还有很多其他的功能,但是我觉得这几个功能在我自己的理解上是属于比较核心的内容了,更多的高级功能就等待大家去挖掘了

你可能感兴趣的:(lerna简易入门)