ruby-32-with-rbs-steep

Enforces static type checking and code quality for Ruby 3.2+ projects using RBS and Steep.

836|66|Updated Feb 3, 2025
One-click install
npx skills add https://github.com/kreuzberg-dev/html-to-markdown --skill ruby-32-with-rbs-steep
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ruby-32-with-rbs-steep
Source: https://github.com/kreuzberg-dev/html-to-markdown/tree/main/.codex/skills/ruby-32-with-rbs-steep
Command: npx skills add https://github.com/kreuzberg-dev/html-to-markdown --skill ruby-32-with-rbs-steep

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and scripts (resource) components.

What problem does it solve?

This Skill addresses the challenges of maintaining large Ruby codebases by introducing static type checking, improving code quality, and reducing runtime errors.

Core Features & Use Cases

  • Static Type Checking: Utilizes RBS and Steep to define and verify type signatures, catching type-related bugs before runtime.
  • Code Quality Enforcement: Integrates Rubocop for style consistency and RSpec for robust testing.
  • Use Case: Ensure that a critical API endpoint in a Ruby on Rails application correctly handles input types and returns expected data structures, preventing unexpected failures in production.

Quick Start

Use the ruby-32-with-rbs-steep skill to check the types of the code in the lib directory.

Frequently Asked Questions about ruby-32-with-rbs-steep

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

FAQPage Schema
How do I add static type checking to a Ruby 3.2 project?

Static type checking for Ruby 3.2 projects is enforced using RBS to define type signatures and Steep to verify them, catching type-related bugs before runtime. This integration ensures robust type safety and reduces unexpected failures.

Can I use RBS and Steep with my existing RSpec and Rubocop setup?

Yes, RBS and Steep integrate seamlessly with existing RSpec and Rubocop configurations. This combination enforces static type checking alongside style consistency and robust testing to maintain code quality standards.

What is the best way to prevent runtime type errors in Ruby on Rails APIs?

The best way to prevent runtime type errors in Ruby on Rails APIs is implementing static type checking with RBS and Steep. This verifies that API endpoints handle input types correctly and return expected data structures before deployment.

Does this Ruby type checking workflow support rbenv for version management?

Yes, the Ruby type checking workflow integrates with rbenv for version management. This ensures your Ruby 3.2+ environment is correctly managed while RBS and Steep enforce type safety standards across your project.

How do I check types in my Ruby lib directory using Steep?

To check types in your Ruby lib directory using Steep, apply the static type checking workflow to scan the directory. Steep uses your RBS signature files to verify type correctness and catch potential bugs before runtime execution.