gulp-csv-to-json v0.1.1

gulp-csv-to-json

Generate static JSON from CSV key/value data.

Getting Started

This plugin requires Gulp ~0.4.0

If you haven't used Gulp before, be sure to check out the Getting Started guide, as it explains how to create a Gulpfile as well as install and use Gulp plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install gulp-csv-to-json --save-dev

The "csvjson" task

Overview

This task builds JSON structures from key/value data defined in CSV format. Multiple JSON resources can be defined per CSV document.

The following CSV document:

Will generate two JSON resources:

// dest/bob.json
{
	"name": "Bob",
	"sex": "male",
	"age": 54
}

// dest/sue.json
{
	"name": "Sue",
	"sex": "female",
	"age": 24
}

In your project's Gulpfile, add a section named csvjson to the data object passed into gulp.initConfig().

var gulp = require('gulp');
var csv2json = require('gulp-csv-to-json');
var options = {};
gulp.task('csvToJson', function () {
    return gulp
    	.src('src/**/*.csv')
        .pipe(csv2json(options))
        .pipe(gulp.dest('dist'));
});

Options

options

Type: Object

CSV parser options: see node-csv-parse#parser-options.

options = {
	auto_parse : true
};

options.processValue

Type: Function

Hook to process field value.

options = {
	processValue: function (key, value) {
		return value;
	}	
};

CSV format

The expected format is one row per value, with resource names defined in the first row, and field keys in the first column.

Object hierarchy

Object hierarchy is expressed with dot notation in the key.

The following data:

Will generate:

{
	"person": {
		"name": "Bob",
		"sex": "male",
		"age": 54
	}
}

Implicit array syntax

Arrays of values can be implicitly defined by duplicating keys.

The following data:

Will generate:

{
	"shopping": {
		"day": "Sunday",
		"list": ["fruit", "candy", "pasta", "spinach"]
	}
}

Explicit array syntax

Arrays of values can be explicitly defined by using integer keys.

The following data:

Will generate:

{
	"list": [
		["fruit", "candy"],
		["pasta", "spinach"]
	]
}