gulp-check

Gulp plugin to check for illegal expressions

Usage

To use gulp please ensure gulp is installed globally as well as locally.

npm install gulp -g
npm install gulp -D

Install gulp-check as a development dependency

npm install gulp-check -D

Add it to your gulpfile

var gulp  = require('gulp');
var check = require('gulp-check');
var util = require('gulp-util');

gulp.task('check', function () {
  gulp.src(['test/**/*.js'])
    .pipe(check(/TODO/))
    .on('error', function (err) {
      util.beep();
      util.log(util.colors.red(err));
    });
});

API

gulp-check can be called with a String or RegExp

check(string)

string

Type: String The string to search for.

check(regex)

regex

Type: RegExp The regex pattern to search for. See the MDN documentation for RegExp for details.

This plugin will throw errors on the file stream and it is up to you to handle them. The first error found will stop the stream showing you what was found and what file it was found in.

If you want the plugin to find all errors without stopping the stream, use gulp-plumber

Changelog

2014/04/23 - 0.1.0 - First release

2014/04/24 - 0.1.1 - Added fields to package.json