Skip to content

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

License

Notifications You must be signed in to change notification settings

reflog/gulp-jsoncombine

Repository files navigation

gulp-jsoncombine

NPM version Build Status Coverage Status Dependency Status

jsoncombine plugin for gulp

Usage

First, install gulp-jsoncombine as a 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' suffix) 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, meta){...}))
	.pipe(gulp.dest("./dist"));

API

jsoncombine(fileName, processor)

fileName

Type: String

The output filename

processor

Type: Function

The processor function will be called with two dictionaries holding the same set of keys. The keys are the filename sans the .json suffix of a file in the gulp stream.

The first dictionary maps the filename to the string contents of the file. The second dictionary maps to a meta object containing the following keys:

  • cwd The working directory
  • base The base path
  • path The full path to the file

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

License

MIT License

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published