gulp-match

What is gulp-match?

The gulp-match package is a utility for conditionally filtering files in a Gulp stream based on a given criteria. It allows you to apply certain tasks only to files that match specific patterns or conditions.

What are gulp-match's main functionalities?

Conditional Task Execution

This feature allows you to conditionally apply tasks to files that match a specific pattern. In this example, the `uglify` task is only applied to JavaScript files.

const gulp = require('gulp');
const gulpIf = require('gulp-if');
const gulpMatch = require('gulp-match');
const uglify = require('gulp-uglify');

function isJavaScript(file) {
  return gulpMatch(file, '**/*.js');
}

gulp.task('scripts', function() {
  return gulp.src('src/**/*')
    .pipe(gulpIf(isJavaScript, uglify()))
    .pipe(gulp.dest('dist'));
});

Pattern Matching

This feature allows you to log or perform actions on files that match a specific pattern. In this example, it logs the paths of all CSS files.

const gulp = require('gulp');
const gulpMatch = require('gulp-match');

function logMatchedFiles() {
  return gulp.src('src/**/*')
    .pipe(gulp.dest('dist'))
    .on('data', function(file) {
      if (gulpMatch(file, '**/*.css')) {
        console.log('CSS file:', file.path);
      }
    });
}

gulp.task('logFiles', logMatchedFiles);

Other packages similar to gulp-match

gulp-if

The gulp-if package is used to conditionally control the flow of files in a Gulp pipeline. It is similar to gulp-match in that it allows you to apply tasks based on conditions, but it is more focused on the conditional execution of tasks rather than just matching files.

gulp-filter

The gulp-filter package allows you to filter files in a Gulp stream based on a given criteria. It is similar to gulp-match but provides more advanced filtering capabilities, such as the ability to restore filtered files back into the stream.

README

gulp-match

Does a vinyl file match a condition? This function checks the condition on the file.path of the vinyl-fs file passed to it.

Condition can be a boolean, a function, a regular expression, a glob string (or array of glob strings), or a stat filter object

Used by gulp-if and gulp-ignore

Usage

var gulpmatch = require('gulp-match');
var map = require('map-stream');

var condition = true; // TODO: add business logic here

vinylfs.src('path/to/file.js')
  .pipe(map(function (file, cb) {
    var match = gulpmatch(file, condition);
    if (match) {
      // it matched, do stuff
    }
    cb(null, file);
  }));

API

file

A vinyl-fs file.

condition

boolean condition

var match = gulpmatch(file, true);

if the condition parameter is true or false, results will also be true or false.

function condition

var match = gulpmatch(file, function (file) {
  return true;
})

if the condition parameter is a function, it will be called, passing in file passed to gulp-match.

regular expression condition

var match = gulpmatch(file, /some\/path\.js/);

If the condition is a regular expression, it will be evaluated on the file.path passed to gulp-match.

glob condition

var match = gulpmatch(file, './some/path.js');

var match = gulpmatch(file, ['./array','!./of','./globs.js']);

The globs are passed to minimatch. If the glob matches (or any of the elements in the array match), gulp-match returns true else false.

stat filter condition

var match = gulpmatch(file, {isFile:true});

var match = gulpmatch(file, {isDirectory:false});

If the condition is an object with a isFile or isDirectory property, it'll match the details on the vinyl-fs file's stat object.

else

var match = gulpmatch(file, 42);
// match = true

var match = gulpmatch(file, '');
// match = false

If there's no matching rule from the rules above, it'll return true for truthy conditions, false for falsey conditions (including undefined).

LICENSE

(MIT License)

Copyright (c) 2014 Richardson & Sons, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.