tree-sitter-json

What is tree-sitter-json?

The tree-sitter-json npm package provides a parser for JSON using the Tree-sitter parsing library. It allows you to parse JSON into a syntax tree, which can be useful for syntax highlighting, code analysis, and other tasks that require understanding the structure of JSON data.

What are tree-sitter-json's main functionalities?

Parsing JSON

This feature allows you to parse a JSON string into a syntax tree. The code sample demonstrates how to set up the parser with the JSON language and parse a simple JSON string.

const Parser = require('tree-sitter');
const JSON = require('tree-sitter-json');

const parser = new Parser();
parser.setLanguage(JSON);

const sourceCode = '{"key": "value"}';
const tree = parser.parse(sourceCode);

console.log(tree.rootNode.toString());

Navigating the Syntax Tree

This feature allows you to navigate the syntax tree generated from the JSON string. The code sample shows how to access the root node and its first child, and print their types and string representations.

const Parser = require('tree-sitter');
const JSON = require('tree-sitter-json');

const parser = new Parser();
parser.setLanguage(JSON);

const sourceCode = '{"key": "value"}';
const tree = parser.parse(sourceCode);

const rootNode = tree.rootNode;
const firstChild = rootNode.firstChild;

console.log(firstChild.type); // object
console.log(firstChild.toString());

Error Handling

This feature allows you to detect syntax errors in the JSON string. The code sample demonstrates how to check if the parsed syntax tree contains any errors.

const Parser = require('tree-sitter');
const JSON = require('tree-sitter-json');

const parser = new Parser();
parser.setLanguage(JSON);

const sourceCode = '{"key": "value"'; // Missing closing brace
const tree = parser.parse(sourceCode);

if (tree.rootNode.hasError()) {
  console.log('Syntax error detected');
} else {
  console.log('No syntax errors');
}

Other packages similar to tree-sitter-json

jsonlint

jsonlint is a JSON parser and validator with a CLI and API. It provides similar functionality for parsing and validating JSON, but it does not generate a syntax tree like tree-sitter-json. Instead, it focuses on ensuring the JSON is well-formed and provides error messages for invalid JSON.

json5

json5 is a JSON parser that allows for more relaxed JSON syntax, such as comments and trailing commas. While it also parses JSON, it is designed to handle a superset of JSON syntax, making it more flexible but less strict compared to tree-sitter-json.

fast-json-parse

fast-json-parse is a fast JSON parser that focuses on performance. It provides basic parsing functionality without generating a syntax tree. It is useful for applications where speed is critical and the additional features of tree-sitter-json are not required.

README

tree-sitter-json

JSON grammar for tree-sitter