marys
140 lines
2.7 KiB
Markdown
140 lines
2.7 KiB
Markdown
[npm-icon]: https://img.shields.io/npm/v/json-to-ast.svg
|
||
[npm-downloads-icon]: https://img.shields.io/npm/dm/json-to-ast.svg
|
||
[npm-url]: https://www.npmjs.com/package/json-to-ast
|
||
|
||
[node-versions-icon]: https://img.shields.io/node/v/json-to-ast.svg
|
||
[node-url]: https://nodejs.org
|
||
|
||
[test-icon]: https://travis-ci.org/vtrushin/json-to-ast.svg?branch=master
|
||
[test-url]: https://travis-ci.org/vtrushin/json-to-ast
|
||
|
||
[coverage-icon]: https://coveralls.io/repos/github/vtrushin/json-to-ast/badge.svg?branch=master
|
||
[coverage-url]: https://coveralls.io/github/vtrushin/json-to-ast?branch=master
|
||
|
||
[astexplorer-url]: https://astexplorer.net/#/gist/6e328cf76a27ca85e552c9cb583cdd74/1077c8842337972509a29bc9063d17bf90a1a492
|
||
|
||
# JSON AST parser
|
||
|
||
[![NPM][npm-icon]][npm-url]
|
||
[![NPM downloads][npm-downloads-icon]][npm-url]
|
||
[![Requirements][node-versions-icon]][node-url]
|
||
[![Travis-CI][test-icon]][test-url]
|
||
|
||
## Install
|
||
```
|
||
> npm install json-to-ast
|
||
```
|
||
|
||
## Usage
|
||
|
||
```js
|
||
const parse = require('json-to-ast');
|
||
|
||
const settings = {
|
||
// Appends location information. Default is <true>
|
||
loc: true,
|
||
// Appends source information to node’s location. Default is <null>
|
||
source: 'data.json'
|
||
};
|
||
|
||
parse('{"a": 1}', settings);
|
||
```
|
||
|
||
Output
|
||
```js
|
||
{
|
||
type: 'Object',
|
||
children: [
|
||
{
|
||
type: 'Property',
|
||
key: {
|
||
type: 'Identifier',
|
||
value: 'a',
|
||
raw: '"a"',
|
||
loc: {
|
||
start: { line: 1, column: 2, offset: 1 },
|
||
end: { line: 1, column: 5, offset: 4 },
|
||
source: 'data.json'
|
||
}
|
||
},
|
||
value: {
|
||
type: 'Literal',
|
||
value: 1,
|
||
raw: '1',
|
||
loc: {
|
||
start: { line: 1, column: 7, offset: 6 },
|
||
end: { line: 1, column: 8, offset: 7 },
|
||
source: 'data.json'
|
||
}
|
||
},
|
||
loc: {
|
||
start: { line: 1, column: 2, offset: 1 },
|
||
end: { line: 1, column: 8, offset: 7 },
|
||
source: 'data.json'
|
||
}
|
||
}
|
||
],
|
||
loc: {
|
||
start: { line: 1, column: 1, offset: 0 },
|
||
end: { line: 1, column: 9, offset: 8 },
|
||
source: 'data.json'
|
||
}
|
||
}
|
||
```
|
||
|
||
## Node types
|
||
|
||
Object:
|
||
```js
|
||
{
|
||
type: 'Object',
|
||
children: <Property>[],
|
||
loc?: Object
|
||
}
|
||
```
|
||
|
||
Property:
|
||
```js
|
||
{
|
||
type: 'Property',
|
||
key: <Identifier>,
|
||
value: Object | Array | <Literal>,
|
||
loc?: Object
|
||
}
|
||
```
|
||
|
||
Identifier:
|
||
```js
|
||
{
|
||
type: 'Identifier',
|
||
value: string,
|
||
raw: string,
|
||
loc?: Object
|
||
}
|
||
```
|
||
|
||
Array:
|
||
```js
|
||
{
|
||
type: 'Array',
|
||
children: (Object | Array | <Literal>)[],
|
||
loc?: Object
|
||
}
|
||
```
|
||
|
||
Literal:
|
||
```js
|
||
{
|
||
type: 'Literal',
|
||
value: string | number | boolean | null,
|
||
raw: string,
|
||
loc?: Object
|
||
}
|
||
```
|
||
|
||
## AST explorer
|
||
[Try it online][astexplorer-url] on [astexplorer.net](https://astexplorer.net/)
|
||
|
||
## License
|
||
MIT
|