/danger-plugin-spellcheck

Primary LanguageTypeScriptMIT LicenseMIT

danger-plugin-spellcheck

Build Status npm version semantic-release

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, or you can have a file called spellcheck.json in your repo's root.

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

schedule(
  spellcheck({ settings: "artsy/artsy-danger@spellcheck.json" })
)

The JSON should look something like:

{
  "ignore": ["orta", "artsy", "github", "/danger-*."],
  "whitelistFiles": ["README.md"]
}

The "ignores" section is case in-sensitive for words, if a word has a prefix of "/" then it will be treated as a RegExp.

Peril

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:

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.