开发一个js包并且发布到npmjs.com上

Posted 2021-06-08 天边彩虹

一、前期准备

  1. 在npmjs.com上注册一个账户

  2. 简单搭建本地npm私服

    1. 全局安装pm2

    2.全局安装verdaccio

    3.使用pm2启动verdaccio，地址为http://localhost:4873

    4. 使用nrm注册本地registry，命名为local

    5. 使用nrm切换到local，并添加一个账户

二、本地开发测试（可结合打包工具）

  1. 在js包名下新疆package.json, 并填写相关配置

  2. 在src目录中存放源代码文件

  3. 在test目录下存放测试文件

  4. 在package.json中设置主入口文件

三、发布到本地npm私服（只是本地或内部使用的话，不必发布到npmjs.com）

  1. 使用nrm查看当前的registry，如果不是local的话切换到local

  2. 使用npm publish发布到local，包名或版本不能与已有的重复

  3. 在local上查看（http://localhost:4873/）

  4. 在其他项目中安装使用，测试是否可用

四、发布到npmjs.com

  1. 使用nrm切换到npm，并用已注册好的账户登录

  2. 使用npm publish发布

注：如果要发布一个scope包到npmjs.com，package.json的name要加上@用户或@组织名，私有包需要付费

注：使用npm publish access publish 命令发布scope的public访问权限的包，避免包命名冲突

注：可使用npm upublish命令取消发布

注： package.json相关配置字段可参考npmjs.com