Sorbet-Rails 项目教程

Sorbet-Rails 项目教程

sorbet-railsA set of tools to make the Sorbet typechecker work with Ruby on Rails seamlessly.项目地址:https://gitcode.com/gh_mirrors/so/sorbet-rails

1. 项目的目录结构及介绍

sorbet-rails/
├── bin/
│   └── setup
├── lib/
│   ├── sorbet-rails/
│   │   ├── base_generators/
│   │   ├── custom_types/
│   │   ├── generators/
│   │   ├── rails_mixins/
│   │   ├── sorbet_rails.rb
│   │   └── version.rb
│   └── sorbet-rails.rb
├── sorbet/
│   └── rails-rbi/
│       ├── active_storage.rbi
│       ├── action_cable.rbi
│       ├── ...
├── spec/
│   ├── sorbet-rails_spec.rb
│   ├── ...
├── Gemfile
├── Gemfile.lock
├── LICENSE
├── README.md
└── Rakefile

目录结构介绍

• bin/: 包含项目的启动脚本，如 setup 脚本。
• lib/: 包含项目的主要代码库，包括各种生成器和工具类。
  • sorbet-rails/: 包含 Sorbet-Rails 的核心代码。
    • base_generators/: 基础生成器代码。
    • custom_types/: 自定义类型代码。
    • generators/: 生成器代码。
    • rails_mixins/: Rails 混合代码。
    • sorbet_rails.rb: 主入口文件。
    • version.rb: 版本信息文件。
• sorbet/: 包含生成的 RBI 文件，用于 Sorbet 类型检查。
  • rails-rbi/: 包含 Rails 相关的 RBI 文件。
• spec/: 包含项目的测试代码。
• Gemfile: 项目的依赖文件。
• Gemfile.lock: 依赖锁定文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• Rakefile: Rake 任务配置文件。

2. 项目的启动文件介绍

bin/setup

bin/setup 是一个启动脚本，用于设置项目环境。它通常包含以下功能：

• 安装依赖
• 配置环境
• 运行初始化任务

lib/sorbet-rails.rb

lib/sorbet-rails.rb 是 Sorbet-Rails 的主入口文件，负责加载项目的核心功能和配置。

3. 项目的配置文件介绍

Gemfile

Gemfile 是项目的依赖配置文件，定义了项目所需的 RubyGems。

source 'https://rubygems.org'

gem 'sorbet-rails'

Rakefile

Rakefile 是 Rake 任务的配置文件，定义了项目中可用的 Rake 任务。

require 'bundler/setup'
require 'sorbet-rails'

task :default => :test

task :test do
  # 测试任务
end

sorbet/rails-rbi/

sorbet/rails-rbi/ 目录包含生成的 RBI 文件，用于 Sorbet 类型检查。这些文件定义了 Rails 动态方法的类型签名。

sorbet/
└── rails-rbi/
    ├── active_storage.rbi
    ├── action_cable.rbi
    ├── ...

.sorbet/config

.sorbet/config 是 Sorbet 的配置文件，定义了 Sorbet 的运行参数和检查范围。

--dir
.
--ignore=vendor/

以上是 Sorbet-Rails 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 Sorbet-Rails。

sorbet-railsA set of tools to make the Sorbet typechecker work with Ruby on Rails seamlessly.项目地址:https://gitcode.com/gh_mirrors/so/sorbet-rails