怎样开发属于自己的包

1.规范的包结构

  1. 一个规范的包,它的组成结构,必须符合以下 3 点要求:
    • 包必须以单独的目录而存在
    • 包的顶级目录下要必须包含 package.json 这个包管理配置文件
    • package.json 中必须包含 name,version,main 这三个属性,分别代表包的名字、版本号、包的入口

2.需要实现的功能

3 初始化包的基础结构

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

4. 初始化 package.json 配置文件

{
  "name": "flightloong-tools",
  "version": "1.0.0",
  "description": "提供格式化时间、HTMLEscape相关功能",
  "main": "index.js",
  "keywords": [
    "itcast",
    "itheima",
    "dateFormat",
    "escape"
  ],
  "license": "ISC"
}

5.package.json 文件中 main 的作用

在导入一个文件的时候,如果没有指定一个特定的文件,但是却能够得到某个包的返回内容,这是因为 Node 在使用 require 导入某个路径的时候,发现没有具体的文件,就会看这个路径下查看是否有 package.json 这个文件,如果有,则查看是否有 main 这个属性,如果有,则指定 main 属性对应的文件作为要执行的文件

6.划分不同的模块

  1. 将格式化时间的功能,拆分到 src -> dateFormat.js 中
  2. 将处理 HTML 字符串的功能,拆分到 src -> htmlEscape.js 中
  3. 在 index.js 中,导入两个模块,得到需要向外共享的方法
  4. 在 index.js 中,使用 module.exports 把对应的方法共享出去

7.编写包的说明文档

  1. 包根目录中的 README.md 文件,是包的使用说明文档。通过它,我们可以事先把包的使用说明,以 markdown 的格式写出来,方便用户参考
  2. README 文件中具体写什么内容,没有强制性的要求;只要能够清晰地把包的作用、用法、注意事项等描述清楚即可
  3. 我们所创建的这个包的 README.md文档中,会包含以下 6 项内容
    • 安装方式
    • 导入方式
    • 格式化时间
    • 转义 HTML 中的特殊字符
    • 还原 HTML 中的特殊字符
    • 开源协议

注册 npm 账号

  1. 访问 npm 网站,点击 sign up 按钮,进入注册用户界面
  2. 填写账号相关的信息:Full Name、Public Email、Username、Password
  3. 点击 Create an Account 按钮,注册账号
  4. 登录邮箱,点击验证链接,进行账号的验证

8.登录 npm 账号

  1. npm 账号注册完成后,可以在终端中执行 npm login 命令,依次输入用户名、密码、邮箱后,即可登录成功
  2. 注意:在运行 npm login 命令之前,必须先把下包的服务器地址切换为 npm 的官方服务器。否则会导致发布包失败!
  3. 把包发布到 npm上

将终端切换到包的根目录之后,运行 npm publish 命令,即可将包发布到 npm 上(注意:包名不能雷同)

9.删除已发布的包

  1. 运行 npm unpublish 包名 --force 命令,即可从 npm 删除已发布的包

10. 注意事项

  • npm unpublish 命令只能删除 72 小时以内发布的包
  • npm unpublish 删除的包,在 24 小时内不允许重复发布
  • 发布包的时候要慎重,尽量不要往 npm 上发布没有意义的包!

你可能感兴趣的:(怎样开发属于自己的包)