Agent skill · software engineering · jeremylongshore

obsidian-upgrade-migration

Migrate Obsidian plugins between API versions and handle breaking changes.

Why this skill is useful

Provides specific migration patterns and scripts for handling Obsidian plugin upgrades that the AI wouldn't reliably generate on its own.

What it needs

Requires node installed locally. About 5k tokens when loaded. Last updated 2026-08-07. 2,604 stars on the source repository.

What this skill does

Obsidian Upgrade Migration Current State !npm list 2>/dev/null head -20 !cat manifest.json 2>/dev/null echo 'No manifest.json in cwd' Overview Upgrade an Obsidian plugin between versions: migrate persisted settings with version checks, replace deprecated API calls, update manifest.json minAppVersion, and test across Obsidian releases. Prerequisites Existing Obsidian plugin with source code Current manifest.json and versions.json Access to Obsidian changelog and breaking changes docs Node.js 18+ with npm or pnpm Instructions Step 1: Audit Current Version Compatibility Check what your plugin currently targets and what the user's Obsidian version requires: Step 2: Update the Obsidian Type Definitions Then check for TypeScript errors against the new types: Every error here is a breaking change you need to address. Step 3: Settings Migration with Version Tracking Implement a version-aware loadData() pattern so existing users' settings survive upgrades: Step 4: Replace Deprecated API Calls Common deprecations and their replacements: Vault API changes: Event registration changes: Editor API (CodeMirror 5 to 6 migration): FileManager changes: Step 5: Update manifest.json Bump minAppVersion to the lowest Obsidian version that supports all APIs you use: Update versions.json to map your plugin version to the minimum Obsidian version: Step 6: Test Across Obsidian Versions Build and verify: Manual testing checklist: 1. Install plugin on the minAppVersion you declared -- confirm it loads without errors 2. Install on latest Obsidian -- confirm full functionality 3. Test settings migration: copy a data.json from an older version into the plugin directory, reload, verify settings are preserved and upgraded 4. …

How to use it

Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:

@skills jeremylongshore/obsidian-upgrade-migration--0b1c70

View the source on GitHub

Browse the @skills marketplace