obsidian-sdk-patterns

# Obsidian SDK Patterns ## Overview Six production patterns that prevent the most common Obsidian plugin bugs: lost settings on upgrade, null-reference crashes on deleted files, memory leaks from unregistered events, stale metadata, and UI jank from rapid file changes. Each pattern is self-contained and copy-pasteable. ## Prerequisites - A working Obsidian plugin (see `obsidian-core-workflow-a`) - TypeScript strict mode enabled (`"strictNullChecks": true` in tsconfig) - Familiarity with `Plugin.onload()` / `onunload()` lifecycle ## Instructions ### Step 1: Typed settings with versioned migration Settings break when you add or rename fields between releases. Version the settings object and migrate on load so existing users keep their data. ```typescript // src/settings.ts interface PluginSettingsV1 { apiKey: string; interval: number; } interface PluginSettingsV2 { version: 2; apiKey: string; syncInterval: number; // renamed from "interval" excludedFolders: string[]; // new field theme: "default" | "minimal"; } // Current version is always the latest type PluginSettings = PluginSettingsV2; const DEFAULTS: PluginSettings = { version: 2, apiKey: "", syncInterval: 300, excludedFolders: [], theme: "default", }; export async function loadSettings(plugin: Plugin): Promise<PluginSettings> { const raw = (await plugin.loadData()) as any; if (!raw) return { ...DEFAULTS }; // Migrate v1 -> v2 if (!raw.version || raw.version < 2) { raw....