gulp-ts-spellcheck

gulp-ts-spellcheck

Spellcheck typescript code with gulp

A gulp plugin for spell checking typescript sources.

Installation

Use npm:

npm install -D gulp-ts-spellcheck

Usage

const gulp = require('gulp');
const tsSpellcheck = require('gulp-ts-spellcheck').default;

gulp.task('spellcheck', (done) => {
  return gulp.src('src/**/*.ts')
    .on('error', (err) => { done(err); })
    .pipe(tsSpellcheck({/* speller options */}))
    .pipe(tsSpellcheck.report({/* reporter options */}));
});

Configuration

Speller Options

dictionary

string[]: List of words to pass as correct (case-insensitive)

.
.
.
.pipe(tsSpellcheck({
    dictionary:['axios','fs']
}))
.
.
.

Or create a dictionary file dictionary.js:

module.exports=[
    'axios',
    'fs'
];

Then use it in your gulpfile.js:

.pipe(tsSpellcheck({
    dictionary: require('./dictionary')
}))

Contribution

To help when developing run this:

cp ./.githooks/* .git/hooks