Yet Another Ruby Parser
This is a parser for the Ruby programming language. It is designed to be portable, error tolerant, and maintainable. It is written in C99 and has no dependencies. It is currently being integrated into CRuby, JRuby, TruffleRuby, Sorbet, and Syntax Tree.
Overview
The repository contains the infrastructure for both a shared library (librubyparser) and a native CRuby extension. The shared library has no bindings to CRuby itself, and so can be used by other projects. The native CRuby extension links against ruby.h, and so is suitable in the context of CRuby.
.
├── Makefile.in configuration to compile the shared library and native tests
├── Rakefile configuration to compile the native extension and run the Ruby tests
├── bin
│  ├── lex runs the lexer on a file or string, prints the tokens, and compares to ripper
│  └── parse runs the parser on a file or string and prints the syntax tree
├── config.yml specification for tokens and nodes in the tree
├── configure.ac configuration to generate the Makefile
├── docs documentation about the project
├── exe
│  └── yarp-lsp language server protocol executable
├── ext
│  └── yarp
│  ├── extconf.rb configuration to generate the Makefile for the native extension
│  └── extension.c the native extension that interacts with librubyparser
├── include
│  ├── yarp header files for the shared library
│  └── yarp.h main header file for the shared library
├── java Java bindings for the shared library
├── lib
│  ├── yarp Ruby library files
│  └── yarp.rb main entrypoint for the Ruby library
├── src
│  ├── enc various encoding files
│  ├── util various utility files
│  └── yarp.c main entrypoint for the shared library
├── tasks various Rake tasks for the project
├── templates contains ERB templates generated by templates/template.rb
│  └── template.rb generates code from the nodes and tokens configured by config.yml
├── test
│  ├── fixtures Ruby code used for testing
│  └── snapshots snapshots of generated syntax trees corresponding to fixtures
└── vscode VSCode extension
Getting started
To compile the shared library, you will need:
- A C99 compiler
- autotools (autoconf, automake, libtool)
- make
- Ruby 3.3.0-preview1 or later
Once you have these dependencies, run:
bundle install
to fetch the Ruby dependencies. Finally, run:
rake compile
to compile the shared library. It will be built in the build directory. To test that everything is working, run:
bin/parse -e "1 + 2"
to see the syntax tree for the expression 1 + 2.
Contributing
See the CONTRIBUTING.md file for more information. We additionally have documentation about the overall design of the project as well as various subtopics.
VSCode plugin
See the vscode/README.md file for more information and installation instructions.