Skip to content

Performance Improvements #87

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

Jump to bottom
Open
miles-to-go wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Performance Improvements #87

miles-to-go wants to merge 5 commits into from

Conversation

@miles-to-go
Copy link

@miles-to-go miles-to-go commented Oct 14, 2025 •
edited
Loading

Thanks again for this great readline library. One issue I noticed is that there was some slowness, which is especially noticeable when pasting text on slower terminals such as the GNOME Terminal.

I spent a little time trying to improve this; below are descriptions of each commit. If this PR is accepted and you are open to it, I will try to implement additional improvements in the future.

  • minimize allocs in line.go: Change core line buffer operations to not allocate in the default case (only if more space is needed)
  • preallocate capacity for slices: Pre-allocate the slices to a known capacity in matchBind
  • add DisplayLine test cases: Write a unit test for DisplayLine
  • combine DisplayLine prints: Update DisplayLine to make a single fmt.Print call
  • bracketed paste: Support bracketed paste mode so that pastes do not cause a display refresh - this is the main performance improvement for pastes just because it skips the refresh, but the other commits should make the library feel a little more responsive as well

@miles-to-go miles-to-go force-pushed the performance-improvements branch from 76423af to bee9f1e Compare October 14, 2025 21:03
@maxlandon
Copy link
Member

maxlandon commented Oct 23, 2025 •
edited
Loading

Hello !

Thanks a lot for this PR, it is really appreciated!

At first glance, most commits will be merged.

I just need to check the one combining all DisplayLine calls in a single fmt.Print, because I'm pretty sure there is a reason why I did not do it in the first place.
Did you notice any chance occurring because of these modifications ?

I'm quite busy at work right now but I will soon merge this. Feel free to open new PRs with other improvements, these are always welcome !

@codecov
Copy link

codecov bot commented Oct 23, 2025

Codecov Report

❌ Patch coverage is 80.70175% with 22 lines in your changes missing coverage. Please review.
✅ Project coverage is 34.35%. Comparing base (1a194fa) to head (bee9f1e).
⚠️ Report is 11 commits behind head on master.

Files with missing lines Patch % Lines
emacs.go 0.00% 16 Missing ⚠️
readline.go 0.00% 4 Missing ⚠️
internal/keymap/dispatch.go 0.00% 1 Missing ⚠️
internal/strutil/key.go 0.00% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##           master      #87      +/-   ##
==========================================
+ Coverage   34.31%   34.35%   +0.04%     
==========================================
  Files          57       57              
  Lines       12620    12631      +11     
==========================================
+ Hits         4330     4340      +10     
- Misses       8252     8253       +1     
  Partials       38       38

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@miles-to-go
Copy link
Author

miles-to-go commented Oct 23, 2025

I have not noticed any changes so far with the fmt.Printf change in DisplayLine, but I can try testing specific cases if needed. Also happy to remove that commit for now if it makes it easier to review. Thanks for the quick response!

@maxlandon
Copy link
Member

maxlandon commented Oct 24, 2025

No need to remove this commits.
I will try writing a few tests around the prompt engine: it's been a while it should have some.

Will tackle this in a week. Try your luck if you want !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@miles-to-go @maxlandon