引领类型革命：Sord - 自动化YARD注释到RBI/RBS的转换工具

在Ruby世界中，类型系统的引入让代码更加健壮，但手动编写类型签名可能是一项繁琐的任务。幸运的是，我们有了Sord，一个神奇的工具，它能够自动将你的YARD文档转换为Sorbet的RBI文件或Ruby 3/Steep的RBS文件。

项目介绍

Sord是SoRbet与YARD的完美结合。只需在已有的YARD注释上运行，它就能自动生成大部分类型的签名。对于已经习惯YARD注释的开发者来说，这是一个理想的起点，无论你计划采用Sorbet的RBI格式还是Ruby 3的RBS格式。

在线试用Sord：sord.aaronc.cc

项目技术分析

Sord的智能之处在于其能理解并转换YARD注释中的各种类型声明。它支持以下特性：

• 自动生成模块、类和方法的签名
• 支持多参数或返回类型（T.any/|）
• 对于未指定类型的处理（T.untyped/untyped）
• 根据getter推断setter的参数类型
• 识别混入（include 和 extend）
• 支持泛型类型（如Array<T>和Hash<K, V>）
• 类名命名空间推断（例如 [Bar] 变为 GemName::Foo::Bar）
• 处理可为nil的返回类型（T.nilable/untyped）
• 接受鸭子类型 (T.untyped/untyped)
• 支持有序列表类型（[Array(Integer, Symbol)] 转换为 [Integer, Symbol]）
• 支持布尔类型 ([true, false] 转换为 T::Boolean/bool)
• 支持通过@yieldparam和@yieldreturn标记的&block参数

应用场景

Sord适用于任何已经使用YARD进行文档化的Ruby项目，无论是新旧项目，都可以快速地加入类型检查，提升代码质量。生成的RBI/RBS文件可以直接嵌入到你的宝石(gem)中，或者贡献给sorbet-typed仓库以供社区共享。

项目特点

• 省时高效：自动从YARD注释生成类型签名，避免手动工作。
• 兼容性强：支持多种YARD类型声明，包括复杂类型如泛型和混入。
• 智能推断：能根据现有信息推断出缺失的类型信息。
• 易于集成：可以无缝地整合到现有的代码库中，并与Sorbet或Ruby 3的类型系统协同工作。

使用Sord，你可以轻松迈出利用静态类型加强代码安全性的第一步，无需大篇幅地修改原有文档，只需几行命令，即可让你的项目变得更加规范和健壮。

安装Sord只需一条简单的命令：

gem install sord

然后在项目根目录下执行：

sord defs.rbi

接下来，你就拥有了一个带有完整类型签名的RBI或RBS文件了！

加入Sord的行列，让代码更具可读性和可靠性。开始你的类型之旅，体验更高级别的编程乐趣！