JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 188776
  • Score
    100M100P100Q162941F
  • License MIT

Filter files in a vinyl stream

Package Exports

  • gulp-filter

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-filter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gulp-filter Build Status

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 restore method.

Install

Install with npm

npm install --save-dev gulp-filter

Examples

Simple

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

var filter = gulpFilter('!src/vendor');

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

Multiple filters

By combining and restoring different filters you can process different sets of files with a single pipeline.

var gulp = require('gulp');
var less = require('gulp-less');
var concat = require('gulp-concat');
var gulpFilter = require('gulp-filter');

var jsFilter = gulpFilter('**/*.js');
var lessFilter = gulpFilter('**/*.less');

gulp.task('default', function () {
    gulp.src('assets/**')
        .pipe(jsFilter)
        .pipe(concat("bundle.js"))
        .pipe(jsFilter.restore())
        .pipe(lessFilter)
        .pipe(less())
        .pipe(lessFilter.restore())
        .pipe(gulp.dest('out/'));
});

API

filter(pattern, options)

Returns a transform stream with a .restore() method.

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);
});

options

Type: Object

Accepts minimatch options.

Note: Set dot: true if you need to match files prefixed with a dot (eg. .gitignore).

stream.restore()

Brings back the previously filtered out files.

License

MIT © Sindre Sorhus