my-plugin/
├── main.ts              # 插件入口（必须）
├── manifest.json        # 插件清单（必须）
├── package.json         # npm 依赖
├── tsconfig.json        # TypeScript 配置
├── esbuild.config.mjs   # 构建配置
├── styles.css           # 样式文件（可选）
├── view.ts              # 自定义视图（可选）
├── settings.ts          # 设置模块（可选）
├── extension.ts         # 编辑器扩展（可选）
└── widget.ts            # 装饰小部件（可选）

# PowerShell 初始化
& "C:\Users\123\.claude\skills\obsidian-plugin-dev\scripts\init-obsidian-plugin.ps1" `
  -Name "my-plugin" -Template "simple" -VaultPath "D:\MyVault"

# 开发构建（监听模式）
npm run dev

# 生产构建
npm run build

import { Plugin, Notice } from 'obsidian';

interface MyPluginSettings {
  option1: string;
  option2: boolean;
}

const DEFAULT_SETTINGS: MyPluginSettings = {
  option1: 'default',
  option2: false,
};

export default class MyPlugin extends Plugin {
  settings: MyPluginSettings;

  async onload() {
    await this.loadSettings();

    // 注册命令
    this.addCommand({
      id: 'my-command',
      name: 'My Command',
      callback: () => { new Notice('Hello!'); },
    });

    // 功能区图标
    this.addRibbonIcon('dice', 'My Plugin', () => { new Notice('Clicked!'); });

    // 状态栏
    this.addStatusBarItem().setText('My Plugin');

    // 设置面板
    this.addSettingTab(new MySettingTab(this.app, this));
  }

  onunload() {
    // 清理所有资源
  }

  async loadSettings() {
    this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
  }

  async saveSettings() {
    await this.saveData(this.settings);
  }
}

{
  "id": "{{PLUGIN_ID}}",
  "name": "{{PLUGIN_NAME}}",
  "version": "1.0.0",
  "minAppVersion": "0.15.0",
  "description": "Description of your plugin.",
  "author": "Your Name",
  "authorUrl": "https://github.com/your-name",
  "isDesktopOnly": false
}

import esbuild from "esbuild";
import process from "process";
import builtins from "builtin-modules";

const prod = process.argv[2] === "production";

esbuild.build({
  entryPoints: ["main.ts"],
  bundle: true,
  external: [
    "obsidian",
    "electron",
    "@codemirror/autocomplete", "@codemirror/collab",
    "@codemirror/commands", "@codemirror/language",
    "@codemirror/lint", "@codemirror/search",
    "@codemirror/state", "@codemirror/view",
    "@lezer/common", "@lezer/highlight", "@lezer/lr",
    ...builtins,
  ],
  format: "cjs",
  target: "es2018",
  logLevel: "info",
  sourcemap: prod ? false : "inline",
  treeShaking: true,
  outfile: "main.js",
  watch: !prod,
}).catch(() => process.exit(1));

// 简单命令
this.addCommand({ id: 'cmd', name: 'Do Something', callback: () => {} });

// 编辑器命令（自动检查编辑器可用性）
this.addCommand({
  id: 'editor-cmd', name: 'Editor Action',
  editorCallback: (editor, ctx) => { editor.replaceSelection('text'); },
});

// 条件命令
this.addCommand({
  id: 'check-cmd', name: 'Conditional',
  checkCallback: (checking) => {
    const view = this.app.workspace.getActiveViewOfType(MarkdownView);
    if (view) { if (!checking) { /* 执行操作 */ } return true; }
    return false;
  },
});

class InputModal extends Modal {
  result: string;
  onSubmit: (result: string) => void;

  constructor(app: App, onSubmit: (result: string) => void) {
    super(app);
    this.onSubmit = onSubmit;
  }

  onOpen() {
    const { contentEl } = this;
    new Setting(contentEl).setName('Input').addText((text) =>
      text.onChange((value) => { this.result = value; })
    );
    new Setting(contentEl).addButton((btn) =>
      btn.setButtonText('Submit').setCta().onClick(() => {
        this.close();
        this.onSubmit(this.result);
      })
    );
  }

  onClose() { this.contentEl.empty(); }
}

class MySettingTab extends PluginSettingTab {
  plugin: MyPlugin;
  constructor(app: App, plugin: MyPlugin) { super(app, plugin); this.plugin = plugin; }

  display(): void {
    const { containerEl } = this;
    containerEl.empty();
    new Setting(containerEl)
      .setName('Setting name').setDesc('Description')
      .addText((text) => text.setValue(this.plugin.settings.option1)
        .onChange(async (v) => { this.plugin.settings.option1 = v; await this.plugin.saveSettings(); }));
    new Setting(containerEl)
      .setName('Toggle').addToggle((toggle) => toggle.setValue(this.plugin.settings.option2)
        .onChange(async (v) => { this.plugin.settings.option2 = v; await this.plugin.saveSettings(); }));
  }
}

import { ItemView, WorkspaceLeaf } from 'obsidian';
const VIEW_TYPE = 'my-view';

class MyView extends ItemView {
  constructor(leaf: WorkspaceLeaf) { super(leaf); }
  getViewType() { return VIEW_TYPE; }
  getDisplayText() { return 'My View'; }
  async onOpen() { this.containerEl.children[1].createEl('h4', { text: 'Hello' }); }
  async onClose() { /* 清理 */ }
}

// 在 Plugin.onload() 中注册
this.registerView(VIEW_TYPE, (leaf) => new MyView(leaf));

// 激活视图
async activateView() {
  this.app.workspace.detachLeavesOfType(VIEW_TYPE);
  await this.app.workspace.getRightLeaf(false).setViewState({ type: VIEW_TYPE, active: true });
  this.app.workspace.revealLeaf(this.app.workspace.getLeavesOfType(VIEW_TYPE)[0]);
}

// 在 Plugin.onunload() 中清理
this.app.workspace.detachLeavesOfType(VIEW_TYPE);

// Vault 事件
this.registerEvent(this.app.vault.on('create', (file) => {}));
this.registerEvent(this.app.vault.on('modify', (file) => {}));
this.registerEvent(this.app.vault.on('delete', (file) => {}));
this.registerEvent(this.app.vault.on('rename', (file, oldPath) => {}));

// Workspace 事件
this.registerEvent(this.app.workspace.on('file-open', (file) => {}));
this.registerEvent(this.app.workspace.on('active-leaf-change', (leaf) => {}));
this.registerEvent(this.app.workspace.on('layout-change', () => {}));
this.registerEvent(this.app.workspace.on('file-menu', (menu, file, source) => {
  menu.addItem((item) => item.setTitle('My Action').onClick(() => {}));
}));
this.registerEvent(this.app.workspace.on('editor-menu', (menu, editor, info) => {
  menu.addItem((item) => item.setTitle('Editor Action').onClick(() => {}));
}));
this.registerEvent(this.app.workspace.on('editor-change', (editor, info) => {}));

// MetadataCache 事件
this.registerEvent(this.app.metadataCache.on('changed', (file, data, cache) => {}));
this.registerEvent(this.app.metadataCache.on('resolved', () => {}));

// 定时器（自动清理）
this.registerInterval(window.setInterval(() => {}, 5 * 60 * 1000));

// 注册编辑器扩展
this.registerEditorExtension([myViewPlugin, myStateField]);

// 注册 Markdown 后处理器
this.registerMarkdownPostProcessor((el, ctx) => { /* 处理阅读视图 DOM */ });

// 注册代码块处理器
this.registerMarkdownCodeBlockProcessor('csv', (source, el, ctx) => { /* 渲染 CSV */ });

// esbuild.config.mjs 中直接输出到 Vault
const VAULT_PLUGIN_DIR = "D:/MyVault/.obsidian/plugins/my-plugin";
// ...
outfile: prod ? "main.js" : `${VAULT_PLUGIN_DIR}/main.js`,