cson

CoffeeScript-Object-Notation Parser. Same as JSON but for CoffeeScript objects

npm install cson
326 downloads in the last day
3 525 downloads in the last week
14 455 downloads in the last month

CSON

Build Status NPM version Gittip donate button Flattr donate button PayPayl donate button

CoffeeScript-Object-Notation Parser. Same as JSON but for CoffeeScript objects

Install

Node, Browserify

  • Use: require('cson')
  • Install: npm install --save cson

Ender

  • Use: require('cson')
  • Install: ender add cson

What is CSON?

Everyone knows JSON, it's the thing that looks like this:

{
    "abc": [
        "a",
        "b",
        "c"
    ],
    "a": {
        "b": "c"
    }
}

But with the invention of CoffeeScript you can also write the same thing in CSON which looks like this:

{
    # an array
    abc: [
        'a'
        'b'
        'c'
    ]

    # an object
    a:
        b: 'c'
}

Which is far more lenient than JSON, nicer to write and read, you don't have to quote everything, you have comments, and won't fail if you forget a comma.

Installing

  1. Install Node.js

  2. Install CSON

     npm install --save cson
    

Using CSON

  • With Node.js in JavaScript

      // Include CSON
      CSON = require('cson');
    
      // Parse a file path
      CSON.parseFile('data.cson', function(err,obj){});  // async
      result = CSON.parseFileSync('data.cson');  // sync
    
      // Parse a String
      CSON.parse(src, function(err,obj){});  // async
      result = CSON.parseSync(src);  // sync
    
      // Stringify an object to CSON
      CSON.stringify(obj, function(err,str){});  // async
      result = CSON.stringifySync(obj);  // sync
    
  • With Node.js in CoffeeScript

    ``` coffeescript

    Include CSON

    CSON = require('cson')

    Parse a file path

    CSON.parseFile 'data.cson', (err,obj) -> # async result = CSON.parseFile('data.cson') # sync

    Parse a string

    CSON.parse src, (err,obj) -> # async result = CSON.parseSync(src) # sync

    Stringify an object to CSON

    CSON.stringify data, (err,str) -> # async result = CSON.stringifySync(obj) # sync

  • Via the command line (requires a global installation of CSON via npm install -g cson)

      # JSON file to CSON String
      json2cson filePath > out.cson
    
      # CSON file to JSON String
      cson2json filePath > out.json
    

History

Discover the change history by heading on over to the History.md file.

Contribute

Discover how you can contribute by heading on over to the Contributing.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Gittip donate button Flattr donate button PayPayl donate button

Contributors

These amazing people have contributed code to this project:

Become a contributor!

License

Licensed under the incredibly permissive MIT license

Copyright © 2012+ Bevry Pty Ltd us@bevry.me (http://bevry.me)
Copyright © 2011 Benjamin Lupton b@lupton.cc (http://balupton.com)

npm loves you