lerna

前言

npm仓库管理工具的意义

为了方便代码的共享，就需要将代码拆分成多个包，存放在各自的npm仓库中。由于，各仓库代码存在较大耦合性，容易出现各仓库之间修改混乱、难以跟踪的问题。因此，npm仓库管理工具出现了，使得代码耦合、仓库独立并存，实现优化、管理javascript多包项目的功能

---

概述

javascript npm仓库管理工具

特点

• 一个git仓库，对应多个npm仓库
• 便于调试
• 清晰的依赖关系
• 减少依赖冗余
• 自动管理版本

官网

https://lerna.js.org/

---

安装

yarn global add lerna

---

初次尝试

创建git仓库

git init lerna-repo && cd lerna-repo

升级为lerna仓库

lerna init

创建内部git仓库，并关联远程仓库

cd packages
mkdir pkg_1 && cd pkg_1 && yarn init -y && cd ..
mkdir pkg_2 && cd pkg_2 && yarn init -y && cd ..

package.json
lerna.json
packages/
├── pkg_1
│   └── package.json
└── pkg_2
    └── package.json

pkg_2 提供API

// packages/pkg_2/index.js
const fn_hello = () => {
    return 'hello lerna'
}

module.exports = fn_hello

pkg_1 调用API

// packages/pkg_1/index.js
const fn_hello = require('pkg_2')

const print_hello = () => {
    const res = fn_hello()
    console.log(res)
}

module.exports = print_hello

修改package.json

// packages/pkg_1/package.json
"dependencies": {
    "pkg_2": "^1.0.0"
}

// packages/pkg_1/package.json
{
  name: "pkg_1",
  version: "1.0.0",
  dependencies: {
    "pkg_2": "^1.0.0"
  }
}

// packages/pkg_2/package.json
{
  name: "pkg_2",
  version: "1.0.0"
}

链接模块，引用依赖

lerna bootstrap

修改lerna.json

{
  "version": "1.0.0",
  "npmClient": "yarn",
  "command": {
    "publish": {
      "registry": "npm仓库地址"
    }
  },
  "packages": ["packages/*"]
}

发布到npm仓库

// 登录到verdaccio提供的npm私有仓库
npm adduser --registry npm仓库地址
lerna publish

查看npm仓库

---

常用命令

// 升级为lerna仓库
lerna init
  // lerna默认使用的是集中版本，所有的package共用一个version
  // 如果希望不同的package拥有自己的版本，可以使用independent模式
  --independent

// 链接模块，引用依赖
lerna bootstrap

// 导入指定git仓库的包作为lerna管理的包
lerna import <pathToRepo>

// 发布
lerna publish
  // 指定版本号
  --npm-tag [tagname]
  // 发布尝鲜版
  --canary
  // 跳过git命令
  --skip-git
  // 强制发布，不进行修改检查
  --force-publish [packages / *]

// 列出所有分包
lerna ls

// 列出存在修改的分包
lerna changed

// 显示分包的修改内容
lerna diff [package]

// 运行脚本
lerna run [script]

---

lerna.json参考说明

{
  "version": "1.1.3",
  "npmClient": "npm",
  "command": {
    "publish": {
// lerna changed/publish期间，忽略的文件
      "ignoreChanges": ["ignored-file", "*.md"],
// 自定义 发布提示消息
      "message": "chore(release): publish",
// 仓库IP
      "registry": "https://npm.pkg.github.com"
    },
    "bootstrap": {
// lerna bootstrap期间，忽略的包
      "ignore": "component-*",
// lerna bootstrap期间，npm install 参数
      "npmClientArgs": ["--no-package-lock"]
    }
  },
// 每个包的路径
  "packages": ["packages/*"]
}

---

相关资源

npm scripts

https://docs.npmjs.com/misc/scripts

npm scope

https://docs.npmjs.com/misc/scope

常见问答

https://github.com/lerna/lerna/blob/master/FAQ.md
https://github.com/lerna/lerna/blob/master/doc/troubleshooting.md