一篇文章解决npm私有包频繁开发调试

最近把业务整理了一下,弄个组件库给合作方使用,瞬间惬意了许多,但是随之而来是npm包管理的诸多问题,主要是业务初期版本号快速增长导致的:版本号过多,版本号传递过程中的繁琐以及组件库反复安装的痛苦,本文将着重解决这三个问题。

1. 面临的问题

npm包版本号的快速增长带来了以下几个问题:

  • 调试变得不方便

之前真机测试只要发布测试环境即可,但是现在要先发布npm包,安装npm包,然后再发布测试环境,从一个步骤变成了三个步骤。

  • 联调困难

版本号的快速更新导致每次都要通知相关同学新的版本号,这中间还容易产生错误,导致安装了错误的版本或者没有及时更新。给测试同学增加了负担。

  • 丑陋的包版本号

一个小小的功能上线了几十个版本,从1.0.0增长到了1.0.3X,既挑战了自己的容忍度,也挑战了合作方的安全感。

2. 处理方案

1.1 调试时使用npm link

npm link可以让项目和要使用的npm包之间建立符号连接。

换句话说,如果在项目A中使用组件包B,之前要把B打包并发布,然后项目A安装B,打包并发布测试环境才能验证,现在只需要B打包一下,A直接打包并发布测试环境即可(A打包时获取的是B在本地的打包文件, 即写在B package.json中的main文件

PS: 如果你是使用yarn的话,也有yarn link,而且yarn link还不会污染全局环境。

clipboard.png

而要使用npm link, 要做到如下几步:

在B包里:
npm link // 相当于npm install B -g
在A包里:
npm link B // 代码无需修改,package.json中引用B的包会自动指向本地B的打包文件
A包发布测试环境测试
使用npm link的方式,所有的小调整都不需要发包就可以验证正确性,尤其是对于不能确定正确的测试性改动,更加具有优越性。需要注意的是,去掉了npm包的版本控制之后,一定要在git上做好代码版本控制,否则有可能会出现丢失代码的情况。

1.2 发布时使用tag

tag可以用来指带版本号,用户可以使用npm install <name>@<tag>安装

对于绝大部分用户,都是用npm install来安装所有依赖的,这种情况下,系统会自动安装最新的版本号,需要注意的是,我们会经常发出测试版本,这时候用户如果安装,那么就会拉取到一个有问题的测试版本,所以我们需要使用tag来区分版本。

另外,在联调阶段,反复告知对方,我们的版本号从1.3.1改成1.3.x了是很蠢的,所以可以指定一个tag维持版本的传递。同时,在B包里使用npm info来观察各个tag的版本号。

clipboard.png

npm publish --tag <tag>

使用latest来设置用户npm install默认安装的版本,使用alpha来设置测试版本,当测试版本测试完毕之后,使用

npm dist-tag add <pkg>@<version> [<tag>]

来切换不同tag的版本号,例如,1.3.1已经测试完成,我们可以使用
npm dist-tag add B@1.3.1 latest来把原本属于alpha的分支切到latest。tag不加的话默认是latest。

当然,还可以通过mpm dist-tag add来添加你自己的tag。

2. 相关知识

2.1 package.json与package-lock.json

package.json:用于标注项目中对各个npm包的依赖。
package-lock.json:用于记录当前状态下实际安装的各个npm package的具体来源和版本号。

由于package.json中默认是@tencent/newsH5Ad: '^1.3.1',^指的是向后兼容,这就导致npm i的时候,装得库的版本和之前装得并不一样(有可能版本号会更新一些),而这个时候若是npm包开发者没有遵守——”相同的大版本号的包,接口保持兼容“——没错了,说的就是我——就会出现兼容性问题。为了解决这个问题,所以才有了package-lock.json。

在npm的不同版本下,package-lock.json有不同的表现。最新的在npm 5.4.2版本之后:

如果改了package.json,且package.json和lock文件不同,那么执行npm i时npm会根据package中的版本号以及语义含义去下载最新的包,并更新至lock。如果两者是同一状态,那么执行npm i都会根据lock下载,不会理会package实际包的版本是否有新。[1]

说到这里,package-lock.json就是yarn.lock的某种实现,其实就应该使用yarn, 使用npm i真是自讨苦吃……

2.2 版本号前的字符含义

说几个不太容易记得
~version:大概某个版本 ~1.2.1就是>=1.2.1 && <1.3.0
^version:向后兼容 ^1.2.1就是>=1.2.1 && <2.0.0

版本号格式:主版本号.次版本号.修补版本号

主版本号:新增功能,兼容老版本
次版本号:修复bug,兼容老版本
修补版本号:新的架构调整,不兼容老版本

具体可以看《package.json中 npm依赖包版本前的符号的意义

3. 总结

凭借npm link和tag,我们可以尽可能的减少调试步骤和库包的发布,从而形成良好的库包管理。


汤姆C
tomczhang的专栏,我会在这个专栏中撰写我的思考,工作中遇到的问题和苦恼,每周一篇

职业提升三部曲:

4.5k 声望
792 粉丝
0 条评论
推荐阅读
项目经历准备篇——如何准备阿里巴巴P6/P7前端面试
在上次的校招文章之后,有很多同学问有没有社招相关的东西可以写一篇,现在它来了。比起校招,社招更加看重项目经历+项目经历反应的思考。本文针对的是想进入阿里的P6/P7同学,着重讲解了很多同学容易忽视的项目...

这是你的玩具车吗30阅读 3.4k评论 5

从零搭建 Node.js 企业级 Web 服务器(零):静态服务
过去 5 年,我前后在菜鸟网络和蚂蚁金服做开发工作,一方面支撑业务团队开发各类业务系统,另一方面在自己的技术团队做基础技术建设。期间借着 Node.js 的锋芒做了不少 Web 系统,有的至今生气蓬勃、有的早已夭折...

乌柏木148阅读 12.2k评论 10

JavaScript有用的代码片段和trick
平时工作过程中可以用到的实用代码集棉。判断对象否为空 {代码...} 浮点数取整 {代码...} 注意:前三种方法只适用于32个位整数,对于负数的处理上和Math.floor是不同的。 {代码...} 生成6位数字验证码 {代码...} ...

jenemy46阅读 5.9k评论 12

从零搭建 Node.js 企业级 Web 服务器(十五):总结与展望
总结截止到本章 “从零搭建 Node.js 企业级 Web 服务器” 主题共计 16 章内容就更新完毕了,回顾第零章曾写道:搭建一个 Node.js 企业级 Web 服务器并非难事,只是必须做好几个关键事项这几件必须做好的关键事项就...

乌柏木66阅读 6.1k评论 16

再也不学AJAX了!(二)使用AJAX ① XMLHttpRequest
「再也不学 AJAX 了」是一个以 AJAX 为主题的系列文章,希望读者通过阅读本系列文章,能够对 AJAX 技术有更加深入的认识和理解,从此能够再也不用专门学习 AJAX。本篇文章为该系列的第二篇,最近更新于 2023 年 1...

libinfs39阅读 6.3k评论 12

封面图
从零搭建 Node.js 企业级 Web 服务器(一):接口与分层
分层规范从本章起,正式进入企业级 Web 服务器核心内容。通常,一块完整的业务逻辑是由视图层、控制层、服务层、模型层共同定义与实现的,如下图:从上至下,抽象层次逐渐加深。从下至上,业务细节逐渐清晰。视图...

乌柏木43阅读 7.3k评论 6

从零搭建 Node.js 企业级 Web 服务器(二):校验
校验就是对输入条件的约束,避免无效的输入引起异常。Web 系统的用户输入主要为编辑与提交各类表单,一方面校验要做在编辑表单字段与提交的时候,另一方面接收表单的接口也要做足校验行为,通过前后端共同控制输...

乌柏木33阅读 6.2k评论 9

职业提升三部曲:

4.5k 声望
792 粉丝
宣传栏