1.注册账号
去npm官方文档注册账号,并验证邮箱,官网地址:https://www.npmjs.com/
2.创建包库
- 新建一个文件夹,并命名(名字随意)
- 在文件夹内执行初始化指令(npm init)并设置包的参数,接着就依次填写, 不想填写的话也可以一路Enter
- name: 模块名,发布之后就可以让用户
npm install xxxx
来引用你的开源模块 - version:版本号,语义版本号分为X.Y.Z三位,分别代表主版本号、次版本号和补丁版本号。当代码变更时,版本号按以下原则更新。
如果只是修复bug,需要更新Z位。
如果是新增了功能,但是向下兼容,需要更新Y位。
如果有大变动,向下不兼容,需要更新X位。 - description: 简单介绍自己的模块
- main: 入口文件,必要,当通过require(‘xxx’)时,是读取main里声明的文件
- test command: 测试命令
- git repository: git仓库地址
- keywords: 关键词,可以通过npm搜索你填写的关键词找到你的模块
- author: 作者信息,可以之后编辑更详细一些
- license(ISC): 代码授权许可 可以参考这里
以上放心可以大胆写,因为之后反正要改。
初始化项目完成,可以看到目录中出现了一个叫 package.json 的文件
- 新建一个index.js文件,并写入你的js方法
示例:
;(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
typeof define === 'function' && define.amd ? define(factory) :
global.moduleName = factory()
}(this, (function () {
var test = {
sayHi: function () {
console.log('hi');
}
};
return test
})))
- 执行
npm install -g
检查是否报错,下图代表成功
- 执行
npm link
(旨在安装开发包并实时查看更改,而无需继续重新安装)
2.发布包
- 登录npm
使用终端命令行
- 如果是第一次发布包,执行以下命令,然后输入前面注册好的NPM账号,密码和邮箱,将提示创建成功
npm adduser
- 如果不是第一次发布包,执行以下命令进行登录,同样输入NPM账号,密码和邮箱
npm login
注意:npm adduser
成功的时候默认你已经登陆了,所以不需要再进行npm login
了
- 接着先进入项目文件夹下,然后输入以下命令进行发布
npm publish
当终端没有出错,就代表版本号为1.0.0的包发布成功了!前往NPM官网就可以查到你的包了。
如果报错,是因为没有确认npm发过来的邮件,点开邮件确认即可。