feat: add ZDOTDIR handling for zsh shell integration

Creates a temporary ZDOTDIR to handle zsh shell integration properly while preserving user's zsh configuration. This ensures VSCode shell integration works correctly with zsh without modifying the user's existing setup.

- Add terminalZdotdir setting (disabled by default)
- Create temporary directory with proper security (sticky bit)
- Add automatic cleanup on terminal close
- Add translations for all supported languages

User confirmed fixes:

Fixes: RooCodeInc#2205
Fixes: RooCodeInc#2129

Signed-off-by: Eric Wheeler <[email protected]>

Author: Eric Wheeler

src/core/webview/ClineProvider.ts

@@ -379,6 +379,7 @@ export class ClineProvider extends EventEmitter<ClineProviderEvents> implements
 				terminalZshOhMy,
 				terminalZshP10k,
 				terminalPowershellCounter,
+				terminalZdotdir,
 			}) => {
 				setSoundEnabled(soundEnabled ?? false)
 				Terminal.setShellIntegrationTimeout(
@@ -389,6 +390,7 @@ export class ClineProvider extends EventEmitter<ClineProviderEvents> implements
 				Terminal.setTerminalZshOhMy(terminalZshOhMy ?? false)
 				Terminal.setTerminalZshP10k(terminalZshP10k ?? false)
 				Terminal.setPowershellCounter(terminalPowershellCounter ?? false)
+				Terminal.setTerminalZdotdir(terminalZdotdir ?? false)
 			},
 		)
 
@@ -1300,6 +1302,7 @@ export class ClineProvider extends EventEmitter<ClineProviderEvents> implements
 			terminalZshClearEolMark,
 			terminalZshOhMy,
 			terminalZshP10k,
+			terminalZdotdir,
 			fuzzyMatchThreshold,
 			mcpEnabled,
 			enableMcpServerCreation,
@@ -1372,6 +1375,7 @@ export class ClineProvider extends EventEmitter<ClineProviderEvents> implements
 			terminalZshClearEolMark: terminalZshClearEolMark ?? true,
 			terminalZshOhMy: terminalZshOhMy ?? false,
 			terminalZshP10k: terminalZshP10k ?? false,
+			terminalZdotdir: terminalZdotdir ?? false,
 			fuzzyMatchThreshold: fuzzyMatchThreshold ?? 1.0,
 			mcpEnabled: mcpEnabled ?? true,
 			enableMcpServerCreation: enableMcpServerCreation ?? true,
@@ -1475,6 +1479,7 @@ export class ClineProvider extends EventEmitter<ClineProviderEvents> implements
 			terminalZshClearEolMark: stateValues.terminalZshClearEolMark ?? true,
 			terminalZshOhMy: stateValues.terminalZshOhMy ?? false,
 			terminalZshP10k: stateValues.terminalZshP10k ?? false,
+			terminalZdotdir: stateValues.terminalZdotdir ?? false,
 			mode: stateValues.mode ?? defaultModeSlug,
 			language: stateValues.language ?? formatLanguage(vscode.env.language),
 			mcpEnabled: stateValues.mcpEnabled ?? true,

src/core/webview/webviewMessageHandler.ts

@@ -784,6 +784,13 @@ export const webviewMessageHandler = async (provider: ClineProvider, message: We
 				Terminal.setTerminalZshP10k(message.bool)
 			}
 			break
+		case "terminalZdotdir":
+			await updateGlobalState("terminalZdotdir", message.bool)
+			await provider.postStateToWebview()
+			if (message.bool !== undefined) {
+				Terminal.setTerminalZdotdir(message.bool)
+			}
+			break
 		case "mode":
 			await provider.handleModeSwitch(message.text as Mode)
 			break

src/exports/roo-code.d.ts

@@ -288,6 +288,7 @@ type GlobalSettings = {
 	terminalZshClearEolMark?: boolean | undefined
 	terminalZshOhMy?: boolean | undefined
 	terminalZshP10k?: boolean | undefined
+	terminalZdotdir?: boolean | undefined
 	rateLimitSeconds?: number | undefined
 	diffEnabled?: boolean | undefined
 	fuzzyMatchThreshold?: number | undefined

src/exports/types.ts

@@ -291,6 +291,7 @@ type GlobalSettings = {
 	terminalZshClearEolMark?: boolean | undefined
 	terminalZshOhMy?: boolean | undefined
 	terminalZshP10k?: boolean | undefined
+	terminalZdotdir?: boolean | undefined
 	rateLimitSeconds?: number | undefined
 	diffEnabled?: boolean | undefined
 	fuzzyMatchThreshold?: number | undefined

src/integrations/terminal/Terminal.ts

@@ -2,6 +2,8 @@ import * as vscode from "vscode"
 import pWaitFor from "p-wait-for"
 import { ExitCodeDetails, mergePromise, TerminalProcess, TerminalProcessResultPromise } from "./TerminalProcess"
 import { truncateOutput, applyRunLengthEncoding } from "../misc/extract-text"
+// Import TerminalRegistry here to avoid circular dependencies
+const { TerminalRegistry } = require("./TerminalRegistry")
 
 export const TERMINAL_SHELL_INTEGRATION_TIMEOUT = 5000
 
@@ -12,6 +14,7 @@ export class Terminal {
 	private static terminalZshClearEolMark: boolean = true
 	private static terminalZshOhMy: boolean = false
 	private static terminalZshP10k: boolean = false
+	private static terminalZdotdir: boolean = false
 
 	public terminal: vscode.Terminal
 	public busy: boolean
@@ -185,10 +188,16 @@ export class Terminal {
 			// Wait for shell integration before executing the command
 			pWaitFor(() => this.terminal.shellIntegration !== undefined, { timeout: Terminal.shellIntegrationTimeout })
 				.then(() => {
+					// Clean up temporary directory if shell integration is available, zsh did its job:
+					TerminalRegistry.zshCleanupTmpDir(this.id)
+
+					// Run the command in the terminal
 					process.run(command)
 				})
 				.catch(() => {
 					console.log(`[Terminal ${this.id}] Shell integration not available. Command execution aborted.`)
+					// Clean up temporary directory if shell integration is not available
+					TerminalRegistry.zshCleanupTmpDir(this.id)
 					process.emit(
 						"no_shell_integration",
 						`Shell integration initialization sequence '\\x1b]633;A' was not received within ${Terminal.shellIntegrationTimeout / 1000}s. Shell integration has been disabled for this terminal instance. Increase the timeout in the settings if necessary.`,
@@ -348,4 +357,20 @@ export class Terminal {
 	public static compressTerminalOutput(input: string, lineLimit: number): string {
 		return truncateOutput(applyRunLengthEncoding(input), lineLimit)
 	}
+
+	/**
+	 * Sets whether to enable ZDOTDIR handling for zsh
+	 * @param enabled Whether to enable ZDOTDIR handling
+	 */
+	public static setTerminalZdotdir(enabled: boolean): void {
+		Terminal.terminalZdotdir = enabled
+	}
+
+	/**
+	 * Gets whether ZDOTDIR handling is enabled
+	 * @returns Whether ZDOTDIR handling is enabled
+	 */
+	public static getTerminalZdotdir(): boolean {
+		return Terminal.terminalZdotdir
+	}
 }

src/integrations/terminal/TerminalRegistry.ts

@@ -1,4 +1,5 @@
 import * as vscode from "vscode"
+import * as path from "path"
 import { arePathsEqual } from "../../utils/path"
 import { Terminal } from "./Terminal"
 import { TerminalProcess } from "./TerminalProcess"
@@ -9,6 +10,7 @@ export class TerminalRegistry {
 	private static terminals: Terminal[] = []
 	private static nextTerminalId = 1
 	private static disposables: vscode.Disposable[] = []
+	private static terminalTmpDirs: Map<number, string> = new Map()
 	private static isInitialized = false
 
 	static initialize() {
@@ -17,6 +19,18 @@ export class TerminalRegistry {
 		}
 		this.isInitialized = true
 
+		// Register handler for terminal close events to clean up temporary directories
+		const closeDisposable = vscode.window.onDidCloseTerminal((terminal) => {
+			const terminalInfo = this.getTerminalByVSCETerminal(terminal)
+			if (terminalInfo) {
+				// Clean up temporary directory if it exists
+				if (this.terminalTmpDirs.has(terminalInfo.id)) {
+					this.zshCleanupTmpDir(terminalInfo.id)
+				}
+			}
+		})
+		this.disposables.push(closeDisposable)
+
 		try {
 			// onDidStartTerminalShellExecution
 			const startDisposable = vscode.window.onDidStartTerminalShellExecution?.(
@@ -141,6 +155,11 @@ export class TerminalRegistry {
 			env.PROMPT_EOL_MARK = ""
 		}
 
+		// Handle ZDOTDIR for zsh if enabled
+		if (Terminal.getTerminalZdotdir()) {
+			env.ZDOTDIR = this.zshInitTmpDir(env)
+		}
+
 		const terminal = vscode.window.createTerminal({
 			cwd,
 			name: "Shenma",
@@ -151,6 +170,13 @@ export class TerminalRegistry {
 		const cwdString = cwd.toString()
 		const newTerminal = new Terminal(this.nextTerminalId++, terminal, cwdString)
 
+		if (Terminal.getTerminalZdotdir()) {
+			this.terminalTmpDirs.set(newTerminal.id, env.ZDOTDIR)
+			console.info(
+				`[TerminalRegistry] Stored temporary directory path for terminal ${newTerminal.id}: ${env.ZDOTDIR}`,
+			)
+		}
+
 		this.terminals.push(newTerminal)
 		return newTerminal
 	}
@@ -191,6 +217,8 @@ export class TerminalRegistry {
 	}
 
 	static removeTerminal(id: number) {
+		this.zshCleanupTmpDir(id)
+
 		this.terminals = this.terminals.filter((t) => t.id !== id)
 	}
 
@@ -279,10 +307,156 @@ export class TerminalRegistry {
 	}
 
 	static cleanup() {
+		// Clean up all temporary directories
+		this.terminalTmpDirs.forEach((_, terminalId) => {
+			this.zshCleanupTmpDir(terminalId)
+		})
+		this.terminalTmpDirs.clear()
+
 		this.disposables.forEach((disposable) => disposable.dispose())
 		this.disposables = []
 	}
 
+	/**
+	 * Gets the path to the shell integration script for a given shell type
+	 * @param shell The shell type
+	 * @returns The path to the shell integration script
+	 */
+	private static getShellIntegrationPath(shell: "bash" | "pwsh" | "zsh" | "fish"): string {
+		let filename: string
+
+		switch (shell) {
+			case "bash":
+				filename = "shellIntegration-bash.sh"
+				break
+			case "pwsh":
+				filename = "shellIntegration.ps1"
+				break
+			case "zsh":
+				filename = "shellIntegration-rc.zsh"
+				break
+			case "fish":
+				filename = "shellIntegration.fish"
+				break
+			default:
+				throw new Error(`Invalid shell type: ${shell}`)
+		}
+
+		// This is the same path used by the CLI command
+		return path.join(
+			vscode.env.appRoot,
+			"out",
+			"vs",
+			"workbench",
+			"contrib",
+			"terminal",
+			"common",
+			"scripts",
+			filename,
+		)
+	}
+
+	/**
+	 * Initialize a temporary directory for ZDOTDIR
+	 * @param env The environment variables object to modify
+	 * @returns The path to the temporary directory
+	 */
+	private static zshInitTmpDir(env: Record<string, string>): string {
+		// Create a temporary directory with the sticky bit set for security
+		const os = require("os")
+		const path = require("path")
+		const tmpDir = path.join(os.tmpdir(), `roo-zdotdir-${Math.random().toString(36).substring(2, 15)}`)
+		console.info(`[TerminalRegistry] Creating temporary directory for ZDOTDIR: ${tmpDir}`)
+
+		// Save original ZDOTDIR as ROO_ZDOTDIR
+		if (process.env.ZDOTDIR) {
+			env.ROO_ZDOTDIR = process.env.ZDOTDIR
+		}
+
+		// Create the temporary directory
+		vscode.workspace.fs
+			.createDirectory(vscode.Uri.file(tmpDir))
+			.then(() => {
+				console.info(`[TerminalRegistry] Created temporary directory for ZDOTDIR at ${tmpDir}`)
+
+				// Create .zshrc in the temporary directory
+				const zshrcPath = `${tmpDir}/.zshrc`
+
+				// Get the path to the shell integration script
+				const shellIntegrationPath = this.getShellIntegrationPath("zsh")
+
+				const zshrcContent = `
+source "${shellIntegrationPath}"
+ZDOTDIR=\${ROO_ZDOTDIR:-$HOME}
+unset ROO_ZDOTDIR
+[ -f "$ZDOTDIR/.zshenv" ] && source "$ZDOTDIR/.zshenv"
+[ -f "$ZDOTDIR/.zprofile" ] && source "$ZDOTDIR/.zprofile"
+[ -f "$ZDOTDIR/.zshrc" ] && source "$ZDOTDIR/.zshrc"
+[ -f "$ZDOTDIR/.zlogin" ] && source "$ZDOTDIR/.zlogin"
+[ "$ZDOTDIR" = "$HOME" ] && unset ZDOTDIR
+`
+				console.info(`[TerminalRegistry] Creating .zshrc file at ${zshrcPath} with content:\n${zshrcContent}`)
+				vscode.workspace.fs.writeFile(vscode.Uri.file(zshrcPath), Buffer.from(zshrcContent)).then(
+					// Success handler
+					() => {
+						console.info(`[TerminalRegistry] Successfully created .zshrc file at ${zshrcPath}`)
+					},
+					// Error handler
+					(error: Error) => {
+						console.error(`[TerminalRegistry] Error creating .zshrc file at ${zshrcPath}: ${error}`)
+					},
+				)
+			})
+			.then(undefined, (error: Error) => {
+				console.error(`[TerminalRegistry] Error creating temporary directory at ${tmpDir}: ${error}`)
+			})
+
+		return tmpDir
+	}
+
+	/**
+	 * Clean up a temporary directory used for ZDOTDIR
+	 */
+	private static zshCleanupTmpDir(terminalId: number): boolean {
+		const tmpDir = this.terminalTmpDirs.get(terminalId)
+		if (!tmpDir) {
+			return false
+		}
+
+		const logPrefix = `[TerminalRegistry] Cleaning up temporary directory for terminal ${terminalId}`
+		console.info(`${logPrefix}: ${tmpDir}`)
+
+		try {
+			// Use fs to remove the directory and its contents
+			const fs = require("fs")
+			const path = require("path")
+
+			// Remove .zshrc file
+			const zshrcPath = path.join(tmpDir, ".zshrc")
+			if (fs.existsSync(zshrcPath)) {
+				console.info(`${logPrefix}: Removing .zshrc file at ${zshrcPath}`)
+				fs.unlinkSync(zshrcPath)
+			}
+
+			// Remove the directory
+			if (fs.existsSync(tmpDir)) {
+				console.info(`${logPrefix}: Removing directory at ${tmpDir}`)
+				fs.rmdirSync(tmpDir)
+			}
+
+			// Remove it from the map
+			this.terminalTmpDirs.delete(terminalId)
+			console.info(`${logPrefix}: Removed terminal ${terminalId} from temporary directory map`)
+
+			return true
+		} catch (error: unknown) {
+			console.error(
+				`[TerminalRegistry] Error cleaning up temporary directory ${tmpDir}: ${error instanceof Error ? error.message : String(error)}`,
+			)
+			return false
+		}
+	}
+
 	/**
 	 * Releases all terminals associated with a task
 	 * @param taskId The task ID

src/integrations/terminal/__tests__/TerminalProcessExec.bash.test.ts

@@ -11,6 +11,7 @@ jest.mock("vscode", () => {
 	const eventHandlers = {
 		startTerminalShellExecution: null,
 		endTerminalShellExecution: null,
+		closeTerminal: null,
 	}
 
 	return {
@@ -29,6 +30,10 @@ jest.mock("vscode", () => {
 				eventHandlers.endTerminalShellExecution = handler
 				return { dispose: jest.fn() }
 			}),
+			onDidCloseTerminal: jest.fn().mockImplementation((handler) => {
+				eventHandlers.closeTerminal = handler
+				return { dispose: jest.fn() }
+			}),
 		},
 		ThemeIcon: class ThemeIcon {
 			constructor(id: string) {

src/integrations/terminal/__tests__/TerminalProcessExec.cmd.test.ts

@@ -16,6 +16,7 @@ jest.mock("vscode", () => {
 	const eventHandlers = {
 		startTerminalShellExecution: null,
 		endTerminalShellExecution: null,
+		closeTerminal: null,
 	}
 
 	return {
@@ -34,6 +35,10 @@ jest.mock("vscode", () => {
 				eventHandlers.endTerminalShellExecution = handler
 				return { dispose: jest.fn() }
 			}),
+			onDidCloseTerminal: jest.fn().mockImplementation((handler) => {
+				eventHandlers.closeTerminal = handler
+				return { dispose: jest.fn() }
+			}),
 		},
 		ThemeIcon: class ThemeIcon {
 			constructor(id: string) {