This plugin checks the spelling in code and reports any error as markdown PR comment.
npm install danger-plugin-git-spellcheck
> This plugin checks the spelling in code and reports any error as markdown PR comment.
Install:
``sh`
yarn add danger-plugin-git-spellcheck --dev
At a glance:
`js
// dangerfile.js
import gitSpellcheck from "danger-plugin-git-spellcheck";
gitSpellcheck();
`
Configuration:
This plugin use the cspell library under the hood to perform spellchecking, which can be configured using a cspell.json configuration file. Please see here for more details on cspell configuration.
`js``
// cSpell Settings
{
// Version of the setting file. Always 0.1
"version": "0.1",
// language - current active spelling language
"language": "en",
// words - list of words to be always considered correct
"words": [
"mkdirp",
"tsmerge",
"githubusercontent",
"streetsidesoftware",
"vsmarketplacebadge",
"visualstudio"
],
// flagWords - list of words to be always considered incorrect
// This is useful for offensive words and common spelling errors.
// For example "hte" should be "the"
"flagWords": ["hte"]
}
See the GitHub release history.
See CONTRIBUTING.md.