RBS Rails

RBS files generator for Ruby on Rails.

Add this line to your application's Gemfile:

gem 'rbs_rails', require: false

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rbs_rails

Run the following command. It generates lib/tasks/rbs.rake.

$ bin/rails g rbs_rails:install

Then, the following four tasks are available.

• rbs_rails:prepare: Install inspector modules for Active Record models. This task is required to run before loading Rails application.
• rbs_rails:generate_rbs_for_models: Generate RBS files for Active Record models
• rbs_rails:generate_rbs_for_path_helpers: Generate RBS files for path helpers
• rbs_rails:all: Execute all tasks of RBS Rails

If you invoke multiple tasks, please run rbs_rails:prepare first.

$ bin/rails rbs_rails:prepare some_task another_task rbs_rails:generate_rbs_for_models

You need to install rails gem's RBS files. I highly recommend using rbs collection.

1. Add gem 'rails' to your Gemfile.
2. Then execute the following commands

   $ bundle install
   $ bundle exec rbs collection init
   $ bundle exec rbs collection install

Put the following code as Steepfile.

target :app do
  signature 'sig'

  check 'app'
end

That's all! Now you can check your Rails app statically with steep check command.

After checking out the repo, run bin/setup to install dependencies.

You can also run bin/console for an interactive prompt that will allow you to experiment.

This gem uses RBS::Inline to generate RBS files. Please mark up your code with RBS comments. And then, run bundle exec rake rbs_update to reflect the type definitions to the RBS files.

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 push it to the GitHub (via Pull Request). Then, GitHub Actions will automatically create a release tag and publish the gem to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/pocke/rbs_rails.