SuperAPI AI 工具集

obsidian-common-errors

测试与质量

查看项目

更新于 10-16 06:20

技能介绍

用途:这是一份 Obsidian 插件开发的排错指南,针对六个高频错误给出根因与可复制的修复方案。

主要能力:

  1. 工作区未就绪:在 onload 中过早访问 app.workspace.activeLeaf 或 getActiveViewOfType 会返回 null,应在 onLayoutReady 回调内操作,或用 null 检查与 checkCallback 保护。
  2. 插件加载失败:多因构建产物或 manifest 问题。需确认 main.js 编译通过并存在于插件根目录,manifest.json 含 id、name、version、minAppVersion 等字段,id 需与 .obsidian/plugins/ 下文件夹名一致,且入口使用 export default class。可运行 npm run build 排查 TypeScript 错误。
  3. CSS 不生效:Obsidian 只自动加载插件根目录下名为 styles.css 的文件,注意是复数,不能放在子目录;用预处理器时构建需输出到 ./styles.css。
  4. 命令未出现在命令面板:addCommand 必须在 onload 内直接调用;仅在编辑器打开时可用应改用 editorCallback。
  5. Vault 读取报错:文件不存在时读取会抛错,应先用 adapter.exists 检查,或用 getAbstractFileByPath 配合 instanceof TFile 判断。
  6. 设置未持久化:修改设置对象后必须 await saveData,设置页应在 onChange 中保存;加载时用 Object.assign 合并默认值,避免新增字段为 undefined。

使用方式:需具备 Obsidian 插件开发环境、插件源码和开发者控制台(Ctrl/Cmd+Shift+I)访问权限。按错误类型定位对应步骤,套用修复代码并重新构建、重载。可用清单按序排查:查看控制台红色错误、确认三个必需文件存在、检查 manifest 字段、确认 export default、重新构建后按 Ctrl/Cmd+R 重载。

适用场景:插件开发调试、故障排查与开发前的代码规范参考。

限制:资料仅覆盖上述六类错误,未提供其他错误、兼容版本范围、收费或平台信息;文中提到的其他深入调试资源详情暂未提供。