【干货】手把手教你发布属于自己的npm包

492 阅读3分钟

发布一个 实现格式化时间的方法和THMLEscape的功能 的npm包

代码都放在github上:github.com/seekbug/for…

1.初始化包的基本结构:

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

2.初始化package.json:

{
   "name":"format-tools-lxf",  //包名
   "version":"1.0.0",         //版本号
   "main":"index.js",       //入口文件
   "description":"提供了格式化时间,THMLEscape的功能" //描述
   "keywords":["itheima","dateFormat","escape"]  //搜索关键字
   "license":"ISC"  //license协议
}

3.将不同功能进行模块化拆分:

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

4.编写包的文档说明:

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

5.发布包:

(1)注册npm账号:
   ①访问 https://www.npmjs.com/ 网站,点击sign up 按钮,进入注册用户界面。
   ②填写账号相关信息:Full Name、Public Email、Username、Password。
   ③点击Create an Account按钮,注册账号。
   ④登录邮箱,点击验证链接,进行账号的验证。  
(2)登录npm账号:
    npm账号注册完成后,可以在终端执行npm login命令,依次输入用户名、密码、邮箱后,即可登录成功。
【注意】在运行npm login 命令之前,必须把下包服务器的地址切换为npm的官方服务器,否则会导致发布包失败。
 切换npm的下包镜像源的两种方法:
      方法一:
         (1)npm config get registry  //查看当前的下包镜像源
         (2)npm config set registry=https://registry.npm.taobao.org/  //将下包镜像源切换为淘宝镜像源
         (3)npm config get registry //检查镜像源是否下载成功
      方法二:
         (1)npm i nrm -g  //全局安装nrm
         (2)nrm ls        //查看所有可用的镜像源
         (3)nrm use taobao  //将下包镜像源切换为淘宝镜像源
 多了解一点: 
    npm i 包名 -g          //全局包会被安装到C:\User\用户目录\AppData\Roaming\npm\node_modules目录下
    npm uninstall 包名 -g  //全局卸载包
(3)发布包:
   将终端切换到包的根目录之后,运行 npm publish 命令,即可将包发布到npm上(注意:包名不能雷同)
 (4)删除已发布的包:
   npm unpublish 包名 --force   //删除已发布的包:
   【注意】
      (1)npm unpublish 命令只能删除72小时以内发布的包
      (2)npm unpublish 删除的包,在24小时内不允许重复发布
      (3)发布包的时候要慎重,尽量不要往npm 上发布没有意义的包(例如我们这个测试做完就把包删掉)