Spell checks any created or modified markdown files in a GitHub PR using node-markdown-spellcheck.
yarn add danger-plugin-spellcheck --dev
At a glance:
You can have a shared repo for the settings for your spell checking, or you can have a file called
spellcheck.json in your repo's root.
The JSON should look something like:
"ignore" section is case in-sensitive for words, if a word has a prefix of
"/" then it will be treated as a
"whitelistFiles" section is an array of files which will NOT be spellchecked.
The spellcheck function also accepts
whitelistFiles as properties of the options object. If you already have a list of spell check exceptions (e.g. from your editor), you can build them in your dangerfile and pass them in to your spellcheck function call.
If you're using Peril you can use both a global settings for org wide-spellchecking, and then have local additions to any of the settings. This can make it easier to handle specific one off cases that feel a bit too unique to a single project.
Here is our Artsy setup where we do this: