Add spell check

[AlexAxthelm]

I go back and forth on if this is a good idea or not.

I find CSpell useful while coding, since it can work on both normal prose (.md, .txt, etc) and on code files (.R, etc) while being pretty good about dealing with coding conventions, like snake case.

https://cspell.org/docs/how-it-works/ lays out:

The concept is simple, split camelCase and snake_case words before checking them against a list of known words.

which is great, but leads to my single biggest frustration when dealing with CSpell: maintaining the custom word list. Overall, it's not that difficult, since CSpell traverses up the directory tree until to find custom dictionaries, which means keeping a wordlist in the repo root, and updating it when new words are added to the repo.

I don't have any benchmark as to how any of our repos fare against the standard dictionaries

[jdhoffa]

Ooof I would be very hesitant to enforce this at all. I think people should use if they want, but I had CSpell enforced in my local neovim config for a bit and hated it.

I spent 99% of my time adding things to the exception list and I eventually just removed it

Recognizing that that may have been an issue with HOW i configured it

[jdhoffa]

Ah, but maybe as you say only enforcing in .md could be good?

That would even catch typos in documented R package functions