Add spell-checking to lint process

[aleclarson]

Possibly grammar-checking too?

I've never looked into adding such a check before, so I'm not sure what solutions are out there.

If anyone decides to research this, please share your findings here. Please comment here before doing any work on a PR, so we can discuss. Thanks!

[MarlonPassos-git]

Interesting point. I usually use the Code Spell Checker extension to help with that. Now, to execute this programmatically is another matter.

[aleclarson]

Oooh, it looks like that runs on CSpell, so @adamhamlin's upcoming PR work can be reused by it. We should recommend this extension here and here once we get CSpell configured and merged. 👍

[adamhamlin]

eslint-plugin-spellcheck seems pretty standard. Tho wouldn't cover grammar.

@aleclarson is there a reason we don't have a "generalized" eslint setup? I see this script that specifically checks browser compatibility rules, why not just check-in an eslint config file?

[aleclarson]

is there a reason we don't have a "generalized" eslint setup? I see this script that specifically checks browser compatibility rules, why not just check-in an eslint config file?

Just a case of trying to be too clever and failing. 😅 I will definitely change that..

[aleclarson]

CSpell also looks like a valid option. (It has an ESLint plugin and a CLI).

Note that I'd like to spell-check both source code and the docs, so that's something to keep in mind.

[aleclarson]

I think we're going to want general eslinting at some point anyway

In case you didn't know, we're already using Biome as a replacement for ESLint in terms of catching mistakes and a couple basic formatting rules (it replaces Prettier entirely for the source code). Unfortunately, they don't have a plugin system yet, so we're in this awkward transition period where we have two linters in the project.

[aleclarson]

Hey @adamhamlin, so I've switched off of ESLint entirely in this commit, because eslint-plugin-compat turned out to be pretty lackluster (it doesn't check method use like array.flat()). Therefore, we should use CSpell's CLI instead of the ESLint plugin.

That said, I'm ready for your PR 👍

[adamhamlin]

In case you didn't know, we're already using Biome as a replacement for ESLint in terms of catching mistakes and a couple basic formatting rules

Ahh right, I definitely saw that at some point and forgot, esp. the other day when I noticed we were using eslint (and prettier) somewhere else.

But yeah all the rest of that sounds good. Will use the cspell binary for any/all spellchecking we want to do 👍

[aleclarson]

Quick update: I refactored the lint command into TypeScript. The need came up when I added the ./scripts/ folder to be linted, which resulted in missing dependency errors since ./scripts/*/package.json dependencies are only installed on-demand. Anyway, you'll want to add the spell-checking command to this array. (As a bonus, I got to remove concurrently as a dependency, opting to write my own, which turned out to be not that complicated, so now we don't have Lodash in our lockfile anymore 🤣).

[adamhamlin]

Sweet. And yep, I briefly started working on this last night and that array is where I put it :)