fix(simulation): mirror kitty keyboard protocol - #39741
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Keep headless simulation input on the same keyboard protocol configured for the TUI. This makes simulated keys behave like keys sent to the corresponding OpenTUI renderer.
Before / After
Before:
SimulationRenderer.create({ useKittyKeyboard: ... })forwarded the option to the application but created the headless OpenTUI renderer withoutkittyKeyboard. A simulated Escape was therefore emitted as legacy input, which could enter OpenTUI's escape-sequence disambiguation path instead of behaving like the configured Kitty key.After: the headless renderer receives
kittyKeyboard: truewheneveruseKittyKeyboardis configured. Simulated Escape is emitted immediately withsource: "kitty", matching the application's keyboard mode.How
packages/simulation/src/frontend/renderer.tsmirrorsuseKittyKeyboardintocreateTestRenderer.packages/simulation/test/actions.test.tsverifies thatui.press("escape")emits a Kitty keyboard event.Scope
This only aligns the existing headless renderer with the existing application option. It does not change key normalization, terminal input parsing, or the simulation protocol.
Testing
bun testinpackages/simulation(39 tests)bun run typecheckinpackages/simulationFlow
sequenceDiagram participant App as Simulated TUI participant Renderer as Headless OpenTUI renderer participant Drive as Simulation client App->>Renderer: configure Kitty keyboard mode Drive->>Renderer: press Escape Renderer-->>App: keypress source=kitty