docs: fix relative paths in plugin standard docs after dev/ restructure
- dev/docs 插件标准文档中的相对路径适配到 dev/ 层级 - gitignore dev/docs/HD2/ 图标转换脚本与生成产物(cairosvg 输出等) Co-Authored-By: Claude Code <noreply@anthropic.com>
This commit is contained in:
@@ -1,14 +1,14 @@
|
||||
# HeXi 插件规范化审计报告
|
||||
|
||||
> 依据 《插件结构标准》(docs/plugin-structure-standard.md) 与 《插件配置文件标准》(docs/plugin-config-standard.md),
|
||||
> 并参照脚手架模板 `plugin_template/nonebot_plugin_template/`。
|
||||
> 并参照脚手架模板 `../plugin_template/nonebot_plugin_template`。
|
||||
> 说明:初版为**审计报告**;后续按用户确认已开始落地改造(见下方「本轮已落地改动」)。
|
||||
|
||||
---
|
||||
|
||||
## 0. 结论摘要
|
||||
|
||||
- 共 **24 个插件** 位于 `hexi/plugins/`,均由 `nonebot.load_plugins("hexi")` 加载,属于本地插件。
|
||||
- 共 **24 个插件** 位于 `../../hexi/plugins`,均由 `nonebot.load_plugins("hexi")` 加载,属于本地插件。
|
||||
- 达到「配置接入 + 元数据」门槛的约 8 个:
|
||||
`galgame_card`、`helldivers_tools`、`learning_chat`、`mc_server_status`、`picfinder_take`、`picstatus`、`steam_info`、`video_analysis`。
|
||||
其中 `galgame_card` 还具备 repository/models/web,最接近标准。
|
||||
@@ -137,7 +137,7 @@ nonebot_plugin_xxx/
|
||||
### 1.2 配置标准
|
||||
- `plugin_id` 必须 = NoneBot 插件模块名(`__name__`)。
|
||||
- 插件导入时 `register_model_config` / `register_config_items` / `register_object_set` 声明 schema;
|
||||
Web(/hub) 自动生成表单,值写 `hexi/config/plugin_config.json`。
|
||||
Web(/hub) 自动生成表单,值写 `../../hexi/config/plugin_config.json`。
|
||||
- 运行期读生效值 `get_effective_value(plugin_id, key, default)`,保证 Web 修改热生效。
|
||||
- 敏感字段 `secret=True`;来源无关项自带 getter/setter;权威源在插件自身用 `nosave=True`。
|
||||
- 禁止 `import *`、裸 `except`、`print()`(用 logger);数据路径用 `get_data_dir()`/插件路径,不硬编码。
|
||||
|
||||
Reference in New Issue
Block a user