Generates RBS-inline type annotations directly in Ruby source files as comments. Triggers when adding inline type signatures, annotating Ruby methods with rbs-inline syntax, or generating type comments without existing inline annotations.
/plugin marketplace add DmitryPogrebnoy/ruby-agent-skills/plugin install ruby-type-signature-skills@ruby-agent-skillsThis skill inherits all available tools. When active, it can use any tool Claude has access to.
reference/data-struct-support.mdreference/rbs_inline_examples/STRUCTURE.mdreference/rbs_inline_examples/zeitwerk/zeitwerk.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/core_ext/kernel.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/core_ext/module.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/cref.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/cref/map.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/error.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/gem_inflector.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/gem_loader.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/inflector.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/internal.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/loader.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/loader/callbacks.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/loader/config.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/loader/eager_load.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/loader/helpers.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/null_inflector.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/real_mod_name.rbreference/rbs_inline_examples/zeitwerk/zeitwerk/registry.rbGenerate RBS-inline type annotations as comments directly in Ruby source files. Unlike pure RBS which uses separate .rbs files, rbs-inline embeds type information as structured comments within Ruby code.
When generating RBS-inline annotations, always follow these steps.
Copy this checklist and track your progress:
RBS-Inline Generation Progress:
- [ ] Step 1: Analyze the Ruby source
- [ ] Step 2: Add RBS-inline annotations
- [ ] Step 3: Eliminate `untyped` types in annotations
- [ ] Step 4: Review and refine annotations
- [ ] Step 5: Validate annotations
- [ ] Step 6: Ensure type safety (only if steep is configured)
untyped. Infer the proper type instead.bundle exec if the project has Gemfile.# @rbs comment syntax for inline annotations..rbs files in the project.Always perform this step.
Read and understand the Ruby source file:
public, private, protected.Always perform this step.
First, add the magic comment at the top of the Ruby file to enable rbs-inline processing:
# rbs_inline: enabled
Then add type annotations as comments directly in the Ruby source file using rbs-inline syntax:
Example - Before:
class User
attr_reader :name, :age
def initialize(name, age)
@name = name
@age = age
end
def greet(greeting)
"#{greeting}, #{@name}!"
end
end
Example - After:
# rbs_inline: enabled
class User
attr_reader :name #: String
attr_reader :age #: Integer
# @rbs name: String
# @rbs age: Integer
# @rbs return: void
def initialize(name, age)
@name = name
@age = age
end
#: (String) -> String
def greet(greeting)
"#{greeting}, #{@name}!"
end
end
Data and Struct types
untyped Types in AnnotationsAlways perform this step.
untyped with proper types.untyped only as a last resort when type cannot be determined.Always perform this step.
untyped types.Always perform this step.
rbs-inline is a transpiler - it generates RBS files from inline annotations. Validation happens on the generated RBS output.
Generate RBS files from annotations:
rbs-inline --output lib
This generates .rbs files in sig/generated/ directory.
Validate the generated RBS files:
rbs validate
This checks syntax, name resolution, inheritance, and type applications.
Fix any errors in your inline annotations and repeat until validation passes.
Perform this step ONLY if the project Gemfile includes steep gem AND the project has Steepfile.
Steep works on RBS files, not directly on inline annotations. The RBS files must be generated first (step 5).
Ensure RBS files are generated from annotations:
rbs-inline --output lib
Run Steep type checker:
steep check
Fix any errors reported by steep check.