How to teach typos about project specific terms?

[nirs]

Thanks for typos, this is a wonderful extension!

One issue, it complains about terms like ODF (OpenShift Data Foundation):

How can I teach it about ODF?

In vim I would add ODF to my local dictionary (zg) - quick an easy and works for many projects related to ODF on single machine.

[BaptisteRoseau]

For now you can create a .typos.toml file at the root of your project's directory, then add the following into it:

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

Then you need to reload the editor.

I might add a command to automatically do this in the future but for the time being this will fix your issue.
Let me know if that worked for you and if you need anything else :D

Note that the configuration will only apply to your project directory. Any other file opened outside of the repository in Zed will not see the .typos.toml configuration applied.

[nirs]

Thanks, adding a shortcut to add a word to the list would be nice.

But per project word may not be enough. Many projects have multiple repos so you will not update multiple project typos.toml files. There should be also a per machine configuration (like ~/.gitconfig and .git/config). Per machine config should be the most useful way, hopefully it can be synced between machines like other zed settings.

[nirs]

For reference, the relevant docs:
https://github.com/crate-ci/typos/blob/master/docs/reference.md

[BaptisteRoseau]

Hello again, I dug a bit on how to solve this issue and the code action to add new words should be done in the LSP itself, not this zed-plugin which purpose is to add the "glue" to use the LSP.

There is already a WIP PR to implement this feature tekumara/typos-lsp#12, which should be automatically downloaded when the new version is released (if not, then that's a bug I should fix here).

I will ask on the PR if it's also possible to add an action into a global config, which would ultimately fix your problem, you're not the only one having it :D