如何编写一个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包,可以公共使用?相关推荐
- npm 查看登陆账号_发布第一个npm包
这篇文章主要介绍如何发布一个npm包,这个过程并不复杂,学完之后你可以发布任何你喜欢的代码到npm网站上,之后你可以使用npm命令安装在其他项目中. 发布到npm网站之前,你必须在npm网站上创建一个 ...
- 手撸一个npm包,安利一下duiba-sprite
背景 我所在组负责我司线上H5互动小游戏的开发,其中一部分开发者负责皮肤的开发.大致流程为:视觉出psd,开发者切图,开发者开发,开发者上传皮肤代码,运营验收.这里边有个奇葩的动作:开发者切图,为什么 ...
- 怎么开发一个npm包
一.注册npm账号 * 怎么将代码提到github,大家都知道需要一个github账号 * 同样,开发一个npm包,当然也需要一个npm账号,将npm包发布到npm的托管服务器 * 注册地址:[htt ...
- 用vue写一个npm包(package),发布及引用
提示:vue写一个npm包(package) 文章目录 前言 一.npm 二.npm package开发 三.引用package 总结 前言 之前一直都是用别人封装好的npm包,新接了一个需求,自己写 ...
- 每日三问之html5css3新特性、如何写一个npm包、围绕vue-router展开分析知识点
html5&&css3新特性 html5 HTML5 新元素(HTML5提供了新的元素来创建更好的页面结构) 标签 描述 <article> 定义页面独立的内容区域. &l ...
- 一个 npm 包的坎坷“续命”之生
如果说 npm 的大新闻,莫过于之前的 left-pad 撤包事件,event-stream 投毒事件,Ant Design 彩蛋事件.使得很多前端开发者又开始重新思考 npm 生态时候真的存在问题? ...
- npm 卸载_手把手教你创建一个NPM包
前言 在前端,基于NodeJs的工程化开发已经是一个很成熟的解决方案,而工程化的构建又离不开诸多便捷又高效的可复用的NPM包,那么这些包是如何制作.发布的呢?今天我们就来研究一下这个问题. ...
- 如何开发一个npm包并发布
一.安装nodejs 不多说了,网上教程多得是 二.创建自己的npm包 目录结构 npm-test a.js b.js package.json 开发 为了简单便于理解,就开发一个简单地hello程序 ...
- 如何发布一个npm包?
npm包在现在前端开发中经常使用且便利,而我也是经常使用,而没研究怎么去发布npm.那如何发布npm包呢? 一.在npm的官网上注册一个账号登录,https://www.npmjs.com/ 注意此步 ...
最新文章
- 由Node.js事件驱动模型引发的思考
- 2.常用的实现多线程的两种方式
- 宏基ec471g黑苹果_宏碁acer ec-471g 黑苹果配置教程
- 程序员不是神……心态决定一切(转载)
- python 协程原理_Python协程greenlet实现原理
- 把时间投资在自己的未来
- MySQL必知必会(使用子查询)
- python如何给定取值范围_python怎么限定函数自变量取值范围
- 鸿蒙应用案例:Ability应用与管理
- Parhaps you are running on a JRE rather than a JDK?
- es6 class语法糖
- ural 1066 uva 1555
- acer台式电脑怎么重装系统_宏基台式电脑怎么重装系统
- 主流无线芯片厂商的自动信道选择算法小结
- 免费网站地图制作工具 —— Sitemap X
- animate发布html5教程,Adobe Animate CC 中的 HTML 发布模板 - Adobe Animate 用户指南
- PPT转换为视频_ppt2dvd-pro
- 【MySQL】修改用户名和密码
- hdfs大概流程和命令操作
- Django实现用户注册登录,表单提交后跳转网页(学习笔记)