AI Fix: alt (option) + b/f doesn't work on iTerm2 on macOS #237
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR refactors the readline implementation by removing the old CLI scaffolding and relocating the core code, and adds explicit handling for Option+B/F sequences on iTerm2 to enable word-wise cursor movement. Sequence diagram for Option+B/F key handling in iTerm2 (word-wise movement)sequenceDiagram
participant User as actor User
participant Terminal
participant Buffer
User->>Terminal: Press Option+B or Option+F
Terminal->>"Readline()": Send ESC [ b or ESC [ f
"Readline()"->>Buffer: MoveLeftWord() (for 'b') / MoveRightWord() (for 'f')
Buffer-->>"Readline()": Update cursor position
"Readline()"-->>Terminal: Display updated line
Class diagram for updated key handling in ReadlineclassDiagram
class Instance {
+Readline() string, error
+HistoryEnable()
+HistoryDisable()
-historyPrev(buf, currentLineBuf)
-historyNext(buf, currentLineBuf)
Prompt *Prompt
Terminal *Terminal
History *History
Pasting bool
}
class Terminal {
+Read() (rune, error)
outchan chan rune
rawmode bool
termios any
}
class Buffer {
+MoveLeftWord()
+MoveRightWord()
+Add(rune)
+Replace([]rune)
+MoveLeft()
+MoveRight()
+IsEmpty() bool
+DisplaySize() int
+Delete()
+Remove()
+String() string
+ClearScreen()
+DeleteWord()
+DeleteRemaining()
+DeleteBefore()
+MoveToStart()
+MoveToEnd()
}
Instance --> Prompt
Instance --> Terminal
Instance --> History
Instance --> Buffer
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Summary of ChangesHello @Vaibhav-kesarwani, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request resolves a specific keybinding incompatibility within the CLI's readline functionality when used in iTerm2 on macOS. By correctly interpreting the escape sequences sent by iTerm2 for Option+B and Option+F, it enables seamless word-by-word navigation, significantly enhancing the command-line experience for macOS users. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request aims to fix an issue with Alt+B/F key combinations on iTerm2 by handling specific escape sequences. The change correctly adds handlers for ESC [ b and ESC [ f.
However, I've noticed a potential issue with the implementation. The comments in the code indicate that iTerm2 can also send more complex sequences like ESC [ 1;3b, but the current change does not handle these. This could lead to the fix being incomplete. My review comment provides more detail on this.
I also noticed that the PR description mentions removing the custom readline implementation, but the provided diff shows a modification to it instead. This might be a bit confusing, but I've focused my review on the code changes as presented.
|
Could you mark this as draft while you are working on it @Vaibhav-kesarwani |
2 participants
This PR was automatically generated by AI 🤖
Issue: alt (option) + b/f doesn't work on iTerm2 on macOS
Summary by Sourcery
Remove the custom cmd/cli/readline implementation in favor of the core readline package and add support for iTerm2 Option+B/F word navigation.
Bug Fixes:
Enhancements: