如何编写一个npm包,可以公共使用?

经常开发vue的项目,package.json文件大家应该都非常都清楚,所谓的依赖,就是js逻辑的暴露,现在告诉大家怎么发布自己写的npm包,供全球人使用。

npm包创建步骤

1.创建一个文件夹

mkdir test
cd test
npm init
然后一路回车即可

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

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

module.exports = function(options) {

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

}

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:开源协议用了哪个

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.io

6.发布npm包

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

以上就是几步,希望大家能够开发自己想做的npm包。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值