Baike.dev
All toolsOnline toolsAI codingTrendingOpen sourceNewsSubmit
Log in
< Back to tools
R

rbs_rails

> 编程语言
Open source

RBS Rails RBS files generator for Ruby on Rails. Installation Add this line to your application's Gemfile: ruby gem 'rbsrails', require: fa…

324 stars0 likes0 views
WebsiteGitHub

About

RBS Rails RBS files generator for Ruby on Rails. Installation Add this line to your application's Gemfile: ruby gem 'rbsrails', require: fa…

RBS Rails

RBS files generator for Ruby on Rails.

Installation

Add this line to your application's Gemfile:

ruby
gem 'rbs_rails', require: false

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rbs_rails

Usage

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

bash
$ bin/rails g rbs_rails:install

Then, the following three tasks are available.

  • 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

You can also run rbs_rails from command line:

bash
# Generate all RBS files
$ bundle exec rbs_rails all

# Generate RBS files for models
$ bundle exec rbs_rails models

# Generate RBS files for path helpers
$ bundle exec rbs_rails path_helpers

Install RBS for rails gem

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
    bash
    $ bundle install
    $ bundle exec rbs collection init
    $ bundle exec rbs collection install

Configuration

You can customize the behavior of rbs_rails via configuration file. Place one of the following files in your project:

  • .rbs_rails.rb (in the project root)
  • config/rbs_rails.rb
…

Steep integration

Put the following code as Steepfile.

ruby
target :app do
  signature 'sig'

  check 'app'
end

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

Development

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.

Contributing

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

Issues· 0 open

View all issuesOpen on GitHub

No open issues yet, or sync has not completed.

> Tags

Ruby

No comments yet. Be the first to share.

> Details

PublishedAug 1, 2026
UpdatedSep 18, 2026
Category编程语言
PricingOpen source

> Related tools

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言