Obsidian Plugin Development Guidelines
gapmiss/obsidian-plugin-skill
Rules and references for building Obsidian plugins: ESLint rules, TypeScript practices, memory cleanup, API choices, UI standards and the community submission process.
Audit ZettelFlow against the official Obsidian plugin guidelines and the Community-hub automated review / quality score.
$ npx skills add RafaelGB/Obsidian-ZettelFlow --skill obsidian-plugin-quality -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install RafaelGB/Obsidian-ZettelFlow obsidian-plugin-quality --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/RafaelGB/Obsidian-ZettelFlow.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/obsidian-plugin-quality .claude/skills/obsidian-plugin-quality && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "obsidian-plugin-quality" agent skill from https://github.com/RafaelGB/Obsidian-ZettelFlow/tree/main/.claude/skills/obsidian-plugin-quality into .claude/skills/obsidian-plugin-quality/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "obsidian-plugin-quality", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/RafaelGB/Obsidian-ZettelFlow/tree/main/.claude/skills/obsidian-plugin-qualityType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add RafaelGB/Obsidian-ZettelFlow --skill obsidian-plugin-quality -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install RafaelGB/Obsidian-ZettelFlow obsidian-plugin-quality --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/RafaelGB/Obsidian-ZettelFlow.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.claude/skills/obsidian-plugin-quality .agents/skills/obsidian-plugin-quality && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "obsidian-plugin-quality" agent skill from https://github.com/RafaelGB/Obsidian-ZettelFlow/tree/main/.claude/skills/obsidian-plugin-quality into .agents/skills/obsidian-plugin-quality/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "obsidian-plugin-quality", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add RafaelGB/Obsidian-ZettelFlow --skill obsidian-plugin-quality -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install RafaelGB/Obsidian-ZettelFlow obsidian-plugin-quality --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/RafaelGB/Obsidian-ZettelFlow.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.claude/skills/obsidian-plugin-quality .cursor/skills/obsidian-plugin-quality && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "obsidian-plugin-quality" agent skill from https://github.com/RafaelGB/Obsidian-ZettelFlow/tree/main/.claude/skills/obsidian-plugin-quality into .cursor/skills/obsidian-plugin-quality/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "obsidian-plugin-quality", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/RafaelGB/Obsidian-ZettelFlow.git --path .claude/skills/obsidian-plugin-quality--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add RafaelGB/Obsidian-ZettelFlow --skill obsidian-plugin-quality -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install RafaelGB/Obsidian-ZettelFlow obsidian-plugin-quality --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/RafaelGB/Obsidian-ZettelFlow.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.claude/skills/obsidian-plugin-quality .gemini/skills/obsidian-plugin-quality && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "obsidian-plugin-quality" agent skill from https://github.com/RafaelGB/Obsidian-ZettelFlow/tree/main/.claude/skills/obsidian-plugin-quality into .gemini/skills/obsidian-plugin-quality/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "obsidian-plugin-quality", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install RafaelGB/Obsidian-ZettelFlow obsidian-plugin-qualityInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add RafaelGB/Obsidian-ZettelFlow --skill obsidian-plugin-quality -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/RafaelGB/Obsidian-ZettelFlow.git skills-src && mkdir -p .github/skills && cp -r skills-src/.claude/skills/obsidian-plugin-quality .github/skills/obsidian-plugin-quality && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "obsidian-plugin-quality" agent skill from https://github.com/RafaelGB/Obsidian-ZettelFlow/tree/main/.claude/skills/obsidian-plugin-quality into .github/skills/obsidian-plugin-quality/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "obsidian-plugin-quality", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add RafaelGB/Obsidian-ZettelFlow --skill obsidian-plugin-quality -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install RafaelGB/Obsidian-ZettelFlow obsidian-plugin-quality --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/RafaelGB/Obsidian-ZettelFlow.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.claude/skills/obsidian-plugin-quality .opencode/skills/obsidian-plugin-quality && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "obsidian-plugin-quality" agent skill from https://github.com/RafaelGB/Obsidian-ZettelFlow/tree/main/.claude/skills/obsidian-plugin-quality into .opencode/skills/obsidian-plugin-quality/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "obsidian-plugin-quality", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
obsidian-plugin-qualityAudit ZettelFlow against the official Obsidian plugin guidelines and the Community-hub automated review / quality score.
Obsidian Plugin Quality is an agent skill from RafaelGB/Obsidian-ZettelFlow. Audit ZettelFlow against the official Obsidian plugin guidelines and the Community-hub automated review / quality score. Use before a release, when preparing a directory submission, or when the user asks to "check plugin quality", "raise the Obsidian score", "run the reviewer", or "prepare for submission". Runs the same rule set Obsidian's automated reviewer uses and reports concrete, file-anchored fixes.
Its SKILL.md is about 1.6k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Linting and formatting. It works with Obsidian and ESLint. The repository describes itself as: ZettelFlow is a plugin for Obsidian that helps you to create and manage your notes in a Zettelkasten way. The licence is MIT.
6 steps, taken from the step headings in SKILL.md.
Read from SKILL.md and the folder at commit 088de36. It shows what the files ask for, not the result of running them.
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Shell commands in SKILL.md call:
rgnpmnpxFrom the folder's file list and the shell code blocks in SKILL.md.
No URLs in SKILL.md. Its commands use npm and npx, which can reach the network depending on how they are called.
From URLs in SKILL.md, links to its own repository left out.
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Obsidian Plugin Quality loads about 1.6k tokens when it runs. Until then it costs about 108 tokens; SKILL.md has 695 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
The full file from RafaelGB/Obsidian-ZettelFlow at commit 088de36, republished under its MIT licence (© RafaelGB). 695 words, ~1,649 tokens.
.claude/skills/obsidian-plugin-quality/SKILL.md (or your agent's skills folder).Obsidian's Community hub (May 2026) runs an automated review on every plugin version
and publishes a 1–100 source-code quality score plus safety scorecards. The score is
essentially how clean the code is against eslint-plugin-obsidianmd + the developer
policies + the submission requirements. This skill reproduces that audit locally.
Background reference (keep it in sync): docs/development/obsidian-review-and-scoring.md.
Work through the phases in order. Report findings grouped by category, most-severe first,
each anchored to file:line with a concrete fix. Do not auto-apply large refactors
without confirming scope with the user first.
The project currently lints with oxlint and a legacy .eslintrc.js; neither encodes the
Obsidian rules. Add and run the official rule set:
npm i -D eslint eslint-plugin-obsidianmd @typescript-eslint/parser
# with an eslint.config.mjs using obsidianmd.configs.recommended (see the doc)
npx eslint "src/**/*.{ts,tsx}"If the flat config is not yet present, create eslint.config.mjs as shown in
docs/development/obsidian-review-and-scoring.md §5. Treat every eslint-plugin-obsidianmd
error as a score deduction.
Run these and triage each hit:
| Check | Command (ripgrep) | Rule / guideline |
|---|---|---|
| HTML injection | `rg -n "innerHTML | outerHTML |
| Inline styles | `rg -n ".style. | setAttribute(['"]style" src` |
| Detach leaves on unload | rg -n "detachLeavesOfType" src | detach-leaves → remove from onunload. |
| Hardcoded config dir | rg -n "\.obsidian/" src | hardcoded-config-path → use vault.configDir. |
| Node/Electron on mobile | `rg -n "require( | from ['"](fs |
Global app | `rg -n "window.app | \bapp." src` |
var / Promise chains | `rg -n "\bvar\s | .then(" src` |
| Regex lookbehind | rg -n "\(\?<" src | regex-lookbehind → unsupported on some iOS. |
Direct activeLeaf | rg -n "workspace\.activeLeaf" src | Use getActiveViewOfType(). |
| Adapter over Vault | rg -n "\.adapter\." src | Prefer the Vault API. |
manifest.json: valid id, name, semver version, minAppVersion, description
(≤250 chars, action verb, ends with ., not starting "This is a plugin"), author.fundingUrl present only because donations are accepted (ZettelFlow: yes).versions.json exists and maps each version → minAppVersion.
⚠️ Currently missing — see docs/development/obsidian-review-and-scoring.md §6.version-bump.mjs exists (referenced by the version npm script). ⚠️ Currently missing.main.js, manifest.json, styles.css under a git tag
equal to manifest.version (no v prefix). Cross-check .github/workflows/releases.yml.LICENSE present with a valid copyright notice (validate-license).setHeading() (not manual HTML), no "settings" in the heading text.src/architecture/lang/ — audit en/es locale strings too.)src/architecture/plugin/canvas/extensions/CanvasPatcher.ts)
patches internal Canvas APIs via monkey-around. This is a manual-review flag: keep the
patches defensive (they already register uninstallers via plugin.register), guard every
patched method behind existence checks, and document the risk. Verify against the current
minAppVersion..js extension registration (CodeView): already wrapped in try/catch — keep it.src/architecture/monitoring/Logger.ts): error is silenced when the
logger toggle is off. Consider always allowing error.onunload only clears the action store; confirm no leaked resources (most are covered
by Obsidian's register* auto-teardown).Beyond the linter, judge the change against the design gate:
architecture/knowledge, future knowledge/) imports no
obsidian and makes no network/AI call; derived metrics are queries over the model, not new
dashboard features. Existing .zftemplate systems and saved settings still work; no command/view
removed without an alias.Produce a prioritized report: (1) blocking submission issues (missing versions.json,
manifest errors), (2) eslint-plugin-obsidianmd errors, (3) security (HTML injection),
(4) styling/inline-style migrations, (5) polish (sentence case, commands). For each: the
rule, the file:line, and the exact fix. Offer to apply the low-risk mechanical fixes
(innerHTML = "" → .empty(), adding the eslint config) in a follow-up.
© RafaelGB, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Just SKILL.md in .claude/skills/obsidian-plugin-quality of RafaelGB/Obsidian-ZettelFlow.
Open the folder on GitHubat commit 088de36
Obsidian Plugin Quality next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Obsidian Plugin Quality this skillRafaelGB/Obsidian-ZettelFlow | 174 | — | ~1.6k | Automated safety check: Pass | MIT | |
| Obsidian Plugin Development Guidelinesgapmiss/obsidian-plugin-skill | 190 | — | ~4.5k | Automated safety check: Pass | MIT | |
| LobeHub Alint Rule Set Maintenancelobehub/lobehub | 83k | — | ~1.9k | Automated safety check: Pass | Custom licence | |
| Eslint Migrate Optionsbiomejs/biome | 26k | — | ~1.4k | Automated safety check: Pass | Apache-2.0 | |
| Ultraciteagustinusnathaniel/nextarter-tailwind | 125 | 2 repos | ~1.2k | Automated safety check: Pass | MIT | |
| Code Qualityredis/RedisInsight | 8.9k | — | ~1.2k | Automated safety check: Pass | Custom licence |
gapmiss/obsidian-plugin-skill
Rules and references for building Obsidian plugins: ESLint rules, TypeScript practices, memory cleanup, API choices, UI standards and the community submission process.
lobehub/lobehub
Maintains LobeHub's model-backed alint rule set: writing rules, removing false positives against real code, deciding warn versus error and tracking token cost.
biomejs/biome
A skill your agent uses when biome migrate eslint must preserve configurable ESLint rule options through source-option models, Biome conversions, typed rule variants, and migration fixtures.
agustinusnathaniel/nextarter-tailwind
Ultracite is a zero-config linting and formatting preset for JavaScript/TypeScript projects.
redis/RedisInsight
Code-quality standards for RedisInsight: TypeScript strictness, naming conventions (camelCase, PascalCase, UPPERSNAKECASE), linting rules, no any without reason, no !important in styles, and…
javierbrea/eslint-plugin-boundaries
Act as a software architect: analyze a repository's folder structure and cross-file import dependencies, detect its architectural pattern, design element/file boundaries with the user, and configure…
RafaelGB/Obsidian-ZettelFlow
Scaffold a new ZettelFlow action following the project's 4-file convention (Action / Component / Settings / SettingsReader), register it, and document it.
RafaelGB/Obsidian-ZettelFlow
Cut a compliant ZettelFlow plugin release — version bump, versions.json, build, tag, and a GitHub Release whose notes follow the house format.
RafaelGB/Obsidian-ZettelFlow
Stage 1 of the SDD pipeline — write a ZettelFlow spec into a GitHub issue body (problem, value, functional requirements, testable acceptance criteria, capability disclosure, out-of-scope).
RafaelGB/Obsidian-ZettelFlow
The Spec-Driven Development pipeline for ZettelFlow — the end-to-end flow (constitution → specify → plan → tasks → implement → verify) and which skill/agent owns each stage.
RafaelGB/Obsidian-ZettelFlow
The test-driven development workflow for ZettelFlow — write a failing test first, run jest, use the Obsidian mock and the bare-specifier alias mappings, and know which code is unit-testable.
RafaelGB/Obsidian-ZettelFlow
Stage 4 of the SDD pipeline — execute a ZettelFlow task checklist (in a GitHub issue comment) test-first (red → green → refactor), one commit per advance, keeping npm run verify green and CI green…
Categories
Audit ZettelFlow against the official Obsidian plugin guidelines and the Community-hub automated review / quality score. Obsidian Plugin Quality is an agent skill from RafaelGB/Obsidian-ZettelFlow. Audit ZettelFlow against the official Obsidian plugin guidelines and the Community-hub automated review / quality score.
Obsidian Plugin Quality fits situations like: asks to check plugin quality; raise the Obsidian score; run the reviewer; prepare for submission.
Run `npx skills add RafaelGB/Obsidian-ZettelFlow --skill obsidian-plugin-quality -a claude-code`. Or copy the skill folder (.claude/skills/obsidian-plugin-quality in RafaelGB/Obsidian-ZettelFlow) into .claude/skills/obsidian-plugin-quality in your project. Claude Code loads it when a task matches its description.
Run `npx skills add RafaelGB/Obsidian-ZettelFlow --skill obsidian-plugin-quality -a codex`. Or copy the skill folder (.claude/skills/obsidian-plugin-quality in RafaelGB/Obsidian-ZettelFlow) into .agents/skills/obsidian-plugin-quality in your project. Codex loads it when a task matches its description.
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add RafaelGB/Obsidian-ZettelFlow --skill obsidian-plugin-quality -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/obsidian-plugin-quality, .gemini/skills/obsidian-plugin-quality, .github/skills/obsidian-plugin-quality and .opencode/skills/obsidian-plugin-quality in your project.
Going by SKILL.md and its folder, Obsidian Plugin Quality needs the command-line tools its instructions call (rg, npm and npx). Our summary lists: Node.js.
SKILL.md contains no URLs. Its commands use npm and npx, which can reach the network depending on how they are called. This is read from the text; nothing was executed.
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
Obsidian Plugin Quality is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
About 1.6k tokens (SKILL.md is roughly 6.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
Skills that share tags, products or a category with Obsidian Plugin Quality: Obsidian Plugin Development Guidelines (gapmiss/obsidian-plugin-skill, 190 stars), LobeHub Alint Rule Set Maintenance (lobehub/lobehub, 83k stars), Eslint Migrate Options (biomejs/biome, 26k stars) and Ultracite (agustinusnathaniel/nextarter-tailwind, 125 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
RafaelGB (a GitHub user) maintains it in RafaelGB/Obsidian-ZettelFlow, which has 174 GitHub stars. The repository holds 9 skills in this directory. The repository was last updated on October 8, 2026.
Source: RafaelGB/Obsidian-ZettelFlow on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.