generating-sorbet-inline

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Sorbet Inline Generation Skill

Sorbet内联签名生成技能

Generate or update Sorbet type signatures using

sig {}

blocks directly in Ruby source files. Supports both full generation from scratch and partial updates for individual changed files. Sorbet signatures are valid Ruby code that enable both static and runtime type checking.

使用

sig {}

块直接在Ruby源文件中生成或更新Sorbet类型签名。支持从头开始完整生成，以及对单个变更文件进行部分更新。Sorbet签名是合法的Ruby代码，可同时支持静态和运行时类型检查。

Instructions

操作步骤

When generating Sorbet inline signatures, always follow these steps.

Copy this checklist and track your progress:

Sorbet Inline Generation Progress:
- [ ] Step 1: Analyze the Ruby source
- [ ] Step 2: Add Sorbet signatures
- [ ] Step 3: Eliminate `T.untyped` in signatures
- [ ] Step 4: Review and refine signatures
- [ ] Step 5: Validate signatures with Sorbet

生成Sorbet内联签名时，请始终遵循以下步骤。

复制此检查清单并跟踪进度：

Sorbet内联签名生成进度：
- [ ] 步骤1：分析Ruby源代码
- [ ] 步骤2：添加Sorbet签名
- [ ] 步骤3：消除签名中的`T.untyped`
- [ ] 步骤4：审核并优化签名
- [ ] 步骤5：使用Sorbet验证签名

Rules

规则

You MUST NOT run Ruby code of the project.
You MUST NOT use
```
T.untyped
```
. Infer the proper type instead.
You MUST NOT use
```
T.unsafe
```
- it bypasses type checking entirely.
You MUST NOT use
```
T.cast
```
- it forces types without verification.
You MUST ask the user to provide more details if something is not clear.
You MUST prepend any command with
```
bundle exec
```
if the project has Gemfile.
You MUST use
```
sig { }
```
block syntax for method signatures.
You MUST add
```
extend T::Sig
```
to classes/modules before using
```
sig
```
.
You MUST focus on method signatures only. Skip local variables, intermediate expressions, and other non-method annotations.
You MUST NOT use or generate
```
.rbi
```
files. This skill is for inline signatures only.
You MUST preserve the existing
```
# typed:
```
sigil level if one exists. Do not upgrade or change strictness without explicit user consent.
You MUST use the tracking file when processing multiple files to ensure no files are missed.

禁止运行项目的Ruby代码。
禁止使用
```
T.untyped
```
，应推断出正确的类型。
禁止使用
```
T.unsafe
```
——它会完全绕过类型检查。
禁止使用
```
T.cast
```
——它会强制指定类型而不进行验证。
若有内容不明确，必须要求用户提供更多细节。
如果项目包含Gemfile，必须在命令前添加
```
bundle exec
```
前缀。
必须使用
```
sig { }
```
块语法定义方法签名。
在使用
```
sig
```
之前，必须向类/模块添加
```
extend T::Sig
```
。
必须仅关注方法签名。跳过局部变量、中间表达式和其他非方法注解。
禁止使用或生成
```
.rbi
```
文件。本技能仅适用于内联签名。
如果文件已存在
```
# typed:
```
标记级别，请保留该级别。未经用户明确同意，不得升级或更改严格性。
处理多个文件时，必须使用跟踪文件以确保没有遗漏任何文件。

Multi-File Processing

多文件处理

When processing multiple Ruby files, create a tracking file to ensure all files are covered:

Create tracking file

.sorbet-inline-generation-todo.tmp

[ ] app/models/user.rb
[ ] app/models/post.rb
[ ] app/services/auth_service.rb

Process files one by one:
- Take the next pending
```
[ ]
```
  entry
- Complete all steps (1-5) for that file
- Mark as processed
```
[x]
```
- Save the tracking file
- Continue to next pending entry
Cleanup: Remove the tracking file after all files are processed:
bash
```
rm .sorbet-inline-generation-todo.tmp
```

If interrupted, the tracking file allows resuming from where you left off.

处理多个Ruby文件时，创建跟踪文件以确保所有文件都被覆盖：

创建跟踪文件

.sorbet-inline-generation-todo.tmp

：

[ ] app/models/user.rb
[ ] app/models/post.rb
[ ] app/services/auth_service.rb

逐个处理文件：
- 选取下一个待处理的
```
[ ]
```
  条目
- 完成该文件的所有步骤（1-5）
- 标记为已处理
```
[x]
```
- 保存跟踪文件
- 继续处理下一个待处理条目
清理：所有文件处理完成后，删除跟踪文件：
bash
```
rm .sorbet-inline-generation-todo.tmp
```

若处理被中断，跟踪文件可让你从中断处恢复。

1. Analyze the Ruby Source

1. 分析Ruby源代码

Always perform this step.

Read and understand the Ruby source file:

Identify all classes, modules, methods, constants and instance variables.
Note inheritance, module inclusion and definitions based on metaprogramming.
Note visibility modifiers -
```
public
```
,
```
private
```
,
```
protected
```
.
Note existing
```
# typed:
```
sigil level at the top of the file.
Note type parameters for generic classes.

必须执行此步骤。

阅读并理解Ruby源文件：

识别所有类、模块、方法、常量和实例变量。
记录基于元编程的继承、模块包含和定义。
记录可见性修饰符——
```
public
```
、
```
private
```
、
```
protected
```
。
记录文件顶部已有的
```
# typed:
```
标记级别。
记录泛型类的类型参数。

2. Add Sorbet Signatures

2. 添加Sorbet签名

Always perform this step.

First, check if the file already has a
```
# typed:
```
sigil at the top:
- If sigil exists: Preserve the existing level. Do not change it without user consent.
- If no sigil exists: Add
```
# typed: true
```
  as a sensible default (allows gradual typing).
Sigil levels (least to most strict):
```
ignore
```
<
```
false
```
<
```
true
```
<
```
strict
```
<
```
strong
```

Add

extend T::Sig

to the class/module:

ruby

class MyClass
  extend T::Sig
end

Then add type signatures using
```
sig {}
```
blocks:

Example - Before:

ruby

class User
  attr_reader :name, :age

  def initialize(name, age)
    @name = name
    @age = age
  end

  def greet(greeting)
    "#{greeting}, #{@name}!"
  end
end

Example - After:

ruby

undefined

必须执行此步骤。

首先，检查文件顶部是否已有
```
# typed:
```
标记：
- 若标记存在：保留现有级别。未经用户同意，不得更改。
- 若标记不存在：添加
```
# typed: true
```
  作为合理默认值（支持渐进式类型标注）。
标记级别（从最宽松到最严格）：
```
ignore
```
<
```
false
```
<
```
true
```
<
```
strict
```
<
```
strong
```

向类/模块添加

extend T::Sig

：

ruby

class MyClass
  extend T::Sig
end

然后使用
```
sig {}
```
块添加类型签名：

示例 - 之前：

ruby

class User
  attr_reader :name, :age

  def initialize(name, age)
    @name = name
    @age = age
  end

  def greet(greeting)
    "#{greeting}, #{@name}!"
  end
end

示例 - 之后：

ruby

undefined

typed: true

class User extend T::Sig

sig { returns(String) } attr_reader :name

sig { returns(Integer) } attr_reader :age

sig { params(name: String, age: Integer).void } def initialize(name, age) @name = name @age = age end

sig { params(greeting: String).returns(String) } def greet(greeting) "#{greeting}, #{@name}!" end end


- Focus on method and attribute signatures only
- See [syntax.md](reference/syntax.md) for the full Sorbet syntax guide

class User extend T::Sig

sig { returns(String) } attr_reader :name

sig { returns(Integer) } attr_reader :age

sig { params(name: String, age: Integer).void } def initialize(name, age) @name = name @age = age end

sig { params(greeting: String).returns(String) } def greet(greeting) "#{greeting}, #{@name}!" end end


- 仅关注方法和属性签名
- 完整的Sorbet语法指南请参见[syntax.md](reference/syntax.md)

3. Eliminate

T.untyped

in Signatures

3. 消除签名中的

T.untyped

Always perform this step.

Review all signatures and replace
```
T.untyped
```
with proper types.
Use code context, method calls, and tests to infer types.
Use
```
T.untyped
```
only as a last resort when type cannot be determined.

必须执行此步骤。

审核所有签名，将
```
T.untyped
```
替换为正确的类型。
使用代码上下文、方法调用和测试来推断类型。
仅在无法确定类型的最后情况下使用
```
T.untyped
```
。

4. Review and Refine Signatures

4. 审核并优化签名

Always perform this step.

Verify signatures are correct, coherent, and complete.
Remove unnecessary
```
T.untyped
```
types.
Ensure all methods and attributes have signatures.
Fix any errors and repeat until signatures are correct.

必须执行此步骤。

验证签名是否正确、连贯且完整。
移除不必要的
```
T.untyped
```
类型。
确保所有方法和属性都有签名。
修复所有错误并重复此步骤，直到签名正确。

5. Validate Signatures with Sorbet

5. 使用Sorbet验证签名

Always perform this step.

Run Sorbet type checker to validate signatures:

bash

srb tc

Or with bundle:

bash

bundle exec srb tc

This checks:

Signature syntax correctness
Type consistency
Method parameter/return type matching
Instance variable initialization

Fix any errors reported and repeat until validation passes.

必须执行此步骤。

运行Sorbet类型检查器以验证签名：

bash

srb tc

或使用bundle：

bash

bundle exec srb tc

此命令检查：

签名语法正确性
类型一致性
方法参数/返回类型匹配
实例变量初始化

修复报告的所有错误并重复此步骤，直到验证通过。

References

参考资料

syntax.md - Sorbet signature syntax guide
sorbet_examples/ - Real-world Sorbet examples from production gems
Sorbet documentation - Official Sorbet docs

syntax.md - Sorbet签名语法指南
sorbet_examples/ - 来自生产级gem的真实Sorbet示例
Sorbet官方文档 - Sorbet官方文档

generating-sorbet-inline

Original

Translation

Sorbet Inline Generation Skill

Sorbet内联签名生成技能

Instructions

操作步骤

Rules

规则

Multi-File Processing

多文件处理

1. Analyze the Ruby Source

1. 分析Ruby源代码

2. Add Sorbet Signatures

2. 添加Sorbet签名

typed: true

typed: true

3. Eliminate
`T.untyped`
in Signatures

3. 消除签名中的
`T.untyped`

4. Review and Refine Signatures

4. 审核并优化签名

5. Validate Signatures with Sorbet

5. 使用Sorbet验证签名

References

参考资料

generating-sorbet-inline

Original

Translation

Sorbet Inline Generation Skill

Sorbet内联签名生成技能

Instructions

操作步骤

Rules

规则

Multi-File Processing

多文件处理

1. Analyze the Ruby Source

1. 分析Ruby源代码

2. Add Sorbet Signatures

2. 添加Sorbet签名

typed: true

typed: true

3. Eliminate T.untyped in Signatures

3. 消除签名中的T.untyped

4. Review and Refine Signatures

4. 审核并优化签名

5. Validate Signatures with Sorbet

5. 使用Sorbet验证签名

References

参考资料

3. Eliminate
`T.untyped`
in Signatures

3. 消除签名中的
`T.untyped`