https://github.com/haraldrudell/greatjson

JSON.parse replacement with helpful Syntax messages providing location, expected tokens and offending excerpt. By Harald Rudell
https://github.com/haraldrudell/greatjson

Last synced: 1 day ago
JSON representation

JSON.parse replacement with helpful Syntax messages providing location, expected tokens and offending excerpt. By Harald Rudell

• Host: GitHub
• URL: https://github.com/haraldrudell/greatjson
• Owner: haraldrudell
• Created: 2012-08-09T07:16:40.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-09-22T00:35:39.000Z (about 12 years ago)
• Last Synced: 2024-11-11T20:38:04.538Z (7 days ago)
• Language: JavaScript
• Homepage:
• Size: 145 KB
• Stars: 7
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Great Json

The **greatjson** module is a **JSON.parse** replacement providing enhanced syntax messages.

## Benefits

1. **Faster fixing** of bad json by using text location, expected tokens and the offending text provided by Great Json

2. Ability to customize **user-friendly error messages** by using the custom error properties Great Json provides

3. **Fewer lines** of code since errors are returned instead of thrown

## Features

1. Errors with line and column numbers, expected tokens and offending text

2. Errors are returned instead of thrown

# Usage

Example of parsing with greatjson:

```js

var greatjson = require('greatjson')

var result, error

// example how to use successfully

if (!((result = greatjson.parse('17')) instanceof Error))

	// It works! I got: 17

	console.log('It works! I got:', result)

// example of parse failure

if (!((error = greatjson.parse('qwerty')) instanceof Error)) ;

else

	/*

	SyntaxError:

	Unexpected token: expected json value,

	text:'qwerty'

	at line:1 column:1 position: 0 (0%)

	*/

	console.log(error.toString())

// example of missing comma

if (!((error = greatjson.parse('{"a":5"b":6}')) instanceof Error)) ;

else {

	/*

	SyntaxError: Bad token:

	expected object comma from line:1 column:2 position: 1 (8%),

	text:'"b":6}'

	at line:1 column:7 position: 6 (50%)

	*/

	console.log(error.toString())

	// printout of custom error properties

	var s = []

	for (var p in error) s.push(p + ':' + error[p])

	/*

	Error properties:

	position:6

	line:1

	column:7

	text:"b":6}

	*/

	console.log('Error properties:', s.join(' '))

}

```

# Notes

(c) [Harald Rudell](http://www.haraldrudell.com) wrote this for node in August, 2012

Great Json is based on work by

* [Mike Samuel](http://json-sans-eval.googlecode.com/)

* [Douglas Crockford](https://github.com/douglascrockford/JSON-js)

[JavaScript Object Notation](http://json.org/) or json is a language-independent text format.

[rfc4627](http://www.ietf.org/rfc/rfc4627): the application/json media type.

[JSON.parse](http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-262.pdf#page=215) in secion 15.12.2 of JavaScript.

No warranty expressed or implied. Use at your own risk.

Please suggest better ways, new features, and possible difficulties on [github](https://github.com/haraldrudell/greatjson)