ocaml-tree-sitter-core

Generate OCaml parsers based on tree-sitter grammars. This project was originally intended for semgrep. This repository contains the code for generating code for tree-sitter grammars but does not contain grammars for specific languages other than tests.

The ocaml-tree-sitter repositories are:

ocaml-tree-sitter-core: this repo; provides the code generator that takes a tree-sitter grammar and produces an OCaml library from it.
ocaml-tree-sitter-languages: community repository that has scripts for building and publishing OCaml libraries for parsing a variety of programming languages.
ocaml-tree-sitter-semgrep: same as ocaml-tree-sitter-languages but extends each language with constructs specific to semgrep patterns.

Installation

Installing ocaml-tree-sitter alone isn't of great use at the moment. It is useful as part of the flow for generating OCaml parsers from tree-sitter grammars, which is done from the lang/ folder. See the Contributing instructions below.

Contributing

Development setup

Install opam.
Install ocaml dev tools for your favorite editor: typically opam install merlin + some plugin for your editor.
Install pre-commit with pip3 install pre-commit and run pre-commit install to set up the pre-commit hook. This will re-indent code in a consistent fashion each time you call git commit.
Check out the extra instructions for MacOS.

For building or rebuilding everything after big changes, use this script:

./scripts/rebuild-everything  # needs root access to install libtree-sitter

Documentation

We have limited documentation which is mostly targeted at early contributors. It's growing organically based on demand, so don't hesitate to file an issue explaining what you're trying to do.

License

ocaml-tree-sitter is free software with contributors from multiple organizations. The project is driven by r2c.

OCaml code developed specifically for this project is distributed under the terms of the GNU GPL v3.
The OCaml bindings to tree-sitter's C API were created by Bryan Phelps as part of the reason-tree-sitter project.
The tree-sitter grammars for major programming languages are external projects. Each comes with its own license.

frankeld / ocaml-tree-sitter-core Goto Github PK