插件结构

插件目录结构

1 、整体结构

plugins/
└── my-plugin/                 # 插件根目录(目录名即插件 ID)
    ├── manifest.json          # 插件配置文件(必需)
    ├── data/                  # 数据目录(可选)
    ├── frontend/              # 前端目录
    └── backend/               # 后端目录(可选)

2 、前端目录结构

frontend/
├── dist/                      # 构建输出目录
│   └── index.html             # 打包后的单文件(生产模式入口)
├── src/                       # 源代码目录
│   ├── App.vue                # 主组件(Vue 项目)
│   ├── main.js                # 入口文件
│   └── components/            # 组件目录
├── public/                    # 静态资源
│   └── logo.png               # 图标等
├── index.html                 # HTML 模板
├── package.json               # 依赖配置
└── vite.config.js             # Vite 构建配置

说明:

  • dist/index.html 是生产模式的入口文件,需打包成单个 HTML 文件
  • 开发模式下直接连接 Vite 开发服务器(如 http://localhost:5173

3 、后端目录结构(Python)

backend/
├── main.py                    # 入口文件
├── handlers.py                # 接口函数(@sdk.handler)
└── utils/                     # 工具包
    ├── __init__.py            # 包初始化
    ├── xiaowo_sdk.py          # SDK 核心
    └── common.py              # 公共函数

各文件职责:

文件 职责
main.py 入口文件,导入 handlers 并启动 sdk.run()
handlers.py 存放所有 @sdk.handler 装饰的接口函数
utils/xiaowo_sdk.py SDK 核心实现,提供 sdk 实例
utils/common.py 公共函数、常用工具函数

4 、数据目录

data/
├── config.json                # 插件运行时配置
└── cache/                     # 缓存文件(可选)

data/ 目录用于存放插件运行时产生的数据,与代码文件分离。

0个回答默认排序 投票数排序
还没有回答~
请先登录