quaff

quaff

A data pipeline helper written in node that works similar to Middleman's Data Files collector.

Point the library at a folder filled with JSON and/or YAML files and get a JavaScript object back that reflects the folder's structure. Great for pulling data in to templates!

Under the hood it uses JavaScript's built in JSON support and js-yaml to read files.

Installation

npm install quaff --save-dev

Requires the latest iojs or node>=0.12.0.

Usage

Assume a folder with this structure.

data/
  mammals/
    cats.json
    dogs.json
  birds/
    parrots.yml

After require()'ing quaff:

var quaff = require('quaff');
var data = quaff('./data/');

console.log(data);

And the results...

{
  "mammals": {
    "cats": [
      "Marty",
      "Sammy"
    ],
    "dogs": [
      "Snazzy"
      "Cally"
    ]
  },
  "birds": {
    "parrots": {
      "alive": [
        "Buzz"
      ],
      "dead": [
        "Moose"
      ]
    }
  }
}

License

By Ryan Murphy.

Available under the MIT license.