Have ideas to improve npm?Join in the discussion! »

    gulp-json-transform

    0.4.7 • Public • Published

    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

    Install

    npm i gulp-json-transform

    DownloadsWeekly Downloads

    3,461

    Version

    0.4.7

    License

    MIT

    Unpacked Size

    8.01 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar