obsidian-plugin-test

Community

Mock-heavy Obsidian plugin testing made simple

Authormagarcia
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Testing Obsidian plugin logic outside the Obsidian runtime is impossible without runtime mocks, so this skill documents how to structure vitest suites and simulate Vault and provider APIs to validate syncing logic reliably.

Core Features & Use Cases

  • Testing Strategy Overview: Emphasizes pure logic tests, mock-based vault operations, mocked HTTP requests, and reserves UI concerns for manual verification.
  • Mock Implementations: Supplies TFile, MockVault, requestUrl, and UI stubs plus helper utilities for seeding files and emitting vault events to keep suites deterministic.
  • Use Case: Developers seed the MockVault, run scan/reconciler/provider logic, and assert outcomes without opening Obsidian while sharing mock definitions across suites.

Quick Start

Ask the obsidian-plugin-test skill to walk through setting up Vitest and mocking the Obsidian Vault for your plugin function.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: obsidian-plugin-test
Download link: https://github.com/magarcia/pylon-sync/archive/main.zip#obsidian-plugin-test

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.