obsidian-plugin-skill
Agent SKILL for Obsidian.md plugin development
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Check it deeper on your machine
It has changed since its scan on 11 Nov 2026.
As a Claude Code plugin, install it and then ask Claude Code:
/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/gapmiss/obsidian-plugin-skill with scanskillsafety
Or from a terminal, clone it and run it:
git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/gapmiss/obsidian-plugin-skill'
It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.
Badge for your README
Markdown
[](/listings/gapmiss--obsidian-plugin-skill)HTML
<a href="/listings/gapmiss--obsidian-plugin-skill"><img src="/api/listings/gapmiss--obsidian-plugin-skill/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
Quick Install
npx skills add https://github.com/gapmiss/obsidian-plugin-skill --skill obsidian
Setup
Option 1: Installer Script (Recommended)
1. Clone this repository:
git clone https://github.com/gapmiss/obsidian-plugin-skill.git cd obsidian-plugin-skill
2. Run the installer:
./install-skill.sh
3. Select your provider(s): - **All providers** — installs to both `.agents/skills/` and `.claude/skills/` - **Claude Code** — installs to `.claude/skills/` with slash commands - **Codex (OpenAI)** — installs to `.agents/skills/` - **Windsurf** — installs to `.agents/skills/`
4. Choose installation target (current directory or custom path)
Option 2: Manual Install
<details> <summary>Claude Code</summary>
git clone https://github.com/gapmiss/obsidian-plugin-skill.git cd obsidian-plugin-skill # Copy skill mkdir -p your-project/.claude/skills/obsidian cp -r .agents/skills/obsidian/* your-project/.claude/skills/obsidian/ # Copy slash commands mkdir -p your-project/.claude/commands cp .claude/commands/obsidian.md your-project/.claude/commands/ cp .claude/commands/create-plugin.md your-project/.claude/commands/
</details>
<details> <summary>Codex (OpenAI) / Windsurf</summary>
git clone https://github.com/gapmiss/obsidian-plugin-skill.git cd obsidian-plugin-skill # Copy skill mkdir -p your-project/.agents/skills/obsidian cp -r .agents/skills/obsidian/* your-project/.agents/skills/obsidian/
</details>
Option 3: Use as Standalone
Just open this directory with your coding agent — no installation needed!
Skill Structure
The skill uses **progressive disclosure** for optimal performance:
.agents/skills/obsidian/
├── SKILL.md # Main overview (~325 lines)
└── reference/ # Detailed documentation
├── memory-management.md # Lifecycle & cleanup patterns
├── type-safety.md # Type narrowing & safety
├── ui-ux.md # UI standards & commands
├── file-operations.md # Vault & file API
├── css-styling.md # Theming & styling
├── accessibility.md # A11y requirements (MANDATORY)
├── code-quality.md # Best practices & security
├── submission.md # Publishing guidelines
├── community-scanner.md # Scanner behavior & Scorecard (version-stamped)
└── eslint-setup.md # Complete ESLint config guideSKILL.md provides a concise overview with ESLint rules and Scorecard guidance, while reference files contain comprehensive details on specific topics.
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 600 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.
- # Obsidian Plugin Development - Agent Skill
- A comprehensive agent skill for developing high-quality Obsidian plugins that follow best practices, pass code review, and adhere to official submission guidelines.
- ## Overview
- This skill provides your coding agent with deep knowledge of Obsidian plugin development standards, including:
- - ESLint rules from `eslint-plugin-obsidianmd` v0.6.0
- - Declarative settings (`getSettingDefinitions()`), the Obsidian 1.13 settings API
- - Official Plugin Guidelines from Obsidian documentation
- - Submission via community.obsidian.md and Scorecard optimization
- - Memory management and lifecycle best practices
- - Security guidelines and XSS prevention
- - Platform compatibility (including iOS considerations)
- - Network request best practices (requestUrl vs fetch)
- ## Prerequisites
- - A coding agent supporting the [Agent Skills standard](https://agentskills.io) (Claude Code, OpenAI Codex, or Windsurf)
- - An Obsidian plugin project (or starting a new one)
- ## Installation
- ### Quick Install
- ```bash
- npx skills add https://github.com/gapmiss/obsidian-plugin-skill --skill obsidian
- ```
- ### Setup
- #### Option 1: Installer Script (Recommended)
- 1. Clone this repository:
- ```bash
- git clone https://github.com/gapmiss/obsidian-plugin-skill.git
- cd obsidian-plugin-skill
- ```
- 2. Run the installer:
- ```bash
- ./install-skill.sh
- ```
- 3. Select your provider(s):
- - **All providers** — installs to both `.agents/skills/` and `.claude/skills/`
- - **Claude Code** — installs to `.claude/skills/` with slash commands
- - **Codex (OpenAI)** — installs to `.agents/skills/`
- - **Windsurf** — installs to `.agents/skills/`
- 4. Choose installation target (current directory or custom path)
- #### Option 2: Manual Install
- <details>
- <summary>Claude Code</summary>
- ```bash
- git clone https://github.com/gapmiss/obsidian-plugin-skill.git
- cd obsidian-plugin-skill
- # Copy skill
- mkdir -p your-project/.claude/skills/obsidian
- cp -r .agents/skills/obsidian/* your-project/.claude/skills/obsidian/
- # Copy slash commands
- mkdir -p your-project/.claude/commands
- cp .claude/commands/obsidian.md your-project/.claude/commands/
- cp .claude/commands/create-plugin.md your-project/.claude/commands/
- ```
- </details>
- <details>
- <summary>Codex (OpenAI) / Windsurf</summary>
- ```bash
- git clone https://github.com/gapmiss/obsidian-plugin-skill.git
- cd obsidian-plugin-skill
- # Copy skill
- mkdir -p your-project/.agents/skills/obsidian
- cp -r .agents/skills/obsidian/* your-project/.agents/skills/obsidian/
- ```
- </details>
- #### Option 3: Use as Standalone
- Just open this directory with your coding agent — no installation needed!
- ### Skill Structure
- The skill uses **progressive disclosure** for optimal performance:
- ```
- .agents/skills/obsidian/
- ├── SKILL.md # Main overview (~325 lines)
- └── reference/ # Detailed documentation
- ├── memory-management.md # Lifecycle & cleanup patterns
- ├── type-safety.md # Type narrowing & safety
- ├── ui-ux.md # UI standards & commands
- ├── file-operations.md # Vault & file API
- ├── css-styling.md # Theming & styling
- ├── accessibility.md # A11y requirements (MANDATORY)
- ├── code-quality.md # Best practices & security
- ├── submission.md # Publishing guidelines
- ├── community-scanner.md # Scanner behavior & Scorecard (version-stamped)
- └── eslint-setup.md # Complete ESLint config guide
- ```
- SKILL.md provides a concise overview with ESLint rules and Scorecard guidance, while reference files contain comprehensive details on specific topics.
- ## Quick Start: Creating a New Plugin
- ### Interactive Boilerplate Generator
- The fastest way to start a new Obsidian plugin with all best practices built-in:
- ```bash
- node /path/to/obsidian-plugin-skill/tools/create-plugin.js
- ```
- **Features:**
- - Generates clean TypeScript boilerplate with **no sample code**
- - Creates `src/` directory structure with `main.ts` and `settings.ts`
- - Settings tab uses the **declarative API** (`getSettingDefinitions()`), so it's lint-clean and searchable on Obsidian 1.13+. To target older Obsidian, lower `minAppVersion` and add a `display()` fallback — see [Path B](.agents/skills/obsidian/reference/ui-ux.md#path-b-dual-support)
- - **Validates plugin metadata in real-time** against Obsidian's submission bot rules
- - Prompts for target directory to avoid overwriting existing files
- - Detects existing projects and only adds missing files
- - All generated code follows the skill's best practices automatically
- - `package.json` overrides `minimatch` to `^11.0.5`, so `npm audit` reports 0 vulnerabilities — see [below](#minimatch-override)
- **What it creates:**
- ```
- your-plugin/
- ├── src/
- │ ├── main.ts # Plugin class with settings integration
- │ └── settings.ts # Settings interface, defaults, and declarative tab
- ├── manifest.json # Validated plugin metadata
- ├── styles.css # CSS with Obsidian variables
- ├── tsconfig.json # TypeScript configuration
- ├── package.json # Dependencies, plus a temporary minimatch override
- ├── esbuild.config.mjs # Build configuration
- ├── eslint.config.mjs # ESLint configuration
- ├── version-bump.mjs # Version management script
- ├── versions.json # Version tracking
- ├── .gitignore # Git ignore rules
- └── LICENSE # MIT license
- ```
- **Interactive prompts:**
- 1. Target directory (default: current directory)
- 2. Plugin name (validates: no "Obsidian" or parts of it, no "Plugin")
- 3. Plugin ID (validates: no "obsidian", can't end with "plugin", lowercase only)
- 4. Description (validates: no "Obsidian", no self-reference, 10–250 chars, ends with `.`, `!`, or `?`, doesn't start with the name)
- 5. Author name
- 6. GitHub username (optional, auto-generates authorUrl)
- 7. Minimum Obsidian version (default `1.13.0`)
- **Real-time validation catches common mistakes:**
- ```
- ❌ Validation Errors:
- • Plugin ID cannot contain "obsidian"
- • Plugin name cannot contain "Plugin"
- • Description must end with punctuation: . ! or ?
- ```
- #### minimatch override
- `minimatch` before 11.0.1 has a denial-of-service advisory ([GHSA-g3hv-75wg-m249](https://github.com/advisories/GHSA-g3hv-75wg-m249)). The lint toolchain still depends on vulnerable versions — `typescript-eslint` on `minimatch ^10`, and `eslint-plugin-obsidianmd` via `@microsoft/eslint-plugin-sdl` → `eslint-plugin-n` on `^9` — so a plain install reports about 10 moderate vulnerabilities. The generated `package.json` forces the patched version:
- ```json
- "overrides": {
- "minimatch@>=7 <11.0.1": "^11.0.5"
- }
- ```
- It is dev-only (nothing reaches `main.js`), but the community scanner's Review lists "No known vulnerable dependencies". Linting and type-aware rules are verified to work with it. A `"//"` key in the generated `package.json` (npm ignores it) explains the override in the project itself. Remove both once upstream moves to `minimatch` 11 — see the [troubleshooting entry](.agents/skills/obsidian/reference/eslint-setup.md#npm-audit-moderate-vulnerabilities-in-minimatch-ghsa-g3hv-75wg-m249) for how to check. Don't run `npm audit fix --force`: it downgrades `eslint-plugin-obsidianmd` to 0.0.2.
- The remaining install warning, `npm warn deprecated eslint@9.39.5`, is expected: ESLint 10 currently adds peer-dependency warnings from bundled plugins instead.
- ---
- ## Usage
- ### Invoking the Skill
- | Provider | Load skill | Create plugin |
- |----------|-----------|---------------|
- | Claude Code | `/obsidian` | `/create-plugin` |
- | Codex (OpenAI) | `$obsidian` | — |
- | Windsurf | `@obsidian` | — |
- Skills are automatically discovered by your agent when present in the project directory. You can also invoke them explicitly using the commands above.
- Just ask your agent naturally:
- ```
- Help me implement a new command for my Obsidian plugin
- ```
- Your agent will automatically use the Obsidian skill guidelines while helping you write code.
- ### What the Skill Helps With
- #### Code Quality
- - Prevents common memory leaks
- - Enforces type safety (no unsafe casts)
- - Ensures proper resource cleanup
- - Follows Obsidian's API patterns
- #### UI/UX Standards
- - Enforces sentence case for all UI text
- - Prevents redundant naming patterns
- - Ensures consistent settings UI
- #### Accessibility (A11y)
- - **MANDATORY keyboard navigation** for all interactive elements
- - **MANDATORY ARIA labels** for icon buttons and controls
- - **MANDATORY focus indicators** with proper CSS styling
- - Touch target size requirements (44×44px minimum)
- - Screen reader support and announcements
- - Tooltip positioning with `data-tooltip-position`
- #### Security
- - Prevents XSS vulnerabilities (no innerHTML/outerHTML)
- - Validates manifest structure
- - Ensures proper path handling
- #### Platform Compatibility
- - iOS compatibility checks (no regex lookbehind)
- - Cross-platform path handling
- - Mobile-friendly API usage
- #### Submission Ready
- - Removes template/sample code
- - Validates manifest.json
- - Ensures LICENSE compliance
- - Follows submission requirements
- ## What's Covered
- ### Most Critical Rules (eslint-plugin-obsidianmd v0.6.0)
- The main SKILL.md file highlights the most important rules organized by category:
- **Submission & Naming:**
- 1. Plugin ID: no "obsidian", can't end with "plugin" (checked with `validate-manifest`'s `checkId: true` — turn it on before first submission)
- 2. Plugin name: no "Obsidian", no "Plugin"
- 3. Plugin name: no parts of "Obsidian" ("obsi", "sidian", or a leading "ob")
- 4. Description: no "Obsidian", "This plugin", "A plugin that", etc.; doesn't start with the name
- 5. Description: 10–250 characters, ends with `.`, `!`, or `?`
- **Memory & Lifecycle:**
- 6. Use `registerEvent()` for automatic cleanup
- 7. Don't store view references in plugin
- 8. Don't call `detachLeavesOfType()` in `onunload`
- **Type Safety:**
- 9. Use `instanceof` instead of type casting for TFile/TFolder
- 10. Use `.instanceOf(T)` for cross-window DOM checks, and `e.targetNode?.instanceOf(T)` for event targets
- **UI/UX:**
- 11. Use sentence case for all UI text (`ui/sentence-case` is off by default since v0.5.0 — opt in; `acronyms` adds to the built-in list since v0.6.0)
- 12. Sentence case in locale JSON files
- 13. Sentence case in TS/JS locale modules
- 14. No "command" as a redundant label in command names/IDs
- 15. No plugin ID/name in command IDs/names
- 16. No default hotkeys; a `checkCallback` must read `checking` (`commands/check-callback-uses-checking`, v0.6.0)
- 17. Use `.setHeading()` for settings headings; never `await` a `Setting` or UI component — it never settles (`no-await-chainable`, v0.6.0)
- **Declarative Settings (Obsidian 1.13+):**
- - Keep `display()` while `minAppVersion < 1.13.0` (`settings-tab/require-display`)
- - Implement `getSettingDefinitions()` so settings appear in global search (`settings-tab/prefer-setting-definitions`)
- - Refresh with `this.update()`, not `this.display()` (`settings-tab/prefer-update-over-display`)
- - Drop `display()` once `minAppVersion >= 1.13.0` and definitions exist (`settings-tab/no-deprecated-display`)
- **API Best Practices:**
- 18. Use Editor API for active file edits
- 19. Use `Vault.process()` for background file mods
- 20. Use `FileManager.trashFile()` for file deletion
- 21. Use `Vault.getAbstractFileByPath()` instead of iterating files
- 22. Use `normalizePath()` for user paths
- 23. Use `Platform` API for OS detection
- 24. Use `requestUrl()` instead of `fetch()`; parse `response.text` and cast once at the API boundary (`response.json` is `any`)
- 25. No console.log in onload/onunload in production
- 26. Use built-in `AbstractInputSuggest`; use built-in `ConfirmationModal` (1.13.0+) and `FileManager.promptForDeletion()` instead of custom confirm modals
- 27. Check `minAppVersion` for API compatibility
- **Popout Window Compatibility:**
- 28. Use `activeDocument`/`activeWindow` instead of globals (`prefer-active-doc`, `warn` since v0.5.0); apply window-wide `<body>` classes and styles in every window's document
- 29. Use `window.setTimeout()` for timers — not bare `setTimeout()` or `activeWindow.setTimeout()` (`prefer-window-timers`)
- **Event Handling:**
- 30. Check `evt.defaultPrevented` and call `evt.preventDefault()` in editor-drop/paste handlers that write to the editor
- **Styling:**
- 31. Use Obsidian CSS variables
- 32. Scope CSS to plugin containers
- 33. Don't create `<link>` or `<style>` elements
- **Accessibility (MANDATORY):**
- 34. Make all interactive elements keyboard accessible
- 35. Provide ARIA labels for icon buttons
- 36. Define clear focus indicators
- **Security & Compatibility:**
- - Don't use `innerHTML`/`outerHTML`
- - Avoid regex lookbehind
- **Code Quality:**
- - Remove all sample/template code
- - Don't mutate defaults with `Object.assign`
- - Validate LICENSE copyright holder and year
- ### Detailed Coverage by Topic
- **[Memory Management & Lifecycle](.agents/skills/obsidian/reference/memory-management.md)**
- - Using `registerEvent()`, `addCommand()`, `registerDomEvent()`, `registerInterval()`
- - Avoiding view references in plugin
- - Not using plugin as component
- - Proper leaf cleanup
- **[Type Safety](.agents/skills/obsidian/reference/type-safety.md)**
- - Using `instanceof` instead of type casting
- - Avoiding `any` type
- - Using `const` and `let` over `var`
- **[UI/UX Standards](.agents/skills/obsidian/reference/ui-ux.md)**
- - Sentence case enforcement
- - Command naming conventions
- - Settings and configuration best practices
- - Confirmation dialogs (`ConfirmationModal`, `promptForDeletion()`)
- **[File & Vault Operations](.agents/skills/obsidian/reference/file-operations.md)**
- - View access patterns
- - Editor vs Vault API
- - Atomic file operations (Vault.process, processFrontMatter)
- - File management and path handling
- **[CSS Styling Best Practices](.agents/skills/obsidian/reference/css-styling.md)**
- - Avoiding inline styles
- - Using Obsidian CSS variables
- - Scoping plugin styles
- - Theme support (light/dark)
- - Spacing and layout (4px grid)
- **[Accessibility (A11y)](.agents/skills/obsidian/reference/accessibility.md)** - MANDATORY
- - Keyboard navigation for all interactive elements
- - ARIA labels and roles
- - Tooltips with proper positioning
- - Focus management
- - Focus visible styles (`:focus-visible`)
- - Screen reader support
- - Mobile and touch accessibility (44×44px minimum)
- **[Code Quality & Best Practices](.agents/skills/obsidian/reference/code-quality.md)**
- - Removing sample code
- - Security best practices (XSS prevention)
- - Platform compatibility (iOS, mobile)
- - API usage patterns
- - Async/await patterns
- - DOM helpers
- **[Plugin Submission Requirements](.agents/skills/obsidian/reference/submission.md)**
- - **Naming and description validation rules** (enforced by automated review)
- - Plugin ID, name, and description requirements
- - Repository structure and manifest synchronization
- - Submission via **community.obsidian.md** portal
- - Semantic versioning
- - Testing checklist
- **[Community Plugin Scanner](.agents/skills/obsidian/reference/community-scanner.md)**
- - What the scanner runs (ESLint rule sets + checks beyond ESLint)
- - **Scorecard system** (Health, Review, Disclosures)
- - Version-stamped — single place to update as the scanner evolves
- ## Examples
- ### Before (Incorrect)
- ```typescript
- // Multiple issues
- class MyPlugin extends Plugin {
- view: CustomView;
- async onload() {
- this.registerView(VIEW_TYPE, (leaf) => {
- this.view = new CustomView(leaf); // Memory leak!
- return this.view;
- });
- this.addCommand({
- id: 'my-plugin-show-command', // Redundant naming
- name: 'Show Command', // Title Case
- hotkeys: [{ modifiers: ['Mod'], key: 's' }], // Default hotkey
- });
- const file = abstractFile as TFile; // Unsafe cast
- }
- onunload() {
- this.app.workspace.detachLeavesOfType(VIEW_TYPE); // Don't do this
- }
- }
- ```
- ### After (Correct)
- ```typescript
- // Following all guidelines
- class TodoPlugin extends Plugin {
- async onload() {
- this.registerView(VIEW_TYPE, (leaf) => {
- return new CustomView(leaf); // Create and return directly
- });
- this.addCommand({
- id: 'show', // Clean naming
- name: 'Show todo', // Sentence case
- // Let users set their own hotkeys
- checkCallback: (checking: boolean) => {
- const view = this.app.workspace.getActiveViewOfType(MarkdownView);
- if (view) {
- if (!checking) {
- // Perform action
- }
- return true;
- }
- return false;
- }
- });
- if (abstractFile instanceof TFile) {
- // Safe type narrowing
- const file = abstractFile;
- }
- }
- onunload() {
- // Let Obsidian handle cleanup
- }
- }
- ```
- ## Checklist for Plugin Review
- Use this checklist before submitting your plugin:
- **Submission Validation (will fail bot checks if incorrect):**
- - [ ] Plugin ID: no "obsidian", doesn't end with "plugin", lowercase only
- - [ ] Plugin name: no "Obsidian", no "Plugin"
- - [ ] Plugin name: no parts of "Obsidian" ("obsi", "sidian", or a leading "ob")
- - [ ] Description: no "Obsidian" or self-reference ("This plugin", "A plugin that")
- - [ ] Description ends with `.`, `!`, or `?`
- - [ ] Description is 10–250 characters and doesn't start with the plugin name
- - [ ] `npx eslint .` from the project root is clean (checks `manifest.json` and `LICENSE` too)
- - [ ] manifest.json ID, name, description match submission entry
- **Code Quality:**
- - [ ] No memory leaks (views/components properly managed)
- - [ ] Type safety (using `instanceof` instead of casts)
- - [ ] All UI text in sentence case
- - [ ] No redundant words in command names
- - [ ] Using preferred APIs (Editor API, Vault.process, etc.)
- - [ ] No iOS-incompatible features (regex lookbehind)
- - [ ] All sample code removed (MyPlugin, SampleModal, etc.)
- - [ ] No security issues (innerHTML, XSS vulnerabilities)
- **Accessibility (MANDATORY):**
- - [ ] **All interactive elements keyboard accessible (Tab, Enter, Space)**
- - [ ] **ARIA labels on all icon buttons (`aria-label`)**
- - [ ] **Clear focus indicators (`:focus-visible` with proper CSS)**
- - [ ] **Touch targets at least 44×44px (mobile)**
- - [ ] **Tooltips positioned with `data-tooltip-position`**
- **Release Requirements:**
- - [ ] manifest.json valid and version correct
- - [ ] LICENSE file included
- - [ ] Mobile tested (if not desktop-only)
- - [ ] Repository has issues enabled
- ## ESLint Integration
- For automatic checking, install the official ESLint plugin:
- ```bash
- npm install --save-dev eslint typescript typescript-eslint obsidian eslint-plugin-obsidianmd
- ```
- v0.5.0 and later require Node.js 20.19+, 22.13+, or 24+, and don't install `obsidian` for you. Upgrading from v0.5.1? See [Upgrading from v0.5.1](.agents/skills/obsidian/reference/eslint-setup.md#upgrading-from-v051). From v0.5.0? See [Upgrading from v0.5.0](.agents/skills/obsidian/reference/eslint-setup.md#upgrading-from-v050). From v0.4.x? See [Upgrading from v0.4.x](.agents/skills/obsidian/reference/eslint-setup.md#upgrading-from-v04x).
- The `recommended` config bundles `typescript-eslint` (type-checked), security plugins, and all Obsidian rules — no separate typescript-eslint setup needed.
- See the **[complete ESLint setup guide](.agents/skills/obsidian/reference/eslint-setup.md)** for:
- - Full `eslint.config.mjs` that matches the community scanner
- - How `recommended` bundles the type-checked rules
- - Common violations and how to fix them
- Quick config example (`recommended` bundles `typescript-eslint` recommendedTypeChecked plus security and import rules):
- ```javascript
- // eslint.config.mjs
- import { defineConfig, globalIgnores } from "eslint/config";
- import obsidianmd from "eslint-plugin-obsidianmd";
- export default defineConfig([
- globalIgnores(["node_modules", "dist", "main.js", "esbuild.config.mjs", "version-bump.mjs"]),
- ...obsidianmd.configs.recommended,
- {
- languageOptions: {
- parserOptions: {
- projectService: {
- allowDefaultProject: ["eslint.config.*"],
- },
- },
- },
- },
- ]);
- ```
- Run it from the project root (`eslint .`, not `eslint src`) so `manifest.json`, `LICENSE`, and `package.json` are checked too.
- Many rules are auto-fixable with:
- ```bash
- npx eslint --fix .
- ```
- Since v0.5.0, rewrites that could break type-checking are offered as editor suggestions instead of `--fix` autofixes. v0.6.0 moves more rewrites to suggestions (timers set and cleared on `activeWindow`, `instanceof` on a value that may be `null`), so run `npx eslint .` again after `--fix` and resolve what's left.
- ## Resources
- - Obsidian API Docs: https://docs.obsidian.md
- - **Community Portal**: https://community.obsidian.md
- - ESLint Plugin: https://github.com/obsidianmd/eslint-plugin
- - Sample Plugin: https://github.com/obsidianmd/obsidian-sample-plugin
- - Plugin Guidelines: https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines
- - Submission Guide: https://docs.obsidian.md/Plugins/Releasing/Submit+your+plugin
- - Agent Skills Standard: https://agentskills.io
- ## Contributing
- Found a missing guideline or rule? Please contribute!
- 1. Fork this repository
- 2. Add the guideline to the appropriate file:
- - Main overview: `.agents/skills/obsidian/SKILL.md`
- - Detailed coverage: `.agents/skills/obsidian/reference/*.md`
- 3. Update this README if needed
- 4. Submit a pull request
- ### Adding New Guidelines
- When adding new content:
- - Keep SKILL.md under 500 lines (progressive disclosure principle)
- - Add detailed content to appropriate reference files
- - Use consistent formatting and examples
- - Include both incorrect and correct examples
- ## Migration from `.claude/skills/`
- If you previously installed this skill to `.claude/skills/obsidian/`, you can migrate:
- ```bash
- # Move skill files to the new location
- mv .claude/skills/obsidian .agents/skills/obsidian
- # Keep .claude/commands/ as-is (Claude Code only)
- ```
- The `.claude/skills/` path still works for Claude Code, but `.agents/skills/` is the standard location recognized by all providers.
- ## License
- MIT License - See LICENSE file for details
- ## Acknowledgments
- This skill is based on:
- - The official Obsidian Plugin Guidelines
- - The `eslint-plugin-obsidianmd` package
- - Community best practices from plugin developers
- - Agent Skills standard best practices (progressive disclosure pattern)
- ---
- ## Design Philosophy
- This skill follows **Agent Skills standard best practices**:
- - **Progressive Disclosure**: Main SKILL.md (~370 lines) provides overview; reference files contain details
- - **Context Window Efficiency**: "The context window is a public good" - optimized token usage
- - **One-Level-Deep References**: All reference files directly under `reference/` (no nesting)
- - **Topic-Based Organization**: Each reference file focuses on a specific domain
- - **Consistent Terminology**: Same terms used throughout for clarity
- This structure allows your coding agent to load the essential information quickly while having access to comprehensive details when needed.
- ---
- Note: Guidelines in this skill are based on `eslint-plugin-obsidianmd` v0.6.0 and the community.obsidian.md Scorecard system. The plugin and scanner are under active development and may evolve.
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.