SuperAPI AI 工具集

xrk-botutil

编程与开发

查看项目

更新于 11-05 16:20

技能介绍

BotUtil 是一个“基础设施工具箱”,用于把 Bot 项目中常见的底层能力集中封装,供业务代码复用。按资料,其权威文档位于 docs/botutil.md,代码位于 src/utils/botutil.js。

主要能力包括:日志(makeLog/makeLogID)、缓存(getMap/cache)、文件(readFile/writeFile/fileToUrl)、命令与异步控制(exec/promiseEvent/sleep),以及时间、大小格式化等工具函数。Bot 通过代理透传 BotUtil 静态方法,如 Bot.makeLog、Bot.fileToUrl、Bot.exec、Bot.promiseEvent。

使用方式上,建议优先调用 BotUtil 封装的方法,而不是在业务代码里直接乱写 fs/fetch/child_process,以保证行为统一、可观测。用户目录相关能力位于 src/utils/user-dirs.js(getDefaultDesktopDirSync / resolveUserDesktopDirAsync),供 BaseTools、tools/desktop 工作流复用,避免写死 ~/Desktop。

适用场景:需要复用日志、缓存、文件、网络、批处理等基础能力;为新模块选择合适的工具函数;定位子系统实现路径与配置入口;快速给出改动落点与兼容性注意事项。

限制:不用于替代其他子系统的实现说明;不在缺少证据时臆造路径或字段。执行步骤建议先确认需求属于该技能职责边界,再给出代码路径、配置路径与关键字段,最后补充风险点、验证步骤与回归范围。常见陷阱包括只给概念不给具体文件路径、文档与代码冲突时未标注以代码为准、忽略配置与 Schema 及消费代码的一致性。其他入口包括项目概览 PROJECT_OVERVIEW.md,以及 src/、core/ 对应子目录和 docs/ 下对应主题文档。