如何使用lerna進行多包(package)管理

貴貴子發表於2022-06-20
Package

為什麼要用lerna

將大型程式碼倉庫分割成多個獨立版本化的 軟體包（package）對於程式碼共享來說非常有用。但是，如果某些更改 跨越了多個程式碼倉庫的話將變得很 麻煩 並且難以跟蹤，並且， 跨越多個程式碼倉庫的測試將迅速變得非常複雜。

為了解決這些（以及許多其它）問題，某些專案會將 程式碼倉庫分割成多個軟體包（package），並將每個軟體包存放到獨立的程式碼倉庫中。但是，例如 Babel、 React、Angular、Ember、Meteor、Jest 等專案以及許多其他專案則是在 一個程式碼倉庫中包含了多個軟體包（package）並進行開發。

Lerna 是一種工具，針對 使用 git 和 npm 管理多軟體包程式碼倉庫的工作流程進行優化

npm初始化

新建資料夾spring-breeze,在整合終端輸入
npm init -y
根目錄會生成package.json:

{
  "name": "spring-breeze",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

安裝lerna

全域性安裝lerna
執行:npm i lerna -g
安裝完成後執行:lerna init
執行完成後後出現這樣的目錄結構

- packages(目錄)
- lerna.json(配置檔案)
- package.json(工程描述檔案)

初始化兩個package

預設情況下，package是放在packages目錄下的.建立包可以使用命令lerna create [loc]
lerna create core packages/core
lerna create core packages/tools

將packages/core/lib/core.js改為:

'use strict';
console.log("我是core包~~")

將packages/tools/lib/tools.js改為:

'use strict';
console.log("我是tools包~~")

此時目錄結構為

-- packages(目錄)
  -- core
    ...
    -- lib
      -- core.js
    -- package.json 
    -- README.md
  - tools
    ...
    -- lib
      -- tools.js 
    -- package.json 
    -- README.md
- lerna.json(配置檔案)
- package.json(工程描述檔案)
...

修改包名

為了防止重名，包名一般改為@組織/包，如現在這個專案core應該改為:@spring-breeze/core；tools改為:@spring-breeze/tools

例如core模組：

  • packages/core/package.json:
{
  "name": "@spring-breeze/core",
  "version": "0.0.1",
  "description": "> TODO: description",
  "author": "******",
  "homepage": "",
  "license": "ISC",
  "main": "lib/core.js",
  "directories": {
    "lib": "lib",
    "test": "__tests__"
  },
  "files": [
    "lib"
  ],
  "repository": {
    "type": "git",
    "url": "******"
  },
  "scripts": {
    "test": "echo \"Error: run tests from root\" && exit 1"
  }
}

安裝第三方包lerna add

  • 新增公共依賴

    在根目錄下執行(在哪個目錄執行都一樣):lerna add lodash
    此時會發現core和tools都被安裝了lodash

  • 新增單獨依賴

    lerna add jquery --scope=core
    core就會被安裝了jquery

刪除依賴lerna clean

執行lerna clean會刪除所有包中的node_modules

安裝所有依賴lerna bootstrap

執行lerna bootstrap會重新安裝所有依賴

測試本地包

如果本地開發的兩個包有所關聯，用lerna進行除錯非常的簡單，只需要將需要用的本地包版本號寫入依賴執行：lerna link就可以了；例如在core模組使用tools模組

  • package新增依賴："@spring-breeze/tools": "^0.0.1"
{
  "name": "@spring-breeze/core",
  "version": "0.0.1",
  "description": "> TODO: description",
  "author": "******",
  "homepage": "",
  "license": "ISC",
  "main": "lib/core.js",
  "directories": {
    "lib": "lib",
    "test": "__tests__"
  },
  "files": [
    "lib"
  ],
  "repository": {
    "type": "git",
    "url": "******"
  },
  "dependencies": {
    "@spring-breeze/tools": "^0.0.1"
  },
  "scripts": {
    "test": "echo \"Error: run tests from root\" && exit 1"
  }
}

新增完成之後執行lerna link

  • core中使用：packages/core/lib/core.js
'use strict';
require("@spring-breeze/tools")

node執行core.js就會發現控制檯列印：我是tools包~~。這樣就可以進行本地的除錯了

釋出前準備

除錯完成就可以釋出了，釋出流程如下：

  • 註冊npm賬戶
  • 新建組織spring-breeze(根據自己專案而定)
  • 執行npm login
  • 分別在core和utils下的package.json中配置
 "publishConfig": {
    "access": "public"
  }
  • 新建gitignore
*node_modules
  • 新建git倉庫,將專案git remote add "你的git倉庫",並且提交專案至git倉庫
git remote add https://gitee.com/geeksdidi/spring-breeze.git  
git add .   
git commit -m "初始化"
git push -u origin master
  • 新建LICENSE.md(可以是空檔案)
  • 修改一個檔案執行 lerna publish

注意：每次釋出新版本之前都有將程式碼提交到git上

檢視已釋出的package

登陸npm官網 即可看到自己釋出的package

相關文章