# 调试与排错
这一页是“开发插件时最常用的排错清单”。
# 快速调试流程(推荐)
- 把插件放入插件目录(见 插件使用指南 的“手动安装”)。
- 打开 启动台 → 插件管理。
- 在插件列表中对你的插件执行:
- 重载:修改代码后最常用
- 禁用/启用:验证停用清理是否正确
停用插件时,插件系统会调用
deactivate(),并自动dispose()掉context.subscriptions里收集的 disposable。
# 观察日志
- 在
activate(context)中优先用context.log / warn / error输出日志(自带插件前缀,方便定位)。 - 如果插件加载失败,插件管理器通常会显示
ERROR状态;也可以结合开发者工具/控制台查看错误堆栈。
# 常见坑
- ID 冲突:
commands/cardId/pageId/widgetId建议统一用${pluginId}.xxx命名。 - 忘记清理资源:定时器、事件监听、窗口引用等要在
deactivate()或 disposable 的dispose()中清理。 - 误用 API 名称:主进程侧是
api.window(不是api.windows)。建议以文档/API 实现为准。
# 插件数据目录位置
插件系统会为每个插件创建独立数据目录:
context.storagePathcontext.globalState保存到global-state.jsoncontext.workspaceState保存到workspace-state.json
这些文件都位于用户数据目录下的插件存储子目录中。