thokr

✨ sleek typing tui with visualized results and historical logging

Usage

For detailed usage run thokr -h.

``` thokr 0.4.1 sleek typing tui with visualized results and historical logging

USAGE: thokr [OPTIONS]

OPTIONS: -f, --full-sentences number of sentences to use in test

-h, --help
        Print help information

-l, --supported-language <SUPPORTED_LANGUAGE>
        language to pull words from [default: english] [possible values: english, english1k,
        english10k]

-p, --prompt <PROMPT>
        custom prompt to use

-s, --number-of-secs <NUMBER_OF_SECS>
        number of seconds to run test

-V, --version
        Print version information

-w, --number-of-words <NUMBER_OF_WORDS>
        number of words to use in test [default: 15]

```

Installation

Cargo

sh $ cargo install thokr

Docker

sh $ docker run -it thatvegandev/thokr

Arch Linux

Install thokr-git from the AUR

Usage

For detailed usage run thokr -h.

Examples

| command | test contents | |:----------------------------|-----------------------------------------------------------------:| | thokr | 50 of the 200 most common english words | | thokr -w 100 | 100 of the 200 most common English words | | thokr -w 100 -l english1k | 100 of the 1000 most common English words | | thokr -w 10 -s 5 | 10 of the 200 most common English words (hard stop at 5 seconds) | | thokr -p "$(cat foo.txt)" | custom prompt with the output of cat foo.txt | | thokr -f 4 | 4 grammatical sentences with full stops; overrides word settings |

During a test you can press ← to start over or → to see a new prompt (assuming you didn't supply a custom one)

Supported Languages

The following languages are available by default:

| name | description | | :----------- | ------------------------------: | | english | 200 most common English words | | english1k | 1000 most common English words | | english10k | 10000 most common English words |

Logging

Upon completion of a test, a row outlining your results is appended to the log.csv file found in the following platform-specific folders. This way you can easily track your progress over time.

| platform | value | example | | :------- | ---------------------------------------------------------------- | ---------------------------------------------: | | Linux | $XDGCONFIG_HOME/_project_path or $HOME/.config/projectpath_ | /home/colby/.config/thokr | | macOS | $HOME/Library/Application Support/projectpath_ | /Users/Colby/Library/Application Support/thokr | | Windows | {FOLDERIDRoamingAppData}_project_path\config | C:\Users\Colby\AppData\Roamingthokr\config |

Roadmap

• [ ] ⚡️ Performance
  • Right now there are known performance issues surrounding the rendering of the tui at each tick interval and/or key press. Ideally each render uses the prior render as a base and only makes the necessary adjustments (possibly using StatefulWidget), but I haven't been able to figure that out yet.
• [ ] 🔠 Multi-language support
  • I decided not to launch thokr with languages besides english because of some odd rendering issues I was experiencing when trying to input characters with accents. It's as though I'm not able to properly input the character in raw mode. I'd love to have that figure out before shipping other languages because I personally felt the experience was a bit jarring. I'll open an bug report for it with more details and replication steps -- would love more eyes on that problem!
• [ ] 🧪 Tests
  • I've only written a small amount of tests at this point. I haven't sat down to really think through what tests look like when the output is dependent on the users terminal size, font size, etc. If you have any ideas for this please open up an issue and start the discussion!

Contributing

All contributions are greatly appreciated.

If you have a suggestion that would make thokr better, please fork the repo and create a pull request. You can also simply open an issue and select Feature Request

1. Fork the repo
2. Create your feature branch (git checkout -b [your_username]/xyz)
3. Commit your changes (git commit -m 'add some xyz')
4. Rebase off main (git fetch --all && git rebase origin/main)
5. Push to your branch (git push origin [your_username]/xyz)
6. Fill out pull request template

See the open issues for a full list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE.md for more information.

Acknowledgments

Check out these amazing projects that inspired thokr!

• monkeytype
• tui-rs
• ttyper

Follow