README.md

🌴 tree-sitter-circom

💡 this grammar is still in development, the structure of the generated AST is not stable

This repository contains a grammar for tree-sitter.

The goal of this project is to provide an parser efficient low-dependency parser for circom which targets most circom versions in use and is designed for enabling metaprogramming.

Navigating this repository

The primary file in this repository is grammar.js which describes the tree-sitter grammar.

# Primary file:
grammar.js
# Tests:
/test/**/*

# Auto generated:
/src/**/*
index.js
binding.gyp

References

-> Circom Documentation:

• https://docs.circom.io/

-> Tree-sitter Solidity grammar:

• https://github.com/JoranHonig/tree-sitter-solidity/blob/master/grammar.js

Major inspriration & some structures have been taken from tree-sitter-solidity, a big thanks to the contributors to this repo!