JJianFeeeeedocs(example): 为每个插件补 README

7ef9bc2a创建于 12 天前历史提交

文件	最后提交记录	最后更新时间
README.md	docs(example): 为每个插件补 README 此前 example/ 下 21 个插件里，13 个完全没有 README，另 4 个是 `hmapdev init` 生成的脚手架样板（`# <name>` + `plugin build` + `Install` 三行，等于从没被写过）。只有 deepsearch / vikunja / plugindev / luademo 是真实文档。本次为 17 个插件写了真文档（13 个缺失 + 4 个样板），现在 21 个全部有内容。 ## 写法每个 README 覆盖：能力一句话 → 为什么需要 → 工具表 → 配置项表 → 通道与钩子（有才写）→ 构建 → 已知边界。事实全部从源码读出来，不推测： - 工具名核对到注册点（含 `tp+"x"` / `p.name+"_x"` 前缀拼接，展开成最终名） - 配置键与默认值取自 `RegisterDef` / getStr 默认值 - 通道名、钩子名、依赖命令逐条 grep 确认 - 版本号与已部署实例交叉核对，17 个里 16 个一致 ## 几处按源码写、与直觉不同的点 - rss：订阅时会把抓到的历史条目一次性标为 seen，所以订阅一个源不会把历史文章全推一遍 —— 这是避免刷屏的关键，写进了文档。 - files：路径校验是两道（规范化后判断 + 解析符号链接后再判断），只做前者的话沙箱里的软链接就能逃逸。两种情况报错文案不同。 - qq：身份必须绑帧而非存插件全局，源码注释记录了由此产生的两个真实故障（中断抢占恢复后权限门整体失效、运行中到达的消息改写正在跑那一轮的身份）。多来源合并时权限取交集。硬私有工具按前缀一律拒绝。这些是安全关键，单独成节写清楚。 - memo：待办与备忘录刻意分两类（一提醒一不提醒），提醒注入带 NoMemory。 - sanitizer：不注册任何工具，只挂三个阶段钩子；依赖 ABI v2 的 stage 写回能力。 - editdoc：本目录是 v1.0.0（单工具），而线上跑 v2.0.0（全能版，源码未公开）—— 在文档开头显式标注，不按 v2 描述，避免读者以为这里就是线上那份。 ## 验证 - 21/21 文件非空且非样板（最小 913B，最大 6845B） - 逐个核对 README 中出现的工具名能在源码找到依据；5 处报警经复核全是误报（`ai_image_generate`/`music_` 前缀来自 metadata 的 name，`on_input` 等是钩子不是工具） - README 版本号 vs 线上 plugin.json：16/17 一致，editdoc 的差异已显式说明注：本仓既有未提交改动（example/qq/plugin.go、sdk/plugin.go）未纳入本次提交*。	12 天前
go.mod	examples: update weather with v0.8.0 API surface, add luademo Lua example, fix go.mod replaces	2 个月前
main.go	feat: sdk NoMemory/Cleaner + example build fixes - sdk/plugin.go: ToolDef adds NoMemory/Cleaner fields - sdk/plugin_test.go: unit tests for NoMemory/Cleaner - all example plugins: NoMemory/Cleaner annotated for each tool - plugindev/templates.go: template shows NoMemory/Cleaner pattern - plugindev/cmd_build.go: fix ensureGoMod, buildBundle/buildTarget sdkPath param, NewPluginFactory - example/go.mod: add external dependency declarations (chromedp, gofeed) - add main.go stubs for all example plugins	2 个月前
plg.json	fix(examples): 全插件安全审查修复（qq/a2a/memo/calendar/rss/browser/bili/recoverydiag）审查发现并修复 7 项问题： - P1 qq: downloadURL 裸 http.Get 无超时 → 120s client - P2 a2a: inbound http.Server 零超时 → Read 30s/Write 120s/Idle 60s - P3 bili: output_dir 配置项零校验 → 系统目录黑名单（/、/etc、/usr、/var 等） - P4 recoverydiag: db_path LLM 可控任意 sqlite → 强制限制 data 目录内 - P5 memo/calendar/rss: os.WriteFile 直写 → atomicWriteJSON (temp+rename) - P6 qq: 3 处后台 goroutine（已读/rcon转发/下载）加 panic recover - P7 browser: dump-dom failback Kill 后补 wait 回收僵尸进程 recoverydiag 此前被 .gitignore 排除，但其 db_path 安全修复属生产代码，故取消忽略并入库。全部经 plugindev 重打包升版安装验证 config_kept=true。	1 个月前
plugin.go	feat(sdk): 通道方向契约落地 + 模板工程/示例插件显式登记 inputch + 生成器两处修正 ## 背景：内核侧发现的真问题在真实二进制压力测试里发现：插件只调 `RegisterOutputChannel("cli", ...)`，却用同一个通道名 `InjectTextSync("cli", ...)` 注入输入 ⇒ 内核 inputch 登记表里没有这个通道，"把 inputch 划给驻留子"直接失败（`划入 inputch cli: inputch 未注册`）。根因是契约没有落到插件与 SDK 面上：inputch 是内核最基本的输入路由单位， "谁会往这个通道注入输入"必须显式声明，而 SDK 文档没说清它与 RegisterOutputChannel 的分工，示例与模板工程也没有示范。 ## SDK 面 - `RegisterInputChannel` / `RegisterOutputChannel` 的文档补齐方向契约：入站（谁会注入）与出站（output_send__<name> 的回复发给谁）是分开登记的两件事；凡是用 `InjectText/InjectInput/InjectInterrupt(source, "<name>", ...)` 注入的通道名都要 RegisterInputChannel。README 同步补了一段契约说明。 ## 示例插件（全部补齐，之前只有 qq/weather 是对的） `a2a`、`acp`、`browser`、`memo`：注入用 `p.name` ⇒ 登记 `p.name`； `calendar`、`rss`：注入用字面量通道名 ⇒ 登记同名通道。（这些插件此前是"能注入、但通道不在登记表里"，与 cli 同类问题。） ## 模板工程（生成器 templates.go） - `tmplPluginGo`：示范入站+出站两个方向（含 ChannelDef/NoMemory 说明与 `inputch 未注册` 的成因）。 - `tmplMainLua`：同样两个方向（`register_input_channel` / `register_output_channel`）。 - `tmplReadme`：新增 "Channels" 一节（方向对照表 + 兜底告警说明）。 - 实测：`hmapdev init` 生成的 Go/Lua 工程都含通道代码，Go 工程可构建打包出 `.hmap`； `--lua` 工程同样生成通道代码。 ## 生成器两处修正（都是实测踩出来的） 1. `sdk install --from <dir>`：install 原本只能从 Release 归档下载，而 SDK 开发期的新能力（如 proc 桥要透传的 `InjectOptions.Priority`）还没发版 ⇒ 生成的工程必然编译失败（`z_proc_gen.go: opts.Priority undefined`）。现在可用本地源码装一个版本并激活。实测：`hmapdev sdk install --from <local sdk>` → 装成 v1.3.0 并激活 → 工程构建通过。 2. 构建前置校验 `sdkHasInjectPriority`：proc 桥模板需要 `InjectOptions.Priority`，旧 SDK 没有时应给出可执行的报错（升级 SDK 或用 `--from`），而不是把两条 `opts.Priority undefined` 编译错误甩给用户（那些错误指向生成物，完全看不出是 SDK 版本问题）。实测：声明 sdk=1.2.0 的工程构建时正确命中该提示。 ## 未决（发布期事项） `InjectOptions.Priority` 属本特性线新增能力，已发布的 SDK v1.2.0 不含它*；发版时 SDK 版本需随之内含该能力（当前源码 meta 已是 1.3.0），否则外部开发者按文档生成的工程会撞上上面那条守卫。	19 天前

calendar · 日历事件

事件管理：支持重复事件与多档提醒。

工具

工具	说明
`calendar_event_add`	添加事件
`calendar_event_list`	列出即将到来的事件（含日期、时间、重复规则）
`calendar_event_update`	更新事件（只改传入的字段；会重置提醒状态）
`calendar_event_delete`	删除事件（连带该事件及之后的所有重复实例）
`calendar_today`	今日事件 + 倒计时
`calendar_week`	本周事件，按天分组
`calendar_month`	月历网格，带事件标记点
`calendar_search`	按关键词搜标题 / 地点 / 备注

calendar_event_add 的时间格式：YYYY-MM-DD HH:MM；只给 YYYY-MM-DD 表示全天事件。

重复规则

repeat 取值：

值	含义
`none`	不重复
`daily`	每天
`weekday`	每个工作日
`weekly`	每周
`biweekly`	每两周
`monthly`	每月
`yearly`	每年
`lunar_yearly`	按农历年（生日、传统节日用）

lunar_yearly 是刻意加的：农历节日按公历写死会逐年偏移。

提醒

remind_before 单位是分钟，可给多个、逗号分隔：

15,60,1440      # 提前 15 分钟 + 1 小时 + 1 天
0 或留空        # 不提醒

到点通过 InjectInterruptText 注入提醒，带 NoMemory: true —— 提醒是瞬时信号，不是记忆内容。通道 calendar 同样声明为 NoMemory。

存储

事件存为 JSON，插件重启后保留。

构建

hmapdev build