Git Product home page Git Product logo

gulp-json-transform's Introduction

gulp-json-transform

NPM Version Build Status Dependencies Status

A gulp plugin to transform JSON files, pipe JSON files through it and transform them to other JSON files or other text based formats.

Usage

First install gulp-json-transform as a development dependency:

npm install gulp-json-transform --save-dev

Then, add it to your gulpfile.js:

var jsonTransform = require('gulp-json-transform');

Then create a task that uses it:

gulp.task('do-something', function() {
	gulp.src('./app/**/*.json')
	.pipe(jsonTransform(function(data, file) {
		return {
			foobar: data.foo + file.relative
		};
	}))
	.pipe(gulp.dest('./dist/out/'));
});

API

jsonTransform(transformFn [, whiteSpace])

transformFn

Type: function

A function that takes the JSON object and a file object (parameters path, base and relative are exposed) as the input parameters and should return either a string which is written raw to the file, a JSON object which is stringified or a Promise which resolves to a string or a JSON object.

Example structure of the file object:

{
  path: 'test/fixtures/input.json',
  relative: 'input.json',
  base: 'test/fixtures'
}

whiteSpace

Type: String or Number Default: undefined

JSON.stringify's whitespace attribute for pretty-printing the resulting JSON. See MDN docs on JSON.stringify() for more information.

License

MIT License

gulp-json-transform's People

Contributors

thaggie avatar handtrix avatar bipol-cb avatar breyed avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.