SuperAPI AI 工具集

obsidian-dev-rules

编程与开发

查看项目

更新于 10-15 16:42

技能介绍

用途:为开发、调试或审查 Obsidian 插件与主题提供规则与参考,镜像官方开发者文档,无需反复查阅网络资料。

主要能力:覆盖插件基础(项目搭建、manifest.json、onload/onunload 生命周期、资源注册与清理、事件、热重载与调试)、Vault 与 Editor API(读写笔记、TFile/TFolder、normalizePath、Markdown 后处理与代码块处理器、CodeMirror 6 扩展)、UI(命令与快捷键、PluginSettingTab、Setting 控件、Modal/SuggestModal/FuzzySuggestModal、ItemView 与工作区叶子、功能区与状态栏)、主题与发布(CSS 变量、theme.css/manifest、snippets、社区目录提交与开发者政策)。API 通过 obsidian npm 包提供,起点为 obsidian-sample-plugin。

硬性规则:使用 this.app 而非全局 app;需清理的资源必须通过 registerEvent / registerInterval / registerDomEvent / addCommand / registerView / registerMarkdownPostProcessor 注册,其余在 onunload() 手动释放;禁止用 innerHTML 等注入动态内容,改用 createEl()/createDiv()/createSpan();优先 Vault API,用 getFileByPath(),用户路径经 normalizePath();写回用 process() 而非 read()+modify(),cachedRead() 仅用于展示;编辑活动笔记用 Editor 接口以保留光标与选区;不保存视图实例引用,用 getLeavesOfType()/getActiveViewOfType();分发插件不设默认快捷键;UI 文案用句首大写;用 CSS 类与 Obsidian CSS 变量而非内联样式;manifest 必填 id、name、version、minAppVersion、description、author、isDesktopOnly,id 不得含 obsidian;发布时 GitHub release 标签需等于 manifest 版本,并附带 main.js、manifest.json 及可选 styles.css 为独立二进制资源;使用 async/await 与 const/let。

适用场景与限制:适合插件与主题的开发、审查和发布。具体安装步骤、进阶配置与更多示例暂未提供。