Skip to content

feat: support shift+enter in terminal #19021

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: support shift+enter in terminal #19021

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
963f4d0
feat: support shift+enter in terminal
code-asher Jul 23, 2025
77d94ae
Name the escaped carriage return
code-asher Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions site/src/pages/TerminalPage/TerminalPage.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import "jest-canvas-mock";
import { waitFor } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import { API } from "api/api";
import WS from "jest-websocket-mock";
import { http, HttpResponse } from "msw";
Expand Down Expand Up @@ -148,4 +149,21 @@ describe("TerminalPage", () => {
ws.send(text);
await expectTerminalText(container, text);
});

it("supports shift+enter", async () => {
const ws = new WS(
`ws://localhost/api/v2/workspaceagents/${MockWorkspaceAgent.id}/pty`,
);

const { container } = await renderTerminal();
// Ideally we could use ws.connected but that seems to pause React updates.
// For now, wait for the initial resize message instead.
await ws.nextMessage;

const msg = ws.nextMessage;
const terminal = container.getElementsByClassName("xterm");
await userEvent.type(terminal[0], "{Shift>}{Enter}{/Shift}");
const req = JSON.parse(new TextDecoder().decode((await msg) as Uint8Array));
expect(req.data).toBe("\x1b\r");
});
});
20 changes: 20 additions & 0 deletions site/src/pages/TerminalPage/TerminalPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,23 @@ const TerminalPage: FC = () => {
}),
);

// Make shift+enter send ^[^M (escaped carriage return). Applications
// typically take this to mean to insert a literal newline. There is no way
// to remove this handler, so we must attach it once and rely on a ref to
// send it to the current socket.
const escapedCarriageReturn = "\x1b\r";
terminal.attachCustomKeyEventHandler((ev) => {
if (ev.shiftKey && ev.key === "Enter") {
if (ev.type === "keydown") {
websocketRef.current?.send(
new TextEncoder().encode(JSON.stringify({ data: escapedCarriageReturn })),
);
}
return false;
}
return true;
});

terminal.open(terminalWrapperRef.current);

// We have to fit twice here. It's unknown why, but the first fit will
Expand Down Expand Up @@ -190,6 +207,7 @@ const TerminalPage: FC = () => {
}, [navigate, reconnectionToken, searchParams]);

// Hook up the terminal through a web socket.
const websocketRef = useRef<Websocket>();
useEffect(() => {
if (!terminal) {
return;
Expand Down Expand Up @@ -270,6 +288,7 @@ const TerminalPage: FC = () => {
.withBackoff(new ExponentialBackoff(1000, 6))
.build();
websocket.binaryType = "arraybuffer";
websocketRef.current = websocket;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you need to do this? It looks strange to me.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

attachCustomKeyEventHandler has no disposer, so we can only add it once, which means I have to do it when we create the terminal (if I did it here we would create additional handlers on every reconnect). But that means I need a stable reference to the websocket.

Is there another way of doing this maybe?

websocket.addEventListener(WebsocketEvent.open, () => {
// Now that we are connected, allow user input.
terminal.options = {
Expand Down Expand Up @@ -333,6 +352,7 @@ const TerminalPage: FC = () => {
d.dispose();
}
websocket?.close(1000);
websocketRef.current = undefined;
};
}, [
command,
Expand Down
Loading