https://github.com/ruby/typeprof
An experimental type-level Ruby interpreter for testing and understanding Ruby code
https://github.com/ruby/typeprof
Last synced: 21 days ago
JSON representation
An experimental type-level Ruby interpreter for testing and understanding Ruby code
- Host: GitHub
- URL: https://github.com/ruby/typeprof
- Owner: ruby
- License: mit
- Created: 2019-02-22T07:26:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-05-01T13:21:25.000Z (about 1 year ago)
- Last Synced: 2025-05-01T13:49:29.992Z (about 1 year ago)
- Language: Ruby
- Size: 3.23 MB
- Stars: 792
- Watchers: 25
- Forks: 91
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- stars - ruby/typeprof - An experimental type-level Ruby interpreter for testing and understanding Ruby code (Ruby)
- awesome-ruby-cli-apps - typeprof - Performs type analysis. (Awesome Ruby CLIs / Profiling)
README
# TypeProf
An experimental type-level Ruby interpreter for testing and understanding Ruby code.
## Installation
Install via RubyGems.
```sh
$ gem install typeprof
```
### Requirements
TypeProf supports Ruby 3.3 or later.
## Quick start
1. Install VSCode [Ruby TypeProf](https://marketplace.visualstudio.com/items?itemName=mame.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](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](https://marketplace.visualstudio.com/items?itemName=mame.ruby-typeprof) extension: `code --install-extension mame.ruby-typeprof`
3. Open the repository in VSCode: `code typeprof`
### Testing
```sh
$ bundle install
$ bundle exec rake test
```
## More details
- [Good first issues of TypeProf](https://speakerdeck.com/mame/good-first-issues-of-typeprof) (slides)
- [How to report bugs / propose features](doc/report_guide.md)
## LICENSE
See [LICENSE](LICENSE) file.