https://github.com/groupon/cson-parser

Simple & safe CSON parser
https://github.com/groupon/cson-parser

coffeescript cson cson-parser javascript nodejs

Last synced: about 2 months ago
JSON representation

Simple & safe CSON parser

• Host: GitHub
• URL: https://github.com/groupon/cson-parser
• Owner: groupon
• License: bsd-3-clause
• Created: 2014-03-03T19:30:02.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2023-01-07T22:18:30.000Z (over 1 year ago)
• Last Synced: 2024-05-20T13:02:52.888Z (4 months ago)
• Topics: coffeescript, cson, cson-parser, javascript, nodejs
• Language: JavaScript
• Homepage:
• Size: 497 KB
• Stars: 132
• Watchers: 10
• Forks: 27
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![nlm-github](https://img.shields.io/badge/github-groupon%2Fcson--parser%2Fissues-F4D03F?logo=github&logoColor=white)](https://github.com/groupon/cson-parser/issues)

![nlm-node](https://img.shields.io/badge/node-%3E%3D10.13-blue?logo=node.js&logoColor=white)

![nlm-version](https://img.shields.io/badge/version-4.0.9-blue?logo=version&logoColor=white)

# cson-parser

A minimalistic CSON parser. Offers:

* A strict subset of CSON that allows only data

* Interface is identical to JSON.{parse,stringify}

* Does not run the code, free of intermediate string representations

* Sane parse error messages with line/column

* Regular Expressions are considered data and will be accepted as well

In addition of pure data it allows for simple arithmetic expressions like

addition and multiplication.

This allows more readable configuration of numbers,

the following is a valid strict CSON file:

```coffee

cachedData:

  refreshIntervalMs: 5 * 60 * 1000

```

## Install

`npm install --save cson-parser`

## Usage

```coffee

CSON = require 'cson-parser'

# This will print { a: '123' }

console.log CSON.parse "a: '123'"

```

## High-level APIs

`cson-parser` only offers basic parsing and serialization.

But there are some great tools if you want more than that:

* [`fs-cson`](https://github.com/charlierudolph/fs-cson), read and write CSON files

* [`CSON`](https://github.com/bevry/cson), provides file, coffeescript, javascript handling and a CLI

* [`season`](https://www.npmjs.org/package/season),

  atom.io's CSON package.

  Includes CLI tool to convert CSON to JSON

* [`grunt-cson`](https://www.npmjs.org/package/grunt-cson),

  converts CSON to JSON as a grunt task

* [`load-grunt-configs`](https://www.npmjs.org/package/load-grunt-configs),

  loads grunt config from CSON files (among other formats)

* [`fetcher`](https://www.npmjs.org/package/fetcher),

  a declarative way to download (frontend) libraries, supports CSON configs

* [`csonschema`](https://www.npmjs.org/package/csonschema),

  parses [JSON Schema](http://json-schema.org) files written in CSON

You can find more on the

[npm website](https://preview.npmjs.com/browse/depended/cson-parser).

## FAQ

### Why not just use YAML?

YAML allows for some pretty complex constructs like anchor and alias,

which can behave in unexpected ways, especially with nested objects.

CSON is simpler while still offering most of the niceties of YAML.

### Why not just use JSON?

JSON doesn't offer multi-line strings and is generally a little noisier.

Also sometimes it can be nice to have comments in config files.

### Why not just use CoffeeScript directly?

You don't want data files being able to run arbitrary code.

Even when ran in a proper sandbox, `while(true)` is still possible.