feat: add support for kitty terminal protocol (#1334)

This commit is contained in:
Kian Jones
2026-03-18 16:38:02 -07:00
committed by GitHub
parent 8d8663adec
commit 63eccd037b
3 changed files with 463 additions and 2 deletions

View File

@@ -147,21 +147,32 @@ const useInput = (inputHandler, options = {}) => {
return; return;
} }
// Map keycodes to names // Map keycodes to names and actual character sequences
const csiUKeyMap = { const csiUKeyMap = {
9: 'tab', 9: 'tab',
13: 'return', 13: 'return',
27: 'escape', 27: 'escape',
32: 'space',
127: 'backspace', 127: 'backspace',
}; };
const csiUSeqMap = {
9: '\t',
13: '\r',
27: '\x1b',
32: ' ',
127: '\x7f',
};
let name = csiUKeyMap[keycode] || ''; let name = csiUKeyMap[keycode] || '';
let seq = csiUSeqMap[keycode] || data;
// Handle letter keycodes (a-z: 97-122, A-Z: 65-90) // Handle letter keycodes (a-z: 97-122, A-Z: 65-90)
if (!name && keycode >= 97 && keycode <= 122) { if (!name && keycode >= 97 && keycode <= 122) {
name = String.fromCharCode(keycode); // lowercase letter name = String.fromCharCode(keycode); // lowercase letter
seq = String.fromCharCode(keycode);
} else if (!name && keycode >= 65 && keycode <= 90) { } else if (!name && keycode >= 65 && keycode <= 90) {
name = String.fromCharCode(keycode + 32); // convert to lowercase name = String.fromCharCode(keycode + 32); // convert to lowercase
seq = String.fromCharCode(keycode + 32);
} }
if (name) { if (name) {
@@ -171,7 +182,7 @@ const useInput = (inputHandler, options = {}) => {
meta: !!(modifier & 10), meta: !!(modifier & 10),
shift: !!(modifier & 1), shift: !!(modifier & 1),
option: false, option: false,
sequence: data, sequence: seq,
raw: data, raw: data,
}; };
} }

View File

@@ -0,0 +1,225 @@
// Copied from https://github.com/enquirer/enquirer/blob/36785f3399a41cd61e9d28d1eb9c2fcd73d69b4c/lib/keypress.js
import { Buffer } from 'node:buffer';
const metaKeyCodeRe = /^(?:\x1b)([a-zA-Z0-9])$/;
const fnKeyRe = /^(?:\x1b+)(O|N|\[|\[\[)(?:(\d+)(?:;(\d+))?([~^$])|(?:1;)?(\d+)?([a-zA-Z]))/;
const keyName = {
/* xterm/gnome ESC O letter */
OP: 'f1',
OQ: 'f2',
OR: 'f3',
OS: 'f4',
/* xterm/rxvt ESC [ number ~ */
'[11~': 'f1',
'[12~': 'f2',
'[13~': 'f3',
'[14~': 'f4',
/* from Cygwin and used in libuv */
'[[A': 'f1',
'[[B': 'f2',
'[[C': 'f3',
'[[D': 'f4',
'[[E': 'f5',
/* common */
'[15~': 'f5',
'[17~': 'f6',
'[18~': 'f7',
'[19~': 'f8',
'[20~': 'f9',
'[21~': 'f10',
'[23~': 'f11',
'[24~': 'f12',
/* xterm ESC [ letter */
'[A': 'up',
'[B': 'down',
'[C': 'right',
'[D': 'left',
'[E': 'clear',
'[F': 'end',
'[H': 'home',
/* xterm/gnome ESC O letter */
OA: 'up',
OB: 'down',
OC: 'right',
OD: 'left',
OE: 'clear',
OF: 'end',
OH: 'home',
/* xterm/rxvt ESC [ number ~ */
'[1~': 'home',
'[2~': 'insert',
'[3~': 'delete',
'[4~': 'end',
'[5~': 'pageup',
'[6~': 'pagedown',
/* putty */
'[[5~': 'pageup',
'[[6~': 'pagedown',
/* rxvt */
'[7~': 'home',
'[8~': 'end',
/* rxvt keys with modifiers */
'[a': 'up',
'[b': 'down',
'[c': 'right',
'[d': 'left',
'[e': 'clear',
'[2$': 'insert',
'[3$': 'delete',
'[5$': 'pageup',
'[6$': 'pagedown',
'[7$': 'home',
'[8$': 'end',
Oa: 'up',
Ob: 'down',
Oc: 'right',
Od: 'left',
Oe: 'clear',
'[2^': 'insert',
'[3^': 'delete',
'[5^': 'pageup',
'[6^': 'pagedown',
'[7^': 'home',
'[8^': 'end',
/* misc. */
'[Z': 'tab',
};
export const nonAlphanumericKeys = [...Object.values(keyName), 'backspace'];
const isShiftKey = (code) => {
return [
'[a',
'[b',
'[c',
'[d',
'[e',
'[2$',
'[3$',
'[5$',
'[6$',
'[7$',
'[8$',
'[Z',
].includes(code);
};
const isCtrlKey = (code) => {
return [
'Oa',
'Ob',
'Oc',
'Od',
'Oe',
'[2^',
'[3^',
'[5^',
'[6^',
'[7^',
'[8^',
].includes(code);
};
const parseKeypress = (s = '') => {
let parts;
if (Buffer.isBuffer(s)) {
if (s[0] > 127 && s[1] === undefined) {
s[0] -= 128;
s = '\x1b' + String(s);
}
else {
s = String(s);
}
}
else if (s !== undefined && typeof s !== 'string') {
s = String(s);
}
else if (!s) {
s = '';
}
const key = {
name: '',
ctrl: false,
meta: false,
shift: false,
option: false,
sequence: s,
raw: s,
};
key.sequence = key.sequence || s || key.name;
if (s === '\r') {
// carriage return
key.raw = undefined;
key.name = 'return';
}
else if (s === '\n') {
// enter, should have been called linefeed
key.name = 'enter';
}
else if (s === '\t') {
// tab
key.name = 'tab';
}
else if (s === '\b' || s === '\x1b\b') {
// backspace or ctrl+h
key.name = 'backspace';
key.meta = s.charAt(0) === '\x1b';
}
else if (s === '\x7f' || s === '\x1b\x7f') {
// TODO(vadimdemedes): `enquirer` detects delete key as backspace, but I had to split them up to avoid breaking changes in Ink. Merge them back together in the next major version.
// delete
key.name = 'delete';
key.meta = s.charAt(0) === '\x1b';
}
else if (s === '\x1b' || s === '\x1b\x1b') {
// escape key
key.name = 'escape';
key.meta = s.length === 2;
}
else if (s === ' ' || s === '\x1b ') {
key.name = 'space';
key.meta = s.length === 2;
}
else if (s <= '\x1a') {
// ctrl+letter
key.name = String.fromCharCode(s.charCodeAt(0) + 'a'.charCodeAt(0) - 1);
key.ctrl = true;
}
else if (s.length === 1 && s >= '0' && s <= '9') {
// number
key.name = 'number';
}
else if (s.length === 1 && s >= 'a' && s <= 'z') {
// lowercase letter
key.name = s;
}
else if (s.length === 1 && s >= 'A' && s <= 'Z') {
// shift+letter
key.name = s.toLowerCase();
key.shift = true;
}
else if ((parts = metaKeyCodeRe.exec(s))) {
// meta+character key
key.meta = true;
key.shift = /^[A-Z]$/.test(parts[1]);
}
else if ((parts = fnKeyRe.exec(s))) {
const segs = [...s];
if (segs[0] === '\u001b' && segs[1] === '\u001b') {
key.option = true;
}
// ansi escape sequence
// reassemble the key code leaving out leading \x1b's,
// the modifier key bitflag and any meaningless "1;" sequence
const code = [parts[1], parts[2], parts[4], parts[6]]
.filter(Boolean)
.join('');
const modifier = (parts[3] || parts[5] || 1) - 1;
// Parse the key modifier
key.ctrl = !!(modifier & 4);
key.meta = !!(modifier & 10);
key.shift = !!(modifier & 1);
key.code = code;
key.name = keyName[code];
key.shift = isShiftKey(code) || key.shift;
key.ctrl = isCtrlKey(code) || key.ctrl;
}
return key;
};
export default parseKeypress;
//# sourceMappingURL=parse-keypress.js.map

225
vendor/ink/build/parse-keypress.js vendored Normal file
View File

@@ -0,0 +1,225 @@
// Copied from https://github.com/enquirer/enquirer/blob/36785f3399a41cd61e9d28d1eb9c2fcd73d69b4c/lib/keypress.js
import { Buffer } from 'node:buffer';
const metaKeyCodeRe = /^(?:\x1b)([a-zA-Z0-9])$/;
const fnKeyRe = /^(?:\x1b+)(O|N|\[|\[\[)(?:(\d+)(?:;(\d+))?([~^$])|(?:1;)?(\d+)?([a-zA-Z]))/;
const keyName = {
/* xterm/gnome ESC O letter */
OP: 'f1',
OQ: 'f2',
OR: 'f3',
OS: 'f4',
/* xterm/rxvt ESC [ number ~ */
'[11~': 'f1',
'[12~': 'f2',
'[13~': 'f3',
'[14~': 'f4',
/* from Cygwin and used in libuv */
'[[A': 'f1',
'[[B': 'f2',
'[[C': 'f3',
'[[D': 'f4',
'[[E': 'f5',
/* common */
'[15~': 'f5',
'[17~': 'f6',
'[18~': 'f7',
'[19~': 'f8',
'[20~': 'f9',
'[21~': 'f10',
'[23~': 'f11',
'[24~': 'f12',
/* xterm ESC [ letter */
'[A': 'up',
'[B': 'down',
'[C': 'right',
'[D': 'left',
'[E': 'clear',
'[F': 'end',
'[H': 'home',
/* xterm/gnome ESC O letter */
OA: 'up',
OB: 'down',
OC: 'right',
OD: 'left',
OE: 'clear',
OF: 'end',
OH: 'home',
/* xterm/rxvt ESC [ number ~ */
'[1~': 'home',
'[2~': 'insert',
'[3~': 'delete',
'[4~': 'end',
'[5~': 'pageup',
'[6~': 'pagedown',
/* putty */
'[[5~': 'pageup',
'[[6~': 'pagedown',
/* rxvt */
'[7~': 'home',
'[8~': 'end',
/* rxvt keys with modifiers */
'[a': 'up',
'[b': 'down',
'[c': 'right',
'[d': 'left',
'[e': 'clear',
'[2$': 'insert',
'[3$': 'delete',
'[5$': 'pageup',
'[6$': 'pagedown',
'[7$': 'home',
'[8$': 'end',
Oa: 'up',
Ob: 'down',
Oc: 'right',
Od: 'left',
Oe: 'clear',
'[2^': 'insert',
'[3^': 'delete',
'[5^': 'pageup',
'[6^': 'pagedown',
'[7^': 'home',
'[8^': 'end',
/* misc. */
'[Z': 'tab',
};
export const nonAlphanumericKeys = [...Object.values(keyName), 'backspace'];
const isShiftKey = (code) => {
return [
'[a',
'[b',
'[c',
'[d',
'[e',
'[2$',
'[3$',
'[5$',
'[6$',
'[7$',
'[8$',
'[Z',
].includes(code);
};
const isCtrlKey = (code) => {
return [
'Oa',
'Ob',
'Oc',
'Od',
'Oe',
'[2^',
'[3^',
'[5^',
'[6^',
'[7^',
'[8^',
].includes(code);
};
const parseKeypress = (s = '') => {
let parts;
if (Buffer.isBuffer(s)) {
if (s[0] > 127 && s[1] === undefined) {
s[0] -= 128;
s = '\x1b' + String(s);
}
else {
s = String(s);
}
}
else if (s !== undefined && typeof s !== 'string') {
s = String(s);
}
else if (!s) {
s = '';
}
const key = {
name: '',
ctrl: false,
meta: false,
shift: false,
option: false,
sequence: s,
raw: s,
};
key.sequence = key.sequence || s || key.name;
if (s === '\r') {
// carriage return
key.raw = undefined;
key.name = 'return';
}
else if (s === '\n') {
// enter, should have been called linefeed
key.name = 'enter';
}
else if (s === '\t') {
// tab
key.name = 'tab';
}
else if (s === '\b' || s === '\x1b\b') {
// backspace or ctrl+h
key.name = 'backspace';
key.meta = s.charAt(0) === '\x1b';
}
else if (s === '\x7f' || s === '\x1b\x7f') {
// TODO(vadimdemedes): `enquirer` detects delete key as backspace, but I had to split them up to avoid breaking changes in Ink. Merge them back together in the next major version.
// delete
key.name = 'delete';
key.meta = s.charAt(0) === '\x1b';
}
else if (s === '\x1b' || s === '\x1b\x1b') {
// escape key
key.name = 'escape';
key.meta = s.length === 2;
}
else if (s === ' ' || s === '\x1b ') {
key.name = 'space';
key.meta = s.length === 2;
}
else if (s <= '\x1a') {
// ctrl+letter
key.name = String.fromCharCode(s.charCodeAt(0) + 'a'.charCodeAt(0) - 1);
key.ctrl = true;
}
else if (s.length === 1 && s >= '0' && s <= '9') {
// number
key.name = 'number';
}
else if (s.length === 1 && s >= 'a' && s <= 'z') {
// lowercase letter
key.name = s;
}
else if (s.length === 1 && s >= 'A' && s <= 'Z') {
// shift+letter
key.name = s.toLowerCase();
key.shift = true;
}
else if ((parts = metaKeyCodeRe.exec(s))) {
// meta+character key
key.meta = true;
key.shift = /^[A-Z]$/.test(parts[1]);
}
else if ((parts = fnKeyRe.exec(s))) {
const segs = [...s];
if (segs[0] === '\u001b' && segs[1] === '\u001b') {
key.option = true;
}
// ansi escape sequence
// reassemble the key code leaving out leading \x1b's,
// the modifier key bitflag and any meaningless "1;" sequence
const code = [parts[1], parts[2], parts[4], parts[6]]
.filter(Boolean)
.join('');
const modifier = (parts[3] || parts[5] || 1) - 1;
// Parse the key modifier
key.ctrl = !!(modifier & 4);
key.meta = !!(modifier & 10);
key.shift = !!(modifier & 1);
key.code = code;
key.name = keyName[code];
key.shift = isShiftKey(code) || key.shift;
key.ctrl = isCtrlKey(code) || key.ctrl;
}
return key;
};
export default parseKeypress;
//# sourceMappingURL=parse-keypress.js.map