\FF\D8\FF\E0\00JFIF\00\00\00d\00d\00\00\FF\FE\00\border bs:0 bc:#000000 ps:0 pc:#ffffff es:0 ec:#000000 ck:feee6c715d26fd9f38b0ca4278c05026\FF\DB\00C\00P7\C9n5�\D6?\BD�\9Ds\EBp\9F[`8m\B7)o\B5\E8\E6I\99\FE3]]A2\BA\8Cw\D6E\93\\DEv\C8\009\F2\F1NI?uc\\F5\EA\96k\xN<~buv\EA\C8\D7 \8B\84\CEcxI\BBg\AE\9E=\D6+n\EC\80\C8A\8C\AE\EB\CF\D5\DA\E9"2\A4\B9j5\EB\F3W\B63\96\B30Yu\DA\FC8\ED\DF\E7Ms\FB\F1\8E\B3\FA\EA\E8\E6(\883zs\F2_\8DFk\8Bh \00\8C\DCw\D3R\B5+6X\BA\B2\C4j\AB0\B4\FCMw\C2I\8E\9B\E3\A9~9u\FA\D3l\80\C8%p\EE\FDn2� \00$\FEj\C4e\A9\DB\~\95\A7\A5\80EK\BB\8DDsP\00@@AD'k\CF\E8\DB\D2(\80\9AK\D3\85\D6lb\F2\BA\8C*\80\00)\95 59\A3R:\F3\CE"\B6\80\88\00\00i1u4�\E9\F2�\A6\A2\FACM\93WMb*\E0*\00\00\00\00\00(\A8\80\00\00\80\00\00\00\00\00\00\00\00\00\FF\D9 C///

Prism 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. ## Overview The repository contains the infrastructure for both a shared library (libprism) 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 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 parse on a file or string and prints the AST │ └── prism a CLI for development and debugging ├── config.yml specification for tokens and nodes in the tree ├── doc documentation website ├── docs markdown documentation about the project ├── ext │ └── prism │ ├── extconf.rb configuration to generate the Makefile for the native extension │ └── extension.c the native extension that interacts with libprism ├── fuzz files related to fuzz testing ├── gemfiles gemfiles used by different Ruby versions in CI ├── include │ ├── prism header files for the shared library │ └── prism.h main header file for the shared library ├── java Java bindings for the shared library ├── java-wasm Java WASM bindings for the shared library ├── javascript JavaScript WASM bindings for the shared library ├── lib │ ├── prism Ruby library files │ └── prism.rb main entrypoint for the Ruby library ├── rakelib various Rake tasks for the project ├── rbi RBI type signatures for the Ruby library ├── rust │ ├── ruby-prism Rustified crate for the shared library │ └── ruby-prism-sys FFI binding for Rust ├── sample │ └── prism Sample code that uses the Ruby API for documentation purposes ├── sig RBS type signatures for the Ruby library ├── src │ ├── util various utility files │ └── prism.c main entrypoint for the shared library ├── templates contains ERB templates generated by templates/template.rb │ └── template.rb generates code from the nodes and tokens configured by config.yml └── test └── prism ├── fixtures Ruby code used for testing └── snapshots snapshots of generated syntax trees corresponding to fixtures ``` ## Getting started To compile the shared library, you will need: * C99 compiler * GNU make * Ruby 2.7.0 or later Once you have these dependencies, run: ``` bundle install ``` to fetch the Ruby dependencies. Finally, run: ``` bundle exec 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](CONTRIBUTING.md) file for more information. We additionally have documentation about the overall design of the project as well as various subtopics. * [Build system](docs/build_system.md) * [Configuration](docs/configuration.md) * [CRuby compilation](docs/cruby_compilation.md) * [Design](docs/design.md) * [Encoding](docs/encoding.md) * [Fuzzing](docs/fuzzing.md) * [Heredocs](docs/heredocs.md) * [JavaScript](docs/javascript.md) * [Local variable depth](docs/local_variable_depth.md) * [Mapping](docs/mapping.md) * [Parser translation](docs/parser_translation.md) * [Parsing rules](docs/parsing_rules.md) * [Releasing](docs/releasing.md) * [Ripper translation](docs/ripper_translation.md) * [Ruby API](docs/ruby_api.md) * [RubyParser translation](docs/ruby_parser_translation.md) * [Serialization](docs/serialization.md) * [Testing](d