skills.rest
tomoasleep
tomoasleepCOMMUNITY
Explore all skills by this author →
𝕏@nemunemu3desuGitHub

rbs-professional

Generate and validate RBS and rbs-inline annotations for Ruby projects.

2|Updated Nov 27, 2017
Search Tags:#Ruby#typing#type-annotations#static-types#code-documentation#RBS#rbs-inline
One-click install
npx skills add https://github.com/tomoasleep/dotfiles --skill rbs-professional
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: rbs-professional
Source: https://github.com/tomoasleep/dotfiles/tree/main/config/.claude/skills/rbs-professional
Command: npx skills add https://github.com/tomoasleep/dotfiles --skill rbs-professional

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Ruby projects often lack formal type specifications, making maintenance and collaboration harder. This Skill provides guidance and tooling patterns to generate RBS type signatures and rbs-inline annotations for Ruby code, improving readability and static analysis.

Core Features & Use Cases

  • Provide accurate RBS class, interface, alias, and proc type annotations.
  • Help convert Ruby codebases to include inline comments using rbs-inline and validate types against Ruby runtime behavior.
  • Use cases include adding types to legacy Rails models, documenting public APIs in gems, and preparing code for type checking with RBS.

Quick Start

To annotate a Ruby class with RBS types, ask for a sample of the class name and methods, and request corresponding RBS in proper syntax.

Frequently Asked Questions about rbs-professional

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add RBS type annotations to existing Ruby code?▼

You can add RBS type annotations by providing a Ruby class name and its methods to generate corresponding RBS class, interface, and alias type signatures. This improves readability and enables static analysis for Ruby projects.

What is the best way to document Ruby gem public APIs with static types?▼

Documenting Ruby gem public APIs with static types involves generating RBS interface and proc type annotations. This provides formal type specifications for modules, making maintenance and collaboration easier without modifying runtime behavior.

How do I use rbs-inline annotations to add types to a Rails model?▼

To use rbs-inline for a Rails model, you add inline comments following rbs-inline syntax conventions to the codebase. This allows you to validate types against Ruby runtime behavior directly within legacy model files.

Can I validate RBS signatures against Ruby runtime behavior?▼

Yes, you can validate RBS signatures against Ruby runtime behavior. This Skill helps convert codebases using rbs-inline annotations and validates the generated types to ensure they accurately match the actual Ruby execution flow.

When do I need RBS type signatures for a Ruby project?▼

You need RBS type signatures when a Ruby project lacks formal type specifications, making maintenance and collaboration harder. Adding RBS improves code readability and prepares the project for robust static type checking.

Related Skills

Explore More Software Engineering Skills→
rigortyperigortype
96

rigor-builtin-import

Import Ruby core class types into Rigor's static analysis catalog.

Official
Advanced
stevegeekstevegeek
19

ruby-rbs

Generate and manage RBS type signatures for Ruby projects.

Community
Advanced
stevegeekstevegeek
19

inline-rbs

Embed Ruby RBS type signatures directly in source files.

Community
Intermediate
DmitryPogrebnoyDmitryPogrebnoy
26

generating-rbs-inline

Generates and updates RBS-inline type annotations in Ruby source files.

Community
Intermediate