gulp-filter

Filter files in a vinyl stream

Enables you to work on a subset of the original files by filtering them using globbing. When you're done and want all the original files back you just call the end function.

Install

Install with npm

npm install --save-dev gulp-filter

Example

var gulp = require('gulp');
var jscs = require('gulp-jscs');
var filter = require('gulp-filter');

gulp.task('default', function () {
    gulp.src('src/*.js')
        // filter a subset of the files
        .pipe(filter('!src/vendor'))
        // run them through a plugin
        .pipe(jscs())
        // bring back the previously filtered out files (optional)
        .pipe(filter.end())
        .pipe(gulp.dest('dist'));
});

API

filter(pattern)

pattern

Type: String|Array|Function

Accepts a string/array with globbing patterns which are run through multimatch.

If you supply a function you'll get a vinyl file object as the first argument and you're expected to return true/false whether to include the file:

filter(function (file) {
    return /unicorns/.test(file.path);
});

filter.end()

Resets the filter and brings back the previously filtered out files.

License

MIT © Sindre Sorhus