https://github.com/decurity/tree-sitter-circom

Circom grammar for tree sitter
https://github.com/decurity/tree-sitter-circom

circom grammar parser tree-sitter

Last synced: about 1 month ago
JSON representation

Circom grammar for tree sitter

• Host: GitHub
• URL: https://github.com/decurity/tree-sitter-circom
• Owner: Decurity
• License: mit
• Created: 2024-07-08T08:12:40.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-09T10:56:54.000Z (2 months ago)
• Last Synced: 2024-10-09T23:22:47.361Z (about 1 month ago)
• Topics: circom, grammar, parser, tree-sitter
• Language: JavaScript
• Homepage:
• Size: 203 KB
• Stars: 7
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## 🌴 tree-sitter-circom

[![Test grammar](https://github.com/Decurity/tree-sitter-circom/actions/workflows/test.yaml/badge.svg)](https://github.com/Decurity/tree-sitter-circom/actions/workflows/test.yaml)

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

This repository contains a grammar for [tree-sitter](https://github.com/tree-sitter/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!