apainintheneck / crystal-linenoise Goto Github PK

The automatic completions currently show the next alphabetic matching completion not the next shortest alphabetic completion which would be more accurate and nicer.

The main Linenoise repo is somewhat abandoned. Though it provided a good foundation it has a large number of bug reports and pending fixes/improvements. Some of those pending fixes and improvements might be useful to add to this repo in a pinch. That is especially true for bug fixes.

Potential Fixes

• fix history on Linux
  • antirez/linenoise#173
  • #20
• ignore ANSI escape codes when deciding on cursor position
  • antirez/linenoise#135
  • antirez/linenoise#181
  • #22
• remove duplicate include
  • antirez/linenoise#139
  • #24
• fix number conversion warnings
  • antirez/linenoise#211

Potential Improvements

• add support for Ctrl-Left and Ctrl-Right
  • antirez/linenoise#205
• implement more common navigation codes
  • antirez/linenoise#147
• utf8 support
  • antirez/linenoise#187
  • #27
• history search support
  • antirez/linenoise#179
• simply handling of escape codes and add left and right ctrl+arrow
  • antirez/linenoise#216

It might also be interesting to look at some forks to see if they have any changes we can pull in that would be useful.

Linenoise Forks

• https://github.com/rain-1/linenoise-mob

Testing will be a bit tricky here since at the very least the hints are just a visual phenomenon. That being said we should be able to test some of the behavior with something like expect or a similar wrapper in pure Crystal.

expect seemed like a good enough way to test that Linenoise completions were working correctly but I ran into two problems with it. First, I couldn't get it working on CI so I had to just make sure to run it locally. That was inconvenient but not that big of a deal. Second, I just found out that the default expect on macOS doesn't support UTF-8 characters by default which means that I can't automatically test new PRs like #27.

Ideally, there'd be a library in Crystal to do this but I'm not aware of any of them. Likely, I'll have to use something written in another language or maybe port something to Crystal. There are definitely a bunch of options out there.

The Linenoise::Completion logic seems to be broken now. It doesn't consistently return the expected results. This should also be easily testable so regression tests need to be added too here.

I found out about this while updating https://github.com/apainintheneck/gitsh to v0.2.0 and started seeing missing completions for common git commands like push and pull.

This is not the only line editing library for Crystal (maybe I wouldn't have started working on it if I had known that two weeks ago...). It'd be good to add those other libraries as alternatives to the readme.

• https://github.com/I3oris/reply#similar-project

These can be generated by running crystal docs but as a user I'd usually like to see this sorts of stuff online or in the repo itself before I have to download and run any code.

The key here will be to add a check on CI for outdated docs.

These should explain how to get this project up and running. This means referencing the makefile and talking about updating the Linenoise library which might be necessary at some point. There is also the whole thing with manual testing using the example/example.cr program.

These should be easily testable without needing to run an interactive REPL like we do already with the expect tests.

Most of the usage documentation should flow pretty directly from the inline documentation (try crystal docs with this repo) along with the code already in example/example.cr.

I'd kind of like to implement a minimal programming language REPL here but that might go beyond the intended scope. Something simple though that uses most of the features would be great. This should be implemented in a separate repo and then linked to from the readme.