https://github.com/Shopify/rbi
RBI generation framework
https://github.com/Shopify/rbi
rbi ruby sorbet tapioca type-checking
Last synced: 7 months ago
JSON representation
RBI generation framework
- Host: GitHub
- URL: https://github.com/Shopify/rbi
- Owner: Shopify
- License: mit
- Created: 2021-01-08T03:27:55.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-18T05:55:57.000Z (7 months ago)
- Last Synced: 2024-11-18T06:51:34.338Z (7 months ago)
- Topics: rbi, ruby, sorbet, tapioca, type-checking
- Language: Ruby
- Homepage:
- Size: 2.95 MB
- Stars: 28
- Watchers: 269
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# RBI generation framework
`RBI` provides a Ruby API to compose Ruby interface files consumed by Sorbet.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'rbi'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install rbi
## Usage
```rb
require "rbi"
rbi = RBI::File.new(strictness: "true") do |file|
file << RBI::Module.new("Foo") do |mod|
mod << RBI::Method.new("foo")
end
end
puts rbi.string
```
will produce:
```rb
# typed: true
module Foo
def foo; end
end
```
## Features
* RBI generation API
* RBI parsing with Whitequark
* RBI formatting
* RBI validation
* RBI merging
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
This repo uses itself (`rbi`) to retrieve and generate gem RBIs. You can run `dev rbi` to update local gem RBIs with RBIs from the central repo.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/rbi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Shopify/rbi/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Rbi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rbi/blob/master/CODE_OF_CONDUCT.md).