obsidian-plugin-config 1.4.6 → 1.4.8

package/scripts/help.ts

@@ -1,152 +1,152 @@
-#!/usr/bin/env tsx
-
-console.log(`
-🎯 Obsidian Plugin Config - Quick Help
-Injection system for autonomous Obsidian plugins
-
-═══════════════════════════════════════════════════════════════════
-
-📋 PLUGIN CONFIG COMMANDS
-
-INSTALLATION & SETUP:
-  yarn i, install                 # Install dependencies
-  yarn update-exports, ue         # Update package.json exports
-
-GIT & VERSION MANAGEMENT:
-  yarn acp                        # Add, commit, push
-  yarn bacp                       # Build + add, commit, push
-  yarn v, update-version          # Update version (package.json + versions.json)
-
-BUILD & TESTING:
-  yarn build                      # TypeScript check (no build needed)
-  yarn dev                        # Start development mode (watch)
-  yarn real                       # Build for production to real vault
-  yarn lint, lint:fix             # ESLint verification/correction
-
-INJECTION (Development phase):
-  yarn inject-prompt <path>       # Interactive injection (recommended)
-  yarn inject-path <path> --yes   # Direct injection with auto-confirm
-  yarn inject <path> --sass       # Injection with SASS support
-  yarn check-plugin <path>        # Verification only (dry-run)
-
-NPM PUBLISHING (all-in-one - no acp needed before):
-  yarn npm-publish                # Full workflow (7 steps):
-                                  # 0. NPM auth check
-                                  # 1. version bump
-                                  # 2. update exports
-                                  # 3. generate bin
-                                  # 4. verify package
-                                  # 5. commit + push
-                                  # 6. publish to NPM
-                                  # 7. offer global CLI update
-  yarn build-npm                  # Alias for npm-publish
-
-UPGRADE:
-  yarn upgrade-all                # yarn upgrade + sync template deps
-
-HELP:
-  yarn help, h                    # This help
-
-═══════════════════════════════════════════════════════════════════
-
-📦 EXPORTS SYSTEM
-
-The package exposes a single entry point:
-  obsidian-plugin-config          # Main entry — re-exports all modules
-
-Src modules (auto-exported via src/index.ts):
-  modals, tools, utils
-
-After adding a new module to src/, run:
-  yarn update-exports             # Regenerates src/index.ts
-
-═══════════════════════════════════════════════════════════════════
-
-🏗️  ARCHITECTURE
-
-TWO DISTINCT ROLES:
-  Root (src/, scripts/)           # Local plugin + NPM snippet exports
-  templates/                      # Source of truth for injection
-
-templates/ → what gets injected:
-  templates/package.json          # Base deps/scripts for target plugins
-  templates/package-sass.json     # Extra deps when --sass is used
-  templates/tsconfig.json         # TypeScript config for target plugins
-  templates/scripts/*             # Scripts copied to <target>/scripts/
-  templates/eslint.config.mts     # ESLint config for target plugins
-
-inject-core.ts — shared injection logic:
-  updatePackageJson()             # Reads templates/package.json (not hardcoded)
-  injectScripts()                 # Copies templates/ files to target
-  performInjection()              # Main orchestration function
-
-inject-path.ts — CLI entry point:
-  Parses --yes, --dry-run, --sass flags
-
-inject-prompt.ts — interactive entry point:
-  Prompts for target path interactively
-
-═══════════════════════════════════════════════════════════════════
-
-🔧 DEVELOPMENT WORKFLOWS
-
-Plugin Config Development:
-  1. yarn i                       # Install dependencies
-  2. yarn update-exports          # Update exports
-  3. yarn dev                     # Test as plugin (optional)
-  4. yarn lint:fix                # Fix code issues
-  5. yarn v                       # Update version + commit + push
-  6. yarn npm-publish             # Publish to NPM
-
-Injection Usage:
-  Usage (from plugin directory or by path):
-    obsidian-inject               # Inject in current dir
-    obsidian-inject ../my-plugin  # Inject by path
-    obsidian-inject ../my-plugin --sass  # With SASS
-
-  Or with local yarn commands:
-    yarn inject-prompt            # Interactive
-    yarn inject-path ../my-plugin # Direct injection
-    yarn check-plugin ../my-plugin # Dry-run only
-
-SASS Support (--sass flag):
-  What gets added to the target plugin:
-    ✅ esbuild-sass-plugin dependency
-    ✅ Automatic .scss file detection (src/styles.scss priority)
-    ✅ CSS cleanup after compilation
-
-  The standard esbuild.config.ts handles SASS via dynamic import —
-  no separate template needed.
-
-═══════════════════════════════════════════════════════════════════
-
-🚀 COMPLETE WORKFLOWS
-
-STANDARD DEVELOPMENT WORKFLOW:
-  1. yarn i                       # Install dependencies
-  2. Make changes to src/ or templates/
-  3. yarn lint:fix                # Fix any linting issues
-  4. yarn npm-publish             # Does EVERYTHING:
-                                  # → Ask for version bump type
-                                  # → Update exports
-                                  # → Generate bin file
-                                  # → Verify package
-                                  # → Commit + push to GitHub
-                                  # → Publish to NPM
-
-  Note: yarn acp is only needed for intermediate commits
-  (not required before npm-publish).
-
-AFTER NPM PUBLISH - Update global CLI:
-  npm install -g obsidian-plugin-config@latest --force
-  obsidian-inject                 # Test in current plugin dir
-  obsidian-inject ../test-plugin --sass
-
-TESTING AS PLUGIN (Optional):
-  1. Configure .env with TEST_VAULT and REAL_VAULT paths
-  2. yarn dev                     # Watch mode for development
-  3. yarn real                    # Install to real vault
-
-═══════════════════════════════════════════════════════════════════
-
-`);
+#!/usr/bin/env tsx
+
+console.log(`
+🎯 Obsidian Plugin Config - Quick Help
+Injection system for autonomous Obsidian plugins
+
+═══════════════════════════════════════════════════════════════════
+
+📋 PLUGIN CONFIG COMMANDS
+
+INSTALLATION & SETUP:
+  yarn i, install                 # Install dependencies
+  yarn update-exports, ue         # Update package.json exports
+
+GIT & VERSION MANAGEMENT:
+  yarn acp                        # Add, commit, push
+  yarn bacp                       # Build + add, commit, push
+  yarn v, update-version          # Update version (package.json + versions.json)
+
+BUILD & TESTING:
+  yarn build                      # TypeScript check (no build needed)
+  yarn dev                        # Start development mode (watch)
+  yarn real                       # Build for production to real vault
+  yarn lint, lint:fix             # ESLint verification/correction
+
+INJECTION (Development phase):
+  yarn inject-prompt <path>       # Interactive injection (recommended)
+  yarn inject-path <path> --yes   # Direct injection with auto-confirm
+  yarn inject <path> --sass       # Injection with SASS support
+  yarn check-plugin <path>        # Verification only (dry-run)
+
+NPM PUBLISHING (all-in-one - no acp needed before):
+  yarn npm-publish                # Full workflow (7 steps):
+                                  # 0. NPM auth check
+                                  # 1. version bump
+                                  # 2. update exports
+                                  # 3. generate bin
+                                  # 4. verify package
+                                  # 5. commit + push
+                                  # 6. publish to NPM
+                                  # 7. offer global CLI update
+  yarn build-npm                  # Alias for npm-publish
+
+UPGRADE:
+  yarn upgrade-all                # yarn upgrade + sync template deps
+
+HELP:
+  yarn help, h                    # This help
+
+═══════════════════════════════════════════════════════════════════
+
+📦 EXPORTS SYSTEM
+
+The package exposes a single entry point:
+  obsidian-plugin-config          # Main entry — re-exports all modules
+
+Src modules (auto-exported via src/index.ts):
+  modals, tools, utils
+
+After adding a new module to src/, run:
+  yarn update-exports             # Regenerates src/index.ts
+
+═══════════════════════════════════════════════════════════════════
+
+🏗️  ARCHITECTURE
+
+TWO DISTINCT ROLES:
+  Root (src/, scripts/)           # Local plugin + NPM snippet exports
+  templates/                      # Source of truth for injection
+
+templates/ → what gets injected:
+  templates/package.json          # Base deps/scripts for target plugins
+  templates/package-sass.json     # Extra deps when --sass is used
+  templates/tsconfig.json         # TypeScript config for target plugins
+  templates/scripts/*             # Scripts copied to <target>/scripts/
+  templates/eslint.config.mts     # ESLint config for target plugins
+
+inject-core.ts — shared injection logic:
+  updatePackageJson()             # Reads templates/package.json (not hardcoded)
+  injectScripts()                 # Copies templates/ files to target
+  performInjection()              # Main orchestration function
+
+inject-path.ts — CLI entry point:
+  Parses --yes, --dry-run, --sass flags
+
+inject-prompt.ts — interactive entry point:
+  Prompts for target path interactively
+
+═══════════════════════════════════════════════════════════════════
+
+🔧 DEVELOPMENT WORKFLOWS
+
+Plugin Config Development:
+  1. yarn i                       # Install dependencies
+  2. yarn update-exports          # Update exports
+  3. yarn dev                     # Test as plugin (optional)
+  4. yarn lint:fix                # Fix code issues
+  5. yarn v                       # Update version + commit + push
+  6. yarn npm-publish             # Publish to NPM
+
+Injection Usage:
+  Usage (from plugin directory or by path):
+    obsidian-inject               # Inject in current dir
+    obsidian-inject ../my-plugin  # Inject by path
+    obsidian-inject ../my-plugin --sass  # With SASS
+
+  Or with local yarn commands:
+    yarn inject-prompt            # Interactive
+    yarn inject-path ../my-plugin # Direct injection
+    yarn check-plugin ../my-plugin # Dry-run only
+
+SASS Support (--sass flag):
+  What gets added to the target plugin:
+    ✅ esbuild-sass-plugin dependency
+    ✅ Automatic .scss file detection (src/styles.scss priority)
+    ✅ CSS cleanup after compilation
+
+  The standard esbuild.config.ts handles SASS via dynamic import —
+  no separate template needed.
+
+═══════════════════════════════════════════════════════════════════
+
+🚀 COMPLETE WORKFLOWS
+
+STANDARD DEVELOPMENT WORKFLOW:
+  1. yarn i                       # Install dependencies
+  2. Make changes to src/ or templates/
+  3. yarn lint:fix                # Fix any linting issues
+  4. yarn npm-publish             # Does EVERYTHING:
+                                  # → Ask for version bump type
+                                  # → Update exports
+                                  # → Generate bin file
+                                  # → Verify package
+                                  # → Commit + push to GitHub
+                                  # → Publish to NPM
+
+  Note: yarn acp is only needed for intermediate commits
+  (not required before npm-publish).
+
+AFTER NPM PUBLISH - Update global CLI:
+  npm install -g obsidian-plugin-config@latest --force
+  obsidian-inject                 # Test in current plugin dir
+  obsidian-inject ../test-plugin --sass
+
+TESTING AS PLUGIN (Optional):
+  1. Configure .env with TEST_VAULT and REAL_VAULT paths
+  2. yarn dev                     # Watch mode for development
+  3. yarn real                    # Install to real vault
+
+═══════════════════════════════════════════════════════════════════
+
+`);

package/scripts/utils.ts

@@ -1,151 +1,151 @@
-import { access, mkdir, copyFile, rm } from 'fs/promises';
-import path from 'path';
-import * as readline from 'readline';
-import { execSync } from 'child_process';
-
-export function createReadlineInterface(): readline.Interface {
-	return readline.createInterface({
-		input: process.stdin as NodeJS.ReadableStream,
-		output: process.stdout as NodeJS.WritableStream
-	});
-}
-
-export const askQuestion = async (
-	question: string,
-	rl: readline.Interface
-): Promise<string> => {
-	try {
-		return await new Promise((resolve) =>
-			rl.question(question, (input) => resolve(input.trim()))
-		);
-	} catch (error) {
-		console.error('Error asking question:', error);
-		throw error;
-	}
-};
-
-/**
- * Ask a yes/no confirmation question with standardized logic
- * Accepts: y, yes, Y, YES, or empty (default to yes)
- * Rejects: n, no, N, NO
- * Invalid input defaults to no for safety
- */
-export const askConfirmation = async (
-	question: string,
-	rl: readline.Interface
-): Promise<boolean> => {
-	const answer = await askQuestion(`${question} [Y/n]: `, rl);
-	const response = answer.toLowerCase();
-
-	// Accept: y, yes, Y, YES, or empty (default to yes)
-	// Reject: n, no, N, NO
-	const isYes = response === '' || response === 'y' || response === 'yes';
-	const isNo = response === 'n' || response === 'no';
-
-	if (isNo) {
-		return false;
-	} else if (isYes) {
-		return true;
-	} else {
-		console.log('Please answer Y (yes) or n (no). Defaulting to no for safety.');
-		return false;
-	}
-};
-
-export const cleanInput = (inputStr: string): string => {
-	if (!inputStr) return '';
-	return inputStr.trim().replace(/["`]/g, "'").replace(/\r\n/g, '\n');
-};
-
-export const isValidPath = async (pathToCheck: string): Promise<boolean> => {
-	if (!pathToCheck) return false;
-
-	try {
-		// Using async fs.access is preferred over synchronous existsSync
-		// as it doesn't block the main thread/event loop
-		await access(pathToCheck.trim());
-		return true;
-	} catch {
-		return false;
-	}
-};
-
-export async function copyFilesToTargetDir(buildPath: string): Promise<void> {
-	const pluginDir = process.cwd();
-	const manifestSrc = path.join(pluginDir, 'manifest.json');
-	const manifestDest = path.join(buildPath, 'manifest.json');
-	const cssDest = path.join(buildPath, 'styles.css');
-	const folderToRemove = path.join(buildPath, '_.._');
-
-	try {
-		await mkdir(buildPath, { recursive: true });
-	} catch (error: unknown) {
-		if ((error as NodeJS.ErrnoException).code !== 'EEXIST') {
-			console.error(`Error creating directory: ${(error as Error).message}`);
-		}
-	}
-
-	// Copy manifest
-	try {
-		await copyFile(manifestSrc, manifestDest);
-	} catch (error: unknown) {
-		console.error(`Error copying manifest: ${(error as Error).message}`);
-	}
-
-	// Copy CSS
-	try {
-		const srcStylesPath = path.join(pluginDir, 'src/styles.css');
-		const rootStylesPath = path.join(pluginDir, 'styles.css');
-
-		// First check if CSS exists in src/styles.css
-		if (await isValidPath(srcStylesPath)) {
-			await copyFile(srcStylesPath, cssDest);
-		}
-		// Otherwise, check if it exists in the root
-		else if (await isValidPath(rootStylesPath)) {
-			await copyFile(rootStylesPath, cssDest);
-			if (await isValidPath(folderToRemove)) {
-				await rm(folderToRemove, { recursive: true });
-			}
-		} else {
-			return;
-		}
-	} catch (error: unknown) {
-		console.error(`Error copying CSS: ${(error as Error).message}`);
-	}
-}
-
-export function gitExec(command: string): void {
-	try {
-		execSync(command, { stdio: 'inherit' });
-	} catch (error: unknown) {
-		console.error(`Error executing '${command}':`, (error as Error).message);
-		throw error;
-	}
-}
-
-/**
- * Ensure Git repository is synchronized with remote before pushing
- */
-export async function ensureGitSync(): Promise<void> {
-	try {
-		console.log('🔄 Checking Git synchronization...');
-
-		// Fetch latest changes from remote
-		execSync('git fetch origin', { stdio: 'pipe' });
-
-		// Check if branch is behind remote
-		const status = execSync('git status --porcelain -b', { encoding: 'utf8' });
-
-		if (status.includes('behind')) {
-			console.log('📥 Branch behind remote. Pulling changes...');
-			execSync('git pull', { stdio: 'inherit' });
-			console.log('✅ Successfully pulled remote changes');
-		} else {
-			console.log('✅ Repository is synchronized with remote');
-		}
-	} catch (error: unknown) {
-		console.error(`❌ Git sync failed: ${(error as Error).message}`);
-		throw error;
-	}
-}
+import { access, mkdir, copyFile, rm } from 'fs/promises';
+import path from 'path';
+import * as readline from 'readline';
+import { execSync } from 'child_process';
+
+export function createReadlineInterface(): readline.Interface {
+	return readline.createInterface({
+		input: process.stdin as NodeJS.ReadableStream,
+		output: process.stdout as NodeJS.WritableStream
+	});
+}
+
+export const askQuestion = async (
+	question: string,
+	rl: readline.Interface
+): Promise<string> => {
+	try {
+		return await new Promise((resolve) =>
+			rl.question(question, (input) => resolve(input.trim()))
+		);
+	} catch (error) {
+		console.error('Error asking question:', error);
+		throw error;
+	}
+};
+
+/**
+ * Ask a yes/no confirmation question with standardized logic
+ * Accepts: y, yes, Y, YES, or empty (default to yes)
+ * Rejects: n, no, N, NO
+ * Invalid input defaults to no for safety
+ */
+export const askConfirmation = async (
+	question: string,
+	rl: readline.Interface
+): Promise<boolean> => {
+	const answer = await askQuestion(`${question} [Y/n]: `, rl);
+	const response = answer.toLowerCase();
+
+	// Accept: y, yes, Y, YES, or empty (default to yes)
+	// Reject: n, no, N, NO
+	const isYes = response === '' || response === 'y' || response === 'yes';
+	const isNo = response === 'n' || response === 'no';
+
+	if (isNo) {
+		return false;
+	} else if (isYes) {
+		return true;
+	} else {
+		console.log('Please answer Y (yes) or n (no). Defaulting to no for safety.');
+		return false;
+	}
+};
+
+export const cleanInput = (inputStr: string): string => {
+	if (!inputStr) return '';
+	return inputStr.trim().replace(/["`]/g, "'").replace(/\r\n/g, '\n');
+};
+
+export const isValidPath = async (pathToCheck: string): Promise<boolean> => {
+	if (!pathToCheck) return false;
+
+	try {
+		// Using async fs.access is preferred over synchronous existsSync
+		// as it doesn't block the main thread/event loop
+		await access(pathToCheck.trim());
+		return true;
+	} catch {
+		return false;
+	}
+};
+
+export async function copyFilesToTargetDir(buildPath: string): Promise<void> {
+	const pluginDir = process.cwd();
+	const manifestSrc = path.join(pluginDir, 'manifest.json');
+	const manifestDest = path.join(buildPath, 'manifest.json');
+	const cssDest = path.join(buildPath, 'styles.css');
+	const folderToRemove = path.join(buildPath, '_.._');
+
+	try {
+		await mkdir(buildPath, { recursive: true });
+	} catch (error: unknown) {
+		if ((error as NodeJS.ErrnoException).code !== 'EEXIST') {
+			console.error(`Error creating directory: ${(error as Error).message}`);
+		}
+	}
+
+	// Copy manifest
+	try {
+		await copyFile(manifestSrc, manifestDest);
+	} catch (error: unknown) {
+		console.error(`Error copying manifest: ${(error as Error).message}`);
+	}
+
+	// Copy CSS
+	try {
+		const srcStylesPath = path.join(pluginDir, 'src/styles.css');
+		const rootStylesPath = path.join(pluginDir, 'styles.css');
+
+		// First check if CSS exists in src/styles.css
+		if (await isValidPath(srcStylesPath)) {
+			await copyFile(srcStylesPath, cssDest);
+		}
+		// Otherwise, check if it exists in the root
+		else if (await isValidPath(rootStylesPath)) {
+			await copyFile(rootStylesPath, cssDest);
+			if (await isValidPath(folderToRemove)) {
+				await rm(folderToRemove, { recursive: true });
+			}
+		} else {
+			return;
+		}
+	} catch (error: unknown) {
+		console.error(`Error copying CSS: ${(error as Error).message}`);
+	}
+}
+
+export function gitExec(command: string): void {
+	try {
+		execSync(command, { stdio: 'inherit' });
+	} catch (error: unknown) {
+		console.error(`Error executing '${command}':`, (error as Error).message);
+		throw error;
+	}
+}
+
+/**
+ * Ensure Git repository is synchronized with remote before pushing
+ */
+export async function ensureGitSync(): Promise<void> {
+	try {
+		console.log('🔄 Checking Git synchronization...');
+
+		// Fetch latest changes from remote
+		execSync('git fetch origin', { stdio: 'pipe' });
+
+		// Check if branch is behind remote
+		const status = execSync('git status --porcelain -b', { encoding: 'utf8' });
+
+		if (status.includes('behind')) {
+			console.log('📥 Branch behind remote. Pulling changes...');
+			execSync('git pull', { stdio: 'inherit' });
+			console.log('✅ Successfully pulled remote changes');
+		} else {
+			console.log('✅ Repository is synchronized with remote');
+		}
+	} catch (error: unknown) {
+		console.error(`❌ Git sync failed: ${(error as Error).message}`);
+		throw error;
+	}
+}

package/templates/.vscode/tasks.json

@@ -41,6 +41,14 @@
       "presentation": { "reveal": "always", "panel": "shared" },
       "problemMatcher": ["$tsc"]
     },
+    {
+      "label": "Obsidian Inject",
+      "type": "shell",
+      "command": "obsidian-inject",
+      "group": "build",
+      "presentation": { "reveal": "always", "panel": "shared" },
+      "problemMatcher": []
+    },
     {
       "label": "Cleanup: Lint + Prettier + Build",
       "dependsOrder": "sequence",

package/templates/package.json

@@ -41,6 +41,6 @@
     "prettier": "latest",
     "semver": "latest",
     "tsx": "latest",
-    "typescript": "latest"
+    "typescript": "^5.8.2"
   }
 }