百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
R

rbs_rails

> 编程语言
开源

RBS Rails 适用于 Ruby on Rails 的 RBS 文件生成器。 安装 将以下一行添加到应用程序的 Gemfile 中: ruby gem 'rbsrails', require: fa…

324 stars0 点赞0 次浏览
访问官网GitHub

工具介绍

RBS Rails 适用于 Ruby on Rails 的 RBS 文件生成器。 安装 将以下一行添加到应用程序的 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 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

Ruby

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月18日
分类编程语言
定价开源

> 相关工具

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