使用 Lerna 管理你的项目

现如今,随着前端做的事情越来越多,越来越复杂,前端项目也随之复杂化。同时受“只做一件事,并且把他做好”思维的影响,我们期望一个项目能拆分成若干个包,每个包只做一块功能,这样一来,就导致前端包数量急剧膨胀。要开发一个工具或者平台,往往对应好几个包,那么如何优雅高效地管理这些多包项目的研发、构建、发布流程,成了需要解决的问题。

实际上,前端已经有人做出了相应的管理工具 Lerna

关于 Lerna 的具体使用和内部机制,通过查看官方文档或者搜索相关博客即可找到比较详细的介绍。本文不会重复叙述这些内容,而是从一个实际项目入手,如何利用 Lerna 打造一套适合我们自己脚本工具。

初始化

先全局安装 Lerna:npm i -g lerna

依次使用 npm initlerna init 初始化项目。

可以看到,在项目根目录下,为我们生成了 lerna.json 文件,其具备配置,可以看官方文档介绍。

很多时候,我们使用的 npm 客户端 并不是 npm,而可能是 cnpm 等,registry 很可能也是公司私有的,此时我们就需要在 lerna.json 中配置 npmClientregistry 了:

{
  "package": ["packages/!(demo-*)"],
  // independent 表示分开管理各个项目版本
  "version": "independent",
  "npmClient": "cnpm",
  "registry": "[some private registry]"
}

创建包

我们可以在 packages 目录下创建我们的包(lerna create),每个包中都应当有一个 package.json 文件。

在实际场景中,每个包当中都会有一系列自己的 scripts,包括:

  • lint:跑 lint 工具,检查代码是否符合规范;
  • build:编译打包;
  • test:跑测试代码;
  • dev:跑开发环境;
  • release:发布;
  • ……

每个包也有自己的版本,并且项目中的某一个包能用另外一个包作为依赖。

开发

现在,我们正式开始写代码做事情了。

Lerna 提供了很多命令帮助我们完成研发,具体可以参考官方文档。

实际上,Lerna 的命令还是未覆盖一些场景,比如我们这里的场景是:

  1. 公司项目,因此要发布到公司 registry,Lerna 目前只支持发布到 npm registry
  2. 在执行某些命令的时候,我们需要特殊的“包过滤规则”,比如 lerna run build,有的包里面可能没有 build 脚本,因此我们希望 lerna run build 能自动跳过这种包。

对于第一个问题,关键的点是,我们要能知道哪些包发生了变化,只发布变化了的包。

Lerna 为我们提供了 lerna changed 命令,可以找出自从上次打版本标签之后,哪些包发生了变化。

对于第二个问题,我们可以从包的 package.json 中查看是否存在相应脚本来决定是否执行。

由此,我们的发布脚本可以写成这样:

const cp = require('child_process');

function runCommand(cmd) {
  console.log(`=== start executing: ${cmd}`);
  cp.execSync(cmd, { stdio: 'inherit' });
  console.log(`=== finish executing: ${cmd}`);
}

function runScript(scriptName, pkgLocation) {
  const pkgJson = require(`${pkgLocation}/package.json`);
  // 检查是否存在对应脚本
  if (pkgJson.scripts && pkgJson.scripts[scriptName]) {
    runCommand(`cd ${pkgLocation} && cnpm run ${scriptName}`);
  }
}

const lerna = {
  changed() {
    return JSON.parse(cp.execSync('lerna changed --json'));
  },
  list() {
    return JSON.parse(cp.execSync('lerna list --json --toposort'));
  },
};

// 重新装一下依赖,干净一点
runCommand('lerna clean --yes');
runCommand('lerna bootstrap');

const changedPackages = lerna.changed();

changedPackages.forEach((pkg) => {
  // 不理会 private 项目
  if (pkg.private) {
    return;
  }
  
  runScript('lint', pkg.location);
  runScript('build', pkg.location);
  runScript('test', pkg.location);
});

runCommand('lerna version --allow-branch master');

changedPackages.forEach((pkg) => {
  if (pkg.private) {
    return;
  }
  
  runCommand(`cd ${pkg.location} && cnpm publish`);
});

总结

像这种项目管理工具,不可能做到支持每一个场景。对于我们自己遇到的情况,优先看用工具最简单的形式是否能满足需求;如果不能,再看复杂的命令形式;如果还是不行,就考虑能不能在工具的基础上,加点自己的代码来做做扩展。

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

推荐阅读更多精彩内容

  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey阅读 6,241评论 2 36
  • npm是什么 NPM的全称是Node Package Manager,是随同NodeJS一起安装的包管理和分发工具...
    build1024阅读 7,837评论 0 9
  • NPM NPM 是随同 Node 一起安装的包管理工具,能解决 Node 代码部署上的很多问题,常见的使用场景有以...
    heyi_let阅读 2,562评论 0 2
  • 文/巴布亚 三年生俩孩子,第五年回职场的妈妈,心中的五味杂陈,有几人能懂?没有经济压力,谁都不想太拼,但人到中年,...
    当妈不易阅读 252评论 0 0
  • 鸟鸣庭院静, 烟雨柳丝斜。 最是江南好, 湖山树树花。 时节天犹热, 观光伴友归。 湖亭催别宴, 花在满山飞。 山...
    郭大牛阅读 525评论 2 21