一. 首先把我们将准备发布的包准备好
1. 初始化包的基础结构
新建文件夹,作为包的根目录,文件夹名字在 npm 官网看看有没有被占用
在新建文件夹中,新建如下三个文件:
package.json (包管理配置文件)
index.js (包的入口文件、自定义)
README.md (包的说明文档)
2. 初始化 package.json
配置文件
{
"name": "flightloong-tools", //包名跟文件夹名称一样
"version": "1.0.0",// 版本号
"description": "提供格式化时间、HTMLEscape相关功能", // 功能提示
"main": "index.js", // 跟包的入口文件 js 名字要一样
"keywords": [
"itcast",
"itheima",
"dateFormat",
"escape"
],
"license": "ISC" // 开源协议
}
3. 编写包的说明文档
根目录中 README.md
文件,是包的使用说明文档。通过它,我们可以事先把包的使用说明,以 markdown
的格式写出来,方便用户参考
README
文件中具体写什么内容,没有强制性的要求;只要能够清晰地把包的作用、用法、注意事项等描述清楚即可
二、注册 npm 账号
自行在官网注册
三、登录 npm 账号
- npm 账号注册完成后,可以在终端中执行
npm login
命令,依次输入用户名、密码、邮箱后,即可登录成功,填写密码没有显示,盲打就行,打完回车键 - 在运行
npm login
命令之前,。否则会导致发布包失败!
四、把包发布到 npm 上
cd到根目录执行命令
npm publish //将包发布在 npm 上
npm unpublish 包名 --force //删除已发布包
注意事项
npm unpublish
命令只能删除 72 小时以内发布的包
npm unpublish
删除的包,在 24 小时内不允许重复发布
网友评论