obsidian

What it does

This skill provides detailed guidance and resources for developing plugins for Obsidian.md, a popular note-taking application. It covers the full spectrum of plugin development, including adhering to 27 ESLint rules from eslint-plugin-obsidianmd, implementing TypeScript best practices, managing memory effectively, and understanding nuances in API usage such as differentiating between requestUrl and other request methods. The skill aims to ensure robust and maintainable Obsidian plugins.

When to use it

• You're starting a new Obsidian plugin project and need guidance on structure and coding standards.
• You want to understand how to correctly implement specific Obsidian API functions, like requestUrl.
• Your existing Obsidian plugin is failing ESLint checks and you need help resolving the issues.
• You’re experiencing memory leaks or performance problems in your plugin and require advice on optimization techniques.

Key capabilities

• Adherence to 27 ESLint rules for Obsidian plugins (from eslint-plugin-obsidianmd v0.1.9).
• TypeScript best practices for plugin development.
• Memory management strategies within the Obsidian environment.
• Guidance on using Obsidian APIs, including distinctions between request methods.

Example prompts

• "Explain how to use requestUrl in an Obsidian plugin."
• "What are the most common ESLint errors when developing Obsidian plugins?"
• "How can I optimize memory usage in my Obsidian plugin?"

Tips & gotchas

This skill assumes a basic understanding of JavaScript and TypeScript. Successfully utilizing this skill requires familiarity with the Obsidian API documentation as it provides guidelines for development, not direct code execution.