如何编写一个npm包,能够公共使用?

常常开发vue的项目,package.json文件你们应该都很是都清楚,所谓的依赖,就是js逻辑的暴露,如今告诉你们怎么发布本身写的npm包,供全球人使用。html

npm包建立步骤

1.建立一个文件夹

mkdir test
cd test
npm init
而后一路回车便可vue

2.在test文件夹建立index.js(主入口文件)

index.js内容自定义便可
示例:git

module.exports = function(options) {github

const options = options || {};
return function(req, res, next) {
    console.log(req, res, next);
}

}npm

3.完善init初始化的package.json文件

name:包的名字,确保该名字是独一无二的
version:包的版本,默认是1.0.0
description:包的描述
main:入口文件,默认是index.js
test command:测试命令
repository:git仓库地址,通常为”type”:”git”,”url”:”git的url”
keyword:这个挺重要,尽可能用比较贴切的关键字做为这个包的索引,这样才能有更多的人搜索到你的包
author:写你的帐号或者你的github帐号吧
license:开源协议用了哪一个json

4.添加LICENCE文件(咱们选择MIT)

参考连接:https://spdx.org/licenses/MIT... & https://opensource.org/licens...
新建文件名称为:LICENSE 没有后缀
内容输入参考连接里面的text内容便可。
将<year> 和 <copyright holders>修改成 对应的年份 和 版权拥有者名字测试

5.添加 README.md 文件 和 .gitignore

README.md 文件主要用于 该项目的一些说明,使用方法等
好看的版本信息参考连接:https://shields.iourl

6.发布npm包

  • 首先,注册npm帐号,连接:https://www.npmjs.com
  • 其次,打开终端,到test目录,输入:npm adduser;而后输入npm whoami,若是出现注册名字,说明成功
  • 最后,输入npm publish --access=public,便可发布成功
  • 测试是否发布成功,直接 npm install 你的包名,或者去注册帐户查看
  • 若是更新版本,须要更改package.json里面的版本号,否则会报错

以上就是几步,但愿你们可以开发本身想作的npm包。code

相关文章
相关标签/搜索