npm工具包————发布
2024-12-09 11:13:16

本次开源的方法是cat-tools,目前该工具包已经在npm上可下载,公司多个项目使用,没出什么问题。

尽管市面上开源了loadshmoment.jsday.js这类的工具包,但是总有不能满足需求的时候。

所以,我觉得,还是得造一个趁手的工具包。

正文

一开始,是不同的项目中,有一些独立的工具类方法的整合。

后来,独立项目越来越多,不同项目之间,同步工具类方法是个大问题。

如果某项目加入了新的方法,我就要同步复制到很多项目!

折腾很多次之后,实在感觉耽误时间,且犯错太多,所有就有了本次流程记录。

打包

在项目开发完成之后,我们首先要打包项目,生成一个能够发布的dist包。

当然,ui包可能有自己的结构,这个只要开发那边确认之后就行。

注册

然后,我们需要到npm官网注册一个账号。

如果之前有npm账号的人,可以略过这步。

换源

在登录之前需要保证你现在使用的 npm源 是指向 npm 的。

先安装 nrm 工具查看和切换 npm

nrm 安装命令

1
npm install nrm -g

查看当前使用的 npm

1
2
nrm ls 	#查看包源列表
nrm use npm #切换包源列表

在执行nrm use npm之后,如果命令行中有如下提示,代表切换成功

1
Registry has been set to: https://registry.npmjs.org/

登录

在终端使用一下命令登录

1
npm login

然后根据提示输入账号、密码、邮箱,同时还有注册邮箱的一次验证码。

以我为例,我按照下边的完成填写之后,就算是登录了。

1
2
3
4
5
6
Username: *********
Password: ********
Email: (this IS public) *********@qq.com
npm notice Please check your email for a one-time password (OTP)
Enter one-time password from your authenticator app: 04471694
Logged in as crazystudent13 on https://registry.npmjs.org/.

发布

1
2
3
npm publish # 发布公有包

npm publish --access public # 发布带命名空间的包,npm publish默认私有需要付费

其他

迭代需要修改版本号

如果项目更新需要重新发布,必须修改 package.json 里的版本号。

版本号只能不断往上增加,哪怕你后边版本号拖的很长也可以。

1
"version": "0.0.2"

包权限管理

很多时候,一个项目包往往不只是你一个人在管理的,这时需要给其他一起维护的同学开通发布的权限,相关使用命令如下:

1
2
3
4
5
6
7
8
# 查看模块 owner, 其中 demo 为模块名称
$ npm owner ls demo

# 添加一个发布者, 其中 xxx 为要添加同学的 npm 账号
$ npm owner add xxx demo

# 删除一个发布者
$ npm owner rm xxx demo

结语

选择npm,也是因为用的人多,出了问题,论坛的解决方案应该多。

其实一开始想过其他的同步方案,比如用一个Git来做同步管理。

但是后来考虑到用的人少,隐患大,而且,这玩意也许不止我们一个人可以用,干脆开源吧。

开源的项目,如果别人用出了问题,他们也会提示,方便了别人,也促进了自己,挺好的。

参考

原生 node 搭建最基础的 npm 工具包

使用npm发布一个vue组件

一文搞定 npm 包发布与管理

规范化开发并发布npm包

Prev
2024-12-09 11:13:16
Next