/** * @license * Copyright 2025 Google LLC * SPDX-License-Identifier: Apache-2.0 */ import { exec, execSync, spawn, spawnSync } from 'node:child_process'; import { promisify } from 'node:util'; import { once } from 'node:events'; import { debugLogger } from './debugLogger.js'; import { coreEvents, CoreEvent, type EditorSelectedPayload } from './events.js'; import { isHeadlessMode } from './headless.js'; const GUI_EDITORS = [ 'vscode', 'vscodium', 'windsurf', 'cursor', 'zed', 'antigravity', 'sublimetext', 'lapce', 'nova', 'bbedit', ] as const; const TERMINAL_EDITORS = [ 'vim', 'neovim', 'emacs', 'hx', 'emacsclient', 'micro', ] as const; const EDITORS = [...GUI_EDITORS, ...TERMINAL_EDITORS] as const; export const ALL_EDITORS: readonly string[] = EDITORS; const GUI_EDITORS_SET = new Set(GUI_EDITORS); const TERMINAL_EDITORS_SET = new Set(TERMINAL_EDITORS); const EDITORS_SET = new Set(EDITORS); export const NO_EDITOR_AVAILABLE_ERROR = 'No external editor is available. Please run /editor to configure one.'; export const DEFAULT_GUI_EDITOR: GuiEditorType = 'vscode'; export type GuiEditorType = (typeof GUI_EDITORS)[number]; export type TerminalEditorType = (typeof TERMINAL_EDITORS)[number]; export type EditorType = (typeof EDITORS)[number]; export function isGuiEditor(editor: EditorType): editor is GuiEditorType { return GUI_EDITORS_SET.has(editor); } export function isTerminalEditor( editor: EditorType, ): editor is TerminalEditorType { return TERMINAL_EDITORS_SET.has(editor); } export const EDITOR_DISPLAY_NAMES: Record = { vscode: 'VS Code', vscodium: 'VSCodium', windsurf: 'Windsurf', cursor: 'Cursor', vim: 'Vim', neovim: 'Neovim', zed: 'Zed', emacs: 'Emacs', emacsclient: 'Emacs Client', antigravity: 'Antigravity', hx: 'Helix', sublimetext: 'Sublime Text', lapce: 'Lapce', nova: 'Nova', bbedit: 'BBEdit', micro: 'Micro', }; export function getEditorDisplayName(editor: EditorType): string { return EDITOR_DISPLAY_NAMES[editor] || editor; } export const EDITOR_OPTIONS: ReadonlyArray<{ value: EditorType; label: string; }> = EDITORS.map((e) => ({ value: e, label: EDITOR_DISPLAY_NAMES[e] })); export function isValidEditorType(editor: string): editor is EditorType { return EDITORS_SET.has(editor); } /** * Escapes a string for use in an Emacs Lisp string literal. * Wraps in double quotes and escapes backslashes and double quotes. */ function escapeELispString(str: string): string { return `"${str.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`; } interface DiffCommand { command: string; args: string[]; } const execAsync = promisify(exec); function getCommandExistsCmd(cmd: string): string { return process.platform === 'win32' ? `where.exe ${cmd}` : `command -v ${cmd}`; } function commandExists(cmd: string): boolean { try { execSync(getCommandExistsCmd(cmd), { stdio: 'ignore' }); return true; } catch { return false; } } async function commandExistsAsync(cmd: string): Promise { try { await execAsync(getCommandExistsCmd(cmd)); return true; } catch { return false; } } /** * Editor command configurations for different platforms. * Each editor can have multiple possible command names, listed in order of preference. */ const editorCommands: Record< EditorType, { win32: string[]; default: string[] } > = { vscode: { win32: ['code.cmd'], default: ['code'] }, vscodium: { win32: ['codium.cmd'], default: ['codium'] }, windsurf: { win32: ['windsurf'], default: ['windsurf'] }, cursor: { win32: ['cursor'], default: ['cursor'] }, vim: { win32: ['vim'], default: ['vim'] }, neovim: { win32: ['nvim'], default: ['nvim'] }, zed: { win32: ['zed'], default: ['zed', 'zeditor'] }, emacs: { win32: ['emacs.exe'], default: ['emacs'] }, emacsclient: { win32: ['emacsclient'], default: ['emacsclient'] }, antigravity: { win32: ['agy.cmd', 'antigravity.cmd', 'antigravity'], default: ['agy', 'antigravity'], }, hx: { win32: ['hx'], default: ['hx'] }, sublimetext: { win32: ['subl'], default: ['subl'] }, lapce: { win32: ['lapce'], default: ['lapce'] }, // nova and bbedit are macOS-only; commandExists will return false on other platforms nova: { win32: ['nova'], default: ['nova'] }, bbedit: { win32: ['bbedit'], default: ['bbedit'] }, micro: { win32: ['micro'], default: ['micro'] }, }; function getEditorCommands(editor: EditorType): string[] { const commandConfig = editorCommands[editor]; return process.platform === 'win32' ? commandConfig.win32 : commandConfig.default; } export function hasValidEditorCommand(editor: EditorType): boolean { return getEditorCommands(editor).some((cmd) => commandExists(cmd)); } export async function hasValidEditorCommandAsync( editor: EditorType, ): Promise { return Promise.any( getEditorCommands(editor).map((cmd) => commandExistsAsync(cmd).then((exists) => exists || Promise.reject()), ), ).catch(() => false); } export function getEditorCommand(editor: EditorType): string { const commands = getEditorCommands(editor); return ( commands.slice(0, -1).find((cmd) => commandExists(cmd)) || commands[commands.length - 1] ); } /** * Given a command name (e.g. "cursor", "code", "code.cmd"), returns the * EditorType that uses that command, or undefined if no match is found. * * This intentionally checks command names across all platforms (both `default` * and `win32` lists) so that, for example, `$EDITOR=code` is recognized as * vscode on Windows and `$EDITOR=code.cmd` is recognized as vscode on macOS. */ export function resolveEditorTypeFromCommand( command: string, ): EditorType | undefined { const lowerCmd = command.toLowerCase(); for (const editor of EDITORS) { const { win32, default: nonWin32 } = editorCommands[editor]; if ( win32.some((c) => c.toLowerCase() === lowerCmd) || nonWin32.some((c) => c.toLowerCase() === lowerCmd) ) { return editor; } } return undefined; } /** * Per-editor wait flags for GUI editors. Most use '--wait'; exceptions are listed here. */ const editorWaitFlags: Partial> = { sublimetext: '-w', // subl uses -w instead of --wait }; /** * Returns the flag used to make a GUI editor block until the file is closed. */ export function getEditorWaitFlag(editor: EditorType): string { return editorWaitFlags[editor] ?? '--wait'; } /** * Per-editor extra arguments prepended to the command invocation. */ const editorExtraArgs: Partial> = { emacsclient: ['-nw'], // Force terminal (no-window) mode }; /** * VS Code-family editors that support the --new-window flag. */ const NEW_WINDOW_EDITORS = new Set([ 'vscode', 'vscodium', 'cursor', 'windsurf', 'antigravity', ]); /** * Returns any extra arguments that must be passed to the editor executable * (in addition to the file path and any wait flag). */ export function getEditorExtraArgs( editor: EditorType, options?: { newWindow?: boolean }, ): string[] { const extraArgs = editorExtraArgs[editor]; const args = extraArgs ? [...extraArgs] : []; if (options?.newWindow && NEW_WINDOW_EDITORS.has(editor)) { args.push('--new-window'); } return args; } export function allowEditorTypeInSandbox(editor: EditorType): boolean { const notUsingSandbox = !process.env['SANDBOX']; if (isGuiEditor(editor)) { return notUsingSandbox; } // For terminal-based editors like vim and emacs, allow in sandbox. return true; } function isEditorTypeAvailable( editor: string | undefined, ): editor is EditorType { return ( !!editor && isValidEditorType(editor) && allowEditorTypeInSandbox(editor) ); } /** * Check if the editor is valid and can be used. * Returns false if preferred editor is not set / invalid / not available / not allowed in sandbox. */ export function isEditorAvailable(editor: string | undefined): boolean { return isEditorTypeAvailable(editor) && hasValidEditorCommand(editor); } /** * Check if the editor is valid and can be used. * Returns false if preferred editor is not set / invalid / not available / not allowed in sandbox. */ export async function isEditorAvailableAsync( editor: string | undefined, ): Promise { return ( isEditorTypeAvailable(editor) && (await hasValidEditorCommandAsync(editor)) ); } /** * Resolves an editor to use for external editing without blocking the event loop. * 1. If a preferred editor is set and available, uses it. * 2. If no preferred editor is set (or preferred is unavailable), requests selection from user and waits for it. */ export async function resolveEditorAsync( preferredEditor: EditorType | undefined, signal?: AbortSignal, ): Promise { if (preferredEditor && (await isEditorAvailableAsync(preferredEditor))) { return preferredEditor; } coreEvents.emit(CoreEvent.RequestEditorSelection); return ( once(coreEvents, CoreEvent.EditorSelected, { signal }) // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion .then(([payload]) => (payload as EditorSelectedPayload).editor) .catch(() => undefined) ); } /** * Get the diff command for a specific editor. */ export function getDiffCommand( oldPath: string, newPath: string, editor: EditorType, ): DiffCommand | null { if (!isValidEditorType(editor)) { return null; } const command = getEditorCommand(editor); switch (editor) { case 'vscode': case 'vscodium': case 'windsurf': case 'cursor': case 'zed': case 'antigravity': return { command, args: ['--wait', '--diff', oldPath, newPath] }; case 'vim': case 'neovim': return { command, args: [ '-d', // skip viminfo file to avoid E138 errors '-i', 'NONE', // make the left window read-only and the right window editable '-c', 'wincmd h | set readonly | wincmd l', // set up colors for diffs '-c', 'highlight DiffAdd cterm=bold ctermbg=22 guibg=#005f00 | highlight DiffChange cterm=bold ctermbg=24 guibg=#005f87 | highlight DiffText ctermbg=21 guibg=#0000af | highlight DiffDelete ctermbg=52 guibg=#5f0000', // Show helpful messages '-c', 'set showtabline=2 | set tabline=[Instructions]\\ :wqa(save\\ &\\ quit)\\ \\|\\ i/esc(toggle\\ edit\\ mode)', '-c', 'wincmd h | setlocal statusline=OLD\\ FILE', '-c', 'wincmd l | setlocal statusline=%#StatusBold#NEW\\ FILE\\ :wqa(save\\ &\\ quit)\\ \\|\\ i/esc(toggle\\ edit\\ mode)', // Auto close all windows when one is closed '-c', 'autocmd BufWritePost * wqa', oldPath, newPath, ], }; case 'emacs': case 'emacsclient': { const extraArgs = editor === 'emacsclient' ? ['-nw'] : []; return { command, args: [ ...extraArgs, '--eval', `(ediff ${escapeELispString(oldPath)} ${escapeELispString(newPath)})`, ], }; } case 'hx': return { command: 'hx', args: ['--vsplit', '--', oldPath, newPath], }; case 'bbedit': return { command, args: ['--wait', '--diff', oldPath, newPath] }; // sublimetext, lapce, nova, micro do not support CLI-driven diff views default: return null; } } /** * Opens a diff tool to compare two files. * Terminal-based editors by default blocks parent process until the editor exits. * GUI-based editors require args such as "--wait" to block parent process. */ export async function openDiff( oldPath: string, newPath: string, editor: EditorType, ): Promise { if (isHeadlessMode()) { debugLogger.warn( 'External editor spawning is disabled in headless/server mode.', ); return; } const diffCommand = getDiffCommand(oldPath, newPath, editor); if (!diffCommand) { debugLogger.error('No diff tool available. Install a supported editor.'); return; } if (isTerminalEditor(editor)) { try { if (!commandExists(diffCommand.command)) { throw new Error(`Editor command not found: ${diffCommand.command}`); } const result = spawnSync(diffCommand.command, diffCommand.args, { stdio: 'inherit', }); if (result.error) { throw result.error; } if (result.status !== 0) { throw new Error(`${editor} exited with code ${result.status}`); } } finally { coreEvents.emit(CoreEvent.ExternalEditorClosed); } return; } return new Promise((resolve, reject) => { const childProcess = spawn(diffCommand.command, diffCommand.args, { stdio: 'inherit', shell: process.platform === 'win32', }); // Guard against both 'error' and 'close' firing for a single failure, // which would emit ExternalEditorClosed twice and attempt to settle // the promise twice. let isSettled = false; childProcess.on('close', (code) => { if (isSettled) return; isSettled = true; if (code !== 0) { // GUI editors (VS Code, Zed, etc.) can exit with non-zero codes // under normal circumstances (e.g., window closed while loading). // Log a warning instead of crashing the CLI process. debugLogger.warn(`${editor} exited with code ${code}`); } coreEvents.emit(CoreEvent.ExternalEditorClosed); resolve(); }); childProcess.on('error', (error) => { if (isSettled) return; isSettled = true; coreEvents.emit(CoreEvent.ExternalEditorClosed); reject(error); }); }); }