SuperAPI AI 工具集

obsidian-develop

编程与开发

查看项目

更新于 11-12 04:25

技能介绍

该技能面向 Obsidian 社区插件的开发与维护,核心思路是把自然语言需求转化为在运行中的应用里可验证、并能通过社区审查的插件改动。它强调对照实际运行的 Obsidian 编写代码,因为 DOM 与私有内部结构会随版本变化。

用途与工作流程

工作流为一个循环:明确需求、探查现有应用、运行时原型、实现、构建重载并验证、提交前审查。第 0 步先确定运行时后端,需要六项能力:执行 JS、读取控制台与错误、查询 DOM 与 CSS、截图、重载或启用插件、列出或执行命令。可用 Obsidian MCP 服务器(按用途匹配工具,不同服务器名称不同),或使用官方 Obsidian CLI(安装器 1.12.7+,设置→通用→命令行界面,用 obsidian version 检查),两者皆无时则构建后请用户重载插件并粘贴控制台输出。基于 CDP 的服务器需以 --remote-debugging-port=9222 启动 Obsidian;基于 CLI 的服务器需开启 CLI 设置。

主要步骤:把需求复述为行为、API 接口面、完成标准三份清单;在写代码前探查实时应用中的 DOM、CSS 类、视图、命令、已启用插件、元数据缓存及插件自身加载状态;用 eval 在运行时先验证核心逻辑;按参考文档把各视图、弹窗、设置页、编辑器扩展拆到独立模块;执行 npm run build,部署并重载,清空控制台、触发功能、检查错误、查询 DOM 并截图,逐项核对完成标准;最后从仓库根目录运行 npx eslint . 并走审查清单,警告也视为阻碍。

关键规则

所有事件、DOM 事件、定时器、命令、视图、编辑器扩展都须注册,使 onunload 无需额外处理;不在插件上持有视图引用;启动工作延迟到 onLayoutReady;文件操作走 Vault 与 FileManager API,删除用 trashFile,路径经 normalizePath;活动视图用 getActiveViewOfType 或 activeEditor;DOM 用 createEl 等构建,禁用 innerHTML 与内联样式;严格 TypeScript,用类型收窄而非强制转换;网络用 requestUrl;默认兼容移动端,无 Node/Electron 导入除非 isDesktopOnly;UI 文案用句式大小写。

安全与限制

优先使用专用测试库,探查性 eval 必须只读;写入、重命名、移动、删除库文件或修改其他插件设置前须征得同意,用户库不是沙箱。若某项检查无法自行运行,需明确说明。回复应简洁,包含需求清单、改动文件、已验证项及未验证或用私有 API 之处。