editor-profile-sync 1.0.5 → 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:

package/index.js

@@ -14,9 +14,17 @@ import {
 } from "./lib/constants.js";
 import { isEditorInstalled } from "./lib/editor-cli.js";
 import { exportExtensions, syncExtensions } from "./lib/extensions-sync.js";
-import { getSettingsPath, getSnippetsPath } from "./lib/profile-paths.js";
+import {
+  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,
@@ -91,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(", ")}`,
   );
@@ -165,6 +173,18 @@ 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) {
@@ -209,6 +229,24 @@ async function main() {
         }
       }
 
+      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...",

package/lib/constants.js

@@ -1,5 +1,6 @@
 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 = [
@@ -43,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/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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "editor-profile-sync",
-  "version": "1.0.5",
-  "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": {