obsidian-plugin-config 1.4.4 → 1.4.6

package/scripts/update-version-config.ts

@@ -1,98 +1,117 @@
-import { readFile, writeFile } from "fs/promises";
-import dedent from "dedent";
-import { inc, valid } from "semver";
-import { createReadlineInterface, askQuestion, gitExec } from "./utils.js";
-
-
-const rl = createReadlineInterface();
-
-async function getTargetVersion(currentVersion: string): Promise<string> {
-    const updateType = await askQuestion(dedent`
-        Current version: ${currentVersion}
-        Kind of update:
-            patch(1.0.1) -> type 1 or p
-            minor(1.1.0) -> type 2 or min
-            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()) || "";
-    }
-}
-
-async function updateJsonFile(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, "\t"));
-    } 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 Promise.all([
-            updateJsonFile("package.json", json => json.version = targetVersion),
-            updateJsonFile("versions.json", json => json[targetVersion] = "1.8.9")
-        ]);
-    } catch (error) {
-        console.error("Error updating config versions:", 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 versions.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();
-    }
-}
-
-updateVersion().catch(console.error).finally(() => {
-    console.log("Exiting...");
-    process.exit();
-});
+import { readFile, writeFile } from 'fs/promises';
+import dedent from 'dedent';
+import { inc, valid } from 'semver';
+import { createReadlineInterface, askQuestion, gitExec } from './utils.js';
+
+const rl = createReadlineInterface();
+
+async function getTargetVersion(currentVersion: string): Promise<string> {
+	const updateType = await askQuestion(
+		dedent`
+        Current version: ${currentVersion}
+        Kind of update:
+            patch(1.0.1) -> type 1 or p
+            minor(1.1.0) -> type 2 or min
+            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()) || '';
+	}
+}
+
+async function updateJsonFile(
+	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, '\t'));
+	} 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 Promise.all([
+			updateJsonFile('package.json', (json) => (json.version = targetVersion)),
+			updateJsonFile('versions.json', (json) => (json[targetVersion] = '1.8.9'))
+		]);
+	} catch (error) {
+		console.error(
+			'Error updating config versions:',
+			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 versions.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();
+	}
+}
+
+updateVersion()
+	.catch(console.error)
+	.finally(() => {
+		console.log('Exiting...');
+		process.exit();
+	});

package/scripts/utils.ts

@@ -1,27 +1,27 @@
-import {
-  access,
-  mkdir,
-  copyFile,
-  rm
-} from "fs/promises";
-import path from "path";
-import * as readline from "readline";
-import { execSync } from "child_process";
+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,
-  });
+	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;
-  }
+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;
+	}
 };
 
 /**
@@ -30,119 +30,122 @@ export const askQuestion = async (question: string, rl: readline.Interface): Pro
  * 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 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");
+	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/.vscode/settings.json

@@ -1,11 +1,11 @@
 {
-	"npm.packageManager": "yarn",
-	// "js/ts.preferences.includePackageJsonAutoImports": "off",
-	"[typescript]": {
-		"editor.defaultFormatter": "esbenp.prettier-vscode"
-	},
-	"[markdown]": {
-		"editor.defaultFormatter": "yzhang.markdown-all-in-one"
-	},
-	"editor.formatOnSave": true
+  "npm.packageManager": "yarn",
+  // "js/ts.preferences.includePackageJsonAutoImports": "off",
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "yzhang.markdown-all-in-one"
+  },
+  "editor.formatOnSave": true
 }

package/templates/.vscode/tasks.json

@@ -1,53 +1,53 @@
-{
-	"version": "2.0.0",
-	"tasks": [
-		{
-			"label": "Lint",
-			"type": "shell",
-			"command": "yarn lint",
-			"group": "test",
-			"presentation": { "reveal": "always", "panel": "shared" },
-			"problemMatcher": ["$eslint-stylish"]
-		},
-		{
-			"label": "Lint: Fix",
-			"type": "shell",
-			"command": "yarn lint:fix",
-			"group": "test",
-			"presentation": { "reveal": "always", "panel": "shared" },
-			"problemMatcher": ["$eslint-stylish"]
-		},
-		{
-			"label": "Prettier: Check",
-			"type": "shell",
-			"command": "npx prettier --check \"{src,scripts}/**/*.{ts,json}\"",
-			"group": "test",
-			"presentation": { "reveal": "always", "panel": "shared" },
-			"problemMatcher": []
-		},
-		{
-			"label": "Prettier: Fix",
-			"type": "shell",
-			"command": "npx prettier --write \"{src,scripts}/**/*.{ts,json}\"",
-			"group": "test",
-			"presentation": { "reveal": "always", "panel": "shared" },
-			"problemMatcher": []
-		},
-		{
-			"label": "Build",
-			"type": "shell",
-			"command": "yarn build",
-			"group": { "kind": "build", "isDefault": true },
-			"presentation": { "reveal": "always", "panel": "shared" },
-			"problemMatcher": ["$tsc"]
-		},
-		{
-			"label": "Cleanup: Lint + Prettier + Build",
-			"dependsOrder": "sequence",
-			"dependsOn": ["Lint: Fix", "Prettier: Fix", "Build"],
-			"group": "build",
-			"presentation": { "reveal": "always", "panel": "shared" },
-			"problemMatcher": []
-		}
-	]
-}
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Lint",
+      "type": "shell",
+      "command": "yarn lint",
+      "group": "test",
+      "presentation": { "reveal": "always", "panel": "shared" },
+      "problemMatcher": ["$eslint-stylish"]
+    },
+    {
+      "label": "Lint: Fix",
+      "type": "shell",
+      "command": "yarn lint:fix",
+      "group": "test",
+      "presentation": { "reveal": "always", "panel": "shared" },
+      "problemMatcher": ["$eslint-stylish"]
+    },
+    {
+      "label": "Prettier: Check",
+      "type": "shell",
+      "command": "yarn prettier",
+      "group": "test",
+      "presentation": { "reveal": "always", "panel": "shared" },
+      "problemMatcher": []
+    },
+    {
+      "label": "Prettier: Fix",
+      "type": "shell",
+      "command": "yarn prettier:fix",
+      "group": "test",
+      "presentation": { "reveal": "always", "panel": "shared" },
+      "problemMatcher": []
+    },
+    {
+      "label": "Build",
+      "type": "shell",
+      "command": "yarn build",
+      "group": { "kind": "build", "isDefault": true },
+      "presentation": { "reveal": "always", "panel": "shared" },
+      "problemMatcher": ["$tsc"]
+    },
+    {
+      "label": "Cleanup: Lint + Prettier + Build",
+      "dependsOrder": "sequence",
+      "dependsOn": ["Lint: Fix", "Prettier: Fix", "Build"],
+      "group": "build",
+      "presentation": { "reveal": "always", "panel": "shared" },
+      "problemMatcher": []
+    }
+  ]
+}

package/templates/package.json

@@ -18,7 +18,9 @@
     "help": "tsx scripts/help.ts",
     "h": "tsx scripts/help.ts",
     "lint": "eslint . --ext .ts",
-    "lint:fix": "eslint . --ext .ts --fix"
+    "lint:fix": "eslint . --ext .ts --fix",
+    "prettier": "npx prettier --check '**/*.{ts,json}'",
+    "prettier:fix": "npx prettier --write '**/*.{ts,json}'"
   },
   "devDependencies": {
     "@types/eslint": "latest",