gulp-custom-filter

A gulp plugin to filter files by customized filters.

Install

1$ npm install --save-dev gulp-custom-filter

Usage

1var filter = require('gulp-custom-filter');
2var gulp = require('gulp');
3var less = require('gulp-less');
4
5function myFilter(file) {
6	return file.basename.startsWith('my_');
7}
8
9gulp.task('less', function() {
10	return gulp.src('./less/**/*.less')
11		.pipe(filter(myFilter))
12		.pipe(less())
13		.pipe(gulp.dest('./css')
14});

This is equivalent to:

1var filter = require('gulp-custom-filter');
2var gulp = require('gulp');
3var less = require('gulp-less');
4
5gulp.task('less', function() {
6	return gulp.src('./less/**/my_*.less')
7		.pipe(less())
8		.pipe(gulp.dest('./css')
9});

You may set any predicate function to a vinyl file.

Basic filters

filter.not(fn)

Nagates filter conditions

1var not = filter.not;
2
3gulp.src('./less/**/*.less')
4	.pipe(filter(not(myFilter)) // will pass files which not satisfy myFilter

This filter passes less files which its name does not start with 'my_'.

filter.and(fn1, fn2, ...)

Passes files which satisfy every filter conditions.

1var and = filter.and;
2
3gulp.src('./less/**/*.less')
4	.pipe(filter(and(myFilter1, myFilter2)) // will pass files which satisfy myFilter1 and myFilter2

filter.or(fn1, fn2, ...)

Passes files which satisfy at least one of the filter conditions.

1var or = filter.or;
2
3gulp.src('./less/**/*.less')
4	.pipe(filter(or(myFilter1, myFilter2)) // will pass files which satisfy myFilter1 or myFilter2

filter.all()

Passes every files. This is equivalent function() { return true; }

1var all = filter.all;
2
3gulp.src('./less/**/*.less')
4	.pipe(filter(all())) // no file will be filtered out.

filter.none()

Passes no file. This is equivalent function() { return false; }

1var none = filter.none;
2
3gulp.src('./less/**/*.less')
4	.pipe(filter(none())) // no file will be passed.

Filename pattern filters

filter.glob(pattern, options)

Glob pattern filter for file name. Just a wrapper of minimatch.

1var glob = filter.glob;
2
3gulp.src('./**/*.*')
4	.pipe(filter(glob('./**/*.less'))).

• pattern: a string or an array of glob pattern.
• options: optional options.

filter.ignore(filename)

Ignore list filter.

1var ignore = filter.ignore;
2
3gulp.src('./**/*.*')
4	.pipe(filter(ignore('.gitignore')))

• filename: filename to ignore file.

Filter development guide

gulp-custom-filter accepts three type of predicate functions.

Simple boolean predicates: function(file, [encode]): boolean

A predicate must have one or two argument(s). It returns a boolean value true/false.

1gulp.src('./**/*.*')
2	.pipe(filter(function(file, encode) {
3		return file.isBuffer();
4	});

To fail the predicate, just throw an error.

1gulp.src('./**/*.*')
2	.pipe(filter(function(file, encode) {
3		throw new Error('error');
4	});

Asynchronous predicates: function(file, [encode], done: function(err, result)): void

A predicate must have three arguments. The third argument is a callback function to settle a result.

Call done with the second argument of true/false.

1gulp.src('./**/*.*')
2	.pipe(filter(function(file, encode, done) {
3		setTimeout(function() {
4			done(null, file.isBuffer()); // 1st argument must be falsy.
5		}, 0);
6	});

To fail the predicate, call done with the first argument of non-falsy value.

1gulp.src('./**/*.*')
2	.pipe(filter(function(file, encode, done) {
3		setTimeout(function() {
4			done(new Error('error'));
5		}, 0);
6	});

Promise predicates: function(file, done: function(err, result)): Promise.

A predicate must have one or two argument(s). It returns a fulfilling promise of boolean value true/false.

1gulp.src('./**/*.*')
2	.pipe(filter(function(file, encode) {
3		return Promise.resolve(file.isBuffer());
4	});

To fail the predicate, return a rejecting promise.

1gulp.src('./**/*.*')
2	.pipe(filter(function(file, encode) {
3		return Promise.reject(new Error('error'));
4	});

Release Notes

• v0.4.4

  • Security updates (library dependency)

• v0.4.3

  • Update library dependency

• v0.3.0

  • Update library dependency
  • Update supporting version of Node.js
    • Now we support Node 6 or higher

• v0.2.5

  • Update supporting version of Node.js
  • Fix assertion error message of or() filter

License

• MIT License
  • see LICENSE