Fast spelling check for Travis CI
Clone or download
Latest commit 3b2b090 Nov 20, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig Initial commit Mar 3, 2017
.gitignore Initial commit Mar 3, 2017
.npmignore Add AppVeyor Mar 5, 2017
.travis.yml Initial commit Mar 3, 2017
.yaspellerrc Add AppVeyor support Mar 5, 2017
CHANGELOG.md Release 1.0 version Nov 19, 2017
LICENSE Initial commit Mar 3, 2017
README.md Clean up config example Mar 10, 2017
appveyor.yml Use Node.js 8 on AppVeyor Sep 11, 2017
bin.js Use ci-job-number Jul 4, 2017
package.json Update ESLint config Nov 19, 2017
yarn.lock Update ESLint config Nov 19, 2017

README.md

Yaspeller for CI

Yaspeller Logo

Fast spelling check for Travis CI and AppVeyor.

It is just simple wrap for yaspeller, CLI for Yandex.Speller API. But it run spelling check only in first CI job, to speed up build time and reduce unnecessary burden for CI service and Yandex.Speller API.

Sponsored by Evil Martians

Usage

Install yaspeller-ci:

npm install yaspeller-ci --save-dev

And add it to npm scripts:

  "scripts": {
    "spellcheck": "yaspeller-ci *.md",
    "test": "npm run unit && npm run lint && npm run spellcheck"
  }

If you use JSDoc, we recommend to pass them by spelling check too:

  "scripts": {
    "docs": "jsdoc --configure .jsdocrc *.js",
    "spellcheck": "npm run docs && yaspeller-ci *.md api/*.html",
    "test": "npm run unit && npm run lint && npm run spellcheck"
  }

Config

You can specify own dictionary and spelling check options in .yaspellerrc config.

{
  "lang": "en",
  "dictionary": [
    "yaspeller",
    "Travis"
  ]
}

Full list of options could be found in yaspeller docs.

Extra

We recommend to combine Yaspeller CI with lint-staged:

  "lint-staged": {
    "*.md": "yaspeller-ci"
  }