MIP 组件库升级公告

时间：2022-06-04 15:26:29

背景

为了方便广大开发者们更好地使用组件，现对 MIP 组件库统一进行升级，升级后将分为通用组件和自定义组件两类，方便开发。

通用组件，即考虑了组件通用性方便所有开发者参考使用的组件，将存放于 mip-extensions 仓库下，同时欢迎开发者贡献通用组件，为 MIP 技术做贡献，提交通用组件时，请通过 GitHub mipengine/mip-extensions提交。

自定义组件，即针对自己开发的站点进行自定义的组件，将统一存放在 mip-extension-platform 下。开发者提交新的自定义组件时，可以通过GitHub提交，也可以通过更便捷的组件平台提交。若开发者自定义的组件，之前是以GitHub的形式提交，在此次升级后被迁移至了mip-extension-platform下，则仍在 GitHub mipengine/mip-extensions-platform上以 pull request 的形式来进行维护即可。

更具体的变化及要求见下文。

提交方式

  • 原位于 mip-extension-platform 仓库下的组件可以继续走组件审核平台进行提交。
  • 从 mip-extensions 迁移过来的组件暂时从 mip-extension-platform 仓库中提交 pull request 更新组件，紧跟后续我们会在组件审核平台加入 GitHub 授权登陆，将组件与 GitHub 账号进行关联，从而通过 GitHub 账号登陆即可在平台提交代码。

脚本引用变化

  • 升级后 MIP 组件使用统一一套地址，即 https://c.mipcdn.com/static/v1/组件名/组件名.js。
  • 原组件审核平台提交的脚本引用地址 https://c.mipcdn.com/extensions/platform/v1/组件名/组件名.js 可以得到兼容，站长无需进行任何修改，但后续页面开发中必须以新地址进行引用。

如何贡献通用组件

提交方式

通过 GitHub 在 mip-extensions 里提交 pull request，并由官方审核人员及时进行审核。

提交要求

  • 使用原生JS编写。
  • 使用中文注释。
  • 组件必须遵守 MIP 组件规范，通过 MIP CLI 和 fecs 工具校验。
  • 功能必须通用，独立，不掺杂任何业务逻辑。
  • 符合MIP组件提交规范。

如果有任何问题，可以通过 GitHub ISSUE 与项目组交流讨论。

相关文章