File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 22
33An experimental type-level Ruby interpreter for testing and understanding Ruby code.
44
5+ ## Installation
6+
7+ Install via RubyGems.
8+
9+ ``` sh
10+ $ gem install typeprof
11+ ```
12+
13+ ### Requirements
14+
15+ TypeProf supports Ruby 3.3 or later.
16+
17+ ## Quick start
18+
19+ 1 . Install VSCode "Ruby TypeProf" extension: ` code --install-extension mame.ruby-typeprof `
20+ 2 . Put ` typeprof.config.json ` ( or ` typeprof.config.jsonc ` ) in your project root.
21+ ``` jsonc
22+ {
23+ " typeprof_version" : " experimental" ,
24+ " rbs_dir" : " sig/" ,
25+ }
26+ ```
27+ Other options are available . See [typeprof .conf .jsonc ](typeprof .conf .jsonc ) for details.
28+
29+ 3. Reopen your project in VSCode.
30+
531## Development
632
7- 1 . Install Ruby 3.3 or later.
8- 2 . Git clone this repository: ` git clone https://github.com/ruby/typeprof.git `
9- 3 . Install VSCode extension: ` code --install-extension mame.ruby-typeprof `
10- 4 . Open the repository in VSCode: ` code typeprof `
33+ 1. Git clone this repository: ` git clone https://github.com/ruby/typeprof.git`
34+ 2. Install VSCode " Ruby TypeProf" extension: ` code --install-extension mame.ruby-typeprof`
35+ 3. Open the repository in VSCode: ` code typeprof`
1136
1237### Testing
1338
You can’t perform that action at this time.
0 commit comments