如何发布自己的npm包

目标

在 npm 上发布一个适合团队代码风格的 eslint 配置包,项目名称为 eslint-config-vpgame

开发 eslint-config-vpgame

如何编写这个包并不是重点,代码直接戳这里

假定我们的包已经开发完毕,我们需要在其他项目中安装这个包进行测试。众所周知,如果在项目中需要引入 eslint-config-vpgame 包的话,我们需要执行

1
npm install eslint-config-vpgame --save-dev

但是在开发这个包的时候,我们不可能每次先发布到 npm 仓库,然后再在其他项目中使用 npm install 的形式来进行测试,我们希望在其他工程中能实时测试当前正在开发的 npm 包的效果,这里我们需要用到 npm link 命令

在当前开发的 eslint-config-vpgame 目录下执行

1
npm link

npm 会把该包关联到本机的 npm 全局安装目录下,即模拟了安装的效果

在另一个项目中使用:
创建新项目 some-project:

1
2
npm init -y
npm link eslint-config-vpgame

此时该项目会增加一个 node_modules 文件夹,即实现了 npm install 效果
当修改 eslint-config-vpgame 包的时候,该项目 node_modules 文件夹下的 eslint-config-vpgame 包也会自动更新

wow…大大的节省了测试时间

发布到 npm

到这步就很简单了,在 eslint-config-vpgame 项目根目录下执行

1
npm publish

如果没有帐号的话,按照提示设置一下就好了… 大功告成

PS:注意,最好先建好 git repo,然后 npm init -y 初始化项目,这样 package.json 中会关联 repo 地址,npm 项目主页面就可以展示 git repo 地址