season - CSON Node module

  

Read and write CSON/JSON files seamlessly.

Installing

``sh
npm install season
`

Building


* Clone the repository
* Run npm install
* Run grunt to compile the CoffeeScript code
* Run grunt test to run the specs

Compiling CSON to JSON

This module comes with a csonc executable that allows you to compile a CSON
file to JSON.

To use:

`sh
npm install -g season
echo "this: 'is cson'" > file.cson
csonc file.cson --output file.json
cat file.json
{
"this": "is cson"
}
`

Docs

`coffeescript
CSON = require 'season'
`

$3

Set the cache directory to use for storing compiled CSON files.

cacheDirectory - Root directory path for storing compiled CSON.

$3

Convert the object to a CSON string.

object - The object to convert to CSON.

Returns the CSON string representation of the given object.

$3

Read the CSON or JSON object at the given path and return it to the callback
once it is read and parsed.

objectPath - The string path to a JSON or CSON object file.

callback - The function to call with the error or object once the path
is read and parsed.

$3

Synchronous version of CSON.readFile(objectPath, callback).

Returns the object read from the path or throws an error if reading fails.

$3

Write the object to the given path as either JSON or CSON depending on the
path's extension.

objectPath - The string path to a JSON or CSON object file.

object - The object to convert to a string and write to the path.

callback - The function to with an error object on failures.

$3

Synchronous version of CSON.writeFile(objectPath, object, callback)

$3

Is the given path a valid object path?

Returns true if the path has a .json or .cson file extension, false
otherwise.

$3

Resolve the path to an existent file that has a .json or .cson extension.

objectPath - The string path to a JSON or CSON object file with or without
an extension.

Returns the path to an existent CSON or JSON file or null` if none found.