开发属于自己的包并发布npm

145 阅读1分钟

初始化包的基本结构

  1. 新建文件夹作为包的根目录
  2. 在该文件夹中,新建如下三个文件:
  • package.json 包管理配置文件
  • index.js 入口文件
  • README.md 说明文档

初始化 package.json

  • name: 包名,供在npm中搜索
  • version:版本号,每发布一次npm包就要增加一个版本,每个版本不能重复。
  • description:包的简短描述
  • keywords: npm检索的关键字
  • author: 作者
  • license: ISC

模块化拆分

  • 将不同功能的模块分别拆分到src文件夹下的不同js文件中
  • 在index.js中导入所有功能模块,得到需要向外共享的方法
  • 在index.js中,使用module.exports把对应的方法共享出去

编写包的说明使用文档

一般包括安装方式、导入方式、以及函数使用说明、作用等

把包发布到npm

在终端登陆前确定当前镜像是npm源,可以设置npm config set registry https://registry.npmjs.org/
然后输入npm login依次输入npm登录账号、密码和邮箱 image.png
最后切换到项目根目录输入npm publish即发布成功