obsidian-plugin-config 1.7.1 → 1.7.3

package/scripts/utils.ts

@@ -1,151 +1,151 @@
-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
-  });
-}
-
-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;
-  }
-};
-
-/**
- * Ask a yes/no confirmation question with standardized logic
- * Accepts: y, yes, Y, YES, or empty (default to yes)
- * 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 cleanInput = (inputStr: string): string => {
-  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;
-  }
-};
-
-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}`);
-  }
-}
-
-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;
-  }
-}
-
-/**
- * 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;
-  }
-}
+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
+  });
+}
+
+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;
+  }
+};
+
+/**
+ * Ask a yes/no confirmation question with standardized logic
+ * Accepts: y, yes, Y, YES, or empty (default to yes)
+ * 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 cleanInput = (inputStr: string): string => {
+  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;
+  }
+};
+
+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}`);
+  }
+}
+
+export function gitExec(command: string, cwd?: string): void {
+  try {
+    execSync(command, { stdio: 'inherit', ...(cwd ? { cwd } : {}) });
+  } 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;
+  }
+}

package/templates/.github/workflows/release.yml

@@ -12,9 +12,9 @@ jobs:
       contents: write
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: "22.x"
 

package/templates/{package.json → package.json.template}

@@ -25,7 +25,7 @@
   },
   "devDependencies": {
     "@types/eslint": "latest",
-    "@types/node": "latest",
+    "@types/node": "^25.9.2",
     "@typescript-eslint/eslint-plugin": "latest",
     "@typescript-eslint/parser": "latest",
     "builtin-modules": "latest",

package/templates/scripts/acp.ts

@@ -1,4 +1,4 @@
-import { execSync } from 'child_process';
+import { execSync, spawnSync } from 'child_process';
 import {
   askQuestion,
   cleanInput,
@@ -23,7 +23,10 @@ async function main(): Promise<void> {
 
     try {
       gitExec('git add -A');
-      gitExec(`git commit -m "${cleanedInput}"`);
+      const result = spawnSync('git', ['commit', '-m', cleanedInput], { stdio: 'inherit' });
+      if (result.status !== 0) {
+        throw new Error('Commit failed');
+      }
     } catch {
       console.log('Commit already exists or failed.');
       return;

package/templates/scripts/esbuild.config.ts

@@ -16,7 +16,7 @@ import {
   copyFilesToTargetDir,
   createReadlineInterface,
   isValidPath,
-  removeMainCss
+  renameMainCss
 } from './utils.ts';
 import { reloadObsidian } from './reload.ts';
 
@@ -56,11 +56,11 @@ async function createBuildContext(
             }
           })(),
           {
-            name: 'remove-main-css',
+            name: 'rename-main-css',
             setup(build: esbuild.PluginBuild): void {
               build.onEnd(async (result) => {
                 if (result.errors.length === 0) {
-                  await removeMainCss(buildPath);
+                  await renameMainCss(buildPath);
                 }
               });
             }

package/templates/scripts/utils.ts

@@ -1,4 +1,4 @@
-import { access, mkdir, copyFile, rm, writeFile } from 'fs/promises';
+import { access, mkdir, copyFile, rm, writeFile, rename } from 'fs/promises';
 import { existsSync, readFileSync } from 'fs';
 import path from 'path';
 import * as readline from 'readline';
@@ -122,9 +122,9 @@ export async function copyFilesToTargetDir(buildPath: string): Promise<void> {
   }
 }
 
-export function gitExec(command: string): void {
+export function gitExec(command: string, cwd?: string): void {
   try {
-    execSync(command, { stdio: 'inherit' });
+    execSync(command, { stdio: 'inherit', ...(cwd ? { cwd } : {}) });
   } catch (error: unknown) {
     console.error(
       `Error executing '${command}':`,
@@ -163,19 +163,20 @@ export async function ensureGitSync(): Promise<void> {
 }
 
 /**
- * Remove main.css file generated by esbuild when compiling SCSS
- * This prevents the unwanted main.css from being included in the plugin
+ * Rename main.css file generated by esbuild when compiling SCSS to styles.css
+ * This ensures the compiled CSS is correctly recognized by Obsidian
  */
-export async function removeMainCss(outdir: string): Promise<void> {
+export async function renameMainCss(outdir: string): Promise<void> {
   const mainCssPath = path.join(outdir, 'main.css');
+  const stylesCssPath = path.join(outdir, 'styles.css');
   try {
-    await rm(mainCssPath);
-  } catch (error: unknown) {
-    if ((error as NodeJS.ErrnoException).code !== 'ENOENT') {
-      console.warn(
-        `Warning: Could not remove main.css: ${error instanceof Error ? error.message : String(error)}`
-      );
+    if (existsSync(mainCssPath)) {
+      await rename(mainCssPath, stylesCssPath);
     }
+  } catch (error: unknown) {
+    console.warn(
+      `Warning: Could not rename main.css to styles.css: ${error instanceof Error ? error.message : String(error)}`
+    );
   }
 }
 

package/tsconfig.json

@@ -5,7 +5,7 @@
     "inlineSources": true,
     "module": "NodeNext",
     "moduleResolution": "NodeNext",
-    "target": "ES2021",
+    "target": "ES2022",
     "allowJs": true,
     "noImplicitAny": true,
     "importHelpers": true,
@@ -17,8 +17,8 @@
     "forceConsistentCasingInFileNames": true,
     "strictNullChecks": true,
     "resolveJsonModule": true,
-    "lib": ["DOM", "ES2021"]
+    "lib": ["DOM", "ES2024"]
   },
-  "include": ["./scripts/**/*.ts"],
-  "exclude": ["node_modules", "eslint.config.ts", "templates"]
+  "include": ["./scripts/**/*.ts", "templates/**/*.ts"],
+  "exclude": ["node_modules", "eslint.config.ts"]
 }