Add configurable editor command and open-file shortcut (#43)

Author: gumadeiras

README.md

@@ -88,6 +88,7 @@ is running so changes apply to open windows.
   "settings": {
     "copyCommentsOnClose": false,
     "diffStyle": "split",
+    "editorCommand": "",
     "lastRepositoryPath": "",
     "openAIModel": "gpt-5.3-codex-spark",
     "showWhitespace": false,
@@ -99,6 +100,7 @@ is running so changes apply to open windows.
     "diffSearch": "Mod+f",
     "fileFilter": "Mod+p",
     "nextSearchMatch": "Enter",
+    "openFile": "Mod+k",
     "prevSearchMatch": "Shift+Enter",
     "closeSearch": "Escape",
     "submitComment": "Mod+Enter",
@@ -108,6 +110,9 @@ is running so changes apply to open windows.
 }
 ```
 
+Set `settings.editorCommand` to customize file opening. Use `{file}` for the selected file and
+`{repo}` for the repository root, for example `"subl \"{repo}\" \"{file}\""`.
+
 Choose `View > Split Diff` or `View > Unified Diff`, use Toggle Diff Layout in the command bar,
 or set `settings.diffStyle` to `split` for side-by-side diffs or `unified` for unified diffs.
 Choose `View > Word Wrap`, use Toggle Word Wrap in the command bar, or set `settings.wordWrap`

config/defaults.json

@@ -0,0 +1,25 @@
+{
+  "settings": {
+    "copyCommentsOnClose": false,
+    "diffStyle": "split",
+    "editorCommand": "",
+    "lastRepositoryPath": "",
+    "openAIModel": "gpt-5.3-codex-spark",
+    "showOutdated": false,
+    "showWhitespace": false,
+    "theme": "system",
+    "wordWrap": false
+  },
+  "keymap": {
+    "closeSearch": "Escape",
+    "commandBar": "Mod+Shift+p",
+    "diffSearch": "Mod+f",
+    "discardComment": "Escape",
+    "fileFilter": "Mod+p",
+    "nextSearchMatch": "Enter",
+    "openFile": "Mod+k",
+    "prevSearchMatch": "Shift+Enter",
+    "submitComment": "Mod+Enter",
+    "toggleSidebar": "Mod+b"
+  }
+}

electron/__tests__/editor.test.ts

@@ -4,43 +4,115 @@ import { expect, test } from 'vite-plus/test';
 const require = createRequire(import.meta.url);
 const { createEditorOpener } = require('../main/editor.cjs') as {
   createEditorOpener: (options: {
+    getEditorCommand?: () => string;
     platform?: NodeJS.Platform;
     shell: {
       openPath: (path: string) => Promise<string>;
     };
   }) => {
-    getEditorCommands: (absolutePath: string) => Array<{
+    getEditorCommands: (
+      absolutePath: string,
+      context?: {
+        repoPath?: string;
+      },
+    ) => Array<{
       args: Array<string>;
       command: string;
     }>;
     parseEditorCommand: (command: string) => Array<string>;
   };
 };
 
-test('falls back to the macOS default text editor for text files without app associations', () => {
-  const opener = createEditorOpener({
-    platform: 'darwin',
+const createOpener = (
+  options: { getEditorCommand?: () => string; platform?: NodeJS.Platform } = {},
+) =>
+  createEditorOpener({
+    ...options,
     shell: {
       openPath: async () => '',
     },
   });
 
+test('falls back to the macOS default text editor for text files without app associations', () => {
+  const opener = createOpener({
+    platform: 'darwin',
+  });
+
   expect(opener.getEditorCommands('/Users/test/.codiff/codiff.jsonc')).toContainEqual({
     args: ['-t', '/Users/test/.codiff/codiff.jsonc'],
     command: 'open',
   });
 });
 
 test('parses custom editor commands with quoted arguments', () => {
-  const opener = createEditorOpener({
-    shell: {
-      openPath: async () => '',
-    },
-  });
+  const opener = createOpener();
 
   expect(opener.parseEditorCommand('editor --goto "{file}"')).toEqual([
     'editor',
     '--goto',
     '{file}',
   ]);
 });
+
+test('uses the configured editor command before built-in commands', () => {
+  const opener = createOpener({
+    getEditorCommand: () => 'cursor --goto "{file}"',
+  });
+
+  expect(opener.getEditorCommands('/Users/test/project/file.ts')[0]).toEqual({
+    args: ['--goto', '/Users/test/project/file.ts'],
+    command: 'cursor',
+  });
+});
+
+test('expands the repo placeholder in configured editor commands', () => {
+  const opener = createOpener({
+    getEditorCommand: () => 'subl "{repo}" "{file}"',
+  });
+
+  expect(
+    opener.getEditorCommands('/Users/test/project/src/file.ts', {
+      repoPath: '/Users/test/project',
+    })[0],
+  ).toEqual({
+    args: ['/Users/test/project', '/Users/test/project/src/file.ts'],
+    command: 'subl',
+  });
+});
+
+test('appends the file path when the configured editor command only uses the repo placeholder', () => {
+  const opener = createOpener({
+    getEditorCommand: () => 'subl "{repo}"',
+  });
+
+  expect(
+    opener.getEditorCommands('/Users/test/project/src/file.ts', {
+      repoPath: '/Users/test/project',
+    })[0],
+  ).toEqual({
+    args: ['/Users/test/project', '/Users/test/project/src/file.ts'],
+    command: 'subl',
+  });
+});
+
+test('lets CODIFF_EDITOR override the configured editor command', () => {
+  const previous = process.env.CODIFF_EDITOR;
+  process.env.CODIFF_EDITOR = 'zed --wait';
+
+  try {
+    const opener = createOpener({
+      getEditorCommand: () => 'cursor --goto "{file}"',
+    });
+
+    expect(opener.getEditorCommands('/Users/test/project/file.ts')[0]).toEqual({
+      args: ['--wait', '/Users/test/project/file.ts'],
+      command: 'zed',
+    });
+  } finally {
+    if (previous === undefined) {
+      delete process.env.CODIFF_EDITOR;
+    } else {
+      process.env.CODIFF_EDITOR = previous;
+    }
+  }
+});

electron/config.cjs

@@ -14,45 +14,21 @@ const { join } = require('node:path');
 /**
  * @typedef {import('../src/config/types.ts').CodiffConfig} CodiffConfig
  * @typedef {import('../src/config/types.ts').CodiffDiffStyle} CodiffDiffStyle
- * @typedef {import('../src/config/types.ts').CodiffKeymap} CodiffKeymap
- * @typedef {import('../src/config/types.ts').CodiffSettings} CodiffSettings
  * @typedef {import('../src/config/types.ts').CodiffTheme} CodiffTheme
  * @typedef {import('../src/types.ts').CodiffPreferences} CodiffPreferences
  */
 
+/** @type {CodiffConfig} */
+const defaultConfigTemplate = require('../config/defaults.json');
+
 const SCHEMA_URL =
   'https://raw.githubusercontent.com/nkzw-tech/codiff/main/src/config/codiff-config.schema.json';
 
-/** @type {CodiffSettings} */
-const defaultSettings = {
-  copyCommentsOnClose: false,
-  diffStyle: 'split',
-  lastRepositoryPath: '',
-  openAIModel: 'gpt-5.3-codex-spark',
-  showOutdated: false,
-  showWhitespace: false,
-  theme: 'system',
-  wordWrap: false,
-};
-
-/** @type {CodiffKeymap} */
-const defaultKeymap = {
-  closeSearch: 'Escape',
-  commandBar: 'Mod+Shift+p',
-  diffSearch: 'Mod+f',
-  discardComment: 'Escape',
-  fileFilter: 'Mod+p',
-  nextSearchMatch: 'Enter',
-  prevSearchMatch: 'Shift+Enter',
-  submitComment: 'Mod+Enter',
-  toggleSidebar: 'Mod+b',
-};
-
-/** @type {CodiffConfig} */
-const defaultConfig = {
-  keymap: defaultKeymap,
-  settings: defaultSettings,
-};
+/** @returns {CodiffConfig} */
+const createDefaultConfig = () => ({
+  keymap: { ...defaultConfigTemplate.keymap },
+  settings: { ...defaultConfigTemplate.settings },
+});
 
 const getConfigDir = () => join(homedir(), '.codiff');
 
@@ -147,8 +123,10 @@ const normalizeLastRepositoryPath = (path) =>
  * @returns {CodiffConfig}
  */
 const mergeConfig = (raw) => {
+  const defaults = createDefaultConfig();
+
   if (typeof raw !== 'object' || raw === null) {
-    return defaultConfig;
+    return defaults;
   }
 
   const obj = /** @type {Record<string, unknown>} */ (raw);
@@ -166,56 +144,70 @@ const mergeConfig = (raw) => {
       closeSearch:
         typeof rawKeymap.closeSearch === 'string'
           ? rawKeymap.closeSearch
-          : defaultKeymap.closeSearch,
+          : defaults.keymap.closeSearch,
       commandBar:
-        typeof rawKeymap.commandBar === 'string' ? rawKeymap.commandBar : defaultKeymap.commandBar,
+        typeof rawKeymap.commandBar === 'string'
+          ? rawKeymap.commandBar
+          : defaults.keymap.commandBar,
       diffSearch:
-        typeof rawKeymap.diffSearch === 'string' ? rawKeymap.diffSearch : defaultKeymap.diffSearch,
+        typeof rawKeymap.diffSearch === 'string'
+          ? rawKeymap.diffSearch
+          : defaults.keymap.diffSearch,
       discardComment:
         typeof rawKeymap.discardComment === 'string'
           ? rawKeymap.discardComment
-          : defaultKeymap.discardComment,
+          : defaults.keymap.discardComment,
       fileFilter:
-        typeof rawKeymap.fileFilter === 'string' ? rawKeymap.fileFilter : defaultKeymap.fileFilter,
+        typeof rawKeymap.fileFilter === 'string'
+          ? rawKeymap.fileFilter
+          : defaults.keymap.fileFilter,
       nextSearchMatch:
         typeof rawKeymap.nextSearchMatch === 'string'
           ? rawKeymap.nextSearchMatch
-          : defaultKeymap.nextSearchMatch,
+          : defaults.keymap.nextSearchMatch,
+      openFile:
+        typeof rawKeymap.openFile === 'string' ? rawKeymap.openFile : defaults.keymap.openFile,
       prevSearchMatch:
         typeof rawKeymap.prevSearchMatch === 'string'
           ? rawKeymap.prevSearchMatch
-          : defaultKeymap.prevSearchMatch,
+          : defaults.keymap.prevSearchMatch,
       submitComment:
         typeof rawKeymap.submitComment === 'string'
           ? rawKeymap.submitComment
-          : defaultKeymap.submitComment,
+          : defaults.keymap.submitComment,
       toggleSidebar:
         typeof rawKeymap.toggleSidebar === 'string'
           ? rawKeymap.toggleSidebar
-          : defaultKeymap.toggleSidebar,
+          : defaults.keymap.toggleSidebar,
     },
     settings: {
       copyCommentsOnClose:
         typeof rawSettings.copyCommentsOnClose === 'boolean'
           ? rawSettings.copyCommentsOnClose
-          : defaultSettings.copyCommentsOnClose,
+          : defaults.settings.copyCommentsOnClose,
       diffStyle: normalizeDiffStyle(rawSettings.diffStyle),
+      editorCommand:
+        typeof rawSettings.editorCommand === 'string'
+          ? rawSettings.editorCommand
+          : defaults.settings.editorCommand,
       lastRepositoryPath: normalizeLastRepositoryPath(rawSettings.lastRepositoryPath),
       openAIModel:
         typeof rawSettings.openAIModel === 'string'
           ? rawSettings.openAIModel
-          : defaultSettings.openAIModel,
+          : defaults.settings.openAIModel,
       showOutdated:
         typeof rawSettings.showOutdated === 'boolean'
           ? rawSettings.showOutdated
-          : defaultSettings.showOutdated,
+          : defaults.settings.showOutdated,
       showWhitespace:
         typeof rawSettings.showWhitespace === 'boolean'
           ? rawSettings.showWhitespace
-          : defaultSettings.showWhitespace,
+          : defaults.settings.showWhitespace,
       theme: normalizeTheme(rawSettings.theme),
       wordWrap:
-        typeof rawSettings.wordWrap === 'boolean' ? rawSettings.wordWrap : defaultSettings.wordWrap,
+        typeof rawSettings.wordWrap === 'boolean'
+          ? rawSettings.wordWrap
+          : defaults.settings.wordWrap,
     },
   };
 };
@@ -228,15 +220,15 @@ const readConfig = () => {
   const configPath = getConfigPath();
 
   if (!existsSync(configPath)) {
-    return defaultConfig;
+    return createDefaultConfig();
   }
 
   try {
     const text = readFileSync(configPath, 'utf8');
     const raw = parseJsonc(text);
     return mergeConfig(raw);
   } catch {
-    return defaultConfig;
+    return createDefaultConfig();
   }
 };
 
@@ -268,7 +260,7 @@ const initConfig = () => {
     return false;
   }
 
-  writeConfig(defaultConfig);
+  writeConfig(createDefaultConfig());
   return true;
 };
 
@@ -297,11 +289,12 @@ const migrateFromPreferences = (userDataPath, normalizeOpenAIModel) => {
 
   try {
     const oldPrefs = JSON.parse(readFileSync(oldPath, 'utf8'));
+    const defaults = createDefaultConfig();
     const config = mergeConfig({
       settings: {
         ...oldPrefs,
         lastRepositoryPath: normalizeLastRepositoryPath(oldPrefs?.lastRepositoryPath),
-        openAIModel: normalizeOpenAIModel(oldPrefs?.openAIModel ?? defaultSettings.openAIModel),
+        openAIModel: normalizeOpenAIModel(oldPrefs?.openAIModel ?? defaults.settings.openAIModel),
         theme: normalizeTheme(oldPrefs?.theme),
       },
     });
@@ -364,7 +357,7 @@ const configToPreferences = (config) => ({
 
 module.exports = {
   configToPreferences,
-  defaultConfig,
+  createDefaultConfig,
   getConfigPath,
   initConfig,
   mergeConfig,