boris-arkenaar / gulp-jsoncombine

A plugin for Gulp to combine several JSON files using a custom function

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

gulp-jsoncombine

NPM version Build Status Coverage Status Dependency Status

jsoncombine plugin for gulp

Usage

First, install gulp-jsoncombine as a development dependency:

npm install --save-dev gulp-jsoncombine

Then, add it to your gulpfile.js:

** This plugin will collect all the json files provided to it, parse them, put them in a dictionary where the keys of that dictionary are the filenames (sans the '.json' postfix) and pass that to a processor function. That function decides how that output should look in the resulting file. **

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

gulp.src("./src/*.json")
	.pipe(jsoncombine("result.js",function(data){...}))
	.pipe(gulp.dest("./dist"));

API

jsoncombine(fileName, processor)

fileName

Type: String

The output filename

processor

Type: Function

The function that will be called with the dictionary containing all the data from the processes JSON files, where the keys of the dictionary, would be the names of the files (sans the '.json' postfix).

The function should return a new Buffer that would be writter to the output file.

License

MIT License

About

A plugin for Gulp to combine several JSON files using a custom function

License:MIT License


Languages

Language:JavaScript 100.0%