dustinblackman / oatmeal

Terminal UI to chat with large language models (LLM) using different model backends, and integrations with your favourite editors!
https://dustinblackman.com/posts/oatmeal/
MIT License
477 stars 23 forks source link

fix: Typos #61

Closed kyu08 closed 5 months ago

kyu08 commented 5 months ago

I found them by executing typos.

If you don't mind, I would be happy to create a PR to run typos in CI. 👍

dustinblackman commented 5 months ago

Good catch, thanks! I've tried playing with typos before but got mixed results and haven't revisited. With you running it locally did any other issues come up?

kyu08 commented 5 months ago

mixed results

Do you mean typos returns errors about the words that you want to ignore like commit hash in CHANGELOG.md or proper noun like ratatui? If so, adding config file(should named as _typos.toml) like below resolves the issue.

[default.extend-words]
ratatui = "ratatui"

[files]
extend-exclude = ["CHANGELOG.md"]

If you run typos with the above config file, you will not get any errors from the command. If you don't dislike, I can make a PR that adds the above config file and CI setting to run typos.