Add rprompt support for right-side prompt display (take 2)#879
Merged
tompng merged 3 commits intoruby:masterfrom Feb 3, 2026
Merged
Add rprompt support for right-side prompt display (take 2)#879tompng merged 3 commits intoruby:masterfrom
tompng merged 3 commits intoruby:masterfrom
Conversation
tompng
reviewed
Feb 3, 2026
lib/reline.rb
Outdated
| Reline::DEFAULT_DIALOG_CONTEXT = Array.new # :nodoc: | ||
|
|
||
| def readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination) | ||
| def readmultiline(_prompt = '', _add_hist = false, prompt: _prompt, add_hist: _add_hist, rprompt: nil, &confirm_multiline_termination) |
Member
There was a problem hiding this comment.
Can this add_hist: be add_history:?
Member
Author
There was a problem hiding this comment.
Did so, and actually replaced all occurrences of add_hist to add_history, because I found that changing the kwarg name only to add_history and keeping positional arg name and ivar name be add_hist makes the code hard to read.
This adds support for displaying a right-aligned prompt (rprompt)
similar to zsh's RPROMPT feature. The rprompt is displayed at the
right edge of the terminal and automatically hides when the input
line gets too long.
Usage:
Reline.readline("> ", rprompt: "[%H:%M]")
The rprompt is rendered as part of Reline's normal render cycle,
so it persists during line editing unlike workarounds using
pre_input_hook.
for prompt, add_hist, and rprompt.
amatsuda
force-pushed
the
rprompt_kwarg
branch
from
333509f to
ab872cb
Compare
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
2 participants
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.
Here's another take for the RPROMPT feature that I sent at #878.
Based on a discussion with @tompng, I changed the API from the
Reline.rprompt=setter to a keyword argument forReline.readline/Reline.readmultiline.Added was a keyword argument
rprompt:, plus,prompt:andadd_hist:for consistency, keeping the existing positional ones for compatibility.Usage
or
Testing
Try this. Now it's much simpler, obviously.
ruby -rreline -Ilib -e 'print Reline.readline("> ", rprompt: "[#{Dir.pwd}]")'