skills.rest
shawnduggan
shawndugganCOMMUNITY
Explore all skills by this author →
GitHub

obsidian-plugin-development

Apply ESLint rules and Obsidian API patterns to plugin code, tests, and documentation.

31|2|Updated Jun 7, 2025
Search Tags:#development#linting#eslint#plugin#obsidian#best-practices#submission
One-click install
npx skills add https://github.com/shawnduggan/nova --skill obsidian-plugin-development-shawnduggan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: obsidian-plugin-development
Source: https://github.com/shawnduggan/nova/tree/main/.claude/skills/obsidian
Command: npx skills add https://github.com/shawnduggan/nova --skill obsidian-plugin-development-shawnduggan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Obsidian plugin development guidelines provide a comprehensive blueprint for crafting high-quality extensions that pass official reviews, follow enforceable ESLint rules, and align with Obsidian API patterns. It helps teams and solo developers avoid common pitfalls and ensures consistency across plugins.

Core Features & Use Cases

  • ESLint-driven coding standards, naming conventions, and code organization to enforce consistency across plugins.
  • Clear submission readiness guidelines covering packaging, metadata, review criteria, and API usage patterns.
  • Lifecycle and API best practices to ensure stable, safe interactions with Obsidian and predictable behavior in users' vaults.
  • Use Case: A developer starts a new Obsidian plugin project and uses these rules to speed up the review process and reduce back-and-forth.

Quick Start

Initialize a new plugin project following these guidelines to align with Obsidian's recommended practices.

Frequently Asked Questions about obsidian-plugin-development

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are the Obsidian plugin submission requirements for passing official review?▼

Obsidian plugin submission requires correct plugin IDs, naming conventions, proper metadata packaging, and adherence to API patterns to pass official reviews. Following these guidelines reduces back-and-forth and ensures your extension is compliant and maintainable.

How do I set up ESLint rules for an Obsidian plugin project?▼

To set up ESLint rules for an Obsidian plugin, apply the enforced coding standards and naming conventions provided by the development guidelines. This ensures code organization consistency and helps catch API pattern violations before submission.

What Obsidian API patterns should I follow for safe lifecycle management?▼

Obsidian API patterns for lifecycle management ensure stable, safe interactions within users' vaults. Following these best practices guarantees predictable plugin behavior and prevents common issues related to extension lifecycle handling.

Do I need to follow specific naming conventions when building an Obsidian plugin?▼

Yes, building an Obsidian plugin requires following specific naming conventions to ensure consistency. Enforceable ESLint rules help maintain these standards across your code and documentation to meet official review criteria.

Why does my Obsidian plugin fail the official review process?▼

Your Obsidian plugin may fail the review process due to incorrect plugin IDs, missing metadata, poor lifecycle management, or violating API patterns. Applying submission readiness guidelines and ESLint standards helps identify and fix these issues beforehand.

Related Skills

Explore More Software Engineering Skills→
akillnessakillness
40

obsidian

Generate Obsidian plugin boilerplate and validate code with ESLint.

Community
Advanced
MartinoPoloMartinoPolo
1

mp-publish-obsidian-plugin

Publish an Obsidian plugin to the community directory with validated manifest and release assets.

Community
Advanced
rsnormanrsnorman

quality-check

Run ESLint, Prettier, and TypeScript type checks on code.

Community
Intermediate
ysyecustysyecust
40

java-coding-standards

Enforce Java 17+ Spring Boot coding standards for naming, immutability, Optional usage, exceptions, generics, and layouts.

Community
Basic