如何编写一个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包。
总结
以上是生活随笔为你收集整理的如何编写一个npm包,可以公共使用?的全部内容,希望文章能够帮你解决所遇到的问题。
- 上一篇: VUE从零开始系列(路由钩子及插件开发)
- 下一篇: sql语句之where子句