NPM创建自己的包及注意事项

当自己造了个小轮子希望在npm包里跑起来,怎么操作呢?总结了一下流程,和遇到的问题及解决方法,以下操作基于Mac环境。

一、准备事项

1、保证本地全局安装了nodejs环境
$ node --version
v11.0.0

如上示例,能返回node版本就表示已经安装了,如果没有,请移步Nodejs官网安装。

2、在npm上发布包,必须得有账号

前往npm注册一个账号。

二、开始

1、登录
$ npm login
Username: xiaohua
Password:
Email: (this IS public) [email protected]

如上,在iTerm2中输入命令npm login,然后就会让你输入用户名密码和一个公开的邮箱,按照之前在npm中注册的信息填写就行。

2、创建demo

$ mkdir xiaohua && cd xiaohua
$ npm init

这里注意,虽然是demo,但也要用npm init,不要用快速默认的命令npm init -y,会漏掉keywords,github等信息,如果用了npm init -y,也要记得在项目的package.json中把相关信息补全。

$ touch index.js

创建一个index.js文件,然后写上简单的一些内容就行。

// index.js
const myname = "xiaohua";
module.exports = myname;
3、发布

准备就绪后,就可以执行npm publish + 包名称进行发布了,是不是很简单,对!就是这么简单。

$ npm publish xiaohua
NPM创建自己的包及注意事项_第1张图片
success.png

如上,没有任何ERROR就发布成功了,然后去npm上搜索xiaohua,如下,可以看到已经有了:

NPM创建自己的包及注意事项_第2张图片
npm.png

三、注意事项

总结了下面几种发布失败的情况和注意事项,供大家参考

1、包名重复错误
npm ERR! code E403
npm ERR! 403 Forbidden - PUT http://registry.npmjs.org/koa - You do not have permission to publish "koa". Are you logged in as the correct user?

如上,我发布一个名为koa的包,报错,很显然koa包已存在。

切记发布前先去npm上搜一下自己的包名,看是否有重复,如果遇到上面提示,修改下包名,再去npm搜一下,确保没有这个包之后,再发布。

2、npm仓库镜像错误
npm ERR! code E403
npm ERR! 403 Forbidden - PUT https://registry.npm.taobao.org/pengxiaohua - [no_perms] Private mode enable, only admin can publish this module

可以看到错误提示中https://registry.npm.taobao.org这个是淘宝的仓库镜像,而不是npm的仓库镜像,需要更换成npm仓库镜像。发布前可以先查看本地默认仓库镜像,如下:

$ npm config get registry
> http://registry.npmjs.org/

如果npm config get registry后,返回的http://registry.npmjs.org/, 则说明的对的,如果返回如下:

$ npm config get registry
> https://registry.npm.taobao.org/

这是淘宝镜像,说明之前可能是安装过cnpm,设置了本地的默认仓库镜像是淘宝的。需要修改本地仓库镜像,如下操作:

$ npm config set registry=http://registry.npmjs.org

再次执行npm login,然后执行npm publish XXX发布包。

如果发布成功后,则再次将仓库地址设为淘宝镜像地址,方便本地cnpm的使用。

$ npm config set registry=https://registry.npm.taobao.org/
3、包版本号version错误
npm ERR! code E400
npm ERR! 400 Bad Request - PUT http://registry.npmjs.org/xiaohua - Cannot publish over previously published version "1.0.0".

遇到这个问题,修改package.json中version版本号,避免和上一次发布重复,再次发布就可以了。

4、撤回发布的包

npm包24小时内可以强制撤回,超过24小时的就不行了。

$ npm --force unpublish xiaohua

如果发布同一个包1次以上(即多个版本)了,那么就只能通过npm deprecate去废弃包,如下操作:

$ npm deprecate [email protected] "sorry, it's a my test npm package, I love Xiaxia && Ruoyu"

使用npm deprecate时,最后的message一定要带上,否则执行失败。

5、更新发布包

如果对已创建的包要更新,更新后上传要修改项目的版本号,即package.jsonversion,也可以在项目目录下执行npm version patch

这是我发布的npm包get-image-size,根据图片的链接获取图片的文件大小,欢迎大家在github上star和提issue。

你可能感兴趣的:(NPM创建自己的包及注意事项)