菜单
ALIAS — merged into the unified `obsidian` skill (v2.0). Use the `obsidian` skill instead. Build, validate, and publish Obsidian plugins. Redirects to obsidian skill for plugin development, ESLint rules, boilerplate generation, accessibility, and submission validation.
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/akillness/oh-my-skills --skill obsidian-plugin命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
基于 SOC 职业分类
正在显示 SKILL.md
| name | obsidian-plugin |
| description | ALIAS — merged into the unified `obsidian` skill (v2.0). Use the `obsidian` skill instead. Build, validate, and publish Obsidian plugins. Redirects to obsidian skill for plugin development, ESLint rules, boilerplate generation, accessibility, and submission validation. |
| allowed-tools | Bash Read Write Edit Glob Grep WebFetch |
| license | MIT |
| metadata | {"tags":"obsidian, plugin-development, eslint, typescript, boilerplate, submission, accessibility","version":"1.1","source":"https://github.com/gapmiss/obsidian-plugin-skill","deprecated":"Merged into obsidian skill v2.0 — use obsidian instead"} |
Keyword:
obsidian plugin·create obsidian plugin·obsidian eslint·obsidian submissionBuild high-quality Obsidian plugins that pass community review on first attempt. Covers all 27 rules from
eslint-plugin-obsidianmdv0.1.9, boilerplate generation, vault API patterns, accessibility requirements, and submission validation.
eslint-plugin-obsidianmdregisterEvent, no view reference storage)as TFile casts, no any)# Interactive boilerplate generator — validates metadata against submission rules
node scripts/create-plugin.js
# Or use npx directly from the source repo
npx github:gapmiss/obsidian-plugin-skill create-plugin
The generator produces:
src/main.ts — Plugin class with settings integrationsrc/settings.ts — Settings interface and PluginSettingTabmanifest.json — Validated plugin metadatastyles.css — CSS scaffold with Obsidian variables commenttsconfig.json, package.json, esbuild.config.mjs — Build toolchainversion-bump.mjs, versions.json — Version managementLICENSE — MIT with auto-populated year/authornpm install --save-dev eslint eslint-plugin-obsidianmd
// eslint.config.mjs
import pluginObsidianmd from "eslint-plugin-obsidianmd";
export default [
pluginObsidianmd.configs.recommended,
// For locale string checking:
// pluginObsidianmd.configs.recommendedWithLocalesEn,
];
Run validation:
npx eslint src/
npx eslint src/ --fix # auto-fix where possible
bash scripts/install.sh to set up the development environment| Field | Rule |
|---|---|
| Plugin ID | Lowercase, alphanumeric + dashes/underscores; no "obsidian"; no "plugin" suffix |
| Plugin Name | No "Obsidian" word; no "Plugin" suffix; no "Obsi" prefix or "dian" suffix |
| Description | No "Obsidian" word; no "This plugin"; must end with ., ?, !, or ) |
# Validate your manifest.json
node scripts/create-plugin.js --validate-only
| Rule | Auto-fix | Description |
|---|---|---|
no-obsidian-in-id | No | Plugin ID must not contain "obsidian" |
no-plugin-suffix-in-id | No | Plugin ID must not end with "-plugin" |
no-obsidian-in-name | No | Plugin name must not contain "Obsidian" |
no-plugin-suffix-in-name | No | Plugin name must not end with "Plugin" |
valid-description | No | Description format validation |
| Rule | Auto-fix | Description |
|---|---|---|
prefer-register-event | No | Use this.registerEvent() for automatic cleanup |
no-view-reference | No | Never store direct view references (causes memory leaks) |
| Rule | Auto-fix | Description |
|---|---|---|
no-tfile-cast | No | Avoid as TFile / as TFolder (use instanceof) |
| Rule | Auto-fix | Description |
|---|---|---|
sentence-case | Yes | All UI text in sentence case |
no-plugin-name-in-command | No | Commands must not repeat plugin name |
no-command-in-command | No | Commands must not include the word "command" |
no-default-hotkey | No | Do not define default hotkeys |
no-manual-headings | No | Settings UI: use setHeading(), not manual HTML |
| Rule | Auto-fix | Description |
|---|---|---|
no-global-app | No | Use this.app, not global app |
prefer-request-url | No | Use requestUrl(), not fetch() |
no-console-log | No | Remove console.log before submission |
prefer-abstract-input-suggest | No | Use AbstractInputSuggest for suggestions |
| Rule | Auto-fix | Description |
|---|---|---|
no-inline-styles | No | Use CSS classes; no inline style attributes |
prefer-css-variables | No | Use Obsidian CSS variables, not hardcoded colors |
scope-plugin-styles | No | Scope all CSS to plugin ID selector |
| Rule | Auto-fix | Description |
|---|---|---|
require-aria-label | No | Icon buttons must have aria-label |
require-keyboard-nav | No | All interactions must be keyboard accessible |
require-focus-visible | No | Use :focus-visible CSS for focus indicators |
// ✅ Correct — auto-cleaned on plugin unload
this.registerEvent(
this.app.vault.on('create', (file) => this.handleCreate(file))
);
// ❌ Wrong — leaks memory
this.app.vault.on('create', (file) => this.handleCreate(file));
// ✅ Correct — instanceof narrowing
const file = this.app.workspace.getActiveFile();
if (file instanceof TFile) {
await this.app.vault.read(file);
}
// ❌ Wrong — unsafe cast
const file = this.app.workspace.getActiveFile() as TFile;
// ✅ Correct
const btn = containerEl.createEl('button', { cls: 'clickable-icon' });
btn.setAttribute('aria-label', 'Delete note');
setIcon(btn, 'trash');
// ❌ Wrong — no aria-label
const btn = containerEl.createEl('button', { cls: 'clickable-icon' });
setIcon(btn, 'trash');
/* ✅ Correct — theme-compatible */
.my-plugin-button {
background-color: var(--interactive-accent);
color: var(--text-on-accent);
border-radius: var(--radius-m);
}
/* ❌ Wrong — hardcoded colors */
.my-plugin-button {
background-color: #7c3aed;
color: white;
}
| Task | Command |
|---|---|
| Generate boilerplate | node scripts/create-plugin.js |
| Install ESLint | npm install --save-dev eslint eslint-plugin-obsidianmd |
| Run ESLint | npx eslint src/ |
| Auto-fix ESLint | npx eslint src/ --fix |
| Build plugin | npm run build |
| Dev watch mode | npm run dev |
| Bump version | npm run version |
any, const/let