search

tbroadley / github-spellcheck-cli

Check a GitHub repository for spelling mistakes and automatically create a pull request :pen:
MIT License
135 stars 14 forks source link

Temporary Whitelist #81

Closed madhavarshney closed 6 years ago

madhavarshney commented 6 years ago

Another useful option for a misspelled word is temporary whitelist, for the current repository. This is useful in projects like webpack.js.org where you wouldn't necessarily want to permanently whitelist the GitHub usernames in the contributors section of each page but only whitelist them for that repo.

Thanks, Madhav.

tbroadley commented 6 years ago

Hey! The tool used to have a command to whitelist a word only for the current run. I got rid of it because I found I was using it too much instead of permanently whitelisting words, which was overall reducing the benefit of having the persistent whitelist. My current thinking for things like names is that, if it's spelled correctly in the repo I'm currently reviewing, it probably means I'd accept the spelling in a different repo too :slightly_smiling_face:

tbroadley commented 6 years ago

I'm going to close this for now - I'm down to reopen it if not having this feature is painful, but personally I find the persistent whitelist works well in most situations 🙂

madhavarshney commented 6 years ago

Sure, that's fine with me.