Skip to content

Latest commit

 

History

History
120 lines (78 loc) · 3.62 KB

README.md

File metadata and controls

120 lines (78 loc) · 3.62 KB
Raw

jsonic

npm version Build Status Coverage Status Dependency Status Gitter chat

A JSON parser for Node.js that isn't strict.

A JSON parser that can parse "bad" JSON. Mostly, this is about avoiding the need to quote everything!

Strict JSON requires you to do this:

{ "foo":"bar", "red":1 }

The JavaScript language itself is a little easier:

{ foo:"bar", red:1, }

But if you really want to be lazy, jsonic lets you say:

foo:bar, red:1,

See below for the relaxed JSON rules.

This module is used by the Seneca framework to provide an abbreviated command syntax.

Support

If you're using this module, feel free to contact me on twitter if you have any questions! :) @rjrodger

Quick example

var jsonic = require('jsonic')

// parse a string into a JavaScript object
var obj = jsonic('foo:1, bar:zed')

// prints { foo: 1, bar: 'zed' }
console.dir( obj )

Install

npm install jsonic

Relaxed Rules

JSONIC format is just standard JSON, with a few rule relaxations:

  • You don't need to quote property names: { foo:"bar baz", red:255 }
  • You don't need the top level braces: foo:"bar baz", red:255
  • You don't need to quote strings with spaces: foo:bar baz, red:255
  • You do need to quote strings if they contain a comma or closing brace or square bracket: icky:",}]"
  • You can use single quotes for strings: Jules:'Cry "Havoc," and let slip the dogs of war!'
  • You can have trailing commas: foo:bar, red:255,

Stringify

The jsonic module provides a stringify method:

console.log( jsonic.stringify( {a:"bc",d:1} ) ) // prints {a:bc,d:1}

The stringify method converts a plain JavaScript object into a string that can be parsed by jsonic. It has two parameters:

  • value: plain object
  • options: optional options object

For example, you can limit the depth of the object tree printed:

console.log( jsonic.stringify( {a:{b:{c:1}}}, {depth:2} ) ) // prints {a:{b:{}}}

NOTE: jsonic.stringify is intended for debug printing, not data exchange, so the defaults are conservative in the amount of data printed

The options are:

  • depth: default: 3; maximum depth of sub-objects printed; NOTE: there is no infinite-cycle protection, just this finite depth
  • maxitems: default: 11; maximum number of array elements or object key/value pairs printed
  • maxchars: default: 111; maximum number of characters printed
  • omit: default:[]; omit listed keys from objects
  • exclude: default:['$']; omit keys from objects if they contain any of the listed values

How it Works

The parser uses PEG.js and is an extension of the example JSON parser included in that project.