Hướng dẫn phát triển plugin Obsidian

Bộ quy tắc ESLint, chuẩn API, khả năng truy cập và quy trình gửi plugin Obsidian gói trong một skill.

Lập trìnhTrung cấp★ 187⑂ 15Điểm AI 8/10Cập nhật lần cuối: 24 thg 9, 2026

Giúp được gì

Tổng hợp hơn 40 quy tắc của eslint-plugin-obsidianmd v0.4.2 dưới dạng bảng ✅/❌ để Claude áp dụng khi viết và review code.
Bao trùm các chủ đề thực chiến: quản lý bộ nhớ (registerEvent, registerDomEvent), an toàn kiểu (instanceof), chọn Editor API hay Vault API, requestUrl thay cho fetch, tương thích cửa sổ popout (activeDocument/activeWindow), settings khai báo (getSettingDefinitions() từ 1.13).
Ép chuẩn UI/A11y: viết chữ kiểu câu, đặt tên command, dùng biến CSS của Obsidian, tránh !important và :has, điều hướng bàn phím, nhãn ARIA, vùng chạm ≥ 44×44px.
Có quy trình 7 bước gửi plugin lên community.obsidian.md, mẹo tối ưu Scorecard (mục tiêu 90%+) và script tạo boilerplate tools/create-plugin.js.
Liên kết tới các tài liệu chi tiết reference/*.md cho từng chủ đề.

Phù hợp với ai

Lập trình viên đang làm hoặc chuẩn bị gửi plugin cộng đồng cho Obsidian.
Người muốn dọn sạch cảnh báo ESLint và nâng điểm Scorecard cho plugin đã phát hành.
Người cần chuyển sang API settings khai báo của Obsidian 1.13.

Ví dụ sử dụng

"Review main.ts của tôi theo chuẩn Obsidian" → chỉ ra event chưa cleanup, dùng sai Vault.modify(), còn dùng fetch() và đề xuất sửa.
"Tạo dự án plugin mới" → gợi ý trình tạo boilerplate tối giản và kiểm tra quy tắc manifest (id, name, description).
"Trước khi submit cần kiểm tra gì?" → checklist: chạy ESLint, kiểm tra LICENSE, test trên mobile, audit bàn phím, tag release khớp manifest.

· · · Hướng dẫn cài đặt · · ·

Dùng thử ngay, không cần cài

Dán đoạn dưới vào Claude là dùng được skill này mà không cần cài đặt.

Hãy đọc hướng dẫn trong tệp này và làm theo để giúp mình:
https://raw.githubusercontent.com/gapmiss/obsidian-plugin-skill/HEAD/.agents/skills/obsidian/SKILL.md

Mình muốn: (viết việc bạn cần ở đây)

Nếu Claude không mở được liên kết, hãy mở liên kết và copy nội dung vào rồi dán.

↓ Thấy hữu ích thì tải ZIP bên dưới và cài. Sau đó skill tự chạy, không phải dán lại mỗi lần.

Cài vào ứng dụng Claude (không cần terminal)

Tải tệp ZIP bằng nút bên dưới.
Trong Claude, mở Settings → Capabilities và bật 'Code execution and file creation'. (chỉ một lần)
Vào Customize → Skills → + → 'Upload a skill' rồi tải tệp ZIP lên.

↓ Tải ZIP

Cài vào Claude Code

Để Claude làm — dán câu dưới đây vào Claude Code

Hãy cài skill mình tìm thấy trên Claude Skill Mart.
Copy thư mục .agents/skills/obsidian từ repo GitHub gapmiss/obsidian-plugin-skill vào ~/.claude/skills/obsidian/ của mình.
Sau khi cài xong, cho mình biết skill này làm được gì trong một câu.

Cài bằng lệnh thủ công

git clone https://github.com/gapmiss/obsidian-plugin-skill.git /tmp/obsidian-plugin-skill && mkdir -p ~/.claude/skills && cp -r /tmp/obsidian-plugin-skill/.agents/skills/obsidian ~/.claude/skills/obsidian

⚠ Đây là skill do người khác tạo. Hãy kiểm tra repo gốc trước khi cài.

Mở terminal.
Tải repo: git clone https://github.com/gapmiss/obsidian-plugin-skill.git
Tạo thư mục skill: mkdir -p ~/.claude/skills
Sao chép skill: cp -r obsidian-plugin-skill/.agents/skills/obsidian ~/.claude/skills/obsidian
Kiểm tra thư mục reference/ và tệp tools/create-plugin.js đã được copy kèm (skill có tham chiếu tới chúng).
Khởi động lại Claude Code, mở repo plugin của bạn và yêu cầu ví dụ: "Kiểm tra code theo quy tắc plugin Obsidian".
Để kiểm tra thật, cài npm i -D eslint eslint-plugin-obsidianmd trong dự án rồi chạy npx eslint ..

Xem mã nguồn trên GitHub ↗Giấy phép: MIT