jonallured/danger-plugin-spellcheck

danger-plugin-spellcheck

Spell checks any created or modified markdown files in a GitHub PR using node-markdown-spellcheck.

Usage

Install:

yarn add danger-plugin-spellcheck --dev

At a glance:

// dangerfile.js
import spellcheck from 'danger-plugin-spellcheck'

schedule(spellcheck())

You can have a shared repo for the settings for your spell checking:

// dangerfile.js
import spellcheck from 'danger-plugin-spellcheck'

schedule(
  spellcheck({ settings: "artsy/[email protected]" })
)

The JSON should look something like like:

{
  "ignore": ["orta", "artsy", "github"],
  "whitelistFiles": ["README.md"]
}

Note: The "ignores" section is case in-sensitive.

Changelog

See the GitHub release history.

Credits

This was created by Orta Therox and Yuki Nishijima in an amazing pairing session on cold thursday before an Artsy Happy Hour.

Contributing

See CONTRIBUTING.md.