xtermjs/xterm.js

Support using option key on MacOS for Escape-Codes

Open

#4,904 opened on Dec 7, 2023

View on GitHub
 (0 comments) (2 reactions) (0 assignees)TypeScript (16,196 stars) (1,574 forks)batch import
area/keyboardhelp wantedplatform/macostype/enhancement

Description

Request for a macOptionIsEscape terminal option: https://github.com/microsoft/vscode/issues/127764

Contributor guide

Tech stack
typescript
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript knowledgexterm.js codebase familiarityTerminal escape codes understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
First, understand the request by reviewing the linked VS Code issue (microsoft/vscode#127764) for the expected behavior. Then examine the xterm.js source to see how terminal options are defined and used, likely in the OptionsService or related files. Look for existing Mac specific options or keybinding handling to model the implementation. No existing PRs or comments provide further direction, so the implementation should be straightforward: add a new option 'macOptionIsEscape' and handle the option key mapping accordingly.