CSON vs JSON

CSON vs JSON

今天在github浏览资料时，无意发现了这个很像json,却优于json的cson.故，再次分享给大家！

官方fork文档：https://github.com/xgqfrms/cson

What is CSON?

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

cosn有比json更宽松，更好的读写方式，并且不需要引号，摆脱一切，它拥有注释和可读的多行字符串，即使你忘了一个逗号，也不会出错！

对比：

json的格式:

{
  "greatDocumentaries": [
    "earthlings.com",
    "forksoverknives.com",
    "cowspiracy.com"
  ],
  "importantFacts": {
    "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",
    "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",
    "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",
    "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",
    "more": "http://cowspiracy.com/facts"
  }
}

cson的格式:

# Comments!!!
 
# An Array with no commas!
greatDocumentaries: [
    'earthlings.com'
    'forksoverknives.com'
    'cowspiracy.com'
]
 
# An Object without braces!
importantFacts:
    # Multi-Line Strings! Without Quote Escaping!
    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.
        Goodland, R Anhang, J. “Livestock and Climate Change: What if the key actors in climate change were pigs, chickens and cows?”
        WorldWatch, November/December 2009. Worldwatch Institute, Washington, DC, USA. Pp. 10–19.
        http://www.worldwatch.org/node/6294
        '''
 
    landuse: '''
        Livestock covers 45% of the earth’s total land.
        Thornton, Phillip, Mario Herrero, and Polly Ericksen. “Livestock and Climate Change.” Livestock Exchange, no. 3 (2011).
        https://cgspace.cgiar.org/bitstream/handle/10568/10601/IssueBrief3.pdf
        '''
 
    burger: '''
        One hamburger requires 660 gallons of water to produce – the equivalent of 2 months’ worth of showers.
        Catanese, Christina. “Virtual Water, Real Impacts.” Greenversations: Official Blog of the U.S. EPA. 2012.
        http://blog.epa.gov/healthywaters/2012/03/virtual-water-real-impacts-world-water-day-2012/
        “50 Ways to Save Your River.” Friends of the River.
        http://www.friendsoftheriver.org/site/PageServer?pagename=50ways
        '''
 
    milk: '''
        1,000 gallons of water are required to produce 1 gallon of milk.
        “Water trivia facts.” United States Environmental Protection Agency.
        http://water.epa.gov/learn/kids/drinkingwater/water_trivia_facts.cfm#_edn11
        '''
 
    more: 'http://cowspiracy.com/facts'

NPM 安装方法：

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

使用 CSON 的方式:

1. 命令行方式：

# Convert a JSON file into a CSON file
json2cson in.json > out.cson
# Same thing via piping
cat in.json | json2cson > out.cson
 
# Convert a CSON file into a JSON file
cson2json in.cson > out.json
# Same thing via piping
cat in.cson | cson2json > out.json

需要一个全局的 CSON 安装包: npm install -g cson

2. 通过 API　方式：

每一个方法都能被执行 ，使用像这样的一个回调:

result = require('CSON').createCSONString({a:{b:'c'}}, {/* optional options argument */})
if ( result instanceof Error ) {
    console.log(result.stack)
} else {
    console.log(result)
}

或　通过像这样的一个回调:

CSON.createCSONString({a:{b:'c'}}, {/* optional options argument */}, function(err,result){
    console.log(err, result)
})

创建字符串：

• String CSON.stringify(data, replacer?, indent?)
  Converts an Object into a CSON String

• String CSON.createCSONString(data, opts?, next?)
  Converts an Object into a CSON String

• String CSON.createJSONString(data, opts?, next?)
  Converts an Object into a JSON String

• String CSON.createString(data, opts?, next?)
  Converts an Object into a String of the desired format If the format option is not specified, we default to CSON

解析字符串：

• Object CSON.parse(data, opts?, next?)
  Parses a CSON String into an Object

• Object CSON.parseCSONString(data, opts?, next?)
  Parses a CSON String into an Object

• Object CSON.parseJSONString(data, opts?, next?)
  Parses a JSON String into an Object

• Object CSON.parseCSString(data, opts?, next?)
  Parses a CoffeeScript String into an Object

• Object CSON.parseJSString(data, opts?, next?)
  Parses a JavaScript String into an Object

• Object CSON.parseString(data, opts?, next?)
  Converts a String of the desired format into an Object If the format option is not specified, we default to CSON

需求文件：

• Object CSON.requireCSFile(filePath, opts?, next?)
  Requires a CoffeeScript file and returns the result Object

• Object CSON.requireJSFile(filePath, opts?, next?)
  Requires a JavaScript file and returns the result Object

• Object CSON.requireFile(filePath, opts?, next?)
  Requires or parses a file path of the desired format into an Object If the format option is not specified, we use the filename to detect what it should be, otherwise we default to parsing CSON

许可授权：

Unless stated otherwise all works are:

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

and licensed under:

• The incredibly permissive MIT License