gulp-group-aggregate

a group and aggregate plugin for gulp

Usage

First, install gulp-group-aggregate as a development dependency:

1npm install --save-dev gulp-group-aggregate

Then, add it to your gulpfile.js:

1var path = require('path');
2var groupAggregate = require('gulp-group-aggregate');
3
4var processFiles = function (files) {...}; 
5
6gulp.task('folderWrap', function(){
7  gulp.src(...)
8  	.pipe(groupAggregate({
9  		group: function (file){
10  			// group by the directory name of each file
11  			return path.basename(path.dirname(file.path));
12  		}, 
13  		aggregate: function (group, files){
14  			// create a new file by processing the grouped files
15  			return {
16  				path: group + '.html',
17  				contents: new Buffer(processFiles(files))
18  			};
19  		}
20  	}));
21    .pipe(gulp.dest(...));
22});

API

gulp-group-aggregate is a function(options) that returns a read-write stream. The options argument should include two functions: group and aggregate.

options.group

Type: function(File) returns string

Receives a vinyl from the stream and returns a string which represents its group.

options.aggregate

Type: function(string, File[]) returns File.options

Receives a group string as returned from group calls and an array of all the files associated with it. Returns a vinyl constructor.options object. The options will be used to construct a file which will be pushed through the stream.