Add a spell checker to our lint task

[stephenplusplus]

Cont'd from #1126 (comment)

We have words written all over the place that might not be correct grammatically.

@callmehiphop found a tool called write-good which we could add to our link task to catch such non-good writings. We would likely need a spell-checker as well, because it doesn't seem to do that.

We'd have to be precise in steering it only towards words and away from code. Sometimes they are mixed, such as our @examples. @callmehiphop, is there a good way to filter out only the text?

[callmehiphop]

We could generate the JSON and run spellcheck/write-good on the description properties throughout? I think the trickier part will be parsing markdown and skipping code snippets and possibly markdown syntax.

[stephenplusplus]

Ooh! https://github.com/wooorm/strip-markdown

[callmehiphop]

Nice!

[stephenplusplus]

I started to work on this and it seemed to be destined for failure from the start. I think the problem is we're trying to spell check tech sentences.

I started by plugging in write-good. It's is a great tool, but in practicality, it might be more detailed than we need. So I scaled back the scope and just went for spell checking. I realized quickly that meant we'd need to have an extensive custom dictionary to define things like "SDK", "gcloud", "getFiles", etc.

At this point, I'm not sure we'll be able to automate this. We might be better off just letting the users catch and contribute any grammar bugs we let seep through.

[callmehiphop]

That sounds good to me

[stephenplusplus]

👍

[jgeewax]

Would it be crazy to have it run and trigger just a warning? Or is it just way too noisy?

[stephenplusplus]

I think I found a way that's not too gross!: #1166