danger-plugin-git-spellcheck

This plugin checks the spelling in code and reports any error as markdown PR comment.

Usage no npm install needed!

<script type="module">
  import dangerPluginGitSpellcheck from 'https://cdn.skypack.dev/danger-plugin-git-spellcheck';
</script>

README

danger-plugin-git-spellcheck

Build Status npm version semantic-release

This plugin checks the spelling in code and reports any error as markdown PR comment.

Usage

Install:

yarn add danger-plugin-git-spellcheck --dev

At a glance:

// 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.

// 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"]
}

Changelog

See the GitHub release history.

Contributing

See CONTRIBUTING.md.