README.md

gulp-spellcheck

A gulp plugin for spell-checking with GNU Aspell.

Usage

First of all you have to make sure that you have GNU Aspell installed:

$ # Debian-based
$ sudo apt-get install aspell

If aspell is available install gulp-spellcheck as a development dependency in your project.

npm install --save-dev gulp-spellcheck

Then, add it to your gulpfile.js:

var spellcheck = require('gulp-spellcheck');

gulp.task('spellcheck', function () {
    gulp.src('./dododo/**/*.md')
        .pipe(spellcheck())
        .pipe(gulp.dest('./spellchecked/'));
});

API

spellcheck (options)

options

language

Type: String Default: undefined

ISO 639 or ISO 3166 language code (e.g. de). Please make sure that you have the respective aspell language pack installed (e.g. sudo apt-get install aspell-de).

replacement

Type: String Default: '%s (suggestions: %s)'

The string that will replace the wrong word whereas the first placeholder is the wrong word and the second placeholder a list of suggestions.

Changelog

Version 0.2.0 (Future)

• Ignore list

Version 0.1.2 (20140331)

• Added functionality for disabling 'pipe mode'.

Version 0.1.1 (20140331)

• Fixed vinyl file access.

Version 0.1.0 (20140331)

• Initial Release.

Author

Copyright 2014, André König ([email protected])