fix(cli): resolve paste issue on Windows terminals. (#15932)

This commit is contained in:
Tommaso Sciortino
2026-01-05 14:46:23 -08:00
committed by GitHub
parent fd7b6bf40a
commit 8f0324d868
15 changed files with 224 additions and 115 deletions

View File

@@ -1,18 +0,0 @@
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { writeToStdout } from '@google/gemini-cli-core';
const ENABLE_BRACKETED_PASTE = '\x1b[?2004h';
const DISABLE_BRACKETED_PASTE = '\x1b[?2004l';
export const enableBracketedPaste = () => {
writeToStdout(ENABLE_BRACKETED_PASTE);
};
export const disableBracketedPaste = () => {
writeToStdout(DISABLE_BRACKETED_PASTE);
};

View File

@@ -23,6 +23,8 @@ vi.mock('@google/gemini-cli-core', () => ({
disableKittyKeyboardProtocol: vi.fn(),
enableModifyOtherKeys: vi.fn(),
disableModifyOtherKeys: vi.fn(),
enableBracketedPasteMode: vi.fn(),
disableBracketedPasteMode: vi.fn(),
}));
describe('TerminalCapabilityManager', () => {
@@ -264,4 +266,46 @@ describe('TerminalCapabilityManager', () => {
expect(manager.isModifyOtherKeysEnabled()).toBe(true);
});
});
describe('bracketed paste detection', () => {
it('should detect bracketed paste support (mode set)', async () => {
const manager = TerminalCapabilityManager.getInstance();
const promise = manager.detectCapabilities();
// Simulate bracketed paste response: \x1b[?2004;1$y
stdin.emit('data', Buffer.from('\x1b[?2004;1$y'));
// Complete detection with DA1
stdin.emit('data', Buffer.from('\x1b[?62c'));
await promise;
expect(manager.isBracketedPasteSupported()).toBe(true);
expect(manager.isBracketedPasteEnabled()).toBe(true);
});
it('should detect bracketed paste support (mode reset)', async () => {
const manager = TerminalCapabilityManager.getInstance();
const promise = manager.detectCapabilities();
// Simulate bracketed paste response: \x1b[?2004;2$y
stdin.emit('data', Buffer.from('\x1b[?2004;2$y'));
// Complete detection with DA1
stdin.emit('data', Buffer.from('\x1b[?62c'));
await promise;
expect(manager.isBracketedPasteSupported()).toBe(true);
expect(manager.isBracketedPasteEnabled()).toBe(true);
});
it('should not enable bracketed paste if not supported', async () => {
const manager = TerminalCapabilityManager.getInstance();
const promise = manager.detectCapabilities();
// Complete detection with DA1 only
stdin.emit('data', Buffer.from('\x1b[?62c'));
await promise;
expect(manager.isBracketedPasteSupported()).toBe(false);
expect(manager.isBracketedPasteEnabled()).toBe(false);
});
});
});

View File

@@ -11,6 +11,8 @@ import {
disableKittyKeyboardProtocol,
enableModifyOtherKeys,
disableModifyOtherKeys,
enableBracketedPasteMode,
disableBracketedPasteMode,
} from '@google/gemini-cli-core';
export type TerminalBackgroundColor = string | undefined;
@@ -23,6 +25,7 @@ export class TerminalCapabilityManager {
private static readonly TERMINAL_NAME_QUERY = '\x1b[>q';
private static readonly DEVICE_ATTRIBUTES_QUERY = '\x1b[c';
private static readonly MODIFY_OTHER_KEYS_QUERY = '\x1b[>4;?m';
private static readonly BRACKETED_PASTE_QUERY = '\x1b[?2004$p';
// Kitty keyboard flags: CSI ? flags u
// eslint-disable-next-line no-control-regex
@@ -40,6 +43,10 @@ export class TerminalCapabilityManager {
// modifyOtherKeys response: CSI > 4 ; level m
// eslint-disable-next-line no-control-regex
private static readonly MODIFY_OTHER_KEYS_REGEX = /\x1b\[>4;(\d+)m/;
// DECRQM response for bracketed paste: CSI ? 2004 ; Ps $ y
// Ps = 1 (set), 2 (reset), 3 (permanently set), 4 (permanently reset)
// eslint-disable-next-line no-control-regex
private static readonly BRACKETED_PASTE_REGEX = /\x1b\[\?2004;([1-4])\$y/;
private terminalBackgroundColor: TerminalBackgroundColor;
private kittySupported = false;
@@ -48,6 +55,8 @@ export class TerminalCapabilityManager {
private terminalName: string | undefined;
private modifyOtherKeysSupported = false;
private modifyOtherKeysEnabled = false;
private bracketedPasteSupported = false;
private bracketedPasteEnabled = false;
private constructor() {}
@@ -75,6 +84,21 @@ export class TerminalCapabilityManager {
return;
}
const cleanupOnExit = () => {
if (this.kittySupported) {
this.disableKittyProtocol();
}
if (this.modifyOtherKeysSupported) {
this.disableModifyOtherKeys();
}
if (this.bracketedPasteSupported) {
this.disableBracketedPaste();
}
};
process.on('exit', () => cleanupOnExit);
process.on('SIGTERM', () => cleanupOnExit);
process.on('SIGINT', cleanupOnExit);
return new Promise((resolve) => {
const originalRawMode = process.stdin.isRaw;
if (!originalRawMode) {
@@ -87,6 +111,7 @@ export class TerminalCapabilityManager {
let deviceAttributesReceived = false;
let bgReceived = false;
let modifyOtherKeysReceived = false;
let bracketedPasteReceived = false;
// eslint-disable-next-line prefer-const
let timeoutId: NodeJS.Timeout;
@@ -100,27 +125,14 @@ export class TerminalCapabilityManager {
}
this.detectionComplete = true;
// Auto-enable kitty if supported
if (this.kittySupported) {
this.enableKittyProtocol();
process.on('exit', () => this.disableKittyProtocol());
process.on('SIGTERM', () => this.disableKittyProtocol());
} else if (this.modifyOtherKeysSupported) {
this.enableModifyOtherKeys();
process.on('exit', () => this.disableModifyOtherKeys());
process.on('SIGTERM', () => this.disableModifyOtherKeys());
}
this.enableSupportedModes();
resolve();
};
const onTimeout = () => {
cleanup();
};
// A somewhat long timeout is acceptable as all terminals should respond
// to the device attributes query used as a sentinel.
timeoutId = setTimeout(onTimeout, 1000);
timeoutId = setTimeout(cleanup, 1000);
const onData = (data: Buffer) => {
buffer += data.toString();
@@ -149,6 +161,32 @@ export class TerminalCapabilityManager {
this.kittySupported = true;
}
// check for modifyOtherKeys support
if (!modifyOtherKeysReceived) {
const match = buffer.match(
TerminalCapabilityManager.MODIFY_OTHER_KEYS_REGEX,
);
if (match) {
modifyOtherKeysReceived = true;
const level = parseInt(match[1], 10);
this.modifyOtherKeysSupported = level >= 2;
debugLogger.log(
`Detected modifyOtherKeys support: ${this.modifyOtherKeysSupported} (level ${level})`,
);
}
}
// check for bracketed paste support
if (!bracketedPasteReceived) {
const match = buffer.match(
TerminalCapabilityManager.BRACKETED_PASTE_REGEX,
);
if (match) {
bracketedPasteReceived = true;
this.bracketedPasteSupported = true;
}
}
// Check for Terminal Name/Version response.
if (!terminalNameReceived) {
const match = buffer.match(
@@ -174,21 +212,6 @@ export class TerminalCapabilityManager {
cleanup();
}
}
// check for modifyOtherKeys support
if (!modifyOtherKeysReceived) {
const match = buffer.match(
TerminalCapabilityManager.MODIFY_OTHER_KEYS_REGEX,
);
if (match) {
modifyOtherKeysReceived = true;
const level = parseInt(match[1], 10);
this.modifyOtherKeysSupported = level >= 2;
debugLogger.log(
`Detected modifyOtherKeys support: ${this.modifyOtherKeysSupported} (level ${level})`,
);
}
}
};
process.stdin.on('data', onData);
@@ -200,6 +223,7 @@ export class TerminalCapabilityManager {
TerminalCapabilityManager.OSC_11_QUERY +
TerminalCapabilityManager.TERMINAL_NAME_QUERY +
TerminalCapabilityManager.MODIFY_OTHER_KEYS_QUERY +
TerminalCapabilityManager.BRACKETED_PASTE_QUERY +
TerminalCapabilityManager.DEVICE_ATTRIBUTES_QUERY,
);
} catch (e) {
@@ -209,6 +233,17 @@ export class TerminalCapabilityManager {
});
}
enableSupportedModes() {
if (this.kittySupported) {
this.enableKittyProtocol();
} else if (this.modifyOtherKeysSupported) {
this.enableModifyOtherKeys();
}
if (this.bracketedPasteSupported) {
this.enableBracketedPaste();
}
}
getTerminalBackgroundColor(): TerminalBackgroundColor {
return this.terminalBackgroundColor;
}
@@ -221,6 +256,36 @@ export class TerminalCapabilityManager {
return this.kittyEnabled;
}
isBracketedPasteSupported(): boolean {
return this.bracketedPasteSupported;
}
isBracketedPasteEnabled(): boolean {
return this.bracketedPasteEnabled;
}
enableBracketedPaste(): void {
try {
if (this.bracketedPasteSupported) {
enableBracketedPasteMode();
this.bracketedPasteEnabled = true;
}
} catch (e) {
debugLogger.warn('Failed to enable bracketed paste mode:', e);
}
}
disableBracketedPaste(): void {
try {
if (this.bracketedPasteEnabled) {
disableBracketedPasteMode();
this.bracketedPasteEnabled = false;
}
} catch (e) {
debugLogger.warn('Failed to disable bracketed paste mode:', e);
}
}
enableKittyProtocol(): void {
try {
if (this.kittySupported) {