Monorepo项目管理:lerna + workspaces

这里主要介绍lernayarn workspaces的使用方法与职能界限。

  • lerna:项目管理与发版
  • workspaces:依赖管理

以上能力结合交互式命令行,打造自动化项目开发流程。

出发点

  • 规范化项目管理
  • 自动提交 + 版本号
  • 交互式commit msg
  • 自动生成日志
  • 一目了然的项目依赖
  • 交互式的项目调试流程

准备工作

  • npm i -g lerna
  • lerna -v // 确认安装成功。
  • yarn -v // 确认安装yarn。应该随node默认安装的

创建Monorepo环境

定义工作区,可独立管理应用依赖

  1. vue create monorepo
  2. cd monorepo
  3. lerna init
  4. 修改package.json
    // 追加——定义工作区,可独立管理应用依赖
    workspaces: [
    "packages/*"
    ]
    
  5. yarn workspaces info

配置版本服务器

  • 配置commit msg校验
    • yarn add -W -D commitizen // root目录下安装依赖-W

    • npx commitizen init cz-lerna-changelog --yarn --dev --exact

      • // 以上两步创建Commitizen-friendly交互式commit msg —— 让您不必再深挖文档查找commit格式. Node10+支持

      • // commitizen init自动安装依赖cz-lerna-changelog

      • // commitizen init自动添加config.commitizenpackage.json

      • // 不同的适配器(E.g.cz-lerna-changelog)提供不同的交互界面

      • // 缺点:不符合常规命令习惯npm run cm

      • 手动添加scripts"cm": "cz" // 不使用commit做scripts的key是避免冲突

        if you are using precommit hooks thanks to something like husky, you will need to name your script some thing other than "commit" (e.g. "cm": "cz"). The reason is because npm-scripts has a "feature" where it automatically runs scripts with the name prexxx where xxx is the name of another script. In essence, npm and husky will run "precommit" scripts twice if you name the script "commit", and the work around is to prevent the npm-triggered precommit script.

    • 适配git commit命令

      • yarn add -W -D husky
      • 手动追加husky.hookspackage.json
          ...
            "husky": {
              "hooks": {
                "commit-msg": "exec < /dev/tty && git cz --hook || true",
                "commit": "echo '-----pre-commit====",
                "push": "echo '-----pre-push===="
              }
            },
          ...
          ```
          > Why exec < /dev/tty? By default, git hooks are not interactive. This command allows the user to use their terminal to interact with Commitizen during the hook.
      
  • 初始化Git服务器
    • git remote add origin ...
    • git add .
    • git commit -m "..." // 该命令后,进入commit msg交互:husky配置提供;
    • git push ... // 初始化远程库,使用git push进行第一次提交lerna.json的默认0.0.0版本,不使用lerna version做第一次提交
      commit-msg.png

自动生成变更日志

```
// 修改lerna.json
...
  "command": {
    "version": {
      "conventionalCommits": true
    }
  },
  "ignoreChanges": [
    ""
  ]
...
```

lerna version 会检测从上一个版本发布以来的变动,但有一些文件的提交,我们不希望触发版本的变动,譬如 .md 文件的修改,并没有实际引起 package 逻辑的变化,不应该触发版本的变更,可以通过 ignoreChanges 配置排除

changeLog.png

创建测试项目

  • 创建一个子项目packages/v1act/

    1. 创建目录packages/v1act/
    2. 创建文件packages/v1act/package.json
        {
          "name": "v1act",
          "version": "0.0.0", // 与lerna.json'version'保持一致
          "private": true  // 注意:追加该属性lerna ls -l会忽略该子项目, yarn workspaces info 可以查看该工作区
        }
      
    3. lerna ls -llerna ls --json // 查看仓库项目组织结构
  • 更新代码

    • git add
    • git commit -m ''
    • lerna version // 交互式版本更新 + 自动提交,没有packages/内容变更的话,不能通过lerna version提交,只能通过git push
      version.png
    publish.png

工具书

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,478评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,825评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,482评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,726评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,633评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,018评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,513评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,168评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,320评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,264评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,288评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,995评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,587评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,909评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,284评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,862评论 2 339

推荐阅读更多精彩内容