npm 包开发最佳实践之 yarn link

[banxi1988]

我自己维护了一个 npm 包。wechat-mp-types, 也就是一个小程序 API 的 TypeScript 的声明文件包。

一开始我的开发流程是这样的。

1. 需要修改声明文件时，打开声明文件包项目，编辑更新。
2. 上传更新包。
3. 在使用这个声明文件包的项目中，更新此声明文件包。有时更新不下来就多试几次，或者指定版本再试一次。 如此循环，有时有点小改到，我只好先放着。

现在的流程：

1. 在 wechat-mp-types 包中执行： yarn link

➜  wechat-mp-types (master) ✔ yarn link
yarn link v1.7.0
success Registered "wechat-mp-types".
info You can now run `yarn link "wechat-mp-types"` in the projects where you want to use this package and it will be used instead.
✨  Done in 0.10s.

相当于直接将包 wechat-mp-types 包跟本地的包项目目录关联起来。

1. 然后再在小程序项目中,运行 yarn link "wechat-mp-types" 命令关联此包即可。

➜  my-awesome-mp (master) ✔ yarn link "wechat-mp-types"
yarn link v1.7.0
success Using linked package for "wechat-mp-types".
✨  Done in 0.11s.

这样我本地开发时修改了 wechat-mp-types 包之后，再也不需要打包，上传，更新这样反复繁琐的过程了。

[Mutoo]

npm 的开发教程里面就有提到本地开发应该使用 npm link 进行测试。