Sorbet-Typed 项目使用教程

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

sorbet-typed/
├── README.md
├── LICENSE
├── rbi/
│   ├── gem_name_1/
│   │   └── gem_name_1.rbi
│   ├── gem_name_2/
│   │   └── gem_name_2.rbi
│   └── ...
├── scripts/
│   └── generate_rbis.rb
└── .gitignore

• README.md: 项目的基本介绍和使用说明。
• LICENSE: 项目的开源许可证，本项目使用 Apache-2.0 许可证。
• rbi/: 该目录包含为各种 Ruby gems 编写的手动类型定义文件（RBI 文件）。每个 gem 的 RBI 文件都存放在以其名称命名的子目录中。
• scripts/: 包含用于生成 RBI 文件的脚本。
• .gitignore: 指定 Git 应该忽略的文件和目录。

2. 项目的启动文件介绍

Sorbet-Typed 项目本身没有传统意义上的“启动文件”，因为它主要是一个用于共享 Ruby gems 类型定义的中央仓库。然而，如果你需要生成或更新 RBI 文件，可以使用 scripts/generate_rbis.rb 脚本。

使用示例

ruby scripts/generate_rbis.rb

该脚本会根据项目中的配置生成或更新 RBI 文件。

3. 项目的配置文件介绍

Sorbet-Typed 项目没有传统意义上的配置文件，因为它主要依赖于目录结构和 RBI 文件来定义类型。然而，如果你需要自定义生成 RBI 文件的过程，可以编辑 scripts/generate_rbis.rb 脚本。

自定义生成过程

你可以根据需要修改 scripts/generate_rbis.rb 脚本，例如添加新的 gem 类型定义或调整现有的定义。

# scripts/generate_rbis.rb
# 自定义生成过程的示例代码
def generate_rbi_for_gem(gem_name)
  # 生成 RBI 文件的逻辑
end

通过这种方式，你可以根据项目的具体需求定制 RBI 文件的生成过程。