RBI provides a Ruby API to compose Ruby interface files consumed by Sorbet.

Add this line to your application's Gemfile:

gem 'rbi'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rbi

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:

# typed: true

module Foo
  def foo; end
end

• RBI generation API
• RBI parsing with Whitequark
• RBI formatting
• RBI validation
• RBI merging

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.

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.

• Locally, update the version number in version.rb
• Run bundle install to update the version number in Gemfile.lock
• Commit this change with the message Bump version to vx.y.z
• Push this change directly to main or open a PR

• Locally, create a new tag with the new version number: git tag vx.y.z
• Push this tag up to the remote git push origin vx.y.z

We have a release workflow that will publish your new gem version to rubygems.org via Trusted Publishing. This workflow must be approved by a member of the Ruby and Rails Infrastructure team at Shopify before it will run. Once it is approved, it will automatically publish a new gem version to rubygems.org and create a new GitHub release.

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.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Rbi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.