![\"Travis](\"https://img.shields.io/travis/com/bevry/cson/master.svg\")
\n![\"NPM](\"https://img.shields.io/npm/v/cson.svg\")
\n![\"NPM](\"https://img.shields.io/npm/dm/cson.svg\")
\n![\"Dependency](\"https://img.shields.io/david/bevry/cson.svg\")
\n![\"Dev](\"https://img.shields.io/david/dev/bevry/cson.svg\")
\n![\"GitHub](\"https://img.shields.io/badge/github-donate-yellow.svg\"){kind=icon}
\n![\"Patreon](\"https://img.shields.io/badge/patreon-donate-yellow.svg\"){kind=icon}
\n![\"Flattr](\"https://img.shields.io/badge/flattr-donate-yellow.svg\"){kind=icon}
\n![\"Liberapay](\"https://img.shields.io/badge/liberapay-donate-yellow.svg\"){kind=icon}
\n![\"Buy](\"https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg\"){kind=icon}
\n![\"Open](\"https://img.shields.io/badge/open%20collective-donate-yellow.svg\"){kind=icon}
\n![\"crypto](\"https://img.shields.io/badge/crypto-donate-yellow.svg\"){kind=icon}
\n![\"PayPal](\"https://img.shields.io/badge/paypal-donate-yellow.svg\"){kind=icon}
\n![\"Wishlist](\"https://img.shields.io/badge/wishlist-donate-yellow.svg\"){kind=icon}
\n\n\n\n\nCoffeeScript-Object-Notation. Same as JSON but for CoffeeScript objects.\n\n[Projects using CSON.](https://www.npmjs.org/browse/depended/cson)\n\n[Projects using CSON Parser directly.](https://www.npmjs.org/browse/depended/cson-parser)\n\nSince v2, this CSON package is a higher-level wrapper around the lower-level [CSON Parser](https://www.npmjs.com/package/cson-parser).\n\n\n\n\n\n## What is CSON?\n\nEveryone knows JSON, it's the thing that looks like this:\n\n``` javascript\n{\n \"greatDocumentaries\": [\n \"earthlings.com\",\n \"forksoverknives.com\",\n \"cowspiracy.com\"\n ],\n \"importantFacts\": {\n \"emissions\": \"Livestock and their byproducts account for at least 32,000 million tons of carbon dioxide (CO2) per year, or 51% of all worldwide greenhouse gas emissions.\\nGoodland, R Anhang, J. “Livestock and Climate Change: What if the key actors in climate change were pigs, chickens and cows?”\\nWorldWatch, November/December 2009. Worldwatch Institute, Washington, DC, USA. Pp. 10–19.\\nhttp://www.worldwatch.org/node/6294\",\n \"landuse\": \"Livestock covers 45% of the earth’s total land.\\nThornton, Phillip, Mario Herrero, and Polly Ericksen. “Livestock and Climate Change.” Livestock Exchange, no. 3 (2011).\\nhttps://cgspace.cgiar.org/bitstream/handle/10568/10601/IssueBrief3.pdf\",\n \"burger\": \"One hamburger requires 660 gallons of water to produce – the equivalent of 2 months’ worth of showers.\\nCatanese, Christina. “Virtual Water, Real Impacts.” Greenversations: Official Blog of the U.S. EPA. 2012.\\nhttp://blog.epa.gov/healthywaters/2012/03/virtual-water-real-impacts-world-water-day-2012/\\n“50 Ways to Save Your River.” Friends of the River.\\nhttp://www.friendsoftheriver.org/site/PageServer?pagename=50ways\",\n \"milk\": \"1,000 gallons of water are required to produce 1 gallon of milk.\\n“Water trivia facts.” United States Environmental Protection Agency.\\nhttp://water.epa.gov/learn/kids/drinkingwater/water_trivia_facts.cfm#_edn11\",\n \"more\": \"http://cowspiracy.com/facts\"\n }\n}\n```\n\nNow let's write the same thing in CSON:\n\n``` coffeescript\n# Comments!!!\n\n# An Array with no commas!\ngreatDocumentaries: [\n\t'earthlings.com'\n\t'forksoverknives.com'\n\t'cowspiracy.com'\n]\n\n# An Object without braces!\nimportantFacts:\n\t# Multi-Line Strings! Without Quote Escaping!\n\temissions: '''\n\t\tLivestock and their byproducts account for at least 32,000 million tons of carbon dioxide (CO2) per year, or 51% of all worldwide greenhouse gas emissions.\n\t\tGoodland, R Anhang, J. “Livestock and Climate Change: What if the key actors in climate change were pigs, chickens and cows?”\n\t\tWorldWatch, November/December 2009. Worldwatch Institute, Washington, DC, USA. Pp. 10–19.\n\t\thttp://www.worldwatch.org/node/6294\n\t\t'''\n\n\tlanduse: '''\n\t\tLivestock covers 45% of the earth’s total land.\n\t\tThornton, Phillip, Mario Herrero, and Polly Ericksen. “Livestock and Climate Change.” Livestock Exchange, no. 3 (2011).\n\t\thttps://cgspace.cgiar.org/bitstream/handle/10568/10601/IssueBrief3.pdf\n\t\t'''\n\n\tburger: '''\n\t\tOne hamburger requires 660 gallons of water to produce – the equivalent of 2 months’ worth of showers.\n\t\tCatanese, Christina. “Virtual Water, Real Impacts.” Greenversations: Official Blog of the U.S. EPA. 2012.\n\t\thttp://blog.epa.gov/healthywaters/2012/03/virtual-water-real-impacts-world-water-day-2012/\n\t\t“50 Ways to Save Your River.” Friends of the River.\n\t\thttp://www.friendsoftheriver.org/site/PageServer?pagename=50ways\n\t\t'''\n\n\tmilk: '''\n\t\t1,000 gallons of water are required to produce 1 gallon of milk.\n\t\t“Water trivia facts.” United States Environmental Protection Agency.\n\t\thttp://water.epa.gov/learn/kids/drinkingwater/water_trivia_facts.cfm#_edn11\n\t\t'''\n\n\tmore: 'http://cowspiracy.com/facts'\n```\n\nWhich is far more lenient than JSON, way nicer to write and read, no need to quote and escape everything, has comments and readable multi-line strings, and won't fail if you forget a comma.\n\n\n\n## Using CSON\n\n### Via the Command Line\n\nUse CSON with the command line with:\n\n``` bash\n# Convert a JSON file into a CSON file\njson2cson in.json > out.cson\n# Same thing via piping\ncat in.json | json2cson > out.cson\n\n# Convert a CSON file into a JSON file\ncson2json in.cson > out.json\n# Same thing via piping\ncat in.cson | cson2json > out.json\n```\n\nRequires a global CSON install: `npm install -g cson`\n\n\n### Via the API\n\nInclude CSON:\n\n``` javascript\nvar CSON = require('cson')\n```\n\nEach method can be executed without a callback like so:\n\n``` javascript\nvar result = CSON.createCSONString({a:{b:'c'}}, {/* optional options argument */})\nif ( result instanceof Error ) {\n\tconsole.log(result.stack)\n} else {\n\tconsole.log(result)\n}\n```\n\nOr via a callback like so:\n\n``` javascript\nCSON.createCSONString({a:{b:'c'}}, {/* optional options argument */}, function(err,result){\n\tconsole.log(err, result)\n})\n```\n\nExecuting the method with a callback still executes the method synchronously.\n\nClick the below function names to open more detailed documentation.\n\n\n#### Create Strings\n\n- String CSON.stringify(data, replacer?, indent?) npm install --global csoncson2json, json2csonnpm install --save csonnpx cson2json, npx json2csonimport * as pkg from ('cson')const pkg = require('cson')This package is published with the following editions:
\n\ncson/source/index.coffee is CoffeeScript source code with Require for modulescson aliases cson/edition-esnext/index.jscson/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n