gulp-filechange v1.0.0

gulp-filechange

Change (Vinyl) file objects while passing through a Gulp stream.

Similar to gulp-modify, gulp-modify-file and gulp-filemod. But instead of a focus on the file's contents, this plugin just passes the Vinyl file object to the provided callback function. Any of the file's properties can then be changed, or optionally a completely new file object can be returned by the callback.

Note: This plugin doesn't support stream based files. Use gulp-buffer (and gulp-stream) to circumvent this issue.

Install

Install with npm

npm install --save-dev gulp-filechange

Usage

Modifying the properties of a file object:

var gulp = require("gulp");
var filechange = require("gulp-filechange");

gulp.task("default", function () {
	gulp.src("src/file.js")
		.pipe(filechange(function(file) {
			file.path = "/src/tree.js";
		}))
		.pipe(gulp.dest("dist"));
});

Returning a new file object:

var gulp = require("gulp");
var Vinyl = require("vinyl");
var filechange = require("gulp-filechange");

gulp.task("default", function () {
	gulp.src("src/file.js")
		.pipe(filechange(function(file) {
			return new Vinyl({
				cwd: "/",
				base: "/lib/",
				path: "/lib/er.ty",
				contents: new Buffer("city")
			});
		}))
		.pipe(gulp.dest("dist"));
});

API

filechange(callback)

callback

Type: function
Required: true
Returns: Vinyl

Function that gets called with the Vinyl file as its first parameter. Optionally a new Vinyl file object can be returned which will then be passed on in the Gulp stream instead of the original file object. If no value (or a non-vinyl object) is returned, then the modified original file is passed on in the Gulp stream.

License

gulp-filechange is Copyright (c) 2017 Wouter Vanmontfort and licensed under the ISC license. All rights not explicitly granted in the ISC license are reserved. See the included LICENSE file for more details.