obsidian-plugin-config 1.6.17 → 1.7.0

package/templates/scripts/esbuild.config.ts

@@ -1,310 +1,157 @@
 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 { type Interface } from 'readline';
+import { obsidianTypingsPlugin } from './typingsPlugin.ts';
+import { EXTERNAL_DEPS, BANNER } from './constants.ts';
 import {
-	isValidPath,
-	copyFilesToTargetDir,
-	askQuestion,
-	createReadlineInterface,
-	removeMainCss
-} from './utils.js';
+  type Manifest,
+  checkManifest,
+  validateEnvironment,
+  getBuildPath
+} from './env.ts';
+import {
+  copyFilesToTargetDir,
+  createReadlineInterface,
+  isValidPath,
+  removeMainCss
+} from './utils.ts';
+import { reloadObsidian } from './reload.ts';
 
 // 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 rl: Interface = createReadlineInterface();
 
-const manifest = JSON.parse(readFileSync(manifestPath, 'utf-8'));
+const manifest: Manifest = checkManifest(pluginDir);
 
 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're already inside an Obsidian plugins folder
-	const pluginsPath = path.join('.obsidian', 'plugins');
-	const isInPluginsFolder = pluginDir.includes(pluginsPath);
-
-	if (isInPluginsFolder) {
-		console.log('ℹ️  Building in Obsidian plugins folder (in-place development)');
-		return pluginDir;
-	}
-
-	// External development: check for vault paths
-	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, prompt for vault path
-	if (!vaultPath || vaultPath.startsWith('/path/to/your/')) {
-		const newPath = await promptForVaultPath(envKey);
-		await updateEnvFile(envKey, newPath);
-		config();
-		return getVaultPath(newPath);
-	}
-
-	return getVaultPath(vaultPath);
-}
-
 async function createBuildContext(
-	buildPath: string,
-	isProd: boolean,
-	entryPoints: string[],
-	hasSass: boolean
+  buildPath: string,
+  isProd: boolean,
+  entryPoints: string[],
+  hasSass: boolean
 ): Promise<esbuild.BuildContext> {
-	const plugins = [
-		// Add SASS plugin if SCSS files are detected
-		...(hasSass
-			? [
-					await (async () => {
-						try {
-							// @ts-expect-error - esbuild-sass-plugin is installed during injection
-							const { sassPlugin } = await import('esbuild-sass-plugin');
-							return sassPlugin({
-								syntax: 'scss',
-								style: 'expanded'
-							});
-						} catch (error) {
-							console.warn(
-								'⚠️  esbuild-sass-plugin not found. Install it with: yarn add -D esbuild-sass-plugin'
-							);
-							throw error;
-						}
-					})(),
-					{
-						name: 'remove-main-css',
-						setup(build: esbuild.PluginBuild): void {
-							build.onEnd(async (result) => {
-								if (result.errors.length === 0) {
-									await removeMainCss(buildPath);
-								}
-							});
-						}
-					}
-				]
-			: []),
-		{
-			name: 'copy-to-plugins-folder',
-			setup: (build: esbuild.PluginBuild): 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);
-					}
-				});
-			}
-		}
-	];
-
-	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
-	});
+  const plugins = [
+    // Add SASS plugin if SCSS files are detected
+    ...(hasSass
+      ? [
+          await (async () => {
+            try {
+              // @ts-expect-error - esbuild-sass-plugin is installed during injection
+              const { sassPlugin } = await import('esbuild-sass-plugin');
+              return sassPlugin({
+                syntax: 'scss',
+                style: 'expanded'
+              });
+            } catch (error) {
+              console.warn(
+                '⚠️  esbuild-sass-plugin not found. Install it with: yarn add -D esbuild-sass-plugin'
+              );
+              throw error;
+            }
+          })(),
+          {
+            name: 'remove-main-css',
+            setup(build: esbuild.PluginBuild): void {
+              build.onEnd(async (result) => {
+                if (result.errors.length === 0) {
+                  await removeMainCss(buildPath);
+                }
+              });
+            }
+          }
+        ]
+      : []),
+    {
+      name: 'copy-to-plugins-folder',
+      setup: (build: esbuild.PluginBuild): 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}`);
+              await reloadObsidian();
+            } else {
+              const folderToRemove = path.join(buildPath, '_.._');
+              if (await isValidPath(folderToRemove)) {
+                await rm(folderToRemove, { recursive: true });
+              }
+              console.log('Build done in initial folder');
+            }
+          }
+          // if watch (dev)
+          else {
+            await copyFilesToTargetDir(buildPath);
+          }
+        });
+      }
+    }
+  ];
+
+  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: [obsidianTypingsPlugin(pluginDir), ...plugins]
+  });
 }
 
 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}`
-		);
-
-		// Check for SCSS first, then CSS in src, then in root
-		const srcStylesScssPath = path.join(pluginDir, 'src/styles.scss');
-		const srcStylesPath = path.join(pluginDir, 'src/styles.css');
-		const rootStylesPath = path.join(pluginDir, 'styles.css');
-
-		const scssExists = await isValidPath(srcStylesScssPath);
-		const stylePath = scssExists
-			? srcStylesScssPath
-			: (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,
-			scssExists
-		);
-
-		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);
-	}
+  try {
+    await validateEnvironment(pluginDir);
+    const isProd = process.argv[2] === 'production';
+    const buildPath = await getBuildPath(pluginDir, manifest, isProd, rl);
+    console.log(
+      buildPath === pluginDir ? 'Building in initial folder' : `Building in ${buildPath}`
+    );
+
+    // Check for SCSS first, then CSS in src, then in root
+    const srcStylesScssPath = path.join(pluginDir, 'src/styles.scss');
+    const srcStylesPath = path.join(pluginDir, 'src/styles.css');
+    const rootStylesPath = path.join(pluginDir, 'styles.css');
+
+    const scssExists = await isValidPath(srcStylesScssPath);
+    const stylePath = scssExists
+      ? srcStylesScssPath
+      : (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, scssExists);
+
+    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/templates/scripts/release.ts

@@ -1,113 +1,118 @@
 import { writeFile, stat } from 'fs/promises';
 import { execSync } from 'child_process';
 import dedent from 'dedent';
-import { askConfirmation, createReadlineInterface, ensureGitSync } from './utils.js';
+import { join } from 'path';
+import {
+  askConfirmation,
+  askQuestion,
+  createReadlineInterface,
+  ensureGitSync
+} from './utils.ts';
 
 const rl = createReadlineInterface();
 
-const body = '.github/workflows/release-body.md';
+const body = join('.github', 'workflows', 'release-body.md');
 
 async function checkOrCreateFile(filename: string): Promise<void> {
-	try {
-		await stat(filename);
-	} catch {
-		console.log(`Creating ${filename} because it doesn't exist. Avoid deleting it.`);
-		await writeFile(filename, '');
-	}
+  try {
+    await stat(filename);
+  } catch {
+    console.log(`Creating ${filename} because it doesn't exist. Avoid deleting it.`);
+    await writeFile(filename, '');
+  }
 }
 
 async function createReleaseNotesFile(tagMessage: string, tag: string): Promise<void> {
-	await writeFile(body, tagMessage);
-	console.log(`Release notes for tag ${tag} have been written to release-body.md`);
+  await writeFile(body, tagMessage);
+  console.log(`Release notes for tag ${tag} have been written to release-body.md`);
 }
 
 async function handleExistingTag(tag: string): Promise<boolean> {
-	// Get the existing tag message to show to the user
-	let existingMessage = '';
-	try {
-		existingMessage = execSync(`git tag -l -n999 ${tag}`, {
-			encoding: 'utf8'
-		}).trim();
-	} catch {
-		// If we can't get the message, continue anyway
-	}
-
-	let prompt = `Tag ${tag} already exists.`;
-	if (existingMessage) {
-		prompt += `\n\nExisting tag message:\n${existingMessage}\n`;
-	}
-	prompt += `\nDo you want to replace it?`;
-
-	const confirmed = await askConfirmation(prompt, rl);
-
-	if (!confirmed) {
-		console.log('Operation aborted');
-		return false;
-	}
-
-	execSync(`git tag -d ${tag}`);
-	execSync(`git push origin :refs/tags/${tag}`);
-	console.log(`Deleted existing tag ${tag} locally and remotely.`);
-	return true;
+  // Get the existing tag message to show to the user
+  let existingMessage = '';
+  try {
+    existingMessage = execSync(`git tag -l -n999 ${tag}`, {
+      encoding: 'utf8'
+    }).trim();
+  } catch {
+    // If we can't get the message, continue anyway
+  }
+
+  let prompt = `Tag ${tag} already exists.`;
+  if (existingMessage) {
+    prompt += `\n\nExisting tag message:\n${existingMessage}\n`;
+  }
+  prompt += `\nDo you want to replace it?`;
+
+  const confirmed = await askConfirmation(prompt, rl);
+
+  if (!confirmed) {
+    console.log('Operation aborted');
+    return false;
+  }
+
+  execSync(`git tag -d ${tag}`);
+  execSync(`git push origin :refs/tags/${tag}`);
+  console.log(`Deleted existing tag ${tag} locally and remotely.`);
+  return true;
 }
 
 async function createTag(): Promise<void> {
-	const currentVersion = process.env.npm_package_version;
-	const tag = `${currentVersion}`;
-
-	await checkOrCreateFile(body);
-	const exists = execSync('git ls-remote --tags origin')
-		.toString()
-		.includes(`refs/tags/${tag}`);
-
-	if (exists && !(await handleExistingTag(tag))) {
-		rl.close();
-		return;
-	}
-	await doCommit(currentVersion, tag);
+  const currentVersion = process.env.npm_package_version;
+  const tag = `${currentVersion}`;
+
+  await checkOrCreateFile(body);
+  const exists = execSync('git ls-remote --tags origin')
+    .toString()
+    .includes(`refs/tags/${tag}`);
+
+  if (exists && !(await handleExistingTag(tag))) {
+    rl.close();
+    return;
+  }
+  await doCommit(currentVersion, tag);
 }
 
 async function doCommit(currentVersion: string | undefined, tag: string): Promise<void> {
-	rl.question(
-		`Enter the commit message for version ${currentVersion}: `,
-		async (message) => {
-			doNextSteps(message, tag);
-			rl.close();
-		}
-	);
+  const message = await askQuestion(
+    `Enter the commit message for version ${currentVersion}: `,
+    rl
+  );
+  rl.close();
+  await doNextSteps(message, tag);
 }
 
 async function doNextSteps(message: string, tag: string): Promise<void> {
-	const messages = message.split('\\n');
-	const toShow = message.replace(/\\n/g, '\n');
-	await createReleaseNotesFile(toShow, tag);
-	const tagMessage = messages.map((m) => `-m "${m}"`).join(' ');
-
-	try {
-		execSync('git add -A');
-		execSync('git commit -m "update tag description"');
-
-		// Ensure Git is synchronized before pushing
-		await ensureGitSync();
-
-		execSync('git push');
-	} catch (error: unknown) {
-		console.error('Error:', error instanceof Error ? error.message : String(error));
-	}
-	try {
-		execSync(`git tag -a ${tag} ${tagMessage}`);
-	} catch {
-		execSync(`git tag -d ${tag}`);
-		execSync(`git push origin :refs/tags/${tag}`);
-		console.log('Fixed');
-		execSync(`git tag -a ${tag} ${tagMessage}`);
-	}
-	// Ensure Git is synchronized before pushing tag
-	await ensureGitSync();
-
-	execSync(`git push origin ${tag}`);
-	console.log(`Release ${tag} pushed to repo.`);
-	console.log(dedent`
+  const messages = message.split('\\n');
+  const toShow = message.replace(/\\n/g, '\n');
+  await createReleaseNotesFile(toShow, tag);
+  const tagMessage = messages.map((m) => `-m "${m}"`).join(' ');
+
+  try {
+    execSync('git add -A');
+    execSync('git commit -m "update tag description"');
+
+    // Ensure Git is synchronized before pushing
+    await ensureGitSync();
+
+    execSync('git push');
+  } catch (error: unknown) {
+    console.error('Error:', error instanceof Error ? error.message : String(error));
+  }
+  try {
+    execSync(`git tag -a ${tag} ${tagMessage}`);
+  } catch {
+    execSync(`git tag -d ${tag}`);
+    execSync(`git push origin :refs/tags/${tag}`);
+    console.log('Fixed');
+    execSync(`git tag -a ${tag} ${tagMessage}`);
+  }
+  // Ensure Git is synchronized before pushing tag
+  await ensureGitSync();
+
+  execSync(`git push origin ${tag}`);
+  console.log(`Release ${tag} pushed to repo.`);
+  console.log(dedent`
         with message:
             ${toShow}
     `);