准备工作: 在npm上注册账号
第一步:在本地磁盘上创建一个空项目,文件夹取名根据自己的实际情况去名字,但是要注意先去npm网官去确定一下,这个项目名是否已经被占用了,如果这个名字已经被占用了,则你是无法向npm上上传的
我们也可以在命令窗检查包名是否被占用,通过以下命令进行检查:
npm view 包名
# 这个命令用来查看 某个包的信息
# 如果返回404,说明这个项目名在npm官网上找不到,此时你就可以使用。
# 否则,说明不可用。
然后需要通过npm init --yes命令来创建一个package.json文件,对你的项目文件进行设置
第二步:创建一个index.js的文件,正常开发,完成你的代码,在默认情况下,index.js是这个项目的入口文件。
第三步:切换当前npm源到官网
由于我们需要把包上传到npm上,所以要先确保当前的npm源是npmjs.org。与之相关的命令有如下:
查看当前的npm的registry配置.
npm config get registry
查看当前的npm的registry配置,确保是https://registry.npmjs.org
如果不是,可以通过如下命令来设置
手动设置registry
npm config set registry https://registry.npmjs.org
第四步:链接npm
输入命令: npm adduser
这个命令需要输入四个信息以供连接上npmjs:
- 用户名
- 密码
- 邮箱(是你在npmjs官网上注册时使用的信息)
- 校验密码。它会向你的邮箱发邮件
如果不知道自己是否上传成功,可以通过 npm who am i 来检查自己是否链接成功
第五步:连接成功后,把包上传到npm
需要通过 npm publish 命令来时实现,如果上传成功,会显示如下图示效果
如果出现错误可能是:
(1).这个包名被别人先用了。
(2).包的版本号不对:每次publish时,包的版本号都应该要大于之前的版本号。
(3).文件过大。你可能需要创建.npmignore
文件来设置在打包时要忽略哪些文件。
第六步: 上传成功之后,就可以下载使用了,通过npm install 包名
即可来安装包。 然后,告诉你的小伙伴们去下载使用吧。
这整个过程中我们需要注意的问题:
1.把代码上传到npm上去,必须要是包的格式,包是什么格式呢,也就是一定要有 package.json这个文件。 它就是用来对包进行整体说明。(name, version, description, author, dependencies, ......). npm init --yes
, 有自己的代码文件。这个代码文件要在package.json中的main中声明。
2.在上传到npm之前,我们需要切换镜像
3.在上传时,包不能与现有的包重名,另外包只能是小写字母+数字+中划线
4.如果上传出错,可能你的帐号还没有通过验证 (在你登记的邮箱里,会收到一封邮件,要去点击确认)。 qq邮箱好像不支持在手机中操作, 建议在pc中浏览器里进行操作。
另外可能没有登录,没有做npm adduser,或者是网不好!
好啦 以上就是npm包从创建到发布详细步骤,赶紧去试试吧!!