Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jrnxf/thokr
✨ sleek typing tui with visualized results and historical logging
https://github.com/jrnxf/thokr
cli monkeytype rust terminal tui typing typing-game typing-practice
Last synced: 6 days ago
JSON representation
✨ sleek typing tui with visualized results and historical logging
- Host: GitHub
- URL: https://github.com/jrnxf/thokr
- Owner: jrnxf
- License: mit
- Created: 2022-03-08T08:08:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-19T13:59:05.000Z (10 months ago)
- Last Synced: 2024-05-16T09:36:29.555Z (6 months ago)
- Topics: cli, monkeytype, rust, terminal, tui, typing, typing-game, typing-practice
- Language: Rust
- Homepage:
- Size: 2.59 MB
- Stars: 511
- Watchers: 4
- Forks: 17
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# thokr
✨ sleek typing tui with visualized results and historical logging
[](https://github.com/thatvegandev/thokr/actions/workflows/build.yml)
[](https://github.com/thatvegandev/thokr/actions/workflows/deploy.yml)
[](./LICENSE.md)
[](https://crates.io/crates/thokr)
[](https://github.com/thatvegandev/thokr/stargazers)
## 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
language to pull words from [default: english] [possible values: english, english1k,
english10k]
-p, --prompt
custom prompt to use
-s, --number-of-secs
number of seconds to run test
-V, --version
Print version information
-w, --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 | $XDG*CONFIG_HOME/\_project_path* or $HOME/.config/_project_path_ | /home/colby/.config/thokr |
| macOS | $HOME/Library/Application Support/_project_path_ | /Users/Colby/Library/Application Support/thokr |
| Windows | {FOLDERID*RoamingAppData}\_project_path*\config | C:\Users\Colby\AppData\Roaming\thokr\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](https://docs.rs/tui/0.10.0/tui/widgets/trait.StatefulWidget.html)),
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](https://docs.rs/crossterm/0.3.0/crossterm/raw/index.html). 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](https://github.com/thatvegandev/thokr/pulls). 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](https://github.com/thatvegandev/thokr/issues) for a full
list of proposed features (and known issues).
## License
Distributed under the MIT License. See [LICENSE.md](./LICENSE.md) for more
information.
## Acknowledgments
Check out these amazing projects that inspired thokr!
- [monkeytype](https://github.com/Miodec/monkeytype)
- [tui-rs](https://github.com/fdehau/tui-rs)
- [ttyper](https://github.com/max-niederman/ttyper)
## Follow
[](https://github.com/thatvegandev)
[](https://twitter.com/thatvegandev)
[](https://youtube.com/user/thatvegandev)