obsidian-plugin-development-typescript-setup
/obsidian-plugin-development-typescript-setup
Use this skill when scaffolding, writing, and compiling custom community plugins for Obsidian using TypeScript and esbuild.
- Author
- nextboxis ↗
- Repository
- library-skill-agents ↗
- Licence
- MIT
- Last repository change
- 28.10.2026
Assessment and security
- Files in this package
- 1
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 28.10.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
What it does and when to use it
Use this skill when scaffolding, writing, and compiling custom community plugins for Obsidian using TypeScript and esbuild.
Original author description
Use this skill when scaffolding, writing, and compiling custom community plugins for Obsidian using TypeScript and esbuild.
How it works
- When to use
- Prerequisites
- Step-by-step workflow
- Commands / code examples
- Common mistakes & pitfalls
- Verification checklist
- Related skills
SKILL.md preview
---
name: obsidian-plugin-development-typescript-setup
description: Use this skill when scaffolding, writing, and compiling custom community plugins for Obsidian using TypeScript and esbuild.
---
# Obsidian Plugin Development: TypeScript Setup
## When to use
Use this skill when you need to scaffolding, writing, and compiling custom community plugins for Obsidian using TypeScript and esbuild.
## Prerequisites
- Obsidian installed (current stable version for desktop or mobile).
- Working knowledge of Markdown syntax and local file management.
## Step-by-step workflow
1. **Understand structural conventions**: Review vault conventions, frontmatter schemas, or community plugin prerequisites.
2. **Configure settings & templates**: Set up necessary folder paths, template variables, or plugin options.
3. **Draft content / script**: Write structured Markdown, Dataview queries, or plugin automation logic.
4. **Test interaction & rendering**: Preview note rendering in Reading View, test graph navigation, or trigger commands.
5. **Enforce vault security**: Audit links, verify attachment locations, and ensure no secrets or sensitive credentials are recorded.
## Commands / code examples
```ts
import { App, Plugin, PluginSettingTab, Setting } from 'obsidian';
export default class CustomAutomationPlugin extends Plugin {
async onload() {
console.log('Loading Custom Automation Plugin');
this.addCommand({
id: 'insert-security-banner',
name: 'Insert Security Classification Banner',
editorCallback: (editor) => {
editor.replaceSelection('> [!CAUTION] CONFIDENTIAL // INTERNAL USE ONLY\n\n');
},
});
}
async onunload() {
console.log('Unloading Custom Automation Plugin');
}
}
```
## Common mistakes & pitfalls
- Installing unvetted community plugins without reviewing source code and network permissions.
- Storing plaintext credentials, API keys, or sensitive passwords inside Markdown notes.
- Creating brittle links by hardcoding absolute OS paths instead of using Obsidian `[[wikilinks]]`.
## Verification checklist
- [ ] Notes utilize valid Obsidian Markdown syntax and standard properties.
- [ ] No passwords, API keys, or private secrets exist inside the note files.
- [ ] Community plugins are documented and audited for permission boundaries.
- [ ] Agent integrations are verified on a scratch or copy vault prior to production use.
## Related skills
- obsidian-vault-structure-para-method
- obsidian-markdown-syntax-wikilinks-embeds
- obsidian-vault-security-privacy-hardening
- mcp-server-obsidian
Versions
The database has no other skills named obsidian-plugin-development-typescript-setup.
Database snapshot: 13.11.2026 · package version 1bbcbff3fa0a (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100obsidian-install-auth
Set up Obsidian plugin development environment with Node.js and TypeScript. Use when starting a new plugin project, configuring the dev environment, or initializing Obsidian plugin development from scratch. Trigger with phrases like "obsidian setup", "obsidian plugin dev",… - 100obsidian-core-workflow-a
Create an Obsidian plugin from scratch with full project scaffolding. Covers Plugin class, ribbon icons, commands, settings tab, esbuild config, manifest.json, and building/testing. Use when starting a new plugin, scaffolding a project, or learning the plugin lifecycle. Trigger… - 100obsidian-scaffold
Generate the layout, manifest, tsconfig, esbuild config, and a minimal class that passes automated review. TRIGGER WHEN: the user asks to start, create, bootstrap, scaffold, or initialize a new Obsidian community plugin. - 100obsidian-scaffold
Generate the layout, manifest, tsconfig, esbuild config, and a minimal class that passes automated review. TRIGGER WHEN: the user asks to start, create, bootstrap, scaffold, or initialize a new Obsidian community plugin. - 100obsidian
Comprehensive guidelines for Obsidian.md plugin development including ESLint rules from eslint-plugin-obsidianmd v0.4.2, TypeScript best practices, memory management, API usage (requestUrl vs fetch), UI/UX standards, popout window compatibility, community.obsidian.md submission… - 100obsidian-dev-rules
Authoritative reference and rules for developing for Obsidian — building TypeScript plugins (Plugin lifecycle, manifest.json, commands, settings, modals, views, ribbon/status bar), the Vault and Editor APIs, the event system, Markdown post-processing & code-block processors,…