Skip to content

fix: strip all ANSI escape sequences in terminal command output #838

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
OmarAlaaeldein wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: strip all ANSI escape sequences in terminal command output #838

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 15 additions & 2 deletions sdk/src/tools/run-terminal-command.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import * as path from 'path'
import type { ChildProcess } from 'child_process'

import {
stripColors,
stripAnsi,
truncateStringWithMessage,
} from '../../../common/src/util/string'
import { getSystemProcessEnv } from '../env'
Expand Down Expand Up @@ -175,6 +175,14 @@ export function runTerminalCommand({
const processEnv = {
...getSystemProcessEnv(),
...(env ?? {}),
// Use a plain-text sudo prompt so sudo doesn't emit ANSI color/cursor
// sequences when asking for a password. Without this, sudo writes
// decorated prompts to /dev/tty that can bleed into the TUI.
SUDO_PROMPT: '[sudo] password: ',
// Signal to child programs that this is a dumb non-interactive terminal
// so they suppress color output and cursor-movement sequences.
// (Only set if the caller hasn't explicitly overridden it.)
...((env ?? {}).TERM === undefined && { TERM: 'dumb' }),
} as NodeJS.ProcessEnv

if (signal?.aborted) {
Expand Down Expand Up @@ -241,7 +249,12 @@ export function runTerminalCommand({

const truncateOutput = (str: string) =>
truncateStringWithMessage({
str: stripColors(str),
// Strip all ANSI/VT escape sequences (not just color codes) so that
// cursor-movement, scroll-region, alternate-screen and other control
// sequences emitted by sudo and interactive programs don't bleed into
// the TUI and corrupt its scroll state or render garbage characters.
// Also normalise bare \r that sudo uses to overwrite its prompt line.
str: stripAnsi(str).replace(/\r/g, ''),
maxLength: COMMAND_OUTPUT_LIMIT,
remove: 'MIDDLE',
})
Expand Down