项目中调试本地组件库的实践方案

一、简述

每个公司都有可能有自己的组件库,我们在开发组件库时,一般都要将组件库里的组件应用在自己的项目上,项目与组件库在本地进行调试就需要一套很好的解决方案。下面我们就对比几个常见的方案,以及它们存在的问题。

二、npm link

项目中进行组件库调试,首先想到的就是使用npm link方案。
在组件库的根目录执行
npm link

在开发项目的根目录执行
npm link 组件库名

它会在开发项目的node_modules文件夹中创建一个指向组件库的软链接。

  • 存在的问题:
  1. 每次修改并保存代码后要都要手动执行一遍npm run build和npm link。
  2. 大多数情况下会出现下面的报错



    原因 1: React 和 React DOM 的版本不一样的问题
    原因 2: 可能打破了 Hooks 的规则
    原因 3: 在同一个项目中使用了多个版本的 React

三、使用yalc库

yalc是一个非常棒的工具,可以在本地开发和测试包/库,而不用发布到npm。
全局安装
npm install yalc –g

在组件库根目录下执行publish,发布组件库到本地仓库
yalc publish

在开发项目的根目录下执行add,安装该组件库
yalc add 组件库名

修改组件库代码后,推送更新
yalc push

本地调试完成后,在开发项目的根目录下执行remove
yalc remove –all

  • 存在的问题:
  1. 修改组件库代码后,需要手动执行yalc push去更新开发项目的node_modules中组件库的代码,页面才会更新。
  2. 我们在开发组件库时一般都需要编译打包才能使用,所以在执行yalc push之前还要先执行npm run build进行打包,对于这一套操作yalc没有提供对应的自动化方案。

四、yalc与yalc-watch配合

yalc-watch是一个专门为实现监听组件库代码修改然后自动执行yalc push的库,它是一个很小的命令行工具。
安装
npm i yalc-watch -D

在package.json文件中添加配置

{
    "scripts": {
        " yalc-watch": "yalc-watch"
    },
    . . .
    "yalcWatch": {
        "watchFolder": "build",
        "buildWatchCommand": "tsc --watch",
        "extensions": "js, png,svg,gif,jpeg,css",
    }
}

启动监听
npm run yalc-watch

  • 存在的问题:
    修改并保存组件库代码后它会立即执行yalc push,而我们的需求是在这之前要先执行npm run build,将组件库编译打包,而这个库满足不了我们的需求,该库也很长时间没人维护了。

五、yalc与yalc-watch2配合

没有库能解决我们的需求,那我就自己写了个库,yalc-watch2,在原先的基础加上了我们需要的功能即可。
安装
npm i yalc-watch2 -D

在package.json文件中添加配置

{
    "scripts": {
        " yalc-watch2": "yalc-watch2"
    },
    . . .
    "yalcWatch2": {
        "watchFolder": "src",
        "buildWatchCommand": "tsc --watch",
        "extensions": "js,jsx,ts,tsx,png,svg,gif,jpeg,css,less",
        "prePushCommand": "npm run build"
    }
}

启动监听
npm run yalc-watch2

最终实现的效果就是,当我们修改并保存了组件库代码后,会执行npm run build进行组件库的编译打包,然后执行yalc push –changed,开发项目中依赖的组件库代码就会被更新,热更新检测到文件的修改后就会重新编译,然后更新页面,整个过程全部自动化完成,不需要人为操作。

如果我们修改了组件库代码,页面却一直不更新,可能是因为我们使用了webpack的缓存功能,在进行调试时可以先将webpack的缓存功能禁用掉,修改webpack.config.js配置:{ cache: false }。

更多个人文章

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

推荐阅读更多精彩内容