uni-app开发插件并发布到插件市场详细步骤
背景
uni_modules 是 uni-app 的插件模块化规范(HBuilderX 3.1.0+支持),通常用于封装一组js sdk、组件、页面、uniCloud云函数、公共模块等,以便嵌入到 uni-app 项目中使用,也支持直接封装为项目模板。
插件开发者可以像开发 uni-app 项目一样编写一个 uni_modules 插件,并在HBuilderX中直接上传至插件市场。使用 uni_modules 开发的插件,可以直接在 uni-app 的任意页面中使用,类似于easycom组件模式,无需在每个页面单独引入。
更多关于 uni_modules 的信息,请参考 官方文档。
开发前提条件
- 开发环境:HBuilderX
- 一个用于开发插件的 uni-app 项目
- 开发和测试环境,如微信开发者工具或手机
插件开发步骤
新建 uni_modules 插件
- 在 uni-app 项目根目录下新建 uni_modules 文件夹(如果已存在可跳过此步)。
- 右键点击 uni_modules 文件夹,选择新建 uni_modules 插件。
- 在弹出的对话框中,填写插件ID、地址和分类,然后点击创建。
创建完成后,插件将出现在 uni_modules 目录下。关于 uni_modules 的目录结构,请参考 官方文档。
编写插件内容
插件内容的具体实现因插件类型而异。例如,开发一个多行文本收起展开插件,相关内容可参考 插件市场示例。在编写插件时,需要完成插件文档,即在插件目录下的 readme.md 文件中编写说明。
发布到插件市场
- 右键点击编写好的插件目录,选择发布到插件市场。
- 在弹出的发布对话框中,填写相关信息,如插件名称、描述等。部分信息会自动填充,但需仔细阅读插件ID命名规范以确保符合要求。
- 填写更新日志(必填项),更新日志将与 changelog.md 文件同步。
- 确认信息无误后,提交发布。
提交后,插件将发布到插件市场,开发者可以在 管理中心 查看和管理。
注意事项
- 插件相关信息可以在 package.json 文件中配置,具体配置说明请参考 官方文档。
- 更新日志为必填项,需与 changelog.md 文件保持一致。
- 发布后,可在插件市场管理中心进行管理。
现在,动手开发你的第一个 uni-app 插件吧!