TypeProf

An experimental type-level Ruby interpreter for testing and understanding Ruby code.

Installation

Install via RubyGems.

$ gem install typeprof

Requirements

TypeProf supports Ruby 3.3 or later.

Quick start

1. Install VSCode Ruby TypeProf extension: code --install-extension mame.ruby-typeprof

2. Run typeprof --init in your project root to create typeprof.conf.jsonc file. Other options are available. See typeprof.conf.jsonc for details.

3. Reopen your project in VSCode.

Development

1. Git clone this repository: git clone https://github.com/ruby/typeprof.git
2. Install VSCode Ruby TypeProf extension: code --install-extension mame.ruby-typeprof
3. Open the repository in VSCode: code typeprof

Testing

$ bundle install
$ bundle exec rake test

More details

• Good first issues of TypeProf (slides)
• How to report bugs / propose features

LICENSE

See LICENSE file.