Obsidian Sample Plugin (Modified)

Self-contained Obsidian plugin with built-in development scripts and automated workflows.

This plugin demonstrates the obsidian-plugin-config injection system, making it 100% standalone with all development tools integrated locally.

Features

• ✅ Standalone scripts - All build and automation scripts included locally
• ✅ Hot reload - Automatic rebuild on file changes
• ✅ Dual vault support - Test and production vault configurations
• ✅ Git automation - One-command commit and push
• ✅ Version management - Automated version bumping
• ✅ GitHub releases - Automated release creation
• ✅ Code quality - ESLint + Prettier configured
• ✅ VSCode tasks - Quick access to common commands
• ✅ SASS support - Optional SCSS compilation

Installation

git clone https://github.com/3C0D/obsidian-sample-plugin-modif.git
cd obsidian-sample-plugin-modif
yarn install

Configuration

Environment Setup

Create a .env file with your vault paths:

TEST_VAULT=C:\path\to\test\vault
REAL_VAULT=C:\path\to\production\vault

Two development modes:

1. In-place development (inside vault):

   • Develop directly in .obsidian/plugins/your-plugin
   • Run yarn dev - builds automatically to current location

2. External development (outside vault):

   • Develop anywhere on your system
   • Configure .env with vault paths
   • Run yarn dev - builds to TEST_VAULT
   • Run yarn real - builds to REAL_VAULT

Commands

Development

yarn start          # Install dependencies + start dev
yarn dev            # Development build (watch mode)
yarn build          # Production build
yarn real           # Build + install to real vault

Git Automation

yarn acp            # Add, commit, push
yarn bacp           # Build + add, commit, push

Version & Release

yarn v              # Update version (prompts for type)
yarn r              # Create GitHub release

Code Quality

yarn lint           # ESLint check
yarn lint:fix       # ESLint fix
yarn prettier       # Prettier check
yarn prettier:fix   # Prettier format all

Help

yarn h              # Full help documentation

VSCode Tasks

Quick access via Ctrl+Shift+P → "Run Task":

• Build - Production build
• Lint / Lint: Fix - ESLint check/fix
• Prettier: Check / Prettier: Fix - Format check/fix
• Obsidian Inject - Re-inject configuration (with confirmation)
• Obsidian Inject (no confirm) - Re-inject without confirmation
• Cleanup: Lint + Prettier + Build - Full cleanup sequence

💡 Tip: Use Ctrl+Shift+B (Windows/Linux) or Cmd+Shift+B (Mac) for the default Build task.

Updating via obsidian-plugin-config

This plugin can be automatically updated with the latest scripts and configurations:

Global Installation (one time)

npm install -g obsidian-plugin-config

Update the Plugin

cd your-plugin
obsidian-inject

Update Options

# With confirmation (default)
obsidian-inject

# Without confirmation
obsidian-inject --no

# Interactive mode (choose what to inject)
obsidian-inject --interactive

# Use preset
obsidian-inject --preset=minimal

# With SASS support
obsidian-inject --sass

# Verification only (no changes)
obsidian-inject --dry-run

What Gets Updated

• ✅ Local scripts (esbuild.config.ts, acp.ts, utils.ts, etc.)
• ✅ package.json (scripts, dependencies)
• ✅ tsconfig.json
• ✅ eslint.config.mts
• ✅ Config files (.editorconfig, .prettierrc, .npmrc, .env)
• ✅ VSCode settings and tasks
• ✅ GitHub Actions workflows

SASS Support (Optional)

To add SASS/SCSS support:

obsidian-inject --sass

What SASS injection adds:

• ✅ esbuild-sass-plugin dependency
• ✅ Automatic compilation of .scss files
• ✅ Priority detection: src/styles.scss > src/styles.css > styles.css
• ✅ Automatic cleanup of generated CSS

Usage:

1. Create src/styles.scss instead of styles.css
2. Use SASS variables, mixins and features
3. Build automatically compiles to CSS

Architecture

Self-Contained Design

All development tools are integrated locally in ./scripts/:

• esbuild.config.ts - Build configuration with SASS detection
• acp.ts - Git automation (add, commit, push)
• update-version.ts - Version management
• release.ts - GitHub release automation
• utils.ts - Shared utility functions
• help.ts - Help documentation

No external dependencies required - the plugin is 100% standalone after injection.

Traceability

.injection-info.json tracks:

• Injector version used
• Injection date
• Injector name

This allows checking if updates are available.

Recommended Workflow

1. yarn start - Install and start development
2. Make changes, test in Obsidian
3. yarn bacp - Build and commit changes
4. yarn v - Update version
5. yarn r - Create release

Updating Dependencies

yarn upgrade        # Update all dependencies to latest

More Information

• obsidian-plugin-config on NPM
• obsidian-plugin-config on GitHub
• Obsidian Plugin Developer Docs