editor-profile-sync 1.0.4 → 1.0.6

package/README.md

@@ -9,6 +9,7 @@ You can sync:
 - extensions
 - snippets
 - `settings.json`
+- `keybindings.json`
 
 ## Requirements
 
@@ -67,8 +68,9 @@ npm install
 2. Choose a source editor.
 3. Choose what to share:
    - `Extensions`
-   - `settings.json`
    - `Snippets`
+   - `settings.json`
+   - `keybindings.json`
 4. Choose mode(s) for selected item types:
    - Extensions:
      - Install on top of existing (additive)
@@ -123,6 +125,48 @@ Result:
 }
 ```
 
+### Keybindings merge behavior
+
+For `keybindings.json`, keybindings are merged intelligently:
+
+- Source keybindings override target ones with the same `key` + `command` combination
+- Existing target keybindings that don't conflict are preserved
+- New source keybindings are added to the target
+
+Example:
+
+Target:
+
+```json
+[{ "key": "ctrl+k", "command": "workbench.action.terminal.clear" }]
+```
+
+Source:
+
+```json
+[
+  {
+    "key": "ctrl+k",
+    "command": "workbench.action.terminal.clear",
+    "when": "terminalFocus"
+  },
+  { "key": "ctrl+shift+p", "command": "workbench.action.showCommands" }
+]
+```
+
+Result:
+
+```json
+[
+  {
+    "key": "ctrl+k",
+    "command": "workbench.action.terminal.clear",
+    "when": "terminalFocus"
+  },
+  { "key": "ctrl+shift+p", "command": "workbench.action.showCommands" }
+]
+```
+
 ## Supported editors
 
 These editors are currently supported:
@@ -140,10 +184,6 @@ These editors are currently supported:
 
 **Windows/Linux**: Each editor must be installed and its CLI available in your terminal (e.g. `code`, `cursor`).
 
-## Generated files
-
-- `extensions.txt` is created when syncing extensions and contains the exported source extension IDs.
-
 ## License
 
 MIT

package/index.js

@@ -9,19 +9,22 @@ import updateNotifier from "update-notifier";
 import {
   EDITORS,
   EXTENSION_MODES,
-  EXTENSIONS_FILE,
   SNIPPET_MODES,
   SYNC_ITEMS,
 } from "./lib/constants.js";
 import { isEditorInstalled } from "./lib/editor-cli.js";
+import { exportExtensions, syncExtensions } from "./lib/extensions-sync.js";
 import {
-  exportExtensions,
-  readExtensionsFile,
-  syncExtensions,
-} from "./lib/extensions-sync.js";
-import { getSettingsPath, getSnippetsPath } from "./lib/profile-paths.js";
+  getSettingsPath,
+  getSnippetsPath,
+  getKeybindingsPath,
+} from "./lib/profile-paths.js";
 import { readSourceSettings, syncSettings } from "./lib/settings-sync.js";
 import { syncSnippets } from "./lib/snippets-sync.js";
+import {
+  readSourceKeybindings,
+  syncKeybindings,
+} from "./lib/keybindings-sync.js";
 import {
   promptExtensionMode,
   promptSnippetMode,
@@ -96,7 +99,7 @@ async function main() {
   }
 
   detectSpinner.succeed(
-    `Found ${availableEditors.length} editor(s): ${availableEditors
+    `Found ${availableEditors.length} editor${availableEditors.length === 1 ? "" : "s"}: ${availableEditors
       .map((e) => e.name)
       .join(", ")}`,
   );
@@ -133,9 +136,6 @@ async function main() {
     targetIds.includes(e.id),
   );
 
-  const cwd = process.cwd();
-  const extensionsPath = join(cwd, EXTENSIONS_FILE);
-
   let desiredExtensions = [];
   if (syncItems.includes("extensions")) {
     const exportSpinner = ora({
@@ -143,11 +143,8 @@ async function main() {
       color: "cyan",
     }).start();
     try {
-      await exportExtensions(sourceEditor, extensionsPath);
-      desiredExtensions = readExtensionsFile(extensionsPath);
-      exportSpinner.succeed(
-        `Exported ${desiredExtensions.length} extensions to ${EXTENSIONS_FILE}`,
-      );
+      desiredExtensions = await exportExtensions(sourceEditor);
+      exportSpinner.succeed(`${desiredExtensions.length} extensions detected`);
     } catch (err) {
       exportSpinner.fail("Extension export failed");
       console.error("  Error:", err.message, "\n");
@@ -176,58 +173,43 @@ async function main() {
     }
   }
 
+  let sourceKeybindings = [];
+  if (syncItems.includes("keybindings")) {
+    try {
+      sourceKeybindings = readSourceKeybindings(
+        getKeybindingsPath(sourceEditor),
+      );
+    } catch (err) {
+      console.error(`  ${err.message}\n`);
+      process.exit(1);
+    }
+  }
+
   console.log("");
 
   for (const editor of targetEditors) {
     try {
-      console.log(chalk.bold(editor.name));
-
-      if (syncItems.includes("extensions")) {
-        const spinner = ora({
-          text: `${chalk.bold(editor.name)}: Installing extensions...`,
-          color: "cyan",
-        }).start();
-        const result = await syncExtensions(
-          editor,
-          desiredExtensions,
-          extensionMode,
-          (i, extensionId) => {
-            spinner.text = `${chalk.bold(editor.name)}: [${i + 1}/${desiredExtensions.length}] Installing ${extensionId}`;
-          },
-        );
-        const parts = [chalk.green(`${result.synced} extensions synced`)];
-        if (result.failed.length > 0) {
-          parts.push(chalk.red(`${result.failed.length} failed`));
-        }
-        spinner.succeed(`${chalk.bold(editor.name)}: ${parts.join(", ")}`);
-        if (result.failed.length > 0) {
-          console.log(
-            `      ${chalk.red("Failed:")} ${result.failed.join(", ")}`,
-          );
-        }
-      }
+      console.log(chalk.bold(editor.name) + ":");
 
       if (syncItems.includes("settings")) {
         const spinner = ora({
-          text: `${chalk.bold(editor.name)}: Syncing settings.json...`,
+          text: "Syncing settings.json...",
           color: "cyan",
         }).start();
         try {
           const targetPath = getSettingsPath(editor, { createIfMissing: true });
           const merged = syncSettings(sourceSettings, targetPath);
           spinner.succeed(
-            `${chalk.bold(editor.name)}: settings.json synced (${Object.keys(merged).length} keys)`,
+            `settings.json synced (${Object.keys(merged).length} keys)`,
           );
         } catch (err) {
-          spinner.fail(
-            `${chalk.bold(editor.name)}: settings sync failed (${err.message})`,
-          );
+          spinner.fail(`settings sync failed (${err.message})`);
         }
       }
 
       if (syncItems.includes("snippets")) {
         const spinner = ora({
-          text: `${chalk.bold(editor.name)}: Syncing snippets (${snippetMode})...`,
+          text: `Syncing snippets (${snippetMode} mode)...`,
           color: "cyan",
         }).start();
         try {
@@ -240,12 +222,52 @@ async function main() {
             snippetMode,
           );
           spinner.succeed(
-            `${chalk.bold(editor.name)}: snippets synced (${fileCount} file${fileCount === 1 ? "" : "s"}, ${snippetMode})`,
+            `snippets synced (${fileCount} file${fileCount === 1 ? "" : "s"}, ${snippetMode} mode)`,
           );
         } catch (err) {
-          spinner.fail(
-            `${chalk.bold(editor.name)}: snippets sync failed (${err.message})`,
+          spinner.fail(`snippets sync failed (${err.message})`);
+        }
+      }
+
+      if (syncItems.includes("keybindings")) {
+        const spinner = ora({
+          text: "Syncing keybindings.json...",
+          color: "cyan",
+        }).start();
+        try {
+          const targetPath = getKeybindingsPath(editor, {
+            createIfMissing: true,
+          });
+          const merged = syncKeybindings(sourceKeybindings, targetPath);
+          spinner.succeed(
+            `keybindings.json synced (${merged.length} binding${merged.length === 1 ? "" : "s"})`,
           );
+        } catch (err) {
+          spinner.fail(`keybindings sync failed (${err.message})`);
+        }
+      }
+
+      if (syncItems.includes("extensions")) {
+        const spinner = ora({
+          text: "Installing extensions...",
+          color: "cyan",
+        }).start();
+        const result = await syncExtensions(
+          editor,
+          desiredExtensions,
+          extensionMode,
+          (i, extensionId) => {
+            spinner.text = `Installing extensions [${i + 1}/${desiredExtensions.length}] ${chalk.dim(extensionId)}`;
+          },
+        );
+        const successPart = chalk.green(`${result.synced} installed`);
+        const failedPart =
+          result.failed.length > 0
+            ? `, ${chalk.red(`${result.failed.length} failed`)}`
+            : "";
+        spinner.succeed(`extensions synced (${successPart}${failedPart})`);
+        if (result.failed.length > 0) {
+          console.log(`${chalk.red("Failed:")} ${result.failed.join(", ")}`);
         }
       }
 

package/lib/constants.js

@@ -1,6 +1,6 @@
-export const EXTENSIONS_FILE = "extensions.txt";
 export const SETTINGS_FILE = "settings.json";
 export const SNIPPETS_DIR = "snippets";
+export const KEYBINDINGS_FILE = "keybindings.json";
 
 // Sorted alphabetically by display name.
 export const EDITORS = [
@@ -44,15 +44,20 @@ export const SYNC_ITEMS = [
     name: "Extensions",
     short: "Extensions",
   },
+  {
+    value: "snippets",
+    name: "Snippets",
+    short: "Snippets",
+  },
   {
     value: "settings",
     name: "settings.json",
     short: "settings.json",
   },
   {
-    value: "snippets",
-    name: "Snippets",
-    short: "Snippets",
+    value: "keybindings",
+    name: "keybindings.json",
+    short: "keybindings.json",
   },
 ];
 

package/lib/extensions-sync.js

@@ -1,32 +1,15 @@
-import { readFileSync, writeFileSync } from "fs";
 import {
   getInstalledExtensions,
   installExtension,
   uninstallExtension,
 } from "./editor-cli.js";
 
-export async function exportExtensions(sourceEditor, filePath) {
+export async function exportExtensions(sourceEditor) {
   const list = await getInstalledExtensions(sourceEditor);
   if (list == null) {
     throw new Error(`${sourceEditor.name} CLI not found or failed.`);
   }
-
-  const sorted = [...list].sort();
-  writeFileSync(
-    filePath,
-    sorted.join("\n") + (sorted.length ? "\n" : ""),
-    "utf-8",
-  );
-
-  return sorted;
-}
-
-export function readExtensionsFile(filePath) {
-  const content = readFileSync(filePath, "utf-8");
-  return content
-    .split(/\r?\n/)
-    .map((s) => s.trim())
-    .filter(Boolean);
+  return [...list].sort();
 }
 
 export async function syncExtensions(editor, desired, mode, onProgress) {

package/lib/keybindings-sync.js

@@ -0,0 +1,57 @@
+import { existsSync, readFileSync, writeFileSync } from "fs";
+import { parse, printParseErrorCode } from "jsonc-parser";
+
+export function readSourceKeybindings(keybindingsPath) {
+  if (!existsSync(keybindingsPath)) {
+    throw new Error(`Source keybindings.json not found: ${keybindingsPath}`);
+  }
+
+  const raw = readFileSync(keybindingsPath, "utf-8");
+  const errors = [];
+  const parsed = parse(raw, errors, { allowTrailingComma: true });
+
+  if (errors.length > 0) {
+    const firstError = errors[0];
+    throw new Error(
+      `Invalid JSON in source keybindings.json: ${printParseErrorCode(firstError.error)} at offset ${firstError.offset}`,
+    );
+  }
+
+  if (!Array.isArray(parsed)) {
+    throw new Error("Source keybindings.json must be an array");
+  }
+
+  return parsed;
+}
+
+export function syncKeybindings(sourceKeybindings, targetPath) {
+  let targetKeybindings = [];
+
+  if (existsSync(targetPath)) {
+    const raw = readFileSync(targetPath, "utf-8");
+    const errors = [];
+    const parsed = parse(raw, errors, { allowTrailingComma: true });
+
+    if (errors.length === 0 && Array.isArray(parsed)) {
+      targetKeybindings = parsed;
+    }
+  }
+
+  // Merge: source keybindings override target ones with same key+command combo
+  const merged = [...targetKeybindings];
+
+  for (const sourceBinding of sourceKeybindings) {
+    const existingIndex = merged.findIndex(
+      (t) => t.key === sourceBinding.key && t.command === sourceBinding.command,
+    );
+
+    if (existingIndex >= 0) {
+      merged[existingIndex] = sourceBinding;
+    } else {
+      merged.push(sourceBinding);
+    }
+  }
+
+  writeFileSync(targetPath, JSON.stringify(merged, null, 2) + "\n", "utf-8");
+  return merged;
+}

package/lib/profile-paths.js

@@ -1,7 +1,12 @@
 import { existsSync, mkdirSync } from "fs";
 import { homedir } from "os";
 import { join } from "path";
-import { EDITOR_DATA_DIRS, SETTINGS_FILE, SNIPPETS_DIR } from "./constants.js";
+import {
+  EDITOR_DATA_DIRS,
+  KEYBINDINGS_FILE,
+  SETTINGS_FILE,
+  SNIPPETS_DIR,
+} from "./constants.js";
 
 function getConfigBaseDir() {
   if (process.platform === "win32") {
@@ -34,3 +39,7 @@ export function getSettingsPath(editor, options = {}) {
 export function getSnippetsPath(editor, options = {}) {
   return join(getEditorUserDir(editor, options), SNIPPETS_DIR);
 }
+
+export function getKeybindingsPath(editor, options = {}) {
+  return join(getEditorUserDir(editor, options), KEYBINDINGS_FILE);
+}

package/lib/prompts.js

@@ -1,96 +1,51 @@
-import inquirer from "inquirer";
-import CheckboxPrompt from "inquirer/lib/prompts/checkbox.js";
-
-class CleanCheckboxPrompt extends CheckboxPrompt {
-  constructor(questions, rl, answers) {
-    super(questions, rl, answers);
-    this.dontShowHints = true;
-  }
-}
-
-let isRegistered = false;
-
-function ensurePromptRegistered() {
-  if (isRegistered) return;
-  inquirer.registerPrompt("clean-checkbox", CleanCheckboxPrompt);
-  isRegistered = true;
-}
-
-const CHECKBOX_HINT =
-  "(Press <space> to select, <a> to toggle all, <enter> to continue)";
+import { select, checkbox } from "@inquirer/prompts";
 
 export async function promptSourceEditor(availableEditors) {
-  ensurePromptRegistered();
-  const answer = await inquirer.prompt([
-    {
-      type: "list",
-      name: "sourceId",
-      message: "Share from:",
-      choices: availableEditors.map((e) => ({ name: e.name, value: e.id })),
-      pageSize: 10,
-    },
-  ]);
-  return answer.sourceId;
+  return await select({
+    message: "Share from:",
+    choices: availableEditors.map((e) => ({ name: e.name, value: e.id })),
+    pageSize: 10,
+  });
 }
 
 export async function promptSyncItems(syncItems, chalk) {
-  ensurePromptRegistered();
-  const answer = await inquirer.prompt([
-    {
-      type: "clean-checkbox",
-      name: "selectedItems",
-      message: `Share: ${chalk.dim(CHECKBOX_HINT)}`,
-      choices: syncItems,
-      validate: (v) => (v.length ? true : "Select at least one item."),
-    },
-  ]);
-  return answer.selectedItems;
+  return await checkbox({
+    message: "Select items to sync:",
+    choices: syncItems,
+    required: true,
+    validate: (v) => (v.length ? true : "Select at least one item."),
+  });
 }
 
 export async function promptExtensionMode(extensionModes) {
-  const answer = await inquirer.prompt([
-    {
-      type: "list",
-      name: "extensionMode",
-      message: "Extension mode:",
-      choices: extensionModes.map((m) => ({
-        name: m.name,
-        value: m.value,
-        short: m.short,
-      })),
-      default: "additive",
-    },
-  ]);
-  return answer.extensionMode;
+  return await select({
+    message: "Extension mode:",
+    choices: extensionModes.map((m) => ({
+      name: m.name,
+      value: m.value,
+      short: m.short,
+    })),
+    default: "additive",
+  });
 }
 
 export async function promptSnippetMode(snippetModes) {
-  const answer = await inquirer.prompt([
-    {
-      type: "list",
-      name: "snippetMode",
-      message: "Snippet mode:",
-      choices: snippetModes.map((m) => ({
-        name: m.name,
-        value: m.value,
-        short: m.short,
-      })),
-      default: "merge",
-    },
-  ]);
-  return answer.snippetMode;
+  return await select({
+    message: "Snippet mode:",
+    choices: snippetModes.map((m) => ({
+      name: m.name,
+      value: m.value,
+      short: m.short,
+    })),
+    default: "merge",
+  });
 }
 
 export async function promptTargetEditors(targetChoices, chalk) {
-  ensurePromptRegistered();
-  const answer = await inquirer.prompt([
-    {
-      type: "clean-checkbox",
-      name: "targetIds",
-      message: `Sync to: ${chalk.dim(CHECKBOX_HINT)}`,
-      choices: targetChoices,
-      validate: (v) => (v.length ? true : "Select at least one editor."),
-    },
-  ]);
-  return answer.targetIds;
+  return await checkbox({
+    message: "Select target editors:",
+    choices: targetChoices,
+    required: true,
+    validate: (v) => (v.length ? true : "Select at least one editor."),
+  });
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "editor-profile-sync",
-  "version": "1.0.4",
-  "description": "Cross-platform extensions, settings.json, and snippets sync for VS Code-based editors",
+  "version": "1.0.6",
+  "description": "Cross-platform extensions, settings.json, keybindings, and snippets sync for VS Code-based editors",
   "type": "module",
   "main": "index.js",
   "bin": {
@@ -32,8 +32,8 @@
     "node": ">=18"
   },
   "dependencies": {
+    "@inquirer/prompts": "^8.2.1",
     "chalk": "^5.6.2",
-    "inquirer": "^9.2.22",
     "jsonc-parser": "^3.3.1",
     "ora": "^9.3.0",
     "update-notifier": "^7.3.1"