node-csvjson v0.0.3

node-csvjson

Generate static JSON from CSV key/value data.

Getting Started

Using npm:

npm install node-csvjson --save-dev

Using yarn:

yarn install node-csvjson --save

Usage

Short version

require('node-csv-json')('directory containing csv files');

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
}

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"]
	]
}

node-csvjson