obsidian-plugin-config 1.6.18 → 1.7.0

package/templates/scripts/acp.ts

@@ -1,83 +1,59 @@
 import { execSync } from 'child_process';
-import fs from 'fs';
-import path from 'path';
 import {
-	askQuestion,
-	cleanInput,
-	createReadlineInterface,
-	gitExec,
-	ensureGitSync
-} from './utils.js';
+  askQuestion,
+  cleanInput,
+  createReadlineInterface,
+  gitExec,
+  ensureGitSync
+} from './utils.ts';
 
 const rl = createReadlineInterface();
 
-// Check if we're in the centralized config repo
-function isInCentralizedRepo(): boolean {
-	const packageJsonPath = path.join(process.cwd(), 'package.json');
-	if (!fs.existsSync(packageJsonPath)) return false;
-
-	const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
-	return packageJson.name === 'obsidian-plugin-config';
-}
-
 async function main(): Promise<void> {
-	try {
-		if (process.argv.includes('-b')) {
-			console.log('Building...');
-			gitExec('yarn build');
-			console.log('Build successful.');
-		}
-
-		// Only update exports if we're in the centralized repo and not explicitly disabled
-		if (
-			!process.argv.includes('-ne') &&
-			!process.argv.includes('--no-exports') &&
-			isInCentralizedRepo()
-		) {
-			console.log('Updating exports...');
-			gitExec('yarn run update-exports');
-			console.log('Exports updated.');
-		}
-
-		const input: string = await askQuestion('Enter commit message: ', rl);
-
-		const cleanedInput = cleanInput(input);
-
-		try {
-			gitExec('git add -A');
-			gitExec(`git commit -m "${cleanedInput}"`);
-		} catch {
-			console.log('Commit already exists or failed.');
-			return;
-		}
-
-		// get current branch name
-		const currentBranch = execSync('git rev-parse --abbrev-ref HEAD')
-			.toString()
-			.trim();
-
-		// Ensure Git is synchronized before pushing
-		await ensureGitSync();
-
-		try {
-			gitExec(`git push origin ${currentBranch}`);
-			console.log('Commit and push successful.');
-		} catch {
-			// new branch
-			console.log(`New branch detected. Setting upstream for ${currentBranch}...`);
-			gitExec(`git push --set-upstream origin ${currentBranch}`);
-			console.log('Upstream branch set and push successful.');
-		}
-	} catch (error) {
-		console.error('Error:', error instanceof Error ? error.message : String(error));
-	} finally {
-		rl.close();
-	}
+  try {
+    if (process.argv.includes('-b')) {
+      console.log('Building...');
+      gitExec('yarn build');
+      console.log('Build successful.');
+    }
+
+    const input: string = await askQuestion('Enter commit message: ', rl);
+
+    const cleanedInput = cleanInput(input);
+
+    try {
+      gitExec('git add -A');
+      gitExec(`git commit -m "${cleanedInput}"`);
+    } catch {
+      console.log('Commit already exists or failed.');
+      return;
+    }
+
+    // get current branch name
+    const currentBranch = execSync('git rev-parse --abbrev-ref HEAD').toString().trim();
+
+    // Ensure Git is synchronized before pushing
+    await ensureGitSync();
+
+    try {
+      gitExec(`git push origin ${currentBranch}`);
+      console.log('Commit and push successful.');
+    } catch {
+      // new branch
+      console.log(`New branch detected. Setting upstream for ${currentBranch}...`);
+      gitExec(`git push --set-upstream origin ${currentBranch}`);
+      console.log('Upstream branch set and push successful.');
+    }
+  } catch (error) {
+    console.error('Error:', error instanceof Error ? error.message : String(error));
+  } finally {
+    rl.close();
+  }
 }
 
 main()
-	.catch(console.error)
-	.finally(() => {
-		console.log('Exiting...');
-		process.exit();
-	});
+  .catch(console.error)
+  .finally(() => {
+    console.log('Exiting...');
+    process.exit();
+  });

package/templates/scripts/constants.ts

@@ -0,0 +1,26 @@
+import builtins from 'builtin-modules';
+
+export 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
+];
+
+export 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
+*/`;
+
+/** The default port used by the Obsidian Local REST API plugin for HTTP. */
+export const OBSIDIAN_REST_PORT = 27123;

package/templates/scripts/env.ts

@@ -0,0 +1,94 @@
+import path from 'path';
+import { readFileSync } from 'fs';
+import fs from 'fs';
+import { type Interface } from 'readline';
+import {
+  isValidPath,
+  isInPluginsFolder,
+  getVaultPath,
+  updateEnvFile,
+  ensureEnvFile,
+  promptForVaultPath
+} from './utils.ts';
+import { config } from 'dotenv';
+
+interface Manifest {
+  id: string;
+}
+
+export type { Manifest };
+
+export function checkManifest(pluginDir: string): Manifest {
+  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);
+  }
+
+  return JSON.parse(readFileSync(manifestPath, 'utf-8'));
+}
+
+/**
+ * Check that the environment is valid
+ * - main.ts exists in src/
+ * - manifest.json exists and is valid JSON
+ */
+export async function validateEnvironment(pluginDir: string): 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');
+  }
+}
+
+/**
+ * Get the build path based on the environment and user input
+ *
+ * @Param pluginDir The plugin directory
+ * @Param manifest The manifest object
+ * @Param _isProd Whether this is a production build (true for 'production' arg, false for 'watch'/'dev')
+ * @Param rl The readline interface
+ * @return The path to build the plugin to (either the vault plugins folder or the initial folder for in-place development)
+ */
+export async function getBuildPath(
+  pluginDir: string,
+  manifest: Manifest,
+  isProd: boolean,
+  rl: Interface
+): Promise<string> {
+  // In-place development: already inside a plugins folder
+  if (isInPluginsFolder(pluginDir)) {
+    console.log('ℹ️  Building in Obsidian plugins folder (in-place development)');
+    return pluginDir;
+  }
+
+  // External development
+  const useRealVault = process.argv.includes('-r') || process.argv.includes('real');
+
+  // Production build without vault copy: build in place, no vault resolution needed
+  if (isProd && !useRealVault) {
+    return pluginDir;
+  }
+
+  const envKey = useRealVault ? 'REAL_VAULT' : 'TEST_VAULT';
+  const envPath = path.join(pluginDir, '.env');
+
+  await ensureEnvFile(envPath);
+  config(); // reload after potential creation
+
+  const vaultPath = process.env[envKey]?.trim();
+
+  // Prompt if missing or still a placeholder
+  if (!vaultPath || vaultPath.startsWith('/path/to/your/')) {
+    const newPath = await promptForVaultPath(envKey, rl);
+    await updateEnvFile(envKey, newPath, envPath);
+    config();
+    return getVaultPath(newPath, manifest.id);
+  }
+
+  return getVaultPath(vaultPath, manifest.id);
+}