Skip to content

Fix wrapper terminal reset for help output #739

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

Merged
jahooma merged 2 commits into from
May 24, 2026
+123 −30
Merged

Fix wrapper terminal reset for help output #739

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
76c5879
Fix wrapper terminal reset for help output
jahooma May 23, 2026
117b482
Handle Windows crash resets in wrappers
jahooma May 23, 2026
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
51 changes: 41 additions & 10 deletions cli/release-staging/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,9 @@ const packageName = 'codecane'
* Terminal escape sequences to reset terminal state after the child process exits.
* When the binary is SIGKILL'd, it can't clean up its own terminal state.
* The wrapper (this process) survives and must reset these modes.
*
* Keep in sync with TERMINAL_RESET_SEQUENCES in cli/src/utils/renderer-cleanup.ts
*/
const TERMINAL_RESET_SEQUENCES =
'\x1b[?1049l' + // Exit alternate screen buffer
const EXIT_ALTERNATE_SCREEN_SEQUENCE = '\x1b[?1049l'
const SAFE_TERMINAL_RESET_SEQUENCES =
'\x1b[?1000l' + // Disable X10 mouse mode
'\x1b[?1002l' + // Disable button event mouse mode
'\x1b[?1003l' + // Disable any-event mouse mode (all motion)
Expand All @@ -30,7 +28,12 @@ const TERMINAL_RESET_SEQUENCES =
'\x1b[?2004l' + // Disable bracketed paste mode
'\x1b[?25h' // Show cursor

function resetTerminal() {
const FULL_TERMINAL_RESET_SEQUENCES =
EXIT_ALTERNATE_SCREEN_SEQUENCE + SAFE_TERMINAL_RESET_SEQUENCES

function resetTerminal(options = {}) {
const { exitAlternateScreen = false } = options

try {
if (process.stdin.isTTY && process.stdin.setRawMode) {
process.stdin.setRawMode(false)
Expand All @@ -40,13 +43,37 @@ function resetTerminal() {
}
try {
if (process.stdout.isTTY) {
process.stdout.write(TERMINAL_RESET_SEQUENCES)
// Exiting the alternate screen is only safe after an interactive child.
// Plain CLI paths like --help never enter it, and ?1049l can erase output.
process.stdout.write(
exitAlternateScreen
? FULL_TERMINAL_RESET_SEQUENCES
: SAFE_TERMINAL_RESET_SEQUENCES,
)
}
} catch {
// stdout may be closed
}
}

function getUnsignedExitCode(code) {
return code != null && code < 0 ? (code >>> 0) : code
}

function isWindowsNativeCrashCode(code) {
const unsignedCode = getUnsignedExitCode(code)
return (
process.platform === 'win32' &&
(unsignedCode === 0xC000001D ||
unsignedCode === 0xC0000005 ||
unsignedCode === 0xC0000409)
)
}

function shouldExitAlternateScreen(code, signal) {
return Boolean(signal) || isWindowsNativeCrashCode(code)
}

function createConfig(packageName) {
const homeDir = os.homedir()
const configDir = path.join(homeDir, '.config', 'manicode')
Expand Down Expand Up @@ -465,7 +492,7 @@ async function checkForUpdates(runningProcess, exitListener) {
}, 5000)
})

resetTerminal()
resetTerminal({ exitAlternateScreen: true })
console.log(`Update available: ${currentVersion} → ${latestVersion}`)

await downloadBinary(latestVersion)
Expand All @@ -476,7 +503,9 @@ async function checkForUpdates(runningProcess, exitListener) {
})

newChild.on('exit', (code, signal) => {
resetTerminal()
resetTerminal({
exitAlternateScreen: shouldExitAlternateScreen(code, signal),
})
printCrashDiagnostics(code, signal)
process.exit(signal ? 1 : (code || 0))
})
Expand All @@ -495,7 +524,7 @@ async function checkForUpdates(runningProcess, exitListener) {

function printCrashDiagnostics(code, signal) {
// Windows NTSTATUS codes (unsigned DWORD)
const unsignedCode = code != null && code < 0 ? (code >>> 0) : code
const unsignedCode = getUnsignedExitCode(code)
const isIllegalInstruction =
signal === 'SIGILL' ||
(process.platform === 'win32' && unsignedCode === 0xC000001D)
Expand Down Expand Up @@ -557,7 +586,9 @@ async function main() {
})

const exitListener = (code, signal) => {
resetTerminal()
resetTerminal({
exitAlternateScreen: shouldExitAlternateScreen(code, signal),
})
printCrashDiagnostics(code, signal)
process.exit(signal ? 1 : (code || 0))
}
Expand Down
51 changes: 41 additions & 10 deletions cli/release/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,9 @@ const packageName = 'codebuff'
* Terminal escape sequences to reset terminal state after the child process exits.
* When the binary is SIGKILL'd, it can't clean up its own terminal state.
* The wrapper (this process) survives and must reset these modes.
*
* Keep in sync with TERMINAL_RESET_SEQUENCES in cli/src/utils/renderer-cleanup.ts
*/
const TERMINAL_RESET_SEQUENCES =
'\x1b[?1049l' + // Exit alternate screen buffer
const EXIT_ALTERNATE_SCREEN_SEQUENCE = '\x1b[?1049l'
const SAFE_TERMINAL_RESET_SEQUENCES =
'\x1b[?1000l' + // Disable X10 mouse mode
'\x1b[?1002l' + // Disable button event mouse mode
'\x1b[?1003l' + // Disable any-event mouse mode (all motion)
Expand All @@ -30,7 +28,12 @@ const TERMINAL_RESET_SEQUENCES =
'\x1b[?2004l' + // Disable bracketed paste mode
'\x1b[?25h' // Show cursor

function resetTerminal() {
const FULL_TERMINAL_RESET_SEQUENCES =
EXIT_ALTERNATE_SCREEN_SEQUENCE + SAFE_TERMINAL_RESET_SEQUENCES

function resetTerminal(options = {}) {
const { exitAlternateScreen = false } = options

try {
if (process.stdin.isTTY && process.stdin.setRawMode) {
process.stdin.setRawMode(false)
Expand All @@ -40,13 +43,37 @@ function resetTerminal() {
}
try {
if (process.stdout.isTTY) {
process.stdout.write(TERMINAL_RESET_SEQUENCES)
// Exiting the alternate screen is only safe after an interactive child.
// Plain CLI paths like --help never enter it, and ?1049l can erase output.
process.stdout.write(
exitAlternateScreen
? FULL_TERMINAL_RESET_SEQUENCES
: SAFE_TERMINAL_RESET_SEQUENCES,
)
}
} catch {
// stdout may be closed
}
}

function getUnsignedExitCode(code) {
return code != null && code < 0 ? (code >>> 0) : code
}

function isWindowsNativeCrashCode(code) {
const unsignedCode = getUnsignedExitCode(code)
return (
process.platform === 'win32' &&
(unsignedCode === 0xC000001D ||
unsignedCode === 0xC0000005 ||
unsignedCode === 0xC0000409)
)
}

function shouldExitAlternateScreen(code, signal) {
return Boolean(signal) || isWindowsNativeCrashCode(code)
}

function createConfig(packageName) {
const homeDir = os.homedir()
const configDir = path.join(homeDir, '.config', 'manicode')
Expand Down Expand Up @@ -485,15 +512,17 @@ async function checkForUpdates(runningProcess, exitListener) {
}, 5000)
})

resetTerminal()
resetTerminal({ exitAlternateScreen: true })
console.log(`Update available: ${currentVersion} → ${latestVersion}`)

await downloadBinary(latestVersion)

const newChild = spawnInstalledBinary({ detached: false })

newChild.on('exit', (code, signal) => {
resetTerminal()
resetTerminal({
exitAlternateScreen: shouldExitAlternateScreen(code, signal),
})
printCrashDiagnostics(code, signal)
process.exit(signal ? 1 : (code || 0))
})
Expand All @@ -507,7 +536,7 @@ async function checkForUpdates(runningProcess, exitListener) {

function printCrashDiagnostics(code, signal) {
// Windows NTSTATUS codes (unsigned DWORD)
const unsignedCode = code != null && code < 0 ? (code >>> 0) : code
const unsignedCode = getUnsignedExitCode(code)
const isIllegalInstruction =
signal === 'SIGILL' ||
(process.platform === 'win32' && unsignedCode === 0xC000001D)
Expand Down Expand Up @@ -625,7 +654,9 @@ async function main() {
const child = spawnInstalledBinary()

const exitListener = (code, signal) => {
resetTerminal()
resetTerminal({
exitAlternateScreen: shouldExitAlternateScreen(code, signal),
})
printCrashDiagnostics(code, signal)
process.exit(signal ? 1 : (code || 0))
}
Expand Down
51 changes: 41 additions & 10 deletions freebuff/cli/release/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,9 @@ const packageName = 'freebuff'
* Terminal escape sequences to reset terminal state after the child process exits.
* When the binary is SIGKILL'd, it can't clean up its own terminal state.
* The wrapper (this process) survives and must reset these modes.
*
* Keep in sync with TERMINAL_RESET_SEQUENCES in cli/src/utils/renderer-cleanup.ts
*/
const TERMINAL_RESET_SEQUENCES =
'\x1b[?1049l' + // Exit alternate screen buffer
const EXIT_ALTERNATE_SCREEN_SEQUENCE = '\x1b[?1049l'
const SAFE_TERMINAL_RESET_SEQUENCES =
'\x1b[?1000l' + // Disable X10 mouse mode
'\x1b[?1002l' + // Disable button event mouse mode
'\x1b[?1003l' + // Disable any-event mouse mode (all motion)
Expand All @@ -30,7 +28,12 @@ const TERMINAL_RESET_SEQUENCES =
'\x1b[?2004l' + // Disable bracketed paste mode
'\x1b[?25h' // Show cursor

function resetTerminal() {
const FULL_TERMINAL_RESET_SEQUENCES =
EXIT_ALTERNATE_SCREEN_SEQUENCE + SAFE_TERMINAL_RESET_SEQUENCES

function resetTerminal(options = {}) {
const { exitAlternateScreen = false } = options

try {
if (process.stdin.isTTY && process.stdin.setRawMode) {
process.stdin.setRawMode(false)
Expand All @@ -40,13 +43,37 @@ function resetTerminal() {
}
try {
if (process.stdout.isTTY) {
process.stdout.write(TERMINAL_RESET_SEQUENCES)
// Exiting the alternate screen is only safe after an interactive child.
// Plain CLI paths like --help never enter it, and ?1049l can erase output.
process.stdout.write(
exitAlternateScreen
? FULL_TERMINAL_RESET_SEQUENCES
: SAFE_TERMINAL_RESET_SEQUENCES,
)
}
} catch {
// stdout may be closed
}
}

function getUnsignedExitCode(code) {
return code != null && code < 0 ? (code >>> 0) : code
}

function isWindowsNativeCrashCode(code) {
const unsignedCode = getUnsignedExitCode(code)
return (
process.platform === 'win32' &&
(unsignedCode === 0xC000001D ||
unsignedCode === 0xC0000005 ||
unsignedCode === 0xC0000409)
)
}

function shouldExitAlternateScreen(code, signal) {
return Boolean(signal) || isWindowsNativeCrashCode(code)
}

function createConfig(packageName) {
const homeDir = os.homedir()
const configDir = path.join(homeDir, '.config', 'manicode')
Expand Down Expand Up @@ -472,15 +499,17 @@ async function checkForUpdates(runningProcess, exitListener) {
}, 5000)
})

resetTerminal()
resetTerminal({ exitAlternateScreen: true })
console.log(`Update available: ${currentVersion} → ${latestVersion}`)

await downloadBinary(latestVersion)

const newChild = spawnInstalledBinary({ detached: false })

newChild.on('exit', (code, signal) => {
resetTerminal()
resetTerminal({
exitAlternateScreen: shouldExitAlternateScreen(code, signal),
})
printCrashDiagnostics(code, signal)
process.exit(signal ? 1 : (code || 0))
})
Expand All @@ -494,7 +523,7 @@ async function checkForUpdates(runningProcess, exitListener) {

function printCrashDiagnostics(code, signal) {
// Windows NTSTATUS codes (unsigned DWORD)
const unsignedCode = code != null && code < 0 ? (code >>> 0) : code
const unsignedCode = getUnsignedExitCode(code)
const isIllegalInstruction =
signal === 'SIGILL' ||
(process.platform === 'win32' && unsignedCode === 0xC000001D)
Expand Down Expand Up @@ -612,7 +641,9 @@ async function main() {
const child = spawnInstalledBinary()

const exitListener = (code, signal) => {
resetTerminal()
resetTerminal({
exitAlternateScreen: shouldExitAlternateScreen(code, signal),
})
printCrashDiagnostics(code, signal)
process.exit(signal ? 1 : (code || 0))
}
Expand Down
Loading