ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

lerna使用教程

2021-10-21 12:03:49  阅读:308  来源: 互联网

标签:教程 依赖 package -- json lerna 使用 moduleA


lerna官网

Lerna是一个工具,它优化了使用git和npm管理多包存储库的工作流。

将大型代码库拆分为单独的独立版本控制包对于代码共享非常有用。然而,跨多个存储库进行更改是混乱且难以跟踪的,并且跨存储库的测试变得非常复杂

vue,babel,react等都在用。我司也在用。文档是英文,我便简单总结一篇,希望对大家有帮助。

需求

  • 假设主项目是 Vue 技术栈的,依赖两个自研 npm 包,这两个包也依赖 Vue,现在主项目要升级 vue 版本,那么这两个 npm 包也得跟着升级,且需要升级两次(一个包一次),可否只升级一次?
  • 假设有两个 npm 包A和B,A依赖B,那么每当B有更新时,要想让A用上B的更新,需要B发版,然后A升级B的依赖,可否更简单些?

解法就是 lerna,一种多包依赖解决方案,简单来讲:
1、可以管理公共依赖和单独依赖;
2、多package相互依赖直接内部 link,不必发版;
3、可以单独发布和全体发布
4、多包放一个git仓库,也有利于代码管理,如配置统一的代码规范

最佳实践

  • 初始化项目时使用 Independent 模式
    Independent 模式可以单独发版,更灵活
npm i -g lerna
lerna init --independent

  

成功后,生成目录:

- packages(目录)
- lerna.json(配置文件)
- package.json(工程描述文件)

  

  • 添加子package
cd packages && mkdir moduleA && cd moduleA && touch index.js && npm init

  

以此方式创建两个模块 moduleA 和 moduleB

- packages
  - moduleA
    - package.json
    - index.js
  - moduleB
    - package.json
    - index.js
- lerna.json
- package.json

  

  • 添加公共依赖
    假设 moduleA 和 moduleB 都依赖 lodash
lerna add lodash

  

这会给moduleA 和 moduleB 同时安装 lodash,出现在各自 package.json 的 dependency 里

  • 添加单独依赖
    假设moduleA 自己依赖 jquery,moduleB 自己依赖 zepto
lerna add jquery --scope=@fengyinchao/modulea
lerna add zepto --scope=@fengyinchao/moduleb

  

注意 scope 的值对应的是 package.json 中的 name 字段

  • 添加packages里其它模块作为自己的依赖
    假设moduleA 依赖 moduleB
lerna add @fengyinchao/moduleb --scope=@fengyinchao/modulea

  

注意这种依赖不会添加到 moduleA 的 node_modules 里,但会添加到 moduleA 的 package.json 中,它会自动检测到 @fengyinchao/moduleb 隶属于当前项目,直接采用symlink的方式关联过去

  • 全 package 发布
lerna publish

  

注意使用 lerna publish命令之前需要将代码commit并推送到远端仓库(首次发布时),然后可以依次为每个 package 选择要发布的版本


   
  • 更新包
    给 moduleA 添加一个依赖 husky
lerna add husky --scope=@fengyinchao/modulea
git add .
git commit -m "test:"
// 查看更改
lerna updated
// 发布
lerna publish

  

注意 lerna updated 命令需要提交更改后才会生效,再次 lerna publish 时会直接跳过 moduleB,只发布 moduleA

  • 卸载包
    给 moduleA 移除一个依赖 husky
lerna exec --scope=@fengyinchao/modulea  npm uninstall husky

  

  • 批量运行 npm script 脚本
lerna run test # 运行所有包的 test 命令
lerna run --scope my-component test # 运行 my-component 模块下的 test
lerna run --parallel watch # 观看所有包并在更改时发报,流式处理前缀输出

  

  • 抽离公共模块
    上面 moduleA 和 moduleB 都依赖了 lodash,且在各自 package 下的node_modules 里都有副本,这其实很浪费空间,可以使用 --hoist
lerna bootstrap --hoist

  

这会将 packages 里重复的依赖提取到最外层的 node_modules 里,同时最外层的 package.json 也不会更新 dependency 信息,所以不建议将公用依赖写到最外层的package.json里,而是重复写到每个子package.json 里,然后用 --hoist 提取出来

  • 更新公共依赖
    假设要升级 moduleA 和 moduleB 都依赖的 lodash 版本,不必依次到各子package下升级,可以借助 lerna-update-wizard 这个包来做
// 根目录执行
npm install --save-dev lerna-update-wizard
./node_modules/.bin/lernaupdate

  

 

 

 

 
 

 

 

 

 

   
常见错误
  • Current HEAD is already released
    第一次发布失败后出现
lerna publish from-package

  

  • You must sign up for private packages
    包名有前缀时出现
// package.json 增加配置
  "publishConfig": {
    "access": "public"
  }

  

标签:教程,依赖,package,--,json,lerna,使用,moduleA
来源: https://www.cnblogs.com/ygunoil/p/15432714.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有