https://github.com/ai/yaspeller-ci
Fast spelling check for Travis CI
https://github.com/ai/yaspeller-ci
spellcheck spelling travis travis-ci
Last synced: 8 months ago
JSON representation
Fast spelling check for Travis CI
- Host: GitHub
- URL: https://github.com/ai/yaspeller-ci
- Owner: ai
- License: mit
- Archived: true
- Created: 2017-03-03T11:36:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-05-10T06:13:28.000Z (over 4 years ago)
- Last Synced: 2025-01-20T20:37:11.191Z (9 months ago)
- Topics: spellcheck, spelling, travis, travis-ci
- Language: JavaScript
- Homepage:
- Size: 454 KB
- Stars: 61
- Watchers: 4
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Yaspeller for CI
Fast spelling check for Travis CI and AppVeyor.
It is just simple wrap for [yaspeller], CLI for [Yandex.Speller] API.
But it runs spelling check only in first CI job,
to speed up build time and reduce unnecessary burden for CI service
and Yandex.Speller API.
[Yandex.Speller]: https://tech.yandex.ru/speller/doc/dg/concepts/About-docpage/
[yaspeller]: https://github.com/hcodes/yaspeller
## Usage
Install `yaspeller-ci`:
```sh
npm install yaspeller-ci --save-dev
```
And add it to npm scripts:
```json
"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:
```json
"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.
```json
{
"lang": "en",
"dictionary": [
"yaspeller",
"Travis"
]
}
```
Full list of options could be found in [`yaspeller` docs].
[`yaspeller` docs]: https://github.com/hcodes/yaspeller#configuration
## Extra
We recommend to combine Yaspeller CI with [`lint-staged`]:
```json
"lint-staged": {
"*.md": "yaspeller-ci"
}
```
[`lint-staged`]: https://github.com/okonet/lint-staged