发布 npm 包到github

268 阅读1分钟

1 确保你的代码测试通过了

npm run test 全部是绿色(原谅色)才行。

2 上传代码到 npmjs.org

  • 更新 package.json

1.在 package.json 里将版本号改为 0.0.1,等我们做完了再改成 1.0.0

2.创建 index.js,在 index.js 里将你想要导出的内容全部导出

  • www.npmjs.com/ 注册一个账户
  • 确认一下邮箱(必须)
  • 在项目根目录运行 npm adduser

如果错误提示里面含有 registry.npm.taobao.org 则说明你的 npm 源目前为淘宝源,需要更换为 npm 官方源

  • 运行 npm publish

3 使用自己的包

1.预测其他使用你的包的人会怎么使用

  • 使用 vue-cli
  • 使用 webpack
  • 使用 parcel

2.分别使用这些方式来使用自己的包(我们只以 vue-cli 为例)

  • 使用过程中我们发现报错说 import 语法有问题,那时因为 node 目前确实不支持 import,我们需要用 babel 转译 import

a.你可以要求使用者自己用 babel 来转译

b.你也可以转义好了再给他用

npx parcel build index.js --no-minify (本来不应该加 --no-minify 的,奈何不加会有 bug,HTML 压缩把 slot 标签全删了) 将 package.json 的 main 改为 dist/index.js

2.使用 npm link 或者 yarn link 来加速调试

你每次修改源码之后,有两条路让别人得到最新效果

  • 更新 package.json 里的 version,然后 npm publish。别人通过 npm update xxx 来更新。
  • 如果你只是为了本地调试,可以在项目目录使用 npm link,然后在使用之处运行 npm link xxx,就是最新了