插件分享

约 748 字大约 2 分钟

想要将插件与他人分享，您必须为此创建一个公开的 Github 仓库

后端

插件仓库命名规则

插件仓库名 == 插件名

假如插件仓库命名为 sms，安装此插件后，backend/plugin 目录下就会新增一个 sms 文件夹

插件总是独一无二的，不允许安装同名插件，所以在对插件进行命名时，应尽量保持其独特性，否则将导致插件冲突

创建个人插件仓库
使用 fba_plugin_template 创建个人插件仓库
上传代码
将在 fba 中开发好的所有插件代码拷贝到个人插件仓库中
警告
应拷贝插件目录中的所有文件，而不是拷贝插件目录

前端

插件仓库命名规则

为了区分 UI 插件，我们需要为插件仓库名添加 _ui 后缀

插件仓库名_ui == 插件名_ui

假如插件仓库命名为 sms_ui，安装此插件后，apps/web-antd/src/plugins 目录下就会新增一个 sms_ui 文件夹

插件总是独一无二的，不允许安装同名插件，所以在对插件进行命名时，应尽量保持其独特性，否则将导致插件冲突

创建个人插件仓库
使用 fba_ui_plugin_template 创建个人插件仓库
上传代码
将在 fba_ui 中开发好的所有插件代码拷贝到个人插件仓库中，仅限 Vben Admin Antd 工程
警告
应拷贝插件目录中的所有文件，而不是拷贝插件目录

发布插件

要想发布插件，你需要为 fba 插件 github 仓库创建一个 PR.

Fork 仓库
进入 fba 插件 github 仓库，将仓库 fork 到个人账户

克隆仓库

# 将地址替换为上面 fork 的仓库地址
git clone https://github.com/your-username/plugins.git

创建分支

# 注意替换 add-your-plugin-branch
git checkout -b add-your-plugin-branch

扩展子模块

# 注意替换 your-username、your-plugin-name
git submodule add https://github.com/your-username/your-plugin-name.git plugins/your-plugin-name
git add plugins/your-plugin-name

注意

所有扩展子模块必须使用 HTTPS URL，而不是 SSH URL（git@github.com）

提交和推送

# 注意替换 your-plugin-name
git commit -m "Add your-plugin-name plugin"

# 注意替换 add-your-plugin-branch
git push --set-upstream origin add-your-plugin-branch

PR
通过 GitHub 创建 PR
合并
fba 团队将尽快完成检查，一旦您的 PR 合并，插件将被发布到插件市场

更新插件

要想更新插件，你需要为 fba 插件 github 仓库创建一个 PR.

执行与发布相同的步骤，并更新以下行为：

更新步骤 4 中的命令

git submodule update --remote plugins/your-plugin-name
git add plugins/your-plugin-name

更新步骤 5 中的提交信息，现在已不再是新增，而是更新