obsidian-plugin-config 1.6.18 → 1.7.1

package/scripts/update-version-config.ts

@@ -1,13 +1,40 @@
 import { readFile, writeFile } from 'fs/promises';
 import dedent from 'dedent';
-import { inc, valid } from 'semver';
-import { createReadlineInterface, askQuestion, gitExec } from './utils.js';
+import { askQuestion, createReadlineInterface, gitExec, ensureGitSync } from './utils.ts';
+
+// Simple version increment functions to avoid semver compatibility issues
+function incrementVersion(version: string, type: 'patch' | 'minor' | 'major'): string {
+  const parts = version.split('.').map(Number);
+  if (parts.length !== 3) return '';
+
+  switch (type) {
+    case 'patch':
+      parts[2]++;
+      break;
+    case 'minor':
+      parts[1]++;
+      parts[2] = 0;
+      break;
+    case 'major':
+      parts[0]++;
+      parts[1] = 0;
+      parts[2] = 0;
+      break;
+  }
+
+  return parts.join('.');
+}
+
+function isValidVersion(version: string): boolean {
+  const versionRegex = /^\d+\.\d+\.\d+$/;
+  return versionRegex.test(version);
+}
 
 const rl = createReadlineInterface();
 
 async function getTargetVersion(currentVersion: string): Promise<string> {
-	const updateType = await askQuestion(
-		dedent`
+  const updateType = await askQuestion(
+    dedent`
         Current version: ${currentVersion}
         Kind of update:
             patch(1.0.1) -> type 1 or p
@@ -15,100 +42,105 @@ async function getTargetVersion(currentVersion: string): Promise<string> {
             major(2.0.0) -> type 3 or maj
             or version number (e.g. 2.0.0)
         Enter choice: `,
-		rl
-	);
-
-	switch (updateType.trim()) {
-		case 'p':
-		case '1':
-			return inc(currentVersion, 'patch') || '';
-		case 'min':
-		case '2':
-			return inc(currentVersion, 'minor') || '';
-		case 'maj':
-		case '3':
-			return inc(currentVersion, 'major') || '';
-		default:
-			return valid(updateType.trim()) || '';
-	}
+    rl
+  );
+
+  switch (updateType.trim()) {
+    case 'p':
+    case '1':
+      return incrementVersion(currentVersion, 'patch');
+    case 'min':
+    case '2':
+      return incrementVersion(currentVersion, 'minor');
+    case 'maj':
+    case '3':
+      return incrementVersion(currentVersion, 'major');
+    default: {
+      const trimmed = updateType.trim();
+      return isValidVersion(trimmed) ? trimmed : '';
+    }
+  }
 }
 
 async function updateJsonFile(
-	filename: string,
-	updateFn: (json: Record<string, unknown>) => void
+  filename: string,
+  updateFn: (json: Record<string, unknown>) => void
 ): Promise<void> {
-	try {
-		const content = JSON.parse(await readFile(filename, 'utf8'));
-		updateFn(content);
-		await writeFile(filename, JSON.stringify(content, null, '  '));
-	} catch (error) {
-		console.error(
-			`Error updating ${filename}:`,
-			error instanceof Error ? error.message : String(error)
-		);
-		throw error;
-	}
+  try {
+    const content = JSON.parse(await readFile(filename, 'utf8'));
+    updateFn(content);
+    await writeFile(filename, JSON.stringify(content, null, '  '));
+  } catch (error) {
+    console.error(
+      `Error updating ${filename}:`,
+      error instanceof Error ? error.message : String(error)
+    );
+    throw error;
+  }
 }
 
-async function updateConfigVersions(targetVersion: string): Promise<void> {
-	try {
-		await updateJsonFile('package.json', (json) => (json.version = targetVersion));
-	} catch (error) {
-		console.error(
-			'Error updating config versions:',
-			error instanceof Error ? error.message : String(error)
-		);
-		throw error;
-	}
+async function updatePackageVersion(targetVersion: string): Promise<void> {
+  try {
+    await updateJsonFile('package.json', (json) => (json.version = targetVersion));
+  } catch (error) {
+    console.error(
+      'Error updating package.json version:',
+      error instanceof Error ? error.message : String(error)
+    );
+    throw error;
+  }
 }
 
 async function updateVersion(): Promise<void> {
-	try {
-		const currentVersion = process.env.npm_package_version || '1.0.0';
-		const targetVersion = await getTargetVersion(currentVersion);
-
-		if (!targetVersion) {
-			console.log('Invalid version');
-			return;
-		}
-
-		try {
-			// Update all files first
-			await updateConfigVersions(targetVersion);
-			console.log(`Files updated to version ${targetVersion}`);
-
-			// Add files to git
-			gitExec('git add package.json');
-			gitExec(`git commit -m "Updated to version ${targetVersion}"`);
-			console.log('Changes committed');
-		} catch (error) {
-			console.error(
-				'Error during update or commit:',
-				error instanceof Error ? error.message : String(error)
-			);
-			console.log('Operation failed.');
-			return;
-		}
-
-		try {
-			gitExec('git push');
-			console.log(`Version successfully updated to ${targetVersion} and pushed.`);
-		} catch (pushError) {
-			console.error(
-				'Failed to push version update:',
-				pushError instanceof Error ? pushError.message : String(pushError)
-			);
-		}
-	} catch (error) {
-		console.error('Error:', error instanceof Error ? error.message : String(error));
-	} finally {
-		rl.close();
-	}
+  try {
+    const currentVersion = process.env.npm_package_version || '1.0.0';
+    const targetVersion = await getTargetVersion(currentVersion);
+
+    if (!targetVersion) {
+      console.log('Invalid version');
+      return;
+    }
+
+    try {
+      // Update package.json version
+      await updatePackageVersion(targetVersion);
+      console.log(`package.json updated to version ${targetVersion}`);
+
+      // Add files to git
+      gitExec('git add package.json');
+      gitExec(`git commit -m "Updated to version ${targetVersion}"`);
+      console.log('Changes committed');
+    } catch (error) {
+      console.error(
+        'Error during update or commit:',
+        error instanceof Error ? error.message : String(error)
+      );
+      console.log('Operation failed.');
+      return;
+    }
+
+    try {
+      // Ensure Git is synchronized before pushing
+      await ensureGitSync();
+
+      gitExec('git push');
+      console.log(`Version successfully updated to ${targetVersion} and pushed.`);
+    } catch (pushError) {
+      console.error(
+        'Failed to push version update:',
+        pushError instanceof Error ? pushError.message : String(pushError)
+      );
+    }
+  } catch (error) {
+    console.error('Error:', error instanceof Error ? error.message : String(error));
+  } finally {
+    rl.close();
+  }
 }
 
 updateVersion()
-	.catch(console.error)
-	.finally(() => {
-		console.log('Exiting...');
-		process.exit();
-	});
+  .catch(console.error)
+  .finally(() => {
+    console.log('Exiting...');
+    process.exit();
+  });

package/scripts/utils.ts

@@ -4,24 +4,24 @@ 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
-	});
+  return readline.createInterface({
+    input: process.stdin as NodeJS.ReadableStream,
+    output: process.stdout as NodeJS.WritableStream
+  });
 }
 
 export const askQuestion = async (
-	question: string,
-	rl: readline.Interface
+  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;
-	}
+  try {
+    return await new Promise((resolve) =>
+      rl.question(question, (input) => resolve(input.trim()))
+    );
+  } catch (error) {
+    console.error('Error asking question:', error);
+    throw error;
+  }
 };
 
 /**
@@ -31,121 +31,121 @@ export const askQuestion = async (
  * Invalid input defaults to no for safety
  */
 export const askConfirmation = async (
-	question: string,
-	rl: readline.Interface
+  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;
-	}
+  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');
+  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;
-	}
+  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}`);
-	}
+  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;
-	}
+  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;
-	}
+  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/.editorconfig

@@ -1,14 +1,11 @@
-# top-most EditorConfig file
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-insert_final_newline = true
-indent_style = tab
-indent_size = 4
-tab_width = 4
-
-[*.json]
-indent_style = space
-indent_size = 2
+# top-most EditorConfig file
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+

package/templates/.prettierrc

@@ -1,19 +1,10 @@
 {
-	"useTabs": true,
-	"tabWidth": 4,
+	"useTabs": false,
+	"tabWidth": 2,
 	"printWidth": 90,
 	"endOfLine": "lf",
 	"trailingComma": "none",
 	"semi": true,
 	"singleQuote": true,
-	"arrowParens": "always",
-	"overrides": [
-		{
-			"files": ["*.json"],
-			"options": {
-				"useTabs": false,
-				"tabWidth": 2
-			}
-		}
-	]
+	"arrowParens": "always"
 }

package/templates/env.template

@@ -1,10 +1,13 @@
 # Environment variables for plugin development
-# Update these paths to match your setup
-
-# Path to test vault (for development)
-TEST_VAULT=
-
-# Path to real vault (for production testing)
-REAL_VAULT=
-
-# Note: Run 'yarn version' to update these paths interactively
+#
+# Vault paths
+# TEST_VAULT: path to your test/development vault (used with yarn dev)
+# REAL_VAULT: path to your production vault (used with yarn real)
+TEST_VAULT=/path/to/your/test/vault
+REAL_VAULT=/path/to/your/real/vault
+#
+# Obsidian Local REST API (for automatic reload after yarn real)
+# 1. Install the "Local REST API" plugin in Obsidian
+# 2. Enable "Enable Non-encrypted (HTTP) Server" in plugin settings
+# 3. Copy the API Key from plugin settings and paste it below
+OBSIDIAN_REST_API_KEY=your_api_key_here

package/templates/eslint.config.mts

@@ -7,7 +7,7 @@ import type {
 
 const configs: Linter.Config[] = [
   {
-    ignores: ["eslint.config.mts"]
+    ignores: ["eslint.config.mts", "scripts/**"]
   },
   {
     files: ["**/*.ts"],

package/templates/package.json

@@ -2,7 +2,8 @@
   "type": "module",
   "engines": {
     "npm": "please-use-yarn",
-    "yarn": ">=1.22.0"
+    "yarn": ">=1.22.0",
+    "node": ">=16.0.0"
   },
   "scripts": {
     "start": "yarn install && yarn dev",
@@ -25,7 +26,6 @@
   "devDependencies": {
     "@types/eslint": "latest",
     "@types/node": "latest",
-    "@types/semver": "latest",
     "@typescript-eslint/eslint-plugin": "latest",
     "@typescript-eslint/parser": "latest",
     "builtin-modules": "latest",
@@ -39,7 +39,6 @@
     "obsidian-typings": "latest",
     "prettier": "latest",
     "tslib": "2.4.0",
-    "semver": "latest",
     "tsx": "^4.21.0",
     "typescript": "^5.8.2"
   }