piotrmurach/tty-reader

View on GitHub
CHANGELOG.md

Summary

Maintainability
Test Coverage
# Change log

## [v0.10.0] - unreleased

### Added
* Add to line the ability to find a word to complete before the cursor
* Add ability to complete words and cycle through completions in both directions
* Add support for adding a custom suffix to suggested word completion
* Add :history_size keyword to allow configuration of maximum history size
* Add the ability to replace a current line in the history buffer
* Add support for preserving edits to lines stored in history
* Add :exit_keys parameter for specifying keys to exit input without using the enter key

### Changed
* Change to finish input with a newline when enter is pressed inside the input line
* Change Reader to stop listening to key events
* Change Line to calculate prompt size once to improve performance

### Fixed
* Fix navigation to the previous history line to display the latest line

## [v0.9.0] - 2020-12-08

### Added
* Add buffer to save input when traversing history and restore it back
  similar to shell

### Changed
* Pressing :down no longer erases the #read_line input if history is disabled by Charles Pence (@pencechp)
* Change Reader initializer to use keyword arguments in place of options hash
* Change history to only exclude empty lines without any space or invisible characters
* Change all input reading methods to use explicit keyword arguments

### Fix
* Fix #read_multiline :value parameter to insert content only once in the first line

## [v0.8.0] - 2020-06-28

### Changed
* Change gemspec to load version directly and remove test artefacts
* Change to update tty-screen dependency
* Change to remove bundler dev dependency and relax wisper version

## [v0.7.0] - 2019-11-24

### Added
* Add support for a multi-line prompt by Katelyn Schiesser(@slowbro)
* Add metadata to gemspec

## [v0.6.0] - 2019-05-27

### Added
* Add :value option to #read_line to allow pre-populating of line content

### Changed
* Change to make InputInterrupt to derive from Interrupt by Samuel Williams(@ioquatix)
* Change #read_line to trigger before line is printed to allow for line changes in key callbacks
* Change Console#get_char :nonblock option to wait for readable input without blocking
* Change to remove bundler version constraints
* Change to update tty-screen dependency
* Change to update tty-cursor dependency

## [v0.5.0] - 2018-11-24

### Added
* Add KeyEvent#line to expose current line in key event callbacks

### Fixed
* Fix Esc key by differentiating between escaped keys and actual escape input
* Fix line editing to correctly insert next to last character

## [v0.4.0] - 2018-08-05

### Changed
* Change to update tty-screen & tty-cursor dependencies

## [v0.3.0] - 2018-04-29

### Added
* Add Reader#unsubscribe to allow stop listening to local key events

### Changed
* Change Reader#subscribe to allow to listening for key events only inside a block
* Change to group xterm keys for navigation

## [v0.2.0] - 2018-01-01

### Added
* Add home & end keys support in #read_line
* Add tty-screen & tty-cursor dependencies

### Changed
* Change Codes to Keys and inverse keys lookup to allow for different system keys matching same name.
* Change Reader#initialize to only accept options and make input and output options as well.
* Change #read_line to print newline character in noecho mode
* Change Reader::Line to include prompt prefix
* Change Reader#initialize to only accept options in place of positional arguments
* Change Reader to expose history options

### Fixed
* Fix issues with recognising :home & :end keys on different terminals
* Fix #read_line to work with strings spanning multiple screen widths and allow copy-pasting a long string without repeating prompt
* Fix backspace keystroke in cooked mode
* Fix history to only save lines in echo mode

## [v0.1.0] - 2017-08-30

* Initial implementation and release

[v0.10.0]: https://github.com/piotrmurach/tty-reader/compare/v0.9.0...v0.10.0
[v0.9.0]: https://github.com/piotrmurach/tty-reader/compare/v0.8.0...v0.9.0
[v0.8.0]: https://github.com/piotrmurach/tty-reader/compare/v0.7.0...v0.8.0
[v0.7.0]: https://github.com/piotrmurach/tty-reader/compare/v0.6.0...v0.7.0
[v0.6.0]: https://github.com/piotrmurach/tty-reader/compare/v0.5.0...v0.6.0
[v0.5.0]: https://github.com/piotrmurach/tty-reader/compare/v0.4.0...v0.5.0
[v0.4.0]: https://github.com/piotrmurach/tty-reader/compare/v0.3.0...v0.4.0
[v0.3.0]: https://github.com/piotrmurach/tty-reader/compare/v0.2.0...v0.3.0
[v0.2.0]: https://github.com/piotrmurach/tty-reader/compare/v0.1.0...v0.2.0
[v0.1.0]: https://github.com/piotrmurach/tty-reader/compare/v0.1.0