Stop printing garbage characters for F1,F2.. keys (#12835)

This commit is contained in:
Tommaso Sciortino
2025-11-10 10:56:05 -08:00
committed by GitHub
parent 2136598e87
commit 3c9052a751
10 changed files with 70 additions and 18 deletions
@@ -188,6 +188,7 @@ describe('<ModelDialog />', () => {
meta: false,
shift: false,
paste: false,
insertable: false,
sequence: '',
});
expect(props.onClose).toHaveBeenCalledTimes(1);
@@ -198,6 +199,7 @@ describe('<ModelDialog />', () => {
meta: false,
shift: false,
paste: false,
insertable: true,
sequence: '',
});
expect(props.onClose).toHaveBeenCalledTimes(1);
@@ -977,6 +977,7 @@ describe('useTextBuffer', () => {
meta: false,
shift: false,
paste: false,
insertable: true,
sequence: 'h',
}),
);
@@ -987,6 +988,7 @@ describe('useTextBuffer', () => {
meta: false,
shift: false,
paste: false,
insertable: true,
sequence: 'i',
}),
);
@@ -1004,6 +1006,7 @@ describe('useTextBuffer', () => {
meta: false,
shift: false,
paste: false,
insertable: true,
sequence: '\r',
}),
);
@@ -1021,6 +1024,7 @@ describe('useTextBuffer', () => {
meta: false,
shift: false,
paste: false,
insertable: false,
sequence: '\t',
}),
);
@@ -1038,6 +1042,7 @@ describe('useTextBuffer', () => {
meta: false,
shift: true,
paste: false,
insertable: false,
sequence: '\u001b[9;2u',
}),
);
@@ -1060,6 +1065,7 @@ describe('useTextBuffer', () => {
meta: false,
shift: false,
paste: false,
insertable: false,
sequence: '\x7f',
}),
);
@@ -1084,6 +1090,7 @@ describe('useTextBuffer', () => {
meta: false,
shift: false,
paste: false,
insertable: false,
sequence: '\x7f',
});
result.current.handleInput({
@@ -1092,6 +1099,7 @@ describe('useTextBuffer', () => {
meta: false,
shift: false,
paste: false,
insertable: false,
sequence: '\x7f',
});
result.current.handleInput({
@@ -1100,6 +1108,7 @@ describe('useTextBuffer', () => {
meta: false,
shift: false,
paste: false,
insertable: false,
sequence: '\x7f',
});
});
@@ -1159,6 +1168,7 @@ describe('useTextBuffer', () => {
meta: false,
shift: false,
paste: false,
insertable: false,
sequence: '\x1b[D',
}),
); // cursor [0,1]
@@ -1170,6 +1180,7 @@ describe('useTextBuffer', () => {
meta: false,
shift: false,
paste: false,
insertable: false,
sequence: '\x1b[C',
}),
); // cursor [0,2]
@@ -1189,6 +1200,7 @@ describe('useTextBuffer', () => {
meta: false,
shift: false,
paste: false,
insertable: true,
sequence: textWithAnsi,
}),
);
@@ -1206,6 +1218,7 @@ describe('useTextBuffer', () => {
meta: false,
shift: true,
paste: false,
insertable: true,
sequence: '\r',
}),
); // Simulates Shift+Enter in VSCode terminal
@@ -1410,6 +1423,7 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
meta: false,
shift: false,
paste: false,
insertable: true,
sequence,
});
@@ -1468,6 +1482,7 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
meta: false,
shift: false,
paste: false,
insertable: true,
sequence: largeTextWithUnsafe,
}),
);
@@ -1502,6 +1517,7 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
meta: false,
shift: false,
paste: false,
insertable: true,
sequence: largeTextWithAnsi,
}),
);
@@ -1526,6 +1542,7 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
meta: false,
shift: false,
paste: false,
insertable: true,
sequence: emojis,
}),
);
@@ -1717,12 +1734,35 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
meta: false,
shift: false,
paste: false,
insertable: true,
sequence: '\r',
}),
);
expect(getBufferState(result).lines).toEqual(['']);
});
it('should not print anything for function keys when singleLine is true', () => {
const { result } = renderHook(() =>
useTextBuffer({
viewport,
isValidPath: () => false,
singleLine: true,
}),
);
act(() =>
result.current.handleInput({
name: 'f1',
ctrl: false,
meta: false,
shift: false,
paste: false,
insertable: false,
sequence: '\u001bOP',
}),
);
expect(getBufferState(result).lines).toEqual(['']);
});
it('should strip newlines from pasted text when singleLine is true', () => {
const { result } = renderHook(() =>
useTextBuffer({
@@ -17,6 +17,7 @@ import {
stripUnsafeCharacters,
getCachedStringWidth,
} from '../../utils/textUtils.js';
import type { Key } from '../../contexts/KeypressContext.js';
import type { VimAction } from './vim-buffer-actions.js';
import { handleVimAction } from './vim-buffer-actions.js';
@@ -1907,14 +1908,7 @@ export function useTextBuffer({
);
const handleInput = useCallback(
(key: {
name: string;
ctrl: boolean;
meta: boolean;
shift: boolean;
paste: boolean;
sequence: string;
}): void => {
(key: Key): void => {
const { sequence: input } = key;
if (key.paste) {
@@ -1964,7 +1958,7 @@ export function useTextBuffer({
else if (key.name === 'delete' || (key.ctrl && key.name === 'd')) del();
else if (key.ctrl && !key.shift && key.name === 'z') undo();
else if (key.ctrl && key.shift && key.name === 'z') redo();
else if (input && !key.ctrl && !key.meta && key.name !== 'tab') {
else if (key.insertable) {
insert(input, { paste: key.paste });
}
},
@@ -2266,14 +2260,7 @@ export interface TextBuffer {
/**
* High level "handleInput" receives what Ink gives us.
*/
handleInput: (key: {
name: string;
ctrl: boolean;
meta: boolean;
shift: boolean;
paste: boolean;
sequence: string;
}) => void;
handleInput: (key: Key) => void;
/**
* Opens the current buffer contents in the user's preferred terminal text
* editor ($VISUAL or $EDITOR, falling back to "vi"). The method blocks