✨ feat: add spellcheck ci

[fuadop]

PR Checklist

• Addresses an existing open issue: fixes 🛠 Tooling: Investigate adding spell checking to CI #8
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

uses cspell for spellcheck on projects directory.

[JoshuaKGoldberg]

Thanks for sending this in! There are a lot of failures in CI right now so we'll have to avoid/fix them in some way.

[JoshuaKGoldberg]

👋 @fuadop just checking in, is this still something you have time to look into?

No worries if not, just making sure the issue isn't blocked! 😄

[fuadop]

Hey @JoshuaKGoldberg 👋 , super sorry about the delay.

About this, the words truly aren't existent, Do we create a dictionary file? but that's what we are trying to avoid here right?

[JoshuaKGoldberg]

Hmm yeah, it is unfortunate how many words are being flagged right now. How about including only .md files in the spellcheck check? There are only two .md failures right now, both of which should go away once the typescript dictionary is configured to be used.

[fuadop]

Hey @JoshuaKGoldberg,
I am actually seeing more than two words being flagged for .md files on my end 🤔.

[JoshuaKGoldberg]

Hmm, is that with the TypeScript dictionary enabled? If so: I probably did it wrong on my end then 😄.

[fuadop]

With the typescript dictionary, it reduced to 37 from 42.

[JoshuaKGoldberg]

Heh. Well, there are a lot of custom words in this repo: Typarium, Typespeare, etc. I think it makes sense that we'd have to add a dictionary.

If that's a lot more work than you have time for, I can always take over - no worries!

[fuadop]

Yea, I can add that. how would you love the dictionary file to be stored in the repo? is the dictionary file okay in the root directory?

[JoshuaKGoldberg]

Yeah that makes sense! If you have opinions on a better way I'd be interested though 😄.

[JoshuaKGoldberg]

Nice 😄 spellcheck really is useful!

[JoshuaKGoldberg]

Wonderful, thanks for this @fuadop! ✨