Improve error message context if we can't read a given word list. Add a ToipeError method, with_context, that prefixes the msg with a str you pass in. Use this method in each of the cases where RawWordSelector initialization can fail when initializing Toipe, so that errors from here say "Error reading the given word list: " at the front. (Fixes #25)

Rust 1.59 introduced new feature - creating stripped binaries. Results for hello-world app (target x86_64-unknown-linux-gnu):

$ cargo build --release
   Compiling hello-world v0.1.0 (//hello-world)
    Finished release [optimized] target(s) in 0.94s
$ du -h target/release/hello-world
3.6M	target/release/hello-world
# enable here
$ cargo build --release           
   Compiling hello-world v0.1.0 (//hello-world)
    Finished release [optimized] target(s) in 0.29s
$ du -h target/release/hello-world
308K	target/release/hello-world

with stripping all symbol information:

[profile.release]
strip = true

Clippy found a bug in: https://github.com/Samyak2/toipe/blob/3cb7e31bd5dc61f0e89c244d2f6a7a3c5580856b/src/textgen.rs#L78

The range should have been inclusive.

https://github.com/Samyak2/toipe/runs/8056437431?check_suite_focus=true#step:6:8

What and why?

If the terminal size is too small, the lines (of words) overlap with each other and the cursor starts at the last line.

It would be nice to show an error and ask the user to maximize their window (or increase the size) to use toipe.

How?

termion provides terminal_size to detect the size of the terminal. The difficulty arises in selecting a good threshold for the minimum size. It can be calculated based on the config (number of words) on the fly or can be fixed.

Context

Suggestion from reddit: https://www.reddit.com/r/rust/comments/tvamfz/comment/i3giuga/

I found a very minor bug (which don't influence the gameplay or anything else) in the program : If you write a single word, and then press ctrl + c, you can get like more than 2000wpm, and the program says that you took 0s for 30 words.

Hey! I came across your project and figured I'd take a crack some of the issues listed. This PR should solve issue: https://github.com/Samyak2/toipe/issues/31

To compress the bundled wordlist, I've used include-flate's flate! macro as a replacement for include_str!. This will compress the wordlists during compilation.

Size comparison for "toipe"

I'm currently using Arch Linux with rust stable, so your results may vary.

• Total wordlist size: 367.3KiB (380,167 Bytes)
• Binary size using include_str!: 1.4MiB (1,452,728 Bytes)
• Binary size using flate!: 1.2 MiB (1,268,408 Bytes)

I've tested both binaries and I couldn't find any performance hits (compilation & runtime).

There are some feature, you may add to make it more usable,

1. ctrl + backspace should delete the previous typed characters until a space is encountered.
2. Statistics of your previous typing tests

I have a txt file 243 word and when i try to open it with topie using the -f flag it shows nothing inside the app (I'm sure about the path and i tried absolute path too)

What and why?

A shortcut to delete the last typed word would be nice. ctrl-w and ctrl-backspace can be used for this.

How?

TODO

Context

Suggestion from reddit: https://www.reddit.com/r/unixporn/comments/tw84a3/comment/i3endiw/

What?

Currently, the terminal UI in toipe is rendered by directly writing to stdout with cursor positioning and colors provided by termion.

Example: https://github.com/Samyak2/toipe/blob/fae300576c4f83e50ca969c588217bbd3c8cb581/src/lib.rs#L263-L271

This code looks a bit ugly and we need to manually position items by changing the arguments given to cursor::Goto. For example, sizey / 2 - 2 means two lines above the middle line. If I want to add another line to that list and move all of them down, I need to change this part of every line.

The cursor::Left(line.len() as u16 / 2) part positions the text in the center - this snippet is repeated for every line. What's even worse is if the text in that line includes special characters such as colors, this will not work because it will consider those hidden characters too! To get around that, I use this hack: https://github.com/Samyak2/toipe/blob/fae300576c4f83e50ca969c588217bbd3c8cb581/src/lib.rs#L285-L299

As you can see, I need to repeat the formatting characters again in a separate string containing only them and then subtract their length from line.len() like cursor::Left((line.len() - zerowidths.len()) as u16 / 2).

How to fix?

Honestly, I'm not sure. I opened this issue to force myself to document the problem.

The solution will definitely involve abstracting this UI rendering into a different module. Abstracting the cursor::Gotos is simple - take a vec/iter/slice of strings and change the y-position when printing each one such that they are approximately in the middle. cursor::Left(line.len() as u16 / 2) is easy too, as long as the given string contains single-width characters. I'm not sure how zero-width and other characters can be handled here. Perhaps this problem is solved elsewhere?

I'm always open to suggestions!

This PR closes multiple TODOs.

The "reset cursor to whatever it was before Toipe was started." TODO is, from what I can tell, unfortunately impossible due to the limitations of escape sequences used to change the cursor shape, therefore removed. See this discussion on the neovim repo.

What?

When the terminal is resized in the middle of a typing test, the text wraps around weirdly. A ctrl-r fixes this but it would be nice to not interrupt the test.

Although, a terminal resize in the middle of a test might be unlikely.

How?

Termion, the library toipe uses for terminal rendering, doesn't seem to have an event for resizes: https://gitlab.redox-os.org/redox-os/termion/-/issues/151

So this will be tricky to implement. I'm not sure how to do this yet

What?

Charm just released this: https://github.com/charmbracelet/vhs

Generating the demo image which you see in the README is a bit of a chore, adding friction to every release. vhs can automate some of this.

How?

Find a way to give a static seed to toipe and then write a vhs script to automatically type the words. Convert the recording to a GIF and upload it.

After exiting toipe, the cursor will change into cursor::SteadyBlock and I find myself having to run reset in my terminal. It would be nice if the cursor could return to its original state after exiting toipe.