obsidian-plugin-config 1.5.12 → 1.6.1

package/scripts/esbuild.config.ts

@@ -1,268 +0,0 @@
-import esbuild from 'esbuild';
-import process from 'process';
-import builtins from 'builtin-modules';
-import { config } from 'dotenv';
-import path from 'path';
-import { readFileSync } from 'fs';
-import { rm } from 'fs/promises';
-import fs from 'fs';
-import {
-	isValidPath,
-	copyFilesToTargetDir,
-	askQuestion,
-	createReadlineInterface
-} from './utils.js';
-
-// Determine the plugin directory (where the script is called from)
-const pluginDir = process.cwd();
-
-// Create readline interface for prompts
-const rl = createReadlineInterface();
-
-async function promptForVaultPath(envKey: string): Promise<string> {
-	const vaultType = envKey === 'REAL_VAULT' ? 'real' : 'test';
-	const usage =
-		envKey === 'REAL_VAULT'
-			? 'for final plugin installation'
-			: 'for development and testing';
-
-	console.log(`❓ ${envKey} path is required ${usage}`);
-	const path = await askQuestion(
-		`📝 Enter your ${vaultType} vault path (or Ctrl+C to cancel): `,
-		rl
-	);
-
-	if (!path) {
-		console.log('❌ No path provided, exiting...');
-		process.exit(1);
-	}
-
-	return path;
-}
-
-async function updateEnvFile(envKey: string, vaultPath: string): Promise<void> {
-	const envPath = path.join(pluginDir, '.env');
-	let envContent = '';
-
-	// Read existing .env if it exists
-	try {
-		envContent = readFileSync(envPath, 'utf8');
-	} catch {
-		// File doesn't exist, start with empty content
-	}
-
-	// Update or add the variable
-	const regex = new RegExp(`^${envKey}=.*$`, 'm');
-	const newLine = `${envKey}=${vaultPath}`;
-
-	if (regex.test(envContent)) {
-		envContent = envContent.replace(regex, newLine);
-	} else {
-		envContent += envContent.endsWith('\n') ? '' : '\n';
-		envContent += newLine + '\n';
-	}
-
-	// Write back to .env
-	await import('fs').then((fs) => fs.writeFileSync(envPath, envContent));
-	console.log(`✅ Updated ${envKey} in .env file`);
-}
-
-function validateVaultPath(vaultPath: string): boolean {
-	// Check if the path contains .obsidian directory
-	const obsidianPath = path.join(vaultPath, '.obsidian');
-	const pluginsPath = path.join(vaultPath, '.obsidian', 'plugins');
-
-	return fs.existsSync(obsidianPath) && fs.existsSync(pluginsPath);
-}
-
-function getVaultPath(vaultPath: string): string {
-	// Validate that this is a proper vault path
-	if (!validateVaultPath(vaultPath)) {
-		console.error(`❌ Invalid vault path: ${vaultPath}`);
-		console.error(`   The path must contain a .obsidian/plugins directory`);
-		console.error(`   Please enter a valid Obsidian vault path`);
-		process.exit(1);
-	}
-
-	// Check if the path already contains the plugins directory path
-	const pluginsPath = path.join('.obsidian', 'plugins');
-	if (vaultPath.includes(pluginsPath)) {
-		return path.join(vaultPath, manifest.id);
-	} else {
-		return path.join(vaultPath, '.obsidian', 'plugins', manifest.id);
-	}
-}
-const manifestPath = path.join(pluginDir, 'manifest.json');
-
-// Check if manifest exists (for plugin-config itself, it might not exist)
-if (!fs.existsSync(manifestPath)) {
-	console.log(
-		'⚠️  No manifest.json found - this script is designed for Obsidian plugins'
-	);
-	console.log("   If you're building plugin-config itself, use 'tsc' instead");
-	process.exit(0);
-}
-
-const manifest = JSON.parse(readFileSync(manifestPath, 'utf-8'));
-
-config();
-
-const EXTERNAL_DEPS = [
-	'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
-];
-
-const BANNER = `/*
-THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
-if you want to view the source, please visit the github repository of this plugin
-*/`;
-
-async function validateEnvironment(): Promise<void> {
-	const srcMainPath = path.join(pluginDir, 'src/main.ts');
-	if (!(await isValidPath(srcMainPath))) {
-		throw new Error(
-			'Invalid path for src/main.ts. main.ts must be in the src directory'
-		);
-	}
-	if (!(await isValidPath(manifestPath))) {
-		throw new Error('Invalid path for manifest.json');
-	}
-}
-
-async function getBuildPath(isProd: boolean): Promise<string> {
-	// Check if we should use real vault (either -r flag or "real" argument)
-	const useRealVault = process.argv.includes('-r') || process.argv.includes('real');
-
-	// If production build without redirection, return plugin directory
-	if (isProd && !useRealVault) {
-		return pluginDir;
-	}
-
-	// Determine which path to use
-	const envKey = useRealVault ? 'REAL_VAULT' : 'TEST_VAULT';
-	const vaultPath = process.env[envKey]?.trim();
-
-	// If empty or undefined, we're already in the plugin folder
-	if (!vaultPath) {
-		// Check if we're in Obsidian plugins folder
-		const currentPath = process.cwd();
-		const isInObsidianPlugins =
-			currentPath.includes('.obsidian/plugins') ||
-			currentPath.includes('.obsidian\\plugins');
-
-		if (isInObsidianPlugins) {
-			// In obsidian/plugins: allow in-place development
-			console.log(`ℹ️  Building in Obsidian plugins folder (in-place development)`);
-			return pluginDir;
-		} else {
-			// External development: prompt for missing vault path
-			const newPath = await promptForVaultPath(envKey);
-			await updateEnvFile(envKey, newPath);
-			config();
-			return getVaultPath(newPath);
-		}
-	}
-
-	// If we reach here, use the vault path directly
-	return getVaultPath(vaultPath);
-}
-
-async function createBuildContext(
-	buildPath: string,
-	isProd: boolean,
-	entryPoints: string[]
-): Promise<esbuild.BuildContext> {
-	return await esbuild.context({
-		banner: { js: BANNER },
-		minify: isProd,
-		entryPoints,
-		bundle: true,
-		external: EXTERNAL_DEPS,
-		format: 'cjs',
-		target: 'esNext',
-		platform: 'node',
-		logLevel: 'info',
-		sourcemap: isProd ? false : 'inline',
-		treeShaking: true,
-		outdir: buildPath,
-		outbase: path.join(pluginDir, 'src'),
-		plugins: [
-			{
-				name: 'copy-to-plugins-folder',
-				setup: (build): void => {
-					build.onEnd(async () => {
-						// if real or build
-						if (isProd) {
-							if (
-								process.argv.includes('-r') ||
-								process.argv.includes('real')
-							) {
-								await copyFilesToTargetDir(buildPath);
-								console.log(`Successfully installed in ${buildPath}`);
-							} else {
-								const folderToRemove = path.join(buildPath, '_.._');
-								if (await isValidPath(folderToRemove)) {
-									await rm(folderToRemove, { recursive: true });
-								}
-								console.log('Built done in initial folder');
-							}
-						}
-						// if watch (dev)
-						else {
-							await copyFilesToTargetDir(buildPath);
-						}
-					});
-				}
-			}
-		]
-	});
-}
-
-async function main(): Promise<void> {
-	try {
-		await validateEnvironment();
-		const isProd = process.argv[2] === 'production';
-		const buildPath = await getBuildPath(isProd);
-		console.log(
-			buildPath === pluginDir
-				? 'Building in initial folder'
-				: `Building in ${buildPath}`
-		);
-		const srcStylesPath = path.join(pluginDir, 'src/styles.css');
-		const rootStylesPath = path.join(pluginDir, 'styles.css');
-		const stylePath = (await isValidPath(srcStylesPath))
-			? srcStylesPath
-			: (await isValidPath(rootStylesPath))
-				? rootStylesPath
-				: '';
-		const mainTsPath = path.join(pluginDir, 'src/main.ts');
-		const entryPoints = stylePath ? [mainTsPath, stylePath] : [mainTsPath];
-		const context = await createBuildContext(buildPath, isProd, entryPoints);
-
-		if (isProd) {
-			await context.rebuild();
-			rl.close();
-			process.exit(0);
-		} else {
-			await context.watch();
-		}
-	} catch (error) {
-		console.error('Build failed:', error);
-		rl.close();
-		process.exit(1);
-	}
-}
-
-main().catch(console.error);

package/scripts/sync-template-deps.ts

@@ -1,59 +0,0 @@
-#!/usr/bin/env tsx
-
-import fs from 'fs';
-import path from 'path';
-
-const TEMPLATES_PKG = 'templates/package.json';
-const TEMPLATES_SASS = 'templates/package-sass.json';
-
-function resolvedVersion(dep: string): string | null {
-	const pkgPath = path.join('node_modules', dep, 'package.json');
-	if (!fs.existsSync(pkgPath)) return null;
-	try {
-		return JSON.parse(fs.readFileSync(pkgPath, 'utf8')).version as string;
-	} catch {
-		return null;
-	}
-}
-
-function updateDeps(deps: Record<string, string>): { updated: string[] } {
-	const updated: string[] = [];
-
-	for (const dep of Object.keys(deps)) {
-		const current = deps[dep];
-		// Skip wildcards like "*"
-		if (current === '*') continue;
-
-		const resolved = resolvedVersion(dep);
-		if (!resolved) continue;
-
-		// Keep "latest" as-is, update pinned/range versions
-		if (current !== 'latest') {
-			const newVersion = `^${resolved}`;
-			if (deps[dep] !== newVersion) {
-				deps[dep] = newVersion;
-				updated.push(`${dep}: ${current} → ${newVersion}`);
-			}
-		}
-	}
-
-	return { updated };
-}
-
-function syncFile(filePath: string): void {
-	const pkg = JSON.parse(fs.readFileSync(filePath, 'utf8'));
-	const { updated } = updateDeps(pkg.devDependencies ?? {});
-
-	if (updated.length) {
-		fs.writeFileSync(filePath, JSON.stringify(pkg, null, 2) + '\n', 'utf8');
-		console.log(`\n✅ ${filePath}`);
-		for (const u of updated) console.log(`   ${u}`);
-	} else {
-		console.log(`\n✅ ${filePath} — already up to date`);
-	}
-}
-
-console.log('🔄 Syncing template deps from node_modules...');
-syncFile(TEMPLATES_PKG);
-syncFile(TEMPLATES_SASS);
-console.log('\n✅ Done.');

package/scripts/update-exports.js

@@ -1,82 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-// Get current directory (equivalent to __dirname in CommonJS)
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-/**
- * Scans the src directory for subdirectories with index.ts files
- * and generates the main index.ts with appropriate exports
- */
-function updateExports() {
-  console.log('🔄 Updating exports...');
-
-  const srcDir = path.join(__dirname, '../src');
-  const mainIndexPath = path.join(srcDir, 'index.ts');
-
-  try {
-    // Check if src directory exists
-    if (!fs.existsSync(srcDir)) {
-      console.error('❌ src directory not found');
-      return;
-    }
-
-    // Get all subdirectories in src/
-    const items = fs.readdirSync(srcDir, { withFileTypes: true });
-    const subdirs = items
-      .filter(item => item.isDirectory())
-      .map(item => item.name);
-
-    // Find subdirectories that have an index.ts file
-    const exportsToGenerate = [];
-
-    for (const subdir of subdirs) {
-      const subdirPath = path.join(srcDir, subdir);
-      const indexPath = path.join(subdirPath, 'index.ts');
-
-      if (fs.existsSync(indexPath)) {
-        exportsToGenerate.push(subdir);
-        console.log(`✅ Found exportable module: ${subdir}`);
-      }
-    }
-
-    // Generate the export statements
-    const exportStatements = exportsToGenerate
-      .map(subdir => `export * from './${subdir}/index.js';`)
-      .join('\n');
-
-    // Add header comment
-    const fileContent = `// Auto-generated exports - DO NOT EDIT MANUALLY
-// Run 'npm run update-exports' to regenerate this file
-
-${exportStatements}
-`;
-
-    // Write the main index.ts file
-    fs.writeFileSync(mainIndexPath, fileContent, 'utf8');
-
-    // Update package.json exports
-    const packageJsonPath = path.join(__dirname, '../package.json');
-    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
-
-    // Generate exports object
-    const exportsObj = { ".": "./src/index.ts" };
-    packageJson.exports = exportsObj;
-
-    // Write updated package.json
-    fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2), 'utf8');
-
-    console.log(`✅ Updated ${mainIndexPath}`);
-    console.log(`✅ Updated ${packageJsonPath} exports`);
-    console.log(`📦 Generated ${exportsToGenerate.length} export(s): ${exportsToGenerate.join(', ')}`);
-
-  } catch (error) {
-    console.error('❌ Error updating exports:', error.message);
-    process.exit(1);
-  }
-}
-
-// Run the function
-updateExports();

package/src/index.ts

@@ -1,6 +0,0 @@
-// Auto-generated exports - DO NOT EDIT MANUALLY
-// Run 'npm run update-exports' to regenerate this file
-
-export * from './modals/index.js';
-export * from './tools/index.js';
-export * from './utils/index.js';

package/src/main.ts

@@ -1,117 +0,0 @@
-import type { App } from 'obsidian';
-import { Plugin, PluginSettingTab, Setting, Notice } from 'obsidian';
-import { showConfirmModal } from './modals/GenericConfirmModal.ts';
-// import { showTestMessage, getRandomEmoji } from "obsidian-plugin-config/tools";
-
-interface MyPluginSettings {
-	mySetting: string;
-}
-
-const DEFAULT_SETTINGS: MyPluginSettings = {
-	mySetting: 'default'
-};
-
-export default class ObsidianPluginConfigPlugin extends Plugin {
-	settings: MyPluginSettings;
-
-	async onload(): Promise<void> {
-		console.debug('Loading obsidian-plugin-config plugin for testing NPM exports');
-		await this.loadSettings();
-
-		this.addCommand({
-			id: 'show-confirmation-modal',
-			name: 'Test Confirmation Modal (Local)',
-			callback: () => this.showConfirmationModal()
-		});
-
-		this.addCommand({
-			id: 'show-centralized-modal',
-			name: 'Test Confirmation Modal (Centralized)',
-			callback: () => this.showCentralizedModal()
-		});
-
-		this.addCommand({
-			id: 'test-tools',
-			name: 'Test Centralized Tools',
-			callback: () => {
-				// const message = showTestMessage();
-				// const emoji = getRandomEmoji();
-				new Notice(`🎯 Test centralized tools (commented for autonomous mode)`);
-			}
-		});
-
-		this.addSettingTab(new PluginConfigSettingTab(this.app, this));
-	}
-
-	private showConfirmationModal(): void {
-		showConfirmModal(this.app, {
-			title: 'Confirmation requise',
-			message:
-				'Êtes-vous sûr de vouloir effectuer cette action ? Cette action ne peut pas être annulée.',
-			confirmText: 'Confirmer',
-			cancelText: 'Annuler',
-			onConfirm: () => {
-				new Notice('Action confirmée !');
-			},
-			onCancel: () => {
-				new Notice('Action annulée.');
-			}
-		});
-	}
-
-	private showCentralizedModal(): void {
-		showConfirmModal(this.app, {
-			title: 'Centralized Modal Test',
-			message:
-				'This modal comes from the centralized configuration! Pretty cool, right?',
-			confirmText: 'Awesome!',
-			cancelText: 'Not bad',
-			onConfirm: () => {
-				new Notice('Centralized modal confirmed! 🎉');
-			},
-			onCancel: () => {
-				new Notice('Centralized modal cancelled 😢');
-			}
-		});
-	}
-
-	async loadSettings(): Promise<void> {
-		this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
-	}
-
-	async saveSettings(): Promise<void> {
-		await this.saveData(this.settings);
-	}
-}
-
-class PluginConfigSettingTab extends PluginSettingTab {
-	plugin: ObsidianPluginConfigPlugin;
-
-	constructor(app: App, plugin: ObsidianPluginConfigPlugin) {
-		super(app, plugin);
-		this.plugin = plugin;
-	}
-
-	display(): void {
-		const { containerEl } = this;
-		containerEl.empty();
-
-		containerEl.createEl('h2', { text: 'Obsidian Plugin Config Settings' });
-		containerEl.createEl('p', {
-			text: 'This plugin is used for testing NPM exports and development of the obsidian-plugin-config system.'
-		});
-
-		new Setting(containerEl)
-			.setName('Test Setting')
-			.setDesc('A test setting for development purposes')
-			.addText((text) =>
-				text
-					.setPlaceholder('Enter test value')
-					.setValue(this.plugin.settings.mySetting)
-					.onChange(async (value) => {
-						this.plugin.settings.mySetting = value;
-						await this.plugin.saveSettings();
-					})
-			);
-	}
-}

package/src/modals/GenericConfirmModal.ts

@@ -1,79 +0,0 @@
-import type { App } from 'obsidian';
-import { Modal } from 'obsidian';
-
-export interface ConfirmModalOptions {
-	title: string;
-	message: string;
-	confirmText?: string;
-	cancelText?: string;
-	onConfirm: () => void;
-	onCancel?: () => void;
-}
-
-export class GenericConfirmModal extends Modal {
-	private options: ConfirmModalOptions;
-
-	constructor(app: App, options: ConfirmModalOptions) {
-		super(app);
-		this.options = options;
-	}
-
-	onOpen(): void {
-		const { contentEl } = this;
-		contentEl.empty();
-
-		const title =
-			this.options.title.charAt(0).toUpperCase() + this.options.title.slice(1);
-		contentEl.createEl('h2', { text: title });
-
-		// Message
-		contentEl.createEl('p', { text: this.options.message });
-
-		// Buttons container
-		const buttonContainer = contentEl.createDiv('modal-button-container');
-
-		// Cancel button
-		const cancelBtn = buttonContainer.createEl('button', {
-			text: this.options.cancelText || 'Cancel',
-			cls: 'mod-cta'
-		});
-		cancelBtn.addEventListener('click', () => {
-			this.options.onCancel?.();
-			this.close();
-		});
-
-		// Confirm button
-		const confirmBtn = buttonContainer.createEl('button', {
-			text: this.options.confirmText || 'Confirm',
-			cls: 'mod-cta mod-warning'
-		});
-		confirmBtn.addEventListener('click', () => {
-			this.options.onConfirm();
-			this.close();
-		});
-
-		// Focus on confirm button
-		confirmBtn.focus();
-	}
-
-	onClose(): void {
-		const { contentEl } = this;
-		contentEl.empty();
-	}
-}
-
-// Utility function for quick usage
-export function showConfirmModal(app: App, options: ConfirmModalOptions): void {
-	new GenericConfirmModal(app, options).open();
-}
-
-export async function confirmation(app: App, message: string): Promise<boolean> {
-	return new Promise((resolve) => {
-		new GenericConfirmModal(app, {
-			title: 'Confirm',
-			message,
-			onConfirm: () => resolve(true),
-			onCancel: () => resolve(false)
-		}).open();
-	});
-}

package/src/modals/index.ts

@@ -1,7 +0,0 @@
-// Export all modals for easy importing
-export {
-	GenericConfirmModal,
-	showConfirmModal,
-	confirmation
-} from './GenericConfirmModal.js';
-export type { ConfirmModalOptions } from './GenericConfirmModal.js';

package/src/tools/index.ts

@@ -1,9 +0,0 @@
-// Simple tools for testing
-export function showTestMessage(): string {
-	return '✅ CENTRALIZED TOOLS WORK! This comes from obsidian-plugin-config!';
-}
-
-export function getRandomEmoji(): string {
-	const emojis = ['🚀', '🎉', '✨', '🔥', '💯', '⚡', '🎯', '🌟'];
-	return emojis[Math.floor(Math.random() * emojis.length)];
-}